1 /* *INDENT-OFF* */ /* THIS FILE IS GENERATED -*- buffer-read-only: t -*- */
4 /* Dynamic architecture support for GDB, the GNU debugger.
6 Copyright (C) 1998-2016 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
45 struct minimal_symbol;
49 struct disassemble_info;
52 struct bp_target_info;
56 struct displaced_step_closure;
60 struct stap_parse_info;
62 struct ravenscar_arch_ops;
63 struct elf_internal_linux_prpsinfo;
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 char or unsigned char for the target machine.
130 Just like CHAR_BIT in <limits.h> but describes the target machine.
131 v:TARGET_CHAR_BIT:int:char_bit::::8 * sizeof (char):8::0:
133 Number of bits in a short or unsigned short for the target machine. */
135 extern int gdbarch_short_bit (struct gdbarch *gdbarch);
136 extern void set_gdbarch_short_bit (struct gdbarch *gdbarch, int short_bit);
138 /* Number of bits in an int or unsigned int for the target machine. */
140 extern int gdbarch_int_bit (struct gdbarch *gdbarch);
141 extern void set_gdbarch_int_bit (struct gdbarch *gdbarch, int int_bit);
143 /* Number of bits in a long or unsigned long for the target machine. */
145 extern int gdbarch_long_bit (struct gdbarch *gdbarch);
146 extern void set_gdbarch_long_bit (struct gdbarch *gdbarch, int long_bit);
148 /* Number of bits in a long long or unsigned long long for the target
151 extern int gdbarch_long_long_bit (struct gdbarch *gdbarch);
152 extern void set_gdbarch_long_long_bit (struct gdbarch *gdbarch, int long_long_bit);
154 /* Alignment of a long long or unsigned long long for the target
157 extern int gdbarch_long_long_align_bit (struct gdbarch *gdbarch);
158 extern void set_gdbarch_long_long_align_bit (struct gdbarch *gdbarch, int long_long_align_bit);
160 /* The ABI default bit-size and format for "half", "float", "double", and
161 "long double". These bit/format pairs should eventually be combined
162 into a single object. For the moment, just initialize them as a pair.
163 Each format describes both the big and little endian layouts (if
166 extern int gdbarch_half_bit (struct gdbarch *gdbarch);
167 extern void set_gdbarch_half_bit (struct gdbarch *gdbarch, int half_bit);
169 extern const struct floatformat ** gdbarch_half_format (struct gdbarch *gdbarch);
170 extern void set_gdbarch_half_format (struct gdbarch *gdbarch, const struct floatformat ** half_format);
172 extern int gdbarch_float_bit (struct gdbarch *gdbarch);
173 extern void set_gdbarch_float_bit (struct gdbarch *gdbarch, int float_bit);
175 extern const struct floatformat ** gdbarch_float_format (struct gdbarch *gdbarch);
176 extern void set_gdbarch_float_format (struct gdbarch *gdbarch, const struct floatformat ** float_format);
178 extern int gdbarch_double_bit (struct gdbarch *gdbarch);
179 extern void set_gdbarch_double_bit (struct gdbarch *gdbarch, int double_bit);
181 extern const struct floatformat ** gdbarch_double_format (struct gdbarch *gdbarch);
182 extern void set_gdbarch_double_format (struct gdbarch *gdbarch, const struct floatformat ** double_format);
184 extern int gdbarch_long_double_bit (struct gdbarch *gdbarch);
185 extern void set_gdbarch_long_double_bit (struct gdbarch *gdbarch, int long_double_bit);
187 extern const struct floatformat ** gdbarch_long_double_format (struct gdbarch *gdbarch);
188 extern void set_gdbarch_long_double_format (struct gdbarch *gdbarch, const struct floatformat ** long_double_format);
190 /* For most targets, a pointer on the target and its representation as an
191 address in GDB have the same size and "look the same". For such a
192 target, you need only set gdbarch_ptr_bit and gdbarch_addr_bit
193 / addr_bit will be set from it.
195 If gdbarch_ptr_bit and gdbarch_addr_bit are different, you'll probably
196 also need to set gdbarch_dwarf2_addr_size, gdbarch_pointer_to_address and
197 gdbarch_address_to_pointer as well.
199 ptr_bit is the size of a pointer on the target */
201 extern int gdbarch_ptr_bit (struct gdbarch *gdbarch);
202 extern void set_gdbarch_ptr_bit (struct gdbarch *gdbarch, int ptr_bit);
204 /* addr_bit is the size of a target address as represented in gdb */
206 extern int gdbarch_addr_bit (struct gdbarch *gdbarch);
207 extern void set_gdbarch_addr_bit (struct gdbarch *gdbarch, int addr_bit);
209 /* dwarf2_addr_size is the target address size as used in the Dwarf debug
210 info. For .debug_frame FDEs, this is supposed to be the target address
211 size from the associated CU header, and which is equivalent to the
212 DWARF2_ADDR_SIZE as defined by the target specific GCC back-end.
213 Unfortunately there is no good way to determine this value. Therefore
214 dwarf2_addr_size simply defaults to the target pointer size.
216 dwarf2_addr_size is not used for .eh_frame FDEs, which are generally
217 defined using the target's pointer size so far.
219 Note that dwarf2_addr_size only needs to be redefined by a target if the
220 GCC back-end defines a DWARF2_ADDR_SIZE other than the target pointer size,
221 and if Dwarf versions < 4 need to be supported. */
223 extern int gdbarch_dwarf2_addr_size (struct gdbarch *gdbarch);
224 extern void set_gdbarch_dwarf2_addr_size (struct gdbarch *gdbarch, int dwarf2_addr_size);
226 /* One if `char' acts like `signed char', zero if `unsigned char'. */
228 extern int gdbarch_char_signed (struct gdbarch *gdbarch);
229 extern void set_gdbarch_char_signed (struct gdbarch *gdbarch, int char_signed);
231 extern int gdbarch_read_pc_p (struct gdbarch *gdbarch);
233 typedef CORE_ADDR (gdbarch_read_pc_ftype) (struct regcache *regcache);
234 extern CORE_ADDR gdbarch_read_pc (struct gdbarch *gdbarch, struct regcache *regcache);
235 extern void set_gdbarch_read_pc (struct gdbarch *gdbarch, gdbarch_read_pc_ftype *read_pc);
237 extern int gdbarch_write_pc_p (struct gdbarch *gdbarch);
239 typedef void (gdbarch_write_pc_ftype) (struct regcache *regcache, CORE_ADDR val);
240 extern void gdbarch_write_pc (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR val);
241 extern void set_gdbarch_write_pc (struct gdbarch *gdbarch, gdbarch_write_pc_ftype *write_pc);
243 /* Function for getting target's idea of a frame pointer. FIXME: GDB's
244 whole scheme for dealing with "frames" and "frame pointers" needs a
245 serious shakedown. */
247 typedef void (gdbarch_virtual_frame_pointer_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc, int *frame_regnum, LONGEST *frame_offset);
248 extern void gdbarch_virtual_frame_pointer (struct gdbarch *gdbarch, CORE_ADDR pc, int *frame_regnum, LONGEST *frame_offset);
249 extern void set_gdbarch_virtual_frame_pointer (struct gdbarch *gdbarch, gdbarch_virtual_frame_pointer_ftype *virtual_frame_pointer);
251 extern int gdbarch_pseudo_register_read_p (struct gdbarch *gdbarch);
253 typedef enum register_status (gdbarch_pseudo_register_read_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, gdb_byte *buf);
254 extern enum register_status gdbarch_pseudo_register_read (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, gdb_byte *buf);
255 extern void set_gdbarch_pseudo_register_read (struct gdbarch *gdbarch, gdbarch_pseudo_register_read_ftype *pseudo_register_read);
257 /* Read a register into a new struct value. If the register is wholly
258 or partly unavailable, this should call mark_value_bytes_unavailable
259 as appropriate. If this is defined, then pseudo_register_read will
262 extern int gdbarch_pseudo_register_read_value_p (struct gdbarch *gdbarch);
264 typedef struct value * (gdbarch_pseudo_register_read_value_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum);
265 extern struct value * gdbarch_pseudo_register_read_value (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum);
266 extern void set_gdbarch_pseudo_register_read_value (struct gdbarch *gdbarch, gdbarch_pseudo_register_read_value_ftype *pseudo_register_read_value);
268 extern int gdbarch_pseudo_register_write_p (struct gdbarch *gdbarch);
270 typedef void (gdbarch_pseudo_register_write_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, const gdb_byte *buf);
271 extern void gdbarch_pseudo_register_write (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, const gdb_byte *buf);
272 extern void set_gdbarch_pseudo_register_write (struct gdbarch *gdbarch, gdbarch_pseudo_register_write_ftype *pseudo_register_write);
274 extern int gdbarch_num_regs (struct gdbarch *gdbarch);
275 extern void set_gdbarch_num_regs (struct gdbarch *gdbarch, int num_regs);
277 /* This macro gives the number of pseudo-registers that live in the
278 register namespace but do not get fetched or stored on the target.
279 These pseudo-registers may be aliases for other registers,
280 combinations of other registers, or they may be computed by GDB. */
282 extern int gdbarch_num_pseudo_regs (struct gdbarch *gdbarch);
283 extern void set_gdbarch_num_pseudo_regs (struct gdbarch *gdbarch, int num_pseudo_regs);
285 /* Assemble agent expression bytecode to collect pseudo-register REG.
286 Return -1 if something goes wrong, 0 otherwise. */
288 extern int gdbarch_ax_pseudo_register_collect_p (struct gdbarch *gdbarch);
290 typedef int (gdbarch_ax_pseudo_register_collect_ftype) (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
291 extern int gdbarch_ax_pseudo_register_collect (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
292 extern void set_gdbarch_ax_pseudo_register_collect (struct gdbarch *gdbarch, gdbarch_ax_pseudo_register_collect_ftype *ax_pseudo_register_collect);
294 /* Assemble agent expression bytecode to push the value of pseudo-register
295 REG on the interpreter stack.
296 Return -1 if something goes wrong, 0 otherwise. */
298 extern int gdbarch_ax_pseudo_register_push_stack_p (struct gdbarch *gdbarch);
300 typedef int (gdbarch_ax_pseudo_register_push_stack_ftype) (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
301 extern int gdbarch_ax_pseudo_register_push_stack (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
302 extern void set_gdbarch_ax_pseudo_register_push_stack (struct gdbarch *gdbarch, gdbarch_ax_pseudo_register_push_stack_ftype *ax_pseudo_register_push_stack);
304 /* Some targets/architectures can do extra processing/display of
305 segmentation faults. E.g., Intel MPX boundary faults.
306 Call the architecture dependent function to handle the fault.
307 UIOUT is the output stream where the handler will place information. */
309 extern int gdbarch_handle_segmentation_fault_p (struct gdbarch *gdbarch);
311 typedef void (gdbarch_handle_segmentation_fault_ftype) (struct gdbarch *gdbarch, struct ui_out *uiout);
312 extern void gdbarch_handle_segmentation_fault (struct gdbarch *gdbarch, struct ui_out *uiout);
313 extern void set_gdbarch_handle_segmentation_fault (struct gdbarch *gdbarch, gdbarch_handle_segmentation_fault_ftype *handle_segmentation_fault);
315 /* GDB's standard (or well known) register numbers. These can map onto
316 a real register or a pseudo (computed) register or not be defined at
318 gdbarch_sp_regnum will hopefully be replaced by UNWIND_SP. */
320 extern int gdbarch_sp_regnum (struct gdbarch *gdbarch);
321 extern void set_gdbarch_sp_regnum (struct gdbarch *gdbarch, int sp_regnum);
323 extern int gdbarch_pc_regnum (struct gdbarch *gdbarch);
324 extern void set_gdbarch_pc_regnum (struct gdbarch *gdbarch, int pc_regnum);
326 extern int gdbarch_ps_regnum (struct gdbarch *gdbarch);
327 extern void set_gdbarch_ps_regnum (struct gdbarch *gdbarch, int ps_regnum);
329 extern int gdbarch_fp0_regnum (struct gdbarch *gdbarch);
330 extern void set_gdbarch_fp0_regnum (struct gdbarch *gdbarch, int fp0_regnum);
332 /* Convert stab register number (from `r' declaration) to a gdb REGNUM. */
334 typedef int (gdbarch_stab_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int stab_regnr);
335 extern int gdbarch_stab_reg_to_regnum (struct gdbarch *gdbarch, int stab_regnr);
336 extern void set_gdbarch_stab_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_stab_reg_to_regnum_ftype *stab_reg_to_regnum);
338 /* Provide a default mapping from a ecoff register number to a gdb REGNUM. */
340 typedef int (gdbarch_ecoff_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int ecoff_regnr);
341 extern int gdbarch_ecoff_reg_to_regnum (struct gdbarch *gdbarch, int ecoff_regnr);
342 extern void set_gdbarch_ecoff_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_ecoff_reg_to_regnum_ftype *ecoff_reg_to_regnum);
344 /* Convert from an sdb register number to an internal gdb register number. */
346 typedef int (gdbarch_sdb_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int sdb_regnr);
347 extern int gdbarch_sdb_reg_to_regnum (struct gdbarch *gdbarch, int sdb_regnr);
348 extern void set_gdbarch_sdb_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_sdb_reg_to_regnum_ftype *sdb_reg_to_regnum);
350 /* Provide a default mapping from a DWARF2 register number to a gdb REGNUM.
351 Return -1 for bad REGNUM. Note: Several targets get this wrong. */
353 typedef int (gdbarch_dwarf2_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int dwarf2_regnr);
354 extern int gdbarch_dwarf2_reg_to_regnum (struct gdbarch *gdbarch, int dwarf2_regnr);
355 extern void set_gdbarch_dwarf2_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_dwarf2_reg_to_regnum_ftype *dwarf2_reg_to_regnum);
357 typedef const char * (gdbarch_register_name_ftype) (struct gdbarch *gdbarch, int regnr);
358 extern const char * gdbarch_register_name (struct gdbarch *gdbarch, int regnr);
359 extern void set_gdbarch_register_name (struct gdbarch *gdbarch, gdbarch_register_name_ftype *register_name);
361 /* Return the type of a register specified by the architecture. Only
362 the register cache should call this function directly; others should
363 use "register_type". */
365 extern int gdbarch_register_type_p (struct gdbarch *gdbarch);
367 typedef struct type * (gdbarch_register_type_ftype) (struct gdbarch *gdbarch, int reg_nr);
368 extern struct type * gdbarch_register_type (struct gdbarch *gdbarch, int reg_nr);
369 extern void set_gdbarch_register_type (struct gdbarch *gdbarch, gdbarch_register_type_ftype *register_type);
371 extern int gdbarch_dummy_id_p (struct gdbarch *gdbarch);
373 typedef struct frame_id (gdbarch_dummy_id_ftype) (struct gdbarch *gdbarch, struct frame_info *this_frame);
374 extern struct frame_id gdbarch_dummy_id (struct gdbarch *gdbarch, struct frame_info *this_frame);
375 extern void set_gdbarch_dummy_id (struct gdbarch *gdbarch, gdbarch_dummy_id_ftype *dummy_id);
377 /* Implement DUMMY_ID and PUSH_DUMMY_CALL, then delete
378 deprecated_fp_regnum. */
380 extern int gdbarch_deprecated_fp_regnum (struct gdbarch *gdbarch);
381 extern void set_gdbarch_deprecated_fp_regnum (struct gdbarch *gdbarch, int deprecated_fp_regnum);
383 extern int gdbarch_push_dummy_call_p (struct gdbarch *gdbarch);
385 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);
386 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);
387 extern void set_gdbarch_push_dummy_call (struct gdbarch *gdbarch, gdbarch_push_dummy_call_ftype *push_dummy_call);
389 extern int gdbarch_call_dummy_location (struct gdbarch *gdbarch);
390 extern void set_gdbarch_call_dummy_location (struct gdbarch *gdbarch, int call_dummy_location);
392 extern int gdbarch_push_dummy_code_p (struct gdbarch *gdbarch);
394 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);
395 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);
396 extern void set_gdbarch_push_dummy_code (struct gdbarch *gdbarch, gdbarch_push_dummy_code_ftype *push_dummy_code);
398 /* Return true if the code of FRAME is writable. */
400 typedef int (gdbarch_code_of_frame_writable_ftype) (struct gdbarch *gdbarch, struct frame_info *frame);
401 extern int gdbarch_code_of_frame_writable (struct gdbarch *gdbarch, struct frame_info *frame);
402 extern void set_gdbarch_code_of_frame_writable (struct gdbarch *gdbarch, gdbarch_code_of_frame_writable_ftype *code_of_frame_writable);
404 typedef void (gdbarch_print_registers_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, int regnum, int all);
405 extern void gdbarch_print_registers_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, int regnum, int all);
406 extern void set_gdbarch_print_registers_info (struct gdbarch *gdbarch, gdbarch_print_registers_info_ftype *print_registers_info);
408 typedef void (gdbarch_print_float_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
409 extern void gdbarch_print_float_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
410 extern void set_gdbarch_print_float_info (struct gdbarch *gdbarch, gdbarch_print_float_info_ftype *print_float_info);
412 extern int gdbarch_print_vector_info_p (struct gdbarch *gdbarch);
414 typedef void (gdbarch_print_vector_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
415 extern void gdbarch_print_vector_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
416 extern void set_gdbarch_print_vector_info (struct gdbarch *gdbarch, gdbarch_print_vector_info_ftype *print_vector_info);
418 /* MAP a GDB RAW register number onto a simulator register number. See
419 also include/...-sim.h. */
421 typedef int (gdbarch_register_sim_regno_ftype) (struct gdbarch *gdbarch, int reg_nr);
422 extern int gdbarch_register_sim_regno (struct gdbarch *gdbarch, int reg_nr);
423 extern void set_gdbarch_register_sim_regno (struct gdbarch *gdbarch, gdbarch_register_sim_regno_ftype *register_sim_regno);
425 typedef int (gdbarch_cannot_fetch_register_ftype) (struct gdbarch *gdbarch, int regnum);
426 extern int gdbarch_cannot_fetch_register (struct gdbarch *gdbarch, int regnum);
427 extern void set_gdbarch_cannot_fetch_register (struct gdbarch *gdbarch, gdbarch_cannot_fetch_register_ftype *cannot_fetch_register);
429 typedef int (gdbarch_cannot_store_register_ftype) (struct gdbarch *gdbarch, int regnum);
430 extern int gdbarch_cannot_store_register (struct gdbarch *gdbarch, int regnum);
431 extern void set_gdbarch_cannot_store_register (struct gdbarch *gdbarch, gdbarch_cannot_store_register_ftype *cannot_store_register);
433 /* Determine the address where a longjmp will land and save this address
434 in PC. Return nonzero on success.
436 FRAME corresponds to the longjmp frame. */
438 extern int gdbarch_get_longjmp_target_p (struct gdbarch *gdbarch);
440 typedef int (gdbarch_get_longjmp_target_ftype) (struct frame_info *frame, CORE_ADDR *pc);
441 extern int gdbarch_get_longjmp_target (struct gdbarch *gdbarch, struct frame_info *frame, CORE_ADDR *pc);
442 extern void set_gdbarch_get_longjmp_target (struct gdbarch *gdbarch, gdbarch_get_longjmp_target_ftype *get_longjmp_target);
444 extern int gdbarch_believe_pcc_promotion (struct gdbarch *gdbarch);
445 extern void set_gdbarch_believe_pcc_promotion (struct gdbarch *gdbarch, int believe_pcc_promotion);
447 typedef int (gdbarch_convert_register_p_ftype) (struct gdbarch *gdbarch, int regnum, struct type *type);
448 extern int gdbarch_convert_register_p (struct gdbarch *gdbarch, int regnum, struct type *type);
449 extern void set_gdbarch_convert_register_p (struct gdbarch *gdbarch, gdbarch_convert_register_p_ftype *convert_register_p);
451 typedef int (gdbarch_register_to_value_ftype) (struct frame_info *frame, int regnum, struct type *type, gdb_byte *buf, int *optimizedp, int *unavailablep);
452 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);
453 extern void set_gdbarch_register_to_value (struct gdbarch *gdbarch, gdbarch_register_to_value_ftype *register_to_value);
455 typedef void (gdbarch_value_to_register_ftype) (struct frame_info *frame, int regnum, struct type *type, const gdb_byte *buf);
456 extern void gdbarch_value_to_register (struct gdbarch *gdbarch, struct frame_info *frame, int regnum, struct type *type, const gdb_byte *buf);
457 extern void set_gdbarch_value_to_register (struct gdbarch *gdbarch, gdbarch_value_to_register_ftype *value_to_register);
459 /* Construct a value representing the contents of register REGNUM in
460 frame FRAME_ID, interpreted as type TYPE. The routine needs to
461 allocate and return a struct value with all value attributes
462 (but not the value contents) filled in. */
464 typedef struct value * (gdbarch_value_from_register_ftype) (struct gdbarch *gdbarch, struct type *type, int regnum, struct frame_id frame_id);
465 extern struct value * gdbarch_value_from_register (struct gdbarch *gdbarch, struct type *type, int regnum, struct frame_id frame_id);
466 extern void set_gdbarch_value_from_register (struct gdbarch *gdbarch, gdbarch_value_from_register_ftype *value_from_register);
468 typedef CORE_ADDR (gdbarch_pointer_to_address_ftype) (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
469 extern CORE_ADDR gdbarch_pointer_to_address (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
470 extern void set_gdbarch_pointer_to_address (struct gdbarch *gdbarch, gdbarch_pointer_to_address_ftype *pointer_to_address);
472 typedef void (gdbarch_address_to_pointer_ftype) (struct gdbarch *gdbarch, struct type *type, gdb_byte *buf, CORE_ADDR addr);
473 extern void gdbarch_address_to_pointer (struct gdbarch *gdbarch, struct type *type, gdb_byte *buf, CORE_ADDR addr);
474 extern void set_gdbarch_address_to_pointer (struct gdbarch *gdbarch, gdbarch_address_to_pointer_ftype *address_to_pointer);
476 extern int gdbarch_integer_to_address_p (struct gdbarch *gdbarch);
478 typedef CORE_ADDR (gdbarch_integer_to_address_ftype) (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
479 extern CORE_ADDR gdbarch_integer_to_address (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
480 extern void set_gdbarch_integer_to_address (struct gdbarch *gdbarch, gdbarch_integer_to_address_ftype *integer_to_address);
482 /* Return the return-value convention that will be used by FUNCTION
483 to return a value of type VALTYPE. FUNCTION may be NULL in which
484 case the return convention is computed based only on VALTYPE.
486 If READBUF is not NULL, extract the return value and save it in this buffer.
488 If WRITEBUF is not NULL, it contains a return value which will be
489 stored into the appropriate register. This can be used when we want
490 to force the value returned by a function (see the "return" command
493 extern int gdbarch_return_value_p (struct gdbarch *gdbarch);
495 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);
496 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);
497 extern void set_gdbarch_return_value (struct gdbarch *gdbarch, gdbarch_return_value_ftype *return_value);
499 /* Return true if the return value of function is stored in the first hidden
500 parameter. In theory, this feature should be language-dependent, specified
501 by language and its ABI, such as C++. Unfortunately, compiler may
502 implement it to a target-dependent feature. So that we need such hook here
503 to be aware of this in GDB. */
505 typedef int (gdbarch_return_in_first_hidden_param_p_ftype) (struct gdbarch *gdbarch, struct type *type);
506 extern int gdbarch_return_in_first_hidden_param_p (struct gdbarch *gdbarch, struct type *type);
507 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);
509 typedef CORE_ADDR (gdbarch_skip_prologue_ftype) (struct gdbarch *gdbarch, CORE_ADDR ip);
510 extern CORE_ADDR gdbarch_skip_prologue (struct gdbarch *gdbarch, CORE_ADDR ip);
511 extern void set_gdbarch_skip_prologue (struct gdbarch *gdbarch, gdbarch_skip_prologue_ftype *skip_prologue);
513 extern int gdbarch_skip_main_prologue_p (struct gdbarch *gdbarch);
515 typedef CORE_ADDR (gdbarch_skip_main_prologue_ftype) (struct gdbarch *gdbarch, CORE_ADDR ip);
516 extern CORE_ADDR gdbarch_skip_main_prologue (struct gdbarch *gdbarch, CORE_ADDR ip);
517 extern void set_gdbarch_skip_main_prologue (struct gdbarch *gdbarch, gdbarch_skip_main_prologue_ftype *skip_main_prologue);
519 /* On some platforms, a single function may provide multiple entry points,
520 e.g. one that is used for function-pointer calls and a different one
521 that is used for direct function calls.
522 In order to ensure that breakpoints set on the function will trigger
523 no matter via which entry point the function is entered, a platform
524 may provide the skip_entrypoint callback. It is called with IP set
525 to the main entry point of a function (as determined by the symbol table),
526 and should return the address of the innermost entry point, where the
527 actual breakpoint needs to be set. Note that skip_entrypoint is used
528 by GDB common code even when debugging optimized code, where skip_prologue
531 extern int gdbarch_skip_entrypoint_p (struct gdbarch *gdbarch);
533 typedef CORE_ADDR (gdbarch_skip_entrypoint_ftype) (struct gdbarch *gdbarch, CORE_ADDR ip);
534 extern CORE_ADDR gdbarch_skip_entrypoint (struct gdbarch *gdbarch, CORE_ADDR ip);
535 extern void set_gdbarch_skip_entrypoint (struct gdbarch *gdbarch, gdbarch_skip_entrypoint_ftype *skip_entrypoint);
537 typedef int (gdbarch_inner_than_ftype) (CORE_ADDR lhs, CORE_ADDR rhs);
538 extern int gdbarch_inner_than (struct gdbarch *gdbarch, CORE_ADDR lhs, CORE_ADDR rhs);
539 extern void set_gdbarch_inner_than (struct gdbarch *gdbarch, gdbarch_inner_than_ftype *inner_than);
541 typedef const gdb_byte * (gdbarch_breakpoint_from_pc_ftype) (struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *lenptr);
542 extern const gdb_byte * gdbarch_breakpoint_from_pc (struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *lenptr);
543 extern void set_gdbarch_breakpoint_from_pc (struct gdbarch *gdbarch, gdbarch_breakpoint_from_pc_ftype *breakpoint_from_pc);
545 /* Return the adjusted address and kind to use for Z0/Z1 packets.
546 KIND is usually the memory length of the breakpoint, but may have a
547 different target-specific meaning. */
549 typedef void (gdbarch_remote_breakpoint_from_pc_ftype) (struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *kindptr);
550 extern void gdbarch_remote_breakpoint_from_pc (struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *kindptr);
551 extern void set_gdbarch_remote_breakpoint_from_pc (struct gdbarch *gdbarch, gdbarch_remote_breakpoint_from_pc_ftype *remote_breakpoint_from_pc);
553 extern int gdbarch_adjust_breakpoint_address_p (struct gdbarch *gdbarch);
555 typedef CORE_ADDR (gdbarch_adjust_breakpoint_address_ftype) (struct gdbarch *gdbarch, CORE_ADDR bpaddr);
556 extern CORE_ADDR gdbarch_adjust_breakpoint_address (struct gdbarch *gdbarch, CORE_ADDR bpaddr);
557 extern void set_gdbarch_adjust_breakpoint_address (struct gdbarch *gdbarch, gdbarch_adjust_breakpoint_address_ftype *adjust_breakpoint_address);
559 typedef int (gdbarch_memory_insert_breakpoint_ftype) (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
560 extern int gdbarch_memory_insert_breakpoint (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
561 extern void set_gdbarch_memory_insert_breakpoint (struct gdbarch *gdbarch, gdbarch_memory_insert_breakpoint_ftype *memory_insert_breakpoint);
563 typedef int (gdbarch_memory_remove_breakpoint_ftype) (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
564 extern int gdbarch_memory_remove_breakpoint (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
565 extern void set_gdbarch_memory_remove_breakpoint (struct gdbarch *gdbarch, gdbarch_memory_remove_breakpoint_ftype *memory_remove_breakpoint);
567 extern CORE_ADDR gdbarch_decr_pc_after_break (struct gdbarch *gdbarch);
568 extern void set_gdbarch_decr_pc_after_break (struct gdbarch *gdbarch, CORE_ADDR decr_pc_after_break);
570 /* A function can be addressed by either it's "pointer" (possibly a
571 descriptor address) or "entry point" (first executable instruction).
572 The method "convert_from_func_ptr_addr" converting the former to the
573 latter. gdbarch_deprecated_function_start_offset is being used to implement
574 a simplified subset of that functionality - the function's address
575 corresponds to the "function pointer" and the function's start
576 corresponds to the "function entry point" - and hence is redundant. */
578 extern CORE_ADDR gdbarch_deprecated_function_start_offset (struct gdbarch *gdbarch);
579 extern void set_gdbarch_deprecated_function_start_offset (struct gdbarch *gdbarch, CORE_ADDR deprecated_function_start_offset);
581 /* Return the remote protocol register number associated with this
582 register. Normally the identity mapping. */
584 typedef int (gdbarch_remote_register_number_ftype) (struct gdbarch *gdbarch, int regno);
585 extern int gdbarch_remote_register_number (struct gdbarch *gdbarch, int regno);
586 extern void set_gdbarch_remote_register_number (struct gdbarch *gdbarch, gdbarch_remote_register_number_ftype *remote_register_number);
588 /* Fetch the target specific address used to represent a load module. */
590 extern int gdbarch_fetch_tls_load_module_address_p (struct gdbarch *gdbarch);
592 typedef CORE_ADDR (gdbarch_fetch_tls_load_module_address_ftype) (struct objfile *objfile);
593 extern CORE_ADDR gdbarch_fetch_tls_load_module_address (struct gdbarch *gdbarch, struct objfile *objfile);
594 extern void set_gdbarch_fetch_tls_load_module_address (struct gdbarch *gdbarch, gdbarch_fetch_tls_load_module_address_ftype *fetch_tls_load_module_address);
596 extern CORE_ADDR gdbarch_frame_args_skip (struct gdbarch *gdbarch);
597 extern void set_gdbarch_frame_args_skip (struct gdbarch *gdbarch, CORE_ADDR frame_args_skip);
599 extern int gdbarch_unwind_pc_p (struct gdbarch *gdbarch);
601 typedef CORE_ADDR (gdbarch_unwind_pc_ftype) (struct gdbarch *gdbarch, struct frame_info *next_frame);
602 extern CORE_ADDR gdbarch_unwind_pc (struct gdbarch *gdbarch, struct frame_info *next_frame);
603 extern void set_gdbarch_unwind_pc (struct gdbarch *gdbarch, gdbarch_unwind_pc_ftype *unwind_pc);
605 extern int gdbarch_unwind_sp_p (struct gdbarch *gdbarch);
607 typedef CORE_ADDR (gdbarch_unwind_sp_ftype) (struct gdbarch *gdbarch, struct frame_info *next_frame);
608 extern CORE_ADDR gdbarch_unwind_sp (struct gdbarch *gdbarch, struct frame_info *next_frame);
609 extern void set_gdbarch_unwind_sp (struct gdbarch *gdbarch, gdbarch_unwind_sp_ftype *unwind_sp);
611 /* DEPRECATED_FRAME_LOCALS_ADDRESS as been replaced by the per-frame
612 frame-base. Enable frame-base before frame-unwind. */
614 extern int gdbarch_frame_num_args_p (struct gdbarch *gdbarch);
616 typedef int (gdbarch_frame_num_args_ftype) (struct frame_info *frame);
617 extern int gdbarch_frame_num_args (struct gdbarch *gdbarch, struct frame_info *frame);
618 extern void set_gdbarch_frame_num_args (struct gdbarch *gdbarch, gdbarch_frame_num_args_ftype *frame_num_args);
620 extern int gdbarch_frame_align_p (struct gdbarch *gdbarch);
622 typedef CORE_ADDR (gdbarch_frame_align_ftype) (struct gdbarch *gdbarch, CORE_ADDR address);
623 extern CORE_ADDR gdbarch_frame_align (struct gdbarch *gdbarch, CORE_ADDR address);
624 extern void set_gdbarch_frame_align (struct gdbarch *gdbarch, gdbarch_frame_align_ftype *frame_align);
626 typedef int (gdbarch_stabs_argument_has_addr_ftype) (struct gdbarch *gdbarch, struct type *type);
627 extern int gdbarch_stabs_argument_has_addr (struct gdbarch *gdbarch, struct type *type);
628 extern void set_gdbarch_stabs_argument_has_addr (struct gdbarch *gdbarch, gdbarch_stabs_argument_has_addr_ftype *stabs_argument_has_addr);
630 extern int gdbarch_frame_red_zone_size (struct gdbarch *gdbarch);
631 extern void set_gdbarch_frame_red_zone_size (struct gdbarch *gdbarch, int frame_red_zone_size);
633 typedef CORE_ADDR (gdbarch_convert_from_func_ptr_addr_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr, struct target_ops *targ);
634 extern CORE_ADDR gdbarch_convert_from_func_ptr_addr (struct gdbarch *gdbarch, CORE_ADDR addr, struct target_ops *targ);
635 extern void set_gdbarch_convert_from_func_ptr_addr (struct gdbarch *gdbarch, gdbarch_convert_from_func_ptr_addr_ftype *convert_from_func_ptr_addr);
637 /* On some machines there are bits in addresses which are not really
638 part of the address, but are used by the kernel, the hardware, etc.
639 for special purposes. gdbarch_addr_bits_remove takes out any such bits so
640 we get a "real" address such as one would find in a symbol table.
641 This is used only for addresses of instructions, and even then I'm
642 not sure it's used in all contexts. It exists to deal with there
643 being a few stray bits in the PC which would mislead us, not as some
644 sort of generic thing to handle alignment or segmentation (it's
645 possible it should be in TARGET_READ_PC instead). */
647 typedef CORE_ADDR (gdbarch_addr_bits_remove_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
648 extern CORE_ADDR gdbarch_addr_bits_remove (struct gdbarch *gdbarch, CORE_ADDR addr);
649 extern void set_gdbarch_addr_bits_remove (struct gdbarch *gdbarch, gdbarch_addr_bits_remove_ftype *addr_bits_remove);
651 /* FIXME/cagney/2001-01-18: This should be split in two. A target method that
652 indicates if the target needs software single step. An ISA method to
655 FIXME/cagney/2001-01-18: The logic is backwards. It should be asking if the
656 target can single step. If not, then implement single step using breakpoints.
658 A return value of 1 means that the software_single_step breakpoints
659 were inserted; 0 means they were not. Multiple breakpoints may be
660 inserted for some instructions such as conditional branch. However,
661 each implementation must always evaluate the condition and only put
662 the breakpoint at the branch destination if the condition is true, so
663 that we ensure forward progress when stepping past a conditional
666 extern int gdbarch_software_single_step_p (struct gdbarch *gdbarch);
668 typedef int (gdbarch_software_single_step_ftype) (struct frame_info *frame);
669 extern int gdbarch_software_single_step (struct gdbarch *gdbarch, struct frame_info *frame);
670 extern void set_gdbarch_software_single_step (struct gdbarch *gdbarch, gdbarch_software_single_step_ftype *software_single_step);
672 /* Return non-zero if the processor is executing a delay slot and a
673 further single-step is needed before the instruction finishes. */
675 extern int gdbarch_single_step_through_delay_p (struct gdbarch *gdbarch);
677 typedef int (gdbarch_single_step_through_delay_ftype) (struct gdbarch *gdbarch, struct frame_info *frame);
678 extern int gdbarch_single_step_through_delay (struct gdbarch *gdbarch, struct frame_info *frame);
679 extern void set_gdbarch_single_step_through_delay (struct gdbarch *gdbarch, gdbarch_single_step_through_delay_ftype *single_step_through_delay);
681 /* FIXME: cagney/2003-08-28: Need to find a better way of selecting the
682 disassembler. Perhaps objdump can handle it? */
684 typedef int (gdbarch_print_insn_ftype) (bfd_vma vma, struct disassemble_info *info);
685 extern int gdbarch_print_insn (struct gdbarch *gdbarch, bfd_vma vma, struct disassemble_info *info);
686 extern void set_gdbarch_print_insn (struct gdbarch *gdbarch, gdbarch_print_insn_ftype *print_insn);
688 typedef CORE_ADDR (gdbarch_skip_trampoline_code_ftype) (struct frame_info *frame, CORE_ADDR pc);
689 extern CORE_ADDR gdbarch_skip_trampoline_code (struct gdbarch *gdbarch, struct frame_info *frame, CORE_ADDR pc);
690 extern void set_gdbarch_skip_trampoline_code (struct gdbarch *gdbarch, gdbarch_skip_trampoline_code_ftype *skip_trampoline_code);
692 /* If in_solib_dynsym_resolve_code() returns true, and SKIP_SOLIB_RESOLVER
693 evaluates non-zero, this is the address where the debugger will place
694 a step-resume breakpoint to get us past the dynamic linker. */
696 typedef CORE_ADDR (gdbarch_skip_solib_resolver_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc);
697 extern CORE_ADDR gdbarch_skip_solib_resolver (struct gdbarch *gdbarch, CORE_ADDR pc);
698 extern void set_gdbarch_skip_solib_resolver (struct gdbarch *gdbarch, gdbarch_skip_solib_resolver_ftype *skip_solib_resolver);
700 /* Some systems also have trampoline code for returning from shared libs. */
702 typedef int (gdbarch_in_solib_return_trampoline_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc, const char *name);
703 extern int gdbarch_in_solib_return_trampoline (struct gdbarch *gdbarch, CORE_ADDR pc, const char *name);
704 extern void set_gdbarch_in_solib_return_trampoline (struct gdbarch *gdbarch, gdbarch_in_solib_return_trampoline_ftype *in_solib_return_trampoline);
706 /* A target might have problems with watchpoints as soon as the stack
707 frame of the current function has been destroyed. This mostly happens
708 as the first action in a function's epilogue. stack_frame_destroyed_p()
709 is defined to return a non-zero value if either the given addr is one
710 instruction after the stack destroying instruction up to the trailing
711 return instruction or if we can figure out that the stack frame has
712 already been invalidated regardless of the value of addr. Targets
713 which don't suffer from that problem could just let this functionality
716 typedef int (gdbarch_stack_frame_destroyed_p_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
717 extern int gdbarch_stack_frame_destroyed_p (struct gdbarch *gdbarch, CORE_ADDR addr);
718 extern void set_gdbarch_stack_frame_destroyed_p (struct gdbarch *gdbarch, gdbarch_stack_frame_destroyed_p_ftype *stack_frame_destroyed_p);
720 /* Process an ELF symbol in the minimal symbol table in a backend-specific
721 way. Normally this hook is supposed to do nothing, however if required,
722 then this hook can be used to apply tranformations to symbols that are
723 considered special in some way. For example the MIPS backend uses it
724 to interpret `st_other' information to mark compressed code symbols so
725 that they can be treated in the appropriate manner in the processing of
726 the main symbol table and DWARF-2 records. */
728 extern int gdbarch_elf_make_msymbol_special_p (struct gdbarch *gdbarch);
730 typedef void (gdbarch_elf_make_msymbol_special_ftype) (asymbol *sym, struct minimal_symbol *msym);
731 extern void gdbarch_elf_make_msymbol_special (struct gdbarch *gdbarch, asymbol *sym, struct minimal_symbol *msym);
732 extern void set_gdbarch_elf_make_msymbol_special (struct gdbarch *gdbarch, gdbarch_elf_make_msymbol_special_ftype *elf_make_msymbol_special);
734 typedef void (gdbarch_coff_make_msymbol_special_ftype) (int val, struct minimal_symbol *msym);
735 extern void gdbarch_coff_make_msymbol_special (struct gdbarch *gdbarch, int val, struct minimal_symbol *msym);
736 extern void set_gdbarch_coff_make_msymbol_special (struct gdbarch *gdbarch, gdbarch_coff_make_msymbol_special_ftype *coff_make_msymbol_special);
738 /* Process a symbol in the main symbol table in a backend-specific way.
739 Normally this hook is supposed to do nothing, however if required,
740 then this hook can be used to apply tranformations to symbols that
741 are considered special in some way. This is currently used by the
742 MIPS backend to make sure compressed code symbols have the ISA bit
743 set. This in turn is needed for symbol values seen in GDB to match
744 the values used at the runtime by the program itself, for function
745 and label references. */
747 typedef void (gdbarch_make_symbol_special_ftype) (struct symbol *sym, struct objfile *objfile);
748 extern void gdbarch_make_symbol_special (struct gdbarch *gdbarch, struct symbol *sym, struct objfile *objfile);
749 extern void set_gdbarch_make_symbol_special (struct gdbarch *gdbarch, gdbarch_make_symbol_special_ftype *make_symbol_special);
751 /* Adjust the address retrieved from a DWARF-2 record other than a line
752 entry in a backend-specific way. Normally this hook is supposed to
753 return the address passed unchanged, however if that is incorrect for
754 any reason, then this hook can be used to fix the address up in the
755 required manner. This is currently used by the MIPS backend to make
756 sure addresses in FDE, range records, etc. referring to compressed
757 code have the ISA bit set, matching line information and the symbol
760 typedef CORE_ADDR (gdbarch_adjust_dwarf2_addr_ftype) (CORE_ADDR pc);
761 extern CORE_ADDR gdbarch_adjust_dwarf2_addr (struct gdbarch *gdbarch, CORE_ADDR pc);
762 extern void set_gdbarch_adjust_dwarf2_addr (struct gdbarch *gdbarch, gdbarch_adjust_dwarf2_addr_ftype *adjust_dwarf2_addr);
764 /* Adjust the address updated by a line entry in a backend-specific way.
765 Normally this hook is supposed to return the address passed unchanged,
766 however in the case of inconsistencies in these records, this hook can
767 be used to fix them up in the required manner. This is currently used
768 by the MIPS backend to make sure all line addresses in compressed code
769 are presented with the ISA bit set, which is not always the case. This
770 in turn ensures breakpoint addresses are correctly matched against the
773 typedef CORE_ADDR (gdbarch_adjust_dwarf2_line_ftype) (CORE_ADDR addr, int rel);
774 extern CORE_ADDR gdbarch_adjust_dwarf2_line (struct gdbarch *gdbarch, CORE_ADDR addr, int rel);
775 extern void set_gdbarch_adjust_dwarf2_line (struct gdbarch *gdbarch, gdbarch_adjust_dwarf2_line_ftype *adjust_dwarf2_line);
777 extern int gdbarch_cannot_step_breakpoint (struct gdbarch *gdbarch);
778 extern void set_gdbarch_cannot_step_breakpoint (struct gdbarch *gdbarch, int cannot_step_breakpoint);
780 extern int gdbarch_have_nonsteppable_watchpoint (struct gdbarch *gdbarch);
781 extern void set_gdbarch_have_nonsteppable_watchpoint (struct gdbarch *gdbarch, int have_nonsteppable_watchpoint);
783 extern int gdbarch_address_class_type_flags_p (struct gdbarch *gdbarch);
785 typedef int (gdbarch_address_class_type_flags_ftype) (int byte_size, int dwarf2_addr_class);
786 extern int gdbarch_address_class_type_flags (struct gdbarch *gdbarch, int byte_size, int dwarf2_addr_class);
787 extern void set_gdbarch_address_class_type_flags (struct gdbarch *gdbarch, gdbarch_address_class_type_flags_ftype *address_class_type_flags);
789 extern int gdbarch_address_class_type_flags_to_name_p (struct gdbarch *gdbarch);
791 typedef const char * (gdbarch_address_class_type_flags_to_name_ftype) (struct gdbarch *gdbarch, int type_flags);
792 extern const char * gdbarch_address_class_type_flags_to_name (struct gdbarch *gdbarch, int type_flags);
793 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);
795 /* Return the appropriate type_flags for the supplied address class.
796 This function should return 1 if the address class was recognized and
797 type_flags was set, zero otherwise. */
799 extern int gdbarch_address_class_name_to_type_flags_p (struct gdbarch *gdbarch);
801 typedef int (gdbarch_address_class_name_to_type_flags_ftype) (struct gdbarch *gdbarch, const char *name, int *type_flags_ptr);
802 extern int gdbarch_address_class_name_to_type_flags (struct gdbarch *gdbarch, const char *name, int *type_flags_ptr);
803 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);
805 /* Is a register in a group */
807 typedef int (gdbarch_register_reggroup_p_ftype) (struct gdbarch *gdbarch, int regnum, struct reggroup *reggroup);
808 extern int gdbarch_register_reggroup_p (struct gdbarch *gdbarch, int regnum, struct reggroup *reggroup);
809 extern void set_gdbarch_register_reggroup_p (struct gdbarch *gdbarch, gdbarch_register_reggroup_p_ftype *register_reggroup_p);
811 /* Fetch the pointer to the ith function argument. */
813 extern int gdbarch_fetch_pointer_argument_p (struct gdbarch *gdbarch);
815 typedef CORE_ADDR (gdbarch_fetch_pointer_argument_ftype) (struct frame_info *frame, int argi, struct type *type);
816 extern CORE_ADDR gdbarch_fetch_pointer_argument (struct gdbarch *gdbarch, struct frame_info *frame, int argi, struct type *type);
817 extern void set_gdbarch_fetch_pointer_argument (struct gdbarch *gdbarch, gdbarch_fetch_pointer_argument_ftype *fetch_pointer_argument);
819 /* Iterate over all supported register notes in a core file. For each
820 supported register note section, the iterator must call CB and pass
821 CB_DATA unchanged. If REGCACHE is not NULL, the iterator can limit
822 the supported register note sections based on the current register
823 values. Otherwise it should enumerate all supported register note
826 extern int gdbarch_iterate_over_regset_sections_p (struct gdbarch *gdbarch);
828 typedef void (gdbarch_iterate_over_regset_sections_ftype) (struct gdbarch *gdbarch, iterate_over_regset_sections_cb *cb, void *cb_data, const struct regcache *regcache);
829 extern void gdbarch_iterate_over_regset_sections (struct gdbarch *gdbarch, iterate_over_regset_sections_cb *cb, void *cb_data, const struct regcache *regcache);
830 extern void set_gdbarch_iterate_over_regset_sections (struct gdbarch *gdbarch, gdbarch_iterate_over_regset_sections_ftype *iterate_over_regset_sections);
832 /* Create core file notes */
834 extern int gdbarch_make_corefile_notes_p (struct gdbarch *gdbarch);
836 typedef char * (gdbarch_make_corefile_notes_ftype) (struct gdbarch *gdbarch, bfd *obfd, int *note_size);
837 extern char * gdbarch_make_corefile_notes (struct gdbarch *gdbarch, bfd *obfd, int *note_size);
838 extern void set_gdbarch_make_corefile_notes (struct gdbarch *gdbarch, gdbarch_make_corefile_notes_ftype *make_corefile_notes);
840 /* The elfcore writer hook to use to write Linux prpsinfo notes to core
841 files. Most Linux architectures use the same prpsinfo32 or
842 prpsinfo64 layouts, and so won't need to provide this hook, as we
843 call the Linux generic routines in bfd to write prpsinfo notes by
846 extern int gdbarch_elfcore_write_linux_prpsinfo_p (struct gdbarch *gdbarch);
848 typedef char * (gdbarch_elfcore_write_linux_prpsinfo_ftype) (bfd *obfd, char *note_data, int *note_size, const struct elf_internal_linux_prpsinfo *info);
849 extern char * gdbarch_elfcore_write_linux_prpsinfo (struct gdbarch *gdbarch, bfd *obfd, char *note_data, int *note_size, const struct elf_internal_linux_prpsinfo *info);
850 extern void set_gdbarch_elfcore_write_linux_prpsinfo (struct gdbarch *gdbarch, gdbarch_elfcore_write_linux_prpsinfo_ftype *elfcore_write_linux_prpsinfo);
852 /* Find core file memory regions */
854 extern int gdbarch_find_memory_regions_p (struct gdbarch *gdbarch);
856 typedef int (gdbarch_find_memory_regions_ftype) (struct gdbarch *gdbarch, find_memory_region_ftype func, void *data);
857 extern int gdbarch_find_memory_regions (struct gdbarch *gdbarch, find_memory_region_ftype func, void *data);
858 extern void set_gdbarch_find_memory_regions (struct gdbarch *gdbarch, gdbarch_find_memory_regions_ftype *find_memory_regions);
860 /* Read offset OFFSET of TARGET_OBJECT_LIBRARIES formatted shared libraries list from
861 core file into buffer READBUF with length LEN. Return the number of bytes read
862 (zero indicates failure).
863 failed, otherwise, return the red length of READBUF. */
865 extern int gdbarch_core_xfer_shared_libraries_p (struct gdbarch *gdbarch);
867 typedef ULONGEST (gdbarch_core_xfer_shared_libraries_ftype) (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
868 extern ULONGEST gdbarch_core_xfer_shared_libraries (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
869 extern void set_gdbarch_core_xfer_shared_libraries (struct gdbarch *gdbarch, gdbarch_core_xfer_shared_libraries_ftype *core_xfer_shared_libraries);
871 /* Read offset OFFSET of TARGET_OBJECT_LIBRARIES_AIX formatted shared
872 libraries list from core file into buffer READBUF with length LEN.
873 Return the number of bytes read (zero indicates failure). */
875 extern int gdbarch_core_xfer_shared_libraries_aix_p (struct gdbarch *gdbarch);
877 typedef ULONGEST (gdbarch_core_xfer_shared_libraries_aix_ftype) (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
878 extern ULONGEST gdbarch_core_xfer_shared_libraries_aix (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
879 extern void set_gdbarch_core_xfer_shared_libraries_aix (struct gdbarch *gdbarch, gdbarch_core_xfer_shared_libraries_aix_ftype *core_xfer_shared_libraries_aix);
881 /* How the core target converts a PTID from a core file to a string. */
883 extern int gdbarch_core_pid_to_str_p (struct gdbarch *gdbarch);
885 typedef char * (gdbarch_core_pid_to_str_ftype) (struct gdbarch *gdbarch, ptid_t ptid);
886 extern char * gdbarch_core_pid_to_str (struct gdbarch *gdbarch, ptid_t ptid);
887 extern void set_gdbarch_core_pid_to_str (struct gdbarch *gdbarch, gdbarch_core_pid_to_str_ftype *core_pid_to_str);
889 /* How the core target extracts the name of a thread from a core file. */
891 extern int gdbarch_core_thread_name_p (struct gdbarch *gdbarch);
893 typedef const char * (gdbarch_core_thread_name_ftype) (struct gdbarch *gdbarch, struct thread_info *thr);
894 extern const char * gdbarch_core_thread_name (struct gdbarch *gdbarch, struct thread_info *thr);
895 extern void set_gdbarch_core_thread_name (struct gdbarch *gdbarch, gdbarch_core_thread_name_ftype *core_thread_name);
897 /* BFD target to use when generating a core file. */
899 extern int gdbarch_gcore_bfd_target_p (struct gdbarch *gdbarch);
901 extern const char * gdbarch_gcore_bfd_target (struct gdbarch *gdbarch);
902 extern void set_gdbarch_gcore_bfd_target (struct gdbarch *gdbarch, const char * gcore_bfd_target);
904 /* If the elements of C++ vtables are in-place function descriptors rather
905 than normal function pointers (which may point to code or a descriptor),
908 extern int gdbarch_vtable_function_descriptors (struct gdbarch *gdbarch);
909 extern void set_gdbarch_vtable_function_descriptors (struct gdbarch *gdbarch, int vtable_function_descriptors);
911 /* Set if the least significant bit of the delta is used instead of the least
912 significant bit of the pfn for pointers to virtual member functions. */
914 extern int gdbarch_vbit_in_delta (struct gdbarch *gdbarch);
915 extern void set_gdbarch_vbit_in_delta (struct gdbarch *gdbarch, int vbit_in_delta);
917 /* Advance PC to next instruction in order to skip a permanent breakpoint. */
919 typedef void (gdbarch_skip_permanent_breakpoint_ftype) (struct regcache *regcache);
920 extern void gdbarch_skip_permanent_breakpoint (struct gdbarch *gdbarch, struct regcache *regcache);
921 extern void set_gdbarch_skip_permanent_breakpoint (struct gdbarch *gdbarch, gdbarch_skip_permanent_breakpoint_ftype *skip_permanent_breakpoint);
923 /* The maximum length of an instruction on this architecture in bytes. */
925 extern int gdbarch_max_insn_length_p (struct gdbarch *gdbarch);
927 extern ULONGEST gdbarch_max_insn_length (struct gdbarch *gdbarch);
928 extern void set_gdbarch_max_insn_length (struct gdbarch *gdbarch, ULONGEST max_insn_length);
930 /* Copy the instruction at FROM to TO, and make any adjustments
931 necessary to single-step it at that address.
933 REGS holds the state the thread's registers will have before
934 executing the copied instruction; the PC in REGS will refer to FROM,
935 not the copy at TO. The caller should update it to point at TO later.
937 Return a pointer to data of the architecture's choice to be passed
938 to gdbarch_displaced_step_fixup. Or, return NULL to indicate that
939 the instruction's effects have been completely simulated, with the
940 resulting state written back to REGS.
942 For a general explanation of displaced stepping and how GDB uses it,
943 see the comments in infrun.c.
945 The TO area is only guaranteed to have space for
946 gdbarch_max_insn_length (arch) bytes, so this function must not
947 write more bytes than that to that area.
949 If you do not provide this function, GDB assumes that the
950 architecture does not support displaced stepping.
952 If your architecture doesn't need to adjust instructions before
953 single-stepping them, consider using simple_displaced_step_copy_insn
956 If the instruction cannot execute out of line, return NULL. The
957 core falls back to stepping past the instruction in-line instead in
960 extern int gdbarch_displaced_step_copy_insn_p (struct gdbarch *gdbarch);
962 typedef struct displaced_step_closure * (gdbarch_displaced_step_copy_insn_ftype) (struct gdbarch *gdbarch, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
963 extern struct displaced_step_closure * gdbarch_displaced_step_copy_insn (struct gdbarch *gdbarch, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
964 extern void set_gdbarch_displaced_step_copy_insn (struct gdbarch *gdbarch, gdbarch_displaced_step_copy_insn_ftype *displaced_step_copy_insn);
966 /* Return true if GDB should use hardware single-stepping to execute
967 the displaced instruction identified by CLOSURE. If false,
968 GDB will simply restart execution at the displaced instruction
969 location, and it is up to the target to ensure GDB will receive
970 control again (e.g. by placing a software breakpoint instruction
971 into the displaced instruction buffer).
973 The default implementation returns false on all targets that
974 provide a gdbarch_software_single_step routine, and true otherwise. */
976 typedef int (gdbarch_displaced_step_hw_singlestep_ftype) (struct gdbarch *gdbarch, struct displaced_step_closure *closure);
977 extern int gdbarch_displaced_step_hw_singlestep (struct gdbarch *gdbarch, struct displaced_step_closure *closure);
978 extern void set_gdbarch_displaced_step_hw_singlestep (struct gdbarch *gdbarch, gdbarch_displaced_step_hw_singlestep_ftype *displaced_step_hw_singlestep);
980 /* Fix up the state resulting from successfully single-stepping a
981 displaced instruction, to give the result we would have gotten from
982 stepping the instruction in its original location.
984 REGS is the register state resulting from single-stepping the
985 displaced instruction.
987 CLOSURE is the result from the matching call to
988 gdbarch_displaced_step_copy_insn.
990 If you provide gdbarch_displaced_step_copy_insn.but not this
991 function, then GDB assumes that no fixup is needed after
992 single-stepping the instruction.
994 For a general explanation of displaced stepping and how GDB uses it,
995 see the comments in infrun.c. */
997 extern int gdbarch_displaced_step_fixup_p (struct gdbarch *gdbarch);
999 typedef void (gdbarch_displaced_step_fixup_ftype) (struct gdbarch *gdbarch, struct displaced_step_closure *closure, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
1000 extern void gdbarch_displaced_step_fixup (struct gdbarch *gdbarch, struct displaced_step_closure *closure, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
1001 extern void set_gdbarch_displaced_step_fixup (struct gdbarch *gdbarch, gdbarch_displaced_step_fixup_ftype *displaced_step_fixup);
1003 /* Free a closure returned by gdbarch_displaced_step_copy_insn.
1005 If you provide gdbarch_displaced_step_copy_insn, you must provide
1006 this function as well.
1008 If your architecture uses closures that don't need to be freed, then
1009 you can use simple_displaced_step_free_closure here.
1011 For a general explanation of displaced stepping and how GDB uses it,
1012 see the comments in infrun.c. */
1014 typedef void (gdbarch_displaced_step_free_closure_ftype) (struct gdbarch *gdbarch, struct displaced_step_closure *closure);
1015 extern void gdbarch_displaced_step_free_closure (struct gdbarch *gdbarch, struct displaced_step_closure *closure);
1016 extern void set_gdbarch_displaced_step_free_closure (struct gdbarch *gdbarch, gdbarch_displaced_step_free_closure_ftype *displaced_step_free_closure);
1018 /* Return the address of an appropriate place to put displaced
1019 instructions while we step over them. There need only be one such
1020 place, since we're only stepping one thread over a breakpoint at a
1023 For a general explanation of displaced stepping and how GDB uses it,
1024 see the comments in infrun.c. */
1026 typedef CORE_ADDR (gdbarch_displaced_step_location_ftype) (struct gdbarch *gdbarch);
1027 extern CORE_ADDR gdbarch_displaced_step_location (struct gdbarch *gdbarch);
1028 extern void set_gdbarch_displaced_step_location (struct gdbarch *gdbarch, gdbarch_displaced_step_location_ftype *displaced_step_location);
1030 /* Relocate an instruction to execute at a different address. OLDLOC
1031 is the address in the inferior memory where the instruction to
1032 relocate is currently at. On input, TO points to the destination
1033 where we want the instruction to be copied (and possibly adjusted)
1034 to. On output, it points to one past the end of the resulting
1035 instruction(s). The effect of executing the instruction at TO shall
1036 be the same as if executing it at FROM. For example, call
1037 instructions that implicitly push the return address on the stack
1038 should be adjusted to return to the instruction after OLDLOC;
1039 relative branches, and other PC-relative instructions need the
1040 offset adjusted; etc. */
1042 extern int gdbarch_relocate_instruction_p (struct gdbarch *gdbarch);
1044 typedef void (gdbarch_relocate_instruction_ftype) (struct gdbarch *gdbarch, CORE_ADDR *to, CORE_ADDR from);
1045 extern void gdbarch_relocate_instruction (struct gdbarch *gdbarch, CORE_ADDR *to, CORE_ADDR from);
1046 extern void set_gdbarch_relocate_instruction (struct gdbarch *gdbarch, gdbarch_relocate_instruction_ftype *relocate_instruction);
1048 /* Refresh overlay mapped state for section OSECT. */
1050 extern int gdbarch_overlay_update_p (struct gdbarch *gdbarch);
1052 typedef void (gdbarch_overlay_update_ftype) (struct obj_section *osect);
1053 extern void gdbarch_overlay_update (struct gdbarch *gdbarch, struct obj_section *osect);
1054 extern void set_gdbarch_overlay_update (struct gdbarch *gdbarch, gdbarch_overlay_update_ftype *overlay_update);
1056 extern int gdbarch_core_read_description_p (struct gdbarch *gdbarch);
1058 typedef const struct target_desc * (gdbarch_core_read_description_ftype) (struct gdbarch *gdbarch, struct target_ops *target, bfd *abfd);
1059 extern const struct target_desc * gdbarch_core_read_description (struct gdbarch *gdbarch, struct target_ops *target, bfd *abfd);
1060 extern void set_gdbarch_core_read_description (struct gdbarch *gdbarch, gdbarch_core_read_description_ftype *core_read_description);
1062 /* Handle special encoding of static variables in stabs debug info. */
1064 extern int gdbarch_static_transform_name_p (struct gdbarch *gdbarch);
1066 typedef const char * (gdbarch_static_transform_name_ftype) (const char *name);
1067 extern const char * gdbarch_static_transform_name (struct gdbarch *gdbarch, const char *name);
1068 extern void set_gdbarch_static_transform_name (struct gdbarch *gdbarch, gdbarch_static_transform_name_ftype *static_transform_name);
1070 /* Set if the address in N_SO or N_FUN stabs may be zero. */
1072 extern int gdbarch_sofun_address_maybe_missing (struct gdbarch *gdbarch);
1073 extern void set_gdbarch_sofun_address_maybe_missing (struct gdbarch *gdbarch, int sofun_address_maybe_missing);
1075 /* Parse the instruction at ADDR storing in the record execution log
1076 the registers REGCACHE and memory ranges that will be affected when
1077 the instruction executes, along with their current values.
1078 Return -1 if something goes wrong, 0 otherwise. */
1080 extern int gdbarch_process_record_p (struct gdbarch *gdbarch);
1082 typedef int (gdbarch_process_record_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr);
1083 extern int gdbarch_process_record (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr);
1084 extern void set_gdbarch_process_record (struct gdbarch *gdbarch, gdbarch_process_record_ftype *process_record);
1086 /* Save process state after a signal.
1087 Return -1 if something goes wrong, 0 otherwise. */
1089 extern int gdbarch_process_record_signal_p (struct gdbarch *gdbarch);
1091 typedef int (gdbarch_process_record_signal_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, enum gdb_signal signal);
1092 extern int gdbarch_process_record_signal (struct gdbarch *gdbarch, struct regcache *regcache, enum gdb_signal signal);
1093 extern void set_gdbarch_process_record_signal (struct gdbarch *gdbarch, gdbarch_process_record_signal_ftype *process_record_signal);
1095 /* Signal translation: translate inferior's signal (target's) number
1096 into GDB's representation. The implementation of this method must
1097 be host independent. IOW, don't rely on symbols of the NAT_FILE
1098 header (the nm-*.h files), the host <signal.h> header, or similar
1099 headers. This is mainly used when cross-debugging core files ---
1100 "Live" targets hide the translation behind the target interface
1101 (target_wait, target_resume, etc.). */
1103 extern int gdbarch_gdb_signal_from_target_p (struct gdbarch *gdbarch);
1105 typedef enum gdb_signal (gdbarch_gdb_signal_from_target_ftype) (struct gdbarch *gdbarch, int signo);
1106 extern enum gdb_signal gdbarch_gdb_signal_from_target (struct gdbarch *gdbarch, int signo);
1107 extern void set_gdbarch_gdb_signal_from_target (struct gdbarch *gdbarch, gdbarch_gdb_signal_from_target_ftype *gdb_signal_from_target);
1109 /* Signal translation: translate the GDB's internal signal number into
1110 the inferior's signal (target's) representation. The implementation
1111 of this method must be host independent. IOW, don't rely on symbols
1112 of the NAT_FILE header (the nm-*.h files), the host <signal.h>
1113 header, or similar headers.
1114 Return the target signal number if found, or -1 if the GDB internal
1115 signal number is invalid. */
1117 extern int gdbarch_gdb_signal_to_target_p (struct gdbarch *gdbarch);
1119 typedef int (gdbarch_gdb_signal_to_target_ftype) (struct gdbarch *gdbarch, enum gdb_signal signal);
1120 extern int gdbarch_gdb_signal_to_target (struct gdbarch *gdbarch, enum gdb_signal signal);
1121 extern void set_gdbarch_gdb_signal_to_target (struct gdbarch *gdbarch, gdbarch_gdb_signal_to_target_ftype *gdb_signal_to_target);
1123 /* Extra signal info inspection.
1125 Return a type suitable to inspect extra signal information. */
1127 extern int gdbarch_get_siginfo_type_p (struct gdbarch *gdbarch);
1129 typedef struct type * (gdbarch_get_siginfo_type_ftype) (struct gdbarch *gdbarch);
1130 extern struct type * gdbarch_get_siginfo_type (struct gdbarch *gdbarch);
1131 extern void set_gdbarch_get_siginfo_type (struct gdbarch *gdbarch, gdbarch_get_siginfo_type_ftype *get_siginfo_type);
1133 /* Record architecture-specific information from the symbol table. */
1135 extern int gdbarch_record_special_symbol_p (struct gdbarch *gdbarch);
1137 typedef void (gdbarch_record_special_symbol_ftype) (struct gdbarch *gdbarch, struct objfile *objfile, asymbol *sym);
1138 extern void gdbarch_record_special_symbol (struct gdbarch *gdbarch, struct objfile *objfile, asymbol *sym);
1139 extern void set_gdbarch_record_special_symbol (struct gdbarch *gdbarch, gdbarch_record_special_symbol_ftype *record_special_symbol);
1141 /* Function for the 'catch syscall' feature.
1142 Get architecture-specific system calls information from registers. */
1144 extern int gdbarch_get_syscall_number_p (struct gdbarch *gdbarch);
1146 typedef LONGEST (gdbarch_get_syscall_number_ftype) (struct gdbarch *gdbarch, ptid_t ptid);
1147 extern LONGEST gdbarch_get_syscall_number (struct gdbarch *gdbarch, ptid_t ptid);
1148 extern void set_gdbarch_get_syscall_number (struct gdbarch *gdbarch, gdbarch_get_syscall_number_ftype *get_syscall_number);
1150 /* The filename of the XML syscall for this architecture. */
1152 extern const char * gdbarch_xml_syscall_file (struct gdbarch *gdbarch);
1153 extern void set_gdbarch_xml_syscall_file (struct gdbarch *gdbarch, const char * xml_syscall_file);
1155 /* Information about system calls from this architecture */
1157 extern struct syscalls_info * gdbarch_syscalls_info (struct gdbarch *gdbarch);
1158 extern void set_gdbarch_syscalls_info (struct gdbarch *gdbarch, struct syscalls_info * syscalls_info);
1160 /* SystemTap related fields and functions.
1161 A NULL-terminated array of prefixes used to mark an integer constant
1162 on the architecture's assembly.
1163 For example, on x86 integer constants are written as:
1165 $10 ;; integer constant 10
1167 in this case, this prefix would be the character `$'. */
1169 extern const char *const * gdbarch_stap_integer_prefixes (struct gdbarch *gdbarch);
1170 extern void set_gdbarch_stap_integer_prefixes (struct gdbarch *gdbarch, const char *const * stap_integer_prefixes);
1172 /* A NULL-terminated array of suffixes used to mark an integer constant
1173 on the architecture's assembly. */
1175 extern const char *const * gdbarch_stap_integer_suffixes (struct gdbarch *gdbarch);
1176 extern void set_gdbarch_stap_integer_suffixes (struct gdbarch *gdbarch, const char *const * stap_integer_suffixes);
1178 /* A NULL-terminated array of prefixes used to mark a register name on
1179 the architecture's assembly.
1180 For example, on x86 the register name is written as:
1182 %eax ;; register eax
1184 in this case, this prefix would be the character `%'. */
1186 extern const char *const * gdbarch_stap_register_prefixes (struct gdbarch *gdbarch);
1187 extern void set_gdbarch_stap_register_prefixes (struct gdbarch *gdbarch, const char *const * stap_register_prefixes);
1189 /* A NULL-terminated array of suffixes used to mark a register name on
1190 the architecture's assembly. */
1192 extern const char *const * gdbarch_stap_register_suffixes (struct gdbarch *gdbarch);
1193 extern void set_gdbarch_stap_register_suffixes (struct gdbarch *gdbarch, const char *const * stap_register_suffixes);
1195 /* A NULL-terminated array of prefixes used to mark a register
1196 indirection on the architecture's assembly.
1197 For example, on x86 the register indirection is written as:
1199 (%eax) ;; indirecting eax
1201 in this case, this prefix would be the charater `('.
1203 Please note that we use the indirection prefix also for register
1204 displacement, e.g., `4(%eax)' on x86. */
1206 extern const char *const * gdbarch_stap_register_indirection_prefixes (struct gdbarch *gdbarch);
1207 extern void set_gdbarch_stap_register_indirection_prefixes (struct gdbarch *gdbarch, const char *const * stap_register_indirection_prefixes);
1209 /* A NULL-terminated array of suffixes used to mark a register
1210 indirection on the architecture's assembly.
1211 For example, on x86 the register indirection is written as:
1213 (%eax) ;; indirecting eax
1215 in this case, this prefix would be the charater `)'.
1217 Please note that we use the indirection suffix also for register
1218 displacement, e.g., `4(%eax)' on x86. */
1220 extern const char *const * gdbarch_stap_register_indirection_suffixes (struct gdbarch *gdbarch);
1221 extern void set_gdbarch_stap_register_indirection_suffixes (struct gdbarch *gdbarch, const char *const * stap_register_indirection_suffixes);
1223 /* Prefix(es) used to name a register using GDB's nomenclature.
1225 For example, on PPC a register is represented by a number in the assembly
1226 language (e.g., `10' is the 10th general-purpose register). However,
1227 inside GDB this same register has an `r' appended to its name, so the 10th
1228 register would be represented as `r10' internally. */
1230 extern const char * gdbarch_stap_gdb_register_prefix (struct gdbarch *gdbarch);
1231 extern void set_gdbarch_stap_gdb_register_prefix (struct gdbarch *gdbarch, const char * stap_gdb_register_prefix);
1233 /* Suffix used to name a register using GDB's nomenclature. */
1235 extern const char * gdbarch_stap_gdb_register_suffix (struct gdbarch *gdbarch);
1236 extern void set_gdbarch_stap_gdb_register_suffix (struct gdbarch *gdbarch, const char * stap_gdb_register_suffix);
1238 /* Check if S is a single operand.
1240 Single operands can be:
1241 - Literal integers, e.g. `$10' on x86
1242 - Register access, e.g. `%eax' on x86
1243 - Register indirection, e.g. `(%eax)' on x86
1244 - Register displacement, e.g. `4(%eax)' on x86
1246 This function should check for these patterns on the string
1247 and return 1 if some were found, or zero otherwise. Please try to match
1248 as much info as you can from the string, i.e., if you have to match
1249 something like `(%', do not match just the `('. */
1251 extern int gdbarch_stap_is_single_operand_p (struct gdbarch *gdbarch);
1253 typedef int (gdbarch_stap_is_single_operand_ftype) (struct gdbarch *gdbarch, const char *s);
1254 extern int gdbarch_stap_is_single_operand (struct gdbarch *gdbarch, const char *s);
1255 extern void set_gdbarch_stap_is_single_operand (struct gdbarch *gdbarch, gdbarch_stap_is_single_operand_ftype *stap_is_single_operand);
1257 /* Function used to handle a "special case" in the parser.
1259 A "special case" is considered to be an unknown token, i.e., a token
1260 that the parser does not know how to parse. A good example of special
1261 case would be ARM's register displacement syntax:
1263 [R0, #4] ;; displacing R0 by 4
1265 Since the parser assumes that a register displacement is of the form:
1267 <number> <indirection_prefix> <register_name> <indirection_suffix>
1269 it means that it will not be able to recognize and parse this odd syntax.
1270 Therefore, we should add a special case function that will handle this token.
1272 This function should generate the proper expression form of the expression
1273 using GDB's internal expression mechanism (e.g., `write_exp_elt_opcode'
1274 and so on). It should also return 1 if the parsing was successful, or zero
1275 if the token was not recognized as a special token (in this case, returning
1276 zero means that the special parser is deferring the parsing to the generic
1277 parser), and should advance the buffer pointer (p->arg). */
1279 extern int gdbarch_stap_parse_special_token_p (struct gdbarch *gdbarch);
1281 typedef int (gdbarch_stap_parse_special_token_ftype) (struct gdbarch *gdbarch, struct stap_parse_info *p);
1282 extern int gdbarch_stap_parse_special_token (struct gdbarch *gdbarch, struct stap_parse_info *p);
1283 extern void set_gdbarch_stap_parse_special_token (struct gdbarch *gdbarch, gdbarch_stap_parse_special_token_ftype *stap_parse_special_token);
1285 /* DTrace related functions.
1286 The expression to compute the NARTGth+1 argument to a DTrace USDT probe.
1287 NARG must be >= 0. */
1289 extern int gdbarch_dtrace_parse_probe_argument_p (struct gdbarch *gdbarch);
1291 typedef void (gdbarch_dtrace_parse_probe_argument_ftype) (struct gdbarch *gdbarch, struct parser_state *pstate, int narg);
1292 extern void gdbarch_dtrace_parse_probe_argument (struct gdbarch *gdbarch, struct parser_state *pstate, int narg);
1293 extern void set_gdbarch_dtrace_parse_probe_argument (struct gdbarch *gdbarch, gdbarch_dtrace_parse_probe_argument_ftype *dtrace_parse_probe_argument);
1295 /* True if the given ADDR does not contain the instruction sequence
1296 corresponding to a disabled DTrace is-enabled probe. */
1298 extern int gdbarch_dtrace_probe_is_enabled_p (struct gdbarch *gdbarch);
1300 typedef int (gdbarch_dtrace_probe_is_enabled_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
1301 extern int gdbarch_dtrace_probe_is_enabled (struct gdbarch *gdbarch, CORE_ADDR addr);
1302 extern void set_gdbarch_dtrace_probe_is_enabled (struct gdbarch *gdbarch, gdbarch_dtrace_probe_is_enabled_ftype *dtrace_probe_is_enabled);
1304 /* Enable a DTrace is-enabled probe at ADDR. */
1306 extern int gdbarch_dtrace_enable_probe_p (struct gdbarch *gdbarch);
1308 typedef void (gdbarch_dtrace_enable_probe_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
1309 extern void gdbarch_dtrace_enable_probe (struct gdbarch *gdbarch, CORE_ADDR addr);
1310 extern void set_gdbarch_dtrace_enable_probe (struct gdbarch *gdbarch, gdbarch_dtrace_enable_probe_ftype *dtrace_enable_probe);
1312 /* Disable a DTrace is-enabled probe at ADDR. */
1314 extern int gdbarch_dtrace_disable_probe_p (struct gdbarch *gdbarch);
1316 typedef void (gdbarch_dtrace_disable_probe_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
1317 extern void gdbarch_dtrace_disable_probe (struct gdbarch *gdbarch, CORE_ADDR addr);
1318 extern void set_gdbarch_dtrace_disable_probe (struct gdbarch *gdbarch, gdbarch_dtrace_disable_probe_ftype *dtrace_disable_probe);
1320 /* True if the list of shared libraries is one and only for all
1321 processes, as opposed to a list of shared libraries per inferior.
1322 This usually means that all processes, although may or may not share
1323 an address space, will see the same set of symbols at the same
1326 extern int gdbarch_has_global_solist (struct gdbarch *gdbarch);
1327 extern void set_gdbarch_has_global_solist (struct gdbarch *gdbarch, int has_global_solist);
1329 /* On some targets, even though each inferior has its own private
1330 address space, the debug interface takes care of making breakpoints
1331 visible to all address spaces automatically. For such cases,
1332 this property should be set to true. */
1334 extern int gdbarch_has_global_breakpoints (struct gdbarch *gdbarch);
1335 extern void set_gdbarch_has_global_breakpoints (struct gdbarch *gdbarch, int has_global_breakpoints);
1337 /* True if inferiors share an address space (e.g., uClinux). */
1339 typedef int (gdbarch_has_shared_address_space_ftype) (struct gdbarch *gdbarch);
1340 extern int gdbarch_has_shared_address_space (struct gdbarch *gdbarch);
1341 extern void set_gdbarch_has_shared_address_space (struct gdbarch *gdbarch, gdbarch_has_shared_address_space_ftype *has_shared_address_space);
1343 /* True if a fast tracepoint can be set at an address. */
1345 typedef int (gdbarch_fast_tracepoint_valid_at_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr, char **msg);
1346 extern int gdbarch_fast_tracepoint_valid_at (struct gdbarch *gdbarch, CORE_ADDR addr, char **msg);
1347 extern void set_gdbarch_fast_tracepoint_valid_at (struct gdbarch *gdbarch, gdbarch_fast_tracepoint_valid_at_ftype *fast_tracepoint_valid_at);
1349 /* Guess register state based on tracepoint location. Used for tracepoints
1350 where no registers have been collected, but there's only one location,
1351 allowing us to guess the PC value, and perhaps some other registers.
1352 On entry, regcache has all registers marked as unavailable. */
1354 typedef void (gdbarch_guess_tracepoint_registers_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr);
1355 extern void gdbarch_guess_tracepoint_registers (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr);
1356 extern void set_gdbarch_guess_tracepoint_registers (struct gdbarch *gdbarch, gdbarch_guess_tracepoint_registers_ftype *guess_tracepoint_registers);
1358 /* Return the "auto" target charset. */
1360 typedef const char * (gdbarch_auto_charset_ftype) (void);
1361 extern const char * gdbarch_auto_charset (struct gdbarch *gdbarch);
1362 extern void set_gdbarch_auto_charset (struct gdbarch *gdbarch, gdbarch_auto_charset_ftype *auto_charset);
1364 /* Return the "auto" target wide charset. */
1366 typedef const char * (gdbarch_auto_wide_charset_ftype) (void);
1367 extern const char * gdbarch_auto_wide_charset (struct gdbarch *gdbarch);
1368 extern void set_gdbarch_auto_wide_charset (struct gdbarch *gdbarch, gdbarch_auto_wide_charset_ftype *auto_wide_charset);
1370 /* If non-empty, this is a file extension that will be opened in place
1371 of the file extension reported by the shared library list.
1373 This is most useful for toolchains that use a post-linker tool,
1374 where the names of the files run on the target differ in extension
1375 compared to the names of the files GDB should load for debug info. */
1377 extern const char * gdbarch_solib_symbols_extension (struct gdbarch *gdbarch);
1378 extern void set_gdbarch_solib_symbols_extension (struct gdbarch *gdbarch, const char * solib_symbols_extension);
1380 /* If true, the target OS has DOS-based file system semantics. That
1381 is, absolute paths include a drive name, and the backslash is
1382 considered a directory separator. */
1384 extern int gdbarch_has_dos_based_file_system (struct gdbarch *gdbarch);
1385 extern void set_gdbarch_has_dos_based_file_system (struct gdbarch *gdbarch, int has_dos_based_file_system);
1387 /* Generate bytecodes to collect the return address in a frame.
1388 Since the bytecodes run on the target, possibly with GDB not even
1389 connected, the full unwinding machinery is not available, and
1390 typically this function will issue bytecodes for one or more likely
1391 places that the return address may be found. */
1393 typedef void (gdbarch_gen_return_address_ftype) (struct gdbarch *gdbarch, struct agent_expr *ax, struct axs_value *value, CORE_ADDR scope);
1394 extern void gdbarch_gen_return_address (struct gdbarch *gdbarch, struct agent_expr *ax, struct axs_value *value, CORE_ADDR scope);
1395 extern void set_gdbarch_gen_return_address (struct gdbarch *gdbarch, gdbarch_gen_return_address_ftype *gen_return_address);
1397 /* Implement the "info proc" command. */
1399 extern int gdbarch_info_proc_p (struct gdbarch *gdbarch);
1401 typedef void (gdbarch_info_proc_ftype) (struct gdbarch *gdbarch, const char *args, enum info_proc_what what);
1402 extern void gdbarch_info_proc (struct gdbarch *gdbarch, const char *args, enum info_proc_what what);
1403 extern void set_gdbarch_info_proc (struct gdbarch *gdbarch, gdbarch_info_proc_ftype *info_proc);
1405 /* Implement the "info proc" command for core files. Noe that there
1406 are two "info_proc"-like methods on gdbarch -- one for core files,
1407 one for live targets. */
1409 extern int gdbarch_core_info_proc_p (struct gdbarch *gdbarch);
1411 typedef void (gdbarch_core_info_proc_ftype) (struct gdbarch *gdbarch, const char *args, enum info_proc_what what);
1412 extern void gdbarch_core_info_proc (struct gdbarch *gdbarch, const char *args, enum info_proc_what what);
1413 extern void set_gdbarch_core_info_proc (struct gdbarch *gdbarch, gdbarch_core_info_proc_ftype *core_info_proc);
1415 /* Iterate over all objfiles in the order that makes the most sense
1416 for the architecture to make global symbol searches.
1418 CB is a callback function where OBJFILE is the objfile to be searched,
1419 and CB_DATA a pointer to user-defined data (the same data that is passed
1420 when calling this gdbarch method). The iteration stops if this function
1423 CB_DATA is a pointer to some user-defined data to be passed to
1426 If not NULL, CURRENT_OBJFILE corresponds to the objfile being
1427 inspected when the symbol search was requested. */
1429 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);
1430 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);
1431 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);
1433 /* Ravenscar arch-dependent ops. */
1435 extern struct ravenscar_arch_ops * gdbarch_ravenscar_ops (struct gdbarch *gdbarch);
1436 extern void set_gdbarch_ravenscar_ops (struct gdbarch *gdbarch, struct ravenscar_arch_ops * ravenscar_ops);
1438 /* Return non-zero if the instruction at ADDR is a call; zero otherwise. */
1440 typedef int (gdbarch_insn_is_call_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
1441 extern int gdbarch_insn_is_call (struct gdbarch *gdbarch, CORE_ADDR addr);
1442 extern void set_gdbarch_insn_is_call (struct gdbarch *gdbarch, gdbarch_insn_is_call_ftype *insn_is_call);
1444 /* Return non-zero if the instruction at ADDR is a return; zero otherwise. */
1446 typedef int (gdbarch_insn_is_ret_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
1447 extern int gdbarch_insn_is_ret (struct gdbarch *gdbarch, CORE_ADDR addr);
1448 extern void set_gdbarch_insn_is_ret (struct gdbarch *gdbarch, gdbarch_insn_is_ret_ftype *insn_is_ret);
1450 /* Return non-zero if the instruction at ADDR is a jump; zero otherwise. */
1452 typedef int (gdbarch_insn_is_jump_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
1453 extern int gdbarch_insn_is_jump (struct gdbarch *gdbarch, CORE_ADDR addr);
1454 extern void set_gdbarch_insn_is_jump (struct gdbarch *gdbarch, gdbarch_insn_is_jump_ftype *insn_is_jump);
1456 /* Read one auxv entry from *READPTR, not reading locations >= ENDPTR.
1457 Return 0 if *READPTR is already at the end of the buffer.
1458 Return -1 if there is insufficient buffer for a whole entry.
1459 Return 1 if an entry was read into *TYPEP and *VALP. */
1461 extern int gdbarch_auxv_parse_p (struct gdbarch *gdbarch);
1463 typedef int (gdbarch_auxv_parse_ftype) (struct gdbarch *gdbarch, gdb_byte **readptr, gdb_byte *endptr, CORE_ADDR *typep, CORE_ADDR *valp);
1464 extern int gdbarch_auxv_parse (struct gdbarch *gdbarch, gdb_byte **readptr, gdb_byte *endptr, CORE_ADDR *typep, CORE_ADDR *valp);
1465 extern void set_gdbarch_auxv_parse (struct gdbarch *gdbarch, gdbarch_auxv_parse_ftype *auxv_parse);
1467 /* Find the address range of the current inferior's vsyscall/vDSO, and
1468 write it to *RANGE. If the vsyscall's length can't be determined, a
1469 range with zero length is returned. Returns true if the vsyscall is
1470 found, false otherwise. */
1472 typedef int (gdbarch_vsyscall_range_ftype) (struct gdbarch *gdbarch, struct mem_range *range);
1473 extern int gdbarch_vsyscall_range (struct gdbarch *gdbarch, struct mem_range *range);
1474 extern void set_gdbarch_vsyscall_range (struct gdbarch *gdbarch, gdbarch_vsyscall_range_ftype *vsyscall_range);
1476 /* Allocate SIZE bytes of PROT protected page aligned memory in inferior.
1477 PROT has GDB_MMAP_PROT_* bitmask format.
1478 Throw an error if it is not possible. Returned address is always valid. */
1480 typedef CORE_ADDR (gdbarch_infcall_mmap_ftype) (CORE_ADDR size, unsigned prot);
1481 extern CORE_ADDR gdbarch_infcall_mmap (struct gdbarch *gdbarch, CORE_ADDR size, unsigned prot);
1482 extern void set_gdbarch_infcall_mmap (struct gdbarch *gdbarch, gdbarch_infcall_mmap_ftype *infcall_mmap);
1484 /* Deallocate SIZE bytes of memory at ADDR in inferior from gdbarch_infcall_mmap.
1485 Print a warning if it is not possible. */
1487 typedef void (gdbarch_infcall_munmap_ftype) (CORE_ADDR addr, CORE_ADDR size);
1488 extern void gdbarch_infcall_munmap (struct gdbarch *gdbarch, CORE_ADDR addr, CORE_ADDR size);
1489 extern void set_gdbarch_infcall_munmap (struct gdbarch *gdbarch, gdbarch_infcall_munmap_ftype *infcall_munmap);
1491 /* Return string (caller has to use xfree for it) with options for GCC
1492 to produce code for this target, typically "-m64", "-m32" or "-m31".
1493 These options are put before CU's DW_AT_producer compilation options so that
1494 they can override it. Method may also return NULL. */
1496 typedef char * (gdbarch_gcc_target_options_ftype) (struct gdbarch *gdbarch);
1497 extern char * gdbarch_gcc_target_options (struct gdbarch *gdbarch);
1498 extern void set_gdbarch_gcc_target_options (struct gdbarch *gdbarch, gdbarch_gcc_target_options_ftype *gcc_target_options);
1500 /* Return a regular expression that matches names used by this
1501 architecture in GNU configury triplets. The result is statically
1502 allocated and must not be freed. The default implementation simply
1503 returns the BFD architecture name, which is correct in nearly every
1506 typedef const char * (gdbarch_gnu_triplet_regexp_ftype) (struct gdbarch *gdbarch);
1507 extern const char * gdbarch_gnu_triplet_regexp (struct gdbarch *gdbarch);
1508 extern void set_gdbarch_gnu_triplet_regexp (struct gdbarch *gdbarch, gdbarch_gnu_triplet_regexp_ftype *gnu_triplet_regexp);
1510 /* Return the size in 8-bit bytes of an addressable memory unit on this
1511 architecture. This corresponds to the number of 8-bit bytes associated to
1512 each address in memory. */
1514 typedef int (gdbarch_addressable_memory_unit_size_ftype) (struct gdbarch *gdbarch);
1515 extern int gdbarch_addressable_memory_unit_size (struct gdbarch *gdbarch);
1516 extern void set_gdbarch_addressable_memory_unit_size (struct gdbarch *gdbarch, gdbarch_addressable_memory_unit_size_ftype *addressable_memory_unit_size);
1518 /* Definition for an unknown syscall, used basically in error-cases. */
1519 #define UNKNOWN_SYSCALL (-1)
1521 extern struct gdbarch_tdep *gdbarch_tdep (struct gdbarch *gdbarch);
1524 /* Mechanism for co-ordinating the selection of a specific
1527 GDB targets (*-tdep.c) can register an interest in a specific
1528 architecture. Other GDB components can register a need to maintain
1529 per-architecture data.
1531 The mechanisms below ensures that there is only a loose connection
1532 between the set-architecture command and the various GDB
1533 components. Each component can independently register their need
1534 to maintain architecture specific data with gdbarch.
1538 Previously, a single TARGET_ARCHITECTURE_HOOK was provided. It
1541 The more traditional mega-struct containing architecture specific
1542 data for all the various GDB components was also considered. Since
1543 GDB is built from a variable number of (fairly independent)
1544 components it was determined that the global aproach was not
1548 /* Register a new architectural family with GDB.
1550 Register support for the specified ARCHITECTURE with GDB. When
1551 gdbarch determines that the specified architecture has been
1552 selected, the corresponding INIT function is called.
1556 The INIT function takes two parameters: INFO which contains the
1557 information available to gdbarch about the (possibly new)
1558 architecture; ARCHES which is a list of the previously created
1559 ``struct gdbarch'' for this architecture.
1561 The INFO parameter is, as far as possible, be pre-initialized with
1562 information obtained from INFO.ABFD or the global defaults.
1564 The ARCHES parameter is a linked list (sorted most recently used)
1565 of all the previously created architures for this architecture
1566 family. The (possibly NULL) ARCHES->gdbarch can used to access
1567 values from the previously selected architecture for this
1568 architecture family.
1570 The INIT function shall return any of: NULL - indicating that it
1571 doesn't recognize the selected architecture; an existing ``struct
1572 gdbarch'' from the ARCHES list - indicating that the new
1573 architecture is just a synonym for an earlier architecture (see
1574 gdbarch_list_lookup_by_info()); a newly created ``struct gdbarch''
1575 - that describes the selected architecture (see gdbarch_alloc()).
1577 The DUMP_TDEP function shall print out all target specific values.
1578 Care should be taken to ensure that the function works in both the
1579 multi-arch and non- multi-arch cases. */
1583 struct gdbarch *gdbarch;
1584 struct gdbarch_list *next;
1589 /* Use default: NULL (ZERO). */
1590 const struct bfd_arch_info *bfd_arch_info;
1592 /* Use default: BFD_ENDIAN_UNKNOWN (NB: is not ZERO). */
1593 enum bfd_endian byte_order;
1595 enum bfd_endian byte_order_for_code;
1597 /* Use default: NULL (ZERO). */
1600 /* Use default: NULL (ZERO). */
1603 /* Use default: GDB_OSABI_UNINITIALIZED (-1). */
1604 enum gdb_osabi osabi;
1606 /* Use default: NULL (ZERO). */
1607 const struct target_desc *target_desc;
1610 typedef struct gdbarch *(gdbarch_init_ftype) (struct gdbarch_info info, struct gdbarch_list *arches);
1611 typedef void (gdbarch_dump_tdep_ftype) (struct gdbarch *gdbarch, struct ui_file *file);
1613 /* DEPRECATED - use gdbarch_register() */
1614 extern void register_gdbarch_init (enum bfd_architecture architecture, gdbarch_init_ftype *);
1616 extern void gdbarch_register (enum bfd_architecture architecture,
1617 gdbarch_init_ftype *,
1618 gdbarch_dump_tdep_ftype *);
1621 /* Return a freshly allocated, NULL terminated, array of the valid
1622 architecture names. Since architectures are registered during the
1623 _initialize phase this function only returns useful information
1624 once initialization has been completed. */
1626 extern const char **gdbarch_printable_names (void);
1629 /* Helper function. Search the list of ARCHES for a GDBARCH that
1630 matches the information provided by INFO. */
1632 extern struct gdbarch_list *gdbarch_list_lookup_by_info (struct gdbarch_list *arches, const struct gdbarch_info *info);
1635 /* Helper function. Create a preliminary ``struct gdbarch''. Perform
1636 basic initialization using values obtained from the INFO and TDEP
1637 parameters. set_gdbarch_*() functions are called to complete the
1638 initialization of the object. */
1640 extern struct gdbarch *gdbarch_alloc (const struct gdbarch_info *info, struct gdbarch_tdep *tdep);
1643 /* Helper function. Free a partially-constructed ``struct gdbarch''.
1644 It is assumed that the caller freeds the ``struct
1647 extern void gdbarch_free (struct gdbarch *);
1650 /* Helper function. Allocate memory from the ``struct gdbarch''
1651 obstack. The memory is freed when the corresponding architecture
1654 extern void *gdbarch_obstack_zalloc (struct gdbarch *gdbarch, long size);
1655 #define GDBARCH_OBSTACK_CALLOC(GDBARCH, NR, TYPE) ((TYPE *) gdbarch_obstack_zalloc ((GDBARCH), (NR) * sizeof (TYPE)))
1656 #define GDBARCH_OBSTACK_ZALLOC(GDBARCH, TYPE) ((TYPE *) gdbarch_obstack_zalloc ((GDBARCH), sizeof (TYPE)))
1658 /* Duplicate STRING, returning an equivalent string that's allocated on the
1659 obstack associated with GDBARCH. The string is freed when the corresponding
1660 architecture is also freed. */
1662 extern char *gdbarch_obstack_strdup (struct gdbarch *arch, const char *string);
1664 /* Helper function. Force an update of the current architecture.
1666 The actual architecture selected is determined by INFO, ``(gdb) set
1667 architecture'' et.al., the existing architecture and BFD's default
1668 architecture. INFO should be initialized to zero and then selected
1669 fields should be updated.
1671 Returns non-zero if the update succeeds. */
1673 extern int gdbarch_update_p (struct gdbarch_info info);
1676 /* Helper function. Find an architecture matching info.
1678 INFO should be initialized using gdbarch_info_init, relevant fields
1679 set, and then finished using gdbarch_info_fill.
1681 Returns the corresponding architecture, or NULL if no matching
1682 architecture was found. */
1684 extern struct gdbarch *gdbarch_find_by_info (struct gdbarch_info info);
1687 /* Helper function. Set the target gdbarch to "gdbarch". */
1689 extern void set_target_gdbarch (struct gdbarch *gdbarch);
1692 /* Register per-architecture data-pointer.
1694 Reserve space for a per-architecture data-pointer. An identifier
1695 for the reserved data-pointer is returned. That identifer should
1696 be saved in a local static variable.
1698 Memory for the per-architecture data shall be allocated using
1699 gdbarch_obstack_zalloc. That memory will be deleted when the
1700 corresponding architecture object is deleted.
1702 When a previously created architecture is re-selected, the
1703 per-architecture data-pointer for that previous architecture is
1704 restored. INIT() is not re-called.
1706 Multiple registrarants for any architecture are allowed (and
1707 strongly encouraged). */
1709 struct gdbarch_data;
1711 typedef void *(gdbarch_data_pre_init_ftype) (struct obstack *obstack);
1712 extern struct gdbarch_data *gdbarch_data_register_pre_init (gdbarch_data_pre_init_ftype *init);
1713 typedef void *(gdbarch_data_post_init_ftype) (struct gdbarch *gdbarch);
1714 extern struct gdbarch_data *gdbarch_data_register_post_init (gdbarch_data_post_init_ftype *init);
1715 extern void deprecated_set_gdbarch_data (struct gdbarch *gdbarch,
1716 struct gdbarch_data *data,
1719 extern void *gdbarch_data (struct gdbarch *gdbarch, struct gdbarch_data *);
1722 /* Set the dynamic target-system-dependent parameters (architecture,
1723 byte-order, ...) using information found in the BFD. */
1725 extern void set_gdbarch_from_file (bfd *);
1728 /* Initialize the current architecture to the "first" one we find on
1731 extern void initialize_current_architecture (void);
1733 /* gdbarch trace variable */
1734 extern unsigned int gdbarch_debug;
1736 extern void gdbarch_dump (struct gdbarch *gdbarch, struct ui_file *file);