1 /* *INDENT-OFF* */ /* THIS FILE IS GENERATED -*- buffer-read-only: t -*- */
4 /* Dynamic architecture support for GDB, the GNU debugger.
6 Copyright (C) 1998-2014 Free Software Foundation, Inc.
8 This file is part of GDB.
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
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.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>. */
23 /* This file was created with the aid of ``gdbarch.sh''.
25 The Bourne shell script ``gdbarch.sh'' creates the files
26 ``new-gdbarch.c'' and ``new-gdbarch.h and then compares them
27 against the existing ``gdbarch.[hc]''. Any differences found
30 If editing this file, please also run gdbarch.sh and merge any
31 changes into that script. Conversely, when making sweeping changes
32 to this file, modifying gdbarch.sh and using its output may prove
44 struct minimal_symbol;
48 struct disassemble_info;
51 struct bp_target_info;
53 struct displaced_step_closure;
54 struct core_regset_section;
58 struct stap_parse_info;
59 struct ravenscar_arch_ops;
60 struct elf_internal_linux_prpsinfo;
62 /* The architecture associated with the inferior through the
63 connection to the target.
65 The architecture vector provides some information that is really a
66 property of the inferior, accessed through a particular target:
67 ptrace operations; the layout of certain RSP packets; the solib_ops
68 vector; etc. To differentiate architecture accesses to
69 per-inferior/target properties from
70 per-thread/per-frame/per-objfile properties, accesses to
71 per-inferior/target properties should be made through this
74 /* This is a convenience wrapper for 'current_inferior ()->gdbarch'. */
75 extern struct gdbarch *target_gdbarch (void);
77 /* Callback type for the 'iterate_over_objfiles_in_search_order'
80 typedef int (iterate_over_objfiles_in_search_order_cb_ftype)
81 (struct objfile *objfile, void *cb_data);
84 /* The following are pre-initialized by GDBARCH. */
86 extern const struct bfd_arch_info * gdbarch_bfd_arch_info (struct gdbarch *gdbarch);
87 /* set_gdbarch_bfd_arch_info() - not applicable - pre-initialized. */
89 extern enum bfd_endian gdbarch_byte_order (struct gdbarch *gdbarch);
90 /* set_gdbarch_byte_order() - not applicable - pre-initialized. */
92 extern enum bfd_endian gdbarch_byte_order_for_code (struct gdbarch *gdbarch);
93 /* set_gdbarch_byte_order_for_code() - not applicable - pre-initialized. */
95 extern enum gdb_osabi gdbarch_osabi (struct gdbarch *gdbarch);
96 /* set_gdbarch_osabi() - not applicable - pre-initialized. */
98 extern const struct target_desc * gdbarch_target_desc (struct gdbarch *gdbarch);
99 /* set_gdbarch_target_desc() - not applicable - pre-initialized. */
102 /* The following are initialized by the target dependent code. */
104 /* The bit byte-order has to do just with numbering of bits in debugging symbols
105 and such. Conceptually, it's quite separate from byte/word byte order. */
107 extern int gdbarch_bits_big_endian (struct gdbarch *gdbarch);
108 extern void set_gdbarch_bits_big_endian (struct gdbarch *gdbarch, int bits_big_endian);
110 /* Number of bits in a char or unsigned char for the target machine.
111 Just like CHAR_BIT in <limits.h> but describes the target machine.
112 v:TARGET_CHAR_BIT:int:char_bit::::8 * sizeof (char):8::0:
114 Number of bits in a short or unsigned short for the target machine. */
116 extern int gdbarch_short_bit (struct gdbarch *gdbarch);
117 extern void set_gdbarch_short_bit (struct gdbarch *gdbarch, int short_bit);
119 /* Number of bits in an int or unsigned int for the target machine. */
121 extern int gdbarch_int_bit (struct gdbarch *gdbarch);
122 extern void set_gdbarch_int_bit (struct gdbarch *gdbarch, int int_bit);
124 /* Number of bits in a long or unsigned long for the target machine. */
126 extern int gdbarch_long_bit (struct gdbarch *gdbarch);
127 extern void set_gdbarch_long_bit (struct gdbarch *gdbarch, int long_bit);
129 /* Number of bits in a long long or unsigned long long for the target
132 extern int gdbarch_long_long_bit (struct gdbarch *gdbarch);
133 extern void set_gdbarch_long_long_bit (struct gdbarch *gdbarch, int long_long_bit);
135 /* Alignment of a long long or unsigned long long for the target
138 extern int gdbarch_long_long_align_bit (struct gdbarch *gdbarch);
139 extern void set_gdbarch_long_long_align_bit (struct gdbarch *gdbarch, int long_long_align_bit);
141 /* The ABI default bit-size and format for "half", "float", "double", and
142 "long double". These bit/format pairs should eventually be combined
143 into a single object. For the moment, just initialize them as a pair.
144 Each format describes both the big and little endian layouts (if
147 extern int gdbarch_half_bit (struct gdbarch *gdbarch);
148 extern void set_gdbarch_half_bit (struct gdbarch *gdbarch, int half_bit);
150 extern const struct floatformat ** gdbarch_half_format (struct gdbarch *gdbarch);
151 extern void set_gdbarch_half_format (struct gdbarch *gdbarch, const struct floatformat ** half_format);
153 extern int gdbarch_float_bit (struct gdbarch *gdbarch);
154 extern void set_gdbarch_float_bit (struct gdbarch *gdbarch, int float_bit);
156 extern const struct floatformat ** gdbarch_float_format (struct gdbarch *gdbarch);
157 extern void set_gdbarch_float_format (struct gdbarch *gdbarch, const struct floatformat ** float_format);
159 extern int gdbarch_double_bit (struct gdbarch *gdbarch);
160 extern void set_gdbarch_double_bit (struct gdbarch *gdbarch, int double_bit);
162 extern const struct floatformat ** gdbarch_double_format (struct gdbarch *gdbarch);
163 extern void set_gdbarch_double_format (struct gdbarch *gdbarch, const struct floatformat ** double_format);
165 extern int gdbarch_long_double_bit (struct gdbarch *gdbarch);
166 extern void set_gdbarch_long_double_bit (struct gdbarch *gdbarch, int long_double_bit);
168 extern const struct floatformat ** gdbarch_long_double_format (struct gdbarch *gdbarch);
169 extern void set_gdbarch_long_double_format (struct gdbarch *gdbarch, const struct floatformat ** long_double_format);
171 /* For most targets, a pointer on the target and its representation as an
172 address in GDB have the same size and "look the same". For such a
173 target, you need only set gdbarch_ptr_bit and gdbarch_addr_bit
174 / addr_bit will be set from it.
176 If gdbarch_ptr_bit and gdbarch_addr_bit are different, you'll probably
177 also need to set gdbarch_dwarf2_addr_size, gdbarch_pointer_to_address and
178 gdbarch_address_to_pointer as well.
180 ptr_bit is the size of a pointer on the target */
182 extern int gdbarch_ptr_bit (struct gdbarch *gdbarch);
183 extern void set_gdbarch_ptr_bit (struct gdbarch *gdbarch, int ptr_bit);
185 /* addr_bit is the size of a target address as represented in gdb */
187 extern int gdbarch_addr_bit (struct gdbarch *gdbarch);
188 extern void set_gdbarch_addr_bit (struct gdbarch *gdbarch, int addr_bit);
190 /* dwarf2_addr_size is the target address size as used in the Dwarf debug
191 info. For .debug_frame FDEs, this is supposed to be the target address
192 size from the associated CU header, and which is equivalent to the
193 DWARF2_ADDR_SIZE as defined by the target specific GCC back-end.
194 Unfortunately there is no good way to determine this value. Therefore
195 dwarf2_addr_size simply defaults to the target pointer size.
197 dwarf2_addr_size is not used for .eh_frame FDEs, which are generally
198 defined using the target's pointer size so far.
200 Note that dwarf2_addr_size only needs to be redefined by a target if the
201 GCC back-end defines a DWARF2_ADDR_SIZE other than the target pointer size,
202 and if Dwarf versions < 4 need to be supported. */
204 extern int gdbarch_dwarf2_addr_size (struct gdbarch *gdbarch);
205 extern void set_gdbarch_dwarf2_addr_size (struct gdbarch *gdbarch, int dwarf2_addr_size);
207 /* One if `char' acts like `signed char', zero if `unsigned char'. */
209 extern int gdbarch_char_signed (struct gdbarch *gdbarch);
210 extern void set_gdbarch_char_signed (struct gdbarch *gdbarch, int char_signed);
212 extern int gdbarch_read_pc_p (struct gdbarch *gdbarch);
214 typedef CORE_ADDR (gdbarch_read_pc_ftype) (struct regcache *regcache);
215 extern CORE_ADDR gdbarch_read_pc (struct gdbarch *gdbarch, struct regcache *regcache);
216 extern void set_gdbarch_read_pc (struct gdbarch *gdbarch, gdbarch_read_pc_ftype *read_pc);
218 extern int gdbarch_write_pc_p (struct gdbarch *gdbarch);
220 typedef void (gdbarch_write_pc_ftype) (struct regcache *regcache, CORE_ADDR val);
221 extern void gdbarch_write_pc (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR val);
222 extern void set_gdbarch_write_pc (struct gdbarch *gdbarch, gdbarch_write_pc_ftype *write_pc);
224 /* Function for getting target's idea of a frame pointer. FIXME: GDB's
225 whole scheme for dealing with "frames" and "frame pointers" needs a
226 serious shakedown. */
228 typedef void (gdbarch_virtual_frame_pointer_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc, int *frame_regnum, LONGEST *frame_offset);
229 extern void gdbarch_virtual_frame_pointer (struct gdbarch *gdbarch, CORE_ADDR pc, int *frame_regnum, LONGEST *frame_offset);
230 extern void set_gdbarch_virtual_frame_pointer (struct gdbarch *gdbarch, gdbarch_virtual_frame_pointer_ftype *virtual_frame_pointer);
232 extern int gdbarch_pseudo_register_read_p (struct gdbarch *gdbarch);
234 typedef enum register_status (gdbarch_pseudo_register_read_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, gdb_byte *buf);
235 extern enum register_status gdbarch_pseudo_register_read (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, gdb_byte *buf);
236 extern void set_gdbarch_pseudo_register_read (struct gdbarch *gdbarch, gdbarch_pseudo_register_read_ftype *pseudo_register_read);
238 /* Read a register into a new struct value. If the register is wholly
239 or partly unavailable, this should call mark_value_bytes_unavailable
240 as appropriate. If this is defined, then pseudo_register_read will
243 extern int gdbarch_pseudo_register_read_value_p (struct gdbarch *gdbarch);
245 typedef struct value * (gdbarch_pseudo_register_read_value_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum);
246 extern struct value * gdbarch_pseudo_register_read_value (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum);
247 extern void set_gdbarch_pseudo_register_read_value (struct gdbarch *gdbarch, gdbarch_pseudo_register_read_value_ftype *pseudo_register_read_value);
249 extern int gdbarch_pseudo_register_write_p (struct gdbarch *gdbarch);
251 typedef void (gdbarch_pseudo_register_write_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, const gdb_byte *buf);
252 extern void gdbarch_pseudo_register_write (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, const gdb_byte *buf);
253 extern void set_gdbarch_pseudo_register_write (struct gdbarch *gdbarch, gdbarch_pseudo_register_write_ftype *pseudo_register_write);
255 extern int gdbarch_num_regs (struct gdbarch *gdbarch);
256 extern void set_gdbarch_num_regs (struct gdbarch *gdbarch, int num_regs);
258 /* This macro gives the number of pseudo-registers that live in the
259 register namespace but do not get fetched or stored on the target.
260 These pseudo-registers may be aliases for other registers,
261 combinations of other registers, or they may be computed by GDB. */
263 extern int gdbarch_num_pseudo_regs (struct gdbarch *gdbarch);
264 extern void set_gdbarch_num_pseudo_regs (struct gdbarch *gdbarch, int num_pseudo_regs);
266 /* Assemble agent expression bytecode to collect pseudo-register REG.
267 Return -1 if something goes wrong, 0 otherwise. */
269 extern int gdbarch_ax_pseudo_register_collect_p (struct gdbarch *gdbarch);
271 typedef int (gdbarch_ax_pseudo_register_collect_ftype) (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
272 extern int gdbarch_ax_pseudo_register_collect (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
273 extern void set_gdbarch_ax_pseudo_register_collect (struct gdbarch *gdbarch, gdbarch_ax_pseudo_register_collect_ftype *ax_pseudo_register_collect);
275 /* Assemble agent expression bytecode to push the value of pseudo-register
276 REG on the interpreter stack.
277 Return -1 if something goes wrong, 0 otherwise. */
279 extern int gdbarch_ax_pseudo_register_push_stack_p (struct gdbarch *gdbarch);
281 typedef int (gdbarch_ax_pseudo_register_push_stack_ftype) (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
282 extern int gdbarch_ax_pseudo_register_push_stack (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
283 extern void set_gdbarch_ax_pseudo_register_push_stack (struct gdbarch *gdbarch, gdbarch_ax_pseudo_register_push_stack_ftype *ax_pseudo_register_push_stack);
285 /* GDB's standard (or well known) register numbers. These can map onto
286 a real register or a pseudo (computed) register or not be defined at
288 gdbarch_sp_regnum will hopefully be replaced by UNWIND_SP. */
290 extern int gdbarch_sp_regnum (struct gdbarch *gdbarch);
291 extern void set_gdbarch_sp_regnum (struct gdbarch *gdbarch, int sp_regnum);
293 extern int gdbarch_pc_regnum (struct gdbarch *gdbarch);
294 extern void set_gdbarch_pc_regnum (struct gdbarch *gdbarch, int pc_regnum);
296 extern int gdbarch_ps_regnum (struct gdbarch *gdbarch);
297 extern void set_gdbarch_ps_regnum (struct gdbarch *gdbarch, int ps_regnum);
299 extern int gdbarch_fp0_regnum (struct gdbarch *gdbarch);
300 extern void set_gdbarch_fp0_regnum (struct gdbarch *gdbarch, int fp0_regnum);
302 /* Convert stab register number (from `r' declaration) to a gdb REGNUM. */
304 typedef int (gdbarch_stab_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int stab_regnr);
305 extern int gdbarch_stab_reg_to_regnum (struct gdbarch *gdbarch, int stab_regnr);
306 extern void set_gdbarch_stab_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_stab_reg_to_regnum_ftype *stab_reg_to_regnum);
308 /* Provide a default mapping from a ecoff register number to a gdb REGNUM. */
310 typedef int (gdbarch_ecoff_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int ecoff_regnr);
311 extern int gdbarch_ecoff_reg_to_regnum (struct gdbarch *gdbarch, int ecoff_regnr);
312 extern void set_gdbarch_ecoff_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_ecoff_reg_to_regnum_ftype *ecoff_reg_to_regnum);
314 /* Convert from an sdb register number to an internal gdb register number. */
316 typedef int (gdbarch_sdb_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int sdb_regnr);
317 extern int gdbarch_sdb_reg_to_regnum (struct gdbarch *gdbarch, int sdb_regnr);
318 extern void set_gdbarch_sdb_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_sdb_reg_to_regnum_ftype *sdb_reg_to_regnum);
320 /* Provide a default mapping from a DWARF2 register number to a gdb REGNUM. */
322 typedef int (gdbarch_dwarf2_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int dwarf2_regnr);
323 extern int gdbarch_dwarf2_reg_to_regnum (struct gdbarch *gdbarch, int dwarf2_regnr);
324 extern void set_gdbarch_dwarf2_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_dwarf2_reg_to_regnum_ftype *dwarf2_reg_to_regnum);
326 typedef const char * (gdbarch_register_name_ftype) (struct gdbarch *gdbarch, int regnr);
327 extern const char * gdbarch_register_name (struct gdbarch *gdbarch, int regnr);
328 extern void set_gdbarch_register_name (struct gdbarch *gdbarch, gdbarch_register_name_ftype *register_name);
330 /* Return the type of a register specified by the architecture. Only
331 the register cache should call this function directly; others should
332 use "register_type". */
334 extern int gdbarch_register_type_p (struct gdbarch *gdbarch);
336 typedef struct type * (gdbarch_register_type_ftype) (struct gdbarch *gdbarch, int reg_nr);
337 extern struct type * gdbarch_register_type (struct gdbarch *gdbarch, int reg_nr);
338 extern void set_gdbarch_register_type (struct gdbarch *gdbarch, gdbarch_register_type_ftype *register_type);
340 extern int gdbarch_dummy_id_p (struct gdbarch *gdbarch);
342 typedef struct frame_id (gdbarch_dummy_id_ftype) (struct gdbarch *gdbarch, struct frame_info *this_frame);
343 extern struct frame_id gdbarch_dummy_id (struct gdbarch *gdbarch, struct frame_info *this_frame);
344 extern void set_gdbarch_dummy_id (struct gdbarch *gdbarch, gdbarch_dummy_id_ftype *dummy_id);
346 /* Implement DUMMY_ID and PUSH_DUMMY_CALL, then delete
347 deprecated_fp_regnum. */
349 extern int gdbarch_deprecated_fp_regnum (struct gdbarch *gdbarch);
350 extern void set_gdbarch_deprecated_fp_regnum (struct gdbarch *gdbarch, int deprecated_fp_regnum);
352 extern int gdbarch_push_dummy_call_p (struct gdbarch *gdbarch);
354 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);
355 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);
356 extern void set_gdbarch_push_dummy_call (struct gdbarch *gdbarch, gdbarch_push_dummy_call_ftype *push_dummy_call);
358 extern int gdbarch_call_dummy_location (struct gdbarch *gdbarch);
359 extern void set_gdbarch_call_dummy_location (struct gdbarch *gdbarch, int call_dummy_location);
361 extern int gdbarch_push_dummy_code_p (struct gdbarch *gdbarch);
363 typedef CORE_ADDR (gdbarch_push_dummy_code_ftype) (struct gdbarch *gdbarch, CORE_ADDR sp, CORE_ADDR funaddr, struct value **args, int nargs, struct type *value_type, CORE_ADDR *real_pc, CORE_ADDR *bp_addr, struct regcache *regcache);
364 extern CORE_ADDR gdbarch_push_dummy_code (struct gdbarch *gdbarch, CORE_ADDR sp, CORE_ADDR funaddr, struct value **args, int nargs, struct type *value_type, CORE_ADDR *real_pc, CORE_ADDR *bp_addr, struct regcache *regcache);
365 extern void set_gdbarch_push_dummy_code (struct gdbarch *gdbarch, gdbarch_push_dummy_code_ftype *push_dummy_code);
367 typedef void (gdbarch_print_registers_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, int regnum, int all);
368 extern void gdbarch_print_registers_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, int regnum, int all);
369 extern void set_gdbarch_print_registers_info (struct gdbarch *gdbarch, gdbarch_print_registers_info_ftype *print_registers_info);
371 extern int gdbarch_print_float_info_p (struct gdbarch *gdbarch);
373 typedef void (gdbarch_print_float_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
374 extern void gdbarch_print_float_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
375 extern void set_gdbarch_print_float_info (struct gdbarch *gdbarch, gdbarch_print_float_info_ftype *print_float_info);
377 extern int gdbarch_print_vector_info_p (struct gdbarch *gdbarch);
379 typedef void (gdbarch_print_vector_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
380 extern void gdbarch_print_vector_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
381 extern void set_gdbarch_print_vector_info (struct gdbarch *gdbarch, gdbarch_print_vector_info_ftype *print_vector_info);
383 /* MAP a GDB RAW register number onto a simulator register number. See
384 also include/...-sim.h. */
386 typedef int (gdbarch_register_sim_regno_ftype) (struct gdbarch *gdbarch, int reg_nr);
387 extern int gdbarch_register_sim_regno (struct gdbarch *gdbarch, int reg_nr);
388 extern void set_gdbarch_register_sim_regno (struct gdbarch *gdbarch, gdbarch_register_sim_regno_ftype *register_sim_regno);
390 typedef int (gdbarch_cannot_fetch_register_ftype) (struct gdbarch *gdbarch, int regnum);
391 extern int gdbarch_cannot_fetch_register (struct gdbarch *gdbarch, int regnum);
392 extern void set_gdbarch_cannot_fetch_register (struct gdbarch *gdbarch, gdbarch_cannot_fetch_register_ftype *cannot_fetch_register);
394 typedef int (gdbarch_cannot_store_register_ftype) (struct gdbarch *gdbarch, int regnum);
395 extern int gdbarch_cannot_store_register (struct gdbarch *gdbarch, int regnum);
396 extern void set_gdbarch_cannot_store_register (struct gdbarch *gdbarch, gdbarch_cannot_store_register_ftype *cannot_store_register);
398 /* Determine the address where a longjmp will land and save this address
399 in PC. Return nonzero on success.
401 FRAME corresponds to the longjmp frame. */
403 extern int gdbarch_get_longjmp_target_p (struct gdbarch *gdbarch);
405 typedef int (gdbarch_get_longjmp_target_ftype) (struct frame_info *frame, CORE_ADDR *pc);
406 extern int gdbarch_get_longjmp_target (struct gdbarch *gdbarch, struct frame_info *frame, CORE_ADDR *pc);
407 extern void set_gdbarch_get_longjmp_target (struct gdbarch *gdbarch, gdbarch_get_longjmp_target_ftype *get_longjmp_target);
409 extern int gdbarch_believe_pcc_promotion (struct gdbarch *gdbarch);
410 extern void set_gdbarch_believe_pcc_promotion (struct gdbarch *gdbarch, int believe_pcc_promotion);
412 typedef int (gdbarch_convert_register_p_ftype) (struct gdbarch *gdbarch, int regnum, struct type *type);
413 extern int gdbarch_convert_register_p (struct gdbarch *gdbarch, int regnum, struct type *type);
414 extern void set_gdbarch_convert_register_p (struct gdbarch *gdbarch, gdbarch_convert_register_p_ftype *convert_register_p);
416 typedef int (gdbarch_register_to_value_ftype) (struct frame_info *frame, int regnum, struct type *type, gdb_byte *buf, int *optimizedp, int *unavailablep);
417 extern int gdbarch_register_to_value (struct gdbarch *gdbarch, struct frame_info *frame, int regnum, struct type *type, gdb_byte *buf, int *optimizedp, int *unavailablep);
418 extern void set_gdbarch_register_to_value (struct gdbarch *gdbarch, gdbarch_register_to_value_ftype *register_to_value);
420 typedef void (gdbarch_value_to_register_ftype) (struct frame_info *frame, int regnum, struct type *type, const gdb_byte *buf);
421 extern void gdbarch_value_to_register (struct gdbarch *gdbarch, struct frame_info *frame, int regnum, struct type *type, const gdb_byte *buf);
422 extern void set_gdbarch_value_to_register (struct gdbarch *gdbarch, gdbarch_value_to_register_ftype *value_to_register);
424 /* Construct a value representing the contents of register REGNUM in
425 frame FRAME_ID, interpreted as type TYPE. The routine needs to
426 allocate and return a struct value with all value attributes
427 (but not the value contents) filled in. */
429 typedef struct value * (gdbarch_value_from_register_ftype) (struct gdbarch *gdbarch, struct type *type, int regnum, struct frame_id frame_id);
430 extern struct value * gdbarch_value_from_register (struct gdbarch *gdbarch, struct type *type, int regnum, struct frame_id frame_id);
431 extern void set_gdbarch_value_from_register (struct gdbarch *gdbarch, gdbarch_value_from_register_ftype *value_from_register);
433 typedef CORE_ADDR (gdbarch_pointer_to_address_ftype) (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
434 extern CORE_ADDR gdbarch_pointer_to_address (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
435 extern void set_gdbarch_pointer_to_address (struct gdbarch *gdbarch, gdbarch_pointer_to_address_ftype *pointer_to_address);
437 typedef void (gdbarch_address_to_pointer_ftype) (struct gdbarch *gdbarch, struct type *type, gdb_byte *buf, CORE_ADDR addr);
438 extern void gdbarch_address_to_pointer (struct gdbarch *gdbarch, struct type *type, gdb_byte *buf, CORE_ADDR addr);
439 extern void set_gdbarch_address_to_pointer (struct gdbarch *gdbarch, gdbarch_address_to_pointer_ftype *address_to_pointer);
441 extern int gdbarch_integer_to_address_p (struct gdbarch *gdbarch);
443 typedef CORE_ADDR (gdbarch_integer_to_address_ftype) (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
444 extern CORE_ADDR gdbarch_integer_to_address (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
445 extern void set_gdbarch_integer_to_address (struct gdbarch *gdbarch, gdbarch_integer_to_address_ftype *integer_to_address);
447 /* Return the return-value convention that will be used by FUNCTION
448 to return a value of type VALTYPE. FUNCTION may be NULL in which
449 case the return convention is computed based only on VALTYPE.
451 If READBUF is not NULL, extract the return value and save it in this buffer.
453 If WRITEBUF is not NULL, it contains a return value which will be
454 stored into the appropriate register. This can be used when we want
455 to force the value returned by a function (see the "return" command
458 extern int gdbarch_return_value_p (struct gdbarch *gdbarch);
460 typedef enum return_value_convention (gdbarch_return_value_ftype) (struct gdbarch *gdbarch, struct value *function, struct type *valtype, struct regcache *regcache, gdb_byte *readbuf, const gdb_byte *writebuf);
461 extern enum return_value_convention gdbarch_return_value (struct gdbarch *gdbarch, struct value *function, struct type *valtype, struct regcache *regcache, gdb_byte *readbuf, const gdb_byte *writebuf);
462 extern void set_gdbarch_return_value (struct gdbarch *gdbarch, gdbarch_return_value_ftype *return_value);
464 /* Return true if the return value of function is stored in the first hidden
465 parameter. In theory, this feature should be language-dependent, specified
466 by language and its ABI, such as C++. Unfortunately, compiler may
467 implement it to a target-dependent feature. So that we need such hook here
468 to be aware of this in GDB. */
470 typedef int (gdbarch_return_in_first_hidden_param_p_ftype) (struct gdbarch *gdbarch, struct type *type);
471 extern int gdbarch_return_in_first_hidden_param_p (struct gdbarch *gdbarch, struct type *type);
472 extern void set_gdbarch_return_in_first_hidden_param_p (struct gdbarch *gdbarch, gdbarch_return_in_first_hidden_param_p_ftype *return_in_first_hidden_param_p);
474 typedef CORE_ADDR (gdbarch_skip_prologue_ftype) (struct gdbarch *gdbarch, CORE_ADDR ip);
475 extern CORE_ADDR gdbarch_skip_prologue (struct gdbarch *gdbarch, CORE_ADDR ip);
476 extern void set_gdbarch_skip_prologue (struct gdbarch *gdbarch, gdbarch_skip_prologue_ftype *skip_prologue);
478 extern int gdbarch_skip_main_prologue_p (struct gdbarch *gdbarch);
480 typedef CORE_ADDR (gdbarch_skip_main_prologue_ftype) (struct gdbarch *gdbarch, CORE_ADDR ip);
481 extern CORE_ADDR gdbarch_skip_main_prologue (struct gdbarch *gdbarch, CORE_ADDR ip);
482 extern void set_gdbarch_skip_main_prologue (struct gdbarch *gdbarch, gdbarch_skip_main_prologue_ftype *skip_main_prologue);
484 /* On some platforms, a single function may provide multiple entry points,
485 e.g. one that is used for function-pointer calls and a different one
486 that is used for direct function calls.
487 In order to ensure that breakpoints set on the function will trigger
488 no matter via which entry point the function is entered, a platform
489 may provide the skip_entrypoint callback. It is called with IP set
490 to the main entry point of a function (as determined by the symbol table),
491 and should return the address of the innermost entry point, where the
492 actual breakpoint needs to be set. Note that skip_entrypoint is used
493 by GDB common code even when debugging optimized code, where skip_prologue
496 extern int gdbarch_skip_entrypoint_p (struct gdbarch *gdbarch);
498 typedef CORE_ADDR (gdbarch_skip_entrypoint_ftype) (struct gdbarch *gdbarch, CORE_ADDR ip);
499 extern CORE_ADDR gdbarch_skip_entrypoint (struct gdbarch *gdbarch, CORE_ADDR ip);
500 extern void set_gdbarch_skip_entrypoint (struct gdbarch *gdbarch, gdbarch_skip_entrypoint_ftype *skip_entrypoint);
502 typedef int (gdbarch_inner_than_ftype) (CORE_ADDR lhs, CORE_ADDR rhs);
503 extern int gdbarch_inner_than (struct gdbarch *gdbarch, CORE_ADDR lhs, CORE_ADDR rhs);
504 extern void set_gdbarch_inner_than (struct gdbarch *gdbarch, gdbarch_inner_than_ftype *inner_than);
506 typedef const gdb_byte * (gdbarch_breakpoint_from_pc_ftype) (struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *lenptr);
507 extern const gdb_byte * gdbarch_breakpoint_from_pc (struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *lenptr);
508 extern void set_gdbarch_breakpoint_from_pc (struct gdbarch *gdbarch, gdbarch_breakpoint_from_pc_ftype *breakpoint_from_pc);
510 /* Return the adjusted address and kind to use for Z0/Z1 packets.
511 KIND is usually the memory length of the breakpoint, but may have a
512 different target-specific meaning. */
514 typedef void (gdbarch_remote_breakpoint_from_pc_ftype) (struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *kindptr);
515 extern void gdbarch_remote_breakpoint_from_pc (struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *kindptr);
516 extern void set_gdbarch_remote_breakpoint_from_pc (struct gdbarch *gdbarch, gdbarch_remote_breakpoint_from_pc_ftype *remote_breakpoint_from_pc);
518 extern int gdbarch_adjust_breakpoint_address_p (struct gdbarch *gdbarch);
520 typedef CORE_ADDR (gdbarch_adjust_breakpoint_address_ftype) (struct gdbarch *gdbarch, CORE_ADDR bpaddr);
521 extern CORE_ADDR gdbarch_adjust_breakpoint_address (struct gdbarch *gdbarch, CORE_ADDR bpaddr);
522 extern void set_gdbarch_adjust_breakpoint_address (struct gdbarch *gdbarch, gdbarch_adjust_breakpoint_address_ftype *adjust_breakpoint_address);
524 typedef int (gdbarch_memory_insert_breakpoint_ftype) (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
525 extern int gdbarch_memory_insert_breakpoint (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
526 extern void set_gdbarch_memory_insert_breakpoint (struct gdbarch *gdbarch, gdbarch_memory_insert_breakpoint_ftype *memory_insert_breakpoint);
528 typedef int (gdbarch_memory_remove_breakpoint_ftype) (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
529 extern int gdbarch_memory_remove_breakpoint (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
530 extern void set_gdbarch_memory_remove_breakpoint (struct gdbarch *gdbarch, gdbarch_memory_remove_breakpoint_ftype *memory_remove_breakpoint);
532 extern CORE_ADDR gdbarch_decr_pc_after_break (struct gdbarch *gdbarch);
533 extern void set_gdbarch_decr_pc_after_break (struct gdbarch *gdbarch, CORE_ADDR decr_pc_after_break);
535 /* A function can be addressed by either it's "pointer" (possibly a
536 descriptor address) or "entry point" (first executable instruction).
537 The method "convert_from_func_ptr_addr" converting the former to the
538 latter. gdbarch_deprecated_function_start_offset is being used to implement
539 a simplified subset of that functionality - the function's address
540 corresponds to the "function pointer" and the function's start
541 corresponds to the "function entry point" - and hence is redundant. */
543 extern CORE_ADDR gdbarch_deprecated_function_start_offset (struct gdbarch *gdbarch);
544 extern void set_gdbarch_deprecated_function_start_offset (struct gdbarch *gdbarch, CORE_ADDR deprecated_function_start_offset);
546 /* Return the remote protocol register number associated with this
547 register. Normally the identity mapping. */
549 typedef int (gdbarch_remote_register_number_ftype) (struct gdbarch *gdbarch, int regno);
550 extern int gdbarch_remote_register_number (struct gdbarch *gdbarch, int regno);
551 extern void set_gdbarch_remote_register_number (struct gdbarch *gdbarch, gdbarch_remote_register_number_ftype *remote_register_number);
553 /* Fetch the target specific address used to represent a load module. */
555 extern int gdbarch_fetch_tls_load_module_address_p (struct gdbarch *gdbarch);
557 typedef CORE_ADDR (gdbarch_fetch_tls_load_module_address_ftype) (struct objfile *objfile);
558 extern CORE_ADDR gdbarch_fetch_tls_load_module_address (struct gdbarch *gdbarch, struct objfile *objfile);
559 extern void set_gdbarch_fetch_tls_load_module_address (struct gdbarch *gdbarch, gdbarch_fetch_tls_load_module_address_ftype *fetch_tls_load_module_address);
561 extern CORE_ADDR gdbarch_frame_args_skip (struct gdbarch *gdbarch);
562 extern void set_gdbarch_frame_args_skip (struct gdbarch *gdbarch, CORE_ADDR frame_args_skip);
564 extern int gdbarch_unwind_pc_p (struct gdbarch *gdbarch);
566 typedef CORE_ADDR (gdbarch_unwind_pc_ftype) (struct gdbarch *gdbarch, struct frame_info *next_frame);
567 extern CORE_ADDR gdbarch_unwind_pc (struct gdbarch *gdbarch, struct frame_info *next_frame);
568 extern void set_gdbarch_unwind_pc (struct gdbarch *gdbarch, gdbarch_unwind_pc_ftype *unwind_pc);
570 extern int gdbarch_unwind_sp_p (struct gdbarch *gdbarch);
572 typedef CORE_ADDR (gdbarch_unwind_sp_ftype) (struct gdbarch *gdbarch, struct frame_info *next_frame);
573 extern CORE_ADDR gdbarch_unwind_sp (struct gdbarch *gdbarch, struct frame_info *next_frame);
574 extern void set_gdbarch_unwind_sp (struct gdbarch *gdbarch, gdbarch_unwind_sp_ftype *unwind_sp);
576 /* DEPRECATED_FRAME_LOCALS_ADDRESS as been replaced by the per-frame
577 frame-base. Enable frame-base before frame-unwind. */
579 extern int gdbarch_frame_num_args_p (struct gdbarch *gdbarch);
581 typedef int (gdbarch_frame_num_args_ftype) (struct frame_info *frame);
582 extern int gdbarch_frame_num_args (struct gdbarch *gdbarch, struct frame_info *frame);
583 extern void set_gdbarch_frame_num_args (struct gdbarch *gdbarch, gdbarch_frame_num_args_ftype *frame_num_args);
585 extern int gdbarch_frame_align_p (struct gdbarch *gdbarch);
587 typedef CORE_ADDR (gdbarch_frame_align_ftype) (struct gdbarch *gdbarch, CORE_ADDR address);
588 extern CORE_ADDR gdbarch_frame_align (struct gdbarch *gdbarch, CORE_ADDR address);
589 extern void set_gdbarch_frame_align (struct gdbarch *gdbarch, gdbarch_frame_align_ftype *frame_align);
591 typedef int (gdbarch_stabs_argument_has_addr_ftype) (struct gdbarch *gdbarch, struct type *type);
592 extern int gdbarch_stabs_argument_has_addr (struct gdbarch *gdbarch, struct type *type);
593 extern void set_gdbarch_stabs_argument_has_addr (struct gdbarch *gdbarch, gdbarch_stabs_argument_has_addr_ftype *stabs_argument_has_addr);
595 extern int gdbarch_frame_red_zone_size (struct gdbarch *gdbarch);
596 extern void set_gdbarch_frame_red_zone_size (struct gdbarch *gdbarch, int frame_red_zone_size);
598 typedef CORE_ADDR (gdbarch_convert_from_func_ptr_addr_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr, struct target_ops *targ);
599 extern CORE_ADDR gdbarch_convert_from_func_ptr_addr (struct gdbarch *gdbarch, CORE_ADDR addr, struct target_ops *targ);
600 extern void set_gdbarch_convert_from_func_ptr_addr (struct gdbarch *gdbarch, gdbarch_convert_from_func_ptr_addr_ftype *convert_from_func_ptr_addr);
602 /* On some machines there are bits in addresses which are not really
603 part of the address, but are used by the kernel, the hardware, etc.
604 for special purposes. gdbarch_addr_bits_remove takes out any such bits so
605 we get a "real" address such as one would find in a symbol table.
606 This is used only for addresses of instructions, and even then I'm
607 not sure it's used in all contexts. It exists to deal with there
608 being a few stray bits in the PC which would mislead us, not as some
609 sort of generic thing to handle alignment or segmentation (it's
610 possible it should be in TARGET_READ_PC instead). */
612 typedef CORE_ADDR (gdbarch_addr_bits_remove_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
613 extern CORE_ADDR gdbarch_addr_bits_remove (struct gdbarch *gdbarch, CORE_ADDR addr);
614 extern void set_gdbarch_addr_bits_remove (struct gdbarch *gdbarch, gdbarch_addr_bits_remove_ftype *addr_bits_remove);
616 /* FIXME/cagney/2001-01-18: This should be split in two. A target method that
617 indicates if the target needs software single step. An ISA method to
620 FIXME/cagney/2001-01-18: This should be replaced with something that inserts
621 breakpoints using the breakpoint system instead of blatting memory directly
624 FIXME/cagney/2001-01-18: The logic is backwards. It should be asking if the
625 target can single step. If not, then implement single step using breakpoints.
627 A return value of 1 means that the software_single_step breakpoints
628 were inserted; 0 means they were not. */
630 extern int gdbarch_software_single_step_p (struct gdbarch *gdbarch);
632 typedef int (gdbarch_software_single_step_ftype) (struct frame_info *frame);
633 extern int gdbarch_software_single_step (struct gdbarch *gdbarch, struct frame_info *frame);
634 extern void set_gdbarch_software_single_step (struct gdbarch *gdbarch, gdbarch_software_single_step_ftype *software_single_step);
636 /* Return non-zero if the processor is executing a delay slot and a
637 further single-step is needed before the instruction finishes. */
639 extern int gdbarch_single_step_through_delay_p (struct gdbarch *gdbarch);
641 typedef int (gdbarch_single_step_through_delay_ftype) (struct gdbarch *gdbarch, struct frame_info *frame);
642 extern int gdbarch_single_step_through_delay (struct gdbarch *gdbarch, struct frame_info *frame);
643 extern void set_gdbarch_single_step_through_delay (struct gdbarch *gdbarch, gdbarch_single_step_through_delay_ftype *single_step_through_delay);
645 /* FIXME: cagney/2003-08-28: Need to find a better way of selecting the
646 disassembler. Perhaps objdump can handle it? */
648 typedef int (gdbarch_print_insn_ftype) (bfd_vma vma, struct disassemble_info *info);
649 extern int gdbarch_print_insn (struct gdbarch *gdbarch, bfd_vma vma, struct disassemble_info *info);
650 extern void set_gdbarch_print_insn (struct gdbarch *gdbarch, gdbarch_print_insn_ftype *print_insn);
652 typedef CORE_ADDR (gdbarch_skip_trampoline_code_ftype) (struct frame_info *frame, CORE_ADDR pc);
653 extern CORE_ADDR gdbarch_skip_trampoline_code (struct gdbarch *gdbarch, struct frame_info *frame, CORE_ADDR pc);
654 extern void set_gdbarch_skip_trampoline_code (struct gdbarch *gdbarch, gdbarch_skip_trampoline_code_ftype *skip_trampoline_code);
656 /* If in_solib_dynsym_resolve_code() returns true, and SKIP_SOLIB_RESOLVER
657 evaluates non-zero, this is the address where the debugger will place
658 a step-resume breakpoint to get us past the dynamic linker. */
660 typedef CORE_ADDR (gdbarch_skip_solib_resolver_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc);
661 extern CORE_ADDR gdbarch_skip_solib_resolver (struct gdbarch *gdbarch, CORE_ADDR pc);
662 extern void set_gdbarch_skip_solib_resolver (struct gdbarch *gdbarch, gdbarch_skip_solib_resolver_ftype *skip_solib_resolver);
664 /* Some systems also have trampoline code for returning from shared libs. */
666 typedef int (gdbarch_in_solib_return_trampoline_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc, const char *name);
667 extern int gdbarch_in_solib_return_trampoline (struct gdbarch *gdbarch, CORE_ADDR pc, const char *name);
668 extern void set_gdbarch_in_solib_return_trampoline (struct gdbarch *gdbarch, gdbarch_in_solib_return_trampoline_ftype *in_solib_return_trampoline);
670 /* A target might have problems with watchpoints as soon as the stack
671 frame of the current function has been destroyed. This mostly happens
672 as the first action in a funtion's epilogue. in_function_epilogue_p()
673 is defined to return a non-zero value if either the given addr is one
674 instruction after the stack destroying instruction up to the trailing
675 return instruction or if we can figure out that the stack frame has
676 already been invalidated regardless of the value of addr. Targets
677 which don't suffer from that problem could just let this functionality
680 typedef int (gdbarch_in_function_epilogue_p_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
681 extern int gdbarch_in_function_epilogue_p (struct gdbarch *gdbarch, CORE_ADDR addr);
682 extern void set_gdbarch_in_function_epilogue_p (struct gdbarch *gdbarch, gdbarch_in_function_epilogue_p_ftype *in_function_epilogue_p);
684 typedef void (gdbarch_elf_make_msymbol_special_ftype) (asymbol *sym, struct minimal_symbol *msym);
685 extern void gdbarch_elf_make_msymbol_special (struct gdbarch *gdbarch, asymbol *sym, struct minimal_symbol *msym);
686 extern void set_gdbarch_elf_make_msymbol_special (struct gdbarch *gdbarch, gdbarch_elf_make_msymbol_special_ftype *elf_make_msymbol_special);
688 typedef void (gdbarch_coff_make_msymbol_special_ftype) (int val, struct minimal_symbol *msym);
689 extern void gdbarch_coff_make_msymbol_special (struct gdbarch *gdbarch, int val, struct minimal_symbol *msym);
690 extern void set_gdbarch_coff_make_msymbol_special (struct gdbarch *gdbarch, gdbarch_coff_make_msymbol_special_ftype *coff_make_msymbol_special);
692 extern int gdbarch_cannot_step_breakpoint (struct gdbarch *gdbarch);
693 extern void set_gdbarch_cannot_step_breakpoint (struct gdbarch *gdbarch, int cannot_step_breakpoint);
695 extern int gdbarch_have_nonsteppable_watchpoint (struct gdbarch *gdbarch);
696 extern void set_gdbarch_have_nonsteppable_watchpoint (struct gdbarch *gdbarch, int have_nonsteppable_watchpoint);
698 extern int gdbarch_address_class_type_flags_p (struct gdbarch *gdbarch);
700 typedef int (gdbarch_address_class_type_flags_ftype) (int byte_size, int dwarf2_addr_class);
701 extern int gdbarch_address_class_type_flags (struct gdbarch *gdbarch, int byte_size, int dwarf2_addr_class);
702 extern void set_gdbarch_address_class_type_flags (struct gdbarch *gdbarch, gdbarch_address_class_type_flags_ftype *address_class_type_flags);
704 extern int gdbarch_address_class_type_flags_to_name_p (struct gdbarch *gdbarch);
706 typedef const char * (gdbarch_address_class_type_flags_to_name_ftype) (struct gdbarch *gdbarch, int type_flags);
707 extern const char * gdbarch_address_class_type_flags_to_name (struct gdbarch *gdbarch, int type_flags);
708 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);
710 /* Return the appropriate type_flags for the supplied address class.
711 This function should return 1 if the address class was recognized and
712 type_flags was set, zero otherwise. */
714 extern int gdbarch_address_class_name_to_type_flags_p (struct gdbarch *gdbarch);
716 typedef int (gdbarch_address_class_name_to_type_flags_ftype) (struct gdbarch *gdbarch, const char *name, int *type_flags_ptr);
717 extern int gdbarch_address_class_name_to_type_flags (struct gdbarch *gdbarch, const char *name, int *type_flags_ptr);
718 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);
720 /* Is a register in a group */
722 typedef int (gdbarch_register_reggroup_p_ftype) (struct gdbarch *gdbarch, int regnum, struct reggroup *reggroup);
723 extern int gdbarch_register_reggroup_p (struct gdbarch *gdbarch, int regnum, struct reggroup *reggroup);
724 extern void set_gdbarch_register_reggroup_p (struct gdbarch *gdbarch, gdbarch_register_reggroup_p_ftype *register_reggroup_p);
726 /* Fetch the pointer to the ith function argument. */
728 extern int gdbarch_fetch_pointer_argument_p (struct gdbarch *gdbarch);
730 typedef CORE_ADDR (gdbarch_fetch_pointer_argument_ftype) (struct frame_info *frame, int argi, struct type *type);
731 extern CORE_ADDR gdbarch_fetch_pointer_argument (struct gdbarch *gdbarch, struct frame_info *frame, int argi, struct type *type);
732 extern void set_gdbarch_fetch_pointer_argument (struct gdbarch *gdbarch, gdbarch_fetch_pointer_argument_ftype *fetch_pointer_argument);
734 /* Return the appropriate register set for a core file section with
735 name SECT_NAME and size SECT_SIZE. */
737 extern int gdbarch_regset_from_core_section_p (struct gdbarch *gdbarch);
739 typedef const struct regset * (gdbarch_regset_from_core_section_ftype) (struct gdbarch *gdbarch, const char *sect_name, size_t sect_size);
740 extern const struct regset * gdbarch_regset_from_core_section (struct gdbarch *gdbarch, const char *sect_name, size_t sect_size);
741 extern void set_gdbarch_regset_from_core_section (struct gdbarch *gdbarch, gdbarch_regset_from_core_section_ftype *regset_from_core_section);
743 /* Supported register notes in a core file. */
745 extern struct core_regset_section * gdbarch_core_regset_sections (struct gdbarch *gdbarch);
746 extern void set_gdbarch_core_regset_sections (struct gdbarch *gdbarch, struct core_regset_section * core_regset_sections);
748 /* Create core file notes */
750 extern int gdbarch_make_corefile_notes_p (struct gdbarch *gdbarch);
752 typedef char * (gdbarch_make_corefile_notes_ftype) (struct gdbarch *gdbarch, bfd *obfd, int *note_size);
753 extern char * gdbarch_make_corefile_notes (struct gdbarch *gdbarch, bfd *obfd, int *note_size);
754 extern void set_gdbarch_make_corefile_notes (struct gdbarch *gdbarch, gdbarch_make_corefile_notes_ftype *make_corefile_notes);
756 /* The elfcore writer hook to use to write Linux prpsinfo notes to core
757 files. Most Linux architectures use the same prpsinfo32 or
758 prpsinfo64 layouts, and so won't need to provide this hook, as we
759 call the Linux generic routines in bfd to write prpsinfo notes by
762 extern int gdbarch_elfcore_write_linux_prpsinfo_p (struct gdbarch *gdbarch);
764 typedef char * (gdbarch_elfcore_write_linux_prpsinfo_ftype) (bfd *obfd, char *note_data, int *note_size, const struct elf_internal_linux_prpsinfo *info);
765 extern char * gdbarch_elfcore_write_linux_prpsinfo (struct gdbarch *gdbarch, bfd *obfd, char *note_data, int *note_size, const struct elf_internal_linux_prpsinfo *info);
766 extern void set_gdbarch_elfcore_write_linux_prpsinfo (struct gdbarch *gdbarch, gdbarch_elfcore_write_linux_prpsinfo_ftype *elfcore_write_linux_prpsinfo);
768 /* Find core file memory regions */
770 extern int gdbarch_find_memory_regions_p (struct gdbarch *gdbarch);
772 typedef int (gdbarch_find_memory_regions_ftype) (struct gdbarch *gdbarch, find_memory_region_ftype func, void *data);
773 extern int gdbarch_find_memory_regions (struct gdbarch *gdbarch, find_memory_region_ftype func, void *data);
774 extern void set_gdbarch_find_memory_regions (struct gdbarch *gdbarch, gdbarch_find_memory_regions_ftype *find_memory_regions);
776 /* Read offset OFFSET of TARGET_OBJECT_LIBRARIES formatted shared libraries list from
777 core file into buffer READBUF with length LEN. Return the number of bytes read
778 (zero indicates failure).
779 failed, otherwise, return the red length of READBUF. */
781 extern int gdbarch_core_xfer_shared_libraries_p (struct gdbarch *gdbarch);
783 typedef ULONGEST (gdbarch_core_xfer_shared_libraries_ftype) (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
784 extern ULONGEST gdbarch_core_xfer_shared_libraries (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
785 extern void set_gdbarch_core_xfer_shared_libraries (struct gdbarch *gdbarch, gdbarch_core_xfer_shared_libraries_ftype *core_xfer_shared_libraries);
787 /* Read offset OFFSET of TARGET_OBJECT_LIBRARIES_AIX formatted shared
788 libraries list from core file into buffer READBUF with length LEN.
789 Return the number of bytes read (zero indicates failure). */
791 extern int gdbarch_core_xfer_shared_libraries_aix_p (struct gdbarch *gdbarch);
793 typedef ULONGEST (gdbarch_core_xfer_shared_libraries_aix_ftype) (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
794 extern ULONGEST gdbarch_core_xfer_shared_libraries_aix (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
795 extern void set_gdbarch_core_xfer_shared_libraries_aix (struct gdbarch *gdbarch, gdbarch_core_xfer_shared_libraries_aix_ftype *core_xfer_shared_libraries_aix);
797 /* How the core target converts a PTID from a core file to a string. */
799 extern int gdbarch_core_pid_to_str_p (struct gdbarch *gdbarch);
801 typedef char * (gdbarch_core_pid_to_str_ftype) (struct gdbarch *gdbarch, ptid_t ptid);
802 extern char * gdbarch_core_pid_to_str (struct gdbarch *gdbarch, ptid_t ptid);
803 extern void set_gdbarch_core_pid_to_str (struct gdbarch *gdbarch, gdbarch_core_pid_to_str_ftype *core_pid_to_str);
805 /* BFD target to use when generating a core file. */
807 extern int gdbarch_gcore_bfd_target_p (struct gdbarch *gdbarch);
809 extern const char * gdbarch_gcore_bfd_target (struct gdbarch *gdbarch);
810 extern void set_gdbarch_gcore_bfd_target (struct gdbarch *gdbarch, const char * gcore_bfd_target);
812 /* If the elements of C++ vtables are in-place function descriptors rather
813 than normal function pointers (which may point to code or a descriptor),
816 extern int gdbarch_vtable_function_descriptors (struct gdbarch *gdbarch);
817 extern void set_gdbarch_vtable_function_descriptors (struct gdbarch *gdbarch, int vtable_function_descriptors);
819 /* Set if the least significant bit of the delta is used instead of the least
820 significant bit of the pfn for pointers to virtual member functions. */
822 extern int gdbarch_vbit_in_delta (struct gdbarch *gdbarch);
823 extern void set_gdbarch_vbit_in_delta (struct gdbarch *gdbarch, int vbit_in_delta);
825 /* Advance PC to next instruction in order to skip a permanent breakpoint. */
827 extern int gdbarch_skip_permanent_breakpoint_p (struct gdbarch *gdbarch);
829 typedef void (gdbarch_skip_permanent_breakpoint_ftype) (struct regcache *regcache);
830 extern void gdbarch_skip_permanent_breakpoint (struct gdbarch *gdbarch, struct regcache *regcache);
831 extern void set_gdbarch_skip_permanent_breakpoint (struct gdbarch *gdbarch, gdbarch_skip_permanent_breakpoint_ftype *skip_permanent_breakpoint);
833 /* The maximum length of an instruction on this architecture in bytes. */
835 extern int gdbarch_max_insn_length_p (struct gdbarch *gdbarch);
837 extern ULONGEST gdbarch_max_insn_length (struct gdbarch *gdbarch);
838 extern void set_gdbarch_max_insn_length (struct gdbarch *gdbarch, ULONGEST max_insn_length);
840 /* Copy the instruction at FROM to TO, and make any adjustments
841 necessary to single-step it at that address.
843 REGS holds the state the thread's registers will have before
844 executing the copied instruction; the PC in REGS will refer to FROM,
845 not the copy at TO. The caller should update it to point at TO later.
847 Return a pointer to data of the architecture's choice to be passed
848 to gdbarch_displaced_step_fixup. Or, return NULL to indicate that
849 the instruction's effects have been completely simulated, with the
850 resulting state written back to REGS.
852 For a general explanation of displaced stepping and how GDB uses it,
853 see the comments in infrun.c.
855 The TO area is only guaranteed to have space for
856 gdbarch_max_insn_length (arch) bytes, so this function must not
857 write more bytes than that to that area.
859 If you do not provide this function, GDB assumes that the
860 architecture does not support displaced stepping.
862 If your architecture doesn't need to adjust instructions before
863 single-stepping them, consider using simple_displaced_step_copy_insn
866 extern int gdbarch_displaced_step_copy_insn_p (struct gdbarch *gdbarch);
868 typedef struct displaced_step_closure * (gdbarch_displaced_step_copy_insn_ftype) (struct gdbarch *gdbarch, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
869 extern struct displaced_step_closure * gdbarch_displaced_step_copy_insn (struct gdbarch *gdbarch, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
870 extern void set_gdbarch_displaced_step_copy_insn (struct gdbarch *gdbarch, gdbarch_displaced_step_copy_insn_ftype *displaced_step_copy_insn);
872 /* Return true if GDB should use hardware single-stepping to execute
873 the displaced instruction identified by CLOSURE. If false,
874 GDB will simply restart execution at the displaced instruction
875 location, and it is up to the target to ensure GDB will receive
876 control again (e.g. by placing a software breakpoint instruction
877 into the displaced instruction buffer).
879 The default implementation returns false on all targets that
880 provide a gdbarch_software_single_step routine, and true otherwise. */
882 typedef int (gdbarch_displaced_step_hw_singlestep_ftype) (struct gdbarch *gdbarch, struct displaced_step_closure *closure);
883 extern int gdbarch_displaced_step_hw_singlestep (struct gdbarch *gdbarch, struct displaced_step_closure *closure);
884 extern void set_gdbarch_displaced_step_hw_singlestep (struct gdbarch *gdbarch, gdbarch_displaced_step_hw_singlestep_ftype *displaced_step_hw_singlestep);
886 /* Fix up the state resulting from successfully single-stepping a
887 displaced instruction, to give the result we would have gotten from
888 stepping the instruction in its original location.
890 REGS is the register state resulting from single-stepping the
891 displaced instruction.
893 CLOSURE is the result from the matching call to
894 gdbarch_displaced_step_copy_insn.
896 If you provide gdbarch_displaced_step_copy_insn.but not this
897 function, then GDB assumes that no fixup is needed after
898 single-stepping the instruction.
900 For a general explanation of displaced stepping and how GDB uses it,
901 see the comments in infrun.c. */
903 extern int gdbarch_displaced_step_fixup_p (struct gdbarch *gdbarch);
905 typedef void (gdbarch_displaced_step_fixup_ftype) (struct gdbarch *gdbarch, struct displaced_step_closure *closure, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
906 extern void gdbarch_displaced_step_fixup (struct gdbarch *gdbarch, struct displaced_step_closure *closure, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
907 extern void set_gdbarch_displaced_step_fixup (struct gdbarch *gdbarch, gdbarch_displaced_step_fixup_ftype *displaced_step_fixup);
909 /* Free a closure returned by gdbarch_displaced_step_copy_insn.
911 If you provide gdbarch_displaced_step_copy_insn, you must provide
912 this function as well.
914 If your architecture uses closures that don't need to be freed, then
915 you can use simple_displaced_step_free_closure here.
917 For a general explanation of displaced stepping and how GDB uses it,
918 see the comments in infrun.c. */
920 typedef void (gdbarch_displaced_step_free_closure_ftype) (struct gdbarch *gdbarch, struct displaced_step_closure *closure);
921 extern void gdbarch_displaced_step_free_closure (struct gdbarch *gdbarch, struct displaced_step_closure *closure);
922 extern void set_gdbarch_displaced_step_free_closure (struct gdbarch *gdbarch, gdbarch_displaced_step_free_closure_ftype *displaced_step_free_closure);
924 /* Return the address of an appropriate place to put displaced
925 instructions while we step over them. There need only be one such
926 place, since we're only stepping one thread over a breakpoint at a
929 For a general explanation of displaced stepping and how GDB uses it,
930 see the comments in infrun.c. */
932 typedef CORE_ADDR (gdbarch_displaced_step_location_ftype) (struct gdbarch *gdbarch);
933 extern CORE_ADDR gdbarch_displaced_step_location (struct gdbarch *gdbarch);
934 extern void set_gdbarch_displaced_step_location (struct gdbarch *gdbarch, gdbarch_displaced_step_location_ftype *displaced_step_location);
936 /* Relocate an instruction to execute at a different address. OLDLOC
937 is the address in the inferior memory where the instruction to
938 relocate is currently at. On input, TO points to the destination
939 where we want the instruction to be copied (and possibly adjusted)
940 to. On output, it points to one past the end of the resulting
941 instruction(s). The effect of executing the instruction at TO shall
942 be the same as if executing it at FROM. For example, call
943 instructions that implicitly push the return address on the stack
944 should be adjusted to return to the instruction after OLDLOC;
945 relative branches, and other PC-relative instructions need the
946 offset adjusted; etc. */
948 extern int gdbarch_relocate_instruction_p (struct gdbarch *gdbarch);
950 typedef void (gdbarch_relocate_instruction_ftype) (struct gdbarch *gdbarch, CORE_ADDR *to, CORE_ADDR from);
951 extern void gdbarch_relocate_instruction (struct gdbarch *gdbarch, CORE_ADDR *to, CORE_ADDR from);
952 extern void set_gdbarch_relocate_instruction (struct gdbarch *gdbarch, gdbarch_relocate_instruction_ftype *relocate_instruction);
954 /* Refresh overlay mapped state for section OSECT. */
956 extern int gdbarch_overlay_update_p (struct gdbarch *gdbarch);
958 typedef void (gdbarch_overlay_update_ftype) (struct obj_section *osect);
959 extern void gdbarch_overlay_update (struct gdbarch *gdbarch, struct obj_section *osect);
960 extern void set_gdbarch_overlay_update (struct gdbarch *gdbarch, gdbarch_overlay_update_ftype *overlay_update);
962 extern int gdbarch_core_read_description_p (struct gdbarch *gdbarch);
964 typedef const struct target_desc * (gdbarch_core_read_description_ftype) (struct gdbarch *gdbarch, struct target_ops *target, bfd *abfd);
965 extern const struct target_desc * gdbarch_core_read_description (struct gdbarch *gdbarch, struct target_ops *target, bfd *abfd);
966 extern void set_gdbarch_core_read_description (struct gdbarch *gdbarch, gdbarch_core_read_description_ftype *core_read_description);
968 /* Handle special encoding of static variables in stabs debug info. */
970 extern int gdbarch_static_transform_name_p (struct gdbarch *gdbarch);
972 typedef const char * (gdbarch_static_transform_name_ftype) (const char *name);
973 extern const char * gdbarch_static_transform_name (struct gdbarch *gdbarch, const char *name);
974 extern void set_gdbarch_static_transform_name (struct gdbarch *gdbarch, gdbarch_static_transform_name_ftype *static_transform_name);
976 /* Set if the address in N_SO or N_FUN stabs may be zero. */
978 extern int gdbarch_sofun_address_maybe_missing (struct gdbarch *gdbarch);
979 extern void set_gdbarch_sofun_address_maybe_missing (struct gdbarch *gdbarch, int sofun_address_maybe_missing);
981 /* Parse the instruction at ADDR storing in the record execution log
982 the registers REGCACHE and memory ranges that will be affected when
983 the instruction executes, along with their current values.
984 Return -1 if something goes wrong, 0 otherwise. */
986 extern int gdbarch_process_record_p (struct gdbarch *gdbarch);
988 typedef int (gdbarch_process_record_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr);
989 extern int gdbarch_process_record (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr);
990 extern void set_gdbarch_process_record (struct gdbarch *gdbarch, gdbarch_process_record_ftype *process_record);
992 /* Save process state after a signal.
993 Return -1 if something goes wrong, 0 otherwise. */
995 extern int gdbarch_process_record_signal_p (struct gdbarch *gdbarch);
997 typedef int (gdbarch_process_record_signal_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, enum gdb_signal signal);
998 extern int gdbarch_process_record_signal (struct gdbarch *gdbarch, struct regcache *regcache, enum gdb_signal signal);
999 extern void set_gdbarch_process_record_signal (struct gdbarch *gdbarch, gdbarch_process_record_signal_ftype *process_record_signal);
1001 /* Signal translation: translate inferior's signal (target's) number
1002 into GDB's representation. The implementation of this method must
1003 be host independent. IOW, don't rely on symbols of the NAT_FILE
1004 header (the nm-*.h files), the host <signal.h> header, or similar
1005 headers. This is mainly used when cross-debugging core files ---
1006 "Live" targets hide the translation behind the target interface
1007 (target_wait, target_resume, etc.). */
1009 extern int gdbarch_gdb_signal_from_target_p (struct gdbarch *gdbarch);
1011 typedef enum gdb_signal (gdbarch_gdb_signal_from_target_ftype) (struct gdbarch *gdbarch, int signo);
1012 extern enum gdb_signal gdbarch_gdb_signal_from_target (struct gdbarch *gdbarch, int signo);
1013 extern void set_gdbarch_gdb_signal_from_target (struct gdbarch *gdbarch, gdbarch_gdb_signal_from_target_ftype *gdb_signal_from_target);
1015 /* Signal translation: translate the GDB's internal signal number into
1016 the inferior's signal (target's) representation. The implementation
1017 of this method must be host independent. IOW, don't rely on symbols
1018 of the NAT_FILE header (the nm-*.h files), the host <signal.h>
1019 header, or similar headers.
1020 Return the target signal number if found, or -1 if the GDB internal
1021 signal number is invalid. */
1023 extern int gdbarch_gdb_signal_to_target_p (struct gdbarch *gdbarch);
1025 typedef int (gdbarch_gdb_signal_to_target_ftype) (struct gdbarch *gdbarch, enum gdb_signal signal);
1026 extern int gdbarch_gdb_signal_to_target (struct gdbarch *gdbarch, enum gdb_signal signal);
1027 extern void set_gdbarch_gdb_signal_to_target (struct gdbarch *gdbarch, gdbarch_gdb_signal_to_target_ftype *gdb_signal_to_target);
1029 /* Extra signal info inspection.
1031 Return a type suitable to inspect extra signal information. */
1033 extern int gdbarch_get_siginfo_type_p (struct gdbarch *gdbarch);
1035 typedef struct type * (gdbarch_get_siginfo_type_ftype) (struct gdbarch *gdbarch);
1036 extern struct type * gdbarch_get_siginfo_type (struct gdbarch *gdbarch);
1037 extern void set_gdbarch_get_siginfo_type (struct gdbarch *gdbarch, gdbarch_get_siginfo_type_ftype *get_siginfo_type);
1039 /* Record architecture-specific information from the symbol table. */
1041 extern int gdbarch_record_special_symbol_p (struct gdbarch *gdbarch);
1043 typedef void (gdbarch_record_special_symbol_ftype) (struct gdbarch *gdbarch, struct objfile *objfile, asymbol *sym);
1044 extern void gdbarch_record_special_symbol (struct gdbarch *gdbarch, struct objfile *objfile, asymbol *sym);
1045 extern void set_gdbarch_record_special_symbol (struct gdbarch *gdbarch, gdbarch_record_special_symbol_ftype *record_special_symbol);
1047 /* Function for the 'catch syscall' feature.
1048 Get architecture-specific system calls information from registers. */
1050 extern int gdbarch_get_syscall_number_p (struct gdbarch *gdbarch);
1052 typedef LONGEST (gdbarch_get_syscall_number_ftype) (struct gdbarch *gdbarch, ptid_t ptid);
1053 extern LONGEST gdbarch_get_syscall_number (struct gdbarch *gdbarch, ptid_t ptid);
1054 extern void set_gdbarch_get_syscall_number (struct gdbarch *gdbarch, gdbarch_get_syscall_number_ftype *get_syscall_number);
1056 /* SystemTap related fields and functions.
1057 A NULL-terminated array of prefixes used to mark an integer constant
1058 on the architecture's assembly.
1059 For example, on x86 integer constants are written as:
1061 $10 ;; integer constant 10
1063 in this case, this prefix would be the character `$'. */
1065 extern const char *const * gdbarch_stap_integer_prefixes (struct gdbarch *gdbarch);
1066 extern void set_gdbarch_stap_integer_prefixes (struct gdbarch *gdbarch, const char *const * stap_integer_prefixes);
1068 /* A NULL-terminated array of suffixes used to mark an integer constant
1069 on the architecture's assembly. */
1071 extern const char *const * gdbarch_stap_integer_suffixes (struct gdbarch *gdbarch);
1072 extern void set_gdbarch_stap_integer_suffixes (struct gdbarch *gdbarch, const char *const * stap_integer_suffixes);
1074 /* A NULL-terminated array of prefixes used to mark a register name on
1075 the architecture's assembly.
1076 For example, on x86 the register name is written as:
1078 %eax ;; register eax
1080 in this case, this prefix would be the character `%'. */
1082 extern const char *const * gdbarch_stap_register_prefixes (struct gdbarch *gdbarch);
1083 extern void set_gdbarch_stap_register_prefixes (struct gdbarch *gdbarch, const char *const * stap_register_prefixes);
1085 /* A NULL-terminated array of suffixes used to mark a register name on
1086 the architecture's assembly. */
1088 extern const char *const * gdbarch_stap_register_suffixes (struct gdbarch *gdbarch);
1089 extern void set_gdbarch_stap_register_suffixes (struct gdbarch *gdbarch, const char *const * stap_register_suffixes);
1091 /* A NULL-terminated array of prefixes used to mark a register
1092 indirection on the architecture's assembly.
1093 For example, on x86 the register indirection is written as:
1095 (%eax) ;; indirecting eax
1097 in this case, this prefix would be the charater `('.
1099 Please note that we use the indirection prefix also for register
1100 displacement, e.g., `4(%eax)' on x86. */
1102 extern const char *const * gdbarch_stap_register_indirection_prefixes (struct gdbarch *gdbarch);
1103 extern void set_gdbarch_stap_register_indirection_prefixes (struct gdbarch *gdbarch, const char *const * stap_register_indirection_prefixes);
1105 /* A NULL-terminated array of suffixes used to mark a register
1106 indirection on the architecture's assembly.
1107 For example, on x86 the register indirection is written as:
1109 (%eax) ;; indirecting eax
1111 in this case, this prefix would be the charater `)'.
1113 Please note that we use the indirection suffix also for register
1114 displacement, e.g., `4(%eax)' on x86. */
1116 extern const char *const * gdbarch_stap_register_indirection_suffixes (struct gdbarch *gdbarch);
1117 extern void set_gdbarch_stap_register_indirection_suffixes (struct gdbarch *gdbarch, const char *const * stap_register_indirection_suffixes);
1119 /* Prefix(es) used to name a register using GDB's nomenclature.
1121 For example, on PPC a register is represented by a number in the assembly
1122 language (e.g., `10' is the 10th general-purpose register). However,
1123 inside GDB this same register has an `r' appended to its name, so the 10th
1124 register would be represented as `r10' internally. */
1126 extern const char * gdbarch_stap_gdb_register_prefix (struct gdbarch *gdbarch);
1127 extern void set_gdbarch_stap_gdb_register_prefix (struct gdbarch *gdbarch, const char * stap_gdb_register_prefix);
1129 /* Suffix used to name a register using GDB's nomenclature. */
1131 extern const char * gdbarch_stap_gdb_register_suffix (struct gdbarch *gdbarch);
1132 extern void set_gdbarch_stap_gdb_register_suffix (struct gdbarch *gdbarch, const char * stap_gdb_register_suffix);
1134 /* Check if S is a single operand.
1136 Single operands can be:
1137 - Literal integers, e.g. `$10' on x86
1138 - Register access, e.g. `%eax' on x86
1139 - Register indirection, e.g. `(%eax)' on x86
1140 - Register displacement, e.g. `4(%eax)' on x86
1142 This function should check for these patterns on the string
1143 and return 1 if some were found, or zero otherwise. Please try to match
1144 as much info as you can from the string, i.e., if you have to match
1145 something like `(%', do not match just the `('. */
1147 extern int gdbarch_stap_is_single_operand_p (struct gdbarch *gdbarch);
1149 typedef int (gdbarch_stap_is_single_operand_ftype) (struct gdbarch *gdbarch, const char *s);
1150 extern int gdbarch_stap_is_single_operand (struct gdbarch *gdbarch, const char *s);
1151 extern void set_gdbarch_stap_is_single_operand (struct gdbarch *gdbarch, gdbarch_stap_is_single_operand_ftype *stap_is_single_operand);
1153 /* Function used to handle a "special case" in the parser.
1155 A "special case" is considered to be an unknown token, i.e., a token
1156 that the parser does not know how to parse. A good example of special
1157 case would be ARM's register displacement syntax:
1159 [R0, #4] ;; displacing R0 by 4
1161 Since the parser assumes that a register displacement is of the form:
1163 <number> <indirection_prefix> <register_name> <indirection_suffix>
1165 it means that it will not be able to recognize and parse this odd syntax.
1166 Therefore, we should add a special case function that will handle this token.
1168 This function should generate the proper expression form of the expression
1169 using GDB's internal expression mechanism (e.g., `write_exp_elt_opcode'
1170 and so on). It should also return 1 if the parsing was successful, or zero
1171 if the token was not recognized as a special token (in this case, returning
1172 zero means that the special parser is deferring the parsing to the generic
1173 parser), and should advance the buffer pointer (p->arg). */
1175 extern int gdbarch_stap_parse_special_token_p (struct gdbarch *gdbarch);
1177 typedef int (gdbarch_stap_parse_special_token_ftype) (struct gdbarch *gdbarch, struct stap_parse_info *p);
1178 extern int gdbarch_stap_parse_special_token (struct gdbarch *gdbarch, struct stap_parse_info *p);
1179 extern void set_gdbarch_stap_parse_special_token (struct gdbarch *gdbarch, gdbarch_stap_parse_special_token_ftype *stap_parse_special_token);
1181 /* True if the list of shared libraries is one and only for all
1182 processes, as opposed to a list of shared libraries per inferior.
1183 This usually means that all processes, although may or may not share
1184 an address space, will see the same set of symbols at the same
1187 extern int gdbarch_has_global_solist (struct gdbarch *gdbarch);
1188 extern void set_gdbarch_has_global_solist (struct gdbarch *gdbarch, int has_global_solist);
1190 /* On some targets, even though each inferior has its own private
1191 address space, the debug interface takes care of making breakpoints
1192 visible to all address spaces automatically. For such cases,
1193 this property should be set to true. */
1195 extern int gdbarch_has_global_breakpoints (struct gdbarch *gdbarch);
1196 extern void set_gdbarch_has_global_breakpoints (struct gdbarch *gdbarch, int has_global_breakpoints);
1198 /* True if inferiors share an address space (e.g., uClinux). */
1200 typedef int (gdbarch_has_shared_address_space_ftype) (struct gdbarch *gdbarch);
1201 extern int gdbarch_has_shared_address_space (struct gdbarch *gdbarch);
1202 extern void set_gdbarch_has_shared_address_space (struct gdbarch *gdbarch, gdbarch_has_shared_address_space_ftype *has_shared_address_space);
1204 /* True if a fast tracepoint can be set at an address. */
1206 typedef int (gdbarch_fast_tracepoint_valid_at_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr, int *isize, char **msg);
1207 extern int gdbarch_fast_tracepoint_valid_at (struct gdbarch *gdbarch, CORE_ADDR addr, int *isize, char **msg);
1208 extern void set_gdbarch_fast_tracepoint_valid_at (struct gdbarch *gdbarch, gdbarch_fast_tracepoint_valid_at_ftype *fast_tracepoint_valid_at);
1210 /* Return the "auto" target charset. */
1212 typedef const char * (gdbarch_auto_charset_ftype) (void);
1213 extern const char * gdbarch_auto_charset (struct gdbarch *gdbarch);
1214 extern void set_gdbarch_auto_charset (struct gdbarch *gdbarch, gdbarch_auto_charset_ftype *auto_charset);
1216 /* Return the "auto" target wide charset. */
1218 typedef const char * (gdbarch_auto_wide_charset_ftype) (void);
1219 extern const char * gdbarch_auto_wide_charset (struct gdbarch *gdbarch);
1220 extern void set_gdbarch_auto_wide_charset (struct gdbarch *gdbarch, gdbarch_auto_wide_charset_ftype *auto_wide_charset);
1222 /* If non-empty, this is a file extension that will be opened in place
1223 of the file extension reported by the shared library list.
1225 This is most useful for toolchains that use a post-linker tool,
1226 where the names of the files run on the target differ in extension
1227 compared to the names of the files GDB should load for debug info. */
1229 extern const char * gdbarch_solib_symbols_extension (struct gdbarch *gdbarch);
1230 extern void set_gdbarch_solib_symbols_extension (struct gdbarch *gdbarch, const char * solib_symbols_extension);
1232 /* If true, the target OS has DOS-based file system semantics. That
1233 is, absolute paths include a drive name, and the backslash is
1234 considered a directory separator. */
1236 extern int gdbarch_has_dos_based_file_system (struct gdbarch *gdbarch);
1237 extern void set_gdbarch_has_dos_based_file_system (struct gdbarch *gdbarch, int has_dos_based_file_system);
1239 /* Generate bytecodes to collect the return address in a frame.
1240 Since the bytecodes run on the target, possibly with GDB not even
1241 connected, the full unwinding machinery is not available, and
1242 typically this function will issue bytecodes for one or more likely
1243 places that the return address may be found. */
1245 typedef void (gdbarch_gen_return_address_ftype) (struct gdbarch *gdbarch, struct agent_expr *ax, struct axs_value *value, CORE_ADDR scope);
1246 extern void gdbarch_gen_return_address (struct gdbarch *gdbarch, struct agent_expr *ax, struct axs_value *value, CORE_ADDR scope);
1247 extern void set_gdbarch_gen_return_address (struct gdbarch *gdbarch, gdbarch_gen_return_address_ftype *gen_return_address);
1249 /* Implement the "info proc" command. */
1251 extern int gdbarch_info_proc_p (struct gdbarch *gdbarch);
1253 typedef void (gdbarch_info_proc_ftype) (struct gdbarch *gdbarch, const char *args, enum info_proc_what what);
1254 extern void gdbarch_info_proc (struct gdbarch *gdbarch, const char *args, enum info_proc_what what);
1255 extern void set_gdbarch_info_proc (struct gdbarch *gdbarch, gdbarch_info_proc_ftype *info_proc);
1257 /* Implement the "info proc" command for core files. Noe that there
1258 are two "info_proc"-like methods on gdbarch -- one for core files,
1259 one for live targets. */
1261 extern int gdbarch_core_info_proc_p (struct gdbarch *gdbarch);
1263 typedef void (gdbarch_core_info_proc_ftype) (struct gdbarch *gdbarch, const char *args, enum info_proc_what what);
1264 extern void gdbarch_core_info_proc (struct gdbarch *gdbarch, const char *args, enum info_proc_what what);
1265 extern void set_gdbarch_core_info_proc (struct gdbarch *gdbarch, gdbarch_core_info_proc_ftype *core_info_proc);
1267 /* Iterate over all objfiles in the order that makes the most sense
1268 for the architecture to make global symbol searches.
1270 CB is a callback function where OBJFILE is the objfile to be searched,
1271 and CB_DATA a pointer to user-defined data (the same data that is passed
1272 when calling this gdbarch method). The iteration stops if this function
1275 CB_DATA is a pointer to some user-defined data to be passed to
1278 If not NULL, CURRENT_OBJFILE corresponds to the objfile being
1279 inspected when the symbol search was requested. */
1281 typedef void (gdbarch_iterate_over_objfiles_in_search_order_ftype) (struct gdbarch *gdbarch, iterate_over_objfiles_in_search_order_cb_ftype *cb, void *cb_data, struct objfile *current_objfile);
1282 extern void gdbarch_iterate_over_objfiles_in_search_order (struct gdbarch *gdbarch, iterate_over_objfiles_in_search_order_cb_ftype *cb, void *cb_data, struct objfile *current_objfile);
1283 extern void set_gdbarch_iterate_over_objfiles_in_search_order (struct gdbarch *gdbarch, gdbarch_iterate_over_objfiles_in_search_order_ftype *iterate_over_objfiles_in_search_order);
1285 /* Ravenscar arch-dependent ops. */
1287 extern struct ravenscar_arch_ops * gdbarch_ravenscar_ops (struct gdbarch *gdbarch);
1288 extern void set_gdbarch_ravenscar_ops (struct gdbarch *gdbarch, struct ravenscar_arch_ops * ravenscar_ops);
1290 /* Return non-zero if the instruction at ADDR is a call; zero otherwise. */
1292 typedef int (gdbarch_insn_is_call_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
1293 extern int gdbarch_insn_is_call (struct gdbarch *gdbarch, CORE_ADDR addr);
1294 extern void set_gdbarch_insn_is_call (struct gdbarch *gdbarch, gdbarch_insn_is_call_ftype *insn_is_call);
1296 /* Return non-zero if the instruction at ADDR is a return; zero otherwise. */
1298 typedef int (gdbarch_insn_is_ret_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
1299 extern int gdbarch_insn_is_ret (struct gdbarch *gdbarch, CORE_ADDR addr);
1300 extern void set_gdbarch_insn_is_ret (struct gdbarch *gdbarch, gdbarch_insn_is_ret_ftype *insn_is_ret);
1302 /* Return non-zero if the instruction at ADDR is a jump; zero otherwise. */
1304 typedef int (gdbarch_insn_is_jump_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
1305 extern int gdbarch_insn_is_jump (struct gdbarch *gdbarch, CORE_ADDR addr);
1306 extern void set_gdbarch_insn_is_jump (struct gdbarch *gdbarch, gdbarch_insn_is_jump_ftype *insn_is_jump);
1308 /* Read one auxv entry from *READPTR, not reading locations >= ENDPTR.
1309 Return 0 if *READPTR is already at the end of the buffer.
1310 Return -1 if there is insufficient buffer for a whole entry.
1311 Return 1 if an entry was read into *TYPEP and *VALP. */
1313 extern int gdbarch_auxv_parse_p (struct gdbarch *gdbarch);
1315 typedef int (gdbarch_auxv_parse_ftype) (struct gdbarch *gdbarch, gdb_byte **readptr, gdb_byte *endptr, CORE_ADDR *typep, CORE_ADDR *valp);
1316 extern int gdbarch_auxv_parse (struct gdbarch *gdbarch, gdb_byte **readptr, gdb_byte *endptr, CORE_ADDR *typep, CORE_ADDR *valp);
1317 extern void set_gdbarch_auxv_parse (struct gdbarch *gdbarch, gdbarch_auxv_parse_ftype *auxv_parse);
1319 /* Definition for an unknown syscall, used basically in error-cases. */
1320 #define UNKNOWN_SYSCALL (-1)
1322 extern struct gdbarch_tdep *gdbarch_tdep (struct gdbarch *gdbarch);
1325 /* Mechanism for co-ordinating the selection of a specific
1328 GDB targets (*-tdep.c) can register an interest in a specific
1329 architecture. Other GDB components can register a need to maintain
1330 per-architecture data.
1332 The mechanisms below ensures that there is only a loose connection
1333 between the set-architecture command and the various GDB
1334 components. Each component can independently register their need
1335 to maintain architecture specific data with gdbarch.
1339 Previously, a single TARGET_ARCHITECTURE_HOOK was provided. It
1342 The more traditional mega-struct containing architecture specific
1343 data for all the various GDB components was also considered. Since
1344 GDB is built from a variable number of (fairly independent)
1345 components it was determined that the global aproach was not
1349 /* Register a new architectural family with GDB.
1351 Register support for the specified ARCHITECTURE with GDB. When
1352 gdbarch determines that the specified architecture has been
1353 selected, the corresponding INIT function is called.
1357 The INIT function takes two parameters: INFO which contains the
1358 information available to gdbarch about the (possibly new)
1359 architecture; ARCHES which is a list of the previously created
1360 ``struct gdbarch'' for this architecture.
1362 The INFO parameter is, as far as possible, be pre-initialized with
1363 information obtained from INFO.ABFD or the global defaults.
1365 The ARCHES parameter is a linked list (sorted most recently used)
1366 of all the previously created architures for this architecture
1367 family. The (possibly NULL) ARCHES->gdbarch can used to access
1368 values from the previously selected architecture for this
1369 architecture family.
1371 The INIT function shall return any of: NULL - indicating that it
1372 doesn't recognize the selected architecture; an existing ``struct
1373 gdbarch'' from the ARCHES list - indicating that the new
1374 architecture is just a synonym for an earlier architecture (see
1375 gdbarch_list_lookup_by_info()); a newly created ``struct gdbarch''
1376 - that describes the selected architecture (see gdbarch_alloc()).
1378 The DUMP_TDEP function shall print out all target specific values.
1379 Care should be taken to ensure that the function works in both the
1380 multi-arch and non- multi-arch cases. */
1384 struct gdbarch *gdbarch;
1385 struct gdbarch_list *next;
1390 /* Use default: NULL (ZERO). */
1391 const struct bfd_arch_info *bfd_arch_info;
1393 /* Use default: BFD_ENDIAN_UNKNOWN (NB: is not ZERO). */
1394 enum bfd_endian byte_order;
1396 enum bfd_endian byte_order_for_code;
1398 /* Use default: NULL (ZERO). */
1401 /* Use default: NULL (ZERO). */
1402 struct gdbarch_tdep_info *tdep_info;
1404 /* Use default: GDB_OSABI_UNINITIALIZED (-1). */
1405 enum gdb_osabi osabi;
1407 /* Use default: NULL (ZERO). */
1408 const struct target_desc *target_desc;
1411 typedef struct gdbarch *(gdbarch_init_ftype) (struct gdbarch_info info, struct gdbarch_list *arches);
1412 typedef void (gdbarch_dump_tdep_ftype) (struct gdbarch *gdbarch, struct ui_file *file);
1414 /* DEPRECATED - use gdbarch_register() */
1415 extern void register_gdbarch_init (enum bfd_architecture architecture, gdbarch_init_ftype *);
1417 extern void gdbarch_register (enum bfd_architecture architecture,
1418 gdbarch_init_ftype *,
1419 gdbarch_dump_tdep_ftype *);
1422 /* Return a freshly allocated, NULL terminated, array of the valid
1423 architecture names. Since architectures are registered during the
1424 _initialize phase this function only returns useful information
1425 once initialization has been completed. */
1427 extern const char **gdbarch_printable_names (void);
1430 /* Helper function. Search the list of ARCHES for a GDBARCH that
1431 matches the information provided by INFO. */
1433 extern struct gdbarch_list *gdbarch_list_lookup_by_info (struct gdbarch_list *arches, const struct gdbarch_info *info);
1436 /* Helper function. Create a preliminary ``struct gdbarch''. Perform
1437 basic initialization using values obtained from the INFO and TDEP
1438 parameters. set_gdbarch_*() functions are called to complete the
1439 initialization of the object. */
1441 extern struct gdbarch *gdbarch_alloc (const struct gdbarch_info *info, struct gdbarch_tdep *tdep);
1444 /* Helper function. Free a partially-constructed ``struct gdbarch''.
1445 It is assumed that the caller freeds the ``struct
1448 extern void gdbarch_free (struct gdbarch *);
1451 /* Helper function. Allocate memory from the ``struct gdbarch''
1452 obstack. The memory is freed when the corresponding architecture
1455 extern void *gdbarch_obstack_zalloc (struct gdbarch *gdbarch, long size);
1456 #define GDBARCH_OBSTACK_CALLOC(GDBARCH, NR, TYPE) ((TYPE *) gdbarch_obstack_zalloc ((GDBARCH), (NR) * sizeof (TYPE)))
1457 #define GDBARCH_OBSTACK_ZALLOC(GDBARCH, TYPE) ((TYPE *) gdbarch_obstack_zalloc ((GDBARCH), sizeof (TYPE)))
1460 /* Helper function. Force an update of the current architecture.
1462 The actual architecture selected is determined by INFO, ``(gdb) set
1463 architecture'' et.al., the existing architecture and BFD's default
1464 architecture. INFO should be initialized to zero and then selected
1465 fields should be updated.
1467 Returns non-zero if the update succeeds. */
1469 extern int gdbarch_update_p (struct gdbarch_info info);
1472 /* Helper function. Find an architecture matching info.
1474 INFO should be initialized using gdbarch_info_init, relevant fields
1475 set, and then finished using gdbarch_info_fill.
1477 Returns the corresponding architecture, or NULL if no matching
1478 architecture was found. */
1480 extern struct gdbarch *gdbarch_find_by_info (struct gdbarch_info info);
1483 /* Helper function. Set the target gdbarch to "gdbarch". */
1485 extern void set_target_gdbarch (struct gdbarch *gdbarch);
1488 /* Register per-architecture data-pointer.
1490 Reserve space for a per-architecture data-pointer. An identifier
1491 for the reserved data-pointer is returned. That identifer should
1492 be saved in a local static variable.
1494 Memory for the per-architecture data shall be allocated using
1495 gdbarch_obstack_zalloc. That memory will be deleted when the
1496 corresponding architecture object is deleted.
1498 When a previously created architecture is re-selected, the
1499 per-architecture data-pointer for that previous architecture is
1500 restored. INIT() is not re-called.
1502 Multiple registrarants for any architecture are allowed (and
1503 strongly encouraged). */
1505 struct gdbarch_data;
1507 typedef void *(gdbarch_data_pre_init_ftype) (struct obstack *obstack);
1508 extern struct gdbarch_data *gdbarch_data_register_pre_init (gdbarch_data_pre_init_ftype *init);
1509 typedef void *(gdbarch_data_post_init_ftype) (struct gdbarch *gdbarch);
1510 extern struct gdbarch_data *gdbarch_data_register_post_init (gdbarch_data_post_init_ftype *init);
1511 extern void deprecated_set_gdbarch_data (struct gdbarch *gdbarch,
1512 struct gdbarch_data *data,
1515 extern void *gdbarch_data (struct gdbarch *gdbarch, struct gdbarch_data *);
1518 /* Set the dynamic target-system-dependent parameters (architecture,
1519 byte-order, ...) using information found in the BFD. */
1521 extern void set_gdbarch_from_file (bfd *);
1524 /* Initialize the current architecture to the "first" one we find on
1527 extern void initialize_current_architecture (void);
1529 /* gdbarch trace variable */
1530 extern unsigned int gdbarch_debug;
1532 extern void gdbarch_dump (struct gdbarch *gdbarch, struct ui_file *file);