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