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