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