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