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