gdb/gdbarch-gen.h

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