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