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