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