1 /* *INDENT-OFF* */ /* THIS FILE IS GENERATED -*- buffer-read-only: t -*- */
4 /* Dynamic architecture support for GDB, the GNU debugger.
6 Copyright (C) 1998-2018 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
47 struct minimal_symbol;
51 struct disassemble_info;
54 struct bp_target_info;
57 struct displaced_step_closure;
61 struct stap_parse_info;
63 struct ravenscar_arch_ops;
71 /* The architecture associated with the inferior through the
72 connection to the target.
74 The architecture vector provides some information that is really a
75 property of the inferior, accessed through a particular target:
76 ptrace operations; the layout of certain RSP packets; the solib_ops
77 vector; etc. To differentiate architecture accesses to
78 per-inferior/target properties from
79 per-thread/per-frame/per-objfile properties, accesses to
80 per-inferior/target properties should be made through this
83 /* This is a convenience wrapper for 'current_inferior ()->gdbarch'. */
84 extern struct gdbarch *target_gdbarch (void);
86 /* Callback type for the 'iterate_over_objfiles_in_search_order'
89 typedef int (iterate_over_objfiles_in_search_order_cb_ftype)
90 (struct objfile *objfile, void *cb_data);
92 /* Callback type for regset section iterators. The callback usually
93 invokes the REGSET's supply or collect method, to which it must
94 pass a buffer with at least the given SIZE. SECT_NAME is a BFD
95 section name, and HUMAN_NAME is used for diagnostic messages.
96 CB_DATA should have been passed unchanged through the iterator. */
98 typedef void (iterate_over_regset_sections_cb)
99 (const char *sect_name, int size, const struct regset *regset,
100 const char *human_name, void *cb_data);
103 /* The following are pre-initialized by GDBARCH. */
105 extern const struct bfd_arch_info * gdbarch_bfd_arch_info (struct gdbarch *gdbarch);
106 /* set_gdbarch_bfd_arch_info() - not applicable - pre-initialized. */
108 extern enum bfd_endian gdbarch_byte_order (struct gdbarch *gdbarch);
109 /* set_gdbarch_byte_order() - not applicable - pre-initialized. */
111 extern enum bfd_endian gdbarch_byte_order_for_code (struct gdbarch *gdbarch);
112 /* set_gdbarch_byte_order_for_code() - not applicable - pre-initialized. */
114 extern enum gdb_osabi gdbarch_osabi (struct gdbarch *gdbarch);
115 /* set_gdbarch_osabi() - not applicable - pre-initialized. */
117 extern const struct target_desc * gdbarch_target_desc (struct gdbarch *gdbarch);
118 /* set_gdbarch_target_desc() - not applicable - pre-initialized. */
121 /* The following are initialized by the target dependent code. */
123 /* The bit byte-order has to do just with numbering of bits in debugging symbols
124 and such. Conceptually, it's quite separate from byte/word byte order. */
126 extern int gdbarch_bits_big_endian (struct gdbarch *gdbarch);
127 extern void set_gdbarch_bits_big_endian (struct gdbarch *gdbarch, int bits_big_endian);
129 /* Number of bits in a short or unsigned short for the target machine. */
131 extern int gdbarch_short_bit (struct gdbarch *gdbarch);
132 extern void set_gdbarch_short_bit (struct gdbarch *gdbarch, int short_bit);
134 /* Number of bits in an int or unsigned int for the target machine. */
136 extern int gdbarch_int_bit (struct gdbarch *gdbarch);
137 extern void set_gdbarch_int_bit (struct gdbarch *gdbarch, int int_bit);
139 /* Number of bits in a long or unsigned long for the target machine. */
141 extern int gdbarch_long_bit (struct gdbarch *gdbarch);
142 extern void set_gdbarch_long_bit (struct gdbarch *gdbarch, int long_bit);
144 /* Number of bits in a long long or unsigned long long for the target
147 extern int gdbarch_long_long_bit (struct gdbarch *gdbarch);
148 extern void set_gdbarch_long_long_bit (struct gdbarch *gdbarch, int long_long_bit);
150 /* Alignment of a long long or unsigned long long for the target
153 extern int gdbarch_long_long_align_bit (struct gdbarch *gdbarch);
154 extern void set_gdbarch_long_long_align_bit (struct gdbarch *gdbarch, int long_long_align_bit);
156 /* The ABI default bit-size and format for "half", "float", "double", and
157 "long double". These bit/format pairs should eventually be combined
158 into a single object. For the moment, just initialize them as a pair.
159 Each format describes both the big and little endian layouts (if
162 extern int gdbarch_half_bit (struct gdbarch *gdbarch);
163 extern void set_gdbarch_half_bit (struct gdbarch *gdbarch, int half_bit);
165 extern const struct floatformat ** gdbarch_half_format (struct gdbarch *gdbarch);
166 extern void set_gdbarch_half_format (struct gdbarch *gdbarch, const struct floatformat ** half_format);
168 extern int gdbarch_float_bit (struct gdbarch *gdbarch);
169 extern void set_gdbarch_float_bit (struct gdbarch *gdbarch, int float_bit);
171 extern const struct floatformat ** gdbarch_float_format (struct gdbarch *gdbarch);
172 extern void set_gdbarch_float_format (struct gdbarch *gdbarch, const struct floatformat ** float_format);
174 extern int gdbarch_double_bit (struct gdbarch *gdbarch);
175 extern void set_gdbarch_double_bit (struct gdbarch *gdbarch, int double_bit);
177 extern const struct floatformat ** gdbarch_double_format (struct gdbarch *gdbarch);
178 extern void set_gdbarch_double_format (struct gdbarch *gdbarch, const struct floatformat ** double_format);
180 extern int gdbarch_long_double_bit (struct gdbarch *gdbarch);
181 extern void set_gdbarch_long_double_bit (struct gdbarch *gdbarch, int long_double_bit);
183 extern const struct floatformat ** gdbarch_long_double_format (struct gdbarch *gdbarch);
184 extern void set_gdbarch_long_double_format (struct gdbarch *gdbarch, const struct floatformat ** long_double_format);
186 /* The ABI default bit-size for "wchar_t". wchar_t is a built-in type
187 starting with C++11. */
189 extern int gdbarch_wchar_bit (struct gdbarch *gdbarch);
190 extern void set_gdbarch_wchar_bit (struct gdbarch *gdbarch, int wchar_bit);
192 /* One if `wchar_t' is signed, zero if unsigned. */
194 extern int gdbarch_wchar_signed (struct gdbarch *gdbarch);
195 extern void set_gdbarch_wchar_signed (struct gdbarch *gdbarch, int wchar_signed);
197 /* Returns the floating-point format to be used for values of length LENGTH.
198 NAME, if non-NULL, is the type name, which may be used to distinguish
199 different target formats of the same length. */
201 typedef const struct floatformat ** (gdbarch_floatformat_for_type_ftype) (struct gdbarch *gdbarch, const char *name, int length);
202 extern const struct floatformat ** gdbarch_floatformat_for_type (struct gdbarch *gdbarch, const char *name, int length);
203 extern void set_gdbarch_floatformat_for_type (struct gdbarch *gdbarch, gdbarch_floatformat_for_type_ftype *floatformat_for_type);
205 /* For most targets, a pointer on the target and its representation as an
206 address in GDB have the same size and "look the same". For such a
207 target, you need only set gdbarch_ptr_bit and gdbarch_addr_bit
208 / addr_bit will be set from it.
210 If gdbarch_ptr_bit and gdbarch_addr_bit are different, you'll probably
211 also need to set gdbarch_dwarf2_addr_size, gdbarch_pointer_to_address and
212 gdbarch_address_to_pointer as well.
214 ptr_bit is the size of a pointer on the target */
216 extern int gdbarch_ptr_bit (struct gdbarch *gdbarch);
217 extern void set_gdbarch_ptr_bit (struct gdbarch *gdbarch, int ptr_bit);
219 /* addr_bit is the size of a target address as represented in gdb */
221 extern int gdbarch_addr_bit (struct gdbarch *gdbarch);
222 extern void set_gdbarch_addr_bit (struct gdbarch *gdbarch, int addr_bit);
224 /* dwarf2_addr_size is the target address size as used in the Dwarf debug
225 info. For .debug_frame FDEs, this is supposed to be the target address
226 size from the associated CU header, and which is equivalent to the
227 DWARF2_ADDR_SIZE as defined by the target specific GCC back-end.
228 Unfortunately there is no good way to determine this value. Therefore
229 dwarf2_addr_size simply defaults to the target pointer size.
231 dwarf2_addr_size is not used for .eh_frame FDEs, which are generally
232 defined using the target's pointer size so far.
234 Note that dwarf2_addr_size only needs to be redefined by a target if the
235 GCC back-end defines a DWARF2_ADDR_SIZE other than the target pointer size,
236 and if Dwarf versions < 4 need to be supported. */
238 extern int gdbarch_dwarf2_addr_size (struct gdbarch *gdbarch);
239 extern void set_gdbarch_dwarf2_addr_size (struct gdbarch *gdbarch, int dwarf2_addr_size);
241 /* One if `char' acts like `signed char', zero if `unsigned char'. */
243 extern int gdbarch_char_signed (struct gdbarch *gdbarch);
244 extern void set_gdbarch_char_signed (struct gdbarch *gdbarch, int char_signed);
246 extern int gdbarch_read_pc_p (struct gdbarch *gdbarch);
248 typedef CORE_ADDR (gdbarch_read_pc_ftype) (readable_regcache *regcache);
249 extern CORE_ADDR gdbarch_read_pc (struct gdbarch *gdbarch, readable_regcache *regcache);
250 extern void set_gdbarch_read_pc (struct gdbarch *gdbarch, gdbarch_read_pc_ftype *read_pc);
252 extern int gdbarch_write_pc_p (struct gdbarch *gdbarch);
254 typedef void (gdbarch_write_pc_ftype) (struct regcache *regcache, CORE_ADDR val);
255 extern void gdbarch_write_pc (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR val);
256 extern void set_gdbarch_write_pc (struct gdbarch *gdbarch, gdbarch_write_pc_ftype *write_pc);
258 /* Function for getting target's idea of a frame pointer. FIXME: GDB's
259 whole scheme for dealing with "frames" and "frame pointers" needs a
260 serious shakedown. */
262 typedef void (gdbarch_virtual_frame_pointer_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc, int *frame_regnum, LONGEST *frame_offset);
263 extern void gdbarch_virtual_frame_pointer (struct gdbarch *gdbarch, CORE_ADDR pc, int *frame_regnum, LONGEST *frame_offset);
264 extern void set_gdbarch_virtual_frame_pointer (struct gdbarch *gdbarch, gdbarch_virtual_frame_pointer_ftype *virtual_frame_pointer);
266 extern int gdbarch_pseudo_register_read_p (struct gdbarch *gdbarch);
268 typedef enum register_status (gdbarch_pseudo_register_read_ftype) (struct gdbarch *gdbarch, readable_regcache *regcache, int cookednum, gdb_byte *buf);
269 extern enum register_status gdbarch_pseudo_register_read (struct gdbarch *gdbarch, readable_regcache *regcache, int cookednum, gdb_byte *buf);
270 extern void set_gdbarch_pseudo_register_read (struct gdbarch *gdbarch, gdbarch_pseudo_register_read_ftype *pseudo_register_read);
272 /* Read a register into a new struct value. If the register is wholly
273 or partly unavailable, this should call mark_value_bytes_unavailable
274 as appropriate. If this is defined, then pseudo_register_read will
277 extern int gdbarch_pseudo_register_read_value_p (struct gdbarch *gdbarch);
279 typedef struct value * (gdbarch_pseudo_register_read_value_ftype) (struct gdbarch *gdbarch, readable_regcache *regcache, int cookednum);
280 extern struct value * gdbarch_pseudo_register_read_value (struct gdbarch *gdbarch, readable_regcache *regcache, int cookednum);
281 extern void set_gdbarch_pseudo_register_read_value (struct gdbarch *gdbarch, gdbarch_pseudo_register_read_value_ftype *pseudo_register_read_value);
283 extern int gdbarch_pseudo_register_write_p (struct gdbarch *gdbarch);
285 typedef void (gdbarch_pseudo_register_write_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, const gdb_byte *buf);
286 extern void gdbarch_pseudo_register_write (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, const gdb_byte *buf);
287 extern void set_gdbarch_pseudo_register_write (struct gdbarch *gdbarch, gdbarch_pseudo_register_write_ftype *pseudo_register_write);
289 extern int gdbarch_num_regs (struct gdbarch *gdbarch);
290 extern void set_gdbarch_num_regs (struct gdbarch *gdbarch, int num_regs);
292 /* This macro gives the number of pseudo-registers that live in the
293 register namespace but do not get fetched or stored on the target.
294 These pseudo-registers may be aliases for other registers,
295 combinations of other registers, or they may be computed by GDB. */
297 extern int gdbarch_num_pseudo_regs (struct gdbarch *gdbarch);
298 extern void set_gdbarch_num_pseudo_regs (struct gdbarch *gdbarch, int num_pseudo_regs);
300 /* Assemble agent expression bytecode to collect pseudo-register REG.
301 Return -1 if something goes wrong, 0 otherwise. */
303 extern int gdbarch_ax_pseudo_register_collect_p (struct gdbarch *gdbarch);
305 typedef int (gdbarch_ax_pseudo_register_collect_ftype) (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
306 extern int gdbarch_ax_pseudo_register_collect (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
307 extern void set_gdbarch_ax_pseudo_register_collect (struct gdbarch *gdbarch, gdbarch_ax_pseudo_register_collect_ftype *ax_pseudo_register_collect);
309 /* Assemble agent expression bytecode to push the value of pseudo-register
310 REG on the interpreter stack.
311 Return -1 if something goes wrong, 0 otherwise. */
313 extern int gdbarch_ax_pseudo_register_push_stack_p (struct gdbarch *gdbarch);
315 typedef int (gdbarch_ax_pseudo_register_push_stack_ftype) (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
316 extern int gdbarch_ax_pseudo_register_push_stack (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
317 extern void set_gdbarch_ax_pseudo_register_push_stack (struct gdbarch *gdbarch, gdbarch_ax_pseudo_register_push_stack_ftype *ax_pseudo_register_push_stack);
319 /* Some targets/architectures can do extra processing/display of
320 segmentation faults. E.g., Intel MPX boundary faults.
321 Call the architecture dependent function to handle the fault.
322 UIOUT is the output stream where the handler will place information. */
324 extern int gdbarch_handle_segmentation_fault_p (struct gdbarch *gdbarch);
326 typedef void (gdbarch_handle_segmentation_fault_ftype) (struct gdbarch *gdbarch, struct ui_out *uiout);
327 extern void gdbarch_handle_segmentation_fault (struct gdbarch *gdbarch, struct ui_out *uiout);
328 extern void set_gdbarch_handle_segmentation_fault (struct gdbarch *gdbarch, gdbarch_handle_segmentation_fault_ftype *handle_segmentation_fault);
330 /* GDB's standard (or well known) register numbers. These can map onto
331 a real register or a pseudo (computed) register or not be defined at
333 gdbarch_sp_regnum will hopefully be replaced by UNWIND_SP. */
335 extern int gdbarch_sp_regnum (struct gdbarch *gdbarch);
336 extern void set_gdbarch_sp_regnum (struct gdbarch *gdbarch, int sp_regnum);
338 extern int gdbarch_pc_regnum (struct gdbarch *gdbarch);
339 extern void set_gdbarch_pc_regnum (struct gdbarch *gdbarch, int pc_regnum);
341 extern int gdbarch_ps_regnum (struct gdbarch *gdbarch);
342 extern void set_gdbarch_ps_regnum (struct gdbarch *gdbarch, int ps_regnum);
344 extern int gdbarch_fp0_regnum (struct gdbarch *gdbarch);
345 extern void set_gdbarch_fp0_regnum (struct gdbarch *gdbarch, int fp0_regnum);
347 /* Convert stab register number (from `r' declaration) to a gdb REGNUM. */
349 typedef int (gdbarch_stab_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int stab_regnr);
350 extern int gdbarch_stab_reg_to_regnum (struct gdbarch *gdbarch, int stab_regnr);
351 extern void set_gdbarch_stab_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_stab_reg_to_regnum_ftype *stab_reg_to_regnum);
353 /* Provide a default mapping from a ecoff register number to a gdb REGNUM. */
355 typedef int (gdbarch_ecoff_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int ecoff_regnr);
356 extern int gdbarch_ecoff_reg_to_regnum (struct gdbarch *gdbarch, int ecoff_regnr);
357 extern void set_gdbarch_ecoff_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_ecoff_reg_to_regnum_ftype *ecoff_reg_to_regnum);
359 /* Convert from an sdb register number to an internal gdb register number. */
361 typedef int (gdbarch_sdb_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int sdb_regnr);
362 extern int gdbarch_sdb_reg_to_regnum (struct gdbarch *gdbarch, int sdb_regnr);
363 extern void set_gdbarch_sdb_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_sdb_reg_to_regnum_ftype *sdb_reg_to_regnum);
365 /* Provide a default mapping from a DWARF2 register number to a gdb REGNUM.
366 Return -1 for bad REGNUM. Note: Several targets get this wrong. */
368 typedef int (gdbarch_dwarf2_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int dwarf2_regnr);
369 extern int gdbarch_dwarf2_reg_to_regnum (struct gdbarch *gdbarch, int dwarf2_regnr);
370 extern void set_gdbarch_dwarf2_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_dwarf2_reg_to_regnum_ftype *dwarf2_reg_to_regnum);
372 typedef const char * (gdbarch_register_name_ftype) (struct gdbarch *gdbarch, int regnr);
373 extern const char * gdbarch_register_name (struct gdbarch *gdbarch, int regnr);
374 extern void set_gdbarch_register_name (struct gdbarch *gdbarch, gdbarch_register_name_ftype *register_name);
376 /* Return the type of a register specified by the architecture. Only
377 the register cache should call this function directly; others should
378 use "register_type". */
380 extern int gdbarch_register_type_p (struct gdbarch *gdbarch);
382 typedef struct type * (gdbarch_register_type_ftype) (struct gdbarch *gdbarch, int reg_nr);
383 extern struct type * gdbarch_register_type (struct gdbarch *gdbarch, int reg_nr);
384 extern void set_gdbarch_register_type (struct gdbarch *gdbarch, gdbarch_register_type_ftype *register_type);
386 extern int gdbarch_dummy_id_p (struct gdbarch *gdbarch);
388 typedef struct frame_id (gdbarch_dummy_id_ftype) (struct gdbarch *gdbarch, struct frame_info *this_frame);
389 extern struct frame_id gdbarch_dummy_id (struct gdbarch *gdbarch, struct frame_info *this_frame);
390 extern void set_gdbarch_dummy_id (struct gdbarch *gdbarch, gdbarch_dummy_id_ftype *dummy_id);
392 /* Implement DUMMY_ID and PUSH_DUMMY_CALL, then delete
393 deprecated_fp_regnum. */
395 extern int gdbarch_deprecated_fp_regnum (struct gdbarch *gdbarch);
396 extern void set_gdbarch_deprecated_fp_regnum (struct gdbarch *gdbarch, int deprecated_fp_regnum);
398 extern int gdbarch_push_dummy_call_p (struct gdbarch *gdbarch);
400 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);
401 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);
402 extern void set_gdbarch_push_dummy_call (struct gdbarch *gdbarch, gdbarch_push_dummy_call_ftype *push_dummy_call);
404 extern int gdbarch_call_dummy_location (struct gdbarch *gdbarch);
405 extern void set_gdbarch_call_dummy_location (struct gdbarch *gdbarch, int call_dummy_location);
407 extern int gdbarch_push_dummy_code_p (struct gdbarch *gdbarch);
409 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);
410 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);
411 extern void set_gdbarch_push_dummy_code (struct gdbarch *gdbarch, gdbarch_push_dummy_code_ftype *push_dummy_code);
413 /* Return true if the code of FRAME is writable. */
415 typedef int (gdbarch_code_of_frame_writable_ftype) (struct gdbarch *gdbarch, struct frame_info *frame);
416 extern int gdbarch_code_of_frame_writable (struct gdbarch *gdbarch, struct frame_info *frame);
417 extern void set_gdbarch_code_of_frame_writable (struct gdbarch *gdbarch, gdbarch_code_of_frame_writable_ftype *code_of_frame_writable);
419 typedef void (gdbarch_print_registers_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, int regnum, int all);
420 extern void gdbarch_print_registers_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, int regnum, int all);
421 extern void set_gdbarch_print_registers_info (struct gdbarch *gdbarch, gdbarch_print_registers_info_ftype *print_registers_info);
423 typedef void (gdbarch_print_float_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
424 extern void gdbarch_print_float_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
425 extern void set_gdbarch_print_float_info (struct gdbarch *gdbarch, gdbarch_print_float_info_ftype *print_float_info);
427 extern int gdbarch_print_vector_info_p (struct gdbarch *gdbarch);
429 typedef void (gdbarch_print_vector_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
430 extern void gdbarch_print_vector_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
431 extern void set_gdbarch_print_vector_info (struct gdbarch *gdbarch, gdbarch_print_vector_info_ftype *print_vector_info);
433 /* MAP a GDB RAW register number onto a simulator register number. See
434 also include/...-sim.h. */
436 typedef int (gdbarch_register_sim_regno_ftype) (struct gdbarch *gdbarch, int reg_nr);
437 extern int gdbarch_register_sim_regno (struct gdbarch *gdbarch, int reg_nr);
438 extern void set_gdbarch_register_sim_regno (struct gdbarch *gdbarch, gdbarch_register_sim_regno_ftype *register_sim_regno);
440 typedef int (gdbarch_cannot_fetch_register_ftype) (struct gdbarch *gdbarch, int regnum);
441 extern int gdbarch_cannot_fetch_register (struct gdbarch *gdbarch, int regnum);
442 extern void set_gdbarch_cannot_fetch_register (struct gdbarch *gdbarch, gdbarch_cannot_fetch_register_ftype *cannot_fetch_register);
444 typedef int (gdbarch_cannot_store_register_ftype) (struct gdbarch *gdbarch, int regnum);
445 extern int gdbarch_cannot_store_register (struct gdbarch *gdbarch, int regnum);
446 extern void set_gdbarch_cannot_store_register (struct gdbarch *gdbarch, gdbarch_cannot_store_register_ftype *cannot_store_register);
448 /* Determine the address where a longjmp will land and save this address
449 in PC. Return nonzero on success.
451 FRAME corresponds to the longjmp frame. */
453 extern int gdbarch_get_longjmp_target_p (struct gdbarch *gdbarch);
455 typedef int (gdbarch_get_longjmp_target_ftype) (struct frame_info *frame, CORE_ADDR *pc);
456 extern int gdbarch_get_longjmp_target (struct gdbarch *gdbarch, struct frame_info *frame, CORE_ADDR *pc);
457 extern void set_gdbarch_get_longjmp_target (struct gdbarch *gdbarch, gdbarch_get_longjmp_target_ftype *get_longjmp_target);
459 extern int gdbarch_believe_pcc_promotion (struct gdbarch *gdbarch);
460 extern void set_gdbarch_believe_pcc_promotion (struct gdbarch *gdbarch, int believe_pcc_promotion);
462 typedef int (gdbarch_convert_register_p_ftype) (struct gdbarch *gdbarch, int regnum, struct type *type);
463 extern int gdbarch_convert_register_p (struct gdbarch *gdbarch, int regnum, struct type *type);
464 extern void set_gdbarch_convert_register_p (struct gdbarch *gdbarch, gdbarch_convert_register_p_ftype *convert_register_p);
466 typedef int (gdbarch_register_to_value_ftype) (struct frame_info *frame, int regnum, struct type *type, gdb_byte *buf, int *optimizedp, int *unavailablep);
467 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);
468 extern void set_gdbarch_register_to_value (struct gdbarch *gdbarch, gdbarch_register_to_value_ftype *register_to_value);
470 typedef void (gdbarch_value_to_register_ftype) (struct frame_info *frame, int regnum, struct type *type, const gdb_byte *buf);
471 extern void gdbarch_value_to_register (struct gdbarch *gdbarch, struct frame_info *frame, int regnum, struct type *type, const gdb_byte *buf);
472 extern void set_gdbarch_value_to_register (struct gdbarch *gdbarch, gdbarch_value_to_register_ftype *value_to_register);
474 /* Construct a value representing the contents of register REGNUM in
475 frame FRAME_ID, interpreted as type TYPE. The routine needs to
476 allocate and return a struct value with all value attributes
477 (but not the value contents) filled in. */
479 typedef struct value * (gdbarch_value_from_register_ftype) (struct gdbarch *gdbarch, struct type *type, int regnum, struct frame_id frame_id);
480 extern struct value * gdbarch_value_from_register (struct gdbarch *gdbarch, struct type *type, int regnum, struct frame_id frame_id);
481 extern void set_gdbarch_value_from_register (struct gdbarch *gdbarch, gdbarch_value_from_register_ftype *value_from_register);
483 typedef CORE_ADDR (gdbarch_pointer_to_address_ftype) (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
484 extern CORE_ADDR gdbarch_pointer_to_address (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
485 extern void set_gdbarch_pointer_to_address (struct gdbarch *gdbarch, gdbarch_pointer_to_address_ftype *pointer_to_address);
487 typedef void (gdbarch_address_to_pointer_ftype) (struct gdbarch *gdbarch, struct type *type, gdb_byte *buf, CORE_ADDR addr);
488 extern void gdbarch_address_to_pointer (struct gdbarch *gdbarch, struct type *type, gdb_byte *buf, CORE_ADDR addr);
489 extern void set_gdbarch_address_to_pointer (struct gdbarch *gdbarch, gdbarch_address_to_pointer_ftype *address_to_pointer);
491 extern int gdbarch_integer_to_address_p (struct gdbarch *gdbarch);
493 typedef CORE_ADDR (gdbarch_integer_to_address_ftype) (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
494 extern CORE_ADDR gdbarch_integer_to_address (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
495 extern void set_gdbarch_integer_to_address (struct gdbarch *gdbarch, gdbarch_integer_to_address_ftype *integer_to_address);
497 /* Return the return-value convention that will be used by FUNCTION
498 to return a value of type VALTYPE. FUNCTION may be NULL in which
499 case the return convention is computed based only on VALTYPE.
501 If READBUF is not NULL, extract the return value and save it in this buffer.
503 If WRITEBUF is not NULL, it contains a return value which will be
504 stored into the appropriate register. This can be used when we want
505 to force the value returned by a function (see the "return" command
508 extern int gdbarch_return_value_p (struct gdbarch *gdbarch);
510 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);
511 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);
512 extern void set_gdbarch_return_value (struct gdbarch *gdbarch, gdbarch_return_value_ftype *return_value);
514 /* Return true if the return value of function is stored in the first hidden
515 parameter. In theory, this feature should be language-dependent, specified
516 by language and its ABI, such as C++. Unfortunately, compiler may
517 implement it to a target-dependent feature. So that we need such hook here
518 to be aware of this in GDB. */
520 typedef int (gdbarch_return_in_first_hidden_param_p_ftype) (struct gdbarch *gdbarch, struct type *type);
521 extern int gdbarch_return_in_first_hidden_param_p (struct gdbarch *gdbarch, struct type *type);
522 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);
524 typedef CORE_ADDR (gdbarch_skip_prologue_ftype) (struct gdbarch *gdbarch, CORE_ADDR ip);
525 extern CORE_ADDR gdbarch_skip_prologue (struct gdbarch *gdbarch, CORE_ADDR ip);
526 extern void set_gdbarch_skip_prologue (struct gdbarch *gdbarch, gdbarch_skip_prologue_ftype *skip_prologue);
528 extern int gdbarch_skip_main_prologue_p (struct gdbarch *gdbarch);
530 typedef CORE_ADDR (gdbarch_skip_main_prologue_ftype) (struct gdbarch *gdbarch, CORE_ADDR ip);
531 extern CORE_ADDR gdbarch_skip_main_prologue (struct gdbarch *gdbarch, CORE_ADDR ip);
532 extern void set_gdbarch_skip_main_prologue (struct gdbarch *gdbarch, gdbarch_skip_main_prologue_ftype *skip_main_prologue);
534 /* On some platforms, a single function may provide multiple entry points,
535 e.g. one that is used for function-pointer calls and a different one
536 that is used for direct function calls.
537 In order to ensure that breakpoints set on the function will trigger
538 no matter via which entry point the function is entered, a platform
539 may provide the skip_entrypoint callback. It is called with IP set
540 to the main entry point of a function (as determined by the symbol table),
541 and should return the address of the innermost entry point, where the
542 actual breakpoint needs to be set. Note that skip_entrypoint is used
543 by GDB common code even when debugging optimized code, where skip_prologue
546 extern int gdbarch_skip_entrypoint_p (struct gdbarch *gdbarch);
548 typedef CORE_ADDR (gdbarch_skip_entrypoint_ftype) (struct gdbarch *gdbarch, CORE_ADDR ip);
549 extern CORE_ADDR gdbarch_skip_entrypoint (struct gdbarch *gdbarch, CORE_ADDR ip);
550 extern void set_gdbarch_skip_entrypoint (struct gdbarch *gdbarch, gdbarch_skip_entrypoint_ftype *skip_entrypoint);
552 typedef int (gdbarch_inner_than_ftype) (CORE_ADDR lhs, CORE_ADDR rhs);
553 extern int gdbarch_inner_than (struct gdbarch *gdbarch, CORE_ADDR lhs, CORE_ADDR rhs);
554 extern void set_gdbarch_inner_than (struct gdbarch *gdbarch, gdbarch_inner_than_ftype *inner_than);
556 typedef const gdb_byte * (gdbarch_breakpoint_from_pc_ftype) (struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *lenptr);
557 extern const gdb_byte * gdbarch_breakpoint_from_pc (struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *lenptr);
558 extern void set_gdbarch_breakpoint_from_pc (struct gdbarch *gdbarch, gdbarch_breakpoint_from_pc_ftype *breakpoint_from_pc);
560 /* Return the breakpoint kind for this target based on *PCPTR. */
562 typedef int (gdbarch_breakpoint_kind_from_pc_ftype) (struct gdbarch *gdbarch, CORE_ADDR *pcptr);
563 extern int gdbarch_breakpoint_kind_from_pc (struct gdbarch *gdbarch, CORE_ADDR *pcptr);
564 extern void set_gdbarch_breakpoint_kind_from_pc (struct gdbarch *gdbarch, gdbarch_breakpoint_kind_from_pc_ftype *breakpoint_kind_from_pc);
566 /* Return the software breakpoint from KIND. KIND can have target
567 specific meaning like the Z0 kind parameter.
568 SIZE is set to the software breakpoint's length in memory. */
570 typedef const gdb_byte * (gdbarch_sw_breakpoint_from_kind_ftype) (struct gdbarch *gdbarch, int kind, int *size);
571 extern const gdb_byte * gdbarch_sw_breakpoint_from_kind (struct gdbarch *gdbarch, int kind, int *size);
572 extern void set_gdbarch_sw_breakpoint_from_kind (struct gdbarch *gdbarch, gdbarch_sw_breakpoint_from_kind_ftype *sw_breakpoint_from_kind);
574 /* Return the breakpoint kind for this target based on the current
575 processor state (e.g. the current instruction mode on ARM) and the
576 *PCPTR. In default, it is gdbarch->breakpoint_kind_from_pc. */
578 typedef int (gdbarch_breakpoint_kind_from_current_state_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR *pcptr);
579 extern int gdbarch_breakpoint_kind_from_current_state (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR *pcptr);
580 extern void set_gdbarch_breakpoint_kind_from_current_state (struct gdbarch *gdbarch, gdbarch_breakpoint_kind_from_current_state_ftype *breakpoint_kind_from_current_state);
582 extern int gdbarch_adjust_breakpoint_address_p (struct gdbarch *gdbarch);
584 typedef CORE_ADDR (gdbarch_adjust_breakpoint_address_ftype) (struct gdbarch *gdbarch, CORE_ADDR bpaddr);
585 extern CORE_ADDR gdbarch_adjust_breakpoint_address (struct gdbarch *gdbarch, CORE_ADDR bpaddr);
586 extern void set_gdbarch_adjust_breakpoint_address (struct gdbarch *gdbarch, gdbarch_adjust_breakpoint_address_ftype *adjust_breakpoint_address);
588 typedef int (gdbarch_memory_insert_breakpoint_ftype) (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
589 extern int gdbarch_memory_insert_breakpoint (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
590 extern void set_gdbarch_memory_insert_breakpoint (struct gdbarch *gdbarch, gdbarch_memory_insert_breakpoint_ftype *memory_insert_breakpoint);
592 typedef int (gdbarch_memory_remove_breakpoint_ftype) (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
593 extern int gdbarch_memory_remove_breakpoint (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
594 extern void set_gdbarch_memory_remove_breakpoint (struct gdbarch *gdbarch, gdbarch_memory_remove_breakpoint_ftype *memory_remove_breakpoint);
596 extern CORE_ADDR gdbarch_decr_pc_after_break (struct gdbarch *gdbarch);
597 extern void set_gdbarch_decr_pc_after_break (struct gdbarch *gdbarch, CORE_ADDR decr_pc_after_break);
599 /* A function can be addressed by either it's "pointer" (possibly a
600 descriptor address) or "entry point" (first executable instruction).
601 The method "convert_from_func_ptr_addr" converting the former to the
602 latter. gdbarch_deprecated_function_start_offset is being used to implement
603 a simplified subset of that functionality - the function's address
604 corresponds to the "function pointer" and the function's start
605 corresponds to the "function entry point" - and hence is redundant. */
607 extern CORE_ADDR gdbarch_deprecated_function_start_offset (struct gdbarch *gdbarch);
608 extern void set_gdbarch_deprecated_function_start_offset (struct gdbarch *gdbarch, CORE_ADDR deprecated_function_start_offset);
610 /* Return the remote protocol register number associated with this
611 register. Normally the identity mapping. */
613 typedef int (gdbarch_remote_register_number_ftype) (struct gdbarch *gdbarch, int regno);
614 extern int gdbarch_remote_register_number (struct gdbarch *gdbarch, int regno);
615 extern void set_gdbarch_remote_register_number (struct gdbarch *gdbarch, gdbarch_remote_register_number_ftype *remote_register_number);
617 /* Fetch the target specific address used to represent a load module. */
619 extern int gdbarch_fetch_tls_load_module_address_p (struct gdbarch *gdbarch);
621 typedef CORE_ADDR (gdbarch_fetch_tls_load_module_address_ftype) (struct objfile *objfile);
622 extern CORE_ADDR gdbarch_fetch_tls_load_module_address (struct gdbarch *gdbarch, struct objfile *objfile);
623 extern void set_gdbarch_fetch_tls_load_module_address (struct gdbarch *gdbarch, gdbarch_fetch_tls_load_module_address_ftype *fetch_tls_load_module_address);
625 extern CORE_ADDR gdbarch_frame_args_skip (struct gdbarch *gdbarch);
626 extern void set_gdbarch_frame_args_skip (struct gdbarch *gdbarch, CORE_ADDR frame_args_skip);
628 extern int gdbarch_unwind_pc_p (struct gdbarch *gdbarch);
630 typedef CORE_ADDR (gdbarch_unwind_pc_ftype) (struct gdbarch *gdbarch, struct frame_info *next_frame);
631 extern CORE_ADDR gdbarch_unwind_pc (struct gdbarch *gdbarch, struct frame_info *next_frame);
632 extern void set_gdbarch_unwind_pc (struct gdbarch *gdbarch, gdbarch_unwind_pc_ftype *unwind_pc);
634 extern int gdbarch_unwind_sp_p (struct gdbarch *gdbarch);
636 typedef CORE_ADDR (gdbarch_unwind_sp_ftype) (struct gdbarch *gdbarch, struct frame_info *next_frame);
637 extern CORE_ADDR gdbarch_unwind_sp (struct gdbarch *gdbarch, struct frame_info *next_frame);
638 extern void set_gdbarch_unwind_sp (struct gdbarch *gdbarch, gdbarch_unwind_sp_ftype *unwind_sp);
640 /* DEPRECATED_FRAME_LOCALS_ADDRESS as been replaced by the per-frame
641 frame-base. Enable frame-base before frame-unwind. */
643 extern int gdbarch_frame_num_args_p (struct gdbarch *gdbarch);
645 typedef int (gdbarch_frame_num_args_ftype) (struct frame_info *frame);
646 extern int gdbarch_frame_num_args (struct gdbarch *gdbarch, struct frame_info *frame);
647 extern void set_gdbarch_frame_num_args (struct gdbarch *gdbarch, gdbarch_frame_num_args_ftype *frame_num_args);
649 extern int gdbarch_frame_align_p (struct gdbarch *gdbarch);
651 typedef CORE_ADDR (gdbarch_frame_align_ftype) (struct gdbarch *gdbarch, CORE_ADDR address);
652 extern CORE_ADDR gdbarch_frame_align (struct gdbarch *gdbarch, CORE_ADDR address);
653 extern void set_gdbarch_frame_align (struct gdbarch *gdbarch, gdbarch_frame_align_ftype *frame_align);
655 typedef int (gdbarch_stabs_argument_has_addr_ftype) (struct gdbarch *gdbarch, struct type *type);
656 extern int gdbarch_stabs_argument_has_addr (struct gdbarch *gdbarch, struct type *type);
657 extern void set_gdbarch_stabs_argument_has_addr (struct gdbarch *gdbarch, gdbarch_stabs_argument_has_addr_ftype *stabs_argument_has_addr);
659 extern int gdbarch_frame_red_zone_size (struct gdbarch *gdbarch);
660 extern void set_gdbarch_frame_red_zone_size (struct gdbarch *gdbarch, int frame_red_zone_size);
662 typedef CORE_ADDR (gdbarch_convert_from_func_ptr_addr_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr, struct target_ops *targ);
663 extern CORE_ADDR gdbarch_convert_from_func_ptr_addr (struct gdbarch *gdbarch, CORE_ADDR addr, struct target_ops *targ);
664 extern void set_gdbarch_convert_from_func_ptr_addr (struct gdbarch *gdbarch, gdbarch_convert_from_func_ptr_addr_ftype *convert_from_func_ptr_addr);
666 /* On some machines there are bits in addresses which are not really
667 part of the address, but are used by the kernel, the hardware, etc.
668 for special purposes. gdbarch_addr_bits_remove takes out any such bits so
669 we get a "real" address such as one would find in a symbol table.
670 This is used only for addresses of instructions, and even then I'm
671 not sure it's used in all contexts. It exists to deal with there
672 being a few stray bits in the PC which would mislead us, not as some
673 sort of generic thing to handle alignment or segmentation (it's
674 possible it should be in TARGET_READ_PC instead). */
676 typedef CORE_ADDR (gdbarch_addr_bits_remove_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
677 extern CORE_ADDR gdbarch_addr_bits_remove (struct gdbarch *gdbarch, CORE_ADDR addr);
678 extern void set_gdbarch_addr_bits_remove (struct gdbarch *gdbarch, gdbarch_addr_bits_remove_ftype *addr_bits_remove);
680 /* On some machines, not all bits of an address word are significant.
681 For example, on AArch64, the top bits of an address known as the "tag"
682 are ignored by the kernel, the hardware, etc. and can be regarded as
683 additional data associated with the address. */
685 extern int gdbarch_significant_addr_bit (struct gdbarch *gdbarch);
686 extern void set_gdbarch_significant_addr_bit (struct gdbarch *gdbarch, int significant_addr_bit);
688 /* FIXME/cagney/2001-01-18: This should be split in two. A target method that
689 indicates if the target needs software single step. An ISA method to
692 FIXME/cagney/2001-01-18: The logic is backwards. It should be asking if the
693 target can single step. If not, then implement single step using breakpoints.
695 Return a vector of addresses on which the software single step
696 breakpoints should be inserted. NULL means software single step is
698 Multiple breakpoints may be inserted for some instructions such as
699 conditional branch. However, each implementation must always evaluate
700 the condition and only put the breakpoint at the branch destination if
701 the condition is true, so that we ensure forward progress when stepping
702 past a conditional branch to self. */
704 extern int gdbarch_software_single_step_p (struct gdbarch *gdbarch);
706 typedef std::vector<CORE_ADDR> (gdbarch_software_single_step_ftype) (struct regcache *regcache);
707 extern std::vector<CORE_ADDR> gdbarch_software_single_step (struct gdbarch *gdbarch, struct regcache *regcache);
708 extern void set_gdbarch_software_single_step (struct gdbarch *gdbarch, gdbarch_software_single_step_ftype *software_single_step);
710 /* Return non-zero if the processor is executing a delay slot and a
711 further single-step is needed before the instruction finishes. */
713 extern int gdbarch_single_step_through_delay_p (struct gdbarch *gdbarch);
715 typedef int (gdbarch_single_step_through_delay_ftype) (struct gdbarch *gdbarch, struct frame_info *frame);
716 extern int gdbarch_single_step_through_delay (struct gdbarch *gdbarch, struct frame_info *frame);
717 extern void set_gdbarch_single_step_through_delay (struct gdbarch *gdbarch, gdbarch_single_step_through_delay_ftype *single_step_through_delay);
719 /* FIXME: cagney/2003-08-28: Need to find a better way of selecting the
720 disassembler. Perhaps objdump can handle it? */
722 typedef int (gdbarch_print_insn_ftype) (bfd_vma vma, struct disassemble_info *info);
723 extern int gdbarch_print_insn (struct gdbarch *gdbarch, bfd_vma vma, struct disassemble_info *info);
724 extern void set_gdbarch_print_insn (struct gdbarch *gdbarch, gdbarch_print_insn_ftype *print_insn);
726 typedef CORE_ADDR (gdbarch_skip_trampoline_code_ftype) (struct frame_info *frame, CORE_ADDR pc);
727 extern CORE_ADDR gdbarch_skip_trampoline_code (struct gdbarch *gdbarch, struct frame_info *frame, CORE_ADDR pc);
728 extern void set_gdbarch_skip_trampoline_code (struct gdbarch *gdbarch, gdbarch_skip_trampoline_code_ftype *skip_trampoline_code);
730 /* If in_solib_dynsym_resolve_code() returns true, and SKIP_SOLIB_RESOLVER
731 evaluates non-zero, this is the address where the debugger will place
732 a step-resume breakpoint to get us past the dynamic linker. */
734 typedef CORE_ADDR (gdbarch_skip_solib_resolver_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc);
735 extern CORE_ADDR gdbarch_skip_solib_resolver (struct gdbarch *gdbarch, CORE_ADDR pc);
736 extern void set_gdbarch_skip_solib_resolver (struct gdbarch *gdbarch, gdbarch_skip_solib_resolver_ftype *skip_solib_resolver);
738 /* Some systems also have trampoline code for returning from shared libs. */
740 typedef int (gdbarch_in_solib_return_trampoline_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc, const char *name);
741 extern int gdbarch_in_solib_return_trampoline (struct gdbarch *gdbarch, CORE_ADDR pc, const char *name);
742 extern void set_gdbarch_in_solib_return_trampoline (struct gdbarch *gdbarch, gdbarch_in_solib_return_trampoline_ftype *in_solib_return_trampoline);
744 /* Return true if PC lies inside an indirect branch thunk. */
746 typedef bool (gdbarch_in_indirect_branch_thunk_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc);
747 extern bool gdbarch_in_indirect_branch_thunk (struct gdbarch *gdbarch, CORE_ADDR pc);
748 extern void set_gdbarch_in_indirect_branch_thunk (struct gdbarch *gdbarch, gdbarch_in_indirect_branch_thunk_ftype *in_indirect_branch_thunk);
750 /* A target might have problems with watchpoints as soon as the stack
751 frame of the current function has been destroyed. This mostly happens
752 as the first action in a function's epilogue. stack_frame_destroyed_p()
753 is defined to return a non-zero value if either the given addr is one
754 instruction after the stack destroying instruction up to the trailing
755 return instruction or if we can figure out that the stack frame has
756 already been invalidated regardless of the value of addr. Targets
757 which don't suffer from that problem could just let this functionality
760 typedef int (gdbarch_stack_frame_destroyed_p_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
761 extern int gdbarch_stack_frame_destroyed_p (struct gdbarch *gdbarch, CORE_ADDR addr);
762 extern void set_gdbarch_stack_frame_destroyed_p (struct gdbarch *gdbarch, gdbarch_stack_frame_destroyed_p_ftype *stack_frame_destroyed_p);
764 /* Process an ELF symbol in the minimal symbol table in a backend-specific
765 way. Normally this hook is supposed to do nothing, however if required,
766 then this hook can be used to apply tranformations to symbols that are
767 considered special in some way. For example the MIPS backend uses it
768 to interpret `st_other' information to mark compressed code symbols so
769 that they can be treated in the appropriate manner in the processing of
770 the main symbol table and DWARF-2 records. */
772 extern int gdbarch_elf_make_msymbol_special_p (struct gdbarch *gdbarch);
774 typedef void (gdbarch_elf_make_msymbol_special_ftype) (asymbol *sym, struct minimal_symbol *msym);
775 extern void gdbarch_elf_make_msymbol_special (struct gdbarch *gdbarch, asymbol *sym, struct minimal_symbol *msym);
776 extern void set_gdbarch_elf_make_msymbol_special (struct gdbarch *gdbarch, gdbarch_elf_make_msymbol_special_ftype *elf_make_msymbol_special);
778 typedef void (gdbarch_coff_make_msymbol_special_ftype) (int val, struct minimal_symbol *msym);
779 extern void gdbarch_coff_make_msymbol_special (struct gdbarch *gdbarch, int val, struct minimal_symbol *msym);
780 extern void set_gdbarch_coff_make_msymbol_special (struct gdbarch *gdbarch, gdbarch_coff_make_msymbol_special_ftype *coff_make_msymbol_special);
782 /* Process a symbol in the main symbol table in a backend-specific way.
783 Normally this hook is supposed to do nothing, however if required,
784 then this hook can be used to apply tranformations to symbols that
785 are considered special in some way. This is currently used by the
786 MIPS backend to make sure compressed code symbols have the ISA bit
787 set. This in turn is needed for symbol values seen in GDB to match
788 the values used at the runtime by the program itself, for function
789 and label references. */
791 typedef void (gdbarch_make_symbol_special_ftype) (struct symbol *sym, struct objfile *objfile);
792 extern void gdbarch_make_symbol_special (struct gdbarch *gdbarch, struct symbol *sym, struct objfile *objfile);
793 extern void set_gdbarch_make_symbol_special (struct gdbarch *gdbarch, gdbarch_make_symbol_special_ftype *make_symbol_special);
795 /* Adjust the address retrieved from a DWARF-2 record other than a line
796 entry in a backend-specific way. Normally this hook is supposed to
797 return the address passed unchanged, however if that is incorrect for
798 any reason, then this hook can be used to fix the address up in the
799 required manner. This is currently used by the MIPS backend to make
800 sure addresses in FDE, range records, etc. referring to compressed
801 code have the ISA bit set, matching line information and the symbol
804 typedef CORE_ADDR (gdbarch_adjust_dwarf2_addr_ftype) (CORE_ADDR pc);
805 extern CORE_ADDR gdbarch_adjust_dwarf2_addr (struct gdbarch *gdbarch, CORE_ADDR pc);
806 extern void set_gdbarch_adjust_dwarf2_addr (struct gdbarch *gdbarch, gdbarch_adjust_dwarf2_addr_ftype *adjust_dwarf2_addr);
808 /* Adjust the address updated by a line entry in a backend-specific way.
809 Normally this hook is supposed to return the address passed unchanged,
810 however in the case of inconsistencies in these records, this hook can
811 be used to fix them up in the required manner. This is currently used
812 by the MIPS backend to make sure all line addresses in compressed code
813 are presented with the ISA bit set, which is not always the case. This
814 in turn ensures breakpoint addresses are correctly matched against the
817 typedef CORE_ADDR (gdbarch_adjust_dwarf2_line_ftype) (CORE_ADDR addr, int rel);
818 extern CORE_ADDR gdbarch_adjust_dwarf2_line (struct gdbarch *gdbarch, CORE_ADDR addr, int rel);
819 extern void set_gdbarch_adjust_dwarf2_line (struct gdbarch *gdbarch, gdbarch_adjust_dwarf2_line_ftype *adjust_dwarf2_line);
821 extern int gdbarch_cannot_step_breakpoint (struct gdbarch *gdbarch);
822 extern void set_gdbarch_cannot_step_breakpoint (struct gdbarch *gdbarch, int cannot_step_breakpoint);
824 extern int gdbarch_have_nonsteppable_watchpoint (struct gdbarch *gdbarch);
825 extern void set_gdbarch_have_nonsteppable_watchpoint (struct gdbarch *gdbarch, int have_nonsteppable_watchpoint);
827 extern int gdbarch_address_class_type_flags_p (struct gdbarch *gdbarch);
829 typedef int (gdbarch_address_class_type_flags_ftype) (int byte_size, int dwarf2_addr_class);
830 extern int gdbarch_address_class_type_flags (struct gdbarch *gdbarch, int byte_size, int dwarf2_addr_class);
831 extern void set_gdbarch_address_class_type_flags (struct gdbarch *gdbarch, gdbarch_address_class_type_flags_ftype *address_class_type_flags);
833 extern int gdbarch_address_class_type_flags_to_name_p (struct gdbarch *gdbarch);
835 typedef const char * (gdbarch_address_class_type_flags_to_name_ftype) (struct gdbarch *gdbarch, int type_flags);
836 extern const char * gdbarch_address_class_type_flags_to_name (struct gdbarch *gdbarch, int type_flags);
837 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);
839 /* Execute vendor-specific DWARF Call Frame Instruction. OP is the instruction.
840 FS are passed from the generic execute_cfa_program function. */
842 typedef bool (gdbarch_execute_dwarf_cfa_vendor_op_ftype) (struct gdbarch *gdbarch, gdb_byte op, struct dwarf2_frame_state *fs);
843 extern bool gdbarch_execute_dwarf_cfa_vendor_op (struct gdbarch *gdbarch, gdb_byte op, struct dwarf2_frame_state *fs);
844 extern void set_gdbarch_execute_dwarf_cfa_vendor_op (struct gdbarch *gdbarch, gdbarch_execute_dwarf_cfa_vendor_op_ftype *execute_dwarf_cfa_vendor_op);
846 /* Return the appropriate type_flags for the supplied address class.
847 This function should return 1 if the address class was recognized and
848 type_flags was set, zero otherwise. */
850 extern int gdbarch_address_class_name_to_type_flags_p (struct gdbarch *gdbarch);
852 typedef int (gdbarch_address_class_name_to_type_flags_ftype) (struct gdbarch *gdbarch, const char *name, int *type_flags_ptr);
853 extern int gdbarch_address_class_name_to_type_flags (struct gdbarch *gdbarch, const char *name, int *type_flags_ptr);
854 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);
856 /* Is a register in a group */
858 typedef int (gdbarch_register_reggroup_p_ftype) (struct gdbarch *gdbarch, int regnum, struct reggroup *reggroup);
859 extern int gdbarch_register_reggroup_p (struct gdbarch *gdbarch, int regnum, struct reggroup *reggroup);
860 extern void set_gdbarch_register_reggroup_p (struct gdbarch *gdbarch, gdbarch_register_reggroup_p_ftype *register_reggroup_p);
862 /* Fetch the pointer to the ith function argument. */
864 extern int gdbarch_fetch_pointer_argument_p (struct gdbarch *gdbarch);
866 typedef CORE_ADDR (gdbarch_fetch_pointer_argument_ftype) (struct frame_info *frame, int argi, struct type *type);
867 extern CORE_ADDR gdbarch_fetch_pointer_argument (struct gdbarch *gdbarch, struct frame_info *frame, int argi, struct type *type);
868 extern void set_gdbarch_fetch_pointer_argument (struct gdbarch *gdbarch, gdbarch_fetch_pointer_argument_ftype *fetch_pointer_argument);
870 /* Iterate over all supported register notes in a core file. For each
871 supported register note section, the iterator must call CB and pass
872 CB_DATA unchanged. If REGCACHE is not NULL, the iterator can limit
873 the supported register note sections based on the current register
874 values. Otherwise it should enumerate all supported register note
877 extern int gdbarch_iterate_over_regset_sections_p (struct gdbarch *gdbarch);
879 typedef void (gdbarch_iterate_over_regset_sections_ftype) (struct gdbarch *gdbarch, iterate_over_regset_sections_cb *cb, void *cb_data, const struct regcache *regcache);
880 extern void gdbarch_iterate_over_regset_sections (struct gdbarch *gdbarch, iterate_over_regset_sections_cb *cb, void *cb_data, const struct regcache *regcache);
881 extern void set_gdbarch_iterate_over_regset_sections (struct gdbarch *gdbarch, gdbarch_iterate_over_regset_sections_ftype *iterate_over_regset_sections);
883 /* Create core file notes */
885 extern int gdbarch_make_corefile_notes_p (struct gdbarch *gdbarch);
887 typedef char * (gdbarch_make_corefile_notes_ftype) (struct gdbarch *gdbarch, bfd *obfd, int *note_size);
888 extern char * gdbarch_make_corefile_notes (struct gdbarch *gdbarch, bfd *obfd, int *note_size);
889 extern void set_gdbarch_make_corefile_notes (struct gdbarch *gdbarch, gdbarch_make_corefile_notes_ftype *make_corefile_notes);
891 /* Find core file memory regions */
893 extern int gdbarch_find_memory_regions_p (struct gdbarch *gdbarch);
895 typedef int (gdbarch_find_memory_regions_ftype) (struct gdbarch *gdbarch, find_memory_region_ftype func, void *data);
896 extern int gdbarch_find_memory_regions (struct gdbarch *gdbarch, find_memory_region_ftype func, void *data);
897 extern void set_gdbarch_find_memory_regions (struct gdbarch *gdbarch, gdbarch_find_memory_regions_ftype *find_memory_regions);
899 /* Read offset OFFSET of TARGET_OBJECT_LIBRARIES formatted shared libraries list from
900 core file into buffer READBUF with length LEN. Return the number of bytes read
901 (zero indicates failure).
902 failed, otherwise, return the red length of READBUF. */
904 extern int gdbarch_core_xfer_shared_libraries_p (struct gdbarch *gdbarch);
906 typedef ULONGEST (gdbarch_core_xfer_shared_libraries_ftype) (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
907 extern ULONGEST gdbarch_core_xfer_shared_libraries (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
908 extern void set_gdbarch_core_xfer_shared_libraries (struct gdbarch *gdbarch, gdbarch_core_xfer_shared_libraries_ftype *core_xfer_shared_libraries);
910 /* Read offset OFFSET of TARGET_OBJECT_LIBRARIES_AIX formatted shared
911 libraries list from core file into buffer READBUF with length LEN.
912 Return the number of bytes read (zero indicates failure). */
914 extern int gdbarch_core_xfer_shared_libraries_aix_p (struct gdbarch *gdbarch);
916 typedef ULONGEST (gdbarch_core_xfer_shared_libraries_aix_ftype) (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
917 extern ULONGEST gdbarch_core_xfer_shared_libraries_aix (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
918 extern void set_gdbarch_core_xfer_shared_libraries_aix (struct gdbarch *gdbarch, gdbarch_core_xfer_shared_libraries_aix_ftype *core_xfer_shared_libraries_aix);
920 /* How the core target converts a PTID from a core file to a string. */
922 extern int gdbarch_core_pid_to_str_p (struct gdbarch *gdbarch);
924 typedef const char * (gdbarch_core_pid_to_str_ftype) (struct gdbarch *gdbarch, ptid_t ptid);
925 extern const char * gdbarch_core_pid_to_str (struct gdbarch *gdbarch, ptid_t ptid);
926 extern void set_gdbarch_core_pid_to_str (struct gdbarch *gdbarch, gdbarch_core_pid_to_str_ftype *core_pid_to_str);
928 /* How the core target extracts the name of a thread from a core file. */
930 extern int gdbarch_core_thread_name_p (struct gdbarch *gdbarch);
932 typedef const char * (gdbarch_core_thread_name_ftype) (struct gdbarch *gdbarch, struct thread_info *thr);
933 extern const char * gdbarch_core_thread_name (struct gdbarch *gdbarch, struct thread_info *thr);
934 extern void set_gdbarch_core_thread_name (struct gdbarch *gdbarch, gdbarch_core_thread_name_ftype *core_thread_name);
936 /* Read offset OFFSET of TARGET_OBJECT_SIGNAL_INFO signal information
937 from core file into buffer READBUF with length LEN. Return the number
938 of bytes read (zero indicates EOF, a negative value indicates failure). */
940 extern int gdbarch_core_xfer_siginfo_p (struct gdbarch *gdbarch);
942 typedef LONGEST (gdbarch_core_xfer_siginfo_ftype) (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
943 extern LONGEST gdbarch_core_xfer_siginfo (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
944 extern void set_gdbarch_core_xfer_siginfo (struct gdbarch *gdbarch, gdbarch_core_xfer_siginfo_ftype *core_xfer_siginfo);
946 /* BFD target to use when generating a core file. */
948 extern int gdbarch_gcore_bfd_target_p (struct gdbarch *gdbarch);
950 extern const char * gdbarch_gcore_bfd_target (struct gdbarch *gdbarch);
951 extern void set_gdbarch_gcore_bfd_target (struct gdbarch *gdbarch, const char * gcore_bfd_target);
953 /* If the elements of C++ vtables are in-place function descriptors rather
954 than normal function pointers (which may point to code or a descriptor),
957 extern int gdbarch_vtable_function_descriptors (struct gdbarch *gdbarch);
958 extern void set_gdbarch_vtable_function_descriptors (struct gdbarch *gdbarch, int vtable_function_descriptors);
960 /* Set if the least significant bit of the delta is used instead of the least
961 significant bit of the pfn for pointers to virtual member functions. */
963 extern int gdbarch_vbit_in_delta (struct gdbarch *gdbarch);
964 extern void set_gdbarch_vbit_in_delta (struct gdbarch *gdbarch, int vbit_in_delta);
966 /* Advance PC to next instruction in order to skip a permanent breakpoint. */
968 typedef void (gdbarch_skip_permanent_breakpoint_ftype) (struct regcache *regcache);
969 extern void gdbarch_skip_permanent_breakpoint (struct gdbarch *gdbarch, struct regcache *regcache);
970 extern void set_gdbarch_skip_permanent_breakpoint (struct gdbarch *gdbarch, gdbarch_skip_permanent_breakpoint_ftype *skip_permanent_breakpoint);
972 /* The maximum length of an instruction on this architecture in bytes. */
974 extern int gdbarch_max_insn_length_p (struct gdbarch *gdbarch);
976 extern ULONGEST gdbarch_max_insn_length (struct gdbarch *gdbarch);
977 extern void set_gdbarch_max_insn_length (struct gdbarch *gdbarch, ULONGEST max_insn_length);
979 /* Copy the instruction at FROM to TO, and make any adjustments
980 necessary to single-step it at that address.
982 REGS holds the state the thread's registers will have before
983 executing the copied instruction; the PC in REGS will refer to FROM,
984 not the copy at TO. The caller should update it to point at TO later.
986 Return a pointer to data of the architecture's choice to be passed
987 to gdbarch_displaced_step_fixup. Or, return NULL to indicate that
988 the instruction's effects have been completely simulated, with the
989 resulting state written back to REGS.
991 For a general explanation of displaced stepping and how GDB uses it,
992 see the comments in infrun.c.
994 The TO area is only guaranteed to have space for
995 gdbarch_max_insn_length (arch) bytes, so this function must not
996 write more bytes than that to that area.
998 If you do not provide this function, GDB assumes that the
999 architecture does not support displaced stepping.
1001 If the instruction cannot execute out of line, return NULL. The
1002 core falls back to stepping past the instruction in-line instead in
1005 extern int gdbarch_displaced_step_copy_insn_p (struct gdbarch *gdbarch);
1007 typedef struct displaced_step_closure * (gdbarch_displaced_step_copy_insn_ftype) (struct gdbarch *gdbarch, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
1008 extern struct displaced_step_closure * gdbarch_displaced_step_copy_insn (struct gdbarch *gdbarch, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
1009 extern void set_gdbarch_displaced_step_copy_insn (struct gdbarch *gdbarch, gdbarch_displaced_step_copy_insn_ftype *displaced_step_copy_insn);
1011 /* Return true if GDB should use hardware single-stepping to execute
1012 the displaced instruction identified by CLOSURE. If false,
1013 GDB will simply restart execution at the displaced instruction
1014 location, and it is up to the target to ensure GDB will receive
1015 control again (e.g. by placing a software breakpoint instruction
1016 into the displaced instruction buffer).
1018 The default implementation returns false on all targets that
1019 provide a gdbarch_software_single_step routine, and true otherwise. */
1021 typedef int (gdbarch_displaced_step_hw_singlestep_ftype) (struct gdbarch *gdbarch, struct displaced_step_closure *closure);
1022 extern int gdbarch_displaced_step_hw_singlestep (struct gdbarch *gdbarch, struct displaced_step_closure *closure);
1023 extern void set_gdbarch_displaced_step_hw_singlestep (struct gdbarch *gdbarch, gdbarch_displaced_step_hw_singlestep_ftype *displaced_step_hw_singlestep);
1025 /* Fix up the state resulting from successfully single-stepping a
1026 displaced instruction, to give the result we would have gotten from
1027 stepping the instruction in its original location.
1029 REGS is the register state resulting from single-stepping the
1030 displaced instruction.
1032 CLOSURE is the result from the matching call to
1033 gdbarch_displaced_step_copy_insn.
1035 If you provide gdbarch_displaced_step_copy_insn.but not this
1036 function, then GDB assumes that no fixup is needed after
1037 single-stepping the instruction.
1039 For a general explanation of displaced stepping and how GDB uses it,
1040 see the comments in infrun.c. */
1042 extern int gdbarch_displaced_step_fixup_p (struct gdbarch *gdbarch);
1044 typedef void (gdbarch_displaced_step_fixup_ftype) (struct gdbarch *gdbarch, struct displaced_step_closure *closure, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
1045 extern void gdbarch_displaced_step_fixup (struct gdbarch *gdbarch, struct displaced_step_closure *closure, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
1046 extern void set_gdbarch_displaced_step_fixup (struct gdbarch *gdbarch, gdbarch_displaced_step_fixup_ftype *displaced_step_fixup);
1048 /* Return the address of an appropriate place to put displaced
1049 instructions while we step over them. There need only be one such
1050 place, since we're only stepping one thread over a breakpoint at a
1053 For a general explanation of displaced stepping and how GDB uses it,
1054 see the comments in infrun.c. */
1056 typedef CORE_ADDR (gdbarch_displaced_step_location_ftype) (struct gdbarch *gdbarch);
1057 extern CORE_ADDR gdbarch_displaced_step_location (struct gdbarch *gdbarch);
1058 extern void set_gdbarch_displaced_step_location (struct gdbarch *gdbarch, gdbarch_displaced_step_location_ftype *displaced_step_location);
1060 /* Relocate an instruction to execute at a different address. OLDLOC
1061 is the address in the inferior memory where the instruction to
1062 relocate is currently at. On input, TO points to the destination
1063 where we want the instruction to be copied (and possibly adjusted)
1064 to. On output, it points to one past the end of the resulting
1065 instruction(s). The effect of executing the instruction at TO shall
1066 be the same as if executing it at FROM. For example, call
1067 instructions that implicitly push the return address on the stack
1068 should be adjusted to return to the instruction after OLDLOC;
1069 relative branches, and other PC-relative instructions need the
1070 offset adjusted; etc. */
1072 extern int gdbarch_relocate_instruction_p (struct gdbarch *gdbarch);
1074 typedef void (gdbarch_relocate_instruction_ftype) (struct gdbarch *gdbarch, CORE_ADDR *to, CORE_ADDR from);
1075 extern void gdbarch_relocate_instruction (struct gdbarch *gdbarch, CORE_ADDR *to, CORE_ADDR from);
1076 extern void set_gdbarch_relocate_instruction (struct gdbarch *gdbarch, gdbarch_relocate_instruction_ftype *relocate_instruction);
1078 /* Refresh overlay mapped state for section OSECT. */
1080 extern int gdbarch_overlay_update_p (struct gdbarch *gdbarch);
1082 typedef void (gdbarch_overlay_update_ftype) (struct obj_section *osect);
1083 extern void gdbarch_overlay_update (struct gdbarch *gdbarch, struct obj_section *osect);
1084 extern void set_gdbarch_overlay_update (struct gdbarch *gdbarch, gdbarch_overlay_update_ftype *overlay_update);
1086 extern int gdbarch_core_read_description_p (struct gdbarch *gdbarch);
1088 typedef const struct target_desc * (gdbarch_core_read_description_ftype) (struct gdbarch *gdbarch, struct target_ops *target, bfd *abfd);
1089 extern const struct target_desc * gdbarch_core_read_description (struct gdbarch *gdbarch, struct target_ops *target, bfd *abfd);
1090 extern void set_gdbarch_core_read_description (struct gdbarch *gdbarch, gdbarch_core_read_description_ftype *core_read_description);
1092 /* Handle special encoding of static variables in stabs debug info. */
1094 extern int gdbarch_static_transform_name_p (struct gdbarch *gdbarch);
1096 typedef const char * (gdbarch_static_transform_name_ftype) (const char *name);
1097 extern const char * gdbarch_static_transform_name (struct gdbarch *gdbarch, const char *name);
1098 extern void set_gdbarch_static_transform_name (struct gdbarch *gdbarch, gdbarch_static_transform_name_ftype *static_transform_name);
1100 /* Set if the address in N_SO or N_FUN stabs may be zero. */
1102 extern int gdbarch_sofun_address_maybe_missing (struct gdbarch *gdbarch);
1103 extern void set_gdbarch_sofun_address_maybe_missing (struct gdbarch *gdbarch, int sofun_address_maybe_missing);
1105 /* Parse the instruction at ADDR storing in the record execution log
1106 the registers REGCACHE and memory ranges that will be affected when
1107 the instruction executes, along with their current values.
1108 Return -1 if something goes wrong, 0 otherwise. */
1110 extern int gdbarch_process_record_p (struct gdbarch *gdbarch);
1112 typedef int (gdbarch_process_record_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr);
1113 extern int gdbarch_process_record (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr);
1114 extern void set_gdbarch_process_record (struct gdbarch *gdbarch, gdbarch_process_record_ftype *process_record);
1116 /* Save process state after a signal.
1117 Return -1 if something goes wrong, 0 otherwise. */
1119 extern int gdbarch_process_record_signal_p (struct gdbarch *gdbarch);
1121 typedef int (gdbarch_process_record_signal_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, enum gdb_signal signal);
1122 extern int gdbarch_process_record_signal (struct gdbarch *gdbarch, struct regcache *regcache, enum gdb_signal signal);
1123 extern void set_gdbarch_process_record_signal (struct gdbarch *gdbarch, gdbarch_process_record_signal_ftype *process_record_signal);
1125 /* Signal translation: translate inferior's signal (target's) number
1126 into GDB's representation. The implementation of this method must
1127 be host independent. IOW, don't rely on symbols of the NAT_FILE
1128 header (the nm-*.h files), the host <signal.h> header, or similar
1129 headers. This is mainly used when cross-debugging core files ---
1130 "Live" targets hide the translation behind the target interface
1131 (target_wait, target_resume, etc.). */
1133 extern int gdbarch_gdb_signal_from_target_p (struct gdbarch *gdbarch);
1135 typedef enum gdb_signal (gdbarch_gdb_signal_from_target_ftype) (struct gdbarch *gdbarch, int signo);
1136 extern enum gdb_signal gdbarch_gdb_signal_from_target (struct gdbarch *gdbarch, int signo);
1137 extern void set_gdbarch_gdb_signal_from_target (struct gdbarch *gdbarch, gdbarch_gdb_signal_from_target_ftype *gdb_signal_from_target);
1139 /* Signal translation: translate the GDB's internal signal number into
1140 the inferior's signal (target's) representation. The implementation
1141 of this method must be host independent. IOW, don't rely on symbols
1142 of the NAT_FILE header (the nm-*.h files), the host <signal.h>
1143 header, or similar headers.
1144 Return the target signal number if found, or -1 if the GDB internal
1145 signal number is invalid. */
1147 extern int gdbarch_gdb_signal_to_target_p (struct gdbarch *gdbarch);
1149 typedef int (gdbarch_gdb_signal_to_target_ftype) (struct gdbarch *gdbarch, enum gdb_signal signal);
1150 extern int gdbarch_gdb_signal_to_target (struct gdbarch *gdbarch, enum gdb_signal signal);
1151 extern void set_gdbarch_gdb_signal_to_target (struct gdbarch *gdbarch, gdbarch_gdb_signal_to_target_ftype *gdb_signal_to_target);
1153 /* Extra signal info inspection.
1155 Return a type suitable to inspect extra signal information. */
1157 extern int gdbarch_get_siginfo_type_p (struct gdbarch *gdbarch);
1159 typedef struct type * (gdbarch_get_siginfo_type_ftype) (struct gdbarch *gdbarch);
1160 extern struct type * gdbarch_get_siginfo_type (struct gdbarch *gdbarch);
1161 extern void set_gdbarch_get_siginfo_type (struct gdbarch *gdbarch, gdbarch_get_siginfo_type_ftype *get_siginfo_type);
1163 /* Record architecture-specific information from the symbol table. */
1165 extern int gdbarch_record_special_symbol_p (struct gdbarch *gdbarch);
1167 typedef void (gdbarch_record_special_symbol_ftype) (struct gdbarch *gdbarch, struct objfile *objfile, asymbol *sym);
1168 extern void gdbarch_record_special_symbol (struct gdbarch *gdbarch, struct objfile *objfile, asymbol *sym);
1169 extern void set_gdbarch_record_special_symbol (struct gdbarch *gdbarch, gdbarch_record_special_symbol_ftype *record_special_symbol);
1171 /* Function for the 'catch syscall' feature.
1172 Get architecture-specific system calls information from registers. */
1174 extern int gdbarch_get_syscall_number_p (struct gdbarch *gdbarch);
1176 typedef LONGEST (gdbarch_get_syscall_number_ftype) (struct gdbarch *gdbarch, ptid_t ptid);
1177 extern LONGEST gdbarch_get_syscall_number (struct gdbarch *gdbarch, ptid_t ptid);
1178 extern void set_gdbarch_get_syscall_number (struct gdbarch *gdbarch, gdbarch_get_syscall_number_ftype *get_syscall_number);
1180 /* The filename of the XML syscall for this architecture. */
1182 extern const char * gdbarch_xml_syscall_file (struct gdbarch *gdbarch);
1183 extern void set_gdbarch_xml_syscall_file (struct gdbarch *gdbarch, const char * xml_syscall_file);
1185 /* Information about system calls from this architecture */
1187 extern struct syscalls_info * gdbarch_syscalls_info (struct gdbarch *gdbarch);
1188 extern void set_gdbarch_syscalls_info (struct gdbarch *gdbarch, struct syscalls_info * syscalls_info);
1190 /* SystemTap related fields and functions.
1191 A NULL-terminated array of prefixes used to mark an integer constant
1192 on the architecture's assembly.
1193 For example, on x86 integer constants are written as:
1195 $10 ;; integer constant 10
1197 in this case, this prefix would be the character `$'. */
1199 extern const char *const * gdbarch_stap_integer_prefixes (struct gdbarch *gdbarch);
1200 extern void set_gdbarch_stap_integer_prefixes (struct gdbarch *gdbarch, const char *const * stap_integer_prefixes);
1202 /* A NULL-terminated array of suffixes used to mark an integer constant
1203 on the architecture's assembly. */
1205 extern const char *const * gdbarch_stap_integer_suffixes (struct gdbarch *gdbarch);
1206 extern void set_gdbarch_stap_integer_suffixes (struct gdbarch *gdbarch, const char *const * stap_integer_suffixes);
1208 /* A NULL-terminated array of prefixes used to mark a register name on
1209 the architecture's assembly.
1210 For example, on x86 the register name is written as:
1212 %eax ;; register eax
1214 in this case, this prefix would be the character `%'. */
1216 extern const char *const * gdbarch_stap_register_prefixes (struct gdbarch *gdbarch);
1217 extern void set_gdbarch_stap_register_prefixes (struct gdbarch *gdbarch, const char *const * stap_register_prefixes);
1219 /* A NULL-terminated array of suffixes used to mark a register name on
1220 the architecture's assembly. */
1222 extern const char *const * gdbarch_stap_register_suffixes (struct gdbarch *gdbarch);
1223 extern void set_gdbarch_stap_register_suffixes (struct gdbarch *gdbarch, const char *const * stap_register_suffixes);
1225 /* A NULL-terminated array of prefixes used to mark a register
1226 indirection on the architecture's assembly.
1227 For example, on x86 the register indirection is written as:
1229 (%eax) ;; indirecting eax
1231 in this case, this prefix would be the charater `('.
1233 Please note that we use the indirection prefix also for register
1234 displacement, e.g., `4(%eax)' on x86. */
1236 extern const char *const * gdbarch_stap_register_indirection_prefixes (struct gdbarch *gdbarch);
1237 extern void set_gdbarch_stap_register_indirection_prefixes (struct gdbarch *gdbarch, const char *const * stap_register_indirection_prefixes);
1239 /* A NULL-terminated array of suffixes used to mark a register
1240 indirection on the architecture's assembly.
1241 For example, on x86 the register indirection is written as:
1243 (%eax) ;; indirecting eax
1245 in this case, this prefix would be the charater `)'.
1247 Please note that we use the indirection suffix also for register
1248 displacement, e.g., `4(%eax)' on x86. */
1250 extern const char *const * gdbarch_stap_register_indirection_suffixes (struct gdbarch *gdbarch);
1251 extern void set_gdbarch_stap_register_indirection_suffixes (struct gdbarch *gdbarch, const char *const * stap_register_indirection_suffixes);
1253 /* Prefix(es) used to name a register using GDB's nomenclature.
1255 For example, on PPC a register is represented by a number in the assembly
1256 language (e.g., `10' is the 10th general-purpose register). However,
1257 inside GDB this same register has an `r' appended to its name, so the 10th
1258 register would be represented as `r10' internally. */
1260 extern const char * gdbarch_stap_gdb_register_prefix (struct gdbarch *gdbarch);
1261 extern void set_gdbarch_stap_gdb_register_prefix (struct gdbarch *gdbarch, const char * stap_gdb_register_prefix);
1263 /* Suffix used to name a register using GDB's nomenclature. */
1265 extern const char * gdbarch_stap_gdb_register_suffix (struct gdbarch *gdbarch);
1266 extern void set_gdbarch_stap_gdb_register_suffix (struct gdbarch *gdbarch, const char * stap_gdb_register_suffix);
1268 /* Check if S is a single operand.
1270 Single operands can be:
1271 - Literal integers, e.g. `$10' on x86
1272 - Register access, e.g. `%eax' on x86
1273 - Register indirection, e.g. `(%eax)' on x86
1274 - Register displacement, e.g. `4(%eax)' on x86
1276 This function should check for these patterns on the string
1277 and return 1 if some were found, or zero otherwise. Please try to match
1278 as much info as you can from the string, i.e., if you have to match
1279 something like `(%', do not match just the `('. */
1281 extern int gdbarch_stap_is_single_operand_p (struct gdbarch *gdbarch);
1283 typedef int (gdbarch_stap_is_single_operand_ftype) (struct gdbarch *gdbarch, const char *s);
1284 extern int gdbarch_stap_is_single_operand (struct gdbarch *gdbarch, const char *s);
1285 extern void set_gdbarch_stap_is_single_operand (struct gdbarch *gdbarch, gdbarch_stap_is_single_operand_ftype *stap_is_single_operand);
1287 /* Function used to handle a "special case" in the parser.
1289 A "special case" is considered to be an unknown token, i.e., a token
1290 that the parser does not know how to parse. A good example of special
1291 case would be ARM's register displacement syntax:
1293 [R0, #4] ;; displacing R0 by 4
1295 Since the parser assumes that a register displacement is of the form:
1297 <number> <indirection_prefix> <register_name> <indirection_suffix>
1299 it means that it will not be able to recognize and parse this odd syntax.
1300 Therefore, we should add a special case function that will handle this token.
1302 This function should generate the proper expression form of the expression
1303 using GDB's internal expression mechanism (e.g., `write_exp_elt_opcode'
1304 and so on). It should also return 1 if the parsing was successful, or zero
1305 if the token was not recognized as a special token (in this case, returning
1306 zero means that the special parser is deferring the parsing to the generic
1307 parser), and should advance the buffer pointer (p->arg). */
1309 extern int gdbarch_stap_parse_special_token_p (struct gdbarch *gdbarch);
1311 typedef int (gdbarch_stap_parse_special_token_ftype) (struct gdbarch *gdbarch, struct stap_parse_info *p);
1312 extern int gdbarch_stap_parse_special_token (struct gdbarch *gdbarch, struct stap_parse_info *p);
1313 extern void set_gdbarch_stap_parse_special_token (struct gdbarch *gdbarch, gdbarch_stap_parse_special_token_ftype *stap_parse_special_token);
1315 /* DTrace related functions.
1316 The expression to compute the NARTGth+1 argument to a DTrace USDT probe.
1317 NARG must be >= 0. */
1319 extern int gdbarch_dtrace_parse_probe_argument_p (struct gdbarch *gdbarch);
1321 typedef void (gdbarch_dtrace_parse_probe_argument_ftype) (struct gdbarch *gdbarch, struct parser_state *pstate, int narg);
1322 extern void gdbarch_dtrace_parse_probe_argument (struct gdbarch *gdbarch, struct parser_state *pstate, int narg);
1323 extern void set_gdbarch_dtrace_parse_probe_argument (struct gdbarch *gdbarch, gdbarch_dtrace_parse_probe_argument_ftype *dtrace_parse_probe_argument);
1325 /* True if the given ADDR does not contain the instruction sequence
1326 corresponding to a disabled DTrace is-enabled probe. */
1328 extern int gdbarch_dtrace_probe_is_enabled_p (struct gdbarch *gdbarch);
1330 typedef int (gdbarch_dtrace_probe_is_enabled_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
1331 extern int gdbarch_dtrace_probe_is_enabled (struct gdbarch *gdbarch, CORE_ADDR addr);
1332 extern void set_gdbarch_dtrace_probe_is_enabled (struct gdbarch *gdbarch, gdbarch_dtrace_probe_is_enabled_ftype *dtrace_probe_is_enabled);
1334 /* Enable a DTrace is-enabled probe at ADDR. */
1336 extern int gdbarch_dtrace_enable_probe_p (struct gdbarch *gdbarch);
1338 typedef void (gdbarch_dtrace_enable_probe_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
1339 extern void gdbarch_dtrace_enable_probe (struct gdbarch *gdbarch, CORE_ADDR addr);
1340 extern void set_gdbarch_dtrace_enable_probe (struct gdbarch *gdbarch, gdbarch_dtrace_enable_probe_ftype *dtrace_enable_probe);
1342 /* Disable a DTrace is-enabled probe at ADDR. */
1344 extern int gdbarch_dtrace_disable_probe_p (struct gdbarch *gdbarch);
1346 typedef void (gdbarch_dtrace_disable_probe_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
1347 extern void gdbarch_dtrace_disable_probe (struct gdbarch *gdbarch, CORE_ADDR addr);
1348 extern void set_gdbarch_dtrace_disable_probe (struct gdbarch *gdbarch, gdbarch_dtrace_disable_probe_ftype *dtrace_disable_probe);
1350 /* True if the list of shared libraries is one and only for all
1351 processes, as opposed to a list of shared libraries per inferior.
1352 This usually means that all processes, although may or may not share
1353 an address space, will see the same set of symbols at the same
1356 extern int gdbarch_has_global_solist (struct gdbarch *gdbarch);
1357 extern void set_gdbarch_has_global_solist (struct gdbarch *gdbarch, int has_global_solist);
1359 /* On some targets, even though each inferior has its own private
1360 address space, the debug interface takes care of making breakpoints
1361 visible to all address spaces automatically. For such cases,
1362 this property should be set to true. */
1364 extern int gdbarch_has_global_breakpoints (struct gdbarch *gdbarch);
1365 extern void set_gdbarch_has_global_breakpoints (struct gdbarch *gdbarch, int has_global_breakpoints);
1367 /* True if inferiors share an address space (e.g., uClinux). */
1369 typedef int (gdbarch_has_shared_address_space_ftype) (struct gdbarch *gdbarch);
1370 extern int gdbarch_has_shared_address_space (struct gdbarch *gdbarch);
1371 extern void set_gdbarch_has_shared_address_space (struct gdbarch *gdbarch, gdbarch_has_shared_address_space_ftype *has_shared_address_space);
1373 /* True if a fast tracepoint can be set at an address. */
1375 typedef int (gdbarch_fast_tracepoint_valid_at_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr, std::string *msg);
1376 extern int gdbarch_fast_tracepoint_valid_at (struct gdbarch *gdbarch, CORE_ADDR addr, std::string *msg);
1377 extern void set_gdbarch_fast_tracepoint_valid_at (struct gdbarch *gdbarch, gdbarch_fast_tracepoint_valid_at_ftype *fast_tracepoint_valid_at);
1379 /* Guess register state based on tracepoint location. Used for tracepoints
1380 where no registers have been collected, but there's only one location,
1381 allowing us to guess the PC value, and perhaps some other registers.
1382 On entry, regcache has all registers marked as unavailable. */
1384 typedef void (gdbarch_guess_tracepoint_registers_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr);
1385 extern void gdbarch_guess_tracepoint_registers (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr);
1386 extern void set_gdbarch_guess_tracepoint_registers (struct gdbarch *gdbarch, gdbarch_guess_tracepoint_registers_ftype *guess_tracepoint_registers);
1388 /* Return the "auto" target charset. */
1390 typedef const char * (gdbarch_auto_charset_ftype) (void);
1391 extern const char * gdbarch_auto_charset (struct gdbarch *gdbarch);
1392 extern void set_gdbarch_auto_charset (struct gdbarch *gdbarch, gdbarch_auto_charset_ftype *auto_charset);
1394 /* Return the "auto" target wide charset. */
1396 typedef const char * (gdbarch_auto_wide_charset_ftype) (void);
1397 extern const char * gdbarch_auto_wide_charset (struct gdbarch *gdbarch);
1398 extern void set_gdbarch_auto_wide_charset (struct gdbarch *gdbarch, gdbarch_auto_wide_charset_ftype *auto_wide_charset);
1400 /* If non-empty, this is a file extension that will be opened in place
1401 of the file extension reported by the shared library list.
1403 This is most useful for toolchains that use a post-linker tool,
1404 where the names of the files run on the target differ in extension
1405 compared to the names of the files GDB should load for debug info. */
1407 extern const char * gdbarch_solib_symbols_extension (struct gdbarch *gdbarch);
1408 extern void set_gdbarch_solib_symbols_extension (struct gdbarch *gdbarch, const char * solib_symbols_extension);
1410 /* If true, the target OS has DOS-based file system semantics. That
1411 is, absolute paths include a drive name, and the backslash is
1412 considered a directory separator. */
1414 extern int gdbarch_has_dos_based_file_system (struct gdbarch *gdbarch);
1415 extern void set_gdbarch_has_dos_based_file_system (struct gdbarch *gdbarch, int has_dos_based_file_system);
1417 /* Generate bytecodes to collect the return address in a frame.
1418 Since the bytecodes run on the target, possibly with GDB not even
1419 connected, the full unwinding machinery is not available, and
1420 typically this function will issue bytecodes for one or more likely
1421 places that the return address may be found. */
1423 typedef void (gdbarch_gen_return_address_ftype) (struct gdbarch *gdbarch, struct agent_expr *ax, struct axs_value *value, CORE_ADDR scope);
1424 extern void gdbarch_gen_return_address (struct gdbarch *gdbarch, struct agent_expr *ax, struct axs_value *value, CORE_ADDR scope);
1425 extern void set_gdbarch_gen_return_address (struct gdbarch *gdbarch, gdbarch_gen_return_address_ftype *gen_return_address);
1427 /* Implement the "info proc" command. */
1429 extern int gdbarch_info_proc_p (struct gdbarch *gdbarch);
1431 typedef void (gdbarch_info_proc_ftype) (struct gdbarch *gdbarch, const char *args, enum info_proc_what what);
1432 extern void gdbarch_info_proc (struct gdbarch *gdbarch, const char *args, enum info_proc_what what);
1433 extern void set_gdbarch_info_proc (struct gdbarch *gdbarch, gdbarch_info_proc_ftype *info_proc);
1435 /* Implement the "info proc" command for core files. Noe that there
1436 are two "info_proc"-like methods on gdbarch -- one for core files,
1437 one for live targets. */
1439 extern int gdbarch_core_info_proc_p (struct gdbarch *gdbarch);
1441 typedef void (gdbarch_core_info_proc_ftype) (struct gdbarch *gdbarch, const char *args, enum info_proc_what what);
1442 extern void gdbarch_core_info_proc (struct gdbarch *gdbarch, const char *args, enum info_proc_what what);
1443 extern void set_gdbarch_core_info_proc (struct gdbarch *gdbarch, gdbarch_core_info_proc_ftype *core_info_proc);
1445 /* Iterate over all objfiles in the order that makes the most sense
1446 for the architecture to make global symbol searches.
1448 CB is a callback function where OBJFILE is the objfile to be searched,
1449 and CB_DATA a pointer to user-defined data (the same data that is passed
1450 when calling this gdbarch method). The iteration stops if this function
1453 CB_DATA is a pointer to some user-defined data to be passed to
1456 If not NULL, CURRENT_OBJFILE corresponds to the objfile being
1457 inspected when the symbol search was requested. */
1459 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);
1460 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);
1461 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);
1463 /* Ravenscar arch-dependent ops. */
1465 extern struct ravenscar_arch_ops * gdbarch_ravenscar_ops (struct gdbarch *gdbarch);
1466 extern void set_gdbarch_ravenscar_ops (struct gdbarch *gdbarch, struct ravenscar_arch_ops * ravenscar_ops);
1468 /* Return non-zero if the instruction at ADDR is a call; zero otherwise. */
1470 typedef int (gdbarch_insn_is_call_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
1471 extern int gdbarch_insn_is_call (struct gdbarch *gdbarch, CORE_ADDR addr);
1472 extern void set_gdbarch_insn_is_call (struct gdbarch *gdbarch, gdbarch_insn_is_call_ftype *insn_is_call);
1474 /* Return non-zero if the instruction at ADDR is a return; zero otherwise. */
1476 typedef int (gdbarch_insn_is_ret_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
1477 extern int gdbarch_insn_is_ret (struct gdbarch *gdbarch, CORE_ADDR addr);
1478 extern void set_gdbarch_insn_is_ret (struct gdbarch *gdbarch, gdbarch_insn_is_ret_ftype *insn_is_ret);
1480 /* Return non-zero if the instruction at ADDR is a jump; zero otherwise. */
1482 typedef int (gdbarch_insn_is_jump_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
1483 extern int gdbarch_insn_is_jump (struct gdbarch *gdbarch, CORE_ADDR addr);
1484 extern void set_gdbarch_insn_is_jump (struct gdbarch *gdbarch, gdbarch_insn_is_jump_ftype *insn_is_jump);
1486 /* Read one auxv entry from *READPTR, not reading locations >= ENDPTR.
1487 Return 0 if *READPTR is already at the end of the buffer.
1488 Return -1 if there is insufficient buffer for a whole entry.
1489 Return 1 if an entry was read into *TYPEP and *VALP. */
1491 extern int gdbarch_auxv_parse_p (struct gdbarch *gdbarch);
1493 typedef int (gdbarch_auxv_parse_ftype) (struct gdbarch *gdbarch, gdb_byte **readptr, gdb_byte *endptr, CORE_ADDR *typep, CORE_ADDR *valp);
1494 extern int gdbarch_auxv_parse (struct gdbarch *gdbarch, gdb_byte **readptr, gdb_byte *endptr, CORE_ADDR *typep, CORE_ADDR *valp);
1495 extern void set_gdbarch_auxv_parse (struct gdbarch *gdbarch, gdbarch_auxv_parse_ftype *auxv_parse);
1497 /* Print the description of a single auxv entry described by TYPE and VAL
1500 typedef void (gdbarch_print_auxv_entry_ftype) (struct gdbarch *gdbarch, struct ui_file *file, CORE_ADDR type, CORE_ADDR val);
1501 extern void gdbarch_print_auxv_entry (struct gdbarch *gdbarch, struct ui_file *file, CORE_ADDR type, CORE_ADDR val);
1502 extern void set_gdbarch_print_auxv_entry (struct gdbarch *gdbarch, gdbarch_print_auxv_entry_ftype *print_auxv_entry);
1504 /* Find the address range of the current inferior's vsyscall/vDSO, and
1505 write it to *RANGE. If the vsyscall's length can't be determined, a
1506 range with zero length is returned. Returns true if the vsyscall is
1507 found, false otherwise. */
1509 typedef int (gdbarch_vsyscall_range_ftype) (struct gdbarch *gdbarch, struct mem_range *range);
1510 extern int gdbarch_vsyscall_range (struct gdbarch *gdbarch, struct mem_range *range);
1511 extern void set_gdbarch_vsyscall_range (struct gdbarch *gdbarch, gdbarch_vsyscall_range_ftype *vsyscall_range);
1513 /* Allocate SIZE bytes of PROT protected page aligned memory in inferior.
1514 PROT has GDB_MMAP_PROT_* bitmask format.
1515 Throw an error if it is not possible. Returned address is always valid. */
1517 typedef CORE_ADDR (gdbarch_infcall_mmap_ftype) (CORE_ADDR size, unsigned prot);
1518 extern CORE_ADDR gdbarch_infcall_mmap (struct gdbarch *gdbarch, CORE_ADDR size, unsigned prot);
1519 extern void set_gdbarch_infcall_mmap (struct gdbarch *gdbarch, gdbarch_infcall_mmap_ftype *infcall_mmap);
1521 /* Deallocate SIZE bytes of memory at ADDR in inferior from gdbarch_infcall_mmap.
1522 Print a warning if it is not possible. */
1524 typedef void (gdbarch_infcall_munmap_ftype) (CORE_ADDR addr, CORE_ADDR size);
1525 extern void gdbarch_infcall_munmap (struct gdbarch *gdbarch, CORE_ADDR addr, CORE_ADDR size);
1526 extern void set_gdbarch_infcall_munmap (struct gdbarch *gdbarch, gdbarch_infcall_munmap_ftype *infcall_munmap);
1528 /* Return string (caller has to use xfree for it) with options for GCC
1529 to produce code for this target, typically "-m64", "-m32" or "-m31".
1530 These options are put before CU's DW_AT_producer compilation options so that
1531 they can override it. Method may also return NULL. */
1533 typedef char * (gdbarch_gcc_target_options_ftype) (struct gdbarch *gdbarch);
1534 extern char * gdbarch_gcc_target_options (struct gdbarch *gdbarch);
1535 extern void set_gdbarch_gcc_target_options (struct gdbarch *gdbarch, gdbarch_gcc_target_options_ftype *gcc_target_options);
1537 /* Return a regular expression that matches names used by this
1538 architecture in GNU configury triplets. The result is statically
1539 allocated and must not be freed. The default implementation simply
1540 returns the BFD architecture name, which is correct in nearly every
1543 typedef const char * (gdbarch_gnu_triplet_regexp_ftype) (struct gdbarch *gdbarch);
1544 extern const char * gdbarch_gnu_triplet_regexp (struct gdbarch *gdbarch);
1545 extern void set_gdbarch_gnu_triplet_regexp (struct gdbarch *gdbarch, gdbarch_gnu_triplet_regexp_ftype *gnu_triplet_regexp);
1547 /* Return the size in 8-bit bytes of an addressable memory unit on this
1548 architecture. This corresponds to the number of 8-bit bytes associated to
1549 each address in memory. */
1551 typedef int (gdbarch_addressable_memory_unit_size_ftype) (struct gdbarch *gdbarch);
1552 extern int gdbarch_addressable_memory_unit_size (struct gdbarch *gdbarch);
1553 extern void set_gdbarch_addressable_memory_unit_size (struct gdbarch *gdbarch, gdbarch_addressable_memory_unit_size_ftype *addressable_memory_unit_size);
1555 /* Functions for allowing a target to modify its disassembler options. */
1557 extern char ** gdbarch_disassembler_options (struct gdbarch *gdbarch);
1558 extern void set_gdbarch_disassembler_options (struct gdbarch *gdbarch, char ** disassembler_options);
1560 extern const disasm_options_t * gdbarch_valid_disassembler_options (struct gdbarch *gdbarch);
1561 extern void set_gdbarch_valid_disassembler_options (struct gdbarch *gdbarch, const disasm_options_t * valid_disassembler_options);
1563 /* Type alignment. */
1565 typedef ULONGEST (gdbarch_type_align_ftype) (struct gdbarch *gdbarch, struct type *type);
1566 extern ULONGEST gdbarch_type_align (struct gdbarch *gdbarch, struct type *type);
1567 extern void set_gdbarch_type_align (struct gdbarch *gdbarch, gdbarch_type_align_ftype *type_align);
1569 /* Definition for an unknown syscall, used basically in error-cases. */
1570 #define UNKNOWN_SYSCALL (-1)
1572 extern struct gdbarch_tdep *gdbarch_tdep (struct gdbarch *gdbarch);
1575 /* Mechanism for co-ordinating the selection of a specific
1578 GDB targets (*-tdep.c) can register an interest in a specific
1579 architecture. Other GDB components can register a need to maintain
1580 per-architecture data.
1582 The mechanisms below ensures that there is only a loose connection
1583 between the set-architecture command and the various GDB
1584 components. Each component can independently register their need
1585 to maintain architecture specific data with gdbarch.
1589 Previously, a single TARGET_ARCHITECTURE_HOOK was provided. It
1592 The more traditional mega-struct containing architecture specific
1593 data for all the various GDB components was also considered. Since
1594 GDB is built from a variable number of (fairly independent)
1595 components it was determined that the global aproach was not
1599 /* Register a new architectural family with GDB.
1601 Register support for the specified ARCHITECTURE with GDB. When
1602 gdbarch determines that the specified architecture has been
1603 selected, the corresponding INIT function is called.
1607 The INIT function takes two parameters: INFO which contains the
1608 information available to gdbarch about the (possibly new)
1609 architecture; ARCHES which is a list of the previously created
1610 ``struct gdbarch'' for this architecture.
1612 The INFO parameter is, as far as possible, be pre-initialized with
1613 information obtained from INFO.ABFD or the global defaults.
1615 The ARCHES parameter is a linked list (sorted most recently used)
1616 of all the previously created architures for this architecture
1617 family. The (possibly NULL) ARCHES->gdbarch can used to access
1618 values from the previously selected architecture for this
1619 architecture family.
1621 The INIT function shall return any of: NULL - indicating that it
1622 doesn't recognize the selected architecture; an existing ``struct
1623 gdbarch'' from the ARCHES list - indicating that the new
1624 architecture is just a synonym for an earlier architecture (see
1625 gdbarch_list_lookup_by_info()); a newly created ``struct gdbarch''
1626 - that describes the selected architecture (see gdbarch_alloc()).
1628 The DUMP_TDEP function shall print out all target specific values.
1629 Care should be taken to ensure that the function works in both the
1630 multi-arch and non- multi-arch cases. */
1634 struct gdbarch *gdbarch;
1635 struct gdbarch_list *next;
1640 /* Use default: NULL (ZERO). */
1641 const struct bfd_arch_info *bfd_arch_info;
1643 /* Use default: BFD_ENDIAN_UNKNOWN (NB: is not ZERO). */
1644 enum bfd_endian byte_order;
1646 enum bfd_endian byte_order_for_code;
1648 /* Use default: NULL (ZERO). */
1651 /* Use default: NULL (ZERO). */
1654 /* Architecture-specific information. The generic form for targets
1655 that have extra requirements. */
1656 struct gdbarch_tdep_info *tdep_info;
1658 /* Architecture-specific target description data. Numerous targets
1659 need only this, so give them an easy way to hold it. */
1660 struct tdesc_arch_data *tdesc_data;
1662 /* SPU file system ID. This is a single integer, so using the
1663 generic form would only complicate code. Other targets may
1664 reuse this member if suitable. */
1668 /* Use default: GDB_OSABI_UNINITIALIZED (-1). */
1669 enum gdb_osabi osabi;
1671 /* Use default: NULL (ZERO). */
1672 const struct target_desc *target_desc;
1675 typedef struct gdbarch *(gdbarch_init_ftype) (struct gdbarch_info info, struct gdbarch_list *arches);
1676 typedef void (gdbarch_dump_tdep_ftype) (struct gdbarch *gdbarch, struct ui_file *file);
1678 /* DEPRECATED - use gdbarch_register() */
1679 extern void register_gdbarch_init (enum bfd_architecture architecture, gdbarch_init_ftype *);
1681 extern void gdbarch_register (enum bfd_architecture architecture,
1682 gdbarch_init_ftype *,
1683 gdbarch_dump_tdep_ftype *);
1686 /* Return a freshly allocated, NULL terminated, array of the valid
1687 architecture names. Since architectures are registered during the
1688 _initialize phase this function only returns useful information
1689 once initialization has been completed. */
1691 extern const char **gdbarch_printable_names (void);
1694 /* Helper function. Search the list of ARCHES for a GDBARCH that
1695 matches the information provided by INFO. */
1697 extern struct gdbarch_list *gdbarch_list_lookup_by_info (struct gdbarch_list *arches, const struct gdbarch_info *info);
1700 /* Helper function. Create a preliminary ``struct gdbarch''. Perform
1701 basic initialization using values obtained from the INFO and TDEP
1702 parameters. set_gdbarch_*() functions are called to complete the
1703 initialization of the object. */
1705 extern struct gdbarch *gdbarch_alloc (const struct gdbarch_info *info, struct gdbarch_tdep *tdep);
1708 /* Helper function. Free a partially-constructed ``struct gdbarch''.
1709 It is assumed that the caller freeds the ``struct
1712 extern void gdbarch_free (struct gdbarch *);
1715 /* Helper function. Allocate memory from the ``struct gdbarch''
1716 obstack. The memory is freed when the corresponding architecture
1719 extern void *gdbarch_obstack_zalloc (struct gdbarch *gdbarch, long size);
1720 #define GDBARCH_OBSTACK_CALLOC(GDBARCH, NR, TYPE) ((TYPE *) gdbarch_obstack_zalloc ((GDBARCH), (NR) * sizeof (TYPE)))
1721 #define GDBARCH_OBSTACK_ZALLOC(GDBARCH, TYPE) ((TYPE *) gdbarch_obstack_zalloc ((GDBARCH), sizeof (TYPE)))
1723 /* Duplicate STRING, returning an equivalent string that's allocated on the
1724 obstack associated with GDBARCH. The string is freed when the corresponding
1725 architecture is also freed. */
1727 extern char *gdbarch_obstack_strdup (struct gdbarch *arch, const char *string);
1729 /* Helper function. Force an update of the current architecture.
1731 The actual architecture selected is determined by INFO, ``(gdb) set
1732 architecture'' et.al., the existing architecture and BFD's default
1733 architecture. INFO should be initialized to zero and then selected
1734 fields should be updated.
1736 Returns non-zero if the update succeeds. */
1738 extern int gdbarch_update_p (struct gdbarch_info info);
1741 /* Helper function. Find an architecture matching info.
1743 INFO should be initialized using gdbarch_info_init, relevant fields
1744 set, and then finished using gdbarch_info_fill.
1746 Returns the corresponding architecture, or NULL if no matching
1747 architecture was found. */
1749 extern struct gdbarch *gdbarch_find_by_info (struct gdbarch_info info);
1752 /* Helper function. Set the target gdbarch to "gdbarch". */
1754 extern void set_target_gdbarch (struct gdbarch *gdbarch);
1757 /* Register per-architecture data-pointer.
1759 Reserve space for a per-architecture data-pointer. An identifier
1760 for the reserved data-pointer is returned. That identifer should
1761 be saved in a local static variable.
1763 Memory for the per-architecture data shall be allocated using
1764 gdbarch_obstack_zalloc. That memory will be deleted when the
1765 corresponding architecture object is deleted.
1767 When a previously created architecture is re-selected, the
1768 per-architecture data-pointer for that previous architecture is
1769 restored. INIT() is not re-called.
1771 Multiple registrarants for any architecture are allowed (and
1772 strongly encouraged). */
1774 struct gdbarch_data;
1776 typedef void *(gdbarch_data_pre_init_ftype) (struct obstack *obstack);
1777 extern struct gdbarch_data *gdbarch_data_register_pre_init (gdbarch_data_pre_init_ftype *init);
1778 typedef void *(gdbarch_data_post_init_ftype) (struct gdbarch *gdbarch);
1779 extern struct gdbarch_data *gdbarch_data_register_post_init (gdbarch_data_post_init_ftype *init);
1780 extern void deprecated_set_gdbarch_data (struct gdbarch *gdbarch,
1781 struct gdbarch_data *data,
1784 extern void *gdbarch_data (struct gdbarch *gdbarch, struct gdbarch_data *);
1787 /* Set the dynamic target-system-dependent parameters (architecture,
1788 byte-order, ...) using information found in the BFD. */
1790 extern void set_gdbarch_from_file (bfd *);
1793 /* Initialize the current architecture to the "first" one we find on
1796 extern void initialize_current_architecture (void);
1798 /* gdbarch trace variable */
1799 extern unsigned int gdbarch_debug;
1801 extern void gdbarch_dump (struct gdbarch *gdbarch, struct ui_file *file);