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