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