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