| blob | 80d40136c37972657d19d3de32557bffa3bb86c6 |
1 /* THIS FILE IS GENERATED -*- buffer-read-only: t -*- */
2 /* vi:set ro: */
4 /* Dynamic architecture support for GDB, the GNU debugger.
6 Copyright (C) 1998-2023 Free Software Foundation, Inc.
8 This file is part of GDB.
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.
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.
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/>. */
23 /* To regenerate this file, run:
24 ./gdbarch.py
25 */
29 /* The following are pre-initialized by GDBARCH. */
32 /* set_gdbarch_bfd_arch_info() - not applicable - pre-initialized. */
35 /* set_gdbarch_byte_order() - not applicable - pre-initialized. */
38 /* set_gdbarch_byte_order_for_code() - not applicable - pre-initialized. */
41 /* set_gdbarch_osabi() - not applicable - pre-initialized. */
44 /* set_gdbarch_target_desc() - not applicable - pre-initialized. */
47 /* The following are initialized by the target dependent code. */
49 /* Number of bits in a short or unsigned short for the target machine. */
54 /* Number of bits in an int or unsigned int for the target machine. */
59 /* Number of bits in a long or unsigned long for the target machine. */
64 /* Number of bits in a long long or unsigned long long for the target
65 machine. */
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). */
80 extern void set_gdbarch_bfloat16_format (struct gdbarch *gdbarch, const struct floatformat ** bfloat16_format);
86 extern void set_gdbarch_half_format (struct gdbarch *gdbarch, const struct floatformat ** half_format);
92 extern void set_gdbarch_float_format (struct gdbarch *gdbarch, const struct floatformat ** float_format);
98 extern void set_gdbarch_double_format (struct gdbarch *gdbarch, const struct floatformat ** double_format);
104 extern void set_gdbarch_long_double_format (struct gdbarch *gdbarch, const struct floatformat ** long_double_format);
106 /* The ABI default bit-size for "wchar_t". wchar_t is a built-in type
107 starting with C++11. */
112 /* One if `wchar_t' is signed, zero if unsigned. */
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. */
121 typedef const struct floatformat ** (gdbarch_floatformat_for_type_ftype) (struct gdbarch *gdbarch, const char *name, int length);
122 extern const struct floatformat ** gdbarch_floatformat_for_type (struct gdbarch *gdbarch, const char *name, int length);
123 extern void set_gdbarch_floatformat_for_type (struct gdbarch *gdbarch, gdbarch_floatformat_for_type_ftype *floatformat_for_type);
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.
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.
134 ptr_bit is the size of a pointer on the target */
139 /* addr_bit is the size of a target address as represented in gdb */
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.
151 dwarf2_addr_size is not used for .eh_frame FDEs, which are generally
152 defined using the target's pointer size so far.
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. */
161 /* One if `char' acts like `signed char', zero if `unsigned char'. */
175 extern void gdbarch_write_pc (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR val);
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. */
182 typedef void (gdbarch_virtual_frame_pointer_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc, int *frame_regnum, LONGEST *frame_offset);
183 extern void gdbarch_virtual_frame_pointer (struct gdbarch *gdbarch, CORE_ADDR pc, int *frame_regnum, LONGEST *frame_offset);
184 extern void set_gdbarch_virtual_frame_pointer (struct gdbarch *gdbarch, gdbarch_virtual_frame_pointer_ftype *virtual_frame_pointer);
188 typedef enum register_status (gdbarch_pseudo_register_read_ftype) (struct gdbarch *gdbarch, readable_regcache *regcache, int cookednum, gdb_byte *buf);
189 extern enum register_status gdbarch_pseudo_register_read (struct gdbarch *gdbarch, readable_regcache *regcache, int cookednum, gdb_byte *buf);
190 extern void set_gdbarch_pseudo_register_read (struct gdbarch *gdbarch, gdbarch_pseudo_register_read_ftype *pseudo_register_read);
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. */
199 typedef struct value * (gdbarch_pseudo_register_read_value_ftype) (struct gdbarch *gdbarch, frame_info_ptr next_frame, int cookednum);
200 extern struct value * gdbarch_pseudo_register_read_value (struct gdbarch *gdbarch, frame_info_ptr next_frame, int cookednum);
201 extern void set_gdbarch_pseudo_register_read_value (struct gdbarch *gdbarch, gdbarch_pseudo_register_read_value_ftype *pseudo_register_read_value);
203 /* Write bytes in BUF to pseudo register with number PSEUDO_REG_NUM.
205 Raw registers backing the pseudo register should be written to using
206 NEXT_FRAME. */
210 typedef void (gdbarch_pseudo_register_write_ftype) (struct gdbarch *gdbarch, frame_info_ptr next_frame, int pseudo_reg_num, gdb::array_view<const gdb_byte> buf);
211 extern void gdbarch_pseudo_register_write (struct gdbarch *gdbarch, frame_info_ptr next_frame, int pseudo_reg_num, gdb::array_view<const gdb_byte> buf);
212 extern void set_gdbarch_pseudo_register_write (struct gdbarch *gdbarch, gdbarch_pseudo_register_write_ftype *pseudo_register_write);
214 /* Write bytes to a pseudo register.
216 This is marked as deprecated because it gets passed a regcache for
217 implementations to write raw registers in. This doesn't work for unwound
218 frames, where the raw registers backing the pseudo registers may have been
219 saved elsewhere.
221 Implementations should be migrated to implement pseudo_register_write instead. */
225 typedef void (gdbarch_deprecated_pseudo_register_write_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, const gdb_byte *buf);
226 extern void gdbarch_deprecated_pseudo_register_write (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, const gdb_byte *buf);
227 extern void set_gdbarch_deprecated_pseudo_register_write (struct gdbarch *gdbarch, gdbarch_deprecated_pseudo_register_write_ftype *deprecated_pseudo_register_write);
232 /* This macro gives the number of pseudo-registers that live in the
233 register namespace but do not get fetched or stored on the target.
234 These pseudo-registers may be aliases for other registers,
235 combinations of other registers, or they may be computed by GDB. */
240 /* Assemble agent expression bytecode to collect pseudo-register REG.
241 Return -1 if something goes wrong, 0 otherwise. */
245 typedef int (gdbarch_ax_pseudo_register_collect_ftype) (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
246 extern int gdbarch_ax_pseudo_register_collect (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
247 extern void set_gdbarch_ax_pseudo_register_collect (struct gdbarch *gdbarch, gdbarch_ax_pseudo_register_collect_ftype *ax_pseudo_register_collect);
249 /* Assemble agent expression bytecode to push the value of pseudo-register
250 REG on the interpreter stack.
251 Return -1 if something goes wrong, 0 otherwise. */
255 typedef int (gdbarch_ax_pseudo_register_push_stack_ftype) (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
256 extern int gdbarch_ax_pseudo_register_push_stack (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
257 extern void set_gdbarch_ax_pseudo_register_push_stack (struct gdbarch *gdbarch, gdbarch_ax_pseudo_register_push_stack_ftype *ax_pseudo_register_push_stack);
259 /* Some architectures can display additional information for specific
260 signals.
261 UIOUT is the output stream where the handler will place information. */
265 typedef void (gdbarch_report_signal_info_ftype) (struct gdbarch *gdbarch, struct ui_out *uiout, enum gdb_signal siggnal);
266 extern void gdbarch_report_signal_info (struct gdbarch *gdbarch, struct ui_out *uiout, enum gdb_signal siggnal);
267 extern void set_gdbarch_report_signal_info (struct gdbarch *gdbarch, gdbarch_report_signal_info_ftype *report_signal_info);
269 /* GDB's standard (or well known) register numbers. These can map onto
270 a real register or a pseudo (computed) register or not be defined at
271 all (-1).
272 gdbarch_sp_regnum will hopefully be replaced by UNWIND_SP. */
286 /* Convert stab register number (from `r' declaration) to a gdb REGNUM. */
290 extern void set_gdbarch_stab_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_stab_reg_to_regnum_ftype *stab_reg_to_regnum);
292 /* Provide a default mapping from a ecoff register number to a gdb REGNUM. */
296 extern void set_gdbarch_ecoff_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_ecoff_reg_to_regnum_ftype *ecoff_reg_to_regnum);
298 /* Convert from an sdb register number to an internal gdb register number. */
302 extern void set_gdbarch_sdb_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_sdb_reg_to_regnum_ftype *sdb_reg_to_regnum);
304 /* Provide a default mapping from a DWARF2 register number to a gdb REGNUM.
305 Return -1 for bad REGNUM. Note: Several targets get this wrong. */
309 extern void set_gdbarch_dwarf2_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_dwarf2_reg_to_regnum_ftype *dwarf2_reg_to_regnum);
311 /* Return the name of register REGNR for the specified architecture.
312 REGNR can be any value greater than, or equal to zero, and less than
313 'gdbarch_num_cooked_regs (GDBARCH)'. If REGNR is not supported for
314 GDBARCH, then this function will return an empty string, this function
315 should never return nullptr. */
319 extern void set_gdbarch_register_name (struct gdbarch *gdbarch, gdbarch_register_name_ftype *register_name);
321 /* Return the type of a register specified by the architecture. Only
322 the register cache should call this function directly; others should
323 use "register_type". */
327 extern void set_gdbarch_register_type (struct gdbarch *gdbarch, gdbarch_register_type_ftype *register_type);
329 /* Generate a dummy frame_id for THIS_FRAME assuming that the frame is
330 a dummy frame. A dummy frame is created before an inferior call,
331 the frame_id returned here must match the frame_id that was built
332 for the inferior call. Usually this means the returned frame_id's
333 stack address should match the address returned by
334 gdbarch_push_dummy_call, and the returned frame_id's code address
335 should match the address at which the breakpoint was set in the dummy
336 frame. */
338 typedef struct frame_id (gdbarch_dummy_id_ftype) (struct gdbarch *gdbarch, frame_info_ptr this_frame);
342 /* Implement DUMMY_ID and PUSH_DUMMY_CALL, then delete
343 deprecated_fp_regnum. */
346 extern void set_gdbarch_deprecated_fp_regnum (struct gdbarch *gdbarch, int deprecated_fp_regnum);
350 typedef CORE_ADDR (gdbarch_push_dummy_call_ftype) (struct gdbarch *gdbarch, struct value *function, struct regcache *regcache, CORE_ADDR bp_addr, int nargs, struct value **args, CORE_ADDR sp, function_call_return_method return_method, CORE_ADDR struct_addr);
351 extern CORE_ADDR gdbarch_push_dummy_call (struct gdbarch *gdbarch, struct value *function, struct regcache *regcache, CORE_ADDR bp_addr, int nargs, struct value **args, CORE_ADDR sp, function_call_return_method return_method, CORE_ADDR struct_addr);
352 extern void set_gdbarch_push_dummy_call (struct gdbarch *gdbarch, gdbarch_push_dummy_call_ftype *push_dummy_call);
355 extern void set_gdbarch_call_dummy_location (struct gdbarch *gdbarch, enum call_dummy_location_type call_dummy_location);
359 typedef CORE_ADDR (gdbarch_push_dummy_code_ftype) (struct gdbarch *gdbarch, CORE_ADDR sp, CORE_ADDR funaddr, struct value **args, int nargs, struct type *value_type, CORE_ADDR *real_pc, CORE_ADDR *bp_addr, struct regcache *regcache);
360 extern CORE_ADDR gdbarch_push_dummy_code (struct gdbarch *gdbarch, CORE_ADDR sp, CORE_ADDR funaddr, struct value **args, int nargs, struct type *value_type, CORE_ADDR *real_pc, CORE_ADDR *bp_addr, struct regcache *regcache);
361 extern void set_gdbarch_push_dummy_code (struct gdbarch *gdbarch, gdbarch_push_dummy_code_ftype *push_dummy_code);
363 /* Return true if the code of FRAME is writable. */
365 typedef int (gdbarch_code_of_frame_writable_ftype) (struct gdbarch *gdbarch, frame_info_ptr frame);
367 extern void set_gdbarch_code_of_frame_writable (struct gdbarch *gdbarch, gdbarch_code_of_frame_writable_ftype *code_of_frame_writable);
369 typedef void (gdbarch_print_registers_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, frame_info_ptr frame, int regnum, int all);
370 extern void gdbarch_print_registers_info (struct gdbarch *gdbarch, struct ui_file *file, frame_info_ptr frame, int regnum, int all);
371 extern void set_gdbarch_print_registers_info (struct gdbarch *gdbarch, gdbarch_print_registers_info_ftype *print_registers_info);
373 typedef void (gdbarch_print_float_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, frame_info_ptr frame, const char *args);
374 extern void gdbarch_print_float_info (struct gdbarch *gdbarch, struct ui_file *file, frame_info_ptr frame, const char *args);
375 extern void set_gdbarch_print_float_info (struct gdbarch *gdbarch, gdbarch_print_float_info_ftype *print_float_info);
379 typedef void (gdbarch_print_vector_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, frame_info_ptr frame, const char *args);
380 extern void gdbarch_print_vector_info (struct gdbarch *gdbarch, struct ui_file *file, frame_info_ptr frame, const char *args);
381 extern void set_gdbarch_print_vector_info (struct gdbarch *gdbarch, gdbarch_print_vector_info_ftype *print_vector_info);
383 /* MAP a GDB RAW register number onto a simulator register number. See
384 also include/...-sim.h. */
388 extern void set_gdbarch_register_sim_regno (struct gdbarch *gdbarch, gdbarch_register_sim_regno_ftype *register_sim_regno);
392 extern void set_gdbarch_cannot_fetch_register (struct gdbarch *gdbarch, gdbarch_cannot_fetch_register_ftype *cannot_fetch_register);
396 extern void set_gdbarch_cannot_store_register (struct gdbarch *gdbarch, gdbarch_cannot_store_register_ftype *cannot_store_register);
398 /* Determine the address where a longjmp will land and save this address
399 in PC. Return nonzero on success.
401 FRAME corresponds to the longjmp frame. */
406 extern int gdbarch_get_longjmp_target (struct gdbarch *gdbarch, frame_info_ptr frame, CORE_ADDR *pc);
407 extern void set_gdbarch_get_longjmp_target (struct gdbarch *gdbarch, gdbarch_get_longjmp_target_ftype *get_longjmp_target);
410 extern void set_gdbarch_believe_pcc_promotion (struct gdbarch *gdbarch, int believe_pcc_promotion);
412 typedef int (gdbarch_convert_register_p_ftype) (struct gdbarch *gdbarch, int regnum, struct type *type);
414 extern void set_gdbarch_convert_register_p (struct gdbarch *gdbarch, gdbarch_convert_register_p_ftype *convert_register_p);
416 typedef int (gdbarch_register_to_value_ftype) (frame_info_ptr frame, int regnum, struct type *type, gdb_byte *buf, int *optimizedp, int *unavailablep);
417 extern int gdbarch_register_to_value (struct gdbarch *gdbarch, frame_info_ptr frame, int regnum, struct type *type, gdb_byte *buf, int *optimizedp, int *unavailablep);
418 extern void set_gdbarch_register_to_value (struct gdbarch *gdbarch, gdbarch_register_to_value_ftype *register_to_value);
420 typedef void (gdbarch_value_to_register_ftype) (frame_info_ptr frame, int regnum, struct type *type, const gdb_byte *buf);
421 extern void gdbarch_value_to_register (struct gdbarch *gdbarch, frame_info_ptr frame, int regnum, struct type *type, const gdb_byte *buf);
422 extern void set_gdbarch_value_to_register (struct gdbarch *gdbarch, gdbarch_value_to_register_ftype *value_to_register);
424 /* Construct a value representing the contents of register REGNUM in
425 frame FRAME_ID, interpreted as type TYPE. The routine needs to
426 allocate and return a struct value with all value attributes
427 (but not the value contents) filled in. */
429 typedef struct value * (gdbarch_value_from_register_ftype) (struct gdbarch *gdbarch, struct type *type, int regnum, struct frame_id frame_id);
430 extern struct value * gdbarch_value_from_register (struct gdbarch *gdbarch, struct type *type, int regnum, struct frame_id frame_id);
431 extern void set_gdbarch_value_from_register (struct gdbarch *gdbarch, gdbarch_value_from_register_ftype *value_from_register);
433 typedef CORE_ADDR (gdbarch_pointer_to_address_ftype) (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
434 extern CORE_ADDR gdbarch_pointer_to_address (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
435 extern void set_gdbarch_pointer_to_address (struct gdbarch *gdbarch, gdbarch_pointer_to_address_ftype *pointer_to_address);
437 typedef void (gdbarch_address_to_pointer_ftype) (struct gdbarch *gdbarch, struct type *type, gdb_byte *buf, CORE_ADDR addr);
438 extern void gdbarch_address_to_pointer (struct gdbarch *gdbarch, struct type *type, gdb_byte *buf, CORE_ADDR addr);
439 extern void set_gdbarch_address_to_pointer (struct gdbarch *gdbarch, gdbarch_address_to_pointer_ftype *address_to_pointer);
443 typedef CORE_ADDR (gdbarch_integer_to_address_ftype) (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
444 extern CORE_ADDR gdbarch_integer_to_address (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
445 extern void set_gdbarch_integer_to_address (struct gdbarch *gdbarch, gdbarch_integer_to_address_ftype *integer_to_address);
447 /* Return the return-value convention that will be used by FUNCTION
448 to return a value of type VALTYPE. FUNCTION may be NULL in which
449 case the return convention is computed based only on VALTYPE.
451 If READBUF is not NULL, extract the return value and save it in this buffer.
453 If WRITEBUF is not NULL, it contains a return value which will be
454 stored into the appropriate register. This can be used when we want
455 to force the value returned by a function (see the "return" command
456 for instance).
458 NOTE: it is better to implement return_value_as_value instead, as that
459 method can properly handle variably-sized types. */
461 typedef enum return_value_convention (gdbarch_return_value_ftype) (struct gdbarch *gdbarch, struct value *function, struct type *valtype, struct regcache *regcache, gdb_byte *readbuf, const gdb_byte *writebuf);
462 extern void set_gdbarch_return_value (struct gdbarch *gdbarch, gdbarch_return_value_ftype *return_value);
464 /* Return the return-value convention that will be used by FUNCTION
465 to return a value of type VALTYPE. FUNCTION may be NULL in which
466 case the return convention is computed based only on VALTYPE.
468 If READ_VALUE is not NULL, extract the return value and save it in
469 this pointer.
471 If WRITEBUF is not NULL, it contains a return value which will be
472 stored into the appropriate register. This can be used when we want
473 to force the value returned by a function (see the "return" command
474 for instance). */
476 typedef enum return_value_convention (gdbarch_return_value_as_value_ftype) (struct gdbarch *gdbarch, struct value *function, struct type *valtype, struct regcache *regcache, struct value **read_value, const gdb_byte *writebuf);
477 extern enum return_value_convention gdbarch_return_value_as_value (struct gdbarch *gdbarch, struct value *function, struct type *valtype, struct regcache *regcache, struct value **read_value, const gdb_byte *writebuf);
478 extern void set_gdbarch_return_value_as_value (struct gdbarch *gdbarch, gdbarch_return_value_as_value_ftype *return_value_as_value);
480 /* Return the address at which the value being returned from
481 the current function will be stored. This routine is only
482 called if the current function uses the the "struct return
483 convention".
485 May return 0 when unable to determine that address. */
487 typedef CORE_ADDR (gdbarch_get_return_buf_addr_ftype) (struct type *val_type, frame_info_ptr cur_frame);
488 extern CORE_ADDR gdbarch_get_return_buf_addr (struct gdbarch *gdbarch, struct type *val_type, frame_info_ptr cur_frame);
489 extern void set_gdbarch_get_return_buf_addr (struct gdbarch *gdbarch, gdbarch_get_return_buf_addr_ftype *get_return_buf_addr);
491 /* Return true if the typedef record needs to be replaced.".
493 Return 0 by default */
495 typedef bool (gdbarch_dwarf2_omit_typedef_p_ftype) (struct type *target_type, const char *producer, const char *name);
496 extern bool gdbarch_dwarf2_omit_typedef_p (struct gdbarch *gdbarch, struct type *target_type, const char *producer, const char *name);
497 extern void set_gdbarch_dwarf2_omit_typedef_p (struct gdbarch *gdbarch, gdbarch_dwarf2_omit_typedef_p_ftype *dwarf2_omit_typedef_p);
499 /* Update PC when trying to find a call site. This is useful on
500 architectures where the call site PC, as reported in the DWARF, can be
501 incorrect for some reason.
503 The passed-in PC will be an address in the inferior. GDB will have
504 already failed to find a call site at this PC. This function may
505 simply return its parameter if it thinks that should be the correct
506 address. */
510 extern void set_gdbarch_update_call_site_pc (struct gdbarch *gdbarch, gdbarch_update_call_site_pc_ftype *update_call_site_pc);
512 /* Return true if the return value of function is stored in the first hidden
513 parameter. In theory, this feature should be language-dependent, specified
514 by language and its ABI, such as C++. Unfortunately, compiler may
515 implement it to a target-dependent feature. So that we need such hook here
516 to be aware of this in GDB. */
518 typedef int (gdbarch_return_in_first_hidden_param_p_ftype) (struct gdbarch *gdbarch, struct type *type);
520 extern void set_gdbarch_return_in_first_hidden_param_p (struct gdbarch *gdbarch, gdbarch_return_in_first_hidden_param_p_ftype *return_in_first_hidden_param_p);
524 extern void set_gdbarch_skip_prologue (struct gdbarch *gdbarch, gdbarch_skip_prologue_ftype *skip_prologue);
530 extern void set_gdbarch_skip_main_prologue (struct gdbarch *gdbarch, gdbarch_skip_main_prologue_ftype *skip_main_prologue);
532 /* On some platforms, a single function may provide multiple entry points,
533 e.g. one that is used for function-pointer calls and a different one
534 that is used for direct function calls.
535 In order to ensure that breakpoints set on the function will trigger
536 no matter via which entry point the function is entered, a platform
537 may provide the skip_entrypoint callback. It is called with IP set
538 to the main entry point of a function (as determined by the symbol table),
539 and should return the address of the innermost entry point, where the
540 actual breakpoint needs to be set. Note that skip_entrypoint is used
541 by GDB common code even when debugging optimized code, where skip_prologue
542 is not used. */
548 extern void set_gdbarch_skip_entrypoint (struct gdbarch *gdbarch, gdbarch_skip_entrypoint_ftype *skip_entrypoint);
552 extern void set_gdbarch_inner_than (struct gdbarch *gdbarch, gdbarch_inner_than_ftype *inner_than);
554 typedef const gdb_byte * (gdbarch_breakpoint_from_pc_ftype) (struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *lenptr);
555 extern const gdb_byte * gdbarch_breakpoint_from_pc (struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *lenptr);
556 extern void set_gdbarch_breakpoint_from_pc (struct gdbarch *gdbarch, gdbarch_breakpoint_from_pc_ftype *breakpoint_from_pc);
558 /* Return the breakpoint kind for this target based on *PCPTR. */
560 typedef int (gdbarch_breakpoint_kind_from_pc_ftype) (struct gdbarch *gdbarch, CORE_ADDR *pcptr);
562 extern void set_gdbarch_breakpoint_kind_from_pc (struct gdbarch *gdbarch, gdbarch_breakpoint_kind_from_pc_ftype *breakpoint_kind_from_pc);
564 /* Return the software breakpoint from KIND. KIND can have target
565 specific meaning like the Z0 kind parameter.
566 SIZE is set to the software breakpoint's length in memory. */
568 typedef const gdb_byte * (gdbarch_sw_breakpoint_from_kind_ftype) (struct gdbarch *gdbarch, int kind, int *size);
569 extern const gdb_byte * gdbarch_sw_breakpoint_from_kind (struct gdbarch *gdbarch, int kind, int *size);
570 extern void set_gdbarch_sw_breakpoint_from_kind (struct gdbarch *gdbarch, gdbarch_sw_breakpoint_from_kind_ftype *sw_breakpoint_from_kind);
572 /* Return the breakpoint kind for this target based on the current
573 processor state (e.g. the current instruction mode on ARM) and the
574 *PCPTR. In default, it is gdbarch->breakpoint_kind_from_pc. */
576 typedef int (gdbarch_breakpoint_kind_from_current_state_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR *pcptr);
577 extern int gdbarch_breakpoint_kind_from_current_state (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR *pcptr);
578 extern void set_gdbarch_breakpoint_kind_from_current_state (struct gdbarch *gdbarch, gdbarch_breakpoint_kind_from_current_state_ftype *breakpoint_kind_from_current_state);
582 typedef CORE_ADDR (gdbarch_adjust_breakpoint_address_ftype) (struct gdbarch *gdbarch, CORE_ADDR bpaddr);
584 extern void set_gdbarch_adjust_breakpoint_address (struct gdbarch *gdbarch, gdbarch_adjust_breakpoint_address_ftype *adjust_breakpoint_address);
586 typedef int (gdbarch_memory_insert_breakpoint_ftype) (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
587 extern int gdbarch_memory_insert_breakpoint (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
588 extern void set_gdbarch_memory_insert_breakpoint (struct gdbarch *gdbarch, gdbarch_memory_insert_breakpoint_ftype *memory_insert_breakpoint);
590 typedef int (gdbarch_memory_remove_breakpoint_ftype) (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
591 extern int gdbarch_memory_remove_breakpoint (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
592 extern void set_gdbarch_memory_remove_breakpoint (struct gdbarch *gdbarch, gdbarch_memory_remove_breakpoint_ftype *memory_remove_breakpoint);
595 extern void set_gdbarch_decr_pc_after_break (struct gdbarch *gdbarch, CORE_ADDR decr_pc_after_break);
597 /* A function can be addressed by either its "pointer" (possibly a
598 descriptor address) or "entry point" (first executable instruction).
599 The method "convert_from_func_ptr_addr" converting the former to the
600 latter. gdbarch_deprecated_function_start_offset is being used to implement
601 a simplified subset of that functionality - the function's address
602 corresponds to the "function pointer" and the function's start
603 corresponds to the "function entry point" - and hence is redundant. */
606 extern void set_gdbarch_deprecated_function_start_offset (struct gdbarch *gdbarch, CORE_ADDR deprecated_function_start_offset);
608 /* Return the remote protocol register number associated with this
609 register. Normally the identity mapping. */
613 extern void set_gdbarch_remote_register_number (struct gdbarch *gdbarch, gdbarch_remote_register_number_ftype *remote_register_number);
615 /* Fetch the target specific address used to represent a load module. */
620 extern CORE_ADDR gdbarch_fetch_tls_load_module_address (struct gdbarch *gdbarch, struct objfile *objfile);
621 extern void set_gdbarch_fetch_tls_load_module_address (struct gdbarch *gdbarch, gdbarch_fetch_tls_load_module_address_ftype *fetch_tls_load_module_address);
623 /* Return the thread-local address at OFFSET in the thread-local
624 storage for the thread PTID and the shared library or executable
625 file given by LM_ADDR. If that block of thread-local storage hasn't
626 been allocated yet, this function may throw an error. LM_ADDR may
627 be zero for statically linked multithreaded inferiors. */
631 typedef CORE_ADDR (gdbarch_get_thread_local_address_ftype) (struct gdbarch *gdbarch, ptid_t ptid, CORE_ADDR lm_addr, CORE_ADDR offset);
632 extern CORE_ADDR gdbarch_get_thread_local_address (struct gdbarch *gdbarch, ptid_t ptid, CORE_ADDR lm_addr, CORE_ADDR offset);
633 extern void set_gdbarch_get_thread_local_address (struct gdbarch *gdbarch, gdbarch_get_thread_local_address_ftype *get_thread_local_address);
638 typedef CORE_ADDR (gdbarch_unwind_pc_ftype) (struct gdbarch *gdbarch, frame_info_ptr next_frame);
640 extern void set_gdbarch_unwind_pc (struct gdbarch *gdbarch, gdbarch_unwind_pc_ftype *unwind_pc);
642 typedef CORE_ADDR (gdbarch_unwind_sp_ftype) (struct gdbarch *gdbarch, frame_info_ptr next_frame);
644 extern void set_gdbarch_unwind_sp (struct gdbarch *gdbarch, gdbarch_unwind_sp_ftype *unwind_sp);
646 /* DEPRECATED_FRAME_LOCALS_ADDRESS as been replaced by the per-frame
647 frame-base. Enable frame-base before frame-unwind. */
653 extern void set_gdbarch_frame_num_args (struct gdbarch *gdbarch, gdbarch_frame_num_args_ftype *frame_num_args);
659 extern void set_gdbarch_frame_align (struct gdbarch *gdbarch, gdbarch_frame_align_ftype *frame_align);
661 typedef int (gdbarch_stabs_argument_has_addr_ftype) (struct gdbarch *gdbarch, struct type *type);
663 extern void set_gdbarch_stabs_argument_has_addr (struct gdbarch *gdbarch, gdbarch_stabs_argument_has_addr_ftype *stabs_argument_has_addr);
668 typedef CORE_ADDR (gdbarch_convert_from_func_ptr_addr_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr, struct target_ops *targ);
669 extern CORE_ADDR gdbarch_convert_from_func_ptr_addr (struct gdbarch *gdbarch, CORE_ADDR addr, struct target_ops *targ);
670 extern void set_gdbarch_convert_from_func_ptr_addr (struct gdbarch *gdbarch, gdbarch_convert_from_func_ptr_addr_ftype *convert_from_func_ptr_addr);
672 /* On some machines there are bits in addresses which are not really
673 part of the address, but are used by the kernel, the hardware, etc.
674 for special purposes. gdbarch_addr_bits_remove takes out any such bits so
675 we get a "real" address such as one would find in a symbol table.
676 This is used only for addresses of instructions, and even then I'm
677 not sure it's used in all contexts. It exists to deal with there
678 being a few stray bits in the PC which would mislead us, not as some
679 sort of generic thing to handle alignment or segmentation (it's
680 possible it should be in TARGET_READ_PC instead). */
684 extern void set_gdbarch_addr_bits_remove (struct gdbarch *gdbarch, gdbarch_addr_bits_remove_ftype *addr_bits_remove);
686 /* On some architectures, not all bits of a pointer are significant.
687 On AArch64, for example, the top bits of a pointer may carry a "tag", which
688 can be ignored by the kernel and the hardware. The "tag" can be regarded as
689 additional data associated with the pointer, but it is not part of the address.
691 Given a pointer for the architecture, this hook removes all the
692 non-significant bits and sign-extends things as needed. It gets used to remove
693 non-address bits from data pointers (for example, removing the AArch64 MTE tag
694 bits from a pointer) and from code pointers (removing the AArch64 PAC signature
695 from a pointer containing the return address). */
697 typedef CORE_ADDR (gdbarch_remove_non_address_bits_ftype) (struct gdbarch *gdbarch, CORE_ADDR pointer);
699 extern void set_gdbarch_remove_non_address_bits (struct gdbarch *gdbarch, gdbarch_remove_non_address_bits_ftype *remove_non_address_bits);
701 /* Return a string representation of the memory tag TAG. */
703 typedef std::string (gdbarch_memtag_to_string_ftype) (struct gdbarch *gdbarch, struct value *tag);
705 extern void set_gdbarch_memtag_to_string (struct gdbarch *gdbarch, gdbarch_memtag_to_string_ftype *memtag_to_string);
707 /* Return true if ADDRESS contains a tag and false otherwise. ADDRESS
708 must be either a pointer or a reference type. */
712 extern void set_gdbarch_tagged_address_p (struct gdbarch *gdbarch, gdbarch_tagged_address_p_ftype *tagged_address_p);
714 /* Return true if the tag from ADDRESS matches the memory tag for that
715 particular address. Return false otherwise. */
719 extern void set_gdbarch_memtag_matches_p (struct gdbarch *gdbarch, gdbarch_memtag_matches_p_ftype *memtag_matches_p);
721 /* Set the tags of type TAG_TYPE, for the memory address range
722 [ADDRESS, ADDRESS + LENGTH) to TAGS.
723 Return true if successful and false otherwise. */
725 typedef bool (gdbarch_set_memtags_ftype) (struct gdbarch *gdbarch, struct value *address, size_t length, const gdb::byte_vector &tags, memtag_type tag_type);
726 extern bool gdbarch_set_memtags (struct gdbarch *gdbarch, struct value *address, size_t length, const gdb::byte_vector &tags, memtag_type tag_type);
727 extern void set_gdbarch_set_memtags (struct gdbarch *gdbarch, gdbarch_set_memtags_ftype *set_memtags);
729 /* Return the tag of type TAG_TYPE associated with the memory address ADDRESS,
730 assuming ADDRESS is tagged. */
732 typedef struct value * (gdbarch_get_memtag_ftype) (struct gdbarch *gdbarch, struct value *address, memtag_type tag_type);
733 extern struct value * gdbarch_get_memtag (struct gdbarch *gdbarch, struct value *address, memtag_type tag_type);
734 extern void set_gdbarch_get_memtag (struct gdbarch *gdbarch, gdbarch_get_memtag_ftype *get_memtag);
736 /* memtag_granule_size is the size of the allocation tag granule, for
737 architectures that support memory tagging.
738 This is 0 for architectures that do not support memory tagging.
739 For a non-zero value, this represents the number of bytes of memory per tag. */
742 extern void set_gdbarch_memtag_granule_size (struct gdbarch *gdbarch, CORE_ADDR memtag_granule_size);
744 /* FIXME/cagney/2001-01-18: This should be split in two. A target method that
745 indicates if the target needs software single step. An ISA method to
746 implement it.
748 FIXME/cagney/2001-01-18: The logic is backwards. It should be asking if the
749 target can single step. If not, then implement single step using breakpoints.
751 Return a vector of addresses on which the software single step
752 breakpoints should be inserted. NULL means software single step is
753 not used.
754 Multiple breakpoints may be inserted for some instructions such as
755 conditional branch. However, each implementation must always evaluate
756 the condition and only put the breakpoint at the branch destination if
757 the condition is true, so that we ensure forward progress when stepping
758 past a conditional branch to self. */
762 typedef std::vector<CORE_ADDR> (gdbarch_software_single_step_ftype) (struct regcache *regcache);
763 extern std::vector<CORE_ADDR> gdbarch_software_single_step (struct gdbarch *gdbarch, struct regcache *regcache);
764 extern void set_gdbarch_software_single_step (struct gdbarch *gdbarch, gdbarch_software_single_step_ftype *software_single_step);
766 /* Return non-zero if the processor is executing a delay slot and a
767 further single-step is needed before the instruction finishes. */
771 typedef int (gdbarch_single_step_through_delay_ftype) (struct gdbarch *gdbarch, frame_info_ptr frame);
773 extern void set_gdbarch_single_step_through_delay (struct gdbarch *gdbarch, gdbarch_single_step_through_delay_ftype *single_step_through_delay);
775 /* FIXME: cagney/2003-08-28: Need to find a better way of selecting the
776 disassembler. Perhaps objdump can handle it? */
779 extern int gdbarch_print_insn (struct gdbarch *gdbarch, bfd_vma vma, struct disassemble_info *info);
780 extern void set_gdbarch_print_insn (struct gdbarch *gdbarch, gdbarch_print_insn_ftype *print_insn);
783 extern CORE_ADDR gdbarch_skip_trampoline_code (struct gdbarch *gdbarch, frame_info_ptr frame, CORE_ADDR pc);
784 extern void set_gdbarch_skip_trampoline_code (struct gdbarch *gdbarch, gdbarch_skip_trampoline_code_ftype *skip_trampoline_code);
786 /* Vtable of solib operations functions. */
791 /* If in_solib_dynsym_resolve_code() returns true, and SKIP_SOLIB_RESOLVER
792 evaluates non-zero, this is the address where the debugger will place
793 a step-resume breakpoint to get us past the dynamic linker. */
797 extern void set_gdbarch_skip_solib_resolver (struct gdbarch *gdbarch, gdbarch_skip_solib_resolver_ftype *skip_solib_resolver);
799 /* Some systems also have trampoline code for returning from shared libs. */
801 typedef int (gdbarch_in_solib_return_trampoline_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc, const char *name);
802 extern int gdbarch_in_solib_return_trampoline (struct gdbarch *gdbarch, CORE_ADDR pc, const char *name);
803 extern void set_gdbarch_in_solib_return_trampoline (struct gdbarch *gdbarch, gdbarch_in_solib_return_trampoline_ftype *in_solib_return_trampoline);
805 /* Return true if PC lies inside an indirect branch thunk. */
809 extern void set_gdbarch_in_indirect_branch_thunk (struct gdbarch *gdbarch, gdbarch_in_indirect_branch_thunk_ftype *in_indirect_branch_thunk);
811 /* A target might have problems with watchpoints as soon as the stack
812 frame of the current function has been destroyed. This mostly happens
813 as the first action in a function's epilogue. stack_frame_destroyed_p()
814 is defined to return a non-zero value if either the given addr is one
815 instruction after the stack destroying instruction up to the trailing
816 return instruction or if we can figure out that the stack frame has
817 already been invalidated regardless of the value of addr. Targets
818 which don't suffer from that problem could just let this functionality
819 untouched. */
823 extern void set_gdbarch_stack_frame_destroyed_p (struct gdbarch *gdbarch, gdbarch_stack_frame_destroyed_p_ftype *stack_frame_destroyed_p);
825 /* Process an ELF symbol in the minimal symbol table in a backend-specific
826 way. Normally this hook is supposed to do nothing, however if required,
827 then this hook can be used to apply tranformations to symbols that are
828 considered special in some way. For example the MIPS backend uses it
829 to interpret `st_other' information to mark compressed code symbols so
830 that they can be treated in the appropriate manner in the processing of
831 the main symbol table and DWARF-2 records. */
835 typedef void (gdbarch_elf_make_msymbol_special_ftype) (asymbol *sym, struct minimal_symbol *msym);
836 extern void gdbarch_elf_make_msymbol_special (struct gdbarch *gdbarch, asymbol *sym, struct minimal_symbol *msym);
837 extern void set_gdbarch_elf_make_msymbol_special (struct gdbarch *gdbarch, gdbarch_elf_make_msymbol_special_ftype *elf_make_msymbol_special);
840 extern void gdbarch_coff_make_msymbol_special (struct gdbarch *gdbarch, int val, struct minimal_symbol *msym);
841 extern void set_gdbarch_coff_make_msymbol_special (struct gdbarch *gdbarch, gdbarch_coff_make_msymbol_special_ftype *coff_make_msymbol_special);
843 /* Process a symbol in the main symbol table in a backend-specific way.
844 Normally this hook is supposed to do nothing, however if required,
845 then this hook can be used to apply tranformations to symbols that
846 are considered special in some way. This is currently used by the
847 MIPS backend to make sure compressed code symbols have the ISA bit
848 set. This in turn is needed for symbol values seen in GDB to match
849 the values used at the runtime by the program itself, for function
850 and label references. */
853 extern void gdbarch_make_symbol_special (struct gdbarch *gdbarch, struct symbol *sym, struct objfile *objfile);
854 extern void set_gdbarch_make_symbol_special (struct gdbarch *gdbarch, gdbarch_make_symbol_special_ftype *make_symbol_special);
856 /* Adjust the address retrieved from a DWARF-2 record other than a line
857 entry in a backend-specific way. Normally this hook is supposed to
858 return the address passed unchanged, however if that is incorrect for
859 any reason, then this hook can be used to fix the address up in the
860 required manner. This is currently used by the MIPS backend to make
861 sure addresses in FDE, range records, etc. referring to compressed
862 code have the ISA bit set, matching line information and the symbol
863 table. */
867 extern void set_gdbarch_adjust_dwarf2_addr (struct gdbarch *gdbarch, gdbarch_adjust_dwarf2_addr_ftype *adjust_dwarf2_addr);
869 /* Adjust the address updated by a line entry in a backend-specific way.
870 Normally this hook is supposed to return the address passed unchanged,
871 however in the case of inconsistencies in these records, this hook can
872 be used to fix them up in the required manner. This is currently used
873 by the MIPS backend to make sure all line addresses in compressed code
874 are presented with the ISA bit set, which is not always the case. This
875 in turn ensures breakpoint addresses are correctly matched against the
876 stop PC. */
880 extern void set_gdbarch_adjust_dwarf2_line (struct gdbarch *gdbarch, gdbarch_adjust_dwarf2_line_ftype *adjust_dwarf2_line);
883 extern void set_gdbarch_cannot_step_breakpoint (struct gdbarch *gdbarch, int cannot_step_breakpoint);
885 /* See comment in target.h about continuable, steppable and
886 non-steppable watchpoints. */
889 extern void set_gdbarch_have_nonsteppable_watchpoint (struct gdbarch *gdbarch, int have_nonsteppable_watchpoint);
893 typedef type_instance_flags (gdbarch_address_class_type_flags_ftype) (int byte_size, int dwarf2_addr_class);
894 extern type_instance_flags gdbarch_address_class_type_flags (struct gdbarch *gdbarch, int byte_size, int dwarf2_addr_class);
895 extern void set_gdbarch_address_class_type_flags (struct gdbarch *gdbarch, gdbarch_address_class_type_flags_ftype *address_class_type_flags);
899 typedef const char * (gdbarch_address_class_type_flags_to_name_ftype) (struct gdbarch *gdbarch, type_instance_flags type_flags);
900 extern const char * gdbarch_address_class_type_flags_to_name (struct gdbarch *gdbarch, type_instance_flags type_flags);
901 extern void set_gdbarch_address_class_type_flags_to_name (struct gdbarch *gdbarch, gdbarch_address_class_type_flags_to_name_ftype *address_class_type_flags_to_name);
903 /* Execute vendor-specific DWARF Call Frame Instruction. OP is the instruction.
904 FS are passed from the generic execute_cfa_program function. */
906 typedef bool (gdbarch_execute_dwarf_cfa_vendor_op_ftype) (struct gdbarch *gdbarch, gdb_byte op, struct dwarf2_frame_state *fs);
907 extern bool gdbarch_execute_dwarf_cfa_vendor_op (struct gdbarch *gdbarch, gdb_byte op, struct dwarf2_frame_state *fs);
908 extern void set_gdbarch_execute_dwarf_cfa_vendor_op (struct gdbarch *gdbarch, gdbarch_execute_dwarf_cfa_vendor_op_ftype *execute_dwarf_cfa_vendor_op);
910 /* Return the appropriate type_flags for the supplied address class.
911 This function should return true if the address class was recognized and
912 type_flags was set, false otherwise. */
916 typedef bool (gdbarch_address_class_name_to_type_flags_ftype) (struct gdbarch *gdbarch, const char *name, type_instance_flags *type_flags_ptr);
917 extern bool gdbarch_address_class_name_to_type_flags (struct gdbarch *gdbarch, const char *name, type_instance_flags *type_flags_ptr);
918 extern void set_gdbarch_address_class_name_to_type_flags (struct gdbarch *gdbarch, gdbarch_address_class_name_to_type_flags_ftype *address_class_name_to_type_flags);
920 /* Is a register in a group */
922 typedef int (gdbarch_register_reggroup_p_ftype) (struct gdbarch *gdbarch, int regnum, const struct reggroup *reggroup);
923 extern int gdbarch_register_reggroup_p (struct gdbarch *gdbarch, int regnum, const struct reggroup *reggroup);
924 extern void set_gdbarch_register_reggroup_p (struct gdbarch *gdbarch, gdbarch_register_reggroup_p_ftype *register_reggroup_p);
926 /* Fetch the pointer to the ith function argument. */
930 typedef CORE_ADDR (gdbarch_fetch_pointer_argument_ftype) (frame_info_ptr frame, int argi, struct type *type);
931 extern CORE_ADDR gdbarch_fetch_pointer_argument (struct gdbarch *gdbarch, frame_info_ptr frame, int argi, struct type *type);
932 extern void set_gdbarch_fetch_pointer_argument (struct gdbarch *gdbarch, gdbarch_fetch_pointer_argument_ftype *fetch_pointer_argument);
934 /* Iterate over all supported register notes in a core file. For each
935 supported register note section, the iterator must call CB and pass
936 CB_DATA unchanged. If REGCACHE is not NULL, the iterator can limit
937 the supported register note sections based on the current register
938 values. Otherwise it should enumerate all supported register note
939 sections. */
943 typedef void (gdbarch_iterate_over_regset_sections_ftype) (struct gdbarch *gdbarch, iterate_over_regset_sections_cb *cb, void *cb_data, const struct regcache *regcache);
944 extern void gdbarch_iterate_over_regset_sections (struct gdbarch *gdbarch, iterate_over_regset_sections_cb *cb, void *cb_data, const struct regcache *regcache);
945 extern void set_gdbarch_iterate_over_regset_sections (struct gdbarch *gdbarch, gdbarch_iterate_over_regset_sections_ftype *iterate_over_regset_sections);
947 /* Create core file notes */
951 typedef gdb::unique_xmalloc_ptr<char> (gdbarch_make_corefile_notes_ftype) (struct gdbarch *gdbarch, bfd *obfd, int *note_size);
952 extern gdb::unique_xmalloc_ptr<char> gdbarch_make_corefile_notes (struct gdbarch *gdbarch, bfd *obfd, int *note_size);
953 extern void set_gdbarch_make_corefile_notes (struct gdbarch *gdbarch, gdbarch_make_corefile_notes_ftype *make_corefile_notes);
955 /* Find core file memory regions */
959 typedef int (gdbarch_find_memory_regions_ftype) (struct gdbarch *gdbarch, find_memory_region_ftype func, void *data);
960 extern int gdbarch_find_memory_regions (struct gdbarch *gdbarch, find_memory_region_ftype func, void *data);
961 extern void set_gdbarch_find_memory_regions (struct gdbarch *gdbarch, gdbarch_find_memory_regions_ftype *find_memory_regions);
963 /* Given a bfd OBFD, segment ADDRESS and SIZE, create a memory tag section to be dumped to a core file */
967 typedef asection * (gdbarch_create_memtag_section_ftype) (struct gdbarch *gdbarch, bfd *obfd, CORE_ADDR address, size_t size);
968 extern asection * gdbarch_create_memtag_section (struct gdbarch *gdbarch, bfd *obfd, CORE_ADDR address, size_t size);
969 extern void set_gdbarch_create_memtag_section (struct gdbarch *gdbarch, gdbarch_create_memtag_section_ftype *create_memtag_section);
971 /* Given a memory tag section OSEC, fill OSEC's contents with the appropriate tag data */
977 extern void set_gdbarch_fill_memtag_section (struct gdbarch *gdbarch, gdbarch_fill_memtag_section_ftype *fill_memtag_section);
979 /* Decode a memory tag SECTION and return the tags of type TYPE contained in
980 the memory range [ADDRESS, ADDRESS + LENGTH).
981 If no tags were found, return an empty vector. */
985 typedef gdb::byte_vector (gdbarch_decode_memtag_section_ftype) (struct gdbarch *gdbarch, bfd_section *section, int type, CORE_ADDR address, size_t length);
986 extern gdb::byte_vector gdbarch_decode_memtag_section (struct gdbarch *gdbarch, bfd_section *section, int type, CORE_ADDR address, size_t length);
987 extern void set_gdbarch_decode_memtag_section (struct gdbarch *gdbarch, gdbarch_decode_memtag_section_ftype *decode_memtag_section);
989 /* Read offset OFFSET of TARGET_OBJECT_LIBRARIES formatted shared libraries list from
990 core file into buffer READBUF with length LEN. Return the number of bytes read
991 (zero indicates failure).
992 failed, otherwise, return the red length of READBUF. */
996 typedef ULONGEST (gdbarch_core_xfer_shared_libraries_ftype) (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
997 extern ULONGEST gdbarch_core_xfer_shared_libraries (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
998 extern void set_gdbarch_core_xfer_shared_libraries (struct gdbarch *gdbarch, gdbarch_core_xfer_shared_libraries_ftype *core_xfer_shared_libraries);
1000 /* Read offset OFFSET of TARGET_OBJECT_LIBRARIES_AIX formatted shared
1001 libraries list from core file into buffer READBUF with length LEN.
1002 Return the number of bytes read (zero indicates failure). */
1006 typedef ULONGEST (gdbarch_core_xfer_shared_libraries_aix_ftype) (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
1007 extern ULONGEST gdbarch_core_xfer_shared_libraries_aix (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
1008 extern void set_gdbarch_core_xfer_shared_libraries_aix (struct gdbarch *gdbarch, gdbarch_core_xfer_shared_libraries_aix_ftype *core_xfer_shared_libraries_aix);
1010 /* How the core target converts a PTID from a core file to a string. */
1016 extern void set_gdbarch_core_pid_to_str (struct gdbarch *gdbarch, gdbarch_core_pid_to_str_ftype *core_pid_to_str);
1018 /* How the core target extracts the name of a thread from a core file. */
1022 typedef const char * (gdbarch_core_thread_name_ftype) (struct gdbarch *gdbarch, struct thread_info *thr);
1023 extern const char * gdbarch_core_thread_name (struct gdbarch *gdbarch, struct thread_info *thr);
1024 extern void set_gdbarch_core_thread_name (struct gdbarch *gdbarch, gdbarch_core_thread_name_ftype *core_thread_name);
1026 /* Read offset OFFSET of TARGET_OBJECT_SIGNAL_INFO signal information
1027 from core file into buffer READBUF with length LEN. Return the number
1028 of bytes read (zero indicates EOF, a negative value indicates failure). */
1032 typedef LONGEST (gdbarch_core_xfer_siginfo_ftype) (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
1033 extern LONGEST gdbarch_core_xfer_siginfo (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
1034 extern void set_gdbarch_core_xfer_siginfo (struct gdbarch *gdbarch, gdbarch_core_xfer_siginfo_ftype *core_xfer_siginfo);
1036 /* Read x86 XSAVE layout information from core file into XSAVE_LAYOUT.
1037 Returns true if the layout was read successfully. */
1041 typedef bool (gdbarch_core_read_x86_xsave_layout_ftype) (struct gdbarch *gdbarch, x86_xsave_layout &xsave_layout);
1042 extern bool gdbarch_core_read_x86_xsave_layout (struct gdbarch *gdbarch, x86_xsave_layout &xsave_layout);
1043 extern void set_gdbarch_core_read_x86_xsave_layout (struct gdbarch *gdbarch, gdbarch_core_read_x86_xsave_layout_ftype *core_read_x86_xsave_layout);
1045 /* BFD target to use when generating a core file. */
1050 extern void set_gdbarch_gcore_bfd_target (struct gdbarch *gdbarch, const char * gcore_bfd_target);
1052 /* If the elements of C++ vtables are in-place function descriptors rather
1053 than normal function pointers (which may point to code or a descriptor),
1054 set this to one. */
1057 extern void set_gdbarch_vtable_function_descriptors (struct gdbarch *gdbarch, int vtable_function_descriptors);
1059 /* Set if the least significant bit of the delta is used instead of the least
1060 significant bit of the pfn for pointers to virtual member functions. */
1065 /* Advance PC to next instruction in order to skip a permanent breakpoint. */
1068 extern void gdbarch_skip_permanent_breakpoint (struct gdbarch *gdbarch, struct regcache *regcache);
1069 extern void set_gdbarch_skip_permanent_breakpoint (struct gdbarch *gdbarch, gdbarch_skip_permanent_breakpoint_ftype *skip_permanent_breakpoint);
1071 /* The maximum length of an instruction on this architecture in bytes. */
1078 /* Copy the instruction at FROM to TO, and make any adjustments
1079 necessary to single-step it at that address.
1081 REGS holds the state the thread's registers will have before
1082 executing the copied instruction; the PC in REGS will refer to FROM,
1083 not the copy at TO. The caller should update it to point at TO later.
1085 Return a pointer to data of the architecture's choice to be passed
1086 to gdbarch_displaced_step_fixup.
1088 For a general explanation of displaced stepping and how GDB uses it,
1089 see the comments in infrun.c.
1091 The TO area is only guaranteed to have space for
1092 gdbarch_displaced_step_buffer_length (arch) octets, so this
1093 function must not write more octets than that to this area.
1095 If you do not provide this function, GDB assumes that the
1096 architecture does not support displaced stepping.
1098 If the instruction cannot execute out of line, return NULL. The
1099 core falls back to stepping past the instruction in-line instead in
1100 that case. */
1104 typedef displaced_step_copy_insn_closure_up (gdbarch_displaced_step_copy_insn_ftype) (struct gdbarch *gdbarch, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
1105 extern displaced_step_copy_insn_closure_up gdbarch_displaced_step_copy_insn (struct gdbarch *gdbarch, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
1106 extern void set_gdbarch_displaced_step_copy_insn (struct gdbarch *gdbarch, gdbarch_displaced_step_copy_insn_ftype *displaced_step_copy_insn);
1108 /* Return true if GDB should use hardware single-stepping to execute a displaced
1109 step instruction. If false, GDB will simply restart execution at the
1110 displaced instruction location, and it is up to the target to ensure GDB will
1111 receive control again (e.g. by placing a software breakpoint instruction into
1112 the displaced instruction buffer).
1114 The default implementation returns false on all targets that provide a
1115 gdbarch_software_single_step routine, and true otherwise. */
1119 extern void set_gdbarch_displaced_step_hw_singlestep (struct gdbarch *gdbarch, gdbarch_displaced_step_hw_singlestep_ftype *displaced_step_hw_singlestep);
1121 /* Fix up the state after attempting to single-step a displaced
1122 instruction, to give the result we would have gotten from stepping the
1123 instruction in its original location.
1125 REGS is the register state resulting from single-stepping the
1126 displaced instruction.
1128 CLOSURE is the result from the matching call to
1129 gdbarch_displaced_step_copy_insn.
1131 FROM is the address where the instruction was original located, TO is
1132 the address of the displaced buffer where the instruction was copied
1133 to for stepping.
1135 COMPLETED_P is true if GDB stopped as a result of the requested step
1136 having completed (e.g. the inferior stopped with SIGTRAP), otherwise
1137 COMPLETED_P is false and GDB stopped for some other reason. In the
1138 case where a single instruction is expanded to multiple replacement
1139 instructions for stepping then it may be necessary to read the current
1140 program counter from REGS in order to decide how far through the
1141 series of replacement instructions the inferior got before stopping,
1142 this may impact what will need fixing up in this function.
1144 For a general explanation of displaced stepping and how GDB uses it,
1145 see the comments in infrun.c. */
1147 typedef void (gdbarch_displaced_step_fixup_ftype) (struct gdbarch *gdbarch, struct displaced_step_copy_insn_closure *closure, CORE_ADDR from, CORE_ADDR to, struct regcache *regs, bool completed_p);
1148 extern void gdbarch_displaced_step_fixup (struct gdbarch *gdbarch, struct displaced_step_copy_insn_closure *closure, CORE_ADDR from, CORE_ADDR to, struct regcache *regs, bool completed_p);
1149 extern void set_gdbarch_displaced_step_fixup (struct gdbarch *gdbarch, gdbarch_displaced_step_fixup_ftype *displaced_step_fixup);
1151 /* Prepare THREAD for it to displaced step the instruction at its current PC.
1153 Throw an exception if any unexpected error happens. */
1157 typedef displaced_step_prepare_status (gdbarch_displaced_step_prepare_ftype) (struct gdbarch *gdbarch, thread_info *thread, CORE_ADDR &displaced_pc);
1158 extern displaced_step_prepare_status gdbarch_displaced_step_prepare (struct gdbarch *gdbarch, thread_info *thread, CORE_ADDR &displaced_pc);
1159 extern void set_gdbarch_displaced_step_prepare (struct gdbarch *gdbarch, gdbarch_displaced_step_prepare_ftype *displaced_step_prepare);
1161 /* Clean up after a displaced step of THREAD.
1163 It is possible for the displaced-stepped instruction to have caused
1164 the thread to exit. The implementation can detect this case by
1165 checking if WS.kind is TARGET_WAITKIND_THREAD_EXITED. */
1167 typedef displaced_step_finish_status (gdbarch_displaced_step_finish_ftype) (struct gdbarch *gdbarch, thread_info *thread, const target_waitstatus &ws);
1168 extern displaced_step_finish_status gdbarch_displaced_step_finish (struct gdbarch *gdbarch, thread_info *thread, const target_waitstatus &ws);
1169 extern void set_gdbarch_displaced_step_finish (struct gdbarch *gdbarch, gdbarch_displaced_step_finish_ftype *displaced_step_finish);
1171 /* Return the closure associated to the displaced step buffer that is at ADDR. */
1175 typedef const displaced_step_copy_insn_closure * (gdbarch_displaced_step_copy_insn_closure_by_addr_ftype) (inferior *inf, CORE_ADDR addr);
1176 extern const displaced_step_copy_insn_closure * gdbarch_displaced_step_copy_insn_closure_by_addr (struct gdbarch *gdbarch, inferior *inf, CORE_ADDR addr);
1177 extern void set_gdbarch_displaced_step_copy_insn_closure_by_addr (struct gdbarch *gdbarch, gdbarch_displaced_step_copy_insn_closure_by_addr_ftype *displaced_step_copy_insn_closure_by_addr);
1179 /* PARENT_INF has forked and CHILD_PTID is the ptid of the child. Restore the
1180 contents of all displaced step buffers in the child's address space. */
1182 typedef void (gdbarch_displaced_step_restore_all_in_ptid_ftype) (inferior *parent_inf, ptid_t child_ptid);
1183 extern void gdbarch_displaced_step_restore_all_in_ptid (struct gdbarch *gdbarch, inferior *parent_inf, ptid_t child_ptid);
1184 extern void set_gdbarch_displaced_step_restore_all_in_ptid (struct gdbarch *gdbarch, gdbarch_displaced_step_restore_all_in_ptid_ftype *displaced_step_restore_all_in_ptid);
1186 /* The maximum length in octets required for a displaced-step instruction
1187 buffer. By default this will be the same as gdbarch::max_insn_length,
1188 but should be overridden for architectures that might expand a
1189 displaced-step instruction to multiple replacement instructions. */
1192 extern void set_gdbarch_displaced_step_buffer_length (struct gdbarch *gdbarch, ULONGEST displaced_step_buffer_length);
1194 /* Relocate an instruction to execute at a different address. OLDLOC
1195 is the address in the inferior memory where the instruction to
1196 relocate is currently at. On input, TO points to the destination
1197 where we want the instruction to be copied (and possibly adjusted)
1198 to. On output, it points to one past the end of the resulting
1199 instruction(s). The effect of executing the instruction at TO shall
1200 be the same as if executing it at FROM. For example, call
1201 instructions that implicitly push the return address on the stack
1202 should be adjusted to return to the instruction after OLDLOC;
1203 relative branches, and other PC-relative instructions need the
1204 offset adjusted; etc. */
1208 typedef void (gdbarch_relocate_instruction_ftype) (struct gdbarch *gdbarch, CORE_ADDR *to, CORE_ADDR from);
1209 extern void gdbarch_relocate_instruction (struct gdbarch *gdbarch, CORE_ADDR *to, CORE_ADDR from);
1210 extern void set_gdbarch_relocate_instruction (struct gdbarch *gdbarch, gdbarch_relocate_instruction_ftype *relocate_instruction);
1212 /* Refresh overlay mapped state for section OSECT. */
1218 extern void set_gdbarch_overlay_update (struct gdbarch *gdbarch, gdbarch_overlay_update_ftype *overlay_update);
1222 typedef const struct target_desc * (gdbarch_core_read_description_ftype) (struct gdbarch *gdbarch, struct target_ops *target, bfd *abfd);
1223 extern const struct target_desc * gdbarch_core_read_description (struct gdbarch *gdbarch, struct target_ops *target, bfd *abfd);
1224 extern void set_gdbarch_core_read_description (struct gdbarch *gdbarch, gdbarch_core_read_description_ftype *core_read_description);
1226 /* Set if the address in N_SO or N_FUN stabs may be zero. */
1229 extern void set_gdbarch_sofun_address_maybe_missing (struct gdbarch *gdbarch, int sofun_address_maybe_missing);
1231 /* Parse the instruction at ADDR storing in the record execution log
1232 the registers REGCACHE and memory ranges that will be affected when
1233 the instruction executes, along with their current values.
1234 Return -1 if something goes wrong, 0 otherwise. */
1238 typedef int (gdbarch_process_record_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr);
1239 extern int gdbarch_process_record (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr);
1240 extern void set_gdbarch_process_record (struct gdbarch *gdbarch, gdbarch_process_record_ftype *process_record);
1242 /* Save process state after a signal.
1243 Return -1 if something goes wrong, 0 otherwise. */
1247 typedef int (gdbarch_process_record_signal_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, enum gdb_signal signal);
1248 extern int gdbarch_process_record_signal (struct gdbarch *gdbarch, struct regcache *regcache, enum gdb_signal signal);
1249 extern void set_gdbarch_process_record_signal (struct gdbarch *gdbarch, gdbarch_process_record_signal_ftype *process_record_signal);
1251 /* Signal translation: translate inferior's signal (target's) number
1252 into GDB's representation. The implementation of this method must
1253 be host independent. IOW, don't rely on symbols of the NAT_FILE
1254 header (the nm-*.h files), the host <signal.h> header, or similar
1255 headers. This is mainly used when cross-debugging core files ---
1256 "Live" targets hide the translation behind the target interface
1257 (target_wait, target_resume, etc.). */
1261 typedef enum gdb_signal (gdbarch_gdb_signal_from_target_ftype) (struct gdbarch *gdbarch, int signo);
1263 extern void set_gdbarch_gdb_signal_from_target (struct gdbarch *gdbarch, gdbarch_gdb_signal_from_target_ftype *gdb_signal_from_target);
1265 /* Signal translation: translate the GDB's internal signal number into
1266 the inferior's signal (target's) representation. The implementation
1267 of this method must be host independent. IOW, don't rely on symbols
1268 of the NAT_FILE header (the nm-*.h files), the host <signal.h>
1269 header, or similar headers.
1270 Return the target signal number if found, or -1 if the GDB internal
1271 signal number is invalid. */
1275 typedef int (gdbarch_gdb_signal_to_target_ftype) (struct gdbarch *gdbarch, enum gdb_signal signal);
1277 extern void set_gdbarch_gdb_signal_to_target (struct gdbarch *gdbarch, gdbarch_gdb_signal_to_target_ftype *gdb_signal_to_target);
1279 /* Extra signal info inspection.
1281 Return a type suitable to inspect extra signal information. */
1287 extern void set_gdbarch_get_siginfo_type (struct gdbarch *gdbarch, gdbarch_get_siginfo_type_ftype *get_siginfo_type);
1289 /* Record architecture-specific information from the symbol table. */
1293 typedef void (gdbarch_record_special_symbol_ftype) (struct gdbarch *gdbarch, struct objfile *objfile, asymbol *sym);
1294 extern void gdbarch_record_special_symbol (struct gdbarch *gdbarch, struct objfile *objfile, asymbol *sym);
1295 extern void set_gdbarch_record_special_symbol (struct gdbarch *gdbarch, gdbarch_record_special_symbol_ftype *record_special_symbol);
1297 /* Function for the 'catch syscall' feature.
1298 Get architecture-specific system calls information from registers. */
1302 typedef LONGEST (gdbarch_get_syscall_number_ftype) (struct gdbarch *gdbarch, thread_info *thread);
1304 extern void set_gdbarch_get_syscall_number (struct gdbarch *gdbarch, gdbarch_get_syscall_number_ftype *get_syscall_number);
1306 /* The filename of the XML syscall for this architecture. */
1309 extern void set_gdbarch_xml_syscall_file (struct gdbarch *gdbarch, const char * xml_syscall_file);
1311 /* Information about system calls from this architecture */
1314 extern void set_gdbarch_syscalls_info (struct gdbarch *gdbarch, struct syscalls_info * syscalls_info);
1316 /* SystemTap related fields and functions.
1317 A NULL-terminated array of prefixes used to mark an integer constant
1318 on the architecture's assembly.
1319 For example, on x86 integer constants are written as:
1321 $10 ;; integer constant 10
1323 in this case, this prefix would be the character `$'. */
1326 extern void set_gdbarch_stap_integer_prefixes (struct gdbarch *gdbarch, const char *const * stap_integer_prefixes);
1328 /* A NULL-terminated array of suffixes used to mark an integer constant
1329 on the architecture's assembly. */
1332 extern void set_gdbarch_stap_integer_suffixes (struct gdbarch *gdbarch, const char *const * stap_integer_suffixes);
1334 /* A NULL-terminated array of prefixes used to mark a register name on
1335 the architecture's assembly.
1336 For example, on x86 the register name is written as:
1338 %eax ;; register eax
1340 in this case, this prefix would be the character `%'. */
1343 extern void set_gdbarch_stap_register_prefixes (struct gdbarch *gdbarch, const char *const * stap_register_prefixes);
1345 /* A NULL-terminated array of suffixes used to mark a register name on
1346 the architecture's assembly. */
1349 extern void set_gdbarch_stap_register_suffixes (struct gdbarch *gdbarch, const char *const * stap_register_suffixes);
1351 /* A NULL-terminated array of prefixes used to mark a register
1352 indirection on the architecture's assembly.
1353 For example, on x86 the register indirection is written as:
1355 (%eax) ;; indirecting eax
1357 in this case, this prefix would be the charater `('.
1359 Please note that we use the indirection prefix also for register
1360 displacement, e.g., `4(%eax)' on x86. */
1362 extern const char *const * gdbarch_stap_register_indirection_prefixes (struct gdbarch *gdbarch);
1363 extern void set_gdbarch_stap_register_indirection_prefixes (struct gdbarch *gdbarch, const char *const * stap_register_indirection_prefixes);
1365 /* A NULL-terminated array of suffixes used to mark a register
1366 indirection on the architecture's assembly.
1367 For example, on x86 the register indirection is written as:
1369 (%eax) ;; indirecting eax
1371 in this case, this prefix would be the charater `)'.
1373 Please note that we use the indirection suffix also for register
1374 displacement, e.g., `4(%eax)' on x86. */
1376 extern const char *const * gdbarch_stap_register_indirection_suffixes (struct gdbarch *gdbarch);
1377 extern void set_gdbarch_stap_register_indirection_suffixes (struct gdbarch *gdbarch, const char *const * stap_register_indirection_suffixes);
1379 /* Prefix(es) used to name a register using GDB's nomenclature.
1381 For example, on PPC a register is represented by a number in the assembly
1382 language (e.g., `10' is the 10th general-purpose register). However,
1383 inside GDB this same register has an `r' appended to its name, so the 10th
1384 register would be represented as `r10' internally. */
1387 extern void set_gdbarch_stap_gdb_register_prefix (struct gdbarch *gdbarch, const char * stap_gdb_register_prefix);
1389 /* Suffix used to name a register using GDB's nomenclature. */
1392 extern void set_gdbarch_stap_gdb_register_suffix (struct gdbarch *gdbarch, const char * stap_gdb_register_suffix);
1394 /* Check if S is a single operand.
1396 Single operands can be:
1397 - Literal integers, e.g. `$10' on x86
1398 - Register access, e.g. `%eax' on x86
1399 - Register indirection, e.g. `(%eax)' on x86
1400 - Register displacement, e.g. `4(%eax)' on x86
1402 This function should check for these patterns on the string
1403 and return 1 if some were found, or zero otherwise. Please try to match
1404 as much info as you can from the string, i.e., if you have to match
1405 something like `(%', do not match just the `('. */
1411 extern void set_gdbarch_stap_is_single_operand (struct gdbarch *gdbarch, gdbarch_stap_is_single_operand_ftype *stap_is_single_operand);
1413 /* Function used to handle a "special case" in the parser.
1415 A "special case" is considered to be an unknown token, i.e., a token
1416 that the parser does not know how to parse. A good example of special
1417 case would be ARM's register displacement syntax:
1419 [R0, #4] ;; displacing R0 by 4
1421 Since the parser assumes that a register displacement is of the form:
1423 <number> <indirection_prefix> <register_name> <indirection_suffix>
1425 it means that it will not be able to recognize and parse this odd syntax.
1426 Therefore, we should add a special case function that will handle this token.
1428 This function should generate the proper expression form of the expression
1429 using GDB's internal expression mechanism (e.g., `write_exp_elt_opcode'
1430 and so on). It should also return 1 if the parsing was successful, or zero
1431 if the token was not recognized as a special token (in this case, returning
1432 zero means that the special parser is deferring the parsing to the generic
1433 parser), and should advance the buffer pointer (p->arg). */
1437 typedef expr::operation_up (gdbarch_stap_parse_special_token_ftype) (struct gdbarch *gdbarch, struct stap_parse_info *p);
1438 extern expr::operation_up gdbarch_stap_parse_special_token (struct gdbarch *gdbarch, struct stap_parse_info *p);
1439 extern void set_gdbarch_stap_parse_special_token (struct gdbarch *gdbarch, gdbarch_stap_parse_special_token_ftype *stap_parse_special_token);
1441 /* Perform arch-dependent adjustments to a register name.
1443 In very specific situations, it may be necessary for the register
1444 name present in a SystemTap probe's argument to be handled in a
1445 special way. For example, on i386, GCC may over-optimize the
1446 register allocation and use smaller registers than necessary. In
1447 such cases, the client that is reading and evaluating the SystemTap
1448 probe (ourselves) will need to actually fetch values from the wider
1449 version of the register in question.
1451 To illustrate the example, consider the following probe argument
1452 (i386):
1454 4@%ax
1456 This argument says that its value can be found at the %ax register,
1457 which is a 16-bit register. However, the argument's prefix says
1458 that its type is "uint32_t", which is 32-bit in size. Therefore, in
1459 this case, GDB should actually fetch the probe's value from register
1460 %eax, not %ax. In this scenario, this function would actually
1461 replace the register name from %ax to %eax.
1463 The rationale for this can be found at PR breakpoints/24541. */
1467 typedef std::string (gdbarch_stap_adjust_register_ftype) (struct gdbarch *gdbarch, struct stap_parse_info *p, const std::string ®name, int regnum);
1468 extern std::string gdbarch_stap_adjust_register (struct gdbarch *gdbarch, struct stap_parse_info *p, const std::string ®name, int regnum);
1469 extern void set_gdbarch_stap_adjust_register (struct gdbarch *gdbarch, gdbarch_stap_adjust_register_ftype *stap_adjust_register);
1471 /* DTrace related functions.
1472 The expression to compute the NARTGth+1 argument to a DTrace USDT probe.
1473 NARG must be >= 0. */
1477 typedef expr::operation_up (gdbarch_dtrace_parse_probe_argument_ftype) (struct gdbarch *gdbarch, int narg);
1478 extern expr::operation_up gdbarch_dtrace_parse_probe_argument (struct gdbarch *gdbarch, int narg);
1479 extern void set_gdbarch_dtrace_parse_probe_argument (struct gdbarch *gdbarch, gdbarch_dtrace_parse_probe_argument_ftype *dtrace_parse_probe_argument);
1481 /* True if the given ADDR does not contain the instruction sequence
1482 corresponding to a disabled DTrace is-enabled probe. */
1488 extern void set_gdbarch_dtrace_probe_is_enabled (struct gdbarch *gdbarch, gdbarch_dtrace_probe_is_enabled_ftype *dtrace_probe_is_enabled);
1490 /* Enable a DTrace is-enabled probe at ADDR. */
1496 extern void set_gdbarch_dtrace_enable_probe (struct gdbarch *gdbarch, gdbarch_dtrace_enable_probe_ftype *dtrace_enable_probe);
1498 /* Disable a DTrace is-enabled probe at ADDR. */
1504 extern void set_gdbarch_dtrace_disable_probe (struct gdbarch *gdbarch, gdbarch_dtrace_disable_probe_ftype *dtrace_disable_probe);
1506 /* True if the list of shared libraries is one and only for all
1507 processes, as opposed to a list of shared libraries per inferior.
1508 This usually means that all processes, although may or may not share
1509 an address space, will see the same set of symbols at the same
1510 addresses. */
1515 /* On some targets, even though each inferior has its own private
1516 address space, the debug interface takes care of making breakpoints
1517 visible to all address spaces automatically. For such cases,
1518 this property should be set to true. */
1521 extern void set_gdbarch_has_global_breakpoints (struct gdbarch *gdbarch, int has_global_breakpoints);
1523 /* True if inferiors share an address space (e.g., uClinux). */
1527 extern void set_gdbarch_has_shared_address_space (struct gdbarch *gdbarch, gdbarch_has_shared_address_space_ftype *has_shared_address_space);
1529 /* True if a fast tracepoint can be set at an address. */
1531 typedef int (gdbarch_fast_tracepoint_valid_at_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr, std::string *msg);
1532 extern int gdbarch_fast_tracepoint_valid_at (struct gdbarch *gdbarch, CORE_ADDR addr, std::string *msg);
1533 extern void set_gdbarch_fast_tracepoint_valid_at (struct gdbarch *gdbarch, gdbarch_fast_tracepoint_valid_at_ftype *fast_tracepoint_valid_at);
1535 /* Guess register state based on tracepoint location. Used for tracepoints
1536 where no registers have been collected, but there's only one location,
1537 allowing us to guess the PC value, and perhaps some other registers.
1538 On entry, regcache has all registers marked as unavailable. */
1540 typedef void (gdbarch_guess_tracepoint_registers_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr);
1541 extern void gdbarch_guess_tracepoint_registers (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr);
1542 extern void set_gdbarch_guess_tracepoint_registers (struct gdbarch *gdbarch, gdbarch_guess_tracepoint_registers_ftype *guess_tracepoint_registers);
1544 /* Return the "auto" target charset. */
1548 extern void set_gdbarch_auto_charset (struct gdbarch *gdbarch, gdbarch_auto_charset_ftype *auto_charset);
1550 /* Return the "auto" target wide charset. */
1554 extern void set_gdbarch_auto_wide_charset (struct gdbarch *gdbarch, gdbarch_auto_wide_charset_ftype *auto_wide_charset);
1556 /* If non-empty, this is a file extension that will be opened in place
1557 of the file extension reported by the shared library list.
1559 This is most useful for toolchains that use a post-linker tool,
1560 where the names of the files run on the target differ in extension
1561 compared to the names of the files GDB should load for debug info. */
1564 extern void set_gdbarch_solib_symbols_extension (struct gdbarch *gdbarch, const char * solib_symbols_extension);
1566 /* If true, the target OS has DOS-based file system semantics. That
1567 is, absolute paths include a drive name, and the backslash is
1568 considered a directory separator. */
1571 extern void set_gdbarch_has_dos_based_file_system (struct gdbarch *gdbarch, int has_dos_based_file_system);
1573 /* Generate bytecodes to collect the return address in a frame.
1574 Since the bytecodes run on the target, possibly with GDB not even
1575 connected, the full unwinding machinery is not available, and
1576 typically this function will issue bytecodes for one or more likely
1577 places that the return address may be found. */
1579 typedef void (gdbarch_gen_return_address_ftype) (struct gdbarch *gdbarch, struct agent_expr *ax, struct axs_value *value, CORE_ADDR scope);
1580 extern void gdbarch_gen_return_address (struct gdbarch *gdbarch, struct agent_expr *ax, struct axs_value *value, CORE_ADDR scope);
1581 extern void set_gdbarch_gen_return_address (struct gdbarch *gdbarch, gdbarch_gen_return_address_ftype *gen_return_address);
1583 /* Implement the "info proc" command. */
1587 typedef void (gdbarch_info_proc_ftype) (struct gdbarch *gdbarch, const char *args, enum info_proc_what what);
1588 extern void gdbarch_info_proc (struct gdbarch *gdbarch, const char *args, enum info_proc_what what);
1589 extern void set_gdbarch_info_proc (struct gdbarch *gdbarch, gdbarch_info_proc_ftype *info_proc);
1591 /* Implement the "info proc" command for core files. Noe that there
1592 are two "info_proc"-like methods on gdbarch -- one for core files,
1593 one for live targets. */
1597 typedef void (gdbarch_core_info_proc_ftype) (struct gdbarch *gdbarch, const char *args, enum info_proc_what what);
1598 extern void gdbarch_core_info_proc (struct gdbarch *gdbarch, const char *args, enum info_proc_what what);
1599 extern void set_gdbarch_core_info_proc (struct gdbarch *gdbarch, gdbarch_core_info_proc_ftype *core_info_proc);
1601 /* Iterate over all objfiles in the order that makes the most sense
1602 for the architecture to make global symbol searches.
1604 CB is a callback function passed an objfile to be searched. The iteration stops
1605 if this function returns nonzero.
1607 If not NULL, CURRENT_OBJFILE corresponds to the objfile being
1608 inspected when the symbol search was requested. */
1610 typedef void (gdbarch_iterate_over_objfiles_in_search_order_ftype) (struct gdbarch *gdbarch, iterate_over_objfiles_in_search_order_cb_ftype cb, struct objfile *current_objfile);
1611 extern void gdbarch_iterate_over_objfiles_in_search_order (struct gdbarch *gdbarch, iterate_over_objfiles_in_search_order_cb_ftype cb, struct objfile *current_objfile);
1612 extern void set_gdbarch_iterate_over_objfiles_in_search_order (struct gdbarch *gdbarch, gdbarch_iterate_over_objfiles_in_search_order_ftype *iterate_over_objfiles_in_search_order);
1614 /* Ravenscar arch-dependent ops. */
1617 extern void set_gdbarch_ravenscar_ops (struct gdbarch *gdbarch, struct ravenscar_arch_ops * ravenscar_ops);
1619 /* Return non-zero if the instruction at ADDR is a call; zero otherwise. */
1623 extern void set_gdbarch_insn_is_call (struct gdbarch *gdbarch, gdbarch_insn_is_call_ftype *insn_is_call);
1625 /* Return non-zero if the instruction at ADDR is a return; zero otherwise. */
1629 extern void set_gdbarch_insn_is_ret (struct gdbarch *gdbarch, gdbarch_insn_is_ret_ftype *insn_is_ret);
1631 /* Return non-zero if the instruction at ADDR is a jump; zero otherwise. */
1635 extern void set_gdbarch_insn_is_jump (struct gdbarch *gdbarch, gdbarch_insn_is_jump_ftype *insn_is_jump);
1637 /* Return true if there's a program/permanent breakpoint planted in
1638 memory at ADDRESS, return false otherwise. */
1640 typedef bool (gdbarch_program_breakpoint_here_p_ftype) (struct gdbarch *gdbarch, CORE_ADDR address);
1642 extern void set_gdbarch_program_breakpoint_here_p (struct gdbarch *gdbarch, gdbarch_program_breakpoint_here_p_ftype *program_breakpoint_here_p);
1644 /* Read one auxv entry from *READPTR, not reading locations >= ENDPTR.
1645 Return 0 if *READPTR is already at the end of the buffer.
1646 Return -1 if there is insufficient buffer for a whole entry.
1647 Return 1 if an entry was read into *TYPEP and *VALP. */
1651 typedef int (gdbarch_auxv_parse_ftype) (struct gdbarch *gdbarch, const gdb_byte **readptr, const gdb_byte *endptr, CORE_ADDR *typep, CORE_ADDR *valp);
1652 extern int gdbarch_auxv_parse (struct gdbarch *gdbarch, const gdb_byte **readptr, const gdb_byte *endptr, CORE_ADDR *typep, CORE_ADDR *valp);
1653 extern void set_gdbarch_auxv_parse (struct gdbarch *gdbarch, gdbarch_auxv_parse_ftype *auxv_parse);
1655 /* Print the description of a single auxv entry described by TYPE and VAL
1656 to FILE. */
1658 typedef void (gdbarch_print_auxv_entry_ftype) (struct gdbarch *gdbarch, struct ui_file *file, CORE_ADDR type, CORE_ADDR val);
1659 extern void gdbarch_print_auxv_entry (struct gdbarch *gdbarch, struct ui_file *file, CORE_ADDR type, CORE_ADDR val);
1660 extern void set_gdbarch_print_auxv_entry (struct gdbarch *gdbarch, gdbarch_print_auxv_entry_ftype *print_auxv_entry);
1662 /* Find the address range of the current inferior's vsyscall/vDSO, and
1663 write it to *RANGE. If the vsyscall's length can't be determined, a
1664 range with zero length is returned. Returns true if the vsyscall is
1665 found, false otherwise. */
1669 extern void set_gdbarch_vsyscall_range (struct gdbarch *gdbarch, gdbarch_vsyscall_range_ftype *vsyscall_range);
1671 /* Allocate SIZE bytes of PROT protected page aligned memory in inferior.
1672 PROT has GDB_MMAP_PROT_* bitmask format.
1673 Throw an error if it is not possible. Returned address is always valid. */
1676 extern CORE_ADDR gdbarch_infcall_mmap (struct gdbarch *gdbarch, CORE_ADDR size, unsigned prot);
1677 extern void set_gdbarch_infcall_mmap (struct gdbarch *gdbarch, gdbarch_infcall_mmap_ftype *infcall_mmap);
1679 /* Deallocate SIZE bytes of memory at ADDR in inferior from gdbarch_infcall_mmap.
1680 Print a warning if it is not possible. */
1684 extern void set_gdbarch_infcall_munmap (struct gdbarch *gdbarch, gdbarch_infcall_munmap_ftype *infcall_munmap);
1686 /* Return string (caller has to use xfree for it) with options for GCC
1687 to produce code for this target, typically "-m64", "-m32" or "-m31".
1688 These options are put before CU's DW_AT_producer compilation options so that
1689 they can override it. */
1693 extern void set_gdbarch_gcc_target_options (struct gdbarch *gdbarch, gdbarch_gcc_target_options_ftype *gcc_target_options);
1695 /* Return a regular expression that matches names used by this
1696 architecture in GNU configury triplets. The result is statically
1697 allocated and must not be freed. The default implementation simply
1698 returns the BFD architecture name, which is correct in nearly every
1699 case. */
1703 extern void set_gdbarch_gnu_triplet_regexp (struct gdbarch *gdbarch, gdbarch_gnu_triplet_regexp_ftype *gnu_triplet_regexp);
1705 /* Return the size in 8-bit bytes of an addressable memory unit on this
1706 architecture. This corresponds to the number of 8-bit bytes associated to
1707 each address in memory. */
1711 extern void set_gdbarch_addressable_memory_unit_size (struct gdbarch *gdbarch, gdbarch_addressable_memory_unit_size_ftype *addressable_memory_unit_size);
1713 /* Functions for allowing a target to modify its disassembler options. */
1716 extern void set_gdbarch_disassembler_options_implicit (struct gdbarch *gdbarch, const char * disassembler_options_implicit);
1719 extern void set_gdbarch_disassembler_options (struct gdbarch *gdbarch, char ** disassembler_options);
1721 extern const disasm_options_and_args_t * gdbarch_valid_disassembler_options (struct gdbarch *gdbarch);
1722 extern void set_gdbarch_valid_disassembler_options (struct gdbarch *gdbarch, const disasm_options_and_args_t * valid_disassembler_options);
1724 /* Type alignment override method. Return the architecture specific
1725 alignment required for TYPE. If there is no special handling
1726 required for TYPE then return the value 0, GDB will then apply the
1727 default rules as laid out in gdbtypes.c:type_align. */
1731 extern void set_gdbarch_type_align (struct gdbarch *gdbarch, gdbarch_type_align_ftype *type_align);
1733 /* Return a string containing any flags for the given PC in the given FRAME. */
1736 extern std::string gdbarch_get_pc_address_flags (struct gdbarch *gdbarch, frame_info_ptr frame, CORE_ADDR pc);
1737 extern void set_gdbarch_get_pc_address_flags (struct gdbarch *gdbarch, gdbarch_get_pc_address_flags_ftype *get_pc_address_flags);
1739 /* Read core file mappings */
1741 typedef void (gdbarch_read_core_file_mappings_ftype) (struct gdbarch *gdbarch, struct bfd *cbfd, read_core_file_mappings_pre_loop_ftype pre_loop_cb, read_core_file_mappings_loop_ftype loop_cb);
1742 extern void gdbarch_read_core_file_mappings (struct gdbarch *gdbarch, struct bfd *cbfd, read_core_file_mappings_pre_loop_ftype pre_loop_cb, read_core_file_mappings_loop_ftype loop_cb);
1743 extern void set_gdbarch_read_core_file_mappings (struct gdbarch *gdbarch, gdbarch_read_core_file_mappings_ftype *read_core_file_mappings);
1745 /* Return true if the target description for all threads should be read from the
1746 target description core file note(s). Return false if the target description
1747 for all threads should be inferred from the core file contents/sections.
1749 The corefile's bfd is passed through COREFILE_BFD. */
1751 typedef bool (gdbarch_use_target_description_from_corefile_notes_ftype) (struct gdbarch *gdbarch, struct bfd *corefile_bfd);
1752 extern bool gdbarch_use_target_description_from_corefile_notes (struct gdbarch *gdbarch, struct bfd *corefile_bfd);
1753 extern void set_gdbarch_use_target_description_from_corefile_notes (struct gdbarch *gdbarch, gdbarch_use_target_description_from_corefile_notes_ftype *use_target_description_from_corefile_notes);