gdb/gdbarch.h

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