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