Remove gdbarch_remote_breakpoint_from_pc
[external/binutils.git] / gdb / gdbarch.h
1 /* *INDENT-OFF* */ /* THIS FILE IS GENERATED -*- buffer-read-only: t -*- */
2 /* vi:set ro: */
3
4 /* Dynamic architecture support for GDB, the GNU debugger.
5
6    Copyright (C) 1998-2016 Free Software Foundation, Inc.
7
8    This file is part of GDB.
9
10    This program is free software; you can redistribute it and/or modify
11    it under the terms of the GNU General Public License as published by
12    the Free Software Foundation; either version 3 of the License, or
13    (at your option) any later version.
14
15    This program is distributed in the hope that it will be useful,
16    but WITHOUT ANY WARRANTY; without even the implied warranty of
17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18    GNU General Public License for more details.
19
20    You should have received a copy of the GNU General Public License
21    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
22
23 /* This file was created with the aid of ``gdbarch.sh''.
24
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
28    being reported.
29
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
33    easier.  */
34
35 #ifndef GDBARCH_H
36 #define GDBARCH_H
37
38 #include "frame.h"
39
40 struct floatformat;
41 struct ui_file;
42 struct value;
43 struct objfile;
44 struct obj_section;
45 struct minimal_symbol;
46 struct regcache;
47 struct reggroup;
48 struct regset;
49 struct disassemble_info;
50 struct target_ops;
51 struct obstack;
52 struct bp_target_info;
53 struct target_desc;
54 struct objfile;
55 struct symbol;
56 struct displaced_step_closure;
57 struct syscall;
58 struct agent_expr;
59 struct axs_value;
60 struct stap_parse_info;
61 struct parser_state;
62 struct ravenscar_arch_ops;
63 struct elf_internal_linux_prpsinfo;
64 struct mem_range;
65 struct syscalls_info;
66 struct thread_info;
67 struct ui_out;
68
69 #include "regcache.h"
70
71 /* The architecture associated with the inferior through the
72    connection to the target.
73
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
81    gdbarch.  */
82
83 /* This is a convenience wrapper for 'current_inferior ()->gdbarch'.  */
84 extern struct gdbarch *target_gdbarch (void);
85
86 /* Callback type for the 'iterate_over_objfiles_in_search_order'
87    gdbarch  method.  */
88
89 typedef int (iterate_over_objfiles_in_search_order_cb_ftype)
90   (struct objfile *objfile, void *cb_data);
91
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.  */
97
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);
101
102
103 /* The following are pre-initialized by GDBARCH.  */
104
105 extern const struct bfd_arch_info * gdbarch_bfd_arch_info (struct gdbarch *gdbarch);
106 /* set_gdbarch_bfd_arch_info() - not applicable - pre-initialized.  */
107
108 extern enum bfd_endian gdbarch_byte_order (struct gdbarch *gdbarch);
109 /* set_gdbarch_byte_order() - not applicable - pre-initialized.  */
110
111 extern enum bfd_endian gdbarch_byte_order_for_code (struct gdbarch *gdbarch);
112 /* set_gdbarch_byte_order_for_code() - not applicable - pre-initialized.  */
113
114 extern enum gdb_osabi gdbarch_osabi (struct gdbarch *gdbarch);
115 /* set_gdbarch_osabi() - not applicable - pre-initialized.  */
116
117 extern const struct target_desc * gdbarch_target_desc (struct gdbarch *gdbarch);
118 /* set_gdbarch_target_desc() - not applicable - pre-initialized.  */
119
120
121 /* The following are initialized by the target dependent code.  */
122
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. */
125
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);
128
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:
132   
133    Number of bits in a short or unsigned short for the target machine. */
134
135 extern int gdbarch_short_bit (struct gdbarch *gdbarch);
136 extern void set_gdbarch_short_bit (struct gdbarch *gdbarch, int short_bit);
137
138 /* Number of bits in an int or unsigned int for the target machine. */
139
140 extern int gdbarch_int_bit (struct gdbarch *gdbarch);
141 extern void set_gdbarch_int_bit (struct gdbarch *gdbarch, int int_bit);
142
143 /* Number of bits in a long or unsigned long for the target machine. */
144
145 extern int gdbarch_long_bit (struct gdbarch *gdbarch);
146 extern void set_gdbarch_long_bit (struct gdbarch *gdbarch, int long_bit);
147
148 /* Number of bits in a long long or unsigned long long for the target
149    machine. */
150
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);
153
154 /* Alignment of a long long or unsigned long long for the target
155    machine. */
156
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);
159
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
164    useful). */
165
166 extern int gdbarch_half_bit (struct gdbarch *gdbarch);
167 extern void set_gdbarch_half_bit (struct gdbarch *gdbarch, int half_bit);
168
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);
171
172 extern int gdbarch_float_bit (struct gdbarch *gdbarch);
173 extern void set_gdbarch_float_bit (struct gdbarch *gdbarch, int float_bit);
174
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);
177
178 extern int gdbarch_double_bit (struct gdbarch *gdbarch);
179 extern void set_gdbarch_double_bit (struct gdbarch *gdbarch, int double_bit);
180
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);
183
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);
186
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);
189
190 /* Returns the floating-point format to be used for values of length LENGTH.
191    NAME, if non-NULL, is the type name, which may be used to distinguish
192    different target formats of the same length. */
193
194 typedef const struct floatformat ** (gdbarch_floatformat_for_type_ftype) (struct gdbarch *gdbarch, const char *name, int length);
195 extern const struct floatformat ** gdbarch_floatformat_for_type (struct gdbarch *gdbarch, const char *name, int length);
196 extern void set_gdbarch_floatformat_for_type (struct gdbarch *gdbarch, gdbarch_floatformat_for_type_ftype *floatformat_for_type);
197
198 /* For most targets, a pointer on the target and its representation as an
199    address in GDB have the same size and "look the same".  For such a
200    target, you need only set gdbarch_ptr_bit and gdbarch_addr_bit
201    / addr_bit will be set from it.
202   
203    If gdbarch_ptr_bit and gdbarch_addr_bit are different, you'll probably
204    also need to set gdbarch_dwarf2_addr_size, gdbarch_pointer_to_address and
205    gdbarch_address_to_pointer as well.
206   
207    ptr_bit is the size of a pointer on the target */
208
209 extern int gdbarch_ptr_bit (struct gdbarch *gdbarch);
210 extern void set_gdbarch_ptr_bit (struct gdbarch *gdbarch, int ptr_bit);
211
212 /* addr_bit is the size of a target address as represented in gdb */
213
214 extern int gdbarch_addr_bit (struct gdbarch *gdbarch);
215 extern void set_gdbarch_addr_bit (struct gdbarch *gdbarch, int addr_bit);
216
217 /* dwarf2_addr_size is the target address size as used in the Dwarf debug
218    info.  For .debug_frame FDEs, this is supposed to be the target address
219    size from the associated CU header, and which is equivalent to the
220    DWARF2_ADDR_SIZE as defined by the target specific GCC back-end.
221    Unfortunately there is no good way to determine this value.  Therefore
222    dwarf2_addr_size simply defaults to the target pointer size.
223   
224    dwarf2_addr_size is not used for .eh_frame FDEs, which are generally
225    defined using the target's pointer size so far.
226   
227    Note that dwarf2_addr_size only needs to be redefined by a target if the
228    GCC back-end defines a DWARF2_ADDR_SIZE other than the target pointer size,
229    and if Dwarf versions < 4 need to be supported. */
230
231 extern int gdbarch_dwarf2_addr_size (struct gdbarch *gdbarch);
232 extern void set_gdbarch_dwarf2_addr_size (struct gdbarch *gdbarch, int dwarf2_addr_size);
233
234 /* One if `char' acts like `signed char', zero if `unsigned char'. */
235
236 extern int gdbarch_char_signed (struct gdbarch *gdbarch);
237 extern void set_gdbarch_char_signed (struct gdbarch *gdbarch, int char_signed);
238
239 extern int gdbarch_read_pc_p (struct gdbarch *gdbarch);
240
241 typedef CORE_ADDR (gdbarch_read_pc_ftype) (struct regcache *regcache);
242 extern CORE_ADDR gdbarch_read_pc (struct gdbarch *gdbarch, struct regcache *regcache);
243 extern void set_gdbarch_read_pc (struct gdbarch *gdbarch, gdbarch_read_pc_ftype *read_pc);
244
245 extern int gdbarch_write_pc_p (struct gdbarch *gdbarch);
246
247 typedef void (gdbarch_write_pc_ftype) (struct regcache *regcache, CORE_ADDR val);
248 extern void gdbarch_write_pc (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR val);
249 extern void set_gdbarch_write_pc (struct gdbarch *gdbarch, gdbarch_write_pc_ftype *write_pc);
250
251 /* Function for getting target's idea of a frame pointer.  FIXME: GDB's
252    whole scheme for dealing with "frames" and "frame pointers" needs a
253    serious shakedown. */
254
255 typedef void (gdbarch_virtual_frame_pointer_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc, int *frame_regnum, LONGEST *frame_offset);
256 extern void gdbarch_virtual_frame_pointer (struct gdbarch *gdbarch, CORE_ADDR pc, int *frame_regnum, LONGEST *frame_offset);
257 extern void set_gdbarch_virtual_frame_pointer (struct gdbarch *gdbarch, gdbarch_virtual_frame_pointer_ftype *virtual_frame_pointer);
258
259 extern int gdbarch_pseudo_register_read_p (struct gdbarch *gdbarch);
260
261 typedef enum register_status (gdbarch_pseudo_register_read_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, gdb_byte *buf);
262 extern enum register_status gdbarch_pseudo_register_read (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, gdb_byte *buf);
263 extern void set_gdbarch_pseudo_register_read (struct gdbarch *gdbarch, gdbarch_pseudo_register_read_ftype *pseudo_register_read);
264
265 /* Read a register into a new struct value.  If the register is wholly
266    or partly unavailable, this should call mark_value_bytes_unavailable
267    as appropriate.  If this is defined, then pseudo_register_read will
268    never be called. */
269
270 extern int gdbarch_pseudo_register_read_value_p (struct gdbarch *gdbarch);
271
272 typedef struct value * (gdbarch_pseudo_register_read_value_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum);
273 extern struct value * gdbarch_pseudo_register_read_value (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum);
274 extern void set_gdbarch_pseudo_register_read_value (struct gdbarch *gdbarch, gdbarch_pseudo_register_read_value_ftype *pseudo_register_read_value);
275
276 extern int gdbarch_pseudo_register_write_p (struct gdbarch *gdbarch);
277
278 typedef void (gdbarch_pseudo_register_write_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, const gdb_byte *buf);
279 extern void gdbarch_pseudo_register_write (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, const gdb_byte *buf);
280 extern void set_gdbarch_pseudo_register_write (struct gdbarch *gdbarch, gdbarch_pseudo_register_write_ftype *pseudo_register_write);
281
282 extern int gdbarch_num_regs (struct gdbarch *gdbarch);
283 extern void set_gdbarch_num_regs (struct gdbarch *gdbarch, int num_regs);
284
285 /* This macro gives the number of pseudo-registers that live in the
286    register namespace but do not get fetched or stored on the target.
287    These pseudo-registers may be aliases for other registers,
288    combinations of other registers, or they may be computed by GDB. */
289
290 extern int gdbarch_num_pseudo_regs (struct gdbarch *gdbarch);
291 extern void set_gdbarch_num_pseudo_regs (struct gdbarch *gdbarch, int num_pseudo_regs);
292
293 /* Assemble agent expression bytecode to collect pseudo-register REG.
294    Return -1 if something goes wrong, 0 otherwise. */
295
296 extern int gdbarch_ax_pseudo_register_collect_p (struct gdbarch *gdbarch);
297
298 typedef int (gdbarch_ax_pseudo_register_collect_ftype) (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
299 extern int gdbarch_ax_pseudo_register_collect (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
300 extern void set_gdbarch_ax_pseudo_register_collect (struct gdbarch *gdbarch, gdbarch_ax_pseudo_register_collect_ftype *ax_pseudo_register_collect);
301
302 /* Assemble agent expression bytecode to push the value of pseudo-register
303    REG on the interpreter stack.
304    Return -1 if something goes wrong, 0 otherwise. */
305
306 extern int gdbarch_ax_pseudo_register_push_stack_p (struct gdbarch *gdbarch);
307
308 typedef int (gdbarch_ax_pseudo_register_push_stack_ftype) (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
309 extern int gdbarch_ax_pseudo_register_push_stack (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
310 extern void set_gdbarch_ax_pseudo_register_push_stack (struct gdbarch *gdbarch, gdbarch_ax_pseudo_register_push_stack_ftype *ax_pseudo_register_push_stack);
311
312 /* Some targets/architectures can do extra processing/display of
313    segmentation faults.  E.g., Intel MPX boundary faults.
314    Call the architecture dependent function to handle the fault.
315    UIOUT is the output stream where the handler will place information. */
316
317 extern int gdbarch_handle_segmentation_fault_p (struct gdbarch *gdbarch);
318
319 typedef void (gdbarch_handle_segmentation_fault_ftype) (struct gdbarch *gdbarch, struct ui_out *uiout);
320 extern void gdbarch_handle_segmentation_fault (struct gdbarch *gdbarch, struct ui_out *uiout);
321 extern void set_gdbarch_handle_segmentation_fault (struct gdbarch *gdbarch, gdbarch_handle_segmentation_fault_ftype *handle_segmentation_fault);
322
323 /* GDB's standard (or well known) register numbers.  These can map onto
324    a real register or a pseudo (computed) register or not be defined at
325    all (-1).
326    gdbarch_sp_regnum will hopefully be replaced by UNWIND_SP. */
327
328 extern int gdbarch_sp_regnum (struct gdbarch *gdbarch);
329 extern void set_gdbarch_sp_regnum (struct gdbarch *gdbarch, int sp_regnum);
330
331 extern int gdbarch_pc_regnum (struct gdbarch *gdbarch);
332 extern void set_gdbarch_pc_regnum (struct gdbarch *gdbarch, int pc_regnum);
333
334 extern int gdbarch_ps_regnum (struct gdbarch *gdbarch);
335 extern void set_gdbarch_ps_regnum (struct gdbarch *gdbarch, int ps_regnum);
336
337 extern int gdbarch_fp0_regnum (struct gdbarch *gdbarch);
338 extern void set_gdbarch_fp0_regnum (struct gdbarch *gdbarch, int fp0_regnum);
339
340 /* Convert stab register number (from `r' declaration) to a gdb REGNUM. */
341
342 typedef int (gdbarch_stab_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int stab_regnr);
343 extern int gdbarch_stab_reg_to_regnum (struct gdbarch *gdbarch, int stab_regnr);
344 extern void set_gdbarch_stab_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_stab_reg_to_regnum_ftype *stab_reg_to_regnum);
345
346 /* Provide a default mapping from a ecoff register number to a gdb REGNUM. */
347
348 typedef int (gdbarch_ecoff_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int ecoff_regnr);
349 extern int gdbarch_ecoff_reg_to_regnum (struct gdbarch *gdbarch, int ecoff_regnr);
350 extern void set_gdbarch_ecoff_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_ecoff_reg_to_regnum_ftype *ecoff_reg_to_regnum);
351
352 /* Convert from an sdb register number to an internal gdb register number. */
353
354 typedef int (gdbarch_sdb_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int sdb_regnr);
355 extern int gdbarch_sdb_reg_to_regnum (struct gdbarch *gdbarch, int sdb_regnr);
356 extern void set_gdbarch_sdb_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_sdb_reg_to_regnum_ftype *sdb_reg_to_regnum);
357
358 /* Provide a default mapping from a DWARF2 register number to a gdb REGNUM.
359    Return -1 for bad REGNUM.  Note: Several targets get this wrong. */
360
361 typedef int (gdbarch_dwarf2_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int dwarf2_regnr);
362 extern int gdbarch_dwarf2_reg_to_regnum (struct gdbarch *gdbarch, int dwarf2_regnr);
363 extern void set_gdbarch_dwarf2_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_dwarf2_reg_to_regnum_ftype *dwarf2_reg_to_regnum);
364
365 typedef const char * (gdbarch_register_name_ftype) (struct gdbarch *gdbarch, int regnr);
366 extern const char * gdbarch_register_name (struct gdbarch *gdbarch, int regnr);
367 extern void set_gdbarch_register_name (struct gdbarch *gdbarch, gdbarch_register_name_ftype *register_name);
368
369 /* Return the type of a register specified by the architecture.  Only
370    the register cache should call this function directly; others should
371    use "register_type". */
372
373 extern int gdbarch_register_type_p (struct gdbarch *gdbarch);
374
375 typedef struct type * (gdbarch_register_type_ftype) (struct gdbarch *gdbarch, int reg_nr);
376 extern struct type * gdbarch_register_type (struct gdbarch *gdbarch, int reg_nr);
377 extern void set_gdbarch_register_type (struct gdbarch *gdbarch, gdbarch_register_type_ftype *register_type);
378
379 extern int gdbarch_dummy_id_p (struct gdbarch *gdbarch);
380
381 typedef struct frame_id (gdbarch_dummy_id_ftype) (struct gdbarch *gdbarch, struct frame_info *this_frame);
382 extern struct frame_id gdbarch_dummy_id (struct gdbarch *gdbarch, struct frame_info *this_frame);
383 extern void set_gdbarch_dummy_id (struct gdbarch *gdbarch, gdbarch_dummy_id_ftype *dummy_id);
384
385 /* Implement DUMMY_ID and PUSH_DUMMY_CALL, then delete
386    deprecated_fp_regnum. */
387
388 extern int gdbarch_deprecated_fp_regnum (struct gdbarch *gdbarch);
389 extern void set_gdbarch_deprecated_fp_regnum (struct gdbarch *gdbarch, int deprecated_fp_regnum);
390
391 extern int gdbarch_push_dummy_call_p (struct gdbarch *gdbarch);
392
393 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);
394 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);
395 extern void set_gdbarch_push_dummy_call (struct gdbarch *gdbarch, gdbarch_push_dummy_call_ftype *push_dummy_call);
396
397 extern int gdbarch_call_dummy_location (struct gdbarch *gdbarch);
398 extern void set_gdbarch_call_dummy_location (struct gdbarch *gdbarch, int call_dummy_location);
399
400 extern int gdbarch_push_dummy_code_p (struct gdbarch *gdbarch);
401
402 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);
403 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);
404 extern void set_gdbarch_push_dummy_code (struct gdbarch *gdbarch, gdbarch_push_dummy_code_ftype *push_dummy_code);
405
406 /* Return true if the code of FRAME is writable. */
407
408 typedef int (gdbarch_code_of_frame_writable_ftype) (struct gdbarch *gdbarch, struct frame_info *frame);
409 extern int gdbarch_code_of_frame_writable (struct gdbarch *gdbarch, struct frame_info *frame);
410 extern void set_gdbarch_code_of_frame_writable (struct gdbarch *gdbarch, gdbarch_code_of_frame_writable_ftype *code_of_frame_writable);
411
412 typedef void (gdbarch_print_registers_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, int regnum, int all);
413 extern void gdbarch_print_registers_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, int regnum, int all);
414 extern void set_gdbarch_print_registers_info (struct gdbarch *gdbarch, gdbarch_print_registers_info_ftype *print_registers_info);
415
416 typedef void (gdbarch_print_float_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
417 extern void gdbarch_print_float_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
418 extern void set_gdbarch_print_float_info (struct gdbarch *gdbarch, gdbarch_print_float_info_ftype *print_float_info);
419
420 extern int gdbarch_print_vector_info_p (struct gdbarch *gdbarch);
421
422 typedef void (gdbarch_print_vector_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
423 extern void gdbarch_print_vector_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
424 extern void set_gdbarch_print_vector_info (struct gdbarch *gdbarch, gdbarch_print_vector_info_ftype *print_vector_info);
425
426 /* MAP a GDB RAW register number onto a simulator register number.  See
427    also include/...-sim.h. */
428
429 typedef int (gdbarch_register_sim_regno_ftype) (struct gdbarch *gdbarch, int reg_nr);
430 extern int gdbarch_register_sim_regno (struct gdbarch *gdbarch, int reg_nr);
431 extern void set_gdbarch_register_sim_regno (struct gdbarch *gdbarch, gdbarch_register_sim_regno_ftype *register_sim_regno);
432
433 typedef int (gdbarch_cannot_fetch_register_ftype) (struct gdbarch *gdbarch, int regnum);
434 extern int gdbarch_cannot_fetch_register (struct gdbarch *gdbarch, int regnum);
435 extern void set_gdbarch_cannot_fetch_register (struct gdbarch *gdbarch, gdbarch_cannot_fetch_register_ftype *cannot_fetch_register);
436
437 typedef int (gdbarch_cannot_store_register_ftype) (struct gdbarch *gdbarch, int regnum);
438 extern int gdbarch_cannot_store_register (struct gdbarch *gdbarch, int regnum);
439 extern void set_gdbarch_cannot_store_register (struct gdbarch *gdbarch, gdbarch_cannot_store_register_ftype *cannot_store_register);
440
441 /* Determine the address where a longjmp will land and save this address
442    in PC.  Return nonzero on success.
443   
444    FRAME corresponds to the longjmp frame. */
445
446 extern int gdbarch_get_longjmp_target_p (struct gdbarch *gdbarch);
447
448 typedef int (gdbarch_get_longjmp_target_ftype) (struct frame_info *frame, CORE_ADDR *pc);
449 extern int gdbarch_get_longjmp_target (struct gdbarch *gdbarch, struct frame_info *frame, CORE_ADDR *pc);
450 extern void set_gdbarch_get_longjmp_target (struct gdbarch *gdbarch, gdbarch_get_longjmp_target_ftype *get_longjmp_target);
451
452 extern int gdbarch_believe_pcc_promotion (struct gdbarch *gdbarch);
453 extern void set_gdbarch_believe_pcc_promotion (struct gdbarch *gdbarch, int believe_pcc_promotion);
454
455 typedef int (gdbarch_convert_register_p_ftype) (struct gdbarch *gdbarch, int regnum, struct type *type);
456 extern int gdbarch_convert_register_p (struct gdbarch *gdbarch, int regnum, struct type *type);
457 extern void set_gdbarch_convert_register_p (struct gdbarch *gdbarch, gdbarch_convert_register_p_ftype *convert_register_p);
458
459 typedef int (gdbarch_register_to_value_ftype) (struct frame_info *frame, int regnum, struct type *type, gdb_byte *buf, int *optimizedp, int *unavailablep);
460 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);
461 extern void set_gdbarch_register_to_value (struct gdbarch *gdbarch, gdbarch_register_to_value_ftype *register_to_value);
462
463 typedef void (gdbarch_value_to_register_ftype) (struct frame_info *frame, int regnum, struct type *type, const gdb_byte *buf);
464 extern void gdbarch_value_to_register (struct gdbarch *gdbarch, struct frame_info *frame, int regnum, struct type *type, const gdb_byte *buf);
465 extern void set_gdbarch_value_to_register (struct gdbarch *gdbarch, gdbarch_value_to_register_ftype *value_to_register);
466
467 /* Construct a value representing the contents of register REGNUM in
468    frame FRAME_ID, interpreted as type TYPE.  The routine needs to
469    allocate and return a struct value with all value attributes
470    (but not the value contents) filled in. */
471
472 typedef struct value * (gdbarch_value_from_register_ftype) (struct gdbarch *gdbarch, struct type *type, int regnum, struct frame_id frame_id);
473 extern struct value * gdbarch_value_from_register (struct gdbarch *gdbarch, struct type *type, int regnum, struct frame_id frame_id);
474 extern void set_gdbarch_value_from_register (struct gdbarch *gdbarch, gdbarch_value_from_register_ftype *value_from_register);
475
476 typedef CORE_ADDR (gdbarch_pointer_to_address_ftype) (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
477 extern CORE_ADDR gdbarch_pointer_to_address (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
478 extern void set_gdbarch_pointer_to_address (struct gdbarch *gdbarch, gdbarch_pointer_to_address_ftype *pointer_to_address);
479
480 typedef void (gdbarch_address_to_pointer_ftype) (struct gdbarch *gdbarch, struct type *type, gdb_byte *buf, CORE_ADDR addr);
481 extern void gdbarch_address_to_pointer (struct gdbarch *gdbarch, struct type *type, gdb_byte *buf, CORE_ADDR addr);
482 extern void set_gdbarch_address_to_pointer (struct gdbarch *gdbarch, gdbarch_address_to_pointer_ftype *address_to_pointer);
483
484 extern int gdbarch_integer_to_address_p (struct gdbarch *gdbarch);
485
486 typedef CORE_ADDR (gdbarch_integer_to_address_ftype) (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
487 extern CORE_ADDR gdbarch_integer_to_address (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
488 extern void set_gdbarch_integer_to_address (struct gdbarch *gdbarch, gdbarch_integer_to_address_ftype *integer_to_address);
489
490 /* Return the return-value convention that will be used by FUNCTION
491    to return a value of type VALTYPE.  FUNCTION may be NULL in which
492    case the return convention is computed based only on VALTYPE.
493   
494    If READBUF is not NULL, extract the return value and save it in this buffer.
495   
496    If WRITEBUF is not NULL, it contains a return value which will be
497    stored into the appropriate register.  This can be used when we want
498    to force the value returned by a function (see the "return" command
499    for instance). */
500
501 extern int gdbarch_return_value_p (struct gdbarch *gdbarch);
502
503 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);
504 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);
505 extern void set_gdbarch_return_value (struct gdbarch *gdbarch, gdbarch_return_value_ftype *return_value);
506
507 /* Return true if the return value of function is stored in the first hidden
508    parameter.  In theory, this feature should be language-dependent, specified
509    by language and its ABI, such as C++.  Unfortunately, compiler may
510    implement it to a target-dependent feature.  So that we need such hook here
511    to be aware of this in GDB. */
512
513 typedef int (gdbarch_return_in_first_hidden_param_p_ftype) (struct gdbarch *gdbarch, struct type *type);
514 extern int gdbarch_return_in_first_hidden_param_p (struct gdbarch *gdbarch, struct type *type);
515 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);
516
517 typedef CORE_ADDR (gdbarch_skip_prologue_ftype) (struct gdbarch *gdbarch, CORE_ADDR ip);
518 extern CORE_ADDR gdbarch_skip_prologue (struct gdbarch *gdbarch, CORE_ADDR ip);
519 extern void set_gdbarch_skip_prologue (struct gdbarch *gdbarch, gdbarch_skip_prologue_ftype *skip_prologue);
520
521 extern int gdbarch_skip_main_prologue_p (struct gdbarch *gdbarch);
522
523 typedef CORE_ADDR (gdbarch_skip_main_prologue_ftype) (struct gdbarch *gdbarch, CORE_ADDR ip);
524 extern CORE_ADDR gdbarch_skip_main_prologue (struct gdbarch *gdbarch, CORE_ADDR ip);
525 extern void set_gdbarch_skip_main_prologue (struct gdbarch *gdbarch, gdbarch_skip_main_prologue_ftype *skip_main_prologue);
526
527 /* On some platforms, a single function may provide multiple entry points,
528    e.g. one that is used for function-pointer calls and a different one
529    that is used for direct function calls.
530    In order to ensure that breakpoints set on the function will trigger
531    no matter via which entry point the function is entered, a platform
532    may provide the skip_entrypoint callback.  It is called with IP set
533    to the main entry point of a function (as determined by the symbol table),
534    and should return the address of the innermost entry point, where the
535    actual breakpoint needs to be set.  Note that skip_entrypoint is used
536    by GDB common code even when debugging optimized code, where skip_prologue
537    is not used. */
538
539 extern int gdbarch_skip_entrypoint_p (struct gdbarch *gdbarch);
540
541 typedef CORE_ADDR (gdbarch_skip_entrypoint_ftype) (struct gdbarch *gdbarch, CORE_ADDR ip);
542 extern CORE_ADDR gdbarch_skip_entrypoint (struct gdbarch *gdbarch, CORE_ADDR ip);
543 extern void set_gdbarch_skip_entrypoint (struct gdbarch *gdbarch, gdbarch_skip_entrypoint_ftype *skip_entrypoint);
544
545 typedef int (gdbarch_inner_than_ftype) (CORE_ADDR lhs, CORE_ADDR rhs);
546 extern int gdbarch_inner_than (struct gdbarch *gdbarch, CORE_ADDR lhs, CORE_ADDR rhs);
547 extern void set_gdbarch_inner_than (struct gdbarch *gdbarch, gdbarch_inner_than_ftype *inner_than);
548
549 typedef const gdb_byte * (gdbarch_breakpoint_from_pc_ftype) (struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *lenptr);
550 extern const gdb_byte * gdbarch_breakpoint_from_pc (struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *lenptr);
551 extern void set_gdbarch_breakpoint_from_pc (struct gdbarch *gdbarch, gdbarch_breakpoint_from_pc_ftype *breakpoint_from_pc);
552
553 /* Return the breakpoint kind for this target based on *PCPTR. */
554
555 typedef int (gdbarch_breakpoint_kind_from_pc_ftype) (struct gdbarch *gdbarch, CORE_ADDR *pcptr);
556 extern int gdbarch_breakpoint_kind_from_pc (struct gdbarch *gdbarch, CORE_ADDR *pcptr);
557 extern void set_gdbarch_breakpoint_kind_from_pc (struct gdbarch *gdbarch, gdbarch_breakpoint_kind_from_pc_ftype *breakpoint_kind_from_pc);
558
559 /* Return the software breakpoint from KIND.  KIND can have target
560    specific meaning like the Z0 kind parameter.
561    SIZE is set to the software breakpoint's length in memory. */
562
563 typedef const gdb_byte * (gdbarch_sw_breakpoint_from_kind_ftype) (struct gdbarch *gdbarch, int kind, int *size);
564 extern const gdb_byte * gdbarch_sw_breakpoint_from_kind (struct gdbarch *gdbarch, int kind, int *size);
565 extern void set_gdbarch_sw_breakpoint_from_kind (struct gdbarch *gdbarch, gdbarch_sw_breakpoint_from_kind_ftype *sw_breakpoint_from_kind);
566
567 extern int gdbarch_adjust_breakpoint_address_p (struct gdbarch *gdbarch);
568
569 typedef CORE_ADDR (gdbarch_adjust_breakpoint_address_ftype) (struct gdbarch *gdbarch, CORE_ADDR bpaddr);
570 extern CORE_ADDR gdbarch_adjust_breakpoint_address (struct gdbarch *gdbarch, CORE_ADDR bpaddr);
571 extern void set_gdbarch_adjust_breakpoint_address (struct gdbarch *gdbarch, gdbarch_adjust_breakpoint_address_ftype *adjust_breakpoint_address);
572
573 typedef int (gdbarch_memory_insert_breakpoint_ftype) (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
574 extern int gdbarch_memory_insert_breakpoint (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
575 extern void set_gdbarch_memory_insert_breakpoint (struct gdbarch *gdbarch, gdbarch_memory_insert_breakpoint_ftype *memory_insert_breakpoint);
576
577 typedef int (gdbarch_memory_remove_breakpoint_ftype) (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
578 extern int gdbarch_memory_remove_breakpoint (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
579 extern void set_gdbarch_memory_remove_breakpoint (struct gdbarch *gdbarch, gdbarch_memory_remove_breakpoint_ftype *memory_remove_breakpoint);
580
581 extern CORE_ADDR gdbarch_decr_pc_after_break (struct gdbarch *gdbarch);
582 extern void set_gdbarch_decr_pc_after_break (struct gdbarch *gdbarch, CORE_ADDR decr_pc_after_break);
583
584 /* A function can be addressed by either it's "pointer" (possibly a
585    descriptor address) or "entry point" (first executable instruction).
586    The method "convert_from_func_ptr_addr" converting the former to the
587    latter.  gdbarch_deprecated_function_start_offset is being used to implement
588    a simplified subset of that functionality - the function's address
589    corresponds to the "function pointer" and the function's start
590    corresponds to the "function entry point" - and hence is redundant. */
591
592 extern CORE_ADDR gdbarch_deprecated_function_start_offset (struct gdbarch *gdbarch);
593 extern void set_gdbarch_deprecated_function_start_offset (struct gdbarch *gdbarch, CORE_ADDR deprecated_function_start_offset);
594
595 /* Return the remote protocol register number associated with this
596    register.  Normally the identity mapping. */
597
598 typedef int (gdbarch_remote_register_number_ftype) (struct gdbarch *gdbarch, int regno);
599 extern int gdbarch_remote_register_number (struct gdbarch *gdbarch, int regno);
600 extern void set_gdbarch_remote_register_number (struct gdbarch *gdbarch, gdbarch_remote_register_number_ftype *remote_register_number);
601
602 /* Fetch the target specific address used to represent a load module. */
603
604 extern int gdbarch_fetch_tls_load_module_address_p (struct gdbarch *gdbarch);
605
606 typedef CORE_ADDR (gdbarch_fetch_tls_load_module_address_ftype) (struct objfile *objfile);
607 extern CORE_ADDR gdbarch_fetch_tls_load_module_address (struct gdbarch *gdbarch, struct objfile *objfile);
608 extern void set_gdbarch_fetch_tls_load_module_address (struct gdbarch *gdbarch, gdbarch_fetch_tls_load_module_address_ftype *fetch_tls_load_module_address);
609
610 extern CORE_ADDR gdbarch_frame_args_skip (struct gdbarch *gdbarch);
611 extern void set_gdbarch_frame_args_skip (struct gdbarch *gdbarch, CORE_ADDR frame_args_skip);
612
613 extern int gdbarch_unwind_pc_p (struct gdbarch *gdbarch);
614
615 typedef CORE_ADDR (gdbarch_unwind_pc_ftype) (struct gdbarch *gdbarch, struct frame_info *next_frame);
616 extern CORE_ADDR gdbarch_unwind_pc (struct gdbarch *gdbarch, struct frame_info *next_frame);
617 extern void set_gdbarch_unwind_pc (struct gdbarch *gdbarch, gdbarch_unwind_pc_ftype *unwind_pc);
618
619 extern int gdbarch_unwind_sp_p (struct gdbarch *gdbarch);
620
621 typedef CORE_ADDR (gdbarch_unwind_sp_ftype) (struct gdbarch *gdbarch, struct frame_info *next_frame);
622 extern CORE_ADDR gdbarch_unwind_sp (struct gdbarch *gdbarch, struct frame_info *next_frame);
623 extern void set_gdbarch_unwind_sp (struct gdbarch *gdbarch, gdbarch_unwind_sp_ftype *unwind_sp);
624
625 /* DEPRECATED_FRAME_LOCALS_ADDRESS as been replaced by the per-frame
626    frame-base.  Enable frame-base before frame-unwind. */
627
628 extern int gdbarch_frame_num_args_p (struct gdbarch *gdbarch);
629
630 typedef int (gdbarch_frame_num_args_ftype) (struct frame_info *frame);
631 extern int gdbarch_frame_num_args (struct gdbarch *gdbarch, struct frame_info *frame);
632 extern void set_gdbarch_frame_num_args (struct gdbarch *gdbarch, gdbarch_frame_num_args_ftype *frame_num_args);
633
634 extern int gdbarch_frame_align_p (struct gdbarch *gdbarch);
635
636 typedef CORE_ADDR (gdbarch_frame_align_ftype) (struct gdbarch *gdbarch, CORE_ADDR address);
637 extern CORE_ADDR gdbarch_frame_align (struct gdbarch *gdbarch, CORE_ADDR address);
638 extern void set_gdbarch_frame_align (struct gdbarch *gdbarch, gdbarch_frame_align_ftype *frame_align);
639
640 typedef int (gdbarch_stabs_argument_has_addr_ftype) (struct gdbarch *gdbarch, struct type *type);
641 extern int gdbarch_stabs_argument_has_addr (struct gdbarch *gdbarch, struct type *type);
642 extern void set_gdbarch_stabs_argument_has_addr (struct gdbarch *gdbarch, gdbarch_stabs_argument_has_addr_ftype *stabs_argument_has_addr);
643
644 extern int gdbarch_frame_red_zone_size (struct gdbarch *gdbarch);
645 extern void set_gdbarch_frame_red_zone_size (struct gdbarch *gdbarch, int frame_red_zone_size);
646
647 typedef CORE_ADDR (gdbarch_convert_from_func_ptr_addr_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr, struct target_ops *targ);
648 extern CORE_ADDR gdbarch_convert_from_func_ptr_addr (struct gdbarch *gdbarch, CORE_ADDR addr, struct target_ops *targ);
649 extern void set_gdbarch_convert_from_func_ptr_addr (struct gdbarch *gdbarch, gdbarch_convert_from_func_ptr_addr_ftype *convert_from_func_ptr_addr);
650
651 /* On some machines there are bits in addresses which are not really
652    part of the address, but are used by the kernel, the hardware, etc.
653    for special purposes.  gdbarch_addr_bits_remove takes out any such bits so
654    we get a "real" address such as one would find in a symbol table.
655    This is used only for addresses of instructions, and even then I'm
656    not sure it's used in all contexts.  It exists to deal with there
657    being a few stray bits in the PC which would mislead us, not as some
658    sort of generic thing to handle alignment or segmentation (it's
659    possible it should be in TARGET_READ_PC instead). */
660
661 typedef CORE_ADDR (gdbarch_addr_bits_remove_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
662 extern CORE_ADDR gdbarch_addr_bits_remove (struct gdbarch *gdbarch, CORE_ADDR addr);
663 extern void set_gdbarch_addr_bits_remove (struct gdbarch *gdbarch, gdbarch_addr_bits_remove_ftype *addr_bits_remove);
664
665 /* FIXME/cagney/2001-01-18: This should be split in two.  A target method that
666    indicates if the target needs software single step.  An ISA method to
667    implement it.
668   
669    FIXME/cagney/2001-01-18: The logic is backwards.  It should be asking if the
670    target can single step.  If not, then implement single step using breakpoints.
671   
672    A return value of 1 means that the software_single_step breakpoints
673    were inserted; 0 means they were not.  Multiple breakpoints may be
674    inserted for some instructions such as conditional branch.  However,
675    each implementation must always evaluate the condition and only put
676    the breakpoint at the branch destination if the condition is true, so
677    that we ensure forward progress when stepping past a conditional
678    branch to self. */
679
680 extern int gdbarch_software_single_step_p (struct gdbarch *gdbarch);
681
682 typedef int (gdbarch_software_single_step_ftype) (struct frame_info *frame);
683 extern int gdbarch_software_single_step (struct gdbarch *gdbarch, struct frame_info *frame);
684 extern void set_gdbarch_software_single_step (struct gdbarch *gdbarch, gdbarch_software_single_step_ftype *software_single_step);
685
686 /* Return non-zero if the processor is executing a delay slot and a
687    further single-step is needed before the instruction finishes. */
688
689 extern int gdbarch_single_step_through_delay_p (struct gdbarch *gdbarch);
690
691 typedef int (gdbarch_single_step_through_delay_ftype) (struct gdbarch *gdbarch, struct frame_info *frame);
692 extern int gdbarch_single_step_through_delay (struct gdbarch *gdbarch, struct frame_info *frame);
693 extern void set_gdbarch_single_step_through_delay (struct gdbarch *gdbarch, gdbarch_single_step_through_delay_ftype *single_step_through_delay);
694
695 /* FIXME: cagney/2003-08-28: Need to find a better way of selecting the
696    disassembler.  Perhaps objdump can handle it? */
697
698 typedef int (gdbarch_print_insn_ftype) (bfd_vma vma, struct disassemble_info *info);
699 extern int gdbarch_print_insn (struct gdbarch *gdbarch, bfd_vma vma, struct disassemble_info *info);
700 extern void set_gdbarch_print_insn (struct gdbarch *gdbarch, gdbarch_print_insn_ftype *print_insn);
701
702 typedef CORE_ADDR (gdbarch_skip_trampoline_code_ftype) (struct frame_info *frame, CORE_ADDR pc);
703 extern CORE_ADDR gdbarch_skip_trampoline_code (struct gdbarch *gdbarch, struct frame_info *frame, CORE_ADDR pc);
704 extern void set_gdbarch_skip_trampoline_code (struct gdbarch *gdbarch, gdbarch_skip_trampoline_code_ftype *skip_trampoline_code);
705
706 /* If in_solib_dynsym_resolve_code() returns true, and SKIP_SOLIB_RESOLVER
707    evaluates non-zero, this is the address where the debugger will place
708    a step-resume breakpoint to get us past the dynamic linker. */
709
710 typedef CORE_ADDR (gdbarch_skip_solib_resolver_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc);
711 extern CORE_ADDR gdbarch_skip_solib_resolver (struct gdbarch *gdbarch, CORE_ADDR pc);
712 extern void set_gdbarch_skip_solib_resolver (struct gdbarch *gdbarch, gdbarch_skip_solib_resolver_ftype *skip_solib_resolver);
713
714 /* Some systems also have trampoline code for returning from shared libs. */
715
716 typedef int (gdbarch_in_solib_return_trampoline_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc, const char *name);
717 extern int gdbarch_in_solib_return_trampoline (struct gdbarch *gdbarch, CORE_ADDR pc, const char *name);
718 extern void set_gdbarch_in_solib_return_trampoline (struct gdbarch *gdbarch, gdbarch_in_solib_return_trampoline_ftype *in_solib_return_trampoline);
719
720 /* A target might have problems with watchpoints as soon as the stack
721    frame of the current function has been destroyed.  This mostly happens
722    as the first action in a function's epilogue.  stack_frame_destroyed_p()
723    is defined to return a non-zero value if either the given addr is one
724    instruction after the stack destroying instruction up to the trailing
725    return instruction or if we can figure out that the stack frame has
726    already been invalidated regardless of the value of addr.  Targets
727    which don't suffer from that problem could just let this functionality
728    untouched. */
729
730 typedef int (gdbarch_stack_frame_destroyed_p_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
731 extern int gdbarch_stack_frame_destroyed_p (struct gdbarch *gdbarch, CORE_ADDR addr);
732 extern void set_gdbarch_stack_frame_destroyed_p (struct gdbarch *gdbarch, gdbarch_stack_frame_destroyed_p_ftype *stack_frame_destroyed_p);
733
734 /* Process an ELF symbol in the minimal symbol table in a backend-specific
735    way.  Normally this hook is supposed to do nothing, however if required,
736    then this hook can be used to apply tranformations to symbols that are
737    considered special in some way.  For example the MIPS backend uses it
738    to interpret `st_other' information to mark compressed code symbols so
739    that they can be treated in the appropriate manner in the processing of
740    the main symbol table and DWARF-2 records. */
741
742 extern int gdbarch_elf_make_msymbol_special_p (struct gdbarch *gdbarch);
743
744 typedef void (gdbarch_elf_make_msymbol_special_ftype) (asymbol *sym, struct minimal_symbol *msym);
745 extern void gdbarch_elf_make_msymbol_special (struct gdbarch *gdbarch, asymbol *sym, struct minimal_symbol *msym);
746 extern void set_gdbarch_elf_make_msymbol_special (struct gdbarch *gdbarch, gdbarch_elf_make_msymbol_special_ftype *elf_make_msymbol_special);
747
748 typedef void (gdbarch_coff_make_msymbol_special_ftype) (int val, struct minimal_symbol *msym);
749 extern void gdbarch_coff_make_msymbol_special (struct gdbarch *gdbarch, int val, struct minimal_symbol *msym);
750 extern void set_gdbarch_coff_make_msymbol_special (struct gdbarch *gdbarch, gdbarch_coff_make_msymbol_special_ftype *coff_make_msymbol_special);
751
752 /* Process a symbol in the main symbol table in a backend-specific way.
753    Normally this hook is supposed to do nothing, however if required,
754    then this hook can be used to apply tranformations to symbols that
755    are considered special in some way.  This is currently used by the
756    MIPS backend to make sure compressed code symbols have the ISA bit
757    set.  This in turn is needed for symbol values seen in GDB to match
758    the values used at the runtime by the program itself, for function
759    and label references. */
760
761 typedef void (gdbarch_make_symbol_special_ftype) (struct symbol *sym, struct objfile *objfile);
762 extern void gdbarch_make_symbol_special (struct gdbarch *gdbarch, struct symbol *sym, struct objfile *objfile);
763 extern void set_gdbarch_make_symbol_special (struct gdbarch *gdbarch, gdbarch_make_symbol_special_ftype *make_symbol_special);
764
765 /* Adjust the address retrieved from a DWARF-2 record other than a line
766    entry in a backend-specific way.  Normally this hook is supposed to
767    return the address passed unchanged, however if that is incorrect for
768    any reason, then this hook can be used to fix the address up in the
769    required manner.  This is currently used by the MIPS backend to make
770    sure addresses in FDE, range records, etc. referring to compressed
771    code have the ISA bit set, matching line information and the symbol
772    table. */
773
774 typedef CORE_ADDR (gdbarch_adjust_dwarf2_addr_ftype) (CORE_ADDR pc);
775 extern CORE_ADDR gdbarch_adjust_dwarf2_addr (struct gdbarch *gdbarch, CORE_ADDR pc);
776 extern void set_gdbarch_adjust_dwarf2_addr (struct gdbarch *gdbarch, gdbarch_adjust_dwarf2_addr_ftype *adjust_dwarf2_addr);
777
778 /* Adjust the address updated by a line entry in a backend-specific way.
779    Normally this hook is supposed to return the address passed unchanged,
780    however in the case of inconsistencies in these records, this hook can
781    be used to fix them up in the required manner.  This is currently used
782    by the MIPS backend to make sure all line addresses in compressed code
783    are presented with the ISA bit set, which is not always the case.  This
784    in turn ensures breakpoint addresses are correctly matched against the
785    stop PC. */
786
787 typedef CORE_ADDR (gdbarch_adjust_dwarf2_line_ftype) (CORE_ADDR addr, int rel);
788 extern CORE_ADDR gdbarch_adjust_dwarf2_line (struct gdbarch *gdbarch, CORE_ADDR addr, int rel);
789 extern void set_gdbarch_adjust_dwarf2_line (struct gdbarch *gdbarch, gdbarch_adjust_dwarf2_line_ftype *adjust_dwarf2_line);
790
791 extern int gdbarch_cannot_step_breakpoint (struct gdbarch *gdbarch);
792 extern void set_gdbarch_cannot_step_breakpoint (struct gdbarch *gdbarch, int cannot_step_breakpoint);
793
794 extern int gdbarch_have_nonsteppable_watchpoint (struct gdbarch *gdbarch);
795 extern void set_gdbarch_have_nonsteppable_watchpoint (struct gdbarch *gdbarch, int have_nonsteppable_watchpoint);
796
797 extern int gdbarch_address_class_type_flags_p (struct gdbarch *gdbarch);
798
799 typedef int (gdbarch_address_class_type_flags_ftype) (int byte_size, int dwarf2_addr_class);
800 extern int gdbarch_address_class_type_flags (struct gdbarch *gdbarch, int byte_size, int dwarf2_addr_class);
801 extern void set_gdbarch_address_class_type_flags (struct gdbarch *gdbarch, gdbarch_address_class_type_flags_ftype *address_class_type_flags);
802
803 extern int gdbarch_address_class_type_flags_to_name_p (struct gdbarch *gdbarch);
804
805 typedef const char * (gdbarch_address_class_type_flags_to_name_ftype) (struct gdbarch *gdbarch, int type_flags);
806 extern const char * gdbarch_address_class_type_flags_to_name (struct gdbarch *gdbarch, int type_flags);
807 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);
808
809 /* Return the appropriate type_flags for the supplied address class.
810    This function should return 1 if the address class was recognized and
811    type_flags was set, zero otherwise. */
812
813 extern int gdbarch_address_class_name_to_type_flags_p (struct gdbarch *gdbarch);
814
815 typedef int (gdbarch_address_class_name_to_type_flags_ftype) (struct gdbarch *gdbarch, const char *name, int *type_flags_ptr);
816 extern int gdbarch_address_class_name_to_type_flags (struct gdbarch *gdbarch, const char *name, int *type_flags_ptr);
817 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);
818
819 /* Is a register in a group */
820
821 typedef int (gdbarch_register_reggroup_p_ftype) (struct gdbarch *gdbarch, int regnum, struct reggroup *reggroup);
822 extern int gdbarch_register_reggroup_p (struct gdbarch *gdbarch, int regnum, struct reggroup *reggroup);
823 extern void set_gdbarch_register_reggroup_p (struct gdbarch *gdbarch, gdbarch_register_reggroup_p_ftype *register_reggroup_p);
824
825 /* Fetch the pointer to the ith function argument. */
826
827 extern int gdbarch_fetch_pointer_argument_p (struct gdbarch *gdbarch);
828
829 typedef CORE_ADDR (gdbarch_fetch_pointer_argument_ftype) (struct frame_info *frame, int argi, struct type *type);
830 extern CORE_ADDR gdbarch_fetch_pointer_argument (struct gdbarch *gdbarch, struct frame_info *frame, int argi, struct type *type);
831 extern void set_gdbarch_fetch_pointer_argument (struct gdbarch *gdbarch, gdbarch_fetch_pointer_argument_ftype *fetch_pointer_argument);
832
833 /* Iterate over all supported register notes in a core file.  For each
834    supported register note section, the iterator must call CB and pass
835    CB_DATA unchanged.  If REGCACHE is not NULL, the iterator can limit
836    the supported register note sections based on the current register
837    values.  Otherwise it should enumerate all supported register note
838    sections. */
839
840 extern int gdbarch_iterate_over_regset_sections_p (struct gdbarch *gdbarch);
841
842 typedef void (gdbarch_iterate_over_regset_sections_ftype) (struct gdbarch *gdbarch, iterate_over_regset_sections_cb *cb, void *cb_data, const struct regcache *regcache);
843 extern void gdbarch_iterate_over_regset_sections (struct gdbarch *gdbarch, iterate_over_regset_sections_cb *cb, void *cb_data, const struct regcache *regcache);
844 extern void set_gdbarch_iterate_over_regset_sections (struct gdbarch *gdbarch, gdbarch_iterate_over_regset_sections_ftype *iterate_over_regset_sections);
845
846 /* Create core file notes */
847
848 extern int gdbarch_make_corefile_notes_p (struct gdbarch *gdbarch);
849
850 typedef char * (gdbarch_make_corefile_notes_ftype) (struct gdbarch *gdbarch, bfd *obfd, int *note_size);
851 extern char * gdbarch_make_corefile_notes (struct gdbarch *gdbarch, bfd *obfd, int *note_size);
852 extern void set_gdbarch_make_corefile_notes (struct gdbarch *gdbarch, gdbarch_make_corefile_notes_ftype *make_corefile_notes);
853
854 /* The elfcore writer hook to use to write Linux prpsinfo notes to core
855    files.  Most Linux architectures use the same prpsinfo32 or
856    prpsinfo64 layouts, and so won't need to provide this hook, as we
857    call the Linux generic routines in bfd to write prpsinfo notes by
858    default. */
859
860 extern int gdbarch_elfcore_write_linux_prpsinfo_p (struct gdbarch *gdbarch);
861
862 typedef char * (gdbarch_elfcore_write_linux_prpsinfo_ftype) (bfd *obfd, char *note_data, int *note_size, const struct elf_internal_linux_prpsinfo *info);
863 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);
864 extern void set_gdbarch_elfcore_write_linux_prpsinfo (struct gdbarch *gdbarch, gdbarch_elfcore_write_linux_prpsinfo_ftype *elfcore_write_linux_prpsinfo);
865
866 /* Find core file memory regions */
867
868 extern int gdbarch_find_memory_regions_p (struct gdbarch *gdbarch);
869
870 typedef int (gdbarch_find_memory_regions_ftype) (struct gdbarch *gdbarch, find_memory_region_ftype func, void *data);
871 extern int gdbarch_find_memory_regions (struct gdbarch *gdbarch, find_memory_region_ftype func, void *data);
872 extern void set_gdbarch_find_memory_regions (struct gdbarch *gdbarch, gdbarch_find_memory_regions_ftype *find_memory_regions);
873
874 /* Read offset OFFSET of TARGET_OBJECT_LIBRARIES formatted shared libraries list from
875    core file into buffer READBUF with length LEN.  Return the number of bytes read
876    (zero indicates failure).
877    failed, otherwise, return the red length of READBUF. */
878
879 extern int gdbarch_core_xfer_shared_libraries_p (struct gdbarch *gdbarch);
880
881 typedef ULONGEST (gdbarch_core_xfer_shared_libraries_ftype) (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
882 extern ULONGEST gdbarch_core_xfer_shared_libraries (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
883 extern void set_gdbarch_core_xfer_shared_libraries (struct gdbarch *gdbarch, gdbarch_core_xfer_shared_libraries_ftype *core_xfer_shared_libraries);
884
885 /* Read offset OFFSET of TARGET_OBJECT_LIBRARIES_AIX formatted shared
886    libraries list from core file into buffer READBUF with length LEN.
887    Return the number of bytes read (zero indicates failure). */
888
889 extern int gdbarch_core_xfer_shared_libraries_aix_p (struct gdbarch *gdbarch);
890
891 typedef ULONGEST (gdbarch_core_xfer_shared_libraries_aix_ftype) (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
892 extern ULONGEST gdbarch_core_xfer_shared_libraries_aix (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
893 extern void set_gdbarch_core_xfer_shared_libraries_aix (struct gdbarch *gdbarch, gdbarch_core_xfer_shared_libraries_aix_ftype *core_xfer_shared_libraries_aix);
894
895 /* How the core target converts a PTID from a core file to a string. */
896
897 extern int gdbarch_core_pid_to_str_p (struct gdbarch *gdbarch);
898
899 typedef char * (gdbarch_core_pid_to_str_ftype) (struct gdbarch *gdbarch, ptid_t ptid);
900 extern char * gdbarch_core_pid_to_str (struct gdbarch *gdbarch, ptid_t ptid);
901 extern void set_gdbarch_core_pid_to_str (struct gdbarch *gdbarch, gdbarch_core_pid_to_str_ftype *core_pid_to_str);
902
903 /* How the core target extracts the name of a thread from a core file. */
904
905 extern int gdbarch_core_thread_name_p (struct gdbarch *gdbarch);
906
907 typedef const char * (gdbarch_core_thread_name_ftype) (struct gdbarch *gdbarch, struct thread_info *thr);
908 extern const char * gdbarch_core_thread_name (struct gdbarch *gdbarch, struct thread_info *thr);
909 extern void set_gdbarch_core_thread_name (struct gdbarch *gdbarch, gdbarch_core_thread_name_ftype *core_thread_name);
910
911 /* BFD target to use when generating a core file. */
912
913 extern int gdbarch_gcore_bfd_target_p (struct gdbarch *gdbarch);
914
915 extern const char * gdbarch_gcore_bfd_target (struct gdbarch *gdbarch);
916 extern void set_gdbarch_gcore_bfd_target (struct gdbarch *gdbarch, const char * gcore_bfd_target);
917
918 /* If the elements of C++ vtables are in-place function descriptors rather
919    than normal function pointers (which may point to code or a descriptor),
920    set this to one. */
921
922 extern int gdbarch_vtable_function_descriptors (struct gdbarch *gdbarch);
923 extern void set_gdbarch_vtable_function_descriptors (struct gdbarch *gdbarch, int vtable_function_descriptors);
924
925 /* Set if the least significant bit of the delta is used instead of the least
926    significant bit of the pfn for pointers to virtual member functions. */
927
928 extern int gdbarch_vbit_in_delta (struct gdbarch *gdbarch);
929 extern void set_gdbarch_vbit_in_delta (struct gdbarch *gdbarch, int vbit_in_delta);
930
931 /* Advance PC to next instruction in order to skip a permanent breakpoint. */
932
933 typedef void (gdbarch_skip_permanent_breakpoint_ftype) (struct regcache *regcache);
934 extern void gdbarch_skip_permanent_breakpoint (struct gdbarch *gdbarch, struct regcache *regcache);
935 extern void set_gdbarch_skip_permanent_breakpoint (struct gdbarch *gdbarch, gdbarch_skip_permanent_breakpoint_ftype *skip_permanent_breakpoint);
936
937 /* The maximum length of an instruction on this architecture in bytes. */
938
939 extern int gdbarch_max_insn_length_p (struct gdbarch *gdbarch);
940
941 extern ULONGEST gdbarch_max_insn_length (struct gdbarch *gdbarch);
942 extern void set_gdbarch_max_insn_length (struct gdbarch *gdbarch, ULONGEST max_insn_length);
943
944 /* Copy the instruction at FROM to TO, and make any adjustments
945    necessary to single-step it at that address.
946   
947    REGS holds the state the thread's registers will have before
948    executing the copied instruction; the PC in REGS will refer to FROM,
949    not the copy at TO.  The caller should update it to point at TO later.
950   
951    Return a pointer to data of the architecture's choice to be passed
952    to gdbarch_displaced_step_fixup.  Or, return NULL to indicate that
953    the instruction's effects have been completely simulated, with the
954    resulting state written back to REGS.
955   
956    For a general explanation of displaced stepping and how GDB uses it,
957    see the comments in infrun.c.
958   
959    The TO area is only guaranteed to have space for
960    gdbarch_max_insn_length (arch) bytes, so this function must not
961    write more bytes than that to that area.
962   
963    If you do not provide this function, GDB assumes that the
964    architecture does not support displaced stepping.
965   
966    If your architecture doesn't need to adjust instructions before
967    single-stepping them, consider using simple_displaced_step_copy_insn
968    here.
969   
970    If the instruction cannot execute out of line, return NULL.  The
971    core falls back to stepping past the instruction in-line instead in
972    that case. */
973
974 extern int gdbarch_displaced_step_copy_insn_p (struct gdbarch *gdbarch);
975
976 typedef struct displaced_step_closure * (gdbarch_displaced_step_copy_insn_ftype) (struct gdbarch *gdbarch, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
977 extern struct displaced_step_closure * gdbarch_displaced_step_copy_insn (struct gdbarch *gdbarch, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
978 extern void set_gdbarch_displaced_step_copy_insn (struct gdbarch *gdbarch, gdbarch_displaced_step_copy_insn_ftype *displaced_step_copy_insn);
979
980 /* Return true if GDB should use hardware single-stepping to execute
981    the displaced instruction identified by CLOSURE.  If false,
982    GDB will simply restart execution at the displaced instruction
983    location, and it is up to the target to ensure GDB will receive
984    control again (e.g. by placing a software breakpoint instruction
985    into the displaced instruction buffer).
986   
987    The default implementation returns false on all targets that
988    provide a gdbarch_software_single_step routine, and true otherwise. */
989
990 typedef int (gdbarch_displaced_step_hw_singlestep_ftype) (struct gdbarch *gdbarch, struct displaced_step_closure *closure);
991 extern int gdbarch_displaced_step_hw_singlestep (struct gdbarch *gdbarch, struct displaced_step_closure *closure);
992 extern void set_gdbarch_displaced_step_hw_singlestep (struct gdbarch *gdbarch, gdbarch_displaced_step_hw_singlestep_ftype *displaced_step_hw_singlestep);
993
994 /* Fix up the state resulting from successfully single-stepping a
995    displaced instruction, to give the result we would have gotten from
996    stepping the instruction in its original location.
997   
998    REGS is the register state resulting from single-stepping the
999    displaced instruction.
1000   
1001    CLOSURE is the result from the matching call to
1002    gdbarch_displaced_step_copy_insn.
1003   
1004    If you provide gdbarch_displaced_step_copy_insn.but not this
1005    function, then GDB assumes that no fixup is needed after
1006    single-stepping the instruction.
1007   
1008    For a general explanation of displaced stepping and how GDB uses it,
1009    see the comments in infrun.c. */
1010
1011 extern int gdbarch_displaced_step_fixup_p (struct gdbarch *gdbarch);
1012
1013 typedef void (gdbarch_displaced_step_fixup_ftype) (struct gdbarch *gdbarch, struct displaced_step_closure *closure, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
1014 extern void gdbarch_displaced_step_fixup (struct gdbarch *gdbarch, struct displaced_step_closure *closure, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
1015 extern void set_gdbarch_displaced_step_fixup (struct gdbarch *gdbarch, gdbarch_displaced_step_fixup_ftype *displaced_step_fixup);
1016
1017 /* Free a closure returned by gdbarch_displaced_step_copy_insn.
1018   
1019    If you provide gdbarch_displaced_step_copy_insn, you must provide
1020    this function as well.
1021   
1022    If your architecture uses closures that don't need to be freed, then
1023    you can use simple_displaced_step_free_closure here.
1024   
1025    For a general explanation of displaced stepping and how GDB uses it,
1026    see the comments in infrun.c. */
1027
1028 typedef void (gdbarch_displaced_step_free_closure_ftype) (struct gdbarch *gdbarch, struct displaced_step_closure *closure);
1029 extern void gdbarch_displaced_step_free_closure (struct gdbarch *gdbarch, struct displaced_step_closure *closure);
1030 extern void set_gdbarch_displaced_step_free_closure (struct gdbarch *gdbarch, gdbarch_displaced_step_free_closure_ftype *displaced_step_free_closure);
1031
1032 /* Return the address of an appropriate place to put displaced
1033    instructions while we step over them.  There need only be one such
1034    place, since we're only stepping one thread over a breakpoint at a
1035    time.
1036   
1037    For a general explanation of displaced stepping and how GDB uses it,
1038    see the comments in infrun.c. */
1039
1040 typedef CORE_ADDR (gdbarch_displaced_step_location_ftype) (struct gdbarch *gdbarch);
1041 extern CORE_ADDR gdbarch_displaced_step_location (struct gdbarch *gdbarch);
1042 extern void set_gdbarch_displaced_step_location (struct gdbarch *gdbarch, gdbarch_displaced_step_location_ftype *displaced_step_location);
1043
1044 /* Relocate an instruction to execute at a different address.  OLDLOC
1045    is the address in the inferior memory where the instruction to
1046    relocate is currently at.  On input, TO points to the destination
1047    where we want the instruction to be copied (and possibly adjusted)
1048    to.  On output, it points to one past the end of the resulting
1049    instruction(s).  The effect of executing the instruction at TO shall
1050    be the same as if executing it at FROM.  For example, call
1051    instructions that implicitly push the return address on the stack
1052    should be adjusted to return to the instruction after OLDLOC;
1053    relative branches, and other PC-relative instructions need the
1054    offset adjusted; etc. */
1055
1056 extern int gdbarch_relocate_instruction_p (struct gdbarch *gdbarch);
1057
1058 typedef void (gdbarch_relocate_instruction_ftype) (struct gdbarch *gdbarch, CORE_ADDR *to, CORE_ADDR from);
1059 extern void gdbarch_relocate_instruction (struct gdbarch *gdbarch, CORE_ADDR *to, CORE_ADDR from);
1060 extern void set_gdbarch_relocate_instruction (struct gdbarch *gdbarch, gdbarch_relocate_instruction_ftype *relocate_instruction);
1061
1062 /* Refresh overlay mapped state for section OSECT. */
1063
1064 extern int gdbarch_overlay_update_p (struct gdbarch *gdbarch);
1065
1066 typedef void (gdbarch_overlay_update_ftype) (struct obj_section *osect);
1067 extern void gdbarch_overlay_update (struct gdbarch *gdbarch, struct obj_section *osect);
1068 extern void set_gdbarch_overlay_update (struct gdbarch *gdbarch, gdbarch_overlay_update_ftype *overlay_update);
1069
1070 extern int gdbarch_core_read_description_p (struct gdbarch *gdbarch);
1071
1072 typedef const struct target_desc * (gdbarch_core_read_description_ftype) (struct gdbarch *gdbarch, struct target_ops *target, bfd *abfd);
1073 extern const struct target_desc * gdbarch_core_read_description (struct gdbarch *gdbarch, struct target_ops *target, bfd *abfd);
1074 extern void set_gdbarch_core_read_description (struct gdbarch *gdbarch, gdbarch_core_read_description_ftype *core_read_description);
1075
1076 /* Handle special encoding of static variables in stabs debug info. */
1077
1078 extern int gdbarch_static_transform_name_p (struct gdbarch *gdbarch);
1079
1080 typedef const char * (gdbarch_static_transform_name_ftype) (const char *name);
1081 extern const char * gdbarch_static_transform_name (struct gdbarch *gdbarch, const char *name);
1082 extern void set_gdbarch_static_transform_name (struct gdbarch *gdbarch, gdbarch_static_transform_name_ftype *static_transform_name);
1083
1084 /* Set if the address in N_SO or N_FUN stabs may be zero. */
1085
1086 extern int gdbarch_sofun_address_maybe_missing (struct gdbarch *gdbarch);
1087 extern void set_gdbarch_sofun_address_maybe_missing (struct gdbarch *gdbarch, int sofun_address_maybe_missing);
1088
1089 /* Parse the instruction at ADDR storing in the record execution log
1090    the registers REGCACHE and memory ranges that will be affected when
1091    the instruction executes, along with their current values.
1092    Return -1 if something goes wrong, 0 otherwise. */
1093
1094 extern int gdbarch_process_record_p (struct gdbarch *gdbarch);
1095
1096 typedef int (gdbarch_process_record_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr);
1097 extern int gdbarch_process_record (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr);
1098 extern void set_gdbarch_process_record (struct gdbarch *gdbarch, gdbarch_process_record_ftype *process_record);
1099
1100 /* Save process state after a signal.
1101    Return -1 if something goes wrong, 0 otherwise. */
1102
1103 extern int gdbarch_process_record_signal_p (struct gdbarch *gdbarch);
1104
1105 typedef int (gdbarch_process_record_signal_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, enum gdb_signal signal);
1106 extern int gdbarch_process_record_signal (struct gdbarch *gdbarch, struct regcache *regcache, enum gdb_signal signal);
1107 extern void set_gdbarch_process_record_signal (struct gdbarch *gdbarch, gdbarch_process_record_signal_ftype *process_record_signal);
1108
1109 /* Signal translation: translate inferior's signal (target's) number
1110    into GDB's representation.  The implementation of this method must
1111    be host independent.  IOW, don't rely on symbols of the NAT_FILE
1112    header (the nm-*.h files), the host <signal.h> header, or similar
1113    headers.  This is mainly used when cross-debugging core files ---
1114    "Live" targets hide the translation behind the target interface
1115    (target_wait, target_resume, etc.). */
1116
1117 extern int gdbarch_gdb_signal_from_target_p (struct gdbarch *gdbarch);
1118
1119 typedef enum gdb_signal (gdbarch_gdb_signal_from_target_ftype) (struct gdbarch *gdbarch, int signo);
1120 extern enum gdb_signal gdbarch_gdb_signal_from_target (struct gdbarch *gdbarch, int signo);
1121 extern void set_gdbarch_gdb_signal_from_target (struct gdbarch *gdbarch, gdbarch_gdb_signal_from_target_ftype *gdb_signal_from_target);
1122
1123 /* Signal translation: translate the GDB's internal signal number into
1124    the inferior's signal (target's) representation.  The implementation
1125    of this method must be host independent.  IOW, don't rely on symbols
1126    of the NAT_FILE header (the nm-*.h files), the host <signal.h>
1127    header, or similar headers.
1128    Return the target signal number if found, or -1 if the GDB internal
1129    signal number is invalid. */
1130
1131 extern int gdbarch_gdb_signal_to_target_p (struct gdbarch *gdbarch);
1132
1133 typedef int (gdbarch_gdb_signal_to_target_ftype) (struct gdbarch *gdbarch, enum gdb_signal signal);
1134 extern int gdbarch_gdb_signal_to_target (struct gdbarch *gdbarch, enum gdb_signal signal);
1135 extern void set_gdbarch_gdb_signal_to_target (struct gdbarch *gdbarch, gdbarch_gdb_signal_to_target_ftype *gdb_signal_to_target);
1136
1137 /* Extra signal info inspection.
1138   
1139    Return a type suitable to inspect extra signal information. */
1140
1141 extern int gdbarch_get_siginfo_type_p (struct gdbarch *gdbarch);
1142
1143 typedef struct type * (gdbarch_get_siginfo_type_ftype) (struct gdbarch *gdbarch);
1144 extern struct type * gdbarch_get_siginfo_type (struct gdbarch *gdbarch);
1145 extern void set_gdbarch_get_siginfo_type (struct gdbarch *gdbarch, gdbarch_get_siginfo_type_ftype *get_siginfo_type);
1146
1147 /* Record architecture-specific information from the symbol table. */
1148
1149 extern int gdbarch_record_special_symbol_p (struct gdbarch *gdbarch);
1150
1151 typedef void (gdbarch_record_special_symbol_ftype) (struct gdbarch *gdbarch, struct objfile *objfile, asymbol *sym);
1152 extern void gdbarch_record_special_symbol (struct gdbarch *gdbarch, struct objfile *objfile, asymbol *sym);
1153 extern void set_gdbarch_record_special_symbol (struct gdbarch *gdbarch, gdbarch_record_special_symbol_ftype *record_special_symbol);
1154
1155 /* Function for the 'catch syscall' feature.
1156    Get architecture-specific system calls information from registers. */
1157
1158 extern int gdbarch_get_syscall_number_p (struct gdbarch *gdbarch);
1159
1160 typedef LONGEST (gdbarch_get_syscall_number_ftype) (struct gdbarch *gdbarch, ptid_t ptid);
1161 extern LONGEST gdbarch_get_syscall_number (struct gdbarch *gdbarch, ptid_t ptid);
1162 extern void set_gdbarch_get_syscall_number (struct gdbarch *gdbarch, gdbarch_get_syscall_number_ftype *get_syscall_number);
1163
1164 /* The filename of the XML syscall for this architecture. */
1165
1166 extern const char * gdbarch_xml_syscall_file (struct gdbarch *gdbarch);
1167 extern void set_gdbarch_xml_syscall_file (struct gdbarch *gdbarch, const char * xml_syscall_file);
1168
1169 /* Information about system calls from this architecture */
1170
1171 extern struct syscalls_info * gdbarch_syscalls_info (struct gdbarch *gdbarch);
1172 extern void set_gdbarch_syscalls_info (struct gdbarch *gdbarch, struct syscalls_info * syscalls_info);
1173
1174 /* SystemTap related fields and functions.
1175    A NULL-terminated array of prefixes used to mark an integer constant
1176    on the architecture's assembly.
1177    For example, on x86 integer constants are written as:
1178   
1179     $10 ;; integer constant 10
1180   
1181    in this case, this prefix would be the character `$'. */
1182
1183 extern const char *const * gdbarch_stap_integer_prefixes (struct gdbarch *gdbarch);
1184 extern void set_gdbarch_stap_integer_prefixes (struct gdbarch *gdbarch, const char *const * stap_integer_prefixes);
1185
1186 /* A NULL-terminated array of suffixes used to mark an integer constant
1187    on the architecture's assembly. */
1188
1189 extern const char *const * gdbarch_stap_integer_suffixes (struct gdbarch *gdbarch);
1190 extern void set_gdbarch_stap_integer_suffixes (struct gdbarch *gdbarch, const char *const * stap_integer_suffixes);
1191
1192 /* A NULL-terminated array of prefixes used to mark a register name on
1193    the architecture's assembly.
1194    For example, on x86 the register name is written as:
1195   
1196     %eax ;; register eax
1197   
1198    in this case, this prefix would be the character `%'. */
1199
1200 extern const char *const * gdbarch_stap_register_prefixes (struct gdbarch *gdbarch);
1201 extern void set_gdbarch_stap_register_prefixes (struct gdbarch *gdbarch, const char *const * stap_register_prefixes);
1202
1203 /* A NULL-terminated array of suffixes used to mark a register name on
1204    the architecture's assembly. */
1205
1206 extern const char *const * gdbarch_stap_register_suffixes (struct gdbarch *gdbarch);
1207 extern void set_gdbarch_stap_register_suffixes (struct gdbarch *gdbarch, const char *const * stap_register_suffixes);
1208
1209 /* A NULL-terminated array of prefixes used to mark a register
1210    indirection on the architecture's assembly.
1211    For example, on x86 the register indirection is written as:
1212   
1213     (%eax) ;; indirecting eax
1214   
1215    in this case, this prefix would be the charater `('.
1216   
1217    Please note that we use the indirection prefix also for register
1218    displacement, e.g., `4(%eax)' on x86. */
1219
1220 extern const char *const * gdbarch_stap_register_indirection_prefixes (struct gdbarch *gdbarch);
1221 extern void set_gdbarch_stap_register_indirection_prefixes (struct gdbarch *gdbarch, const char *const * stap_register_indirection_prefixes);
1222
1223 /* A NULL-terminated array of suffixes used to mark a register
1224    indirection on the architecture's assembly.
1225    For example, on x86 the register indirection is written as:
1226   
1227     (%eax) ;; indirecting eax
1228   
1229    in this case, this prefix would be the charater `)'.
1230   
1231    Please note that we use the indirection suffix also for register
1232    displacement, e.g., `4(%eax)' on x86. */
1233
1234 extern const char *const * gdbarch_stap_register_indirection_suffixes (struct gdbarch *gdbarch);
1235 extern void set_gdbarch_stap_register_indirection_suffixes (struct gdbarch *gdbarch, const char *const * stap_register_indirection_suffixes);
1236
1237 /* Prefix(es) used to name a register using GDB's nomenclature.
1238   
1239    For example, on PPC a register is represented by a number in the assembly
1240    language (e.g., `10' is the 10th general-purpose register).  However,
1241    inside GDB this same register has an `r' appended to its name, so the 10th
1242    register would be represented as `r10' internally. */
1243
1244 extern const char * gdbarch_stap_gdb_register_prefix (struct gdbarch *gdbarch);
1245 extern void set_gdbarch_stap_gdb_register_prefix (struct gdbarch *gdbarch, const char * stap_gdb_register_prefix);
1246
1247 /* Suffix used to name a register using GDB's nomenclature. */
1248
1249 extern const char * gdbarch_stap_gdb_register_suffix (struct gdbarch *gdbarch);
1250 extern void set_gdbarch_stap_gdb_register_suffix (struct gdbarch *gdbarch, const char * stap_gdb_register_suffix);
1251
1252 /* Check if S is a single operand.
1253   
1254    Single operands can be:
1255     - Literal integers, e.g. `$10' on x86
1256     - Register access, e.g. `%eax' on x86
1257     - Register indirection, e.g. `(%eax)' on x86
1258     - Register displacement, e.g. `4(%eax)' on x86
1259   
1260    This function should check for these patterns on the string
1261    and return 1 if some were found, or zero otherwise.  Please try to match
1262    as much info as you can from the string, i.e., if you have to match
1263    something like `(%', do not match just the `('. */
1264
1265 extern int gdbarch_stap_is_single_operand_p (struct gdbarch *gdbarch);
1266
1267 typedef int (gdbarch_stap_is_single_operand_ftype) (struct gdbarch *gdbarch, const char *s);
1268 extern int gdbarch_stap_is_single_operand (struct gdbarch *gdbarch, const char *s);
1269 extern void set_gdbarch_stap_is_single_operand (struct gdbarch *gdbarch, gdbarch_stap_is_single_operand_ftype *stap_is_single_operand);
1270
1271 /* Function used to handle a "special case" in the parser.
1272   
1273    A "special case" is considered to be an unknown token, i.e., a token
1274    that the parser does not know how to parse.  A good example of special
1275    case would be ARM's register displacement syntax:
1276   
1277     [R0, #4]  ;; displacing R0 by 4
1278   
1279    Since the parser assumes that a register displacement is of the form:
1280   
1281     <number> <indirection_prefix> <register_name> <indirection_suffix>
1282   
1283    it means that it will not be able to recognize and parse this odd syntax.
1284    Therefore, we should add a special case function that will handle this token.
1285   
1286    This function should generate the proper expression form of the expression
1287    using GDB's internal expression mechanism (e.g., `write_exp_elt_opcode'
1288    and so on).  It should also return 1 if the parsing was successful, or zero
1289    if the token was not recognized as a special token (in this case, returning
1290    zero means that the special parser is deferring the parsing to the generic
1291    parser), and should advance the buffer pointer (p->arg). */
1292
1293 extern int gdbarch_stap_parse_special_token_p (struct gdbarch *gdbarch);
1294
1295 typedef int (gdbarch_stap_parse_special_token_ftype) (struct gdbarch *gdbarch, struct stap_parse_info *p);
1296 extern int gdbarch_stap_parse_special_token (struct gdbarch *gdbarch, struct stap_parse_info *p);
1297 extern void set_gdbarch_stap_parse_special_token (struct gdbarch *gdbarch, gdbarch_stap_parse_special_token_ftype *stap_parse_special_token);
1298
1299 /* DTrace related functions.
1300    The expression to compute the NARTGth+1 argument to a DTrace USDT probe.
1301    NARG must be >= 0. */
1302
1303 extern int gdbarch_dtrace_parse_probe_argument_p (struct gdbarch *gdbarch);
1304
1305 typedef void (gdbarch_dtrace_parse_probe_argument_ftype) (struct gdbarch *gdbarch, struct parser_state *pstate, int narg);
1306 extern void gdbarch_dtrace_parse_probe_argument (struct gdbarch *gdbarch, struct parser_state *pstate, int narg);
1307 extern void set_gdbarch_dtrace_parse_probe_argument (struct gdbarch *gdbarch, gdbarch_dtrace_parse_probe_argument_ftype *dtrace_parse_probe_argument);
1308
1309 /* True if the given ADDR does not contain the instruction sequence
1310    corresponding to a disabled DTrace is-enabled probe. */
1311
1312 extern int gdbarch_dtrace_probe_is_enabled_p (struct gdbarch *gdbarch);
1313
1314 typedef int (gdbarch_dtrace_probe_is_enabled_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
1315 extern int gdbarch_dtrace_probe_is_enabled (struct gdbarch *gdbarch, CORE_ADDR addr);
1316 extern void set_gdbarch_dtrace_probe_is_enabled (struct gdbarch *gdbarch, gdbarch_dtrace_probe_is_enabled_ftype *dtrace_probe_is_enabled);
1317
1318 /* Enable a DTrace is-enabled probe at ADDR. */
1319
1320 extern int gdbarch_dtrace_enable_probe_p (struct gdbarch *gdbarch);
1321
1322 typedef void (gdbarch_dtrace_enable_probe_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
1323 extern void gdbarch_dtrace_enable_probe (struct gdbarch *gdbarch, CORE_ADDR addr);
1324 extern void set_gdbarch_dtrace_enable_probe (struct gdbarch *gdbarch, gdbarch_dtrace_enable_probe_ftype *dtrace_enable_probe);
1325
1326 /* Disable a DTrace is-enabled probe at ADDR. */
1327
1328 extern int gdbarch_dtrace_disable_probe_p (struct gdbarch *gdbarch);
1329
1330 typedef void (gdbarch_dtrace_disable_probe_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
1331 extern void gdbarch_dtrace_disable_probe (struct gdbarch *gdbarch, CORE_ADDR addr);
1332 extern void set_gdbarch_dtrace_disable_probe (struct gdbarch *gdbarch, gdbarch_dtrace_disable_probe_ftype *dtrace_disable_probe);
1333
1334 /* True if the list of shared libraries is one and only for all
1335    processes, as opposed to a list of shared libraries per inferior.
1336    This usually means that all processes, although may or may not share
1337    an address space, will see the same set of symbols at the same
1338    addresses. */
1339
1340 extern int gdbarch_has_global_solist (struct gdbarch *gdbarch);
1341 extern void set_gdbarch_has_global_solist (struct gdbarch *gdbarch, int has_global_solist);
1342
1343 /* On some targets, even though each inferior has its own private
1344    address space, the debug interface takes care of making breakpoints
1345    visible to all address spaces automatically.  For such cases,
1346    this property should be set to true. */
1347
1348 extern int gdbarch_has_global_breakpoints (struct gdbarch *gdbarch);
1349 extern void set_gdbarch_has_global_breakpoints (struct gdbarch *gdbarch, int has_global_breakpoints);
1350
1351 /* True if inferiors share an address space (e.g., uClinux). */
1352
1353 typedef int (gdbarch_has_shared_address_space_ftype) (struct gdbarch *gdbarch);
1354 extern int gdbarch_has_shared_address_space (struct gdbarch *gdbarch);
1355 extern void set_gdbarch_has_shared_address_space (struct gdbarch *gdbarch, gdbarch_has_shared_address_space_ftype *has_shared_address_space);
1356
1357 /* True if a fast tracepoint can be set at an address. */
1358
1359 typedef int (gdbarch_fast_tracepoint_valid_at_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr, char **msg);
1360 extern int gdbarch_fast_tracepoint_valid_at (struct gdbarch *gdbarch, CORE_ADDR addr, char **msg);
1361 extern void set_gdbarch_fast_tracepoint_valid_at (struct gdbarch *gdbarch, gdbarch_fast_tracepoint_valid_at_ftype *fast_tracepoint_valid_at);
1362
1363 /* Guess register state based on tracepoint location.  Used for tracepoints
1364    where no registers have been collected, but there's only one location,
1365    allowing us to guess the PC value, and perhaps some other registers.
1366    On entry, regcache has all registers marked as unavailable. */
1367
1368 typedef void (gdbarch_guess_tracepoint_registers_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr);
1369 extern void gdbarch_guess_tracepoint_registers (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr);
1370 extern void set_gdbarch_guess_tracepoint_registers (struct gdbarch *gdbarch, gdbarch_guess_tracepoint_registers_ftype *guess_tracepoint_registers);
1371
1372 /* Return the "auto" target charset. */
1373
1374 typedef const char * (gdbarch_auto_charset_ftype) (void);
1375 extern const char * gdbarch_auto_charset (struct gdbarch *gdbarch);
1376 extern void set_gdbarch_auto_charset (struct gdbarch *gdbarch, gdbarch_auto_charset_ftype *auto_charset);
1377
1378 /* Return the "auto" target wide charset. */
1379
1380 typedef const char * (gdbarch_auto_wide_charset_ftype) (void);
1381 extern const char * gdbarch_auto_wide_charset (struct gdbarch *gdbarch);
1382 extern void set_gdbarch_auto_wide_charset (struct gdbarch *gdbarch, gdbarch_auto_wide_charset_ftype *auto_wide_charset);
1383
1384 /* If non-empty, this is a file extension that will be opened in place
1385    of the file extension reported by the shared library list.
1386   
1387    This is most useful for toolchains that use a post-linker tool,
1388    where the names of the files run on the target differ in extension
1389    compared to the names of the files GDB should load for debug info. */
1390
1391 extern const char * gdbarch_solib_symbols_extension (struct gdbarch *gdbarch);
1392 extern void set_gdbarch_solib_symbols_extension (struct gdbarch *gdbarch, const char * solib_symbols_extension);
1393
1394 /* If true, the target OS has DOS-based file system semantics.  That
1395    is, absolute paths include a drive name, and the backslash is
1396    considered a directory separator. */
1397
1398 extern int gdbarch_has_dos_based_file_system (struct gdbarch *gdbarch);
1399 extern void set_gdbarch_has_dos_based_file_system (struct gdbarch *gdbarch, int has_dos_based_file_system);
1400
1401 /* Generate bytecodes to collect the return address in a frame.
1402    Since the bytecodes run on the target, possibly with GDB not even
1403    connected, the full unwinding machinery is not available, and
1404    typically this function will issue bytecodes for one or more likely
1405    places that the return address may be found. */
1406
1407 typedef void (gdbarch_gen_return_address_ftype) (struct gdbarch *gdbarch, struct agent_expr *ax, struct axs_value *value, CORE_ADDR scope);
1408 extern void gdbarch_gen_return_address (struct gdbarch *gdbarch, struct agent_expr *ax, struct axs_value *value, CORE_ADDR scope);
1409 extern void set_gdbarch_gen_return_address (struct gdbarch *gdbarch, gdbarch_gen_return_address_ftype *gen_return_address);
1410
1411 /* Implement the "info proc" command. */
1412
1413 extern int gdbarch_info_proc_p (struct gdbarch *gdbarch);
1414
1415 typedef void (gdbarch_info_proc_ftype) (struct gdbarch *gdbarch, const char *args, enum info_proc_what what);
1416 extern void gdbarch_info_proc (struct gdbarch *gdbarch, const char *args, enum info_proc_what what);
1417 extern void set_gdbarch_info_proc (struct gdbarch *gdbarch, gdbarch_info_proc_ftype *info_proc);
1418
1419 /* Implement the "info proc" command for core files.  Noe that there
1420    are two "info_proc"-like methods on gdbarch -- one for core files,
1421    one for live targets. */
1422
1423 extern int gdbarch_core_info_proc_p (struct gdbarch *gdbarch);
1424
1425 typedef void (gdbarch_core_info_proc_ftype) (struct gdbarch *gdbarch, const char *args, enum info_proc_what what);
1426 extern void gdbarch_core_info_proc (struct gdbarch *gdbarch, const char *args, enum info_proc_what what);
1427 extern void set_gdbarch_core_info_proc (struct gdbarch *gdbarch, gdbarch_core_info_proc_ftype *core_info_proc);
1428
1429 /* Iterate over all objfiles in the order that makes the most sense
1430    for the architecture to make global symbol searches.
1431   
1432    CB is a callback function where OBJFILE is the objfile to be searched,
1433    and CB_DATA a pointer to user-defined data (the same data that is passed
1434    when calling this gdbarch method).  The iteration stops if this function
1435    returns nonzero.
1436   
1437    CB_DATA is a pointer to some user-defined data to be passed to
1438    the callback.
1439   
1440    If not NULL, CURRENT_OBJFILE corresponds to the objfile being
1441    inspected when the symbol search was requested. */
1442
1443 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);
1444 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);
1445 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);
1446
1447 /* Ravenscar arch-dependent ops. */
1448
1449 extern struct ravenscar_arch_ops * gdbarch_ravenscar_ops (struct gdbarch *gdbarch);
1450 extern void set_gdbarch_ravenscar_ops (struct gdbarch *gdbarch, struct ravenscar_arch_ops * ravenscar_ops);
1451
1452 /* Return non-zero if the instruction at ADDR is a call; zero otherwise. */
1453
1454 typedef int (gdbarch_insn_is_call_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
1455 extern int gdbarch_insn_is_call (struct gdbarch *gdbarch, CORE_ADDR addr);
1456 extern void set_gdbarch_insn_is_call (struct gdbarch *gdbarch, gdbarch_insn_is_call_ftype *insn_is_call);
1457
1458 /* Return non-zero if the instruction at ADDR is a return; zero otherwise. */
1459
1460 typedef int (gdbarch_insn_is_ret_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
1461 extern int gdbarch_insn_is_ret (struct gdbarch *gdbarch, CORE_ADDR addr);
1462 extern void set_gdbarch_insn_is_ret (struct gdbarch *gdbarch, gdbarch_insn_is_ret_ftype *insn_is_ret);
1463
1464 /* Return non-zero if the instruction at ADDR is a jump; zero otherwise. */
1465
1466 typedef int (gdbarch_insn_is_jump_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
1467 extern int gdbarch_insn_is_jump (struct gdbarch *gdbarch, CORE_ADDR addr);
1468 extern void set_gdbarch_insn_is_jump (struct gdbarch *gdbarch, gdbarch_insn_is_jump_ftype *insn_is_jump);
1469
1470 /* Read one auxv entry from *READPTR, not reading locations >= ENDPTR.
1471    Return 0 if *READPTR is already at the end of the buffer.
1472    Return -1 if there is insufficient buffer for a whole entry.
1473    Return 1 if an entry was read into *TYPEP and *VALP. */
1474
1475 extern int gdbarch_auxv_parse_p (struct gdbarch *gdbarch);
1476
1477 typedef int (gdbarch_auxv_parse_ftype) (struct gdbarch *gdbarch, gdb_byte **readptr, gdb_byte *endptr, CORE_ADDR *typep, CORE_ADDR *valp);
1478 extern int gdbarch_auxv_parse (struct gdbarch *gdbarch, gdb_byte **readptr, gdb_byte *endptr, CORE_ADDR *typep, CORE_ADDR *valp);
1479 extern void set_gdbarch_auxv_parse (struct gdbarch *gdbarch, gdbarch_auxv_parse_ftype *auxv_parse);
1480
1481 /* Print the description of a single auxv entry described by TYPE and VAL
1482    to FILE. */
1483
1484 typedef void (gdbarch_print_auxv_entry_ftype) (struct gdbarch *gdbarch, struct ui_file *file, CORE_ADDR type, CORE_ADDR val);
1485 extern void gdbarch_print_auxv_entry (struct gdbarch *gdbarch, struct ui_file *file, CORE_ADDR type, CORE_ADDR val);
1486 extern void set_gdbarch_print_auxv_entry (struct gdbarch *gdbarch, gdbarch_print_auxv_entry_ftype *print_auxv_entry);
1487
1488 /* Find the address range of the current inferior's vsyscall/vDSO, and
1489    write it to *RANGE.  If the vsyscall's length can't be determined, a
1490    range with zero length is returned.  Returns true if the vsyscall is
1491    found, false otherwise. */
1492
1493 typedef int (gdbarch_vsyscall_range_ftype) (struct gdbarch *gdbarch, struct mem_range *range);
1494 extern int gdbarch_vsyscall_range (struct gdbarch *gdbarch, struct mem_range *range);
1495 extern void set_gdbarch_vsyscall_range (struct gdbarch *gdbarch, gdbarch_vsyscall_range_ftype *vsyscall_range);
1496
1497 /* Allocate SIZE bytes of PROT protected page aligned memory in inferior.
1498    PROT has GDB_MMAP_PROT_* bitmask format.
1499    Throw an error if it is not possible.  Returned address is always valid. */
1500
1501 typedef CORE_ADDR (gdbarch_infcall_mmap_ftype) (CORE_ADDR size, unsigned prot);
1502 extern CORE_ADDR gdbarch_infcall_mmap (struct gdbarch *gdbarch, CORE_ADDR size, unsigned prot);
1503 extern void set_gdbarch_infcall_mmap (struct gdbarch *gdbarch, gdbarch_infcall_mmap_ftype *infcall_mmap);
1504
1505 /* Deallocate SIZE bytes of memory at ADDR in inferior from gdbarch_infcall_mmap.
1506    Print a warning if it is not possible. */
1507
1508 typedef void (gdbarch_infcall_munmap_ftype) (CORE_ADDR addr, CORE_ADDR size);
1509 extern void gdbarch_infcall_munmap (struct gdbarch *gdbarch, CORE_ADDR addr, CORE_ADDR size);
1510 extern void set_gdbarch_infcall_munmap (struct gdbarch *gdbarch, gdbarch_infcall_munmap_ftype *infcall_munmap);
1511
1512 /* Return string (caller has to use xfree for it) with options for GCC
1513    to produce code for this target, typically "-m64", "-m32" or "-m31".
1514    These options are put before CU's DW_AT_producer compilation options so that
1515    they can override it.  Method may also return NULL. */
1516
1517 typedef char * (gdbarch_gcc_target_options_ftype) (struct gdbarch *gdbarch);
1518 extern char * gdbarch_gcc_target_options (struct gdbarch *gdbarch);
1519 extern void set_gdbarch_gcc_target_options (struct gdbarch *gdbarch, gdbarch_gcc_target_options_ftype *gcc_target_options);
1520
1521 /* Return a regular expression that matches names used by this
1522    architecture in GNU configury triplets.  The result is statically
1523    allocated and must not be freed.  The default implementation simply
1524    returns the BFD architecture name, which is correct in nearly every
1525    case. */
1526
1527 typedef const char * (gdbarch_gnu_triplet_regexp_ftype) (struct gdbarch *gdbarch);
1528 extern const char * gdbarch_gnu_triplet_regexp (struct gdbarch *gdbarch);
1529 extern void set_gdbarch_gnu_triplet_regexp (struct gdbarch *gdbarch, gdbarch_gnu_triplet_regexp_ftype *gnu_triplet_regexp);
1530
1531 /* Return the size in 8-bit bytes of an addressable memory unit on this
1532    architecture.  This corresponds to the number of 8-bit bytes associated to
1533    each address in memory. */
1534
1535 typedef int (gdbarch_addressable_memory_unit_size_ftype) (struct gdbarch *gdbarch);
1536 extern int gdbarch_addressable_memory_unit_size (struct gdbarch *gdbarch);
1537 extern void set_gdbarch_addressable_memory_unit_size (struct gdbarch *gdbarch, gdbarch_addressable_memory_unit_size_ftype *addressable_memory_unit_size);
1538
1539 /* Definition for an unknown syscall, used basically in error-cases.  */
1540 #define UNKNOWN_SYSCALL (-1)
1541
1542 extern struct gdbarch_tdep *gdbarch_tdep (struct gdbarch *gdbarch);
1543
1544
1545 /* Mechanism for co-ordinating the selection of a specific
1546    architecture.
1547
1548    GDB targets (*-tdep.c) can register an interest in a specific
1549    architecture.  Other GDB components can register a need to maintain
1550    per-architecture data.
1551
1552    The mechanisms below ensures that there is only a loose connection
1553    between the set-architecture command and the various GDB
1554    components.  Each component can independently register their need
1555    to maintain architecture specific data with gdbarch.
1556
1557    Pragmatics:
1558
1559    Previously, a single TARGET_ARCHITECTURE_HOOK was provided.  It
1560    didn't scale.
1561
1562    The more traditional mega-struct containing architecture specific
1563    data for all the various GDB components was also considered.  Since
1564    GDB is built from a variable number of (fairly independent)
1565    components it was determined that the global aproach was not
1566    applicable.  */
1567
1568
1569 /* Register a new architectural family with GDB.
1570
1571    Register support for the specified ARCHITECTURE with GDB.  When
1572    gdbarch determines that the specified architecture has been
1573    selected, the corresponding INIT function is called.
1574
1575    --
1576
1577    The INIT function takes two parameters: INFO which contains the
1578    information available to gdbarch about the (possibly new)
1579    architecture; ARCHES which is a list of the previously created
1580    ``struct gdbarch'' for this architecture.
1581
1582    The INFO parameter is, as far as possible, be pre-initialized with
1583    information obtained from INFO.ABFD or the global defaults.
1584
1585    The ARCHES parameter is a linked list (sorted most recently used)
1586    of all the previously created architures for this architecture
1587    family.  The (possibly NULL) ARCHES->gdbarch can used to access
1588    values from the previously selected architecture for this
1589    architecture family.
1590
1591    The INIT function shall return any of: NULL - indicating that it
1592    doesn't recognize the selected architecture; an existing ``struct
1593    gdbarch'' from the ARCHES list - indicating that the new
1594    architecture is just a synonym for an earlier architecture (see
1595    gdbarch_list_lookup_by_info()); a newly created ``struct gdbarch''
1596    - that describes the selected architecture (see gdbarch_alloc()).
1597
1598    The DUMP_TDEP function shall print out all target specific values.
1599    Care should be taken to ensure that the function works in both the
1600    multi-arch and non- multi-arch cases.  */
1601
1602 struct gdbarch_list
1603 {
1604   struct gdbarch *gdbarch;
1605   struct gdbarch_list *next;
1606 };
1607
1608 struct gdbarch_info
1609 {
1610   /* Use default: NULL (ZERO).  */
1611   const struct bfd_arch_info *bfd_arch_info;
1612
1613   /* Use default: BFD_ENDIAN_UNKNOWN (NB: is not ZERO).  */
1614   enum bfd_endian byte_order;
1615
1616   enum bfd_endian byte_order_for_code;
1617
1618   /* Use default: NULL (ZERO).  */
1619   bfd *abfd;
1620
1621   /* Use default: NULL (ZERO).  */
1622   void *tdep_info;
1623
1624   /* Use default: GDB_OSABI_UNINITIALIZED (-1).  */
1625   enum gdb_osabi osabi;
1626
1627   /* Use default: NULL (ZERO).  */
1628   const struct target_desc *target_desc;
1629 };
1630
1631 typedef struct gdbarch *(gdbarch_init_ftype) (struct gdbarch_info info, struct gdbarch_list *arches);
1632 typedef void (gdbarch_dump_tdep_ftype) (struct gdbarch *gdbarch, struct ui_file *file);
1633
1634 /* DEPRECATED - use gdbarch_register() */
1635 extern void register_gdbarch_init (enum bfd_architecture architecture, gdbarch_init_ftype *);
1636
1637 extern void gdbarch_register (enum bfd_architecture architecture,
1638                               gdbarch_init_ftype *,
1639                               gdbarch_dump_tdep_ftype *);
1640
1641
1642 /* Return a freshly allocated, NULL terminated, array of the valid
1643    architecture names.  Since architectures are registered during the
1644    _initialize phase this function only returns useful information
1645    once initialization has been completed.  */
1646
1647 extern const char **gdbarch_printable_names (void);
1648
1649
1650 /* Helper function.  Search the list of ARCHES for a GDBARCH that
1651    matches the information provided by INFO.  */
1652
1653 extern struct gdbarch_list *gdbarch_list_lookup_by_info (struct gdbarch_list *arches, const struct gdbarch_info *info);
1654
1655
1656 /* Helper function.  Create a preliminary ``struct gdbarch''.  Perform
1657    basic initialization using values obtained from the INFO and TDEP
1658    parameters.  set_gdbarch_*() functions are called to complete the
1659    initialization of the object.  */
1660
1661 extern struct gdbarch *gdbarch_alloc (const struct gdbarch_info *info, struct gdbarch_tdep *tdep);
1662
1663
1664 /* Helper function.  Free a partially-constructed ``struct gdbarch''.
1665    It is assumed that the caller freeds the ``struct
1666    gdbarch_tdep''.  */
1667
1668 extern void gdbarch_free (struct gdbarch *);
1669
1670
1671 /* Helper function.  Allocate memory from the ``struct gdbarch''
1672    obstack.  The memory is freed when the corresponding architecture
1673    is also freed.  */
1674
1675 extern void *gdbarch_obstack_zalloc (struct gdbarch *gdbarch, long size);
1676 #define GDBARCH_OBSTACK_CALLOC(GDBARCH, NR, TYPE) ((TYPE *) gdbarch_obstack_zalloc ((GDBARCH), (NR) * sizeof (TYPE)))
1677 #define GDBARCH_OBSTACK_ZALLOC(GDBARCH, TYPE) ((TYPE *) gdbarch_obstack_zalloc ((GDBARCH), sizeof (TYPE)))
1678
1679 /* Duplicate STRING, returning an equivalent string that's allocated on the
1680    obstack associated with GDBARCH.  The string is freed when the corresponding
1681    architecture is also freed.  */
1682
1683 extern char *gdbarch_obstack_strdup (struct gdbarch *arch, const char *string);
1684
1685 /* Helper function.  Force an update of the current architecture.
1686
1687    The actual architecture selected is determined by INFO, ``(gdb) set
1688    architecture'' et.al., the existing architecture and BFD's default
1689    architecture.  INFO should be initialized to zero and then selected
1690    fields should be updated.
1691
1692    Returns non-zero if the update succeeds.  */
1693
1694 extern int gdbarch_update_p (struct gdbarch_info info);
1695
1696
1697 /* Helper function.  Find an architecture matching info.
1698
1699    INFO should be initialized using gdbarch_info_init, relevant fields
1700    set, and then finished using gdbarch_info_fill.
1701
1702    Returns the corresponding architecture, or NULL if no matching
1703    architecture was found.  */
1704
1705 extern struct gdbarch *gdbarch_find_by_info (struct gdbarch_info info);
1706
1707
1708 /* Helper function.  Set the target gdbarch to "gdbarch".  */
1709
1710 extern void set_target_gdbarch (struct gdbarch *gdbarch);
1711
1712
1713 /* Register per-architecture data-pointer.
1714
1715    Reserve space for a per-architecture data-pointer.  An identifier
1716    for the reserved data-pointer is returned.  That identifer should
1717    be saved in a local static variable.
1718
1719    Memory for the per-architecture data shall be allocated using
1720    gdbarch_obstack_zalloc.  That memory will be deleted when the
1721    corresponding architecture object is deleted.
1722
1723    When a previously created architecture is re-selected, the
1724    per-architecture data-pointer for that previous architecture is
1725    restored.  INIT() is not re-called.
1726
1727    Multiple registrarants for any architecture are allowed (and
1728    strongly encouraged).  */
1729
1730 struct gdbarch_data;
1731
1732 typedef void *(gdbarch_data_pre_init_ftype) (struct obstack *obstack);
1733 extern struct gdbarch_data *gdbarch_data_register_pre_init (gdbarch_data_pre_init_ftype *init);
1734 typedef void *(gdbarch_data_post_init_ftype) (struct gdbarch *gdbarch);
1735 extern struct gdbarch_data *gdbarch_data_register_post_init (gdbarch_data_post_init_ftype *init);
1736 extern void deprecated_set_gdbarch_data (struct gdbarch *gdbarch,
1737                                          struct gdbarch_data *data,
1738                                          void *pointer);
1739
1740 extern void *gdbarch_data (struct gdbarch *gdbarch, struct gdbarch_data *);
1741
1742
1743 /* Set the dynamic target-system-dependent parameters (architecture,
1744    byte-order, ...) using information found in the BFD.  */
1745
1746 extern void set_gdbarch_from_file (bfd *);
1747
1748
1749 /* Initialize the current architecture to the "first" one we find on
1750    our list.  */
1751
1752 extern void initialize_current_architecture (void);
1753
1754 /* gdbarch trace variable */
1755 extern unsigned int gdbarch_debug;
1756
1757 extern void gdbarch_dump (struct gdbarch *gdbarch, struct ui_file *file);
1758
1759 #endif