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