2013-02-04 Sergio Durigan Junior <sergiodj@redhat.com>
[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-2013 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 struct floatformat;
39 struct ui_file;
40 struct frame_info;
41 struct value;
42 struct objfile;
43 struct obj_section;
44 struct minimal_symbol;
45 struct regcache;
46 struct reggroup;
47 struct regset;
48 struct disassemble_info;
49 struct target_ops;
50 struct obstack;
51 struct bp_target_info;
52 struct target_desc;
53 struct displaced_step_closure;
54 struct core_regset_section;
55 struct syscall;
56 struct agent_expr;
57 struct axs_value;
58 struct stap_parse_info;
59 struct ravenscar_arch_ops;
60 struct elf_internal_linux_prpsinfo;
61
62 /* The architecture associated with the inferior through the
63    connection to the target.
64
65    The architecture vector provides some information that is really a
66    property of the inferior, accessed through a particular target:
67    ptrace operations; the layout of certain RSP packets; the solib_ops
68    vector; etc.  To differentiate architecture accesses to
69    per-inferior/target properties from
70    per-thread/per-frame/per-objfile properties, accesses to
71    per-inferior/target properties should be made through this
72    gdbarch.  */
73
74 /* This is a convenience wrapper for 'current_inferior ()->gdbarch'.  */
75 extern struct gdbarch *target_gdbarch (void);
76
77 /* The initial, default architecture.  It uses host values (for want of a better
78    choice).  */
79 extern struct gdbarch startup_gdbarch;
80
81
82 /* Callback type for the 'iterate_over_objfiles_in_search_order'
83    gdbarch  method.  */
84
85 typedef int (iterate_over_objfiles_in_search_order_cb_ftype)
86   (struct objfile *objfile, void *cb_data);
87
88
89 /* The following are pre-initialized by GDBARCH.  */
90
91 extern const struct bfd_arch_info * gdbarch_bfd_arch_info (struct gdbarch *gdbarch);
92 /* set_gdbarch_bfd_arch_info() - not applicable - pre-initialized.  */
93
94 extern int gdbarch_byte_order (struct gdbarch *gdbarch);
95 /* set_gdbarch_byte_order() - not applicable - pre-initialized.  */
96
97 extern int gdbarch_byte_order_for_code (struct gdbarch *gdbarch);
98 /* set_gdbarch_byte_order_for_code() - not applicable - pre-initialized.  */
99
100 extern enum gdb_osabi gdbarch_osabi (struct gdbarch *gdbarch);
101 /* set_gdbarch_osabi() - not applicable - pre-initialized.  */
102
103 extern const struct target_desc * gdbarch_target_desc (struct gdbarch *gdbarch);
104 /* set_gdbarch_target_desc() - not applicable - pre-initialized.  */
105
106
107 /* The following are initialized by the target dependent code.  */
108
109 /* The bit byte-order has to do just with numbering of bits in debugging symbols
110    and such.  Conceptually, it's quite separate from byte/word byte order. */
111
112 extern int gdbarch_bits_big_endian (struct gdbarch *gdbarch);
113 extern void set_gdbarch_bits_big_endian (struct gdbarch *gdbarch, int bits_big_endian);
114
115 /* Number of bits in a char or unsigned char for the target machine.
116    Just like CHAR_BIT in <limits.h> but describes the target machine.
117    v:TARGET_CHAR_BIT:int:char_bit::::8 * sizeof (char):8::0:
118   
119    Number of bits in a short or unsigned short for the target machine. */
120
121 extern int gdbarch_short_bit (struct gdbarch *gdbarch);
122 extern void set_gdbarch_short_bit (struct gdbarch *gdbarch, int short_bit);
123
124 /* Number of bits in an int or unsigned int for the target machine. */
125
126 extern int gdbarch_int_bit (struct gdbarch *gdbarch);
127 extern void set_gdbarch_int_bit (struct gdbarch *gdbarch, int int_bit);
128
129 /* Number of bits in a long or unsigned long for the target machine. */
130
131 extern int gdbarch_long_bit (struct gdbarch *gdbarch);
132 extern void set_gdbarch_long_bit (struct gdbarch *gdbarch, int long_bit);
133
134 /* Number of bits in a long long or unsigned long long for the target
135    machine. */
136
137 extern int gdbarch_long_long_bit (struct gdbarch *gdbarch);
138 extern void set_gdbarch_long_long_bit (struct gdbarch *gdbarch, int long_long_bit);
139
140 /* Alignment of a long long or unsigned long long for the target
141    machine. */
142
143 extern int gdbarch_long_long_align_bit (struct gdbarch *gdbarch);
144 extern void set_gdbarch_long_long_align_bit (struct gdbarch *gdbarch, int long_long_align_bit);
145
146 /* The ABI default bit-size and format for "half", "float", "double", and
147    "long double".  These bit/format pairs should eventually be combined
148    into a single object.  For the moment, just initialize them as a pair.
149    Each format describes both the big and little endian layouts (if
150    useful). */
151
152 extern int gdbarch_half_bit (struct gdbarch *gdbarch);
153 extern void set_gdbarch_half_bit (struct gdbarch *gdbarch, int half_bit);
154
155 extern const struct floatformat ** gdbarch_half_format (struct gdbarch *gdbarch);
156 extern void set_gdbarch_half_format (struct gdbarch *gdbarch, const struct floatformat ** half_format);
157
158 extern int gdbarch_float_bit (struct gdbarch *gdbarch);
159 extern void set_gdbarch_float_bit (struct gdbarch *gdbarch, int float_bit);
160
161 extern const struct floatformat ** gdbarch_float_format (struct gdbarch *gdbarch);
162 extern void set_gdbarch_float_format (struct gdbarch *gdbarch, const struct floatformat ** float_format);
163
164 extern int gdbarch_double_bit (struct gdbarch *gdbarch);
165 extern void set_gdbarch_double_bit (struct gdbarch *gdbarch, int double_bit);
166
167 extern const struct floatformat ** gdbarch_double_format (struct gdbarch *gdbarch);
168 extern void set_gdbarch_double_format (struct gdbarch *gdbarch, const struct floatformat ** double_format);
169
170 extern int gdbarch_long_double_bit (struct gdbarch *gdbarch);
171 extern void set_gdbarch_long_double_bit (struct gdbarch *gdbarch, int long_double_bit);
172
173 extern const struct floatformat ** gdbarch_long_double_format (struct gdbarch *gdbarch);
174 extern void set_gdbarch_long_double_format (struct gdbarch *gdbarch, const struct floatformat ** long_double_format);
175
176 /* For most targets, a pointer on the target and its representation as an
177    address in GDB have the same size and "look the same".  For such a
178    target, you need only set gdbarch_ptr_bit and gdbarch_addr_bit
179    / addr_bit will be set from it.
180   
181    If gdbarch_ptr_bit and gdbarch_addr_bit are different, you'll probably
182    also need to set gdbarch_dwarf2_addr_size, gdbarch_pointer_to_address and
183    gdbarch_address_to_pointer as well.
184   
185    ptr_bit is the size of a pointer on the target */
186
187 extern int gdbarch_ptr_bit (struct gdbarch *gdbarch);
188 extern void set_gdbarch_ptr_bit (struct gdbarch *gdbarch, int ptr_bit);
189
190 /* addr_bit is the size of a target address as represented in gdb */
191
192 extern int gdbarch_addr_bit (struct gdbarch *gdbarch);
193 extern void set_gdbarch_addr_bit (struct gdbarch *gdbarch, int addr_bit);
194
195 /* dwarf2_addr_size is the target address size as used in the Dwarf debug
196    info.  For .debug_frame FDEs, this is supposed to be the target address
197    size from the associated CU header, and which is equivalent to the
198    DWARF2_ADDR_SIZE as defined by the target specific GCC back-end.
199    Unfortunately there is no good way to determine this value.  Therefore
200    dwarf2_addr_size simply defaults to the target pointer size.
201   
202    dwarf2_addr_size is not used for .eh_frame FDEs, which are generally
203    defined using the target's pointer size so far.
204   
205    Note that dwarf2_addr_size only needs to be redefined by a target if the
206    GCC back-end defines a DWARF2_ADDR_SIZE other than the target pointer size,
207    and if Dwarf versions < 4 need to be supported. */
208
209 extern int gdbarch_dwarf2_addr_size (struct gdbarch *gdbarch);
210 extern void set_gdbarch_dwarf2_addr_size (struct gdbarch *gdbarch, int dwarf2_addr_size);
211
212 /* One if `char' acts like `signed char', zero if `unsigned char'. */
213
214 extern int gdbarch_char_signed (struct gdbarch *gdbarch);
215 extern void set_gdbarch_char_signed (struct gdbarch *gdbarch, int char_signed);
216
217 extern int gdbarch_read_pc_p (struct gdbarch *gdbarch);
218
219 typedef CORE_ADDR (gdbarch_read_pc_ftype) (struct regcache *regcache);
220 extern CORE_ADDR gdbarch_read_pc (struct gdbarch *gdbarch, struct regcache *regcache);
221 extern void set_gdbarch_read_pc (struct gdbarch *gdbarch, gdbarch_read_pc_ftype *read_pc);
222
223 extern int gdbarch_write_pc_p (struct gdbarch *gdbarch);
224
225 typedef void (gdbarch_write_pc_ftype) (struct regcache *regcache, CORE_ADDR val);
226 extern void gdbarch_write_pc (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR val);
227 extern void set_gdbarch_write_pc (struct gdbarch *gdbarch, gdbarch_write_pc_ftype *write_pc);
228
229 /* Function for getting target's idea of a frame pointer.  FIXME: GDB's
230    whole scheme for dealing with "frames" and "frame pointers" needs a
231    serious shakedown. */
232
233 typedef void (gdbarch_virtual_frame_pointer_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc, int *frame_regnum, LONGEST *frame_offset);
234 extern void gdbarch_virtual_frame_pointer (struct gdbarch *gdbarch, CORE_ADDR pc, int *frame_regnum, LONGEST *frame_offset);
235 extern void set_gdbarch_virtual_frame_pointer (struct gdbarch *gdbarch, gdbarch_virtual_frame_pointer_ftype *virtual_frame_pointer);
236
237 extern int gdbarch_pseudo_register_read_p (struct gdbarch *gdbarch);
238
239 typedef enum register_status (gdbarch_pseudo_register_read_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, gdb_byte *buf);
240 extern enum register_status gdbarch_pseudo_register_read (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, gdb_byte *buf);
241 extern void set_gdbarch_pseudo_register_read (struct gdbarch *gdbarch, gdbarch_pseudo_register_read_ftype *pseudo_register_read);
242
243 /* Read a register into a new struct value.  If the register is wholly
244    or partly unavailable, this should call mark_value_bytes_unavailable
245    as appropriate.  If this is defined, then pseudo_register_read will
246    never be called. */
247
248 extern int gdbarch_pseudo_register_read_value_p (struct gdbarch *gdbarch);
249
250 typedef struct value * (gdbarch_pseudo_register_read_value_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum);
251 extern struct value * gdbarch_pseudo_register_read_value (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum);
252 extern void set_gdbarch_pseudo_register_read_value (struct gdbarch *gdbarch, gdbarch_pseudo_register_read_value_ftype *pseudo_register_read_value);
253
254 extern int gdbarch_pseudo_register_write_p (struct gdbarch *gdbarch);
255
256 typedef void (gdbarch_pseudo_register_write_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, const gdb_byte *buf);
257 extern void gdbarch_pseudo_register_write (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, const gdb_byte *buf);
258 extern void set_gdbarch_pseudo_register_write (struct gdbarch *gdbarch, gdbarch_pseudo_register_write_ftype *pseudo_register_write);
259
260 extern int gdbarch_num_regs (struct gdbarch *gdbarch);
261 extern void set_gdbarch_num_regs (struct gdbarch *gdbarch, int num_regs);
262
263 /* This macro gives the number of pseudo-registers that live in the
264    register namespace but do not get fetched or stored on the target.
265    These pseudo-registers may be aliases for other registers,
266    combinations of other registers, or they may be computed by GDB. */
267
268 extern int gdbarch_num_pseudo_regs (struct gdbarch *gdbarch);
269 extern void set_gdbarch_num_pseudo_regs (struct gdbarch *gdbarch, int num_pseudo_regs);
270
271 /* Assemble agent expression bytecode to collect pseudo-register REG.
272    Return -1 if something goes wrong, 0 otherwise. */
273
274 extern int gdbarch_ax_pseudo_register_collect_p (struct gdbarch *gdbarch);
275
276 typedef int (gdbarch_ax_pseudo_register_collect_ftype) (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
277 extern int gdbarch_ax_pseudo_register_collect (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
278 extern void set_gdbarch_ax_pseudo_register_collect (struct gdbarch *gdbarch, gdbarch_ax_pseudo_register_collect_ftype *ax_pseudo_register_collect);
279
280 /* Assemble agent expression bytecode to push the value of pseudo-register
281    REG on the interpreter stack.
282    Return -1 if something goes wrong, 0 otherwise. */
283
284 extern int gdbarch_ax_pseudo_register_push_stack_p (struct gdbarch *gdbarch);
285
286 typedef int (gdbarch_ax_pseudo_register_push_stack_ftype) (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
287 extern int gdbarch_ax_pseudo_register_push_stack (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
288 extern void set_gdbarch_ax_pseudo_register_push_stack (struct gdbarch *gdbarch, gdbarch_ax_pseudo_register_push_stack_ftype *ax_pseudo_register_push_stack);
289
290 /* GDB's standard (or well known) register numbers.  These can map onto
291    a real register or a pseudo (computed) register or not be defined at
292    all (-1).
293    gdbarch_sp_regnum will hopefully be replaced by UNWIND_SP. */
294
295 extern int gdbarch_sp_regnum (struct gdbarch *gdbarch);
296 extern void set_gdbarch_sp_regnum (struct gdbarch *gdbarch, int sp_regnum);
297
298 extern int gdbarch_pc_regnum (struct gdbarch *gdbarch);
299 extern void set_gdbarch_pc_regnum (struct gdbarch *gdbarch, int pc_regnum);
300
301 extern int gdbarch_ps_regnum (struct gdbarch *gdbarch);
302 extern void set_gdbarch_ps_regnum (struct gdbarch *gdbarch, int ps_regnum);
303
304 extern int gdbarch_fp0_regnum (struct gdbarch *gdbarch);
305 extern void set_gdbarch_fp0_regnum (struct gdbarch *gdbarch, int fp0_regnum);
306
307 /* Convert stab register number (from `r' declaration) to a gdb REGNUM. */
308
309 typedef int (gdbarch_stab_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int stab_regnr);
310 extern int gdbarch_stab_reg_to_regnum (struct gdbarch *gdbarch, int stab_regnr);
311 extern void set_gdbarch_stab_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_stab_reg_to_regnum_ftype *stab_reg_to_regnum);
312
313 /* Provide a default mapping from a ecoff register number to a gdb REGNUM. */
314
315 typedef int (gdbarch_ecoff_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int ecoff_regnr);
316 extern int gdbarch_ecoff_reg_to_regnum (struct gdbarch *gdbarch, int ecoff_regnr);
317 extern void set_gdbarch_ecoff_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_ecoff_reg_to_regnum_ftype *ecoff_reg_to_regnum);
318
319 /* Convert from an sdb register number to an internal gdb register number. */
320
321 typedef int (gdbarch_sdb_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int sdb_regnr);
322 extern int gdbarch_sdb_reg_to_regnum (struct gdbarch *gdbarch, int sdb_regnr);
323 extern void set_gdbarch_sdb_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_sdb_reg_to_regnum_ftype *sdb_reg_to_regnum);
324
325 /* Provide a default mapping from a DWARF2 register number to a gdb REGNUM. */
326
327 typedef int (gdbarch_dwarf2_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int dwarf2_regnr);
328 extern int gdbarch_dwarf2_reg_to_regnum (struct gdbarch *gdbarch, int dwarf2_regnr);
329 extern void set_gdbarch_dwarf2_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_dwarf2_reg_to_regnum_ftype *dwarf2_reg_to_regnum);
330
331 typedef const char * (gdbarch_register_name_ftype) (struct gdbarch *gdbarch, int regnr);
332 extern const char * gdbarch_register_name (struct gdbarch *gdbarch, int regnr);
333 extern void set_gdbarch_register_name (struct gdbarch *gdbarch, gdbarch_register_name_ftype *register_name);
334
335 /* Return the type of a register specified by the architecture.  Only
336    the register cache should call this function directly; others should
337    use "register_type". */
338
339 extern int gdbarch_register_type_p (struct gdbarch *gdbarch);
340
341 typedef struct type * (gdbarch_register_type_ftype) (struct gdbarch *gdbarch, int reg_nr);
342 extern struct type * gdbarch_register_type (struct gdbarch *gdbarch, int reg_nr);
343 extern void set_gdbarch_register_type (struct gdbarch *gdbarch, gdbarch_register_type_ftype *register_type);
344
345 /* See gdbint.texinfo, and PUSH_DUMMY_CALL. */
346
347 extern int gdbarch_dummy_id_p (struct gdbarch *gdbarch);
348
349 typedef struct frame_id (gdbarch_dummy_id_ftype) (struct gdbarch *gdbarch, struct frame_info *this_frame);
350 extern struct frame_id gdbarch_dummy_id (struct gdbarch *gdbarch, struct frame_info *this_frame);
351 extern void set_gdbarch_dummy_id (struct gdbarch *gdbarch, gdbarch_dummy_id_ftype *dummy_id);
352
353 /* Implement DUMMY_ID and PUSH_DUMMY_CALL, then delete
354    deprecated_fp_regnum. */
355
356 extern int gdbarch_deprecated_fp_regnum (struct gdbarch *gdbarch);
357 extern void set_gdbarch_deprecated_fp_regnum (struct gdbarch *gdbarch, int deprecated_fp_regnum);
358
359 /* See gdbint.texinfo.  See infcall.c. */
360
361 extern int gdbarch_push_dummy_call_p (struct gdbarch *gdbarch);
362
363 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);
364 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);
365 extern void set_gdbarch_push_dummy_call (struct gdbarch *gdbarch, gdbarch_push_dummy_call_ftype *push_dummy_call);
366
367 extern int gdbarch_call_dummy_location (struct gdbarch *gdbarch);
368 extern void set_gdbarch_call_dummy_location (struct gdbarch *gdbarch, int call_dummy_location);
369
370 extern int gdbarch_push_dummy_code_p (struct gdbarch *gdbarch);
371
372 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);
373 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);
374 extern void set_gdbarch_push_dummy_code (struct gdbarch *gdbarch, gdbarch_push_dummy_code_ftype *push_dummy_code);
375
376 typedef void (gdbarch_print_registers_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, int regnum, int all);
377 extern void gdbarch_print_registers_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, int regnum, int all);
378 extern void set_gdbarch_print_registers_info (struct gdbarch *gdbarch, gdbarch_print_registers_info_ftype *print_registers_info);
379
380 extern int gdbarch_print_float_info_p (struct gdbarch *gdbarch);
381
382 typedef void (gdbarch_print_float_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
383 extern void gdbarch_print_float_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
384 extern void set_gdbarch_print_float_info (struct gdbarch *gdbarch, gdbarch_print_float_info_ftype *print_float_info);
385
386 extern int gdbarch_print_vector_info_p (struct gdbarch *gdbarch);
387
388 typedef void (gdbarch_print_vector_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
389 extern void gdbarch_print_vector_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
390 extern void set_gdbarch_print_vector_info (struct gdbarch *gdbarch, gdbarch_print_vector_info_ftype *print_vector_info);
391
392 /* MAP a GDB RAW register number onto a simulator register number.  See
393    also include/...-sim.h. */
394
395 typedef int (gdbarch_register_sim_regno_ftype) (struct gdbarch *gdbarch, int reg_nr);
396 extern int gdbarch_register_sim_regno (struct gdbarch *gdbarch, int reg_nr);
397 extern void set_gdbarch_register_sim_regno (struct gdbarch *gdbarch, gdbarch_register_sim_regno_ftype *register_sim_regno);
398
399 typedef int (gdbarch_cannot_fetch_register_ftype) (struct gdbarch *gdbarch, int regnum);
400 extern int gdbarch_cannot_fetch_register (struct gdbarch *gdbarch, int regnum);
401 extern void set_gdbarch_cannot_fetch_register (struct gdbarch *gdbarch, gdbarch_cannot_fetch_register_ftype *cannot_fetch_register);
402
403 typedef int (gdbarch_cannot_store_register_ftype) (struct gdbarch *gdbarch, int regnum);
404 extern int gdbarch_cannot_store_register (struct gdbarch *gdbarch, int regnum);
405 extern void set_gdbarch_cannot_store_register (struct gdbarch *gdbarch, gdbarch_cannot_store_register_ftype *cannot_store_register);
406
407 /* setjmp/longjmp support. */
408
409 extern int gdbarch_get_longjmp_target_p (struct gdbarch *gdbarch);
410
411 typedef int (gdbarch_get_longjmp_target_ftype) (struct frame_info *frame, CORE_ADDR *pc);
412 extern int gdbarch_get_longjmp_target (struct gdbarch *gdbarch, struct frame_info *frame, CORE_ADDR *pc);
413 extern void set_gdbarch_get_longjmp_target (struct gdbarch *gdbarch, gdbarch_get_longjmp_target_ftype *get_longjmp_target);
414
415 extern int gdbarch_believe_pcc_promotion (struct gdbarch *gdbarch);
416 extern void set_gdbarch_believe_pcc_promotion (struct gdbarch *gdbarch, int believe_pcc_promotion);
417
418 typedef int (gdbarch_convert_register_p_ftype) (struct gdbarch *gdbarch, int regnum, struct type *type);
419 extern int gdbarch_convert_register_p (struct gdbarch *gdbarch, int regnum, struct type *type);
420 extern void set_gdbarch_convert_register_p (struct gdbarch *gdbarch, gdbarch_convert_register_p_ftype *convert_register_p);
421
422 typedef int (gdbarch_register_to_value_ftype) (struct frame_info *frame, int regnum, struct type *type, gdb_byte *buf, int *optimizedp, int *unavailablep);
423 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);
424 extern void set_gdbarch_register_to_value (struct gdbarch *gdbarch, gdbarch_register_to_value_ftype *register_to_value);
425
426 typedef void (gdbarch_value_to_register_ftype) (struct frame_info *frame, int regnum, struct type *type, const gdb_byte *buf);
427 extern void gdbarch_value_to_register (struct gdbarch *gdbarch, struct frame_info *frame, int regnum, struct type *type, const gdb_byte *buf);
428 extern void set_gdbarch_value_to_register (struct gdbarch *gdbarch, gdbarch_value_to_register_ftype *value_to_register);
429
430 /* Construct a value representing the contents of register REGNUM in
431    frame FRAME, interpreted as type TYPE.  The routine needs to
432    allocate and return a struct value with all value attributes
433    (but not the value contents) filled in. */
434
435 typedef struct value * (gdbarch_value_from_register_ftype) (struct type *type, int regnum, struct frame_info *frame);
436 extern struct value * gdbarch_value_from_register (struct gdbarch *gdbarch, struct type *type, int regnum, struct frame_info *frame);
437 extern void set_gdbarch_value_from_register (struct gdbarch *gdbarch, gdbarch_value_from_register_ftype *value_from_register);
438
439 typedef CORE_ADDR (gdbarch_pointer_to_address_ftype) (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
440 extern CORE_ADDR gdbarch_pointer_to_address (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
441 extern void set_gdbarch_pointer_to_address (struct gdbarch *gdbarch, gdbarch_pointer_to_address_ftype *pointer_to_address);
442
443 typedef void (gdbarch_address_to_pointer_ftype) (struct gdbarch *gdbarch, struct type *type, gdb_byte *buf, CORE_ADDR addr);
444 extern void gdbarch_address_to_pointer (struct gdbarch *gdbarch, struct type *type, gdb_byte *buf, CORE_ADDR addr);
445 extern void set_gdbarch_address_to_pointer (struct gdbarch *gdbarch, gdbarch_address_to_pointer_ftype *address_to_pointer);
446
447 extern int gdbarch_integer_to_address_p (struct gdbarch *gdbarch);
448
449 typedef CORE_ADDR (gdbarch_integer_to_address_ftype) (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
450 extern CORE_ADDR gdbarch_integer_to_address (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
451 extern void set_gdbarch_integer_to_address (struct gdbarch *gdbarch, gdbarch_integer_to_address_ftype *integer_to_address);
452
453 /* Return the return-value convention that will be used by FUNCTION
454    to return a value of type VALTYPE.  FUNCTION may be NULL in which
455    case the return convention is computed based only on VALTYPE.
456   
457    If READBUF is not NULL, extract the return value and save it in this buffer.
458   
459    If WRITEBUF is not NULL, it contains a return value which will be
460    stored into the appropriate register.  This can be used when we want
461    to force the value returned by a function (see the "return" command
462    for instance). */
463
464 extern int gdbarch_return_value_p (struct gdbarch *gdbarch);
465
466 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);
467 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);
468 extern void set_gdbarch_return_value (struct gdbarch *gdbarch, gdbarch_return_value_ftype *return_value);
469
470 /* Return true if the return value of function is stored in the first hidden
471    parameter.  In theory, this feature should be language-dependent, specified
472    by language and its ABI, such as C++.  Unfortunately, compiler may
473    implement it to a target-dependent feature.  So that we need such hook here
474    to be aware of this in GDB. */
475
476 typedef int (gdbarch_return_in_first_hidden_param_p_ftype) (struct gdbarch *gdbarch, struct type *type);
477 extern int gdbarch_return_in_first_hidden_param_p (struct gdbarch *gdbarch, struct type *type);
478 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);
479
480 typedef CORE_ADDR (gdbarch_skip_prologue_ftype) (struct gdbarch *gdbarch, CORE_ADDR ip);
481 extern CORE_ADDR gdbarch_skip_prologue (struct gdbarch *gdbarch, CORE_ADDR ip);
482 extern void set_gdbarch_skip_prologue (struct gdbarch *gdbarch, gdbarch_skip_prologue_ftype *skip_prologue);
483
484 extern int gdbarch_skip_main_prologue_p (struct gdbarch *gdbarch);
485
486 typedef CORE_ADDR (gdbarch_skip_main_prologue_ftype) (struct gdbarch *gdbarch, CORE_ADDR ip);
487 extern CORE_ADDR gdbarch_skip_main_prologue (struct gdbarch *gdbarch, CORE_ADDR ip);
488 extern void set_gdbarch_skip_main_prologue (struct gdbarch *gdbarch, gdbarch_skip_main_prologue_ftype *skip_main_prologue);
489
490 typedef int (gdbarch_inner_than_ftype) (CORE_ADDR lhs, CORE_ADDR rhs);
491 extern int gdbarch_inner_than (struct gdbarch *gdbarch, CORE_ADDR lhs, CORE_ADDR rhs);
492 extern void set_gdbarch_inner_than (struct gdbarch *gdbarch, gdbarch_inner_than_ftype *inner_than);
493
494 typedef const gdb_byte * (gdbarch_breakpoint_from_pc_ftype) (struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *lenptr);
495 extern const gdb_byte * gdbarch_breakpoint_from_pc (struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *lenptr);
496 extern void set_gdbarch_breakpoint_from_pc (struct gdbarch *gdbarch, gdbarch_breakpoint_from_pc_ftype *breakpoint_from_pc);
497
498 /* Return the adjusted address and kind to use for Z0/Z1 packets.
499    KIND is usually the memory length of the breakpoint, but may have a
500    different target-specific meaning. */
501
502 typedef void (gdbarch_remote_breakpoint_from_pc_ftype) (struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *kindptr);
503 extern void gdbarch_remote_breakpoint_from_pc (struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *kindptr);
504 extern void set_gdbarch_remote_breakpoint_from_pc (struct gdbarch *gdbarch, gdbarch_remote_breakpoint_from_pc_ftype *remote_breakpoint_from_pc);
505
506 extern int gdbarch_adjust_breakpoint_address_p (struct gdbarch *gdbarch);
507
508 typedef CORE_ADDR (gdbarch_adjust_breakpoint_address_ftype) (struct gdbarch *gdbarch, CORE_ADDR bpaddr);
509 extern CORE_ADDR gdbarch_adjust_breakpoint_address (struct gdbarch *gdbarch, CORE_ADDR bpaddr);
510 extern void set_gdbarch_adjust_breakpoint_address (struct gdbarch *gdbarch, gdbarch_adjust_breakpoint_address_ftype *adjust_breakpoint_address);
511
512 typedef int (gdbarch_memory_insert_breakpoint_ftype) (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
513 extern int gdbarch_memory_insert_breakpoint (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
514 extern void set_gdbarch_memory_insert_breakpoint (struct gdbarch *gdbarch, gdbarch_memory_insert_breakpoint_ftype *memory_insert_breakpoint);
515
516 typedef int (gdbarch_memory_remove_breakpoint_ftype) (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
517 extern int gdbarch_memory_remove_breakpoint (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
518 extern void set_gdbarch_memory_remove_breakpoint (struct gdbarch *gdbarch, gdbarch_memory_remove_breakpoint_ftype *memory_remove_breakpoint);
519
520 extern CORE_ADDR gdbarch_decr_pc_after_break (struct gdbarch *gdbarch);
521 extern void set_gdbarch_decr_pc_after_break (struct gdbarch *gdbarch, CORE_ADDR decr_pc_after_break);
522
523 /* A function can be addressed by either it's "pointer" (possibly a
524    descriptor address) or "entry point" (first executable instruction).
525    The method "convert_from_func_ptr_addr" converting the former to the
526    latter.  gdbarch_deprecated_function_start_offset is being used to implement
527    a simplified subset of that functionality - the function's address
528    corresponds to the "function pointer" and the function's start
529    corresponds to the "function entry point" - and hence is redundant. */
530
531 extern CORE_ADDR gdbarch_deprecated_function_start_offset (struct gdbarch *gdbarch);
532 extern void set_gdbarch_deprecated_function_start_offset (struct gdbarch *gdbarch, CORE_ADDR deprecated_function_start_offset);
533
534 /* Return the remote protocol register number associated with this
535    register.  Normally the identity mapping. */
536
537 typedef int (gdbarch_remote_register_number_ftype) (struct gdbarch *gdbarch, int regno);
538 extern int gdbarch_remote_register_number (struct gdbarch *gdbarch, int regno);
539 extern void set_gdbarch_remote_register_number (struct gdbarch *gdbarch, gdbarch_remote_register_number_ftype *remote_register_number);
540
541 /* Fetch the target specific address used to represent a load module. */
542
543 extern int gdbarch_fetch_tls_load_module_address_p (struct gdbarch *gdbarch);
544
545 typedef CORE_ADDR (gdbarch_fetch_tls_load_module_address_ftype) (struct objfile *objfile);
546 extern CORE_ADDR gdbarch_fetch_tls_load_module_address (struct gdbarch *gdbarch, struct objfile *objfile);
547 extern void set_gdbarch_fetch_tls_load_module_address (struct gdbarch *gdbarch, gdbarch_fetch_tls_load_module_address_ftype *fetch_tls_load_module_address);
548
549 extern CORE_ADDR gdbarch_frame_args_skip (struct gdbarch *gdbarch);
550 extern void set_gdbarch_frame_args_skip (struct gdbarch *gdbarch, CORE_ADDR frame_args_skip);
551
552 extern int gdbarch_unwind_pc_p (struct gdbarch *gdbarch);
553
554 typedef CORE_ADDR (gdbarch_unwind_pc_ftype) (struct gdbarch *gdbarch, struct frame_info *next_frame);
555 extern CORE_ADDR gdbarch_unwind_pc (struct gdbarch *gdbarch, struct frame_info *next_frame);
556 extern void set_gdbarch_unwind_pc (struct gdbarch *gdbarch, gdbarch_unwind_pc_ftype *unwind_pc);
557
558 extern int gdbarch_unwind_sp_p (struct gdbarch *gdbarch);
559
560 typedef CORE_ADDR (gdbarch_unwind_sp_ftype) (struct gdbarch *gdbarch, struct frame_info *next_frame);
561 extern CORE_ADDR gdbarch_unwind_sp (struct gdbarch *gdbarch, struct frame_info *next_frame);
562 extern void set_gdbarch_unwind_sp (struct gdbarch *gdbarch, gdbarch_unwind_sp_ftype *unwind_sp);
563
564 /* DEPRECATED_FRAME_LOCALS_ADDRESS as been replaced by the per-frame
565    frame-base.  Enable frame-base before frame-unwind. */
566
567 extern int gdbarch_frame_num_args_p (struct gdbarch *gdbarch);
568
569 typedef int (gdbarch_frame_num_args_ftype) (struct frame_info *frame);
570 extern int gdbarch_frame_num_args (struct gdbarch *gdbarch, struct frame_info *frame);
571 extern void set_gdbarch_frame_num_args (struct gdbarch *gdbarch, gdbarch_frame_num_args_ftype *frame_num_args);
572
573 extern int gdbarch_frame_align_p (struct gdbarch *gdbarch);
574
575 typedef CORE_ADDR (gdbarch_frame_align_ftype) (struct gdbarch *gdbarch, CORE_ADDR address);
576 extern CORE_ADDR gdbarch_frame_align (struct gdbarch *gdbarch, CORE_ADDR address);
577 extern void set_gdbarch_frame_align (struct gdbarch *gdbarch, gdbarch_frame_align_ftype *frame_align);
578
579 typedef int (gdbarch_stabs_argument_has_addr_ftype) (struct gdbarch *gdbarch, struct type *type);
580 extern int gdbarch_stabs_argument_has_addr (struct gdbarch *gdbarch, struct type *type);
581 extern void set_gdbarch_stabs_argument_has_addr (struct gdbarch *gdbarch, gdbarch_stabs_argument_has_addr_ftype *stabs_argument_has_addr);
582
583 extern int gdbarch_frame_red_zone_size (struct gdbarch *gdbarch);
584 extern void set_gdbarch_frame_red_zone_size (struct gdbarch *gdbarch, int frame_red_zone_size);
585
586 typedef CORE_ADDR (gdbarch_convert_from_func_ptr_addr_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr, struct target_ops *targ);
587 extern CORE_ADDR gdbarch_convert_from_func_ptr_addr (struct gdbarch *gdbarch, CORE_ADDR addr, struct target_ops *targ);
588 extern void set_gdbarch_convert_from_func_ptr_addr (struct gdbarch *gdbarch, gdbarch_convert_from_func_ptr_addr_ftype *convert_from_func_ptr_addr);
589
590 /* On some machines there are bits in addresses which are not really
591    part of the address, but are used by the kernel, the hardware, etc.
592    for special purposes.  gdbarch_addr_bits_remove takes out any such bits so
593    we get a "real" address such as one would find in a symbol table.
594    This is used only for addresses of instructions, and even then I'm
595    not sure it's used in all contexts.  It exists to deal with there
596    being a few stray bits in the PC which would mislead us, not as some
597    sort of generic thing to handle alignment or segmentation (it's
598    possible it should be in TARGET_READ_PC instead). */
599
600 typedef CORE_ADDR (gdbarch_addr_bits_remove_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
601 extern CORE_ADDR gdbarch_addr_bits_remove (struct gdbarch *gdbarch, CORE_ADDR addr);
602 extern void set_gdbarch_addr_bits_remove (struct gdbarch *gdbarch, gdbarch_addr_bits_remove_ftype *addr_bits_remove);
603
604 /* FIXME/cagney/2001-01-18: This should be split in two.  A target method that
605    indicates if the target needs software single step.  An ISA method to
606    implement it.
607   
608    FIXME/cagney/2001-01-18: This should be replaced with something that inserts
609    breakpoints using the breakpoint system instead of blatting memory directly
610    (as with rs6000).
611   
612    FIXME/cagney/2001-01-18: The logic is backwards.  It should be asking if the
613    target can single step.  If not, then implement single step using breakpoints.
614   
615    A return value of 1 means that the software_single_step breakpoints
616    were inserted; 0 means they were not. */
617
618 extern int gdbarch_software_single_step_p (struct gdbarch *gdbarch);
619
620 typedef int (gdbarch_software_single_step_ftype) (struct frame_info *frame);
621 extern int gdbarch_software_single_step (struct gdbarch *gdbarch, struct frame_info *frame);
622 extern void set_gdbarch_software_single_step (struct gdbarch *gdbarch, gdbarch_software_single_step_ftype *software_single_step);
623
624 /* Return non-zero if the processor is executing a delay slot and a
625    further single-step is needed before the instruction finishes. */
626
627 extern int gdbarch_single_step_through_delay_p (struct gdbarch *gdbarch);
628
629 typedef int (gdbarch_single_step_through_delay_ftype) (struct gdbarch *gdbarch, struct frame_info *frame);
630 extern int gdbarch_single_step_through_delay (struct gdbarch *gdbarch, struct frame_info *frame);
631 extern void set_gdbarch_single_step_through_delay (struct gdbarch *gdbarch, gdbarch_single_step_through_delay_ftype *single_step_through_delay);
632
633 /* FIXME: cagney/2003-08-28: Need to find a better way of selecting the
634    disassembler.  Perhaps objdump can handle it? */
635
636 typedef int (gdbarch_print_insn_ftype) (bfd_vma vma, struct disassemble_info *info);
637 extern int gdbarch_print_insn (struct gdbarch *gdbarch, bfd_vma vma, struct disassemble_info *info);
638 extern void set_gdbarch_print_insn (struct gdbarch *gdbarch, gdbarch_print_insn_ftype *print_insn);
639
640 typedef CORE_ADDR (gdbarch_skip_trampoline_code_ftype) (struct frame_info *frame, CORE_ADDR pc);
641 extern CORE_ADDR gdbarch_skip_trampoline_code (struct gdbarch *gdbarch, struct frame_info *frame, CORE_ADDR pc);
642 extern void set_gdbarch_skip_trampoline_code (struct gdbarch *gdbarch, gdbarch_skip_trampoline_code_ftype *skip_trampoline_code);
643
644 /* If in_solib_dynsym_resolve_code() returns true, and SKIP_SOLIB_RESOLVER
645    evaluates non-zero, this is the address where the debugger will place
646    a step-resume breakpoint to get us past the dynamic linker. */
647
648 typedef CORE_ADDR (gdbarch_skip_solib_resolver_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc);
649 extern CORE_ADDR gdbarch_skip_solib_resolver (struct gdbarch *gdbarch, CORE_ADDR pc);
650 extern void set_gdbarch_skip_solib_resolver (struct gdbarch *gdbarch, gdbarch_skip_solib_resolver_ftype *skip_solib_resolver);
651
652 /* Some systems also have trampoline code for returning from shared libs. */
653
654 typedef int (gdbarch_in_solib_return_trampoline_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc, const char *name);
655 extern int gdbarch_in_solib_return_trampoline (struct gdbarch *gdbarch, CORE_ADDR pc, const char *name);
656 extern void set_gdbarch_in_solib_return_trampoline (struct gdbarch *gdbarch, gdbarch_in_solib_return_trampoline_ftype *in_solib_return_trampoline);
657
658 /* A target might have problems with watchpoints as soon as the stack
659    frame of the current function has been destroyed.  This mostly happens
660    as the first action in a funtion's epilogue.  in_function_epilogue_p()
661    is defined to return a non-zero value if either the given addr is one
662    instruction after the stack destroying instruction up to the trailing
663    return instruction or if we can figure out that the stack frame has
664    already been invalidated regardless of the value of addr.  Targets
665    which don't suffer from that problem could just let this functionality
666    untouched. */
667
668 typedef int (gdbarch_in_function_epilogue_p_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
669 extern int gdbarch_in_function_epilogue_p (struct gdbarch *gdbarch, CORE_ADDR addr);
670 extern void set_gdbarch_in_function_epilogue_p (struct gdbarch *gdbarch, gdbarch_in_function_epilogue_p_ftype *in_function_epilogue_p);
671
672 typedef void (gdbarch_elf_make_msymbol_special_ftype) (asymbol *sym, struct minimal_symbol *msym);
673 extern void gdbarch_elf_make_msymbol_special (struct gdbarch *gdbarch, asymbol *sym, struct minimal_symbol *msym);
674 extern void set_gdbarch_elf_make_msymbol_special (struct gdbarch *gdbarch, gdbarch_elf_make_msymbol_special_ftype *elf_make_msymbol_special);
675
676 typedef void (gdbarch_coff_make_msymbol_special_ftype) (int val, struct minimal_symbol *msym);
677 extern void gdbarch_coff_make_msymbol_special (struct gdbarch *gdbarch, int val, struct minimal_symbol *msym);
678 extern void set_gdbarch_coff_make_msymbol_special (struct gdbarch *gdbarch, gdbarch_coff_make_msymbol_special_ftype *coff_make_msymbol_special);
679
680 extern int gdbarch_cannot_step_breakpoint (struct gdbarch *gdbarch);
681 extern void set_gdbarch_cannot_step_breakpoint (struct gdbarch *gdbarch, int cannot_step_breakpoint);
682
683 extern int gdbarch_have_nonsteppable_watchpoint (struct gdbarch *gdbarch);
684 extern void set_gdbarch_have_nonsteppable_watchpoint (struct gdbarch *gdbarch, int have_nonsteppable_watchpoint);
685
686 extern int gdbarch_address_class_type_flags_p (struct gdbarch *gdbarch);
687
688 typedef int (gdbarch_address_class_type_flags_ftype) (int byte_size, int dwarf2_addr_class);
689 extern int gdbarch_address_class_type_flags (struct gdbarch *gdbarch, int byte_size, int dwarf2_addr_class);
690 extern void set_gdbarch_address_class_type_flags (struct gdbarch *gdbarch, gdbarch_address_class_type_flags_ftype *address_class_type_flags);
691
692 extern int gdbarch_address_class_type_flags_to_name_p (struct gdbarch *gdbarch);
693
694 typedef const char * (gdbarch_address_class_type_flags_to_name_ftype) (struct gdbarch *gdbarch, int type_flags);
695 extern const char * gdbarch_address_class_type_flags_to_name (struct gdbarch *gdbarch, int type_flags);
696 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);
697
698 extern int gdbarch_address_class_name_to_type_flags_p (struct gdbarch *gdbarch);
699
700 typedef int (gdbarch_address_class_name_to_type_flags_ftype) (struct gdbarch *gdbarch, const char *name, int *type_flags_ptr);
701 extern int gdbarch_address_class_name_to_type_flags (struct gdbarch *gdbarch, const char *name, int *type_flags_ptr);
702 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);
703
704 /* Is a register in a group */
705
706 typedef int (gdbarch_register_reggroup_p_ftype) (struct gdbarch *gdbarch, int regnum, struct reggroup *reggroup);
707 extern int gdbarch_register_reggroup_p (struct gdbarch *gdbarch, int regnum, struct reggroup *reggroup);
708 extern void set_gdbarch_register_reggroup_p (struct gdbarch *gdbarch, gdbarch_register_reggroup_p_ftype *register_reggroup_p);
709
710 /* Fetch the pointer to the ith function argument. */
711
712 extern int gdbarch_fetch_pointer_argument_p (struct gdbarch *gdbarch);
713
714 typedef CORE_ADDR (gdbarch_fetch_pointer_argument_ftype) (struct frame_info *frame, int argi, struct type *type);
715 extern CORE_ADDR gdbarch_fetch_pointer_argument (struct gdbarch *gdbarch, struct frame_info *frame, int argi, struct type *type);
716 extern void set_gdbarch_fetch_pointer_argument (struct gdbarch *gdbarch, gdbarch_fetch_pointer_argument_ftype *fetch_pointer_argument);
717
718 /* Return the appropriate register set for a core file section with
719    name SECT_NAME and size SECT_SIZE. */
720
721 extern int gdbarch_regset_from_core_section_p (struct gdbarch *gdbarch);
722
723 typedef const struct regset * (gdbarch_regset_from_core_section_ftype) (struct gdbarch *gdbarch, const char *sect_name, size_t sect_size);
724 extern const struct regset * gdbarch_regset_from_core_section (struct gdbarch *gdbarch, const char *sect_name, size_t sect_size);
725 extern void set_gdbarch_regset_from_core_section (struct gdbarch *gdbarch, gdbarch_regset_from_core_section_ftype *regset_from_core_section);
726
727 /* Supported register notes in a core file. */
728
729 extern struct core_regset_section * gdbarch_core_regset_sections (struct gdbarch *gdbarch);
730 extern void set_gdbarch_core_regset_sections (struct gdbarch *gdbarch, struct core_regset_section * core_regset_sections);
731
732 /* Create core file notes */
733
734 extern int gdbarch_make_corefile_notes_p (struct gdbarch *gdbarch);
735
736 typedef char * (gdbarch_make_corefile_notes_ftype) (struct gdbarch *gdbarch, bfd *obfd, int *note_size);
737 extern char * gdbarch_make_corefile_notes (struct gdbarch *gdbarch, bfd *obfd, int *note_size);
738 extern void set_gdbarch_make_corefile_notes (struct gdbarch *gdbarch, gdbarch_make_corefile_notes_ftype *make_corefile_notes);
739
740 /* The elfcore writer hook to use to write Linux prpsinfo notes to core
741    files.  Most Linux architectures use the same prpsinfo32 or
742    prpsinfo64 layouts, and so won't need to provide this hook, as we
743    call the Linux generic routines in bfd to write prpsinfo notes by
744    default. */
745
746 extern int gdbarch_elfcore_write_linux_prpsinfo_p (struct gdbarch *gdbarch);
747
748 typedef char * (gdbarch_elfcore_write_linux_prpsinfo_ftype) (bfd *obfd, char *note_data, int *note_size, const struct elf_internal_linux_prpsinfo *info);
749 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);
750 extern void set_gdbarch_elfcore_write_linux_prpsinfo (struct gdbarch *gdbarch, gdbarch_elfcore_write_linux_prpsinfo_ftype *elfcore_write_linux_prpsinfo);
751
752 /* Find core file memory regions */
753
754 extern int gdbarch_find_memory_regions_p (struct gdbarch *gdbarch);
755
756 typedef int (gdbarch_find_memory_regions_ftype) (struct gdbarch *gdbarch, find_memory_region_ftype func, void *data);
757 extern int gdbarch_find_memory_regions (struct gdbarch *gdbarch, find_memory_region_ftype func, void *data);
758 extern void set_gdbarch_find_memory_regions (struct gdbarch *gdbarch, gdbarch_find_memory_regions_ftype *find_memory_regions);
759
760 /* Read offset OFFSET of TARGET_OBJECT_LIBRARIES formatted shared libraries list from
761    core file into buffer READBUF with length LEN. */
762
763 extern int gdbarch_core_xfer_shared_libraries_p (struct gdbarch *gdbarch);
764
765 typedef LONGEST (gdbarch_core_xfer_shared_libraries_ftype) (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, LONGEST len);
766 extern LONGEST gdbarch_core_xfer_shared_libraries (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, LONGEST len);
767 extern void set_gdbarch_core_xfer_shared_libraries (struct gdbarch *gdbarch, gdbarch_core_xfer_shared_libraries_ftype *core_xfer_shared_libraries);
768
769 /* How the core target converts a PTID from a core file to a string. */
770
771 extern int gdbarch_core_pid_to_str_p (struct gdbarch *gdbarch);
772
773 typedef char * (gdbarch_core_pid_to_str_ftype) (struct gdbarch *gdbarch, ptid_t ptid);
774 extern char * gdbarch_core_pid_to_str (struct gdbarch *gdbarch, ptid_t ptid);
775 extern void set_gdbarch_core_pid_to_str (struct gdbarch *gdbarch, gdbarch_core_pid_to_str_ftype *core_pid_to_str);
776
777 /* BFD target to use when generating a core file. */
778
779 extern int gdbarch_gcore_bfd_target_p (struct gdbarch *gdbarch);
780
781 extern const char * gdbarch_gcore_bfd_target (struct gdbarch *gdbarch);
782 extern void set_gdbarch_gcore_bfd_target (struct gdbarch *gdbarch, const char * gcore_bfd_target);
783
784 /* If the elements of C++ vtables are in-place function descriptors rather
785    than normal function pointers (which may point to code or a descriptor),
786    set this to one. */
787
788 extern int gdbarch_vtable_function_descriptors (struct gdbarch *gdbarch);
789 extern void set_gdbarch_vtable_function_descriptors (struct gdbarch *gdbarch, int vtable_function_descriptors);
790
791 /* Set if the least significant bit of the delta is used instead of the least
792    significant bit of the pfn for pointers to virtual member functions. */
793
794 extern int gdbarch_vbit_in_delta (struct gdbarch *gdbarch);
795 extern void set_gdbarch_vbit_in_delta (struct gdbarch *gdbarch, int vbit_in_delta);
796
797 /* Advance PC to next instruction in order to skip a permanent breakpoint. */
798
799 extern int gdbarch_skip_permanent_breakpoint_p (struct gdbarch *gdbarch);
800
801 typedef void (gdbarch_skip_permanent_breakpoint_ftype) (struct regcache *regcache);
802 extern void gdbarch_skip_permanent_breakpoint (struct gdbarch *gdbarch, struct regcache *regcache);
803 extern void set_gdbarch_skip_permanent_breakpoint (struct gdbarch *gdbarch, gdbarch_skip_permanent_breakpoint_ftype *skip_permanent_breakpoint);
804
805 /* The maximum length of an instruction on this architecture in bytes. */
806
807 extern int gdbarch_max_insn_length_p (struct gdbarch *gdbarch);
808
809 extern ULONGEST gdbarch_max_insn_length (struct gdbarch *gdbarch);
810 extern void set_gdbarch_max_insn_length (struct gdbarch *gdbarch, ULONGEST max_insn_length);
811
812 /* Copy the instruction at FROM to TO, and make any adjustments
813    necessary to single-step it at that address.
814   
815    REGS holds the state the thread's registers will have before
816    executing the copied instruction; the PC in REGS will refer to FROM,
817    not the copy at TO.  The caller should update it to point at TO later.
818   
819    Return a pointer to data of the architecture's choice to be passed
820    to gdbarch_displaced_step_fixup.  Or, return NULL to indicate that
821    the instruction's effects have been completely simulated, with the
822    resulting state written back to REGS.
823   
824    For a general explanation of displaced stepping and how GDB uses it,
825    see the comments in infrun.c.
826   
827    The TO area is only guaranteed to have space for
828    gdbarch_max_insn_length (arch) bytes, so this function must not
829    write more bytes than that to that area.
830   
831    If you do not provide this function, GDB assumes that the
832    architecture does not support displaced stepping.
833   
834    If your architecture doesn't need to adjust instructions before
835    single-stepping them, consider using simple_displaced_step_copy_insn
836    here. */
837
838 extern int gdbarch_displaced_step_copy_insn_p (struct gdbarch *gdbarch);
839
840 typedef struct displaced_step_closure * (gdbarch_displaced_step_copy_insn_ftype) (struct gdbarch *gdbarch, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
841 extern struct displaced_step_closure * gdbarch_displaced_step_copy_insn (struct gdbarch *gdbarch, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
842 extern void set_gdbarch_displaced_step_copy_insn (struct gdbarch *gdbarch, gdbarch_displaced_step_copy_insn_ftype *displaced_step_copy_insn);
843
844 /* Return true if GDB should use hardware single-stepping to execute
845    the displaced instruction identified by CLOSURE.  If false,
846    GDB will simply restart execution at the displaced instruction
847    location, and it is up to the target to ensure GDB will receive
848    control again (e.g. by placing a software breakpoint instruction
849    into the displaced instruction buffer).
850   
851    The default implementation returns false on all targets that
852    provide a gdbarch_software_single_step routine, and true otherwise. */
853
854 typedef int (gdbarch_displaced_step_hw_singlestep_ftype) (struct gdbarch *gdbarch, struct displaced_step_closure *closure);
855 extern int gdbarch_displaced_step_hw_singlestep (struct gdbarch *gdbarch, struct displaced_step_closure *closure);
856 extern void set_gdbarch_displaced_step_hw_singlestep (struct gdbarch *gdbarch, gdbarch_displaced_step_hw_singlestep_ftype *displaced_step_hw_singlestep);
857
858 /* Fix up the state resulting from successfully single-stepping a
859    displaced instruction, to give the result we would have gotten from
860    stepping the instruction in its original location.
861   
862    REGS is the register state resulting from single-stepping the
863    displaced instruction.
864   
865    CLOSURE is the result from the matching call to
866    gdbarch_displaced_step_copy_insn.
867   
868    If you provide gdbarch_displaced_step_copy_insn.but not this
869    function, then GDB assumes that no fixup is needed after
870    single-stepping the instruction.
871   
872    For a general explanation of displaced stepping and how GDB uses it,
873    see the comments in infrun.c. */
874
875 extern int gdbarch_displaced_step_fixup_p (struct gdbarch *gdbarch);
876
877 typedef void (gdbarch_displaced_step_fixup_ftype) (struct gdbarch *gdbarch, struct displaced_step_closure *closure, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
878 extern void gdbarch_displaced_step_fixup (struct gdbarch *gdbarch, struct displaced_step_closure *closure, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
879 extern void set_gdbarch_displaced_step_fixup (struct gdbarch *gdbarch, gdbarch_displaced_step_fixup_ftype *displaced_step_fixup);
880
881 /* Free a closure returned by gdbarch_displaced_step_copy_insn.
882   
883    If you provide gdbarch_displaced_step_copy_insn, you must provide
884    this function as well.
885   
886    If your architecture uses closures that don't need to be freed, then
887    you can use simple_displaced_step_free_closure here.
888   
889    For a general explanation of displaced stepping and how GDB uses it,
890    see the comments in infrun.c. */
891
892 typedef void (gdbarch_displaced_step_free_closure_ftype) (struct gdbarch *gdbarch, struct displaced_step_closure *closure);
893 extern void gdbarch_displaced_step_free_closure (struct gdbarch *gdbarch, struct displaced_step_closure *closure);
894 extern void set_gdbarch_displaced_step_free_closure (struct gdbarch *gdbarch, gdbarch_displaced_step_free_closure_ftype *displaced_step_free_closure);
895
896 /* Return the address of an appropriate place to put displaced
897    instructions while we step over them.  There need only be one such
898    place, since we're only stepping one thread over a breakpoint at a
899    time.
900   
901    For a general explanation of displaced stepping and how GDB uses it,
902    see the comments in infrun.c. */
903
904 typedef CORE_ADDR (gdbarch_displaced_step_location_ftype) (struct gdbarch *gdbarch);
905 extern CORE_ADDR gdbarch_displaced_step_location (struct gdbarch *gdbarch);
906 extern void set_gdbarch_displaced_step_location (struct gdbarch *gdbarch, gdbarch_displaced_step_location_ftype *displaced_step_location);
907
908 /* Relocate an instruction to execute at a different address.  OLDLOC
909    is the address in the inferior memory where the instruction to
910    relocate is currently at.  On input, TO points to the destination
911    where we want the instruction to be copied (and possibly adjusted)
912    to.  On output, it points to one past the end of the resulting
913    instruction(s).  The effect of executing the instruction at TO shall
914    be the same as if executing it at FROM.  For example, call
915    instructions that implicitly push the return address on the stack
916    should be adjusted to return to the instruction after OLDLOC;
917    relative branches, and other PC-relative instructions need the
918    offset adjusted; etc. */
919
920 extern int gdbarch_relocate_instruction_p (struct gdbarch *gdbarch);
921
922 typedef void (gdbarch_relocate_instruction_ftype) (struct gdbarch *gdbarch, CORE_ADDR *to, CORE_ADDR from);
923 extern void gdbarch_relocate_instruction (struct gdbarch *gdbarch, CORE_ADDR *to, CORE_ADDR from);
924 extern void set_gdbarch_relocate_instruction (struct gdbarch *gdbarch, gdbarch_relocate_instruction_ftype *relocate_instruction);
925
926 /* Refresh overlay mapped state for section OSECT. */
927
928 extern int gdbarch_overlay_update_p (struct gdbarch *gdbarch);
929
930 typedef void (gdbarch_overlay_update_ftype) (struct obj_section *osect);
931 extern void gdbarch_overlay_update (struct gdbarch *gdbarch, struct obj_section *osect);
932 extern void set_gdbarch_overlay_update (struct gdbarch *gdbarch, gdbarch_overlay_update_ftype *overlay_update);
933
934 extern int gdbarch_core_read_description_p (struct gdbarch *gdbarch);
935
936 typedef const struct target_desc * (gdbarch_core_read_description_ftype) (struct gdbarch *gdbarch, struct target_ops *target, bfd *abfd);
937 extern const struct target_desc * gdbarch_core_read_description (struct gdbarch *gdbarch, struct target_ops *target, bfd *abfd);
938 extern void set_gdbarch_core_read_description (struct gdbarch *gdbarch, gdbarch_core_read_description_ftype *core_read_description);
939
940 /* Handle special encoding of static variables in stabs debug info. */
941
942 extern int gdbarch_static_transform_name_p (struct gdbarch *gdbarch);
943
944 typedef const char * (gdbarch_static_transform_name_ftype) (const char *name);
945 extern const char * gdbarch_static_transform_name (struct gdbarch *gdbarch, const char *name);
946 extern void set_gdbarch_static_transform_name (struct gdbarch *gdbarch, gdbarch_static_transform_name_ftype *static_transform_name);
947
948 /* Set if the address in N_SO or N_FUN stabs may be zero. */
949
950 extern int gdbarch_sofun_address_maybe_missing (struct gdbarch *gdbarch);
951 extern void set_gdbarch_sofun_address_maybe_missing (struct gdbarch *gdbarch, int sofun_address_maybe_missing);
952
953 /* Parse the instruction at ADDR storing in the record execution log
954    the registers REGCACHE and memory ranges that will be affected when
955    the instruction executes, along with their current values.
956    Return -1 if something goes wrong, 0 otherwise. */
957
958 extern int gdbarch_process_record_p (struct gdbarch *gdbarch);
959
960 typedef int (gdbarch_process_record_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr);
961 extern int gdbarch_process_record (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr);
962 extern void set_gdbarch_process_record (struct gdbarch *gdbarch, gdbarch_process_record_ftype *process_record);
963
964 /* Save process state after a signal.
965    Return -1 if something goes wrong, 0 otherwise. */
966
967 extern int gdbarch_process_record_signal_p (struct gdbarch *gdbarch);
968
969 typedef int (gdbarch_process_record_signal_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, enum gdb_signal signal);
970 extern int gdbarch_process_record_signal (struct gdbarch *gdbarch, struct regcache *regcache, enum gdb_signal signal);
971 extern void set_gdbarch_process_record_signal (struct gdbarch *gdbarch, gdbarch_process_record_signal_ftype *process_record_signal);
972
973 /* Signal translation: translate inferior's signal (target's) number
974    into GDB's representation.  The implementation of this method must
975    be host independent.  IOW, don't rely on symbols of the NAT_FILE
976    header (the nm-*.h files), the host <signal.h> header, or similar
977    headers.  This is mainly used when cross-debugging core files ---
978    "Live" targets hide the translation behind the target interface
979    (target_wait, target_resume, etc.). */
980
981 extern int gdbarch_gdb_signal_from_target_p (struct gdbarch *gdbarch);
982
983 typedef enum gdb_signal (gdbarch_gdb_signal_from_target_ftype) (struct gdbarch *gdbarch, int signo);
984 extern enum gdb_signal gdbarch_gdb_signal_from_target (struct gdbarch *gdbarch, int signo);
985 extern void set_gdbarch_gdb_signal_from_target (struct gdbarch *gdbarch, gdbarch_gdb_signal_from_target_ftype *gdb_signal_from_target);
986
987 /* Extra signal info inspection.
988   
989    Return a type suitable to inspect extra signal information. */
990
991 extern int gdbarch_get_siginfo_type_p (struct gdbarch *gdbarch);
992
993 typedef struct type * (gdbarch_get_siginfo_type_ftype) (struct gdbarch *gdbarch);
994 extern struct type * gdbarch_get_siginfo_type (struct gdbarch *gdbarch);
995 extern void set_gdbarch_get_siginfo_type (struct gdbarch *gdbarch, gdbarch_get_siginfo_type_ftype *get_siginfo_type);
996
997 /* Record architecture-specific information from the symbol table. */
998
999 extern int gdbarch_record_special_symbol_p (struct gdbarch *gdbarch);
1000
1001 typedef void (gdbarch_record_special_symbol_ftype) (struct gdbarch *gdbarch, struct objfile *objfile, asymbol *sym);
1002 extern void gdbarch_record_special_symbol (struct gdbarch *gdbarch, struct objfile *objfile, asymbol *sym);
1003 extern void set_gdbarch_record_special_symbol (struct gdbarch *gdbarch, gdbarch_record_special_symbol_ftype *record_special_symbol);
1004
1005 /* Function for the 'catch syscall' feature.
1006    Get architecture-specific system calls information from registers. */
1007
1008 extern int gdbarch_get_syscall_number_p (struct gdbarch *gdbarch);
1009
1010 typedef LONGEST (gdbarch_get_syscall_number_ftype) (struct gdbarch *gdbarch, ptid_t ptid);
1011 extern LONGEST gdbarch_get_syscall_number (struct gdbarch *gdbarch, ptid_t ptid);
1012 extern void set_gdbarch_get_syscall_number (struct gdbarch *gdbarch, gdbarch_get_syscall_number_ftype *get_syscall_number);
1013
1014 /* SystemTap related fields and functions.
1015    Prefix used to mark an integer constant on the architecture's assembly
1016    For example, on x86 integer constants are written as:
1017   
1018     $10 ;; integer constant 10
1019   
1020    in this case, this prefix would be the character `$'. */
1021
1022 extern const char * gdbarch_stap_integer_prefix (struct gdbarch *gdbarch);
1023 extern void set_gdbarch_stap_integer_prefix (struct gdbarch *gdbarch, const char * stap_integer_prefix);
1024
1025 /* Suffix used to mark an integer constant on the architecture's assembly. */
1026
1027 extern const char * gdbarch_stap_integer_suffix (struct gdbarch *gdbarch);
1028 extern void set_gdbarch_stap_integer_suffix (struct gdbarch *gdbarch, const char * stap_integer_suffix);
1029
1030 /* Prefix used to mark a register name on the architecture's assembly.
1031    For example, on x86 the register name is written as:
1032   
1033     %eax ;; register eax
1034   
1035    in this case, this prefix would be the character `%'. */
1036
1037 extern const char * gdbarch_stap_register_prefix (struct gdbarch *gdbarch);
1038 extern void set_gdbarch_stap_register_prefix (struct gdbarch *gdbarch, const char * stap_register_prefix);
1039
1040 /* Suffix used to mark a register name on the architecture's assembly */
1041
1042 extern const char * gdbarch_stap_register_suffix (struct gdbarch *gdbarch);
1043 extern void set_gdbarch_stap_register_suffix (struct gdbarch *gdbarch, const char * stap_register_suffix);
1044
1045 /* Prefix used to mark a register indirection on the architecture's assembly.
1046    For example, on x86 the register indirection is written as:
1047   
1048     (%eax) ;; indirecting eax
1049   
1050    in this case, this prefix would be the charater `('.
1051   
1052    Please note that we use the indirection prefix also for register
1053    displacement, e.g., `4(%eax)' on x86. */
1054
1055 extern const char * gdbarch_stap_register_indirection_prefix (struct gdbarch *gdbarch);
1056 extern void set_gdbarch_stap_register_indirection_prefix (struct gdbarch *gdbarch, const char * stap_register_indirection_prefix);
1057
1058 /* Suffix used to mark a register indirection on the architecture's assembly.
1059    For example, on x86 the register indirection is written as:
1060   
1061     (%eax) ;; indirecting eax
1062   
1063    in this case, this prefix would be the charater `)'.
1064   
1065    Please note that we use the indirection suffix also for register
1066    displacement, e.g., `4(%eax)' on x86. */
1067
1068 extern const char * gdbarch_stap_register_indirection_suffix (struct gdbarch *gdbarch);
1069 extern void set_gdbarch_stap_register_indirection_suffix (struct gdbarch *gdbarch, const char * stap_register_indirection_suffix);
1070
1071 /* Prefix used to name a register using GDB's nomenclature.
1072   
1073    For example, on PPC a register is represented by a number in the assembly
1074    language (e.g., `10' is the 10th general-purpose register).  However,
1075    inside GDB this same register has an `r' appended to its name, so the 10th
1076    register would be represented as `r10' internally. */
1077
1078 extern const char * gdbarch_stap_gdb_register_prefix (struct gdbarch *gdbarch);
1079 extern void set_gdbarch_stap_gdb_register_prefix (struct gdbarch *gdbarch, const char * stap_gdb_register_prefix);
1080
1081 /* Suffix used to name a register using GDB's nomenclature. */
1082
1083 extern const char * gdbarch_stap_gdb_register_suffix (struct gdbarch *gdbarch);
1084 extern void set_gdbarch_stap_gdb_register_suffix (struct gdbarch *gdbarch, const char * stap_gdb_register_suffix);
1085
1086 /* Check if S is a single operand.
1087   
1088    Single operands can be:
1089     - Literal integers, e.g. `$10' on x86
1090     - Register access, e.g. `%eax' on x86
1091     - Register indirection, e.g. `(%eax)' on x86
1092     - Register displacement, e.g. `4(%eax)' on x86
1093   
1094    This function should check for these patterns on the string
1095    and return 1 if some were found, or zero otherwise.  Please try to match
1096    as much info as you can from the string, i.e., if you have to match
1097    something like `(%', do not match just the `('. */
1098
1099 extern int gdbarch_stap_is_single_operand_p (struct gdbarch *gdbarch);
1100
1101 typedef int (gdbarch_stap_is_single_operand_ftype) (struct gdbarch *gdbarch, const char *s);
1102 extern int gdbarch_stap_is_single_operand (struct gdbarch *gdbarch, const char *s);
1103 extern void set_gdbarch_stap_is_single_operand (struct gdbarch *gdbarch, gdbarch_stap_is_single_operand_ftype *stap_is_single_operand);
1104
1105 /* Function used to handle a "special case" in the parser.
1106   
1107    A "special case" is considered to be an unknown token, i.e., a token
1108    that the parser does not know how to parse.  A good example of special
1109    case would be ARM's register displacement syntax:
1110   
1111     [R0, #4]  ;; displacing R0 by 4
1112   
1113    Since the parser assumes that a register displacement is of the form:
1114   
1115     <number> <indirection_prefix> <register_name> <indirection_suffix>
1116   
1117    it means that it will not be able to recognize and parse this odd syntax.
1118    Therefore, we should add a special case function that will handle this token.
1119   
1120    This function should generate the proper expression form of the expression
1121    using GDB's internal expression mechanism (e.g., `write_exp_elt_opcode'
1122    and so on).  It should also return 1 if the parsing was successful, or zero
1123    if the token was not recognized as a special token (in this case, returning
1124    zero means that the special parser is deferring the parsing to the generic
1125    parser), and should advance the buffer pointer (p->arg). */
1126
1127 extern int gdbarch_stap_parse_special_token_p (struct gdbarch *gdbarch);
1128
1129 typedef int (gdbarch_stap_parse_special_token_ftype) (struct gdbarch *gdbarch, struct stap_parse_info *p);
1130 extern int gdbarch_stap_parse_special_token (struct gdbarch *gdbarch, struct stap_parse_info *p);
1131 extern void set_gdbarch_stap_parse_special_token (struct gdbarch *gdbarch, gdbarch_stap_parse_special_token_ftype *stap_parse_special_token);
1132
1133 /* True if the list of shared libraries is one and only for all
1134    processes, as opposed to a list of shared libraries per inferior.
1135    This usually means that all processes, although may or may not share
1136    an address space, will see the same set of symbols at the same
1137    addresses. */
1138
1139 extern int gdbarch_has_global_solist (struct gdbarch *gdbarch);
1140 extern void set_gdbarch_has_global_solist (struct gdbarch *gdbarch, int has_global_solist);
1141
1142 /* On some targets, even though each inferior has its own private
1143    address space, the debug interface takes care of making breakpoints
1144    visible to all address spaces automatically.  For such cases,
1145    this property should be set to true. */
1146
1147 extern int gdbarch_has_global_breakpoints (struct gdbarch *gdbarch);
1148 extern void set_gdbarch_has_global_breakpoints (struct gdbarch *gdbarch, int has_global_breakpoints);
1149
1150 /* True if inferiors share an address space (e.g., uClinux). */
1151
1152 typedef int (gdbarch_has_shared_address_space_ftype) (struct gdbarch *gdbarch);
1153 extern int gdbarch_has_shared_address_space (struct gdbarch *gdbarch);
1154 extern void set_gdbarch_has_shared_address_space (struct gdbarch *gdbarch, gdbarch_has_shared_address_space_ftype *has_shared_address_space);
1155
1156 /* True if a fast tracepoint can be set at an address. */
1157
1158 typedef int (gdbarch_fast_tracepoint_valid_at_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr, int *isize, char **msg);
1159 extern int gdbarch_fast_tracepoint_valid_at (struct gdbarch *gdbarch, CORE_ADDR addr, int *isize, char **msg);
1160 extern void set_gdbarch_fast_tracepoint_valid_at (struct gdbarch *gdbarch, gdbarch_fast_tracepoint_valid_at_ftype *fast_tracepoint_valid_at);
1161
1162 /* Return the "auto" target charset. */
1163
1164 typedef const char * (gdbarch_auto_charset_ftype) (void);
1165 extern const char * gdbarch_auto_charset (struct gdbarch *gdbarch);
1166 extern void set_gdbarch_auto_charset (struct gdbarch *gdbarch, gdbarch_auto_charset_ftype *auto_charset);
1167
1168 /* Return the "auto" target wide charset. */
1169
1170 typedef const char * (gdbarch_auto_wide_charset_ftype) (void);
1171 extern const char * gdbarch_auto_wide_charset (struct gdbarch *gdbarch);
1172 extern void set_gdbarch_auto_wide_charset (struct gdbarch *gdbarch, gdbarch_auto_wide_charset_ftype *auto_wide_charset);
1173
1174 /* If non-empty, this is a file extension that will be opened in place
1175    of the file extension reported by the shared library list.
1176   
1177    This is most useful for toolchains that use a post-linker tool,
1178    where the names of the files run on the target differ in extension
1179    compared to the names of the files GDB should load for debug info. */
1180
1181 extern const char * gdbarch_solib_symbols_extension (struct gdbarch *gdbarch);
1182 extern void set_gdbarch_solib_symbols_extension (struct gdbarch *gdbarch, const char * solib_symbols_extension);
1183
1184 /* If true, the target OS has DOS-based file system semantics.  That
1185    is, absolute paths include a drive name, and the backslash is
1186    considered a directory separator. */
1187
1188 extern int gdbarch_has_dos_based_file_system (struct gdbarch *gdbarch);
1189 extern void set_gdbarch_has_dos_based_file_system (struct gdbarch *gdbarch, int has_dos_based_file_system);
1190
1191 /* Generate bytecodes to collect the return address in a frame.
1192    Since the bytecodes run on the target, possibly with GDB not even
1193    connected, the full unwinding machinery is not available, and
1194    typically this function will issue bytecodes for one or more likely
1195    places that the return address may be found. */
1196
1197 typedef void (gdbarch_gen_return_address_ftype) (struct gdbarch *gdbarch, struct agent_expr *ax, struct axs_value *value, CORE_ADDR scope);
1198 extern void gdbarch_gen_return_address (struct gdbarch *gdbarch, struct agent_expr *ax, struct axs_value *value, CORE_ADDR scope);
1199 extern void set_gdbarch_gen_return_address (struct gdbarch *gdbarch, gdbarch_gen_return_address_ftype *gen_return_address);
1200
1201 /* Implement the "info proc" command. */
1202
1203 extern int gdbarch_info_proc_p (struct gdbarch *gdbarch);
1204
1205 typedef void (gdbarch_info_proc_ftype) (struct gdbarch *gdbarch, char *args, enum info_proc_what what);
1206 extern void gdbarch_info_proc (struct gdbarch *gdbarch, char *args, enum info_proc_what what);
1207 extern void set_gdbarch_info_proc (struct gdbarch *gdbarch, gdbarch_info_proc_ftype *info_proc);
1208
1209 /* Implement the "info proc" command for core files.  Noe that there
1210    are two "info_proc"-like methods on gdbarch -- one for core files,
1211    one for live targets. */
1212
1213 extern int gdbarch_core_info_proc_p (struct gdbarch *gdbarch);
1214
1215 typedef void (gdbarch_core_info_proc_ftype) (struct gdbarch *gdbarch, char *args, enum info_proc_what what);
1216 extern void gdbarch_core_info_proc (struct gdbarch *gdbarch, char *args, enum info_proc_what what);
1217 extern void set_gdbarch_core_info_proc (struct gdbarch *gdbarch, gdbarch_core_info_proc_ftype *core_info_proc);
1218
1219 /* Iterate over all objfiles in the order that makes the most sense
1220    for the architecture to make global symbol searches.
1221   
1222    CB is a callback function where OBJFILE is the objfile to be searched,
1223    and CB_DATA a pointer to user-defined data (the same data that is passed
1224    when calling this gdbarch method).  The iteration stops if this function
1225    returns nonzero.
1226   
1227    CB_DATA is a pointer to some user-defined data to be passed to
1228    the callback.
1229   
1230    If not NULL, CURRENT_OBJFILE corresponds to the objfile being
1231    inspected when the symbol search was requested. */
1232
1233 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);
1234 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);
1235 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);
1236
1237 /* Ravenscar arch-dependent ops. */
1238
1239 extern struct ravenscar_arch_ops * gdbarch_ravenscar_ops (struct gdbarch *gdbarch);
1240 extern void set_gdbarch_ravenscar_ops (struct gdbarch *gdbarch, struct ravenscar_arch_ops * ravenscar_ops);
1241
1242 /* Definition for an unknown syscall, used basically in error-cases.  */
1243 #define UNKNOWN_SYSCALL (-1)
1244
1245 extern struct gdbarch_tdep *gdbarch_tdep (struct gdbarch *gdbarch);
1246
1247
1248 /* Mechanism for co-ordinating the selection of a specific
1249    architecture.
1250
1251    GDB targets (*-tdep.c) can register an interest in a specific
1252    architecture.  Other GDB components can register a need to maintain
1253    per-architecture data.
1254
1255    The mechanisms below ensures that there is only a loose connection
1256    between the set-architecture command and the various GDB
1257    components.  Each component can independently register their need
1258    to maintain architecture specific data with gdbarch.
1259
1260    Pragmatics:
1261
1262    Previously, a single TARGET_ARCHITECTURE_HOOK was provided.  It
1263    didn't scale.
1264
1265    The more traditional mega-struct containing architecture specific
1266    data for all the various GDB components was also considered.  Since
1267    GDB is built from a variable number of (fairly independent)
1268    components it was determined that the global aproach was not
1269    applicable.  */
1270
1271
1272 /* Register a new architectural family with GDB.
1273
1274    Register support for the specified ARCHITECTURE with GDB.  When
1275    gdbarch determines that the specified architecture has been
1276    selected, the corresponding INIT function is called.
1277
1278    --
1279
1280    The INIT function takes two parameters: INFO which contains the
1281    information available to gdbarch about the (possibly new)
1282    architecture; ARCHES which is a list of the previously created
1283    ``struct gdbarch'' for this architecture.
1284
1285    The INFO parameter is, as far as possible, be pre-initialized with
1286    information obtained from INFO.ABFD or the global defaults.
1287
1288    The ARCHES parameter is a linked list (sorted most recently used)
1289    of all the previously created architures for this architecture
1290    family.  The (possibly NULL) ARCHES->gdbarch can used to access
1291    values from the previously selected architecture for this
1292    architecture family.
1293
1294    The INIT function shall return any of: NULL - indicating that it
1295    doesn't recognize the selected architecture; an existing ``struct
1296    gdbarch'' from the ARCHES list - indicating that the new
1297    architecture is just a synonym for an earlier architecture (see
1298    gdbarch_list_lookup_by_info()); a newly created ``struct gdbarch''
1299    - that describes the selected architecture (see gdbarch_alloc()).
1300
1301    The DUMP_TDEP function shall print out all target specific values.
1302    Care should be taken to ensure that the function works in both the
1303    multi-arch and non- multi-arch cases.  */
1304
1305 struct gdbarch_list
1306 {
1307   struct gdbarch *gdbarch;
1308   struct gdbarch_list *next;
1309 };
1310
1311 struct gdbarch_info
1312 {
1313   /* Use default: NULL (ZERO).  */
1314   const struct bfd_arch_info *bfd_arch_info;
1315
1316   /* Use default: BFD_ENDIAN_UNKNOWN (NB: is not ZERO).  */
1317   int byte_order;
1318
1319   int byte_order_for_code;
1320
1321   /* Use default: NULL (ZERO).  */
1322   bfd *abfd;
1323
1324   /* Use default: NULL (ZERO).  */
1325   struct gdbarch_tdep_info *tdep_info;
1326
1327   /* Use default: GDB_OSABI_UNINITIALIZED (-1).  */
1328   enum gdb_osabi osabi;
1329
1330   /* Use default: NULL (ZERO).  */
1331   const struct target_desc *target_desc;
1332 };
1333
1334 typedef struct gdbarch *(gdbarch_init_ftype) (struct gdbarch_info info, struct gdbarch_list *arches);
1335 typedef void (gdbarch_dump_tdep_ftype) (struct gdbarch *gdbarch, struct ui_file *file);
1336
1337 /* DEPRECATED - use gdbarch_register() */
1338 extern void register_gdbarch_init (enum bfd_architecture architecture, gdbarch_init_ftype *);
1339
1340 extern void gdbarch_register (enum bfd_architecture architecture,
1341                               gdbarch_init_ftype *,
1342                               gdbarch_dump_tdep_ftype *);
1343
1344
1345 /* Return a freshly allocated, NULL terminated, array of the valid
1346    architecture names.  Since architectures are registered during the
1347    _initialize phase this function only returns useful information
1348    once initialization has been completed.  */
1349
1350 extern const char **gdbarch_printable_names (void);
1351
1352
1353 /* Helper function.  Search the list of ARCHES for a GDBARCH that
1354    matches the information provided by INFO.  */
1355
1356 extern struct gdbarch_list *gdbarch_list_lookup_by_info (struct gdbarch_list *arches, const struct gdbarch_info *info);
1357
1358
1359 /* Helper function.  Create a preliminary ``struct gdbarch''.  Perform
1360    basic initialization using values obtained from the INFO and TDEP
1361    parameters.  set_gdbarch_*() functions are called to complete the
1362    initialization of the object.  */
1363
1364 extern struct gdbarch *gdbarch_alloc (const struct gdbarch_info *info, struct gdbarch_tdep *tdep);
1365
1366
1367 /* Helper function.  Free a partially-constructed ``struct gdbarch''.
1368    It is assumed that the caller freeds the ``struct
1369    gdbarch_tdep''.  */
1370
1371 extern void gdbarch_free (struct gdbarch *);
1372
1373
1374 /* Helper function.  Allocate memory from the ``struct gdbarch''
1375    obstack.  The memory is freed when the corresponding architecture
1376    is also freed.  */
1377
1378 extern void *gdbarch_obstack_zalloc (struct gdbarch *gdbarch, long size);
1379 #define GDBARCH_OBSTACK_CALLOC(GDBARCH, NR, TYPE) ((TYPE *) gdbarch_obstack_zalloc ((GDBARCH), (NR) * sizeof (TYPE)))
1380 #define GDBARCH_OBSTACK_ZALLOC(GDBARCH, TYPE) ((TYPE *) gdbarch_obstack_zalloc ((GDBARCH), sizeof (TYPE)))
1381
1382
1383 /* Helper function.  Force an update of the current architecture.
1384
1385    The actual architecture selected is determined by INFO, ``(gdb) set
1386    architecture'' et.al., the existing architecture and BFD's default
1387    architecture.  INFO should be initialized to zero and then selected
1388    fields should be updated.
1389
1390    Returns non-zero if the update succeeds.  */
1391
1392 extern int gdbarch_update_p (struct gdbarch_info info);
1393
1394
1395 /* Helper function.  Find an architecture matching info.
1396
1397    INFO should be initialized using gdbarch_info_init, relevant fields
1398    set, and then finished using gdbarch_info_fill.
1399
1400    Returns the corresponding architecture, or NULL if no matching
1401    architecture was found.  */
1402
1403 extern struct gdbarch *gdbarch_find_by_info (struct gdbarch_info info);
1404
1405
1406 /* Helper function.  Set the target gdbarch to "gdbarch".  */
1407
1408 extern void set_target_gdbarch (struct gdbarch *gdbarch);
1409
1410
1411 /* Register per-architecture data-pointer.
1412
1413    Reserve space for a per-architecture data-pointer.  An identifier
1414    for the reserved data-pointer is returned.  That identifer should
1415    be saved in a local static variable.
1416
1417    Memory for the per-architecture data shall be allocated using
1418    gdbarch_obstack_zalloc.  That memory will be deleted when the
1419    corresponding architecture object is deleted.
1420
1421    When a previously created architecture is re-selected, the
1422    per-architecture data-pointer for that previous architecture is
1423    restored.  INIT() is not re-called.
1424
1425    Multiple registrarants for any architecture are allowed (and
1426    strongly encouraged).  */
1427
1428 struct gdbarch_data;
1429
1430 typedef void *(gdbarch_data_pre_init_ftype) (struct obstack *obstack);
1431 extern struct gdbarch_data *gdbarch_data_register_pre_init (gdbarch_data_pre_init_ftype *init);
1432 typedef void *(gdbarch_data_post_init_ftype) (struct gdbarch *gdbarch);
1433 extern struct gdbarch_data *gdbarch_data_register_post_init (gdbarch_data_post_init_ftype *init);
1434 extern void deprecated_set_gdbarch_data (struct gdbarch *gdbarch,
1435                                          struct gdbarch_data *data,
1436                                          void *pointer);
1437
1438 extern void *gdbarch_data (struct gdbarch *gdbarch, struct gdbarch_data *);
1439
1440
1441 /* Set the dynamic target-system-dependent parameters (architecture,
1442    byte-order, ...) using information found in the BFD.  */
1443
1444 extern void set_gdbarch_from_file (bfd *);
1445
1446
1447 /* Initialize the current architecture to the "first" one we find on
1448    our list.  */
1449
1450 extern void initialize_current_architecture (void);
1451
1452 /* gdbarch trace variable */
1453 extern unsigned int gdbarch_debug;
1454
1455 extern void gdbarch_dump (struct gdbarch *gdbarch, struct ui_file *file);
1456
1457 #endif