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