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 /* Convert from an sdb register number to an internal gdb register number. */
 227
 228 typedef int (gdbarch_sdb_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int sdb_regnr);
 229 extern int gdbarch_sdb_reg_to_regnum (struct gdbarch *gdbarch, int sdb_regnr);
 230 extern void set_gdbarch_sdb_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_sdb_reg_to_regnum_ftype *sdb_reg_to_regnum);
 231
 232 /* Provide a default mapping from a DWARF2 register number to a gdb REGNUM. */
 233
 234 typedef int (gdbarch_dwarf2_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int dwarf2_regnr);
 235 extern int gdbarch_dwarf2_reg_to_regnum (struct gdbarch *gdbarch, int dwarf2_regnr);
 236 extern void set_gdbarch_dwarf2_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_dwarf2_reg_to_regnum_ftype *dwarf2_reg_to_regnum);
 237
 238 typedef const char * (gdbarch_register_name_ftype) (struct gdbarch *gdbarch, int regnr);
 239 extern const char * gdbarch_register_name (struct gdbarch *gdbarch, int regnr);
 240 extern void set_gdbarch_register_name (struct gdbarch *gdbarch, gdbarch_register_name_ftype *register_name);
 241
 242 /* Return the type of a register specified by the architecture.  Only
 243    the register cache should call this function directly; others should
 244    use "register_type". */
 245
 246 extern int gdbarch_register_type_p (struct gdbarch *gdbarch);
 247
 248 typedef struct type * (gdbarch_register_type_ftype) (struct gdbarch *gdbarch, int reg_nr);
 249 extern struct type * gdbarch_register_type (struct gdbarch *gdbarch, int reg_nr);
 250 extern void set_gdbarch_register_type (struct gdbarch *gdbarch, gdbarch_register_type_ftype *register_type);
 251
 252 /* See gdbint.texinfo, and PUSH_DUMMY_CALL. */
 253
 254 extern int gdbarch_dummy_id_p (struct gdbarch *gdbarch);
 255
 256 typedef struct frame_id (gdbarch_dummy_id_ftype) (struct gdbarch *gdbarch, struct frame_info *this_frame);
 257 extern struct frame_id gdbarch_dummy_id (struct gdbarch *gdbarch, struct frame_info *this_frame);
 258 extern void set_gdbarch_dummy_id (struct gdbarch *gdbarch, gdbarch_dummy_id_ftype *dummy_id);
 259
 260 /* Implement DUMMY_ID and PUSH_DUMMY_CALL, then delete
 261    deprecated_fp_regnum. */
 262
 263 extern int gdbarch_deprecated_fp_regnum (struct gdbarch *gdbarch);
 264 extern void set_gdbarch_deprecated_fp_regnum (struct gdbarch *gdbarch, int deprecated_fp_regnum);
 265
 266 /* See gdbint.texinfo.  See infcall.c. */
 267
 268 extern int gdbarch_push_dummy_call_p (struct gdbarch *gdbarch);
 269
 270 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);
 271 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);
 272 extern void set_gdbarch_push_dummy_call (struct gdbarch *gdbarch, gdbarch_push_dummy_call_ftype *push_dummy_call);
 273
 274 extern int gdbarch_call_dummy_location (struct gdbarch *gdbarch);
 275 extern void set_gdbarch_call_dummy_location (struct gdbarch *gdbarch, int call_dummy_location);
 276
 277 extern int gdbarch_push_dummy_code_p (struct gdbarch *gdbarch);
 278
 279 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);
 280 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);
 281 extern void set_gdbarch_push_dummy_code (struct gdbarch *gdbarch, gdbarch_push_dummy_code_ftype *push_dummy_code);
 282
 283 typedef void (gdbarch_print_registers_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, int regnum, int all);
 284 extern void gdbarch_print_registers_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, int regnum, int all);
 285 extern void set_gdbarch_print_registers_info (struct gdbarch *gdbarch, gdbarch_print_registers_info_ftype *print_registers_info);
 286
 287 extern int gdbarch_print_float_info_p (struct gdbarch *gdbarch);
 288
 289 typedef void (gdbarch_print_float_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
 290 extern void gdbarch_print_float_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
 291 extern void set_gdbarch_print_float_info (struct gdbarch *gdbarch, gdbarch_print_float_info_ftype *print_float_info);
 292
 293 extern int gdbarch_print_vector_info_p (struct gdbarch *gdbarch);
 294
 295 typedef void (gdbarch_print_vector_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
 296 extern void gdbarch_print_vector_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
 297 extern void set_gdbarch_print_vector_info (struct gdbarch *gdbarch, gdbarch_print_vector_info_ftype *print_vector_info);
 298
 299 /* MAP a GDB RAW register number onto a simulator register number.  See
 300    also include/...-sim.h. */
 301
 302 typedef int (gdbarch_register_sim_regno_ftype) (struct gdbarch *gdbarch, int reg_nr);
 303 extern int gdbarch_register_sim_regno (struct gdbarch *gdbarch, int reg_nr);
 304 extern void set_gdbarch_register_sim_regno (struct gdbarch *gdbarch, gdbarch_register_sim_regno_ftype *register_sim_regno);
 305
 306 typedef int (gdbarch_cannot_fetch_register_ftype) (struct gdbarch *gdbarch, int regnum);
 307 extern int gdbarch_cannot_fetch_register (struct gdbarch *gdbarch, int regnum);
 308 extern void set_gdbarch_cannot_fetch_register (struct gdbarch *gdbarch, gdbarch_cannot_fetch_register_ftype *cannot_fetch_register);
 309
 310 typedef int (gdbarch_cannot_store_register_ftype) (struct gdbarch *gdbarch, int regnum);
 311 extern int gdbarch_cannot_store_register (struct gdbarch *gdbarch, int regnum);
 312 extern void set_gdbarch_cannot_store_register (struct gdbarch *gdbarch, gdbarch_cannot_store_register_ftype *cannot_store_register);
 313
 314 /* setjmp/longjmp support. */
 315
 316 extern int gdbarch_get_longjmp_target_p (struct gdbarch *gdbarch);
 317
 318 typedef int (gdbarch_get_longjmp_target_ftype) (struct frame_info *frame, CORE_ADDR *pc);
 319 extern int gdbarch_get_longjmp_target (struct gdbarch *gdbarch, struct frame_info *frame, CORE_ADDR *pc);
 320 extern void set_gdbarch_get_longjmp_target (struct gdbarch *gdbarch, gdbarch_get_longjmp_target_ftype *get_longjmp_target);
 321
 322 extern int gdbarch_believe_pcc_promotion (struct gdbarch *gdbarch);
 323 extern void set_gdbarch_believe_pcc_promotion (struct gdbarch *gdbarch, int believe_pcc_promotion);
 324
 325 typedef int (gdbarch_convert_register_p_ftype) (struct gdbarch *gdbarch, int regnum, struct type *type);
 326 extern int gdbarch_convert_register_p (struct gdbarch *gdbarch, int regnum, struct type *type);
 327 extern void set_gdbarch_convert_register_p (struct gdbarch *gdbarch, gdbarch_convert_register_p_ftype *convert_register_p);
 328
 329 typedef void (gdbarch_register_to_value_ftype) (struct frame_info *frame, int regnum, struct type *type, gdb_byte *buf);
 330 extern void gdbarch_register_to_value (struct gdbarch *gdbarch, struct frame_info *frame, int regnum, struct type *type, gdb_byte *buf);
 331 extern void set_gdbarch_register_to_value (struct gdbarch *gdbarch, gdbarch_register_to_value_ftype *register_to_value);
 332
 333 typedef void (gdbarch_value_to_register_ftype) (struct frame_info *frame, int regnum, struct type *type, const gdb_byte *buf);
 334 extern void gdbarch_value_to_register (struct gdbarch *gdbarch, struct frame_info *frame, int regnum, struct type *type, const gdb_byte *buf);
 335 extern void set_gdbarch_value_to_register (struct gdbarch *gdbarch, gdbarch_value_to_register_ftype *value_to_register);
 336
 337 /* Construct a value representing the contents of register REGNUM in
 338    frame FRAME, interpreted as type TYPE.  The routine needs to
 339    allocate and return a struct value with all value attributes
 340    (but not the value contents) filled in. */
 341
 342 typedef struct value * (gdbarch_value_from_register_ftype) (struct type *type, int regnum, struct frame_info *frame);
 343 extern struct value * gdbarch_value_from_register (struct gdbarch *gdbarch, struct type *type, int regnum, struct frame_info *frame);
 344 extern void set_gdbarch_value_from_register (struct gdbarch *gdbarch, gdbarch_value_from_register_ftype *value_from_register);
 345
 346 typedef CORE_ADDR (gdbarch_pointer_to_address_ftype) (struct type *type, const gdb_byte *buf);
 347 extern CORE_ADDR gdbarch_pointer_to_address (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
 348 extern void set_gdbarch_pointer_to_address (struct gdbarch *gdbarch, gdbarch_pointer_to_address_ftype *pointer_to_address);
 349
 350 typedef void (gdbarch_address_to_pointer_ftype) (struct type *type, gdb_byte *buf, CORE_ADDR addr);
 351 extern void gdbarch_address_to_pointer (struct gdbarch *gdbarch, struct type *type, gdb_byte *buf, CORE_ADDR addr);
 352 extern void set_gdbarch_address_to_pointer (struct gdbarch *gdbarch, gdbarch_address_to_pointer_ftype *address_to_pointer);
 353
 354 extern int gdbarch_integer_to_address_p (struct gdbarch *gdbarch);
 355
 356 typedef CORE_ADDR (gdbarch_integer_to_address_ftype) (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
 357 extern CORE_ADDR gdbarch_integer_to_address (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
 358 extern void set_gdbarch_integer_to_address (struct gdbarch *gdbarch, gdbarch_integer_to_address_ftype *integer_to_address);
 359
 360 /* Return the return-value convention that will be used by FUNCTYPE
 361    to return a value of type VALTYPE.  FUNCTYPE may be NULL in which
 362    case the return convention is computed based only on VALTYPE.
 363
 364    If READBUF is not NULL, extract the return value and save it in this buffer.
 365
 366    If WRITEBUF is not NULL, it contains a return value which will be
 367    stored into the appropriate register.  This can be used when we want
 368    to force the value returned by a function (see the "return" command
 369    for instance). */
 370
 371 extern int gdbarch_return_value_p (struct gdbarch *gdbarch);
 372
 373 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);
 374 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);
 375 extern void set_gdbarch_return_value (struct gdbarch *gdbarch, gdbarch_return_value_ftype *return_value);
 376
 377 typedef CORE_ADDR (gdbarch_skip_prologue_ftype) (struct gdbarch *gdbarch, CORE_ADDR ip);
 378 extern CORE_ADDR gdbarch_skip_prologue (struct gdbarch *gdbarch, CORE_ADDR ip);
 379 extern void set_gdbarch_skip_prologue (struct gdbarch *gdbarch, gdbarch_skip_prologue_ftype *skip_prologue);
 380
 381 typedef int (gdbarch_inner_than_ftype) (CORE_ADDR lhs, CORE_ADDR rhs);
 382 extern int gdbarch_inner_than (struct gdbarch *gdbarch, CORE_ADDR lhs, CORE_ADDR rhs);
 383 extern void set_gdbarch_inner_than (struct gdbarch *gdbarch, gdbarch_inner_than_ftype *inner_than);
 384
 385 typedef const gdb_byte * (gdbarch_breakpoint_from_pc_ftype) (struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *lenptr);
 386 extern const gdb_byte * gdbarch_breakpoint_from_pc (struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *lenptr);
 387 extern void set_gdbarch_breakpoint_from_pc (struct gdbarch *gdbarch, gdbarch_breakpoint_from_pc_ftype *breakpoint_from_pc);
 388
 389 extern int gdbarch_adjust_breakpoint_address_p (struct gdbarch *gdbarch);
 390
 391 typedef CORE_ADDR (gdbarch_adjust_breakpoint_address_ftype) (struct gdbarch *gdbarch, CORE_ADDR bpaddr);
 392 extern CORE_ADDR gdbarch_adjust_breakpoint_address (struct gdbarch *gdbarch, CORE_ADDR bpaddr);
 393 extern void set_gdbarch_adjust_breakpoint_address (struct gdbarch *gdbarch, gdbarch_adjust_breakpoint_address_ftype *adjust_breakpoint_address);
 394
 395 typedef int (gdbarch_memory_insert_breakpoint_ftype) (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
 396 extern int gdbarch_memory_insert_breakpoint (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
 397 extern void set_gdbarch_memory_insert_breakpoint (struct gdbarch *gdbarch, gdbarch_memory_insert_breakpoint_ftype *memory_insert_breakpoint);
 398
 399 typedef int (gdbarch_memory_remove_breakpoint_ftype) (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
 400 extern int gdbarch_memory_remove_breakpoint (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
 401 extern void set_gdbarch_memory_remove_breakpoint (struct gdbarch *gdbarch, gdbarch_memory_remove_breakpoint_ftype *memory_remove_breakpoint);
 402
 403 extern CORE_ADDR gdbarch_decr_pc_after_break (struct gdbarch *gdbarch);
 404 extern void set_gdbarch_decr_pc_after_break (struct gdbarch *gdbarch, CORE_ADDR decr_pc_after_break);
 405
 406 /* A function can be addressed by either it's "pointer" (possibly a
 407    descriptor address) or "entry point" (first executable instruction).
 408    The method "convert_from_func_ptr_addr" converting the former to the
 409    latter.  gdbarch_deprecated_function_start_offset is being used to implement
 410    a simplified subset of that functionality - the function's address
 411    corresponds to the "function pointer" and the function's start
 412    corresponds to the "function entry point" - and hence is redundant. */
 413
 414 extern CORE_ADDR gdbarch_deprecated_function_start_offset (struct gdbarch *gdbarch);
 415 extern void set_gdbarch_deprecated_function_start_offset (struct gdbarch *gdbarch, CORE_ADDR deprecated_function_start_offset);
 416
 417 /* Return the remote protocol register number associated with this
 418    register.  Normally the identity mapping. */
 419
 420 typedef int (gdbarch_remote_register_number_ftype) (struct gdbarch *gdbarch, int regno);
 421 extern int gdbarch_remote_register_number (struct gdbarch *gdbarch, int regno);
 422 extern void set_gdbarch_remote_register_number (struct gdbarch *gdbarch, gdbarch_remote_register_number_ftype *remote_register_number);
 423
 424 /* Fetch the target specific address used to represent a load module. */
 425
 426 extern int gdbarch_fetch_tls_load_module_address_p (struct gdbarch *gdbarch);
 427
 428 typedef CORE_ADDR (gdbarch_fetch_tls_load_module_address_ftype) (struct objfile *objfile);
 429 extern CORE_ADDR gdbarch_fetch_tls_load_module_address (struct gdbarch *gdbarch, struct objfile *objfile);
 430 extern void set_gdbarch_fetch_tls_load_module_address (struct gdbarch *gdbarch, gdbarch_fetch_tls_load_module_address_ftype *fetch_tls_load_module_address);
 431
 432 extern CORE_ADDR gdbarch_frame_args_skip (struct gdbarch *gdbarch);
 433 extern void set_gdbarch_frame_args_skip (struct gdbarch *gdbarch, CORE_ADDR frame_args_skip);
 434
 435 extern int gdbarch_unwind_pc_p (struct gdbarch *gdbarch);
 436
 437 typedef CORE_ADDR (gdbarch_unwind_pc_ftype) (struct gdbarch *gdbarch, struct frame_info *next_frame);
 438 extern CORE_ADDR gdbarch_unwind_pc (struct gdbarch *gdbarch, struct frame_info *next_frame);
 439 extern void set_gdbarch_unwind_pc (struct gdbarch *gdbarch, gdbarch_unwind_pc_ftype *unwind_pc);
 440
 441 extern int gdbarch_unwind_sp_p (struct gdbarch *gdbarch);
 442
 443 typedef CORE_ADDR (gdbarch_unwind_sp_ftype) (struct gdbarch *gdbarch, struct frame_info *next_frame);
 444 extern CORE_ADDR gdbarch_unwind_sp (struct gdbarch *gdbarch, struct frame_info *next_frame);
 445 extern void set_gdbarch_unwind_sp (struct gdbarch *gdbarch, gdbarch_unwind_sp_ftype *unwind_sp);
 446
 447 /* DEPRECATED_FRAME_LOCALS_ADDRESS as been replaced by the per-frame
 448    frame-base.  Enable frame-base before frame-unwind. */
 449
 450 extern int gdbarch_frame_num_args_p (struct gdbarch *gdbarch);
 451
 452 typedef int (gdbarch_frame_num_args_ftype) (struct frame_info *frame);
 453 extern int gdbarch_frame_num_args (struct gdbarch *gdbarch, struct frame_info *frame);
 454 extern void set_gdbarch_frame_num_args (struct gdbarch *gdbarch, gdbarch_frame_num_args_ftype *frame_num_args);
 455
 456 extern int gdbarch_frame_align_p (struct gdbarch *gdbarch);
 457
 458 typedef CORE_ADDR (gdbarch_frame_align_ftype) (struct gdbarch *gdbarch, CORE_ADDR address);
 459 extern CORE_ADDR gdbarch_frame_align (struct gdbarch *gdbarch, CORE_ADDR address);
 460 extern void set_gdbarch_frame_align (struct gdbarch *gdbarch, gdbarch_frame_align_ftype *frame_align);
 461
 462 typedef int (gdbarch_stabs_argument_has_addr_ftype) (struct gdbarch *gdbarch, struct type *type);
 463 extern int gdbarch_stabs_argument_has_addr (struct gdbarch *gdbarch, struct type *type);
 464 extern void set_gdbarch_stabs_argument_has_addr (struct gdbarch *gdbarch, gdbarch_stabs_argument_has_addr_ftype *stabs_argument_has_addr);
 465
 466 extern int gdbarch_frame_red_zone_size (struct gdbarch *gdbarch);
 467 extern void set_gdbarch_frame_red_zone_size (struct gdbarch *gdbarch, int frame_red_zone_size);
 468
 469 typedef CORE_ADDR (gdbarch_convert_from_func_ptr_addr_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr, struct target_ops *targ);
 470 extern CORE_ADDR gdbarch_convert_from_func_ptr_addr (struct gdbarch *gdbarch, CORE_ADDR addr, struct target_ops *targ);
 471 extern void set_gdbarch_convert_from_func_ptr_addr (struct gdbarch *gdbarch, gdbarch_convert_from_func_ptr_addr_ftype *convert_from_func_ptr_addr);
 472
 473 /* On some machines there are bits in addresses which are not really
 474    part of the address, but are used by the kernel, the hardware, etc.
 475    for special purposes.  gdbarch_addr_bits_remove takes out any such bits so
 476    we get a "real" address such as one would find in a symbol table.
 477    This is used only for addresses of instructions, and even then I'm
 478    not sure it's used in all contexts.  It exists to deal with there
 479    being a few stray bits in the PC which would mislead us, not as some
 480    sort of generic thing to handle alignment or segmentation (it's
 481    possible it should be in TARGET_READ_PC instead). */
 482
 483 typedef CORE_ADDR (gdbarch_addr_bits_remove_ftype) (CORE_ADDR addr);
 484 extern CORE_ADDR gdbarch_addr_bits_remove (struct gdbarch *gdbarch, CORE_ADDR addr);
 485 extern void set_gdbarch_addr_bits_remove (struct gdbarch *gdbarch, gdbarch_addr_bits_remove_ftype *addr_bits_remove);
 486
 487 /* It is not at all clear why gdbarch_smash_text_address is not folded into
 488    gdbarch_addr_bits_remove. */
 489
 490 typedef CORE_ADDR (gdbarch_smash_text_address_ftype) (CORE_ADDR addr);
 491 extern CORE_ADDR gdbarch_smash_text_address (struct gdbarch *gdbarch, CORE_ADDR addr);
 492 extern void set_gdbarch_smash_text_address (struct gdbarch *gdbarch, gdbarch_smash_text_address_ftype *smash_text_address);
 493
 494 /* FIXME/cagney/2001-01-18: This should be split in two.  A target method that
 495    indicates if the target needs software single step.  An ISA method to
 496    implement it.
 497
 498    FIXME/cagney/2001-01-18: This should be replaced with something that inserts
 499    breakpoints using the breakpoint system instead of blatting memory directly
 500    (as with rs6000).
 501
 502    FIXME/cagney/2001-01-18: The logic is backwards.  It should be asking if the
 503    target can single step.  If not, then implement single step using breakpoints.
 504
 505    A return value of 1 means that the software_single_step breakpoints
 506    were inserted; 0 means they were not. */
 507
 508 extern int gdbarch_software_single_step_p (struct gdbarch *gdbarch);
 509
 510 typedef int (gdbarch_software_single_step_ftype) (struct frame_info *frame);
 511 extern int gdbarch_software_single_step (struct gdbarch *gdbarch, struct frame_info *frame);
 512 extern void set_gdbarch_software_single_step (struct gdbarch *gdbarch, gdbarch_software_single_step_ftype *software_single_step);
 513
 514 /* Return non-zero if the processor is executing a delay slot and a
 515    further single-step is needed before the instruction finishes. */
 516
 517 extern int gdbarch_single_step_through_delay_p (struct gdbarch *gdbarch);
 518
 519 typedef int (gdbarch_single_step_through_delay_ftype) (struct gdbarch *gdbarch, struct frame_info *frame);
 520 extern int gdbarch_single_step_through_delay (struct gdbarch *gdbarch, struct frame_info *frame);
 521 extern void set_gdbarch_single_step_through_delay (struct gdbarch *gdbarch, gdbarch_single_step_through_delay_ftype *single_step_through_delay);
 522
 523 /* FIXME: cagney/2003-08-28: Need to find a better way of selecting the
 524    disassembler.  Perhaps objdump can handle it? */
 525
 526 typedef int (gdbarch_print_insn_ftype) (bfd_vma vma, struct disassemble_info *info);
 527 extern int gdbarch_print_insn (struct gdbarch *gdbarch, bfd_vma vma, struct disassemble_info *info);
 528 extern void set_gdbarch_print_insn (struct gdbarch *gdbarch, gdbarch_print_insn_ftype *print_insn);
 529
 530 typedef CORE_ADDR (gdbarch_skip_trampoline_code_ftype) (struct frame_info *frame, CORE_ADDR pc);
 531 extern CORE_ADDR gdbarch_skip_trampoline_code (struct gdbarch *gdbarch, struct frame_info *frame, CORE_ADDR pc);
 532 extern void set_gdbarch_skip_trampoline_code (struct gdbarch *gdbarch, gdbarch_skip_trampoline_code_ftype *skip_trampoline_code);
 533
 534 /* If IN_SOLIB_DYNSYM_RESOLVE_CODE returns true, and SKIP_SOLIB_RESOLVER
 535    evaluates non-zero, this is the address where the debugger will place
 536    a step-resume breakpoint to get us past the dynamic linker. */
 537
 538 typedef CORE_ADDR (gdbarch_skip_solib_resolver_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc);
 539 extern CORE_ADDR gdbarch_skip_solib_resolver (struct gdbarch *gdbarch, CORE_ADDR pc);
 540 extern void set_gdbarch_skip_solib_resolver (struct gdbarch *gdbarch, gdbarch_skip_solib_resolver_ftype *skip_solib_resolver);
 541
 542 /* Some systems also have trampoline code for returning from shared libs. */
 543
 544 typedef int (gdbarch_in_solib_return_trampoline_ftype) (CORE_ADDR pc, char *name);
 545 extern int gdbarch_in_solib_return_trampoline (struct gdbarch *gdbarch, CORE_ADDR pc, char *name);
 546 extern void set_gdbarch_in_solib_return_trampoline (struct gdbarch *gdbarch, gdbarch_in_solib_return_trampoline_ftype *in_solib_return_trampoline);
 547
 548 /* A target might have problems with watchpoints as soon as the stack
 549    frame of the current function has been destroyed.  This mostly happens
 550    as the first action in a funtion's epilogue.  in_function_epilogue_p()
 551    is defined to return a non-zero value if either the given addr is one
 552    instruction after the stack destroying instruction up to the trailing
 553    return instruction or if we can figure out that the stack frame has
 554    already been invalidated regardless of the value of addr.  Targets
 555    which don't suffer from that problem could just let this functionality
 556    untouched. */
 557
 558 typedef int (gdbarch_in_function_epilogue_p_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
 559 extern int gdbarch_in_function_epilogue_p (struct gdbarch *gdbarch, CORE_ADDR addr);
 560 extern void set_gdbarch_in_function_epilogue_p (struct gdbarch *gdbarch, gdbarch_in_function_epilogue_p_ftype *in_function_epilogue_p);
 561
 562 /* Given a vector of command-line arguments, return a newly allocated
 563    string which, when passed to the create_inferior function, will be
 564    parsed (on Unix systems, by the shell) to yield the same vector.
 565    This function should call error() if the argument vector is not
 566    representable for this target or if this target does not support
 567    command-line arguments.
 568    ARGC is the number of elements in the vector.
 569    ARGV is an array of strings, one per argument. */
 570
 571 typedef char * (gdbarch_construct_inferior_arguments_ftype) (struct gdbarch *gdbarch, int argc, char **argv);
 572 extern char * gdbarch_construct_inferior_arguments (struct gdbarch *gdbarch, int argc, char **argv);
 573 extern void set_gdbarch_construct_inferior_arguments (struct gdbarch *gdbarch, gdbarch_construct_inferior_arguments_ftype *construct_inferior_arguments);
 574
 575 typedef void (gdbarch_elf_make_msymbol_special_ftype) (asymbol *sym, struct minimal_symbol *msym);
 576 extern void gdbarch_elf_make_msymbol_special (struct gdbarch *gdbarch, asymbol *sym, struct minimal_symbol *msym);
 577 extern void set_gdbarch_elf_make_msymbol_special (struct gdbarch *gdbarch, gdbarch_elf_make_msymbol_special_ftype *elf_make_msymbol_special);
 578
 579 typedef void (gdbarch_coff_make_msymbol_special_ftype) (int val, struct minimal_symbol *msym);
 580 extern void gdbarch_coff_make_msymbol_special (struct gdbarch *gdbarch, int val, struct minimal_symbol *msym);
 581 extern void set_gdbarch_coff_make_msymbol_special (struct gdbarch *gdbarch, gdbarch_coff_make_msymbol_special_ftype *coff_make_msymbol_special);
 582
 583 extern const char * gdbarch_name_of_malloc (struct gdbarch *gdbarch);
 584 extern void set_gdbarch_name_of_malloc (struct gdbarch *gdbarch, const char * name_of_malloc);
 585
 586 extern int gdbarch_cannot_step_breakpoint (struct gdbarch *gdbarch);
 587 extern void set_gdbarch_cannot_step_breakpoint (struct gdbarch *gdbarch, int cannot_step_breakpoint);
 588
 589 extern int gdbarch_have_nonsteppable_watchpoint (struct gdbarch *gdbarch);
 590 extern void set_gdbarch_have_nonsteppable_watchpoint (struct gdbarch *gdbarch, int have_nonsteppable_watchpoint);
 591
 592 extern int gdbarch_address_class_type_flags_p (struct gdbarch *gdbarch);
 593
 594 typedef int (gdbarch_address_class_type_flags_ftype) (int byte_size, int dwarf2_addr_class);
 595 extern int gdbarch_address_class_type_flags (struct gdbarch *gdbarch, int byte_size, int dwarf2_addr_class);
 596 extern void set_gdbarch_address_class_type_flags (struct gdbarch *gdbarch, gdbarch_address_class_type_flags_ftype *address_class_type_flags);
 597
 598 extern int gdbarch_address_class_type_flags_to_name_p (struct gdbarch *gdbarch);
 599
 600 typedef const char * (gdbarch_address_class_type_flags_to_name_ftype) (struct gdbarch *gdbarch, int type_flags);
 601 extern const char * gdbarch_address_class_type_flags_to_name (struct gdbarch *gdbarch, int type_flags);
 602 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);
 603
 604 extern int gdbarch_address_class_name_to_type_flags_p (struct gdbarch *gdbarch);
 605
 606 typedef int (gdbarch_address_class_name_to_type_flags_ftype) (struct gdbarch *gdbarch, const char *name, int *type_flags_ptr);
 607 extern int gdbarch_address_class_name_to_type_flags (struct gdbarch *gdbarch, const char *name, int *type_flags_ptr);
 608 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);
 609
 610 /* Is a register in a group */
 611
 612 typedef int (gdbarch_register_reggroup_p_ftype) (struct gdbarch *gdbarch, int regnum, struct reggroup *reggroup);
 613 extern int gdbarch_register_reggroup_p (struct gdbarch *gdbarch, int regnum, struct reggroup *reggroup);
 614 extern void set_gdbarch_register_reggroup_p (struct gdbarch *gdbarch, gdbarch_register_reggroup_p_ftype *register_reggroup_p);
 615
 616 /* Fetch the pointer to the ith function argument. */
 617
 618 extern int gdbarch_fetch_pointer_argument_p (struct gdbarch *gdbarch);
 619
 620 typedef CORE_ADDR (gdbarch_fetch_pointer_argument_ftype) (struct frame_info *frame, int argi, struct type *type);
 621 extern CORE_ADDR gdbarch_fetch_pointer_argument (struct gdbarch *gdbarch, struct frame_info *frame, int argi, struct type *type);
 622 extern void set_gdbarch_fetch_pointer_argument (struct gdbarch *gdbarch, gdbarch_fetch_pointer_argument_ftype *fetch_pointer_argument);
 623
 624 /* Return the appropriate register set for a core file section with
 625    name SECT_NAME and size SECT_SIZE. */
 626
 627 extern int gdbarch_regset_from_core_section_p (struct gdbarch *gdbarch);
 628
 629 typedef const struct regset * (gdbarch_regset_from_core_section_ftype) (struct gdbarch *gdbarch, const char *sect_name, size_t sect_size);
 630 extern const struct regset * gdbarch_regset_from_core_section (struct gdbarch *gdbarch, const char *sect_name, size_t sect_size);
 631 extern void set_gdbarch_regset_from_core_section (struct gdbarch *gdbarch, gdbarch_regset_from_core_section_ftype *regset_from_core_section);
 632
 633 /* Read offset OFFSET of TARGET_OBJECT_LIBRARIES formatted shared libraries list from
 634    core file into buffer READBUF with length LEN. */
 635
 636 extern int gdbarch_core_xfer_shared_libraries_p (struct gdbarch *gdbarch);
 637
 638 typedef LONGEST (gdbarch_core_xfer_shared_libraries_ftype) (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, LONGEST len);
 639 extern LONGEST gdbarch_core_xfer_shared_libraries (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, LONGEST len);
 640 extern void set_gdbarch_core_xfer_shared_libraries (struct gdbarch *gdbarch, gdbarch_core_xfer_shared_libraries_ftype *core_xfer_shared_libraries);
 641
 642 /* If the elements of C++ vtables are in-place function descriptors rather
 643    than normal function pointers (which may point to code or a descriptor),
 644    set this to one. */
 645
 646 extern int gdbarch_vtable_function_descriptors (struct gdbarch *gdbarch);
 647 extern void set_gdbarch_vtable_function_descriptors (struct gdbarch *gdbarch, int vtable_function_descriptors);
 648
 649 /* Set if the least significant bit of the delta is used instead of the least
 650    significant bit of the pfn for pointers to virtual member functions. */
 651
 652 extern int gdbarch_vbit_in_delta (struct gdbarch *gdbarch);
 653 extern void set_gdbarch_vbit_in_delta (struct gdbarch *gdbarch, int vbit_in_delta);
 654
 655 /* Advance PC to next instruction in order to skip a permanent breakpoint. */
 656
 657 extern int gdbarch_skip_permanent_breakpoint_p (struct gdbarch *gdbarch);
 658
 659 typedef void (gdbarch_skip_permanent_breakpoint_ftype) (struct regcache *regcache);
 660 extern void gdbarch_skip_permanent_breakpoint (struct gdbarch *gdbarch, struct regcache *regcache);
 661 extern void set_gdbarch_skip_permanent_breakpoint (struct gdbarch *gdbarch, gdbarch_skip_permanent_breakpoint_ftype *skip_permanent_breakpoint);
 662
 663 /* The maximum length of an instruction on this architecture. */
 664
 665 extern int gdbarch_max_insn_length_p (struct gdbarch *gdbarch);
 666
 667 extern ULONGEST gdbarch_max_insn_length (struct gdbarch *gdbarch);
 668 extern void set_gdbarch_max_insn_length (struct gdbarch *gdbarch, ULONGEST max_insn_length);
 669
 670 /* Copy the instruction at FROM to TO, and make any adjustments
 671    necessary to single-step it at that address.
 672
 673    REGS holds the state the thread's registers will have before
 674    executing the copied instruction; the PC in REGS will refer to FROM,
 675    not the copy at TO.  The caller should update it to point at TO later.
 676
 677    Return a pointer to data of the architecture's choice to be passed
 678    to gdbarch_displaced_step_fixup.  Or, return NULL to indicate that
 679    the instruction's effects have been completely simulated, with the
 680    resulting state written back to REGS.
 681
 682    For a general explanation of displaced stepping and how GDB uses it,
 683    see the comments in infrun.c.
 684
 685    The TO area is only guaranteed to have space for
 686    gdbarch_max_insn_length (arch) bytes, so this function must not
 687    write more bytes than that to that area.
 688
 689    If you do not provide this function, GDB assumes that the
 690    architecture does not support displaced stepping.
 691
 692    If your architecture doesn't need to adjust instructions before
 693    single-stepping them, consider using simple_displaced_step_copy_insn
 694    here. */
 695
 696 extern int gdbarch_displaced_step_copy_insn_p (struct gdbarch *gdbarch);
 697
 698 typedef struct displaced_step_closure * (gdbarch_displaced_step_copy_insn_ftype) (struct gdbarch *gdbarch, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
 699 extern struct displaced_step_closure * gdbarch_displaced_step_copy_insn (struct gdbarch *gdbarch, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
 700 extern void set_gdbarch_displaced_step_copy_insn (struct gdbarch *gdbarch, gdbarch_displaced_step_copy_insn_ftype *displaced_step_copy_insn);
 701
 702 /* Fix up the state resulting from successfully single-stepping a
 703    displaced instruction, to give the result we would have gotten from
 704    stepping the instruction in its original location.
 705
 706    REGS is the register state resulting from single-stepping the
 707    displaced instruction.
 708
 709    CLOSURE is the result from the matching call to
 710    gdbarch_displaced_step_copy_insn.
 711
 712    If you provide gdbarch_displaced_step_copy_insn.but not this
 713    function, then GDB assumes that no fixup is needed after
 714    single-stepping the instruction.
 715
 716    For a general explanation of displaced stepping and how GDB uses it,
 717    see the comments in infrun.c. */
 718
 719 extern int gdbarch_displaced_step_fixup_p (struct gdbarch *gdbarch);
 720
 721 typedef void (gdbarch_displaced_step_fixup_ftype) (struct gdbarch *gdbarch, struct displaced_step_closure *closure, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
 722 extern void gdbarch_displaced_step_fixup (struct gdbarch *gdbarch, struct displaced_step_closure *closure, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
 723 extern void set_gdbarch_displaced_step_fixup (struct gdbarch *gdbarch, gdbarch_displaced_step_fixup_ftype *displaced_step_fixup);
 724
 725 /* Free a closure returned by gdbarch_displaced_step_copy_insn.
 726
 727    If you provide gdbarch_displaced_step_copy_insn, you must provide
 728    this function as well.
 729
 730    If your architecture uses closures that don't need to be freed, then
 731    you can use simple_displaced_step_free_closure here.
 732
 733    For a general explanation of displaced stepping and how GDB uses it,
 734    see the comments in infrun.c. */
 735
 736 typedef void (gdbarch_displaced_step_free_closure_ftype) (struct gdbarch *gdbarch, struct displaced_step_closure *closure);
 737 extern void gdbarch_displaced_step_free_closure (struct gdbarch *gdbarch, struct displaced_step_closure *closure);
 738 extern void set_gdbarch_displaced_step_free_closure (struct gdbarch *gdbarch, gdbarch_displaced_step_free_closure_ftype *displaced_step_free_closure);
 739
 740 /* Return the address of an appropriate place to put displaced
 741    instructions while we step over them.  There need only be one such
 742    place, since we're only stepping one thread over a breakpoint at a
 743    time.
 744
 745    For a general explanation of displaced stepping and how GDB uses it,
 746    see the comments in infrun.c. */
 747
 748 typedef CORE_ADDR (gdbarch_displaced_step_location_ftype) (struct gdbarch *gdbarch);
 749 extern CORE_ADDR gdbarch_displaced_step_location (struct gdbarch *gdbarch);
 750 extern void set_gdbarch_displaced_step_location (struct gdbarch *gdbarch, gdbarch_displaced_step_location_ftype *displaced_step_location);
 751
 752 /* Refresh overlay mapped state for section OSECT. */
 753
 754 extern int gdbarch_overlay_update_p (struct gdbarch *gdbarch);
 755
 756 typedef void (gdbarch_overlay_update_ftype) (struct obj_section *osect);
 757 extern void gdbarch_overlay_update (struct gdbarch *gdbarch, struct obj_section *osect);
 758 extern void set_gdbarch_overlay_update (struct gdbarch *gdbarch, gdbarch_overlay_update_ftype *overlay_update);
 759
 760 extern int gdbarch_core_read_description_p (struct gdbarch *gdbarch);
 761
 762 typedef const struct target_desc * (gdbarch_core_read_description_ftype) (struct gdbarch *gdbarch, struct target_ops *target, bfd *abfd);
 763 extern const struct target_desc * gdbarch_core_read_description (struct gdbarch *gdbarch, struct target_ops *target, bfd *abfd);
 764 extern void set_gdbarch_core_read_description (struct gdbarch *gdbarch, gdbarch_core_read_description_ftype *core_read_description);
 765
 766 /* Handle special encoding of static variables in stabs debug info. */
 767
 768 extern int gdbarch_static_transform_name_p (struct gdbarch *gdbarch);
 769
 770 typedef char * (gdbarch_static_transform_name_ftype) (char *name);
 771 extern char * gdbarch_static_transform_name (struct gdbarch *gdbarch, char *name);
 772 extern void set_gdbarch_static_transform_name (struct gdbarch *gdbarch, gdbarch_static_transform_name_ftype *static_transform_name);
 773
 774 /* Set if the address in N_SO or N_FUN stabs may be zero. */
 775
 776 extern int gdbarch_sofun_address_maybe_missing (struct gdbarch *gdbarch);
 777 extern void set_gdbarch_sofun_address_maybe_missing (struct gdbarch *gdbarch, int sofun_address_maybe_missing);
 778
 779 /* Signal translation: translate inferior's signal (host's) number into
 780    GDB's representation. */
 781
 782 typedef enum target_signal (gdbarch_target_signal_from_host_ftype) (struct gdbarch *gdbarch, int signo);
 783 extern enum target_signal gdbarch_target_signal_from_host (struct gdbarch *gdbarch, int signo);
 784 extern void set_gdbarch_target_signal_from_host (struct gdbarch *gdbarch, gdbarch_target_signal_from_host_ftype *target_signal_from_host);
 785
 786 /* Signal translation: translate GDB's signal number into inferior's host
 787    signal number. */
 788
 789 typedef int (gdbarch_target_signal_to_host_ftype) (struct gdbarch *gdbarch, enum target_signal ts);
 790 extern int gdbarch_target_signal_to_host (struct gdbarch *gdbarch, enum target_signal ts);
 791 extern void set_gdbarch_target_signal_to_host (struct gdbarch *gdbarch, gdbarch_target_signal_to_host_ftype *target_signal_to_host);
 792
 793 /* Record architecture-specific information from the symbol table. */
 794
 795 extern int gdbarch_record_special_symbol_p (struct gdbarch *gdbarch);
 796
 797 typedef void (gdbarch_record_special_symbol_ftype) (struct gdbarch *gdbarch, struct objfile *objfile, asymbol *sym);
 798 extern void gdbarch_record_special_symbol (struct gdbarch *gdbarch, struct objfile *objfile, asymbol *sym);
 799 extern void set_gdbarch_record_special_symbol (struct gdbarch *gdbarch, gdbarch_record_special_symbol_ftype *record_special_symbol);
 800
 801 extern struct gdbarch_tdep *gdbarch_tdep (struct gdbarch *gdbarch);
 802
 803
 804 /* Mechanism for co-ordinating the selection of a specific
 805    architecture.
 806
 807    GDB targets (*-tdep.c) can register an interest in a specific
 808    architecture.  Other GDB components can register a need to maintain
 809    per-architecture data.
 810
 811    The mechanisms below ensures that there is only a loose connection
 812    between the set-architecture command and the various GDB
 813    components.  Each component can independently register their need
 814    to maintain architecture specific data with gdbarch.
 815
 816    Pragmatics:
 817
 818    Previously, a single TARGET_ARCHITECTURE_HOOK was provided.  It
 819    didn't scale.
 820
 821    The more traditional mega-struct containing architecture specific
 822    data for all the various GDB components was also considered.  Since
 823    GDB is built from a variable number of (fairly independent)
 824    components it was determined that the global aproach was not
 825    applicable. */
 826
 827
 828 /* Register a new architectural family with GDB.
 829
 830    Register support for the specified ARCHITECTURE with GDB.  When
 831    gdbarch determines that the specified architecture has been
 832    selected, the corresponding INIT function is called.
 833
 834    --
 835
 836    The INIT function takes two parameters: INFO which contains the
 837    information available to gdbarch about the (possibly new)
 838    architecture; ARCHES which is a list of the previously created
 839    ``struct gdbarch'' for this architecture.
 840
 841    The INFO parameter is, as far as possible, be pre-initialized with
 842    information obtained from INFO.ABFD or the global defaults.
 843
 844    The ARCHES parameter is a linked list (sorted most recently used)
 845    of all the previously created architures for this architecture
 846    family.  The (possibly NULL) ARCHES->gdbarch can used to access
 847    values from the previously selected architecture for this
 848    architecture family.  The global ``current_gdbarch'' shall not be
 849    used.
 850
 851    The INIT function shall return any of: NULL - indicating that it
 852    doesn't recognize the selected architecture; an existing ``struct
 853    gdbarch'' from the ARCHES list - indicating that the new
 854    architecture is just a synonym for an earlier architecture (see
 855    gdbarch_list_lookup_by_info()); a newly created ``struct gdbarch''
 856    - that describes the selected architecture (see gdbarch_alloc()).
 857
 858    The DUMP_TDEP function shall print out all target specific values.
 859    Care should be taken to ensure that the function works in both the
 860    multi-arch and non- multi-arch cases. */
 861
 862 struct gdbarch_list
 863 {
 864   struct gdbarch *gdbarch;
 865   struct gdbarch_list *next;
 866 };
 867
 868 struct gdbarch_info
 869 {
 870   /* Use default: NULL (ZERO). */
 871   const struct bfd_arch_info *bfd_arch_info;
 872
 873   /* Use default: BFD_ENDIAN_UNKNOWN (NB: is not ZERO).  */
 874   int byte_order;
 875
 876   /* Use default: NULL (ZERO). */
 877   bfd *abfd;
 878
 879   /* Use default: NULL (ZERO). */
 880   struct gdbarch_tdep_info *tdep_info;
 881
 882   /* Use default: GDB_OSABI_UNINITIALIZED (-1).  */
 883   enum gdb_osabi osabi;
 884
 885   /* Use default: NULL (ZERO).  */
 886   const struct target_desc *target_desc;
 887 };
 888
 889 typedef struct gdbarch *(gdbarch_init_ftype) (struct gdbarch_info info, struct gdbarch_list *arches);
 890 typedef void (gdbarch_dump_tdep_ftype) (struct gdbarch *gdbarch, struct ui_file *file);
 891
 892 /* DEPRECATED - use gdbarch_register() */
 893 extern void register_gdbarch_init (enum bfd_architecture architecture, gdbarch_init_ftype *);
 894
 895 extern void gdbarch_register (enum bfd_architecture architecture,
 896                               gdbarch_init_ftype *,
 897                               gdbarch_dump_tdep_ftype *);
 898
 899
 900 /* Return a freshly allocated, NULL terminated, array of the valid
 901    architecture names.  Since architectures are registered during the
 902    _initialize phase this function only returns useful information
 903    once initialization has been completed. */
 904
 905 extern const char **gdbarch_printable_names (void);
 906
 907
 908 /* Helper function.  Search the list of ARCHES for a GDBARCH that
 909    matches the information provided by INFO. */
 910
 911 extern struct gdbarch_list *gdbarch_list_lookup_by_info (struct gdbarch_list *arches, const struct gdbarch_info *info);
 912
 913
 914 /* Helper function.  Create a preliminary ``struct gdbarch''.  Perform
 915    basic initialization using values obtained from the INFO and TDEP
 916    parameters.  set_gdbarch_*() functions are called to complete the
 917    initialization of the object. */
 918
 919 extern struct gdbarch *gdbarch_alloc (const struct gdbarch_info *info, struct gdbarch_tdep *tdep);
 920
 921
 922 /* Helper function.  Free a partially-constructed ``struct gdbarch''.
 923    It is assumed that the caller freeds the ``struct
 924    gdbarch_tdep''. */
 925
 926 extern void gdbarch_free (struct gdbarch *);
 927
 928
 929 /* Helper function.  Allocate memory from the ``struct gdbarch''
 930    obstack.  The memory is freed when the corresponding architecture
 931    is also freed.  */
 932
 933 extern void *gdbarch_obstack_zalloc (struct gdbarch *gdbarch, long size);
 934 #define GDBARCH_OBSTACK_CALLOC(GDBARCH, NR, TYPE) ((TYPE *) gdbarch_obstack_zalloc ((GDBARCH), (NR) * sizeof (TYPE)))
 935 #define GDBARCH_OBSTACK_ZALLOC(GDBARCH, TYPE) ((TYPE *) gdbarch_obstack_zalloc ((GDBARCH), sizeof (TYPE)))
 936
 937
 938 /* Helper function. Force an update of the current architecture.
 939
 940    The actual architecture selected is determined by INFO, ``(gdb) set
 941    architecture'' et.al., the existing architecture and BFD's default
 942    architecture.  INFO should be initialized to zero and then selected
 943    fields should be updated.
 944
 945    Returns non-zero if the update succeeds */
 946
 947 extern int gdbarch_update_p (struct gdbarch_info info);
 948
 949
 950 /* Helper function.  Find an architecture matching info.
 951
 952    INFO should be initialized using gdbarch_info_init, relevant fields
 953    set, and then finished using gdbarch_info_fill.
 954
 955    Returns the corresponding architecture, or NULL if no matching
 956    architecture was found.  "current_gdbarch" is not updated.  */
 957
 958 extern struct gdbarch *gdbarch_find_by_info (struct gdbarch_info info);
 959
 960
 961 /* Helper function.  Set the global "current_gdbarch" to "gdbarch".
 962
 963    FIXME: kettenis/20031124: Of the functions that follow, only
 964    gdbarch_from_bfd is supposed to survive.  The others will
 965    dissappear since in the future GDB will (hopefully) be truly
 966    multi-arch.  However, for now we're still stuck with the concept of
 967    a single active architecture.  */
 968
 969 extern void deprecated_current_gdbarch_select_hack (struct gdbarch *gdbarch);
 970
 971
 972 /* Register per-architecture data-pointer.
 973
 974    Reserve space for a per-architecture data-pointer.  An identifier
 975    for the reserved data-pointer is returned.  That identifer should
 976    be saved in a local static variable.
 977
 978    Memory for the per-architecture data shall be allocated using
 979    gdbarch_obstack_zalloc.  That memory will be deleted when the
 980    corresponding architecture object is deleted.
 981
 982    When a previously created architecture is re-selected, the
 983    per-architecture data-pointer for that previous architecture is
 984    restored.  INIT() is not re-called.
 985
 986    Multiple registrarants for any architecture are allowed (and
 987    strongly encouraged).  */
 988
 989 struct gdbarch_data;
 990
 991 typedef void *(gdbarch_data_pre_init_ftype) (struct obstack *obstack);
 992 extern struct gdbarch_data *gdbarch_data_register_pre_init (gdbarch_data_pre_init_ftype *init);
 993 typedef void *(gdbarch_data_post_init_ftype) (struct gdbarch *gdbarch);
 994 extern struct gdbarch_data *gdbarch_data_register_post_init (gdbarch_data_post_init_ftype *init);
 995 extern void deprecated_set_gdbarch_data (struct gdbarch *gdbarch,
 996                                          struct gdbarch_data *data,
 997                                          void *pointer);
 998
 999 extern void *gdbarch_data (struct gdbarch *gdbarch, struct gdbarch_data *);
1000
1001
1002 /* Set the dynamic target-system-dependent parameters (architecture,
1003    byte-order, ...) using information found in the BFD */
1004
1005 extern void set_gdbarch_from_file (bfd *);
1006
1007
1008 /* Initialize the current architecture to the "first" one we find on
1009    our list.  */
1010
1011 extern void initialize_current_architecture (void);
1012
1013 /* gdbarch trace variable */
1014 extern int gdbarch_debug;
1015
1016 extern void gdbarch_dump (struct gdbarch *gdbarch, struct ui_file *file);
1017
1018 #endif