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, 2007
6   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
38struct floatformat;
39struct ui_file;
40struct frame_info;
41struct value;
42struct objfile;
43struct obj_section;
44struct minimal_symbol;
45struct regcache;
46struct reggroup;
47struct regset;
48struct disassemble_info;
49struct target_ops;
50struct obstack;
51struct bp_target_info;
52struct target_desc;
53
54extern struct gdbarch *current_gdbarch;
55
56
57/* The following are pre-initialized by GDBARCH. */
58
59extern const struct bfd_arch_info * gdbarch_bfd_arch_info (struct gdbarch *gdbarch);
60/* set_gdbarch_bfd_arch_info() - not applicable - pre-initialized. */
61
62extern int gdbarch_byte_order (struct gdbarch *gdbarch);
63/* set_gdbarch_byte_order() - not applicable - pre-initialized. */
64
65extern enum gdb_osabi gdbarch_osabi (struct gdbarch *gdbarch);
66/* set_gdbarch_osabi() - not applicable - pre-initialized. */
67
68extern const struct target_desc * gdbarch_target_desc (struct gdbarch *gdbarch);
69/* set_gdbarch_target_desc() - not applicable - pre-initialized. */
70
71
72/* The following are initialized by the target dependent code. */
73
74/* Number of bits in a char or unsigned char for the target machine.
75   Just like CHAR_BIT in <limits.h> but describes the target machine.
76   v:TARGET_CHAR_BIT:int:char_bit::::8 * sizeof (char):8::0:
77
78   Number of bits in a short or unsigned short for the target machine. */
79
80extern int gdbarch_short_bit (struct gdbarch *gdbarch);
81extern void set_gdbarch_short_bit (struct gdbarch *gdbarch, int short_bit);
82
83/* Number of bits in an int or unsigned int for the target machine. */
84
85extern int gdbarch_int_bit (struct gdbarch *gdbarch);
86extern void set_gdbarch_int_bit (struct gdbarch *gdbarch, int int_bit);
87
88/* Number of bits in a long or unsigned long for the target machine. */
89
90extern int gdbarch_long_bit (struct gdbarch *gdbarch);
91extern void set_gdbarch_long_bit (struct gdbarch *gdbarch, int long_bit);
92
93/* Number of bits in a long long or unsigned long long for the target
94   machine. */
95
96extern int gdbarch_long_long_bit (struct gdbarch *gdbarch);
97extern void set_gdbarch_long_long_bit (struct gdbarch *gdbarch, int long_long_bit);
98
99/* The ABI default bit-size and format for "float", "double", and "long
100   double".  These bit/format pairs should eventually be combined into
101   a single object.  For the moment, just initialize them as a pair.
102   Each format describes both the big and little endian layouts (if
103   useful). */
104
105extern int gdbarch_float_bit (struct gdbarch *gdbarch);
106extern void set_gdbarch_float_bit (struct gdbarch *gdbarch, int float_bit);
107
108extern const struct floatformat ** gdbarch_float_format (struct gdbarch *gdbarch);
109extern void set_gdbarch_float_format (struct gdbarch *gdbarch, const struct floatformat ** float_format);
110
111extern int gdbarch_double_bit (struct gdbarch *gdbarch);
112extern void set_gdbarch_double_bit (struct gdbarch *gdbarch, int double_bit);
113
114extern const struct floatformat ** gdbarch_double_format (struct gdbarch *gdbarch);
115extern void set_gdbarch_double_format (struct gdbarch *gdbarch, const struct floatformat ** double_format);
116
117extern int gdbarch_long_double_bit (struct gdbarch *gdbarch);
118extern void set_gdbarch_long_double_bit (struct gdbarch *gdbarch, int long_double_bit);
119
120extern const struct floatformat ** gdbarch_long_double_format (struct gdbarch *gdbarch);
121extern void set_gdbarch_long_double_format (struct gdbarch *gdbarch, const struct floatformat ** long_double_format);
122
123/* For most targets, a pointer on the target and its representation as an
124   address in GDB have the same size and "look the same".  For such a
125   target, you need only set gdbarch_ptr_bit and gdbarch_addr_bit
126   / addr_bit will be set from it.
127
128   If gdbarch_ptr_bit and gdbarch_addr_bit are different, you'll probably
129   also need to set gdbarch_pointer_to_address and gdbarch_address_to_pointer
130   as well.
131
132   ptr_bit is the size of a pointer on the target */
133
134extern int gdbarch_ptr_bit (struct gdbarch *gdbarch);
135extern void set_gdbarch_ptr_bit (struct gdbarch *gdbarch, int ptr_bit);
136
137/* addr_bit is the size of a target address as represented in gdb */
138
139extern int gdbarch_addr_bit (struct gdbarch *gdbarch);
140extern void set_gdbarch_addr_bit (struct gdbarch *gdbarch, int addr_bit);
141
142/* One if `char' acts like `signed char', zero if `unsigned char'. */
143
144extern int gdbarch_char_signed (struct gdbarch *gdbarch);
145extern void set_gdbarch_char_signed (struct gdbarch *gdbarch, int char_signed);
146
147extern int gdbarch_read_pc_p (struct gdbarch *gdbarch);
148
149typedef CORE_ADDR (gdbarch_read_pc_ftype) (struct regcache *regcache);
150extern CORE_ADDR gdbarch_read_pc (struct gdbarch *gdbarch, struct regcache *regcache);
151extern void set_gdbarch_read_pc (struct gdbarch *gdbarch, gdbarch_read_pc_ftype *read_pc);
152
153extern int gdbarch_write_pc_p (struct gdbarch *gdbarch);
154
155typedef void (gdbarch_write_pc_ftype) (struct regcache *regcache, CORE_ADDR val);
156extern void gdbarch_write_pc (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR val);
157extern void set_gdbarch_write_pc (struct gdbarch *gdbarch, gdbarch_write_pc_ftype *write_pc);
158
159/* Function for getting target's idea of a frame pointer.  FIXME: GDB's
160   whole scheme for dealing with "frames" and "frame pointers" needs a
161   serious shakedown. */
162
163typedef void (gdbarch_virtual_frame_pointer_ftype) (CORE_ADDR pc, int *frame_regnum, LONGEST *frame_offset);
164extern void gdbarch_virtual_frame_pointer (struct gdbarch *gdbarch, CORE_ADDR pc, int *frame_regnum, LONGEST *frame_offset);
165extern void set_gdbarch_virtual_frame_pointer (struct gdbarch *gdbarch, gdbarch_virtual_frame_pointer_ftype *virtual_frame_pointer);
166
167extern int gdbarch_pseudo_register_read_p (struct gdbarch *gdbarch);
168
169typedef void (gdbarch_pseudo_register_read_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, gdb_byte *buf);
170extern void gdbarch_pseudo_register_read (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, gdb_byte *buf);
171extern void set_gdbarch_pseudo_register_read (struct gdbarch *gdbarch, gdbarch_pseudo_register_read_ftype *pseudo_register_read);
172
173extern int gdbarch_pseudo_register_write_p (struct gdbarch *gdbarch);
174
175typedef void (gdbarch_pseudo_register_write_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, const gdb_byte *buf);
176extern void gdbarch_pseudo_register_write (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, const gdb_byte *buf);
177extern void set_gdbarch_pseudo_register_write (struct gdbarch *gdbarch, gdbarch_pseudo_register_write_ftype *pseudo_register_write);
178
179extern int gdbarch_num_regs (struct gdbarch *gdbarch);
180extern void set_gdbarch_num_regs (struct gdbarch *gdbarch, int num_regs);
181
182/* This macro gives the number of pseudo-registers that live in the
183   register namespace but do not get fetched or stored on the target.
184   These pseudo-registers may be aliases for other registers,
185   combinations of other registers, or they may be computed by GDB. */
186
187extern int gdbarch_num_pseudo_regs (struct gdbarch *gdbarch);
188extern void set_gdbarch_num_pseudo_regs (struct gdbarch *gdbarch, int num_pseudo_regs);
189
190/* GDB's standard (or well known) register numbers.  These can map onto
191   a real register or a pseudo (computed) register or not be defined at
192   all (-1).
193   gdbarch_sp_regnum will hopefully be replaced by UNWIND_SP. */
194
195extern int gdbarch_sp_regnum (struct gdbarch *gdbarch);
196extern void set_gdbarch_sp_regnum (struct gdbarch *gdbarch, int sp_regnum);
197
198extern int gdbarch_pc_regnum (struct gdbarch *gdbarch);
199extern void set_gdbarch_pc_regnum (struct gdbarch *gdbarch, int pc_regnum);
200
201extern int gdbarch_ps_regnum (struct gdbarch *gdbarch);
202extern void set_gdbarch_ps_regnum (struct gdbarch *gdbarch, int ps_regnum);
203
204extern int gdbarch_fp0_regnum (struct gdbarch *gdbarch);
205extern void set_gdbarch_fp0_regnum (struct gdbarch *gdbarch, int fp0_regnum);
206
207/* Convert stab register number (from `r' declaration) to a gdb REGNUM. */
208
209typedef int (gdbarch_stab_reg_to_regnum_ftype) (int stab_regnr);
210extern int gdbarch_stab_reg_to_regnum (struct gdbarch *gdbarch, int stab_regnr);
211extern void set_gdbarch_stab_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_stab_reg_to_regnum_ftype *stab_reg_to_regnum);
212
213/* Provide a default mapping from a ecoff register number to a gdb REGNUM. */
214
215typedef int (gdbarch_ecoff_reg_to_regnum_ftype) (int ecoff_regnr);
216extern int gdbarch_ecoff_reg_to_regnum (struct gdbarch *gdbarch, int ecoff_regnr);
217extern void set_gdbarch_ecoff_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_ecoff_reg_to_regnum_ftype *ecoff_reg_to_regnum);
218
219/* Provide a default mapping from a DWARF register number to a gdb REGNUM. */
220
221typedef int (gdbarch_dwarf_reg_to_regnum_ftype) (int dwarf_regnr);
222extern int gdbarch_dwarf_reg_to_regnum (struct gdbarch *gdbarch, int dwarf_regnr);
223extern void set_gdbarch_dwarf_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_dwarf_reg_to_regnum_ftype *dwarf_reg_to_regnum);
224
225/* Convert from an sdb register number to an internal gdb register number. */
226
227typedef int (gdbarch_sdb_reg_to_regnum_ftype) (int sdb_regnr);
228extern int gdbarch_sdb_reg_to_regnum (struct gdbarch *gdbarch, int sdb_regnr);
229extern void set_gdbarch_sdb_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_sdb_reg_to_regnum_ftype *sdb_reg_to_regnum);
230
231typedef int (gdbarch_dwarf2_reg_to_regnum_ftype) (int dwarf2_regnr);
232extern int gdbarch_dwarf2_reg_to_regnum (struct gdbarch *gdbarch, int dwarf2_regnr);
233extern void set_gdbarch_dwarf2_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_dwarf2_reg_to_regnum_ftype *dwarf2_reg_to_regnum);
234
235typedef const char * (gdbarch_register_name_ftype) (int regnr);
236extern const char * gdbarch_register_name (struct gdbarch *gdbarch, int regnr);
237extern void set_gdbarch_register_name (struct gdbarch *gdbarch, gdbarch_register_name_ftype *register_name);
238
239/* Return the type of a register specified by the architecture.  Only
240   the register cache should call this function directly; others should
241   use "register_type". */
242
243extern int gdbarch_register_type_p (struct gdbarch *gdbarch);
244
245typedef struct type * (gdbarch_register_type_ftype) (struct gdbarch *gdbarch, int reg_nr);
246extern struct type * gdbarch_register_type (struct gdbarch *gdbarch, int reg_nr);
247extern void set_gdbarch_register_type (struct gdbarch *gdbarch, gdbarch_register_type_ftype *register_type);
248
249/* See gdbint.texinfo, and PUSH_DUMMY_CALL. */
250
251extern int gdbarch_unwind_dummy_id_p (struct gdbarch *gdbarch);
252
253typedef struct frame_id (gdbarch_unwind_dummy_id_ftype) (struct gdbarch *gdbarch, struct frame_info *info);
254extern struct frame_id gdbarch_unwind_dummy_id (struct gdbarch *gdbarch, struct frame_info *info);
255extern void set_gdbarch_unwind_dummy_id (struct gdbarch *gdbarch, gdbarch_unwind_dummy_id_ftype *unwind_dummy_id);
256
257/* Implement UNWIND_DUMMY_ID and PUSH_DUMMY_CALL, then delete
258   deprecated_fp_regnum. */
259
260extern int gdbarch_deprecated_fp_regnum (struct gdbarch *gdbarch);
261extern void set_gdbarch_deprecated_fp_regnum (struct gdbarch *gdbarch, int deprecated_fp_regnum);
262
263/* See gdbint.texinfo.  See infcall.c. */
264
265extern int gdbarch_push_dummy_call_p (struct gdbarch *gdbarch);
266
267typedef 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);
268extern 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);
269extern void set_gdbarch_push_dummy_call (struct gdbarch *gdbarch, gdbarch_push_dummy_call_ftype *push_dummy_call);
270
271extern int gdbarch_call_dummy_location (struct gdbarch *gdbarch);
272extern void set_gdbarch_call_dummy_location (struct gdbarch *gdbarch, int call_dummy_location);
273
274extern int gdbarch_push_dummy_code_p (struct gdbarch *gdbarch);
275
276typedef CORE_ADDR (gdbarch_push_dummy_code_ftype) (struct gdbarch *gdbarch, CORE_ADDR sp, CORE_ADDR funaddr, int using_gcc, struct value **args, int nargs, struct type *value_type, CORE_ADDR *real_pc, CORE_ADDR *bp_addr, struct regcache *regcache);
277extern CORE_ADDR gdbarch_push_dummy_code (struct gdbarch *gdbarch, CORE_ADDR sp, CORE_ADDR funaddr, int using_gcc, struct value **args, int nargs, struct type *value_type, CORE_ADDR *real_pc, CORE_ADDR *bp_addr, struct regcache *regcache);
278extern void set_gdbarch_push_dummy_code (struct gdbarch *gdbarch, gdbarch_push_dummy_code_ftype *push_dummy_code);
279
280typedef void (gdbarch_print_registers_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, int regnum, int all);
281extern void gdbarch_print_registers_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, int regnum, int all);
282extern void set_gdbarch_print_registers_info (struct gdbarch *gdbarch, gdbarch_print_registers_info_ftype *print_registers_info);
283
284extern int gdbarch_print_float_info_p (struct gdbarch *gdbarch);
285
286typedef void (gdbarch_print_float_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
287extern void gdbarch_print_float_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
288extern void set_gdbarch_print_float_info (struct gdbarch *gdbarch, gdbarch_print_float_info_ftype *print_float_info);
289
290extern int gdbarch_print_vector_info_p (struct gdbarch *gdbarch);
291
292typedef void (gdbarch_print_vector_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
293extern void gdbarch_print_vector_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
294extern void set_gdbarch_print_vector_info (struct gdbarch *gdbarch, gdbarch_print_vector_info_ftype *print_vector_info);
295
296/* MAP a GDB RAW register number onto a simulator register number.  See
297   also include/...-sim.h. */
298
299typedef int (gdbarch_register_sim_regno_ftype) (int reg_nr);
300extern int gdbarch_register_sim_regno (struct gdbarch *gdbarch, int reg_nr);
301extern void set_gdbarch_register_sim_regno (struct gdbarch *gdbarch, gdbarch_register_sim_regno_ftype *register_sim_regno);
302
303typedef int (gdbarch_cannot_fetch_register_ftype) (int regnum);
304extern int gdbarch_cannot_fetch_register (struct gdbarch *gdbarch, int regnum);
305extern void set_gdbarch_cannot_fetch_register (struct gdbarch *gdbarch, gdbarch_cannot_fetch_register_ftype *cannot_fetch_register);
306
307typedef int (gdbarch_cannot_store_register_ftype) (int regnum);
308extern int gdbarch_cannot_store_register (struct gdbarch *gdbarch, int regnum);
309extern void set_gdbarch_cannot_store_register (struct gdbarch *gdbarch, gdbarch_cannot_store_register_ftype *cannot_store_register);
310
311/* setjmp/longjmp support. */
312
313extern int gdbarch_get_longjmp_target_p (struct gdbarch *gdbarch);
314
315typedef int (gdbarch_get_longjmp_target_ftype) (struct frame_info *frame, CORE_ADDR *pc);
316extern int gdbarch_get_longjmp_target (struct gdbarch *gdbarch, struct frame_info *frame, CORE_ADDR *pc);
317extern void set_gdbarch_get_longjmp_target (struct gdbarch *gdbarch, gdbarch_get_longjmp_target_ftype *get_longjmp_target);
318
319extern int gdbarch_believe_pcc_promotion (struct gdbarch *gdbarch);
320extern void set_gdbarch_believe_pcc_promotion (struct gdbarch *gdbarch, int believe_pcc_promotion);
321
322typedef int (gdbarch_convert_register_p_ftype) (int regnum, struct type *type);
323extern int gdbarch_convert_register_p (struct gdbarch *gdbarch, int regnum, struct type *type);
324extern void set_gdbarch_convert_register_p (struct gdbarch *gdbarch, gdbarch_convert_register_p_ftype *convert_register_p);
325
326typedef void (gdbarch_register_to_value_ftype) (struct frame_info *frame, int regnum, struct type *type, gdb_byte *buf);
327extern void gdbarch_register_to_value (struct gdbarch *gdbarch, struct frame_info *frame, int regnum, struct type *type, gdb_byte *buf);
328extern void set_gdbarch_register_to_value (struct gdbarch *gdbarch, gdbarch_register_to_value_ftype *register_to_value);
329
330typedef void (gdbarch_value_to_register_ftype) (struct frame_info *frame, int regnum, struct type *type, const gdb_byte *buf);
331extern void gdbarch_value_to_register (struct gdbarch *gdbarch, struct frame_info *frame, int regnum, struct type *type, const gdb_byte *buf);
332extern void set_gdbarch_value_to_register (struct gdbarch *gdbarch, gdbarch_value_to_register_ftype *value_to_register);
333
334/* Construct a value representing the contents of register REGNUM in
335   frame FRAME, interpreted as type TYPE.  The routine needs to
336   allocate and return a struct value with all value attributes
337   (but not the value contents) filled in. */
338
339typedef struct value * (gdbarch_value_from_register_ftype) (struct type *type, int regnum, struct frame_info *frame);
340extern struct value * gdbarch_value_from_register (struct gdbarch *gdbarch, struct type *type, int regnum, struct frame_info *frame);
341extern void set_gdbarch_value_from_register (struct gdbarch *gdbarch, gdbarch_value_from_register_ftype *value_from_register);
342
343typedef CORE_ADDR (gdbarch_pointer_to_address_ftype) (struct type *type, const gdb_byte *buf);
344extern CORE_ADDR gdbarch_pointer_to_address (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
345extern void set_gdbarch_pointer_to_address (struct gdbarch *gdbarch, gdbarch_pointer_to_address_ftype *pointer_to_address);
346
347typedef void (gdbarch_address_to_pointer_ftype) (struct type *type, gdb_byte *buf, CORE_ADDR addr);
348extern void gdbarch_address_to_pointer (struct gdbarch *gdbarch, struct type *type, gdb_byte *buf, CORE_ADDR addr);
349extern void set_gdbarch_address_to_pointer (struct gdbarch *gdbarch, gdbarch_address_to_pointer_ftype *address_to_pointer);
350
351extern int gdbarch_integer_to_address_p (struct gdbarch *gdbarch);
352
353typedef CORE_ADDR (gdbarch_integer_to_address_ftype) (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
354extern CORE_ADDR gdbarch_integer_to_address (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
355extern void set_gdbarch_integer_to_address (struct gdbarch *gdbarch, gdbarch_integer_to_address_ftype *integer_to_address);
356
357/* It has been suggested that this, well actually its predecessor,
358   should take the type/value of the function to be called and not the
359   return type.  This is left as an exercise for the reader.
360   NOTE: cagney/2004-06-13: The function stack.c:return_command uses
361   the predicate with default hack to avoid calling store_return_value
362   (via legacy_return_value), when a small struct is involved. */
363
364extern int gdbarch_return_value_p (struct gdbarch *gdbarch);
365
366typedef enum return_value_convention (gdbarch_return_value_ftype) (struct gdbarch *gdbarch, struct type *valtype, struct regcache *regcache, gdb_byte *readbuf, const gdb_byte *writebuf);
367extern enum return_value_convention gdbarch_return_value (struct gdbarch *gdbarch, struct type *valtype, struct regcache *regcache, gdb_byte *readbuf, const gdb_byte *writebuf);
368extern void set_gdbarch_return_value (struct gdbarch *gdbarch, gdbarch_return_value_ftype *return_value);
369
370/* The deprecated methods extract_return_value, store_return_value,
371   DEPRECATED_EXTRACT_STRUCT_VALUE_ADDRESS and
372   deprecated_use_struct_convention have all been folded into
373   RETURN_VALUE. */
374
375typedef void (gdbarch_extract_return_value_ftype) (struct type *type, struct regcache *regcache, gdb_byte *valbuf);
376extern void gdbarch_extract_return_value (struct gdbarch *gdbarch, struct type *type, struct regcache *regcache, gdb_byte *valbuf);
377extern void set_gdbarch_extract_return_value (struct gdbarch *gdbarch, gdbarch_extract_return_value_ftype *extract_return_value);
378
379typedef void (gdbarch_store_return_value_ftype) (struct type *type, struct regcache *regcache, const gdb_byte *valbuf);
380extern void gdbarch_store_return_value (struct gdbarch *gdbarch, struct type *type, struct regcache *regcache, const gdb_byte *valbuf);
381extern void set_gdbarch_store_return_value (struct gdbarch *gdbarch, gdbarch_store_return_value_ftype *store_return_value);
382
383typedef int (gdbarch_deprecated_use_struct_convention_ftype) (int gcc_p, struct type *value_type);
384extern int gdbarch_deprecated_use_struct_convention (struct gdbarch *gdbarch, int gcc_p, struct type *value_type);
385extern void set_gdbarch_deprecated_use_struct_convention (struct gdbarch *gdbarch, gdbarch_deprecated_use_struct_convention_ftype *deprecated_use_struct_convention);
386
387typedef CORE_ADDR (gdbarch_skip_prologue_ftype) (CORE_ADDR ip);
388extern CORE_ADDR gdbarch_skip_prologue (struct gdbarch *gdbarch, CORE_ADDR ip);
389extern void set_gdbarch_skip_prologue (struct gdbarch *gdbarch, gdbarch_skip_prologue_ftype *skip_prologue);
390
391typedef int (gdbarch_inner_than_ftype) (CORE_ADDR lhs, CORE_ADDR rhs);
392extern int gdbarch_inner_than (struct gdbarch *gdbarch, CORE_ADDR lhs, CORE_ADDR rhs);
393extern void set_gdbarch_inner_than (struct gdbarch *gdbarch, gdbarch_inner_than_ftype *inner_than);
394
395typedef const gdb_byte * (gdbarch_breakpoint_from_pc_ftype) (CORE_ADDR *pcptr, int *lenptr);
396extern const gdb_byte * gdbarch_breakpoint_from_pc (struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *lenptr);
397extern void set_gdbarch_breakpoint_from_pc (struct gdbarch *gdbarch, gdbarch_breakpoint_from_pc_ftype *breakpoint_from_pc);
398
399extern int gdbarch_adjust_breakpoint_address_p (struct gdbarch *gdbarch);
400
401typedef CORE_ADDR (gdbarch_adjust_breakpoint_address_ftype) (struct gdbarch *gdbarch, CORE_ADDR bpaddr);
402extern CORE_ADDR gdbarch_adjust_breakpoint_address (struct gdbarch *gdbarch, CORE_ADDR bpaddr);
403extern void set_gdbarch_adjust_breakpoint_address (struct gdbarch *gdbarch, gdbarch_adjust_breakpoint_address_ftype *adjust_breakpoint_address);
404
405typedef int (gdbarch_memory_insert_breakpoint_ftype) (struct bp_target_info *bp_tgt);
406extern int gdbarch_memory_insert_breakpoint (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
407extern void set_gdbarch_memory_insert_breakpoint (struct gdbarch *gdbarch, gdbarch_memory_insert_breakpoint_ftype *memory_insert_breakpoint);
408
409typedef int (gdbarch_memory_remove_breakpoint_ftype) (struct bp_target_info *bp_tgt);
410extern int gdbarch_memory_remove_breakpoint (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
411extern void set_gdbarch_memory_remove_breakpoint (struct gdbarch *gdbarch, gdbarch_memory_remove_breakpoint_ftype *memory_remove_breakpoint);
412
413extern CORE_ADDR gdbarch_decr_pc_after_break (struct gdbarch *gdbarch);
414extern void set_gdbarch_decr_pc_after_break (struct gdbarch *gdbarch, CORE_ADDR decr_pc_after_break);
415
416/* A function can be addressed by either it's "pointer" (possibly a
417   descriptor address) or "entry point" (first executable instruction).
418   The method "convert_from_func_ptr_addr" converting the former to the
419   latter.  gdbarch_deprecated_function_start_offset is being used to implement
420   a simplified subset of that functionality - the function's address
421   corresponds to the "function pointer" and the function's start
422   corresponds to the "function entry point" - and hence is redundant. */
423
424extern CORE_ADDR gdbarch_deprecated_function_start_offset (struct gdbarch *gdbarch);
425extern void set_gdbarch_deprecated_function_start_offset (struct gdbarch *gdbarch, CORE_ADDR deprecated_function_start_offset);
426
427/* Return the remote protocol register number associated with this
428   register.  Normally the identity mapping. */
429
430typedef int (gdbarch_remote_register_number_ftype) (struct gdbarch *gdbarch, int regno);
431extern int gdbarch_remote_register_number (struct gdbarch *gdbarch, int regno);
432extern void set_gdbarch_remote_register_number (struct gdbarch *gdbarch, gdbarch_remote_register_number_ftype *remote_register_number);
433
434/* Fetch the target specific address used to represent a load module. */
435
436extern int gdbarch_fetch_tls_load_module_address_p (struct gdbarch *gdbarch);
437
438typedef CORE_ADDR (gdbarch_fetch_tls_load_module_address_ftype) (struct objfile *objfile);
439extern CORE_ADDR gdbarch_fetch_tls_load_module_address (struct gdbarch *gdbarch, struct objfile *objfile);
440extern void set_gdbarch_fetch_tls_load_module_address (struct gdbarch *gdbarch, gdbarch_fetch_tls_load_module_address_ftype *fetch_tls_load_module_address);
441
442extern CORE_ADDR gdbarch_frame_args_skip (struct gdbarch *gdbarch);
443extern void set_gdbarch_frame_args_skip (struct gdbarch *gdbarch, CORE_ADDR frame_args_skip);
444
445extern int gdbarch_unwind_pc_p (struct gdbarch *gdbarch);
446
447typedef CORE_ADDR (gdbarch_unwind_pc_ftype) (struct gdbarch *gdbarch, struct frame_info *next_frame);
448extern CORE_ADDR gdbarch_unwind_pc (struct gdbarch *gdbarch, struct frame_info *next_frame);
449extern void set_gdbarch_unwind_pc (struct gdbarch *gdbarch, gdbarch_unwind_pc_ftype *unwind_pc);
450
451extern int gdbarch_unwind_sp_p (struct gdbarch *gdbarch);
452
453typedef CORE_ADDR (gdbarch_unwind_sp_ftype) (struct gdbarch *gdbarch, struct frame_info *next_frame);
454extern CORE_ADDR gdbarch_unwind_sp (struct gdbarch *gdbarch, struct frame_info *next_frame);
455extern void set_gdbarch_unwind_sp (struct gdbarch *gdbarch, gdbarch_unwind_sp_ftype *unwind_sp);
456
457/* DEPRECATED_FRAME_LOCALS_ADDRESS as been replaced by the per-frame
458   frame-base.  Enable frame-base before frame-unwind. */
459
460extern int gdbarch_frame_num_args_p (struct gdbarch *gdbarch);
461
462typedef int (gdbarch_frame_num_args_ftype) (struct frame_info *frame);
463extern int gdbarch_frame_num_args (struct gdbarch *gdbarch, struct frame_info *frame);
464extern void set_gdbarch_frame_num_args (struct gdbarch *gdbarch, gdbarch_frame_num_args_ftype *frame_num_args);
465
466extern int gdbarch_frame_align_p (struct gdbarch *gdbarch);
467
468typedef CORE_ADDR (gdbarch_frame_align_ftype) (struct gdbarch *gdbarch, CORE_ADDR address);
469extern CORE_ADDR gdbarch_frame_align (struct gdbarch *gdbarch, CORE_ADDR address);
470extern void set_gdbarch_frame_align (struct gdbarch *gdbarch, gdbarch_frame_align_ftype *frame_align);
471
472/* deprecated_reg_struct_has_addr has been replaced by
473   stabs_argument_has_addr. */
474
475extern int gdbarch_deprecated_reg_struct_has_addr_p (struct gdbarch *gdbarch);
476
477typedef int (gdbarch_deprecated_reg_struct_has_addr_ftype) (int gcc_p, struct type *type);
478extern int gdbarch_deprecated_reg_struct_has_addr (struct gdbarch *gdbarch, int gcc_p, struct type *type);
479extern void set_gdbarch_deprecated_reg_struct_has_addr (struct gdbarch *gdbarch, gdbarch_deprecated_reg_struct_has_addr_ftype *deprecated_reg_struct_has_addr);
480
481typedef int (gdbarch_stabs_argument_has_addr_ftype) (struct gdbarch *gdbarch, struct type *type);
482extern int gdbarch_stabs_argument_has_addr (struct gdbarch *gdbarch, struct type *type);
483extern void set_gdbarch_stabs_argument_has_addr (struct gdbarch *gdbarch, gdbarch_stabs_argument_has_addr_ftype *stabs_argument_has_addr);
484
485extern int gdbarch_frame_red_zone_size (struct gdbarch *gdbarch);
486extern void set_gdbarch_frame_red_zone_size (struct gdbarch *gdbarch, int frame_red_zone_size);
487
488typedef CORE_ADDR (gdbarch_convert_from_func_ptr_addr_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr, struct target_ops *targ);
489extern CORE_ADDR gdbarch_convert_from_func_ptr_addr (struct gdbarch *gdbarch, CORE_ADDR addr, struct target_ops *targ);
490extern void set_gdbarch_convert_from_func_ptr_addr (struct gdbarch *gdbarch, gdbarch_convert_from_func_ptr_addr_ftype *convert_from_func_ptr_addr);
491
492/* On some machines there are bits in addresses which are not really
493   part of the address, but are used by the kernel, the hardware, etc.
494   for special purposes.  gdbarch_addr_bits_remove takes out any such bits so
495   we get a "real" address such as one would find in a symbol table.
496   This is used only for addresses of instructions, and even then I'm
497   not sure it's used in all contexts.  It exists to deal with there
498   being a few stray bits in the PC which would mislead us, not as some
499   sort of generic thing to handle alignment or segmentation (it's
500   possible it should be in TARGET_READ_PC instead). */
501
502typedef CORE_ADDR (gdbarch_addr_bits_remove_ftype) (CORE_ADDR addr);
503extern CORE_ADDR gdbarch_addr_bits_remove (struct gdbarch *gdbarch, CORE_ADDR addr);
504extern void set_gdbarch_addr_bits_remove (struct gdbarch *gdbarch, gdbarch_addr_bits_remove_ftype *addr_bits_remove);
505
506/* It is not at all clear why gdbarch_smash_text_address is not folded into
507   gdbarch_addr_bits_remove. */
508
509typedef CORE_ADDR (gdbarch_smash_text_address_ftype) (CORE_ADDR addr);
510extern CORE_ADDR gdbarch_smash_text_address (struct gdbarch *gdbarch, CORE_ADDR addr);
511extern void set_gdbarch_smash_text_address (struct gdbarch *gdbarch, gdbarch_smash_text_address_ftype *smash_text_address);
512
513/* FIXME/cagney/2001-01-18: This should be split in two.  A target method that
514   indicates if the target needs software single step.  An ISA method to
515   implement it.
516
517   FIXME/cagney/2001-01-18: This should be replaced with something that inserts
518   breakpoints using the breakpoint system instead of blatting memory directly
519   (as with rs6000).
520
521   FIXME/cagney/2001-01-18: The logic is backwards.  It should be asking if the
522   target can single step.  If not, then implement single step using breakpoints.
523
524   A return value of 1 means that the software_single_step breakpoints
525   were inserted; 0 means they were not. */
526
527extern int gdbarch_software_single_step_p (struct gdbarch *gdbarch);
528
529typedef int (gdbarch_software_single_step_ftype) (struct frame_info *frame);
530extern int gdbarch_software_single_step (struct gdbarch *gdbarch, struct frame_info *frame);
531extern void set_gdbarch_software_single_step (struct gdbarch *gdbarch, gdbarch_software_single_step_ftype *software_single_step);
532
533/* Return non-zero if the processor is executing a delay slot and a
534   further single-step is needed before the instruction finishes. */
535
536extern int gdbarch_single_step_through_delay_p (struct gdbarch *gdbarch);
537
538typedef int (gdbarch_single_step_through_delay_ftype) (struct gdbarch *gdbarch, struct frame_info *frame);
539extern int gdbarch_single_step_through_delay (struct gdbarch *gdbarch, struct frame_info *frame);
540extern void set_gdbarch_single_step_through_delay (struct gdbarch *gdbarch, gdbarch_single_step_through_delay_ftype *single_step_through_delay);
541
542/* FIXME: cagney/2003-08-28: Need to find a better way of selecting the
543   disassembler.  Perhaps objdump can handle it? */
544
545typedef int (gdbarch_print_insn_ftype) (bfd_vma vma, struct disassemble_info *info);
546extern int gdbarch_print_insn (struct gdbarch *gdbarch, bfd_vma vma, struct disassemble_info *info);
547extern void set_gdbarch_print_insn (struct gdbarch *gdbarch, gdbarch_print_insn_ftype *print_insn);
548
549typedef CORE_ADDR (gdbarch_skip_trampoline_code_ftype) (struct frame_info *frame, CORE_ADDR pc);
550extern CORE_ADDR gdbarch_skip_trampoline_code (struct gdbarch *gdbarch, struct frame_info *frame, CORE_ADDR pc);
551extern void set_gdbarch_skip_trampoline_code (struct gdbarch *gdbarch, gdbarch_skip_trampoline_code_ftype *skip_trampoline_code);
552
553/* If IN_SOLIB_DYNSYM_RESOLVE_CODE returns true, and SKIP_SOLIB_RESOLVER
554   evaluates non-zero, this is the address where the debugger will place
555   a step-resume breakpoint to get us past the dynamic linker. */
556
557typedef CORE_ADDR (gdbarch_skip_solib_resolver_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc);
558extern CORE_ADDR gdbarch_skip_solib_resolver (struct gdbarch *gdbarch, CORE_ADDR pc);
559extern void set_gdbarch_skip_solib_resolver (struct gdbarch *gdbarch, gdbarch_skip_solib_resolver_ftype *skip_solib_resolver);
560
561/* Some systems also have trampoline code for returning from shared libs. */
562
563typedef int (gdbarch_in_solib_return_trampoline_ftype) (CORE_ADDR pc, char *name);
564extern int gdbarch_in_solib_return_trampoline (struct gdbarch *gdbarch, CORE_ADDR pc, char *name);
565extern void set_gdbarch_in_solib_return_trampoline (struct gdbarch *gdbarch, gdbarch_in_solib_return_trampoline_ftype *in_solib_return_trampoline);
566
567/* A target might have problems with watchpoints as soon as the stack
568   frame of the current function has been destroyed.  This mostly happens
569   as the first action in a funtion's epilogue.  in_function_epilogue_p()
570   is defined to return a non-zero value if either the given addr is one
571   instruction after the stack destroying instruction up to the trailing
572   return instruction or if we can figure out that the stack frame has
573   already been invalidated regardless of the value of addr.  Targets
574   which don't suffer from that problem could just let this functionality
575   untouched. */
576
577typedef int (gdbarch_in_function_epilogue_p_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
578extern int gdbarch_in_function_epilogue_p (struct gdbarch *gdbarch, CORE_ADDR addr);
579extern void set_gdbarch_in_function_epilogue_p (struct gdbarch *gdbarch, gdbarch_in_function_epilogue_p_ftype *in_function_epilogue_p);
580
581/* Given a vector of command-line arguments, return a newly allocated
582   string which, when passed to the create_inferior function, will be
583   parsed (on Unix systems, by the shell) to yield the same vector.
584   This function should call error() if the argument vector is not
585   representable for this target or if this target does not support
586   command-line arguments.
587   ARGC is the number of elements in the vector.
588   ARGV is an array of strings, one per argument. */
589
590typedef char * (gdbarch_construct_inferior_arguments_ftype) (struct gdbarch *gdbarch, int argc, char **argv);
591extern char * gdbarch_construct_inferior_arguments (struct gdbarch *gdbarch, int argc, char **argv);
592extern void set_gdbarch_construct_inferior_arguments (struct gdbarch *gdbarch, gdbarch_construct_inferior_arguments_ftype *construct_inferior_arguments);
593
594typedef void (gdbarch_elf_make_msymbol_special_ftype) (asymbol *sym, struct minimal_symbol *msym);
595extern void gdbarch_elf_make_msymbol_special (struct gdbarch *gdbarch, asymbol *sym, struct minimal_symbol *msym);
596extern void set_gdbarch_elf_make_msymbol_special (struct gdbarch *gdbarch, gdbarch_elf_make_msymbol_special_ftype *elf_make_msymbol_special);
597
598typedef void (gdbarch_coff_make_msymbol_special_ftype) (int val, struct minimal_symbol *msym);
599extern void gdbarch_coff_make_msymbol_special (struct gdbarch *gdbarch, int val, struct minimal_symbol *msym);
600extern void set_gdbarch_coff_make_msymbol_special (struct gdbarch *gdbarch, gdbarch_coff_make_msymbol_special_ftype *coff_make_msymbol_special);
601
602extern const char * gdbarch_name_of_malloc (struct gdbarch *gdbarch);
603extern void set_gdbarch_name_of_malloc (struct gdbarch *gdbarch, const char * name_of_malloc);
604
605extern int gdbarch_cannot_step_breakpoint (struct gdbarch *gdbarch);
606extern void set_gdbarch_cannot_step_breakpoint (struct gdbarch *gdbarch, int cannot_step_breakpoint);
607
608extern int gdbarch_have_nonsteppable_watchpoint (struct gdbarch *gdbarch);
609extern void set_gdbarch_have_nonsteppable_watchpoint (struct gdbarch *gdbarch, int have_nonsteppable_watchpoint);
610
611extern int gdbarch_address_class_type_flags_p (struct gdbarch *gdbarch);
612
613typedef int (gdbarch_address_class_type_flags_ftype) (int byte_size, int dwarf2_addr_class);
614extern int gdbarch_address_class_type_flags (struct gdbarch *gdbarch, int byte_size, int dwarf2_addr_class);
615extern void set_gdbarch_address_class_type_flags (struct gdbarch *gdbarch, gdbarch_address_class_type_flags_ftype *address_class_type_flags);
616
617extern int gdbarch_address_class_type_flags_to_name_p (struct gdbarch *gdbarch);
618
619typedef const char * (gdbarch_address_class_type_flags_to_name_ftype) (struct gdbarch *gdbarch, int type_flags);
620extern const char * gdbarch_address_class_type_flags_to_name (struct gdbarch *gdbarch, int type_flags);
621extern 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);
622
623extern int gdbarch_address_class_name_to_type_flags_p (struct gdbarch *gdbarch);
624
625typedef int (gdbarch_address_class_name_to_type_flags_ftype) (struct gdbarch *gdbarch, const char *name, int *type_flags_ptr);
626extern int gdbarch_address_class_name_to_type_flags (struct gdbarch *gdbarch, const char *name, int *type_flags_ptr);
627extern 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);
628
629/* Is a register in a group */
630
631typedef int (gdbarch_register_reggroup_p_ftype) (struct gdbarch *gdbarch, int regnum, struct reggroup *reggroup);
632extern int gdbarch_register_reggroup_p (struct gdbarch *gdbarch, int regnum, struct reggroup *reggroup);
633extern void set_gdbarch_register_reggroup_p (struct gdbarch *gdbarch, gdbarch_register_reggroup_p_ftype *register_reggroup_p);
634
635/* Fetch the pointer to the ith function argument. */
636
637extern int gdbarch_fetch_pointer_argument_p (struct gdbarch *gdbarch);
638
639typedef CORE_ADDR (gdbarch_fetch_pointer_argument_ftype) (struct frame_info *frame, int argi, struct type *type);
640extern CORE_ADDR gdbarch_fetch_pointer_argument (struct gdbarch *gdbarch, struct frame_info *frame, int argi, struct type *type);
641extern void set_gdbarch_fetch_pointer_argument (struct gdbarch *gdbarch, gdbarch_fetch_pointer_argument_ftype *fetch_pointer_argument);
642
643/* Return the appropriate register set for a core file section with
644   name SECT_NAME and size SECT_SIZE. */
645
646extern int gdbarch_regset_from_core_section_p (struct gdbarch *gdbarch);
647
648typedef const struct regset * (gdbarch_regset_from_core_section_ftype) (struct gdbarch *gdbarch, const char *sect_name, size_t sect_size);
649extern const struct regset * gdbarch_regset_from_core_section (struct gdbarch *gdbarch, const char *sect_name, size_t sect_size);
650extern void set_gdbarch_regset_from_core_section (struct gdbarch *gdbarch, gdbarch_regset_from_core_section_ftype *regset_from_core_section);
651
652/* Read offset OFFSET of TARGET_OBJECT_LIBRARIES formatted shared libraries list from
653   core file into buffer READBUF with length LEN. */
654
655extern int gdbarch_core_xfer_shared_libraries_p (struct gdbarch *gdbarch);
656
657typedef LONGEST (gdbarch_core_xfer_shared_libraries_ftype) (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, LONGEST len);
658extern LONGEST gdbarch_core_xfer_shared_libraries (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, LONGEST len);
659extern void set_gdbarch_core_xfer_shared_libraries (struct gdbarch *gdbarch, gdbarch_core_xfer_shared_libraries_ftype *core_xfer_shared_libraries);
660
661/* If the elements of C++ vtables are in-place function descriptors rather
662   than normal function pointers (which may point to code or a descriptor),
663   set this to one. */
664
665extern int gdbarch_vtable_function_descriptors (struct gdbarch *gdbarch);
666extern void set_gdbarch_vtable_function_descriptors (struct gdbarch *gdbarch, int vtable_function_descriptors);
667
668/* Set if the least significant bit of the delta is used instead of the least
669   significant bit of the pfn for pointers to virtual member functions. */
670
671extern int gdbarch_vbit_in_delta (struct gdbarch *gdbarch);
672extern void set_gdbarch_vbit_in_delta (struct gdbarch *gdbarch, int vbit_in_delta);
673
674/* Advance PC to next instruction in order to skip a permanent breakpoint. */
675
676extern int gdbarch_skip_permanent_breakpoint_p (struct gdbarch *gdbarch);
677
678typedef void (gdbarch_skip_permanent_breakpoint_ftype) (struct regcache *regcache);
679extern void gdbarch_skip_permanent_breakpoint (struct gdbarch *gdbarch, struct regcache *regcache);
680extern void set_gdbarch_skip_permanent_breakpoint (struct gdbarch *gdbarch, gdbarch_skip_permanent_breakpoint_ftype *skip_permanent_breakpoint);
681
682/* Refresh overlay mapped state for section OSECT. */
683
684extern int gdbarch_overlay_update_p (struct gdbarch *gdbarch);
685
686typedef void (gdbarch_overlay_update_ftype) (struct obj_section *osect);
687extern void gdbarch_overlay_update (struct gdbarch *gdbarch, struct obj_section *osect);
688extern void set_gdbarch_overlay_update (struct gdbarch *gdbarch, gdbarch_overlay_update_ftype *overlay_update);
689
690extern struct gdbarch_tdep *gdbarch_tdep (struct gdbarch *gdbarch);
691
692
693/* Mechanism for co-ordinating the selection of a specific
694   architecture.
695
696   GDB targets (*-tdep.c) can register an interest in a specific
697   architecture.  Other GDB components can register a need to maintain
698   per-architecture data.
699
700   The mechanisms below ensures that there is only a loose connection
701   between the set-architecture command and the various GDB
702   components.  Each component can independently register their need
703   to maintain architecture specific data with gdbarch.
704
705   Pragmatics:
706
707   Previously, a single TARGET_ARCHITECTURE_HOOK was provided.  It
708   didn't scale.
709
710   The more traditional mega-struct containing architecture specific
711   data for all the various GDB components was also considered.  Since
712   GDB is built from a variable number of (fairly independent)
713   components it was determined that the global aproach was not
714   applicable. */
715
716
717/* Register a new architectural family with GDB.
718
719   Register support for the specified ARCHITECTURE with GDB.  When
720   gdbarch determines that the specified architecture has been
721   selected, the corresponding INIT function is called.
722
723   --
724
725   The INIT function takes two parameters: INFO which contains the
726   information available to gdbarch about the (possibly new)
727   architecture; ARCHES which is a list of the previously created
728   ``struct gdbarch'' for this architecture.
729
730   The INFO parameter is, as far as possible, be pre-initialized with
731   information obtained from INFO.ABFD or the global defaults.
732
733   The ARCHES parameter is a linked list (sorted most recently used)
734   of all the previously created architures for this architecture
735   family.  The (possibly NULL) ARCHES->gdbarch can used to access
736   values from the previously selected architecture for this
737   architecture family.  The global ``current_gdbarch'' shall not be
738   used.
739
740   The INIT function shall return any of: NULL - indicating that it
741   doesn't recognize the selected architecture; an existing ``struct
742   gdbarch'' from the ARCHES list - indicating that the new
743   architecture is just a synonym for an earlier architecture (see
744   gdbarch_list_lookup_by_info()); a newly created ``struct gdbarch''
745   - that describes the selected architecture (see gdbarch_alloc()).
746
747   The DUMP_TDEP function shall print out all target specific values.
748   Care should be taken to ensure that the function works in both the
749   multi-arch and non- multi-arch cases. */
750
751struct gdbarch_list
752{
753  struct gdbarch *gdbarch;
754  struct gdbarch_list *next;
755};
756
757struct gdbarch_info
758{
759  /* Use default: NULL (ZERO). */
760  const struct bfd_arch_info *bfd_arch_info;
761
762  /* Use default: BFD_ENDIAN_UNKNOWN (NB: is not ZERO).  */
763  int byte_order;
764
765  /* Use default: NULL (ZERO). */
766  bfd *abfd;
767
768  /* Use default: NULL (ZERO). */
769  struct gdbarch_tdep_info *tdep_info;
770
771  /* Use default: GDB_OSABI_UNINITIALIZED (-1).  */
772  enum gdb_osabi osabi;
773
774  /* Use default: NULL (ZERO).  */
775  const struct target_desc *target_desc;
776};
777
778typedef struct gdbarch *(gdbarch_init_ftype) (struct gdbarch_info info, struct gdbarch_list *arches);
779typedef void (gdbarch_dump_tdep_ftype) (struct gdbarch *gdbarch, struct ui_file *file);
780
781/* DEPRECATED - use gdbarch_register() */
782extern void register_gdbarch_init (enum bfd_architecture architecture, gdbarch_init_ftype *);
783
784extern void gdbarch_register (enum bfd_architecture architecture,
785                              gdbarch_init_ftype *,
786                              gdbarch_dump_tdep_ftype *);
787
788
789/* Return a freshly allocated, NULL terminated, array of the valid
790   architecture names.  Since architectures are registered during the
791   _initialize phase this function only returns useful information
792   once initialization has been completed. */
793
794extern const char **gdbarch_printable_names (void);
795
796
797/* Helper function.  Search the list of ARCHES for a GDBARCH that
798   matches the information provided by INFO. */
799
800extern struct gdbarch_list *gdbarch_list_lookup_by_info (struct gdbarch_list *arches, const struct gdbarch_info *info);
801
802
803/* Helper function.  Create a preliminary ``struct gdbarch''.  Perform
804   basic initialization using values obtained from the INFO and TDEP
805   parameters.  set_gdbarch_*() functions are called to complete the
806   initialization of the object. */
807
808extern struct gdbarch *gdbarch_alloc (const struct gdbarch_info *info, struct gdbarch_tdep *tdep);
809
810
811/* Helper function.  Free a partially-constructed ``struct gdbarch''.
812   It is assumed that the caller freeds the ``struct
813   gdbarch_tdep''. */
814
815extern void gdbarch_free (struct gdbarch *);
816
817
818/* Helper function.  Allocate memory from the ``struct gdbarch''
819   obstack.  The memory is freed when the corresponding architecture
820   is also freed.  */
821
822extern void *gdbarch_obstack_zalloc (struct gdbarch *gdbarch, long size);
823#define GDBARCH_OBSTACK_CALLOC(GDBARCH, NR, TYPE) ((TYPE *) gdbarch_obstack_zalloc ((GDBARCH), (NR) * sizeof (TYPE)))
824#define GDBARCH_OBSTACK_ZALLOC(GDBARCH, TYPE) ((TYPE *) gdbarch_obstack_zalloc ((GDBARCH), sizeof (TYPE)))
825
826
827/* Helper function. Force an update of the current architecture.
828
829   The actual architecture selected is determined by INFO, ``(gdb) set
830   architecture'' et.al., the existing architecture and BFD's default
831   architecture.  INFO should be initialized to zero and then selected
832   fields should be updated.
833
834   Returns non-zero if the update succeeds */
835
836extern int gdbarch_update_p (struct gdbarch_info info);
837
838
839/* Helper function.  Find an architecture matching info.
840
841   INFO should be initialized using gdbarch_info_init, relevant fields
842   set, and then finished using gdbarch_info_fill.
843
844   Returns the corresponding architecture, or NULL if no matching
845   architecture was found.  "current_gdbarch" is not updated.  */
846
847extern struct gdbarch *gdbarch_find_by_info (struct gdbarch_info info);
848
849
850/* Helper function.  Set the global "current_gdbarch" to "gdbarch".
851
852   FIXME: kettenis/20031124: Of the functions that follow, only
853   gdbarch_from_bfd is supposed to survive.  The others will
854   dissappear since in the future GDB will (hopefully) be truly
855   multi-arch.  However, for now we're still stuck with the concept of
856   a single active architecture.  */
857
858extern void deprecated_current_gdbarch_select_hack (struct gdbarch *gdbarch);
859
860
861/* Register per-architecture data-pointer.
862
863   Reserve space for a per-architecture data-pointer.  An identifier
864   for the reserved data-pointer is returned.  That identifer should
865   be saved in a local static variable.
866
867   Memory for the per-architecture data shall be allocated using
868   gdbarch_obstack_zalloc.  That memory will be deleted when the
869   corresponding architecture object is deleted.
870
871   When a previously created architecture is re-selected, the
872   per-architecture data-pointer for that previous architecture is
873   restored.  INIT() is not re-called.
874
875   Multiple registrarants for any architecture are allowed (and
876   strongly encouraged).  */
877
878struct gdbarch_data;
879
880typedef void *(gdbarch_data_pre_init_ftype) (struct obstack *obstack);
881extern struct gdbarch_data *gdbarch_data_register_pre_init (gdbarch_data_pre_init_ftype *init);
882typedef void *(gdbarch_data_post_init_ftype) (struct gdbarch *gdbarch);
883extern struct gdbarch_data *gdbarch_data_register_post_init (gdbarch_data_post_init_ftype *init);
884extern void deprecated_set_gdbarch_data (struct gdbarch *gdbarch,
885                                         struct gdbarch_data *data,
886			                 void *pointer);
887
888extern void *gdbarch_data (struct gdbarch *gdbarch, struct gdbarch_data *);
889
890
891/* Set the dynamic target-system-dependent parameters (architecture,
892   byte-order, ...) using information found in the BFD */
893
894extern void set_gdbarch_from_file (bfd *);
895
896
897/* Initialize the current architecture to the "first" one we find on
898   our list.  */
899
900extern void initialize_current_architecture (void);
901
902/* gdbarch trace variable */
903extern int gdbarch_debug;
904
905extern void gdbarch_dump (struct gdbarch *gdbarch, struct ui_file *file);
906
907#endif
908