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