gdb/gdbarch.h

   1 /* *INDENT-OFF* */ /* THIS FILE IS GENERATED */
   2
   3 /* Dynamic architecture support for GDB, the GNU debugger.
   4
   5    Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007
   6    Free Software Foundation, Inc.
   7
   8    This file is part of GDB.
   9
  10    This program is free software; you can redistribute it and/or modify
  11    it under the terms of the GNU General Public License as published by
  12    the Free Software Foundation; either version 3 of the License, or
  13    (at your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18    GNU General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  22
  23 /* This file was created with the aid of ``gdbarch.sh''.
  24
  25    The Bourne shell script ``gdbarch.sh'' creates the files
  26    ``new-gdbarch.c'' and ``new-gdbarch.h and then compares them
  27    against the existing ``gdbarch.[hc]''.  Any differences found
  28    being reported.
  29
  30    If editing this file, please also run gdbarch.sh and merge any
  31    changes into that script. Conversely, when making sweeping changes
  32    to this file, modifying gdbarch.sh and using its output may prove
  33    easier. */
  34
  35 #ifndef GDBARCH_H
  36 #define GDBARCH_H
  37
  38 struct floatformat;
  39 struct ui_file;
  40 struct frame_info;
  41 struct value;
  42 struct objfile;
  43 struct obj_section;
  44 struct minimal_symbol;
  45 struct regcache;
  46 struct reggroup;
  47 struct regset;
  48 struct disassemble_info;
  49 struct target_ops;
  50 struct obstack;
  51 struct bp_target_info;
  52 struct target_desc;
  53 struct displaced_step_closure;
  54
  55 extern struct gdbarch *current_gdbarch;
  56
  57
  58 /* The following are pre-initialized by GDBARCH. */
  59
  60 extern const struct bfd_arch_info * gdbarch_bfd_arch_info (struct gdbarch *gdbarch);
  61 /* set_gdbarch_bfd_arch_info() - not applicable - pre-initialized. */
  62
  63 extern int gdbarch_byte_order (struct gdbarch *gdbarch);
  64 /* set_gdbarch_byte_order() - not applicable - pre-initialized. */
  65
  66 extern enum gdb_osabi gdbarch_osabi (struct gdbarch *gdbarch);
  67 /* set_gdbarch_osabi() - not applicable - pre-initialized. */
  68
  69 extern const struct target_desc * gdbarch_target_desc (struct gdbarch *gdbarch);
  70 /* set_gdbarch_target_desc() - not applicable - pre-initialized. */
  71
  72
  73 /* The following are initialized by the target dependent code. */
  74
  75 /* The bit byte-order has to do just with numbering of bits in debugging symbols
  76    and such.  Conceptually, it's quite separate from byte/word byte order. */
  77
  78 extern int gdbarch_bits_big_endian (struct gdbarch *gdbarch);
  79 extern void set_gdbarch_bits_big_endian (struct gdbarch *gdbarch, int bits_big_endian);
  80
  81 /* Number of bits in a char or unsigned char for the target machine.
  82    Just like CHAR_BIT in <limits.h> but describes the target machine.
  83    v:TARGET_CHAR_BIT:int:char_bit::::8 * sizeof (char):8::0:
  84
  85    Number of bits in a short or unsigned short for the target machine. */
  86
  87 extern int gdbarch_short_bit (struct gdbarch *gdbarch);
  88 extern void set_gdbarch_short_bit (struct gdbarch *gdbarch, int short_bit);
  89
  90 /* Number of bits in an int or unsigned int for the target machine. */
  91
  92 extern int gdbarch_int_bit (struct gdbarch *gdbarch);
  93 extern void set_gdbarch_int_bit (struct gdbarch *gdbarch, int int_bit);
  94
  95 /* Number of bits in a long or unsigned long for the target machine. */
  96
  97 extern int gdbarch_long_bit (struct gdbarch *gdbarch);
  98 extern void set_gdbarch_long_bit (struct gdbarch *gdbarch, int long_bit);
  99
 100 /* Number of bits in a long long or unsigned long long for the target
 101    machine. */
 102
 103 extern int gdbarch_long_long_bit (struct gdbarch *gdbarch);
 104 extern void set_gdbarch_long_long_bit (struct gdbarch *gdbarch, int long_long_bit);
 105
 106 /* The ABI default bit-size and format for "float", "double", and "long
 107    double".  These bit/format pairs should eventually be combined into
 108    a single object.  For the moment, just initialize them as a pair.
 109    Each format describes both the big and little endian layouts (if
 110    useful). */
 111
 112 extern int gdbarch_float_bit (struct gdbarch *gdbarch);
 113 extern void set_gdbarch_float_bit (struct gdbarch *gdbarch, int float_bit);
 114
 115 extern const struct floatformat ** gdbarch_float_format (struct gdbarch *gdbarch);
 116 extern void set_gdbarch_float_format (struct gdbarch *gdbarch, const struct floatformat ** float_format);
 117
 118 extern int gdbarch_double_bit (struct gdbarch *gdbarch);
 119 extern void set_gdbarch_double_bit (struct gdbarch *gdbarch, int double_bit);
 120
 121 extern const struct floatformat ** gdbarch_double_format (struct gdbarch *gdbarch);
 122 extern void set_gdbarch_double_format (struct gdbarch *gdbarch, const struct floatformat ** double_format);
 123
 124 extern int gdbarch_long_double_bit (struct gdbarch *gdbarch);
 125 extern void set_gdbarch_long_double_bit (struct gdbarch *gdbarch, int long_double_bit);
 126
 127 extern const struct floatformat ** gdbarch_long_double_format (struct gdbarch *gdbarch);
 128 extern void set_gdbarch_long_double_format (struct gdbarch *gdbarch, const struct floatformat ** long_double_format);
 129
 130 /* For most targets, a pointer on the target and its representation as an
 131    address in GDB have the same size and "look the same".  For such a
 132    target, you need only set gdbarch_ptr_bit and gdbarch_addr_bit
 133    / addr_bit will be set from it.
 134
 135    If gdbarch_ptr_bit and gdbarch_addr_bit are different, you'll probably
 136    also need to set gdbarch_pointer_to_address and gdbarch_address_to_pointer
 137    as well.
 138
 139    ptr_bit is the size of a pointer on the target */
 140
 141 extern int gdbarch_ptr_bit (struct gdbarch *gdbarch);
 142 extern void set_gdbarch_ptr_bit (struct gdbarch *gdbarch, int ptr_bit);
 143
 144 /* addr_bit is the size of a target address as represented in gdb */
 145
 146 extern int gdbarch_addr_bit (struct gdbarch *gdbarch);
 147 extern void set_gdbarch_addr_bit (struct gdbarch *gdbarch, int addr_bit);
 148
 149 /* One if `char' acts like `signed char', zero if `unsigned char'. */
 150
 151 extern int gdbarch_char_signed (struct gdbarch *gdbarch);
 152 extern void set_gdbarch_char_signed (struct gdbarch *gdbarch, int char_signed);
 153
 154 extern int gdbarch_read_pc_p (struct gdbarch *gdbarch);
 155
 156 typedef CORE_ADDR (gdbarch_read_pc_ftype) (struct regcache *regcache);
 157 extern CORE_ADDR gdbarch_read_pc (struct gdbarch *gdbarch, struct regcache *regcache);
 158 extern void set_gdbarch_read_pc (struct gdbarch *gdbarch, gdbarch_read_pc_ftype *read_pc);
 159
 160 extern int gdbarch_write_pc_p (struct gdbarch *gdbarch);
 161
 162 typedef void (gdbarch_write_pc_ftype) (struct regcache *regcache, CORE_ADDR val);
 163 extern void gdbarch_write_pc (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR val);
 164 extern void set_gdbarch_write_pc (struct gdbarch *gdbarch, gdbarch_write_pc_ftype *write_pc);
 165
 166 /* Function for getting target's idea of a frame pointer.  FIXME: GDB's
 167    whole scheme for dealing with "frames" and "frame pointers" needs a
 168    serious shakedown. */
 169
 170 typedef void (gdbarch_virtual_frame_pointer_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc, int *frame_regnum, LONGEST *frame_offset);
 171 extern void gdbarch_virtual_frame_pointer (struct gdbarch *gdbarch, CORE_ADDR pc, int *frame_regnum, LONGEST *frame_offset);
 172 extern void set_gdbarch_virtual_frame_pointer (struct gdbarch *gdbarch, gdbarch_virtual_frame_pointer_ftype *virtual_frame_pointer);
 173
 174 extern int gdbarch_pseudo_register_read_p (struct gdbarch *gdbarch);
 175
 176 typedef void (gdbarch_pseudo_register_read_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, gdb_byte *buf);
 177 extern void gdbarch_pseudo_register_read (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, gdb_byte *buf);
 178 extern void set_gdbarch_pseudo_register_read (struct gdbarch *gdbarch, gdbarch_pseudo_register_read_ftype *pseudo_register_read);
 179
 180 extern int gdbarch_pseudo_register_write_p (struct gdbarch *gdbarch);
 181
 182 typedef void (gdbarch_pseudo_register_write_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, const gdb_byte *buf);
 183 extern void gdbarch_pseudo_register_write (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, const gdb_byte *buf);
 184 extern void set_gdbarch_pseudo_register_write (struct gdbarch *gdbarch, gdbarch_pseudo_register_write_ftype *pseudo_register_write);
 185
 186 extern int gdbarch_num_regs (struct gdbarch *gdbarch);
 187 extern void set_gdbarch_num_regs (struct gdbarch *gdbarch, int num_regs);
 188
 189 /* This macro gives the number of pseudo-registers that live in the
 190    register namespace but do not get fetched or stored on the target.
 191    These pseudo-registers may be aliases for other registers,
 192    combinations of other registers, or they may be computed by GDB. */
 193
 194 extern int gdbarch_num_pseudo_regs (struct gdbarch *gdbarch);
 195 extern void set_gdbarch_num_pseudo_regs (struct gdbarch *gdbarch, int num_pseudo_regs);
 196
 197 /* GDB's standard (or well known) register numbers.  These can map onto
 198    a real register or a pseudo (computed) register or not be defined at
 199    all (-1).
 200    gdbarch_sp_regnum will hopefully be replaced by UNWIND_SP. */
 201
 202 extern int gdbarch_sp_regnum (struct gdbarch *gdbarch);
 203 extern void set_gdbarch_sp_regnum (struct gdbarch *gdbarch, int sp_regnum);
 204
 205 extern int gdbarch_pc_regnum (struct gdbarch *gdbarch);
 206 extern void set_gdbarch_pc_regnum (struct gdbarch *gdbarch, int pc_regnum);
 207
 208 extern int gdbarch_ps_regnum (struct gdbarch *gdbarch);
 209 extern void set_gdbarch_ps_regnum (struct gdbarch *gdbarch, int ps_regnum);
 210
 211 extern int gdbarch_fp0_regnum (struct gdbarch *gdbarch);
 212 extern void set_gdbarch_fp0_regnum (struct gdbarch *gdbarch, int fp0_regnum);
 213
 214 /* Convert stab register number (from `r' declaration) to a gdb REGNUM. */
 215
 216 typedef int (gdbarch_stab_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int stab_regnr);
 217 extern int gdbarch_stab_reg_to_regnum (struct gdbarch *gdbarch, int stab_regnr);
 218 extern void set_gdbarch_stab_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_stab_reg_to_regnum_ftype *stab_reg_to_regnum);
 219
 220 /* Provide a default mapping from a ecoff register number to a gdb REGNUM. */
 221
 222 typedef int (gdbarch_ecoff_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int ecoff_regnr);
 223 extern int gdbarch_ecoff_reg_to_regnum (struct gdbarch *gdbarch, int ecoff_regnr);
 224 extern void set_gdbarch_ecoff_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_ecoff_reg_to_regnum_ftype *ecoff_reg_to_regnum);
 225
 226 /* Provide a default mapping from a DWARF register number to a gdb REGNUM. */
 227
 228 typedef int (gdbarch_dwarf_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int dwarf_regnr);
 229 extern int gdbarch_dwarf_reg_to_regnum (struct gdbarch *gdbarch, int dwarf_regnr);
 230 extern void set_gdbarch_dwarf_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_dwarf_reg_to_regnum_ftype *dwarf_reg_to_regnum);
 231
 232 /* Convert from an sdb register number to an internal gdb register number. */
 233
 234 typedef int (gdbarch_sdb_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int sdb_regnr);
 235 extern int gdbarch_sdb_reg_to_regnum (struct gdbarch *gdbarch, int sdb_regnr);
 236 extern void set_gdbarch_sdb_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_sdb_reg_to_regnum_ftype *sdb_reg_to_regnum);
 237
 238 typedef int (gdbarch_dwarf2_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int dwarf2_regnr);
 239 extern int gdbarch_dwarf2_reg_to_regnum (struct gdbarch *gdbarch, int dwarf2_regnr);
 240 extern void set_gdbarch_dwarf2_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_dwarf2_reg_to_regnum_ftype *dwarf2_reg_to_regnum);
 241
 242 typedef const char * (gdbarch_register_name_ftype) (struct gdbarch *gdbarch, int regnr);
 243 extern const char * gdbarch_register_name (struct gdbarch *gdbarch, int regnr);
 244 extern void set_gdbarch_register_name (struct gdbarch *gdbarch, gdbarch_register_name_ftype *register_name);
 245
 246 /* Return the type of a register specified by the architecture.  Only
 247    the register cache should call this function directly; others should
 248    use "register_type". */
 249
 250 extern int gdbarch_register_type_p (struct gdbarch *gdbarch);
 251
 252 typedef struct type * (gdbarch_register_type_ftype) (struct gdbarch *gdbarch, int reg_nr);
 253 extern struct type * gdbarch_register_type (struct gdbarch *gdbarch, int reg_nr);
 254 extern void set_gdbarch_register_type (struct gdbarch *gdbarch, gdbarch_register_type_ftype *register_type);
 255
 256 /* See gdbint.texinfo, and PUSH_DUMMY_CALL. */
 257
 258 extern int gdbarch_dummy_id_p (struct gdbarch *gdbarch);
 259
 260 typedef struct frame_id (gdbarch_dummy_id_ftype) (struct gdbarch *gdbarch, struct frame_info *this_frame);
 261 extern struct frame_id gdbarch_dummy_id (struct gdbarch *gdbarch, struct frame_info *this_frame);
 262 extern void set_gdbarch_dummy_id (struct gdbarch *gdbarch, gdbarch_dummy_id_ftype *dummy_id);
 263
 264 /* Implement DUMMY_ID and PUSH_DUMMY_CALL, then delete
 265    deprecated_fp_regnum. */
 266
 267 extern int gdbarch_deprecated_fp_regnum (struct gdbarch *gdbarch);
 268 extern void set_gdbarch_deprecated_fp_regnum (struct gdbarch *gdbarch, int deprecated_fp_regnum);
 269
 270 /* See gdbint.texinfo.  See infcall.c. */
 271
 272 extern int gdbarch_push_dummy_call_p (struct gdbarch *gdbarch);
 273
 274 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, int struct_return, CORE_ADDR struct_addr);
 275 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, int struct_return, CORE_ADDR struct_addr);
 276 extern void set_gdbarch_push_dummy_call (struct gdbarch *gdbarch, gdbarch_push_dummy_call_ftype *push_dummy_call);
 277
 278 extern int gdbarch_call_dummy_location (struct gdbarch *gdbarch);
 279 extern void set_gdbarch_call_dummy_location (struct gdbarch *gdbarch, int call_dummy_location);
 280
 281 extern int gdbarch_push_dummy_code_p (struct gdbarch *gdbarch);
 282
 283 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);
 284 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);
 285 extern void set_gdbarch_push_dummy_code (struct gdbarch *gdbarch, gdbarch_push_dummy_code_ftype *push_dummy_code);
 286
 287 typedef void (gdbarch_print_registers_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, int regnum, int all);
 288 extern void gdbarch_print_registers_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, int regnum, int all);
 289 extern void set_gdbarch_print_registers_info (struct gdbarch *gdbarch, gdbarch_print_registers_info_ftype *print_registers_info);
 290
 291 extern int gdbarch_print_float_info_p (struct gdbarch *gdbarch);
 292
 293 typedef void (gdbarch_print_float_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
 294 extern void gdbarch_print_float_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
 295 extern void set_gdbarch_print_float_info (struct gdbarch *gdbarch, gdbarch_print_float_info_ftype *print_float_info);
 296
 297 extern int gdbarch_print_vector_info_p (struct gdbarch *gdbarch);
 298
 299 typedef void (gdbarch_print_vector_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
 300 extern void gdbarch_print_vector_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
 301 extern void set_gdbarch_print_vector_info (struct gdbarch *gdbarch, gdbarch_print_vector_info_ftype *print_vector_info);
 302
 303 /* MAP a GDB RAW register number onto a simulator register number.  See
 304    also include/...-sim.h. */
 305
 306 typedef int (gdbarch_register_sim_regno_ftype) (struct gdbarch *gdbarch, int reg_nr);
 307 extern int gdbarch_register_sim_regno (struct gdbarch *gdbarch, int reg_nr);
 308 extern void set_gdbarch_register_sim_regno (struct gdbarch *gdbarch, gdbarch_register_sim_regno_ftype *register_sim_regno);
 309
 310 typedef int (gdbarch_cannot_fetch_register_ftype) (struct gdbarch *gdbarch, int regnum);
 311 extern int gdbarch_cannot_fetch_register (struct gdbarch *gdbarch, int regnum);
 312 extern void set_gdbarch_cannot_fetch_register (struct gdbarch *gdbarch, gdbarch_cannot_fetch_register_ftype *cannot_fetch_register);
 313
 314 typedef int (gdbarch_cannot_store_register_ftype) (struct gdbarch *gdbarch, int regnum);
 315 extern int gdbarch_cannot_store_register (struct gdbarch *gdbarch, int regnum);
 316 extern void set_gdbarch_cannot_store_register (struct gdbarch *gdbarch, gdbarch_cannot_store_register_ftype *cannot_store_register);
 317
 318 /* setjmp/longjmp support. */
 319
 320 extern int gdbarch_get_longjmp_target_p (struct gdbarch *gdbarch);
 321
 322 typedef int (gdbarch_get_longjmp_target_ftype) (struct frame_info *frame, CORE_ADDR *pc);
 323 extern int gdbarch_get_longjmp_target (struct gdbarch *gdbarch, struct frame_info *frame, CORE_ADDR *pc);
 324 extern void set_gdbarch_get_longjmp_target (struct gdbarch *gdbarch, gdbarch_get_longjmp_target_ftype *get_longjmp_target);
 325
 326 extern int gdbarch_believe_pcc_promotion (struct gdbarch *gdbarch);
 327 extern void set_gdbarch_believe_pcc_promotion (struct gdbarch *gdbarch, int believe_pcc_promotion);
 328
 329 typedef int (gdbarch_convert_register_p_ftype) (struct gdbarch *gdbarch, int regnum, struct type *type);
 330 extern int gdbarch_convert_register_p (struct gdbarch *gdbarch, int regnum, struct type *type);
 331 extern void set_gdbarch_convert_register_p (struct gdbarch *gdbarch, gdbarch_convert_register_p_ftype *convert_register_p);
 332
 333 typedef void (gdbarch_register_to_value_ftype) (struct frame_info *frame, int regnum, struct type *type, gdb_byte *buf);
 334 extern void gdbarch_register_to_value (struct gdbarch *gdbarch, struct frame_info *frame, int regnum, struct type *type, gdb_byte *buf);
 335 extern void set_gdbarch_register_to_value (struct gdbarch *gdbarch, gdbarch_register_to_value_ftype *register_to_value);
 336
 337 typedef void (gdbarch_value_to_register_ftype) (struct frame_info *frame, int regnum, struct type *type, const gdb_byte *buf);
 338 extern void gdbarch_value_to_register (struct gdbarch *gdbarch, struct frame_info *frame, int regnum, struct type *type, const gdb_byte *buf);
 339 extern void set_gdbarch_value_to_register (struct gdbarch *gdbarch, gdbarch_value_to_register_ftype *value_to_register);
 340
 341 /* Construct a value representing the contents of register REGNUM in
 342    frame FRAME, interpreted as type TYPE.  The routine needs to
 343    allocate and return a struct value with all value attributes
 344    (but not the value contents) filled in. */
 345
 346 typedef struct value * (gdbarch_value_from_register_ftype) (struct type *type, int regnum, struct frame_info *frame);
 347 extern struct value * gdbarch_value_from_register (struct gdbarch *gdbarch, struct type *type, int regnum, struct frame_info *frame);
 348 extern void set_gdbarch_value_from_register (struct gdbarch *gdbarch, gdbarch_value_from_register_ftype *value_from_register);
 349
 350 typedef CORE_ADDR (gdbarch_pointer_to_address_ftype) (struct type *type, const gdb_byte *buf);
 351 extern CORE_ADDR gdbarch_pointer_to_address (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
 352 extern void set_gdbarch_pointer_to_address (struct gdbarch *gdbarch, gdbarch_pointer_to_address_ftype *pointer_to_address);
 353
 354 typedef void (gdbarch_address_to_pointer_ftype) (struct type *type, gdb_byte *buf, CORE_ADDR addr);
 355 extern void gdbarch_address_to_pointer (struct gdbarch *gdbarch, struct type *type, gdb_byte *buf, CORE_ADDR addr);
 356 extern void set_gdbarch_address_to_pointer (struct gdbarch *gdbarch, gdbarch_address_to_pointer_ftype *address_to_pointer);
 357
 358 extern int gdbarch_integer_to_address_p (struct gdbarch *gdbarch);
 359
 360 typedef CORE_ADDR (gdbarch_integer_to_address_ftype) (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
 361 extern CORE_ADDR gdbarch_integer_to_address (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
 362 extern void set_gdbarch_integer_to_address (struct gdbarch *gdbarch, gdbarch_integer_to_address_ftype *integer_to_address);
 363
 364 /* Return the return-value convention that will be used by FUNCTYPE
 365    to return a value of type VALTYPE.  FUNCTYPE may be NULL in which
 366    case the return convention is computed based only on VALTYPE.
 367
 368    If READBUF is not NULL, extract the return value and save it in this buffer.
 369
 370    If WRITEBUF is not NULL, it contains a return value which will be
 371    stored into the appropriate register.  This can be used when we want
 372    to force the value returned by a function (see the "return" command
 373    for instance). */
 374
 375 extern int gdbarch_return_value_p (struct gdbarch *gdbarch);
 376
 377 typedef enum return_value_convention (gdbarch_return_value_ftype) (struct gdbarch *gdbarch, struct type *functype, struct type *valtype, struct regcache *regcache, gdb_byte *readbuf, const gdb_byte *writebuf);
 378 extern enum return_value_convention gdbarch_return_value (struct gdbarch *gdbarch, struct type *functype, struct type *valtype, struct regcache *regcache, gdb_byte *readbuf, const gdb_byte *writebuf);
 379 extern void set_gdbarch_return_value (struct gdbarch *gdbarch, gdbarch_return_value_ftype *return_value);
 380
 381 typedef CORE_ADDR (gdbarch_skip_prologue_ftype) (struct gdbarch *gdbarch, CORE_ADDR ip);
 382 extern CORE_ADDR gdbarch_skip_prologue (struct gdbarch *gdbarch, CORE_ADDR ip);
 383 extern void set_gdbarch_skip_prologue (struct gdbarch *gdbarch, gdbarch_skip_prologue_ftype *skip_prologue);
 384
 385 typedef int (gdbarch_inner_than_ftype) (CORE_ADDR lhs, CORE_ADDR rhs);
 386 extern int gdbarch_inner_than (struct gdbarch *gdbarch, CORE_ADDR lhs, CORE_ADDR rhs);
 387 extern void set_gdbarch_inner_than (struct gdbarch *gdbarch, gdbarch_inner_than_ftype *inner_than);
 388
 389 typedef const gdb_byte * (gdbarch_breakpoint_from_pc_ftype) (struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *lenptr);
 390 extern const gdb_byte * gdbarch_breakpoint_from_pc (struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *lenptr);
 391 extern void set_gdbarch_breakpoint_from_pc (struct gdbarch *gdbarch, gdbarch_breakpoint_from_pc_ftype *breakpoint_from_pc);
 392
 393 extern int gdbarch_adjust_breakpoint_address_p (struct gdbarch *gdbarch);
 394
 395 typedef CORE_ADDR (gdbarch_adjust_breakpoint_address_ftype) (struct gdbarch *gdbarch, CORE_ADDR bpaddr);
 396 extern CORE_ADDR gdbarch_adjust_breakpoint_address (struct gdbarch *gdbarch, CORE_ADDR bpaddr);
 397 extern void set_gdbarch_adjust_breakpoint_address (struct gdbarch *gdbarch, gdbarch_adjust_breakpoint_address_ftype *adjust_breakpoint_address);
 398
 399 typedef int (gdbarch_memory_insert_breakpoint_ftype) (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
 400 extern int gdbarch_memory_insert_breakpoint (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
 401 extern void set_gdbarch_memory_insert_breakpoint (struct gdbarch *gdbarch, gdbarch_memory_insert_breakpoint_ftype *memory_insert_breakpoint);
 402
 403 typedef int (gdbarch_memory_remove_breakpoint_ftype) (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
 404 extern int gdbarch_memory_remove_breakpoint (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
 405 extern void set_gdbarch_memory_remove_breakpoint (struct gdbarch *gdbarch, gdbarch_memory_remove_breakpoint_ftype *memory_remove_breakpoint);
 406
 407 extern CORE_ADDR gdbarch_decr_pc_after_break (struct gdbarch *gdbarch);
 408 extern void set_gdbarch_decr_pc_after_break (struct gdbarch *gdbarch, CORE_ADDR decr_pc_after_break);
 409
 410 /* A function can be addressed by either it's "pointer" (possibly a
 411    descriptor address) or "entry point" (first executable instruction).
 412    The method "convert_from_func_ptr_addr" converting the former to the
 413    latter.  gdbarch_deprecated_function_start_offset is being used to implement
 414    a simplified subset of that functionality - the function's address
 415    corresponds to the "function pointer" and the function's start
 416    corresponds to the "function entry point" - and hence is redundant. */
 417
 418 extern CORE_ADDR gdbarch_deprecated_function_start_offset (struct gdbarch *gdbarch);
 419 extern void set_gdbarch_deprecated_function_start_offset (struct gdbarch *gdbarch, CORE_ADDR deprecated_function_start_offset);
 420
 421 /* Return the remote protocol register number associated with this
 422    register.  Normally the identity mapping. */
 423
 424 typedef int (gdbarch_remote_register_number_ftype) (struct gdbarch *gdbarch, int regno);
 425 extern int gdbarch_remote_register_number (struct gdbarch *gdbarch, int regno);
 426 extern void set_gdbarch_remote_register_number (struct gdbarch *gdbarch, gdbarch_remote_register_number_ftype *remote_register_number);
 427
 428 /* Fetch the target specific address used to represent a load module. */
 429
 430 extern int gdbarch_fetch_tls_load_module_address_p (struct gdbarch *gdbarch);
 431
 432 typedef CORE_ADDR (gdbarch_fetch_tls_load_module_address_ftype) (struct objfile *objfile);
 433 extern CORE_ADDR gdbarch_fetch_tls_load_module_address (struct gdbarch *gdbarch, struct objfile *objfile);
 434 extern void set_gdbarch_fetch_tls_load_module_address (struct gdbarch *gdbarch, gdbarch_fetch_tls_load_module_address_ftype *fetch_tls_load_module_address);
 435
 436 extern CORE_ADDR gdbarch_frame_args_skip (struct gdbarch *gdbarch);
 437 extern void set_gdbarch_frame_args_skip (struct gdbarch *gdbarch, CORE_ADDR frame_args_skip);
 438
 439 extern int gdbarch_unwind_pc_p (struct gdbarch *gdbarch);
 440
 441 typedef CORE_ADDR (gdbarch_unwind_pc_ftype) (struct gdbarch *gdbarch, struct frame_info *next_frame);
 442 extern CORE_ADDR gdbarch_unwind_pc (struct gdbarch *gdbarch, struct frame_info *next_frame);
 443 extern void set_gdbarch_unwind_pc (struct gdbarch *gdbarch, gdbarch_unwind_pc_ftype *unwind_pc);
 444
 445 extern int gdbarch_unwind_sp_p (struct gdbarch *gdbarch);
 446
 447 typedef CORE_ADDR (gdbarch_unwind_sp_ftype) (struct gdbarch *gdbarch, struct frame_info *next_frame);
 448 extern CORE_ADDR gdbarch_unwind_sp (struct gdbarch *gdbarch, struct frame_info *next_frame);
 449 extern void set_gdbarch_unwind_sp (struct gdbarch *gdbarch, gdbarch_unwind_sp_ftype *unwind_sp);
 450
 451 /* DEPRECATED_FRAME_LOCALS_ADDRESS as been replaced by the per-frame
 452    frame-base.  Enable frame-base before frame-unwind. */
 453
 454 extern int gdbarch_frame_num_args_p (struct gdbarch *gdbarch);
 455
 456 typedef int (gdbarch_frame_num_args_ftype) (struct frame_info *frame);
 457 extern int gdbarch_frame_num_args (struct gdbarch *gdbarch, struct frame_info *frame);
 458 extern void set_gdbarch_frame_num_args (struct gdbarch *gdbarch, gdbarch_frame_num_args_ftype *frame_num_args);
 459
 460 extern int gdbarch_frame_align_p (struct gdbarch *gdbarch);
 461
 462 typedef CORE_ADDR (gdbarch_frame_align_ftype) (struct gdbarch *gdbarch, CORE_ADDR address);
 463 extern CORE_ADDR gdbarch_frame_align (struct gdbarch *gdbarch, CORE_ADDR address);
 464 extern void set_gdbarch_frame_align (struct gdbarch *gdbarch, gdbarch_frame_align_ftype *frame_align);
 465
 466 typedef int (gdbarch_stabs_argument_has_addr_ftype) (struct gdbarch *gdbarch, struct type *type);
 467 extern int gdbarch_stabs_argument_has_addr (struct gdbarch *gdbarch, struct type *type);
 468 extern void set_gdbarch_stabs_argument_has_addr (struct gdbarch *gdbarch, gdbarch_stabs_argument_has_addr_ftype *stabs_argument_has_addr);
 469
 470 extern int gdbarch_frame_red_zone_size (struct gdbarch *gdbarch);
 471 extern void set_gdbarch_frame_red_zone_size (struct gdbarch *gdbarch, int frame_red_zone_size);
 472
 473 typedef CORE_ADDR (gdbarch_convert_from_func_ptr_addr_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr, struct target_ops *targ);
 474 extern CORE_ADDR gdbarch_convert_from_func_ptr_addr (struct gdbarch *gdbarch, CORE_ADDR addr, struct target_ops *targ);
 475 extern void set_gdbarch_convert_from_func_ptr_addr (struct gdbarch *gdbarch, gdbarch_convert_from_func_ptr_addr_ftype *convert_from_func_ptr_addr);
 476
 477 /* On some machines there are bits in addresses which are not really
 478    part of the address, but are used by the kernel, the hardware, etc.
 479    for special purposes.  gdbarch_addr_bits_remove takes out any such bits so
 480    we get a "real" address such as one would find in a symbol table.
 481    This is used only for addresses of instructions, and even then I'm
 482    not sure it's used in all contexts.  It exists to deal with there
 483    being a few stray bits in the PC which would mislead us, not as some
 484    sort of generic thing to handle alignment or segmentation (it's
 485    possible it should be in TARGET_READ_PC instead). */
 486
 487 typedef CORE_ADDR (gdbarch_addr_bits_remove_ftype) (CORE_ADDR addr);
 488 extern CORE_ADDR gdbarch_addr_bits_remove (struct gdbarch *gdbarch, CORE_ADDR addr);
 489 extern void set_gdbarch_addr_bits_remove (struct gdbarch *gdbarch, gdbarch_addr_bits_remove_ftype *addr_bits_remove);
 490
 491 /* It is not at all clear why gdbarch_smash_text_address is not folded into
 492    gdbarch_addr_bits_remove. */
 493
 494 typedef CORE_ADDR (gdbarch_smash_text_address_ftype) (CORE_ADDR addr);
 495 extern CORE_ADDR gdbarch_smash_text_address (struct gdbarch *gdbarch, CORE_ADDR addr);
 496 extern void set_gdbarch_smash_text_address (struct gdbarch *gdbarch, gdbarch_smash_text_address_ftype *smash_text_address);
 497
 498 /* FIXME/cagney/2001-01-18: This should be split in two.  A target method that
 499    indicates if the target needs software single step.  An ISA method to
 500    implement it.
 501
 502    FIXME/cagney/2001-01-18: This should be replaced with something that inserts
 503    breakpoints using the breakpoint system instead of blatting memory directly
 504    (as with rs6000).
 505
 506    FIXME/cagney/2001-01-18: The logic is backwards.  It should be asking if the
 507    target can single step.  If not, then implement single step using breakpoints.
 508
 509    A return value of 1 means that the software_single_step breakpoints
 510    were inserted; 0 means they were not. */
 511
 512 extern int gdbarch_software_single_step_p (struct gdbarch *gdbarch);
 513
 514 typedef int (gdbarch_software_single_step_ftype) (struct frame_info *frame);
 515 extern int gdbarch_software_single_step (struct gdbarch *gdbarch, struct frame_info *frame);
 516 extern void set_gdbarch_software_single_step (struct gdbarch *gdbarch, gdbarch_software_single_step_ftype *software_single_step);
 517
 518 /* Return non-zero if the processor is executing a delay slot and a
 519    further single-step is needed before the instruction finishes. */
 520
 521 extern int gdbarch_single_step_through_delay_p (struct gdbarch *gdbarch);
 522
 523 typedef int (gdbarch_single_step_through_delay_ftype) (struct gdbarch *gdbarch, struct frame_info *frame);
 524 extern int gdbarch_single_step_through_delay (struct gdbarch *gdbarch, struct frame_info *frame);
 525 extern void set_gdbarch_single_step_through_delay (struct gdbarch *gdbarch, gdbarch_single_step_through_delay_ftype *single_step_through_delay);
 526
 527 /* FIXME: cagney/2003-08-28: Need to find a better way of selecting the
 528    disassembler.  Perhaps objdump can handle it? */
 529
 530 typedef int (gdbarch_print_insn_ftype) (bfd_vma vma, struct disassemble_info *info);
 531 extern int gdbarch_print_insn (struct gdbarch *gdbarch, bfd_vma vma, struct disassemble_info *info);
 532 extern void set_gdbarch_print_insn (struct gdbarch *gdbarch, gdbarch_print_insn_ftype *print_insn);
 533
 534 typedef CORE_ADDR (gdbarch_skip_trampoline_code_ftype) (struct frame_info *frame, CORE_ADDR pc);
 535 extern CORE_ADDR gdbarch_skip_trampoline_code (struct gdbarch *gdbarch, struct frame_info *frame, CORE_ADDR pc);
 536 extern void set_gdbarch_skip_trampoline_code (struct gdbarch *gdbarch, gdbarch_skip_trampoline_code_ftype *skip_trampoline_code);
 537
 538 /* If IN_SOLIB_DYNSYM_RESOLVE_CODE returns true, and SKIP_SOLIB_RESOLVER
 539    evaluates non-zero, this is the address where the debugger will place
 540    a step-resume breakpoint to get us past the dynamic linker. */
 541
 542 typedef CORE_ADDR (gdbarch_skip_solib_resolver_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc);
 543 extern CORE_ADDR gdbarch_skip_solib_resolver (struct gdbarch *gdbarch, CORE_ADDR pc);
 544 extern void set_gdbarch_skip_solib_resolver (struct gdbarch *gdbarch, gdbarch_skip_solib_resolver_ftype *skip_solib_resolver);
 545
 546 /* Some systems also have trampoline code for returning from shared libs. */
 547
 548 typedef int (gdbarch_in_solib_return_trampoline_ftype) (CORE_ADDR pc, char *name);
 549 extern int gdbarch_in_solib_return_trampoline (struct gdbarch *gdbarch, CORE_ADDR pc, char *name);
 550 extern void set_gdbarch_in_solib_return_trampoline (struct gdbarch *gdbarch, gdbarch_in_solib_return_trampoline_ftype *in_solib_return_trampoline);
 551
 552 /* A target might have problems with watchpoints as soon as the stack
 553    frame of the current function has been destroyed.  This mostly happens
 554    as the first action in a funtion's epilogue.  in_function_epilogue_p()
 555    is defined to return a non-zero value if either the given addr is one
 556    instruction after the stack destroying instruction up to the trailing
 557    return instruction or if we can figure out that the stack frame has
 558    already been invalidated regardless of the value of addr.  Targets
 559    which don't suffer from that problem could just let this functionality
 560    untouched. */
 561
 562 typedef int (gdbarch_in_function_epilogue_p_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
 563 extern int gdbarch_in_function_epilogue_p (struct gdbarch *gdbarch, CORE_ADDR addr);
 564 extern void set_gdbarch_in_function_epilogue_p (struct gdbarch *gdbarch, gdbarch_in_function_epilogue_p_ftype *in_function_epilogue_p);
 565
 566 /* Given a vector of command-line arguments, return a newly allocated
 567    string which, when passed to the create_inferior function, will be
 568    parsed (on Unix systems, by the shell) to yield the same vector.
 569    This function should call error() if the argument vector is not
 570    representable for this target or if this target does not support
 571    command-line arguments.
 572    ARGC is the number of elements in the vector.
 573    ARGV is an array of strings, one per argument. */
 574
 575 typedef char * (gdbarch_construct_inferior_arguments_ftype) (struct gdbarch *gdbarch, int argc, char **argv);
 576 extern char * gdbarch_construct_inferior_arguments (struct gdbarch *gdbarch, int argc, char **argv);
 577 extern void set_gdbarch_construct_inferior_arguments (struct gdbarch *gdbarch, gdbarch_construct_inferior_arguments_ftype *construct_inferior_arguments);
 578
 579 typedef void (gdbarch_elf_make_msymbol_special_ftype) (asymbol *sym, struct minimal_symbol *msym);
 580 extern void gdbarch_elf_make_msymbol_special (struct gdbarch *gdbarch, asymbol *sym, struct minimal_symbol *msym);
 581 extern void set_gdbarch_elf_make_msymbol_special (struct gdbarch *gdbarch, gdbarch_elf_make_msymbol_special_ftype *elf_make_msymbol_special);
 582
 583 typedef void (gdbarch_coff_make_msymbol_special_ftype) (int val, struct minimal_symbol *msym);
 584 extern void gdbarch_coff_make_msymbol_special (struct gdbarch *gdbarch, int val, struct minimal_symbol *msym);
 585 extern void set_gdbarch_coff_make_msymbol_special (struct gdbarch *gdbarch, gdbarch_coff_make_msymbol_special_ftype *coff_make_msymbol_special);
 586
 587 extern const char * gdbarch_name_of_malloc (struct gdbarch *gdbarch);
 588 extern void set_gdbarch_name_of_malloc (struct gdbarch *gdbarch, const char * name_of_malloc);
 589
 590 extern int gdbarch_cannot_step_breakpoint (struct gdbarch *gdbarch);
 591 extern void set_gdbarch_cannot_step_breakpoint (struct gdbarch *gdbarch, int cannot_step_breakpoint);
 592
 593 extern int gdbarch_have_nonsteppable_watchpoint (struct gdbarch *gdbarch);
 594 extern void set_gdbarch_have_nonsteppable_watchpoint (struct gdbarch *gdbarch, int have_nonsteppable_watchpoint);
 595
 596 extern int gdbarch_address_class_type_flags_p (struct gdbarch *gdbarch);
 597
 598 typedef int (gdbarch_address_class_type_flags_ftype) (int byte_size, int dwarf2_addr_class);
 599 extern int gdbarch_address_class_type_flags (struct gdbarch *gdbarch, int byte_size, int dwarf2_addr_class);
 600 extern void set_gdbarch_address_class_type_flags (struct gdbarch *gdbarch, gdbarch_address_class_type_flags_ftype *address_class_type_flags);
 601
 602 extern int gdbarch_address_class_type_flags_to_name_p (struct gdbarch *gdbarch);
 603
 604 typedef const char * (gdbarch_address_class_type_flags_to_name_ftype) (struct gdbarch *gdbarch, int type_flags);
 605 extern const char * gdbarch_address_class_type_flags_to_name (struct gdbarch *gdbarch, int type_flags);
 606 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);
 607
 608 extern int gdbarch_address_class_name_to_type_flags_p (struct gdbarch *gdbarch);
 609
 610 typedef int (gdbarch_address_class_name_to_type_flags_ftype) (struct gdbarch *gdbarch, const char *name, int *type_flags_ptr);
 611 extern int gdbarch_address_class_name_to_type_flags (struct gdbarch *gdbarch, const char *name, int *type_flags_ptr);
 612 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);
 613
 614 /* Is a register in a group */
 615
 616 typedef int (gdbarch_register_reggroup_p_ftype) (struct gdbarch *gdbarch, int regnum, struct reggroup *reggroup);
 617 extern int gdbarch_register_reggroup_p (struct gdbarch *gdbarch, int regnum, struct reggroup *reggroup);
 618 extern void set_gdbarch_register_reggroup_p (struct gdbarch *gdbarch, gdbarch_register_reggroup_p_ftype *register_reggroup_p);
 619
 620 /* Fetch the pointer to the ith function argument. */
 621
 622 extern int gdbarch_fetch_pointer_argument_p (struct gdbarch *gdbarch);
 623
 624 typedef CORE_ADDR (gdbarch_fetch_pointer_argument_ftype) (struct frame_info *frame, int argi, struct type *type);
 625 extern CORE_ADDR gdbarch_fetch_pointer_argument (struct gdbarch *gdbarch, struct frame_info *frame, int argi, struct type *type);
 626 extern void set_gdbarch_fetch_pointer_argument (struct gdbarch *gdbarch, gdbarch_fetch_pointer_argument_ftype *fetch_pointer_argument);
 627
 628 /* Return the appropriate register set for a core file section with
 629    name SECT_NAME and size SECT_SIZE. */
 630
 631 extern int gdbarch_regset_from_core_section_p (struct gdbarch *gdbarch);
 632
 633 typedef const struct regset * (gdbarch_regset_from_core_section_ftype) (struct gdbarch *gdbarch, const char *sect_name, size_t sect_size);
 634 extern const struct regset * gdbarch_regset_from_core_section (struct gdbarch *gdbarch, const char *sect_name, size_t sect_size);
 635 extern void set_gdbarch_regset_from_core_section (struct gdbarch *gdbarch, gdbarch_regset_from_core_section_ftype *regset_from_core_section);
 636
 637 /* Read offset OFFSET of TARGET_OBJECT_LIBRARIES formatted shared libraries list from
 638    core file into buffer READBUF with length LEN. */
 639
 640 extern int gdbarch_core_xfer_shared_libraries_p (struct gdbarch *gdbarch);
 641
 642 typedef LONGEST (gdbarch_core_xfer_shared_libraries_ftype) (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, LONGEST len);
 643 extern LONGEST gdbarch_core_xfer_shared_libraries (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, LONGEST len);
 644 extern void set_gdbarch_core_xfer_shared_libraries (struct gdbarch *gdbarch, gdbarch_core_xfer_shared_libraries_ftype *core_xfer_shared_libraries);
 645
 646 /* If the elements of C++ vtables are in-place function descriptors rather
 647    than normal function pointers (which may point to code or a descriptor),
 648    set this to one. */
 649
 650 extern int gdbarch_vtable_function_descriptors (struct gdbarch *gdbarch);
 651 extern void set_gdbarch_vtable_function_descriptors (struct gdbarch *gdbarch, int vtable_function_descriptors);
 652
 653 /* Set if the least significant bit of the delta is used instead of the least
 654    significant bit of the pfn for pointers to virtual member functions. */
 655
 656 extern int gdbarch_vbit_in_delta (struct gdbarch *gdbarch);
 657 extern void set_gdbarch_vbit_in_delta (struct gdbarch *gdbarch, int vbit_in_delta);
 658
 659 /* Advance PC to next instruction in order to skip a permanent breakpoint. */
 660
 661 extern int gdbarch_skip_permanent_breakpoint_p (struct gdbarch *gdbarch);
 662
 663 typedef void (gdbarch_skip_permanent_breakpoint_ftype) (struct regcache *regcache);
 664 extern void gdbarch_skip_permanent_breakpoint (struct gdbarch *gdbarch, struct regcache *regcache);
 665 extern void set_gdbarch_skip_permanent_breakpoint (struct gdbarch *gdbarch, gdbarch_skip_permanent_breakpoint_ftype *skip_permanent_breakpoint);
 666
 667 /* The maximum length of an instruction on this architecture. */
 668
 669 extern int gdbarch_max_insn_length_p (struct gdbarch *gdbarch);
 670
 671 extern ULONGEST gdbarch_max_insn_length (struct gdbarch *gdbarch);
 672 extern void set_gdbarch_max_insn_length (struct gdbarch *gdbarch, ULONGEST max_insn_length);
 673
 674 /* Copy the instruction at FROM to TO, and make any adjustments
 675    necessary to single-step it at that address.
 676
 677    REGS holds the state the thread's registers will have before
 678    executing the copied instruction; the PC in REGS will refer to FROM,
 679    not the copy at TO.  The caller should update it to point at TO later.
 680
 681    Return a pointer to data of the architecture's choice to be passed
 682    to gdbarch_displaced_step_fixup.  Or, return NULL to indicate that
 683    the instruction's effects have been completely simulated, with the
 684    resulting state written back to REGS.
 685
 686    For a general explanation of displaced stepping and how GDB uses it,
 687    see the comments in infrun.c.
 688
 689    The TO area is only guaranteed to have space for
 690    gdbarch_max_insn_length (arch) bytes, so this function must not
 691    write more bytes than that to that area.
 692
 693    If you do not provide this function, GDB assumes that the
 694    architecture does not support displaced stepping.
 695
 696    If your architecture doesn't need to adjust instructions before
 697    single-stepping them, consider using simple_displaced_step_copy_insn
 698    here. */
 699
 700 extern int gdbarch_displaced_step_copy_insn_p (struct gdbarch *gdbarch);
 701
 702 typedef struct displaced_step_closure * (gdbarch_displaced_step_copy_insn_ftype) (struct gdbarch *gdbarch, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
 703 extern struct displaced_step_closure * gdbarch_displaced_step_copy_insn (struct gdbarch *gdbarch, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
 704 extern void set_gdbarch_displaced_step_copy_insn (struct gdbarch *gdbarch, gdbarch_displaced_step_copy_insn_ftype *displaced_step_copy_insn);
 705
 706 /* Fix up the state resulting from successfully single-stepping a
 707    displaced instruction, to give the result we would have gotten from
 708    stepping the instruction in its original location.
 709
 710    REGS is the register state resulting from single-stepping the
 711    displaced instruction.
 712
 713    CLOSURE is the result from the matching call to
 714    gdbarch_displaced_step_copy_insn.
 715
 716    If you provide gdbarch_displaced_step_copy_insn.but not this
 717    function, then GDB assumes that no fixup is needed after
 718    single-stepping the instruction.
 719
 720    For a general explanation of displaced stepping and how GDB uses it,
 721    see the comments in infrun.c. */
 722
 723 extern int gdbarch_displaced_step_fixup_p (struct gdbarch *gdbarch);
 724
 725 typedef void (gdbarch_displaced_step_fixup_ftype) (struct gdbarch *gdbarch, struct displaced_step_closure *closure, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
 726 extern void gdbarch_displaced_step_fixup (struct gdbarch *gdbarch, struct displaced_step_closure *closure, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
 727 extern void set_gdbarch_displaced_step_fixup (struct gdbarch *gdbarch, gdbarch_displaced_step_fixup_ftype *displaced_step_fixup);
 728
 729 /* Free a closure returned by gdbarch_displaced_step_copy_insn.
 730
 731    If you provide gdbarch_displaced_step_copy_insn, you must provide
 732    this function as well.
 733
 734    If your architecture uses closures that don't need to be freed, then
 735    you can use simple_displaced_step_free_closure here.
 736
 737    For a general explanation of displaced stepping and how GDB uses it,
 738    see the comments in infrun.c. */
 739
 740 typedef void (gdbarch_displaced_step_free_closure_ftype) (struct gdbarch *gdbarch, struct displaced_step_closure *closure);
 741 extern void gdbarch_displaced_step_free_closure (struct gdbarch *gdbarch, struct displaced_step_closure *closure);
 742 extern void set_gdbarch_displaced_step_free_closure (struct gdbarch *gdbarch, gdbarch_displaced_step_free_closure_ftype *displaced_step_free_closure);
 743
 744 /* Return the address of an appropriate place to put displaced
 745    instructions while we step over them.  There need only be one such
 746    place, since we're only stepping one thread over a breakpoint at a
 747    time.
 748
 749    For a general explanation of displaced stepping and how GDB uses it,
 750    see the comments in infrun.c. */
 751
 752 typedef CORE_ADDR (gdbarch_displaced_step_location_ftype) (struct gdbarch *gdbarch);
 753 extern CORE_ADDR gdbarch_displaced_step_location (struct gdbarch *gdbarch);
 754 extern void set_gdbarch_displaced_step_location (struct gdbarch *gdbarch, gdbarch_displaced_step_location_ftype *displaced_step_location);
 755
 756 /* Refresh overlay mapped state for section OSECT. */
 757
 758 extern int gdbarch_overlay_update_p (struct gdbarch *gdbarch);
 759
 760 typedef void (gdbarch_overlay_update_ftype) (struct obj_section *osect);
 761 extern void gdbarch_overlay_update (struct gdbarch *gdbarch, struct obj_section *osect);
 762 extern void set_gdbarch_overlay_update (struct gdbarch *gdbarch, gdbarch_overlay_update_ftype *overlay_update);
 763
 764 extern int gdbarch_core_read_description_p (struct gdbarch *gdbarch);
 765
 766 typedef const struct target_desc * (gdbarch_core_read_description_ftype) (struct gdbarch *gdbarch, struct target_ops *target, bfd *abfd);
 767 extern const struct target_desc * gdbarch_core_read_description (struct gdbarch *gdbarch, struct target_ops *target, bfd *abfd);
 768 extern void set_gdbarch_core_read_description (struct gdbarch *gdbarch, gdbarch_core_read_description_ftype *core_read_description);
 769
 770 /* Handle special encoding of static variables in stabs debug info. */
 771
 772 extern int gdbarch_static_transform_name_p (struct gdbarch *gdbarch);
 773
 774 typedef char * (gdbarch_static_transform_name_ftype) (char *name);
 775 extern char * gdbarch_static_transform_name (struct gdbarch *gdbarch, char *name);
 776 extern void set_gdbarch_static_transform_name (struct gdbarch *gdbarch, gdbarch_static_transform_name_ftype *static_transform_name);
 777
 778 /* Set if the address in N_SO or N_FUN stabs may be zero. */
 779
 780 extern int gdbarch_sofun_address_maybe_missing (struct gdbarch *gdbarch);
 781 extern void set_gdbarch_sofun_address_maybe_missing (struct gdbarch *gdbarch, int sofun_address_maybe_missing);
 782
 783 /* Signal translation: translate inferior's signal (host's) number into
 784    GDB's representation. */
 785
 786 typedef enum target_signal (gdbarch_target_signal_from_host_ftype) (struct gdbarch *gdbarch, int signo);
 787 extern enum target_signal gdbarch_target_signal_from_host (struct gdbarch *gdbarch, int signo);
 788 extern void set_gdbarch_target_signal_from_host (struct gdbarch *gdbarch, gdbarch_target_signal_from_host_ftype *target_signal_from_host);
 789
 790 /* Signal translation: translate GDB's signal number into inferior's host
 791    signal number. */
 792
 793 typedef int (gdbarch_target_signal_to_host_ftype) (struct gdbarch *gdbarch, enum target_signal ts);
 794 extern int gdbarch_target_signal_to_host (struct gdbarch *gdbarch, enum target_signal ts);
 795 extern void set_gdbarch_target_signal_to_host (struct gdbarch *gdbarch, gdbarch_target_signal_to_host_ftype *target_signal_to_host);
 796
 797 extern struct gdbarch_tdep *gdbarch_tdep (struct gdbarch *gdbarch);
 798
 799
 800 /* Mechanism for co-ordinating the selection of a specific
 801    architecture.
 802
 803    GDB targets (*-tdep.c) can register an interest in a specific
 804    architecture.  Other GDB components can register a need to maintain
 805    per-architecture data.
 806
 807    The mechanisms below ensures that there is only a loose connection
 808    between the set-architecture command and the various GDB
 809    components.  Each component can independently register their need
 810    to maintain architecture specific data with gdbarch.
 811
 812    Pragmatics:
 813
 814    Previously, a single TARGET_ARCHITECTURE_HOOK was provided.  It
 815    didn't scale.
 816
 817    The more traditional mega-struct containing architecture specific
 818    data for all the various GDB components was also considered.  Since
 819    GDB is built from a variable number of (fairly independent)
 820    components it was determined that the global aproach was not
 821    applicable. */
 822
 823
 824 /* Register a new architectural family with GDB.
 825
 826    Register support for the specified ARCHITECTURE with GDB.  When
 827    gdbarch determines that the specified architecture has been
 828    selected, the corresponding INIT function is called.
 829
 830    --
 831
 832    The INIT function takes two parameters: INFO which contains the
 833    information available to gdbarch about the (possibly new)
 834    architecture; ARCHES which is a list of the previously created
 835    ``struct gdbarch'' for this architecture.
 836
 837    The INFO parameter is, as far as possible, be pre-initialized with
 838    information obtained from INFO.ABFD or the global defaults.
 839
 840    The ARCHES parameter is a linked list (sorted most recently used)
 841    of all the previously created architures for this architecture
 842    family.  The (possibly NULL) ARCHES->gdbarch can used to access
 843    values from the previously selected architecture for this
 844    architecture family.  The global ``current_gdbarch'' shall not be
 845    used.
 846
 847    The INIT function shall return any of: NULL - indicating that it
 848    doesn't recognize the selected architecture; an existing ``struct
 849    gdbarch'' from the ARCHES list - indicating that the new
 850    architecture is just a synonym for an earlier architecture (see
 851    gdbarch_list_lookup_by_info()); a newly created ``struct gdbarch''
 852    - that describes the selected architecture (see gdbarch_alloc()).
 853
 854    The DUMP_TDEP function shall print out all target specific values.
 855    Care should be taken to ensure that the function works in both the
 856    multi-arch and non- multi-arch cases. */
 857
 858 struct gdbarch_list
 859 {
 860   struct gdbarch *gdbarch;
 861   struct gdbarch_list *next;
 862 };
 863
 864 struct gdbarch_info
 865 {
 866   /* Use default: NULL (ZERO). */
 867   const struct bfd_arch_info *bfd_arch_info;
 868
 869   /* Use default: BFD_ENDIAN_UNKNOWN (NB: is not ZERO).  */
 870   int byte_order;
 871
 872   /* Use default: NULL (ZERO). */
 873   bfd *abfd;
 874
 875   /* Use default: NULL (ZERO). */
 876   struct gdbarch_tdep_info *tdep_info;
 877
 878   /* Use default: GDB_OSABI_UNINITIALIZED (-1).  */
 879   enum gdb_osabi osabi;
 880
 881   /* Use default: NULL (ZERO).  */
 882   const struct target_desc *target_desc;
 883 };
 884
 885 typedef struct gdbarch *(gdbarch_init_ftype) (struct gdbarch_info info, struct gdbarch_list *arches);
 886 typedef void (gdbarch_dump_tdep_ftype) (struct gdbarch *gdbarch, struct ui_file *file);
 887
 888 /* DEPRECATED - use gdbarch_register() */
 889 extern void register_gdbarch_init (enum bfd_architecture architecture, gdbarch_init_ftype *);
 890
 891 extern void gdbarch_register (enum bfd_architecture architecture,
 892                               gdbarch_init_ftype *,
 893                               gdbarch_dump_tdep_ftype *);
 894
 895
 896 /* Return a freshly allocated, NULL terminated, array of the valid
 897    architecture names.  Since architectures are registered during the
 898    _initialize phase this function only returns useful information
 899    once initialization has been completed. */
 900
 901 extern const char **gdbarch_printable_names (void);
 902
 903
 904 /* Helper function.  Search the list of ARCHES for a GDBARCH that
 905    matches the information provided by INFO. */
 906
 907 extern struct gdbarch_list *gdbarch_list_lookup_by_info (struct gdbarch_list *arches, const struct gdbarch_info *info);
 908
 909
 910 /* Helper function.  Create a preliminary ``struct gdbarch''.  Perform
 911    basic initialization using values obtained from the INFO and TDEP
 912    parameters.  set_gdbarch_*() functions are called to complete the
 913    initialization of the object. */
 914
 915 extern struct gdbarch *gdbarch_alloc (const struct gdbarch_info *info, struct gdbarch_tdep *tdep);
 916
 917
 918 /* Helper function.  Free a partially-constructed ``struct gdbarch''.
 919    It is assumed that the caller freeds the ``struct
 920    gdbarch_tdep''. */
 921
 922 extern void gdbarch_free (struct gdbarch *);
 923
 924
 925 /* Helper function.  Allocate memory from the ``struct gdbarch''
 926    obstack.  The memory is freed when the corresponding architecture
 927    is also freed.  */
 928
 929 extern void *gdbarch_obstack_zalloc (struct gdbarch *gdbarch, long size);
 930 #define GDBARCH_OBSTACK_CALLOC(GDBARCH, NR, TYPE) ((TYPE *) gdbarch_obstack_zalloc ((GDBARCH), (NR) * sizeof (TYPE)))
 931 #define GDBARCH_OBSTACK_ZALLOC(GDBARCH, TYPE) ((TYPE *) gdbarch_obstack_zalloc ((GDBARCH), sizeof (TYPE)))
 932
 933
 934 /* Helper function. Force an update of the current architecture.
 935
 936    The actual architecture selected is determined by INFO, ``(gdb) set
 937    architecture'' et.al., the existing architecture and BFD's default
 938    architecture.  INFO should be initialized to zero and then selected
 939    fields should be updated.
 940
 941    Returns non-zero if the update succeeds */
 942
 943 extern int gdbarch_update_p (struct gdbarch_info info);
 944
 945
 946 /* Helper function.  Find an architecture matching info.
 947
 948    INFO should be initialized using gdbarch_info_init, relevant fields
 949    set, and then finished using gdbarch_info_fill.
 950
 951    Returns the corresponding architecture, or NULL if no matching
 952    architecture was found.  "current_gdbarch" is not updated.  */
 953
 954 extern struct gdbarch *gdbarch_find_by_info (struct gdbarch_info info);
 955
 956
 957 /* Helper function.  Set the global "current_gdbarch" to "gdbarch".
 958
 959    FIXME: kettenis/20031124: Of the functions that follow, only
 960    gdbarch_from_bfd is supposed to survive.  The others will
 961    dissappear since in the future GDB will (hopefully) be truly
 962    multi-arch.  However, for now we're still stuck with the concept of
 963    a single active architecture.  */
 964
 965 extern void deprecated_current_gdbarch_select_hack (struct gdbarch *gdbarch);
 966
 967
 968 /* Register per-architecture data-pointer.
 969
 970    Reserve space for a per-architecture data-pointer.  An identifier
 971    for the reserved data-pointer is returned.  That identifer should
 972    be saved in a local static variable.
 973
 974    Memory for the per-architecture data shall be allocated using
 975    gdbarch_obstack_zalloc.  That memory will be deleted when the
 976    corresponding architecture object is deleted.
 977
 978    When a previously created architecture is re-selected, the
 979    per-architecture data-pointer for that previous architecture is
 980    restored.  INIT() is not re-called.
 981
 982    Multiple registrarants for any architecture are allowed (and
 983    strongly encouraged).  */
 984
 985 struct gdbarch_data;
 986
 987 typedef void *(gdbarch_data_pre_init_ftype) (struct obstack *obstack);
 988 extern struct gdbarch_data *gdbarch_data_register_pre_init (gdbarch_data_pre_init_ftype *init);
 989 typedef void *(gdbarch_data_post_init_ftype) (struct gdbarch *gdbarch);
 990 extern struct gdbarch_data *gdbarch_data_register_post_init (gdbarch_data_post_init_ftype *init);
 991 extern void deprecated_set_gdbarch_data (struct gdbarch *gdbarch,
 992                                          struct gdbarch_data *data,
 993                                          void *pointer);
 994
 995 extern void *gdbarch_data (struct gdbarch *gdbarch, struct gdbarch_data *);
 996
 997
 998 /* Set the dynamic target-system-dependent parameters (architecture,
 999    byte-order, ...) using information found in the BFD */
1000
1001 extern void set_gdbarch_from_file (bfd *);
1002
1003
1004 /* Initialize the current architecture to the "first" one we find on
1005    our list.  */
1006
1007 extern void initialize_current_architecture (void);
1008
1009 /* gdbarch trace variable */
1010 extern int gdbarch_debug;
1011
1012 extern void gdbarch_dump (struct gdbarch *gdbarch, struct ui_file *file);
1013
1014 #endif