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