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