* gdbarch.h (target_gdbarch): Add comment documenting this global.
[gdb/SamB.git] / gdb / gdbarch.h
blobe844f52d6387e436cb16e7c453c9514682bdc8dd
1 /* *INDENT-OFF* */ /* THIS FILE IS GENERATED */
3 /* Dynamic architecture support for GDB, the GNU debugger.
5 Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007
6 Free Software Foundation, Inc.
8 This file is part of GDB.
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.
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.
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/>. */
23 /* This file was created with the aid of ``gdbarch.sh''.
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.
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. */
35 #ifndef GDBARCH_H
36 #define GDBARCH_H
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;
56 extern struct gdbarch *current_gdbarch;
58 /* The architecture associated with the connection to the target.
60 The architecture vector provides some information that is really
61 a property of the target: The layout of certain packets, for instance;
62 or the solib_ops vector. Etc. To differentiate architecture accesses
63 to per-target properties from per-thread/per-frame/per-objfile properties,
64 accesses to per-target properties should be made through target_gdbarch.
66 Eventually, when support for multiple targets is implemented in
67 GDB, this global should be made target-specific. */
68 extern struct gdbarch *target_gdbarch;
71 /* The following are pre-initialized by GDBARCH. */
73 extern const struct bfd_arch_info * gdbarch_bfd_arch_info (struct gdbarch *gdbarch);
74 /* set_gdbarch_bfd_arch_info() - not applicable - pre-initialized. */
76 extern int gdbarch_byte_order (struct gdbarch *gdbarch);
77 /* set_gdbarch_byte_order() - not applicable - pre-initialized. */
79 extern int gdbarch_byte_order_for_code (struct gdbarch *gdbarch);
80 /* set_gdbarch_byte_order_for_code() - not applicable - pre-initialized. */
82 extern enum gdb_osabi gdbarch_osabi (struct gdbarch *gdbarch);
83 /* set_gdbarch_osabi() - not applicable - pre-initialized. */
85 extern const struct target_desc * gdbarch_target_desc (struct gdbarch *gdbarch);
86 /* set_gdbarch_target_desc() - not applicable - pre-initialized. */
89 /* The following are initialized by the target dependent code. */
91 /* The bit byte-order has to do just with numbering of bits in debugging symbols
92 and such. Conceptually, it's quite separate from byte/word byte order. */
94 extern int gdbarch_bits_big_endian (struct gdbarch *gdbarch);
95 extern void set_gdbarch_bits_big_endian (struct gdbarch *gdbarch, int bits_big_endian);
97 /* Number of bits in a char or unsigned char for the target machine.
98 Just like CHAR_BIT in <limits.h> but describes the target machine.
99 v:TARGET_CHAR_BIT:int:char_bit::::8 * sizeof (char):8::0:
101 Number of bits in a short or unsigned short for the target machine. */
103 extern int gdbarch_short_bit (struct gdbarch *gdbarch);
104 extern void set_gdbarch_short_bit (struct gdbarch *gdbarch, int short_bit);
106 /* Number of bits in an int or unsigned int for the target machine. */
108 extern int gdbarch_int_bit (struct gdbarch *gdbarch);
109 extern void set_gdbarch_int_bit (struct gdbarch *gdbarch, int int_bit);
111 /* Number of bits in a long or unsigned long for the target machine. */
113 extern int gdbarch_long_bit (struct gdbarch *gdbarch);
114 extern void set_gdbarch_long_bit (struct gdbarch *gdbarch, int long_bit);
116 /* Number of bits in a long long or unsigned long long for the target
117 machine. */
119 extern int gdbarch_long_long_bit (struct gdbarch *gdbarch);
120 extern void set_gdbarch_long_long_bit (struct gdbarch *gdbarch, int long_long_bit);
122 /* The ABI default bit-size and format for "float", "double", and "long
123 double". These bit/format pairs should eventually be combined into
124 a single object. For the moment, just initialize them as a pair.
125 Each format describes both the big and little endian layouts (if
126 useful). */
128 extern int gdbarch_float_bit (struct gdbarch *gdbarch);
129 extern void set_gdbarch_float_bit (struct gdbarch *gdbarch, int float_bit);
131 extern const struct floatformat ** gdbarch_float_format (struct gdbarch *gdbarch);
132 extern void set_gdbarch_float_format (struct gdbarch *gdbarch, const struct floatformat ** float_format);
134 extern int gdbarch_double_bit (struct gdbarch *gdbarch);
135 extern void set_gdbarch_double_bit (struct gdbarch *gdbarch, int double_bit);
137 extern const struct floatformat ** gdbarch_double_format (struct gdbarch *gdbarch);
138 extern void set_gdbarch_double_format (struct gdbarch *gdbarch, const struct floatformat ** double_format);
140 extern int gdbarch_long_double_bit (struct gdbarch *gdbarch);
141 extern void set_gdbarch_long_double_bit (struct gdbarch *gdbarch, int long_double_bit);
143 extern const struct floatformat ** gdbarch_long_double_format (struct gdbarch *gdbarch);
144 extern void set_gdbarch_long_double_format (struct gdbarch *gdbarch, const struct floatformat ** long_double_format);
146 /* For most targets, a pointer on the target and its representation as an
147 address in GDB have the same size and "look the same". For such a
148 target, you need only set gdbarch_ptr_bit and gdbarch_addr_bit
149 / addr_bit will be set from it.
151 If gdbarch_ptr_bit and gdbarch_addr_bit are different, you'll probably
152 also need to set gdbarch_pointer_to_address and gdbarch_address_to_pointer
153 as well.
155 ptr_bit is the size of a pointer on the target */
157 extern int gdbarch_ptr_bit (struct gdbarch *gdbarch);
158 extern void set_gdbarch_ptr_bit (struct gdbarch *gdbarch, int ptr_bit);
160 /* addr_bit is the size of a target address as represented in gdb */
162 extern int gdbarch_addr_bit (struct gdbarch *gdbarch);
163 extern void set_gdbarch_addr_bit (struct gdbarch *gdbarch, int addr_bit);
165 /* One if `char' acts like `signed char', zero if `unsigned char'. */
167 extern int gdbarch_char_signed (struct gdbarch *gdbarch);
168 extern void set_gdbarch_char_signed (struct gdbarch *gdbarch, int char_signed);
170 extern int gdbarch_read_pc_p (struct gdbarch *gdbarch);
172 typedef CORE_ADDR (gdbarch_read_pc_ftype) (struct regcache *regcache);
173 extern CORE_ADDR gdbarch_read_pc (struct gdbarch *gdbarch, struct regcache *regcache);
174 extern void set_gdbarch_read_pc (struct gdbarch *gdbarch, gdbarch_read_pc_ftype *read_pc);
176 extern int gdbarch_write_pc_p (struct gdbarch *gdbarch);
178 typedef void (gdbarch_write_pc_ftype) (struct regcache *regcache, CORE_ADDR val);
179 extern void gdbarch_write_pc (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR val);
180 extern void set_gdbarch_write_pc (struct gdbarch *gdbarch, gdbarch_write_pc_ftype *write_pc);
182 /* Function for getting target's idea of a frame pointer. FIXME: GDB's
183 whole scheme for dealing with "frames" and "frame pointers" needs a
184 serious shakedown. */
186 typedef void (gdbarch_virtual_frame_pointer_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc, int *frame_regnum, LONGEST *frame_offset);
187 extern void gdbarch_virtual_frame_pointer (struct gdbarch *gdbarch, CORE_ADDR pc, int *frame_regnum, LONGEST *frame_offset);
188 extern void set_gdbarch_virtual_frame_pointer (struct gdbarch *gdbarch, gdbarch_virtual_frame_pointer_ftype *virtual_frame_pointer);
190 extern int gdbarch_pseudo_register_read_p (struct gdbarch *gdbarch);
192 typedef void (gdbarch_pseudo_register_read_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, gdb_byte *buf);
193 extern void gdbarch_pseudo_register_read (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, gdb_byte *buf);
194 extern void set_gdbarch_pseudo_register_read (struct gdbarch *gdbarch, gdbarch_pseudo_register_read_ftype *pseudo_register_read);
196 extern int gdbarch_pseudo_register_write_p (struct gdbarch *gdbarch);
198 typedef void (gdbarch_pseudo_register_write_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, const gdb_byte *buf);
199 extern void gdbarch_pseudo_register_write (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, const gdb_byte *buf);
200 extern void set_gdbarch_pseudo_register_write (struct gdbarch *gdbarch, gdbarch_pseudo_register_write_ftype *pseudo_register_write);
202 extern int gdbarch_num_regs (struct gdbarch *gdbarch);
203 extern void set_gdbarch_num_regs (struct gdbarch *gdbarch, int num_regs);
205 /* This macro gives the number of pseudo-registers that live in the
206 register namespace but do not get fetched or stored on the target.
207 These pseudo-registers may be aliases for other registers,
208 combinations of other registers, or they may be computed by GDB. */
210 extern int gdbarch_num_pseudo_regs (struct gdbarch *gdbarch);
211 extern void set_gdbarch_num_pseudo_regs (struct gdbarch *gdbarch, int num_pseudo_regs);
213 /* GDB's standard (or well known) register numbers. These can map onto
214 a real register or a pseudo (computed) register or not be defined at
215 all (-1).
216 gdbarch_sp_regnum will hopefully be replaced by UNWIND_SP. */
218 extern int gdbarch_sp_regnum (struct gdbarch *gdbarch);
219 extern void set_gdbarch_sp_regnum (struct gdbarch *gdbarch, int sp_regnum);
221 extern int gdbarch_pc_regnum (struct gdbarch *gdbarch);
222 extern void set_gdbarch_pc_regnum (struct gdbarch *gdbarch, int pc_regnum);
224 extern int gdbarch_ps_regnum (struct gdbarch *gdbarch);
225 extern void set_gdbarch_ps_regnum (struct gdbarch *gdbarch, int ps_regnum);
227 extern int gdbarch_fp0_regnum (struct gdbarch *gdbarch);
228 extern void set_gdbarch_fp0_regnum (struct gdbarch *gdbarch, int fp0_regnum);
230 /* Convert stab register number (from `r' declaration) to a gdb REGNUM. */
232 typedef int (gdbarch_stab_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int stab_regnr);
233 extern int gdbarch_stab_reg_to_regnum (struct gdbarch *gdbarch, int stab_regnr);
234 extern void set_gdbarch_stab_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_stab_reg_to_regnum_ftype *stab_reg_to_regnum);
236 /* Provide a default mapping from a ecoff register number to a gdb REGNUM. */
238 typedef int (gdbarch_ecoff_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int ecoff_regnr);
239 extern int gdbarch_ecoff_reg_to_regnum (struct gdbarch *gdbarch, int ecoff_regnr);
240 extern void set_gdbarch_ecoff_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_ecoff_reg_to_regnum_ftype *ecoff_reg_to_regnum);
242 /* Convert from an sdb register number to an internal gdb register number. */
244 typedef int (gdbarch_sdb_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int sdb_regnr);
245 extern int gdbarch_sdb_reg_to_regnum (struct gdbarch *gdbarch, int sdb_regnr);
246 extern void set_gdbarch_sdb_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_sdb_reg_to_regnum_ftype *sdb_reg_to_regnum);
248 /* Provide a default mapping from a DWARF2 register number to a gdb REGNUM. */
250 typedef int (gdbarch_dwarf2_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int dwarf2_regnr);
251 extern int gdbarch_dwarf2_reg_to_regnum (struct gdbarch *gdbarch, int dwarf2_regnr);
252 extern void set_gdbarch_dwarf2_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_dwarf2_reg_to_regnum_ftype *dwarf2_reg_to_regnum);
254 typedef const char * (gdbarch_register_name_ftype) (struct gdbarch *gdbarch, int regnr);
255 extern const char * gdbarch_register_name (struct gdbarch *gdbarch, int regnr);
256 extern void set_gdbarch_register_name (struct gdbarch *gdbarch, gdbarch_register_name_ftype *register_name);
258 /* Return the type of a register specified by the architecture. Only
259 the register cache should call this function directly; others should
260 use "register_type". */
262 extern int gdbarch_register_type_p (struct gdbarch *gdbarch);
264 typedef struct type * (gdbarch_register_type_ftype) (struct gdbarch *gdbarch, int reg_nr);
265 extern struct type * gdbarch_register_type (struct gdbarch *gdbarch, int reg_nr);
266 extern void set_gdbarch_register_type (struct gdbarch *gdbarch, gdbarch_register_type_ftype *register_type);
268 /* See gdbint.texinfo, and PUSH_DUMMY_CALL. */
270 extern int gdbarch_dummy_id_p (struct gdbarch *gdbarch);
272 typedef struct frame_id (gdbarch_dummy_id_ftype) (struct gdbarch *gdbarch, struct frame_info *this_frame);
273 extern struct frame_id gdbarch_dummy_id (struct gdbarch *gdbarch, struct frame_info *this_frame);
274 extern void set_gdbarch_dummy_id (struct gdbarch *gdbarch, gdbarch_dummy_id_ftype *dummy_id);
276 /* Implement DUMMY_ID and PUSH_DUMMY_CALL, then delete
277 deprecated_fp_regnum. */
279 extern int gdbarch_deprecated_fp_regnum (struct gdbarch *gdbarch);
280 extern void set_gdbarch_deprecated_fp_regnum (struct gdbarch *gdbarch, int deprecated_fp_regnum);
282 /* See gdbint.texinfo. See infcall.c. */
284 extern int gdbarch_push_dummy_call_p (struct gdbarch *gdbarch);
286 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);
287 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);
288 extern void set_gdbarch_push_dummy_call (struct gdbarch *gdbarch, gdbarch_push_dummy_call_ftype *push_dummy_call);
290 extern int gdbarch_call_dummy_location (struct gdbarch *gdbarch);
291 extern void set_gdbarch_call_dummy_location (struct gdbarch *gdbarch, int call_dummy_location);
293 extern int gdbarch_push_dummy_code_p (struct gdbarch *gdbarch);
295 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);
296 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);
297 extern void set_gdbarch_push_dummy_code (struct gdbarch *gdbarch, gdbarch_push_dummy_code_ftype *push_dummy_code);
299 typedef void (gdbarch_print_registers_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, int regnum, int all);
300 extern void gdbarch_print_registers_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, int regnum, int all);
301 extern void set_gdbarch_print_registers_info (struct gdbarch *gdbarch, gdbarch_print_registers_info_ftype *print_registers_info);
303 extern int gdbarch_print_float_info_p (struct gdbarch *gdbarch);
305 typedef void (gdbarch_print_float_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
306 extern void gdbarch_print_float_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
307 extern void set_gdbarch_print_float_info (struct gdbarch *gdbarch, gdbarch_print_float_info_ftype *print_float_info);
309 extern int gdbarch_print_vector_info_p (struct gdbarch *gdbarch);
311 typedef void (gdbarch_print_vector_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
312 extern void gdbarch_print_vector_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
313 extern void set_gdbarch_print_vector_info (struct gdbarch *gdbarch, gdbarch_print_vector_info_ftype *print_vector_info);
315 /* MAP a GDB RAW register number onto a simulator register number. See
316 also include/...-sim.h. */
318 typedef int (gdbarch_register_sim_regno_ftype) (struct gdbarch *gdbarch, int reg_nr);
319 extern int gdbarch_register_sim_regno (struct gdbarch *gdbarch, int reg_nr);
320 extern void set_gdbarch_register_sim_regno (struct gdbarch *gdbarch, gdbarch_register_sim_regno_ftype *register_sim_regno);
322 typedef int (gdbarch_cannot_fetch_register_ftype) (struct gdbarch *gdbarch, int regnum);
323 extern int gdbarch_cannot_fetch_register (struct gdbarch *gdbarch, int regnum);
324 extern void set_gdbarch_cannot_fetch_register (struct gdbarch *gdbarch, gdbarch_cannot_fetch_register_ftype *cannot_fetch_register);
326 typedef int (gdbarch_cannot_store_register_ftype) (struct gdbarch *gdbarch, int regnum);
327 extern int gdbarch_cannot_store_register (struct gdbarch *gdbarch, int regnum);
328 extern void set_gdbarch_cannot_store_register (struct gdbarch *gdbarch, gdbarch_cannot_store_register_ftype *cannot_store_register);
330 /* setjmp/longjmp support. */
332 extern int gdbarch_get_longjmp_target_p (struct gdbarch *gdbarch);
334 typedef int (gdbarch_get_longjmp_target_ftype) (struct frame_info *frame, CORE_ADDR *pc);
335 extern int gdbarch_get_longjmp_target (struct gdbarch *gdbarch, struct frame_info *frame, CORE_ADDR *pc);
336 extern void set_gdbarch_get_longjmp_target (struct gdbarch *gdbarch, gdbarch_get_longjmp_target_ftype *get_longjmp_target);
338 extern int gdbarch_believe_pcc_promotion (struct gdbarch *gdbarch);
339 extern void set_gdbarch_believe_pcc_promotion (struct gdbarch *gdbarch, int believe_pcc_promotion);
341 typedef int (gdbarch_convert_register_p_ftype) (struct gdbarch *gdbarch, int regnum, struct type *type);
342 extern int gdbarch_convert_register_p (struct gdbarch *gdbarch, int regnum, struct type *type);
343 extern void set_gdbarch_convert_register_p (struct gdbarch *gdbarch, gdbarch_convert_register_p_ftype *convert_register_p);
345 typedef void (gdbarch_register_to_value_ftype) (struct frame_info *frame, int regnum, struct type *type, gdb_byte *buf);
346 extern void gdbarch_register_to_value (struct gdbarch *gdbarch, struct frame_info *frame, int regnum, struct type *type, gdb_byte *buf);
347 extern void set_gdbarch_register_to_value (struct gdbarch *gdbarch, gdbarch_register_to_value_ftype *register_to_value);
349 typedef void (gdbarch_value_to_register_ftype) (struct frame_info *frame, int regnum, struct type *type, const gdb_byte *buf);
350 extern void gdbarch_value_to_register (struct gdbarch *gdbarch, struct frame_info *frame, int regnum, struct type *type, const gdb_byte *buf);
351 extern void set_gdbarch_value_to_register (struct gdbarch *gdbarch, gdbarch_value_to_register_ftype *value_to_register);
353 /* Construct a value representing the contents of register REGNUM in
354 frame FRAME, interpreted as type TYPE. The routine needs to
355 allocate and return a struct value with all value attributes
356 (but not the value contents) filled in. */
358 typedef struct value * (gdbarch_value_from_register_ftype) (struct type *type, int regnum, struct frame_info *frame);
359 extern struct value * gdbarch_value_from_register (struct gdbarch *gdbarch, struct type *type, int regnum, struct frame_info *frame);
360 extern void set_gdbarch_value_from_register (struct gdbarch *gdbarch, gdbarch_value_from_register_ftype *value_from_register);
362 typedef CORE_ADDR (gdbarch_pointer_to_address_ftype) (struct type *type, const gdb_byte *buf);
363 extern CORE_ADDR gdbarch_pointer_to_address (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
364 extern void set_gdbarch_pointer_to_address (struct gdbarch *gdbarch, gdbarch_pointer_to_address_ftype *pointer_to_address);
366 typedef void (gdbarch_address_to_pointer_ftype) (struct type *type, gdb_byte *buf, CORE_ADDR addr);
367 extern void gdbarch_address_to_pointer (struct gdbarch *gdbarch, struct type *type, gdb_byte *buf, CORE_ADDR addr);
368 extern void set_gdbarch_address_to_pointer (struct gdbarch *gdbarch, gdbarch_address_to_pointer_ftype *address_to_pointer);
370 extern int gdbarch_integer_to_address_p (struct gdbarch *gdbarch);
372 typedef CORE_ADDR (gdbarch_integer_to_address_ftype) (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
373 extern CORE_ADDR gdbarch_integer_to_address (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
374 extern void set_gdbarch_integer_to_address (struct gdbarch *gdbarch, gdbarch_integer_to_address_ftype *integer_to_address);
376 /* Return the return-value convention that will be used by FUNCTYPE
377 to return a value of type VALTYPE. FUNCTYPE may be NULL in which
378 case the return convention is computed based only on VALTYPE.
380 If READBUF is not NULL, extract the return value and save it in this buffer.
382 If WRITEBUF is not NULL, it contains a return value which will be
383 stored into the appropriate register. This can be used when we want
384 to force the value returned by a function (see the "return" command
385 for instance). */
387 extern int gdbarch_return_value_p (struct gdbarch *gdbarch);
389 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);
390 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);
391 extern void set_gdbarch_return_value (struct gdbarch *gdbarch, gdbarch_return_value_ftype *return_value);
393 typedef CORE_ADDR (gdbarch_skip_prologue_ftype) (struct gdbarch *gdbarch, CORE_ADDR ip);
394 extern CORE_ADDR gdbarch_skip_prologue (struct gdbarch *gdbarch, CORE_ADDR ip);
395 extern void set_gdbarch_skip_prologue (struct gdbarch *gdbarch, gdbarch_skip_prologue_ftype *skip_prologue);
397 extern int gdbarch_skip_main_prologue_p (struct gdbarch *gdbarch);
399 typedef CORE_ADDR (gdbarch_skip_main_prologue_ftype) (struct gdbarch *gdbarch, CORE_ADDR ip);
400 extern CORE_ADDR gdbarch_skip_main_prologue (struct gdbarch *gdbarch, CORE_ADDR ip);
401 extern void set_gdbarch_skip_main_prologue (struct gdbarch *gdbarch, gdbarch_skip_main_prologue_ftype *skip_main_prologue);
403 typedef int (gdbarch_inner_than_ftype) (CORE_ADDR lhs, CORE_ADDR rhs);
404 extern int gdbarch_inner_than (struct gdbarch *gdbarch, CORE_ADDR lhs, CORE_ADDR rhs);
405 extern void set_gdbarch_inner_than (struct gdbarch *gdbarch, gdbarch_inner_than_ftype *inner_than);
407 typedef const gdb_byte * (gdbarch_breakpoint_from_pc_ftype) (struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *lenptr);
408 extern const gdb_byte * gdbarch_breakpoint_from_pc (struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *lenptr);
409 extern void set_gdbarch_breakpoint_from_pc (struct gdbarch *gdbarch, gdbarch_breakpoint_from_pc_ftype *breakpoint_from_pc);
411 extern int gdbarch_adjust_breakpoint_address_p (struct gdbarch *gdbarch);
413 typedef CORE_ADDR (gdbarch_adjust_breakpoint_address_ftype) (struct gdbarch *gdbarch, CORE_ADDR bpaddr);
414 extern CORE_ADDR gdbarch_adjust_breakpoint_address (struct gdbarch *gdbarch, CORE_ADDR bpaddr);
415 extern void set_gdbarch_adjust_breakpoint_address (struct gdbarch *gdbarch, gdbarch_adjust_breakpoint_address_ftype *adjust_breakpoint_address);
417 typedef int (gdbarch_memory_insert_breakpoint_ftype) (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
418 extern int gdbarch_memory_insert_breakpoint (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
419 extern void set_gdbarch_memory_insert_breakpoint (struct gdbarch *gdbarch, gdbarch_memory_insert_breakpoint_ftype *memory_insert_breakpoint);
421 typedef int (gdbarch_memory_remove_breakpoint_ftype) (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
422 extern int gdbarch_memory_remove_breakpoint (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
423 extern void set_gdbarch_memory_remove_breakpoint (struct gdbarch *gdbarch, gdbarch_memory_remove_breakpoint_ftype *memory_remove_breakpoint);
425 extern CORE_ADDR gdbarch_decr_pc_after_break (struct gdbarch *gdbarch);
426 extern void set_gdbarch_decr_pc_after_break (struct gdbarch *gdbarch, CORE_ADDR decr_pc_after_break);
428 /* A function can be addressed by either it's "pointer" (possibly a
429 descriptor address) or "entry point" (first executable instruction).
430 The method "convert_from_func_ptr_addr" converting the former to the
431 latter. gdbarch_deprecated_function_start_offset is being used to implement
432 a simplified subset of that functionality - the function's address
433 corresponds to the "function pointer" and the function's start
434 corresponds to the "function entry point" - and hence is redundant. */
436 extern CORE_ADDR gdbarch_deprecated_function_start_offset (struct gdbarch *gdbarch);
437 extern void set_gdbarch_deprecated_function_start_offset (struct gdbarch *gdbarch, CORE_ADDR deprecated_function_start_offset);
439 /* Return the remote protocol register number associated with this
440 register. Normally the identity mapping. */
442 typedef int (gdbarch_remote_register_number_ftype) (struct gdbarch *gdbarch, int regno);
443 extern int gdbarch_remote_register_number (struct gdbarch *gdbarch, int regno);
444 extern void set_gdbarch_remote_register_number (struct gdbarch *gdbarch, gdbarch_remote_register_number_ftype *remote_register_number);
446 /* Fetch the target specific address used to represent a load module. */
448 extern int gdbarch_fetch_tls_load_module_address_p (struct gdbarch *gdbarch);
450 typedef CORE_ADDR (gdbarch_fetch_tls_load_module_address_ftype) (struct objfile *objfile);
451 extern CORE_ADDR gdbarch_fetch_tls_load_module_address (struct gdbarch *gdbarch, struct objfile *objfile);
452 extern void set_gdbarch_fetch_tls_load_module_address (struct gdbarch *gdbarch, gdbarch_fetch_tls_load_module_address_ftype *fetch_tls_load_module_address);
454 extern CORE_ADDR gdbarch_frame_args_skip (struct gdbarch *gdbarch);
455 extern void set_gdbarch_frame_args_skip (struct gdbarch *gdbarch, CORE_ADDR frame_args_skip);
457 extern int gdbarch_unwind_pc_p (struct gdbarch *gdbarch);
459 typedef CORE_ADDR (gdbarch_unwind_pc_ftype) (struct gdbarch *gdbarch, struct frame_info *next_frame);
460 extern CORE_ADDR gdbarch_unwind_pc (struct gdbarch *gdbarch, struct frame_info *next_frame);
461 extern void set_gdbarch_unwind_pc (struct gdbarch *gdbarch, gdbarch_unwind_pc_ftype *unwind_pc);
463 extern int gdbarch_unwind_sp_p (struct gdbarch *gdbarch);
465 typedef CORE_ADDR (gdbarch_unwind_sp_ftype) (struct gdbarch *gdbarch, struct frame_info *next_frame);
466 extern CORE_ADDR gdbarch_unwind_sp (struct gdbarch *gdbarch, struct frame_info *next_frame);
467 extern void set_gdbarch_unwind_sp (struct gdbarch *gdbarch, gdbarch_unwind_sp_ftype *unwind_sp);
469 /* DEPRECATED_FRAME_LOCALS_ADDRESS as been replaced by the per-frame
470 frame-base. Enable frame-base before frame-unwind. */
472 extern int gdbarch_frame_num_args_p (struct gdbarch *gdbarch);
474 typedef int (gdbarch_frame_num_args_ftype) (struct frame_info *frame);
475 extern int gdbarch_frame_num_args (struct gdbarch *gdbarch, struct frame_info *frame);
476 extern void set_gdbarch_frame_num_args (struct gdbarch *gdbarch, gdbarch_frame_num_args_ftype *frame_num_args);
478 extern int gdbarch_frame_align_p (struct gdbarch *gdbarch);
480 typedef CORE_ADDR (gdbarch_frame_align_ftype) (struct gdbarch *gdbarch, CORE_ADDR address);
481 extern CORE_ADDR gdbarch_frame_align (struct gdbarch *gdbarch, CORE_ADDR address);
482 extern void set_gdbarch_frame_align (struct gdbarch *gdbarch, gdbarch_frame_align_ftype *frame_align);
484 typedef int (gdbarch_stabs_argument_has_addr_ftype) (struct gdbarch *gdbarch, struct type *type);
485 extern int gdbarch_stabs_argument_has_addr (struct gdbarch *gdbarch, struct type *type);
486 extern void set_gdbarch_stabs_argument_has_addr (struct gdbarch *gdbarch, gdbarch_stabs_argument_has_addr_ftype *stabs_argument_has_addr);
488 extern int gdbarch_frame_red_zone_size (struct gdbarch *gdbarch);
489 extern void set_gdbarch_frame_red_zone_size (struct gdbarch *gdbarch, int frame_red_zone_size);
491 typedef CORE_ADDR (gdbarch_convert_from_func_ptr_addr_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr, struct target_ops *targ);
492 extern CORE_ADDR gdbarch_convert_from_func_ptr_addr (struct gdbarch *gdbarch, CORE_ADDR addr, struct target_ops *targ);
493 extern void set_gdbarch_convert_from_func_ptr_addr (struct gdbarch *gdbarch, gdbarch_convert_from_func_ptr_addr_ftype *convert_from_func_ptr_addr);
495 /* On some machines there are bits in addresses which are not really
496 part of the address, but are used by the kernel, the hardware, etc.
497 for special purposes. gdbarch_addr_bits_remove takes out any such bits so
498 we get a "real" address such as one would find in a symbol table.
499 This is used only for addresses of instructions, and even then I'm
500 not sure it's used in all contexts. It exists to deal with there
501 being a few stray bits in the PC which would mislead us, not as some
502 sort of generic thing to handle alignment or segmentation (it's
503 possible it should be in TARGET_READ_PC instead). */
505 typedef CORE_ADDR (gdbarch_addr_bits_remove_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
506 extern CORE_ADDR gdbarch_addr_bits_remove (struct gdbarch *gdbarch, CORE_ADDR addr);
507 extern void set_gdbarch_addr_bits_remove (struct gdbarch *gdbarch, gdbarch_addr_bits_remove_ftype *addr_bits_remove);
509 /* It is not at all clear why gdbarch_smash_text_address is not folded into
510 gdbarch_addr_bits_remove. */
512 typedef CORE_ADDR (gdbarch_smash_text_address_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
513 extern CORE_ADDR gdbarch_smash_text_address (struct gdbarch *gdbarch, CORE_ADDR addr);
514 extern void set_gdbarch_smash_text_address (struct gdbarch *gdbarch, gdbarch_smash_text_address_ftype *smash_text_address);
516 /* FIXME/cagney/2001-01-18: This should be split in two. A target method that
517 indicates if the target needs software single step. An ISA method to
518 implement it.
520 FIXME/cagney/2001-01-18: This should be replaced with something that inserts
521 breakpoints using the breakpoint system instead of blatting memory directly
522 (as with rs6000).
524 FIXME/cagney/2001-01-18: The logic is backwards. It should be asking if the
525 target can single step. If not, then implement single step using breakpoints.
527 A return value of 1 means that the software_single_step breakpoints
528 were inserted; 0 means they were not. */
530 extern int gdbarch_software_single_step_p (struct gdbarch *gdbarch);
532 typedef int (gdbarch_software_single_step_ftype) (struct frame_info *frame);
533 extern int gdbarch_software_single_step (struct gdbarch *gdbarch, struct frame_info *frame);
534 extern void set_gdbarch_software_single_step (struct gdbarch *gdbarch, gdbarch_software_single_step_ftype *software_single_step);
536 /* Return non-zero if the processor is executing a delay slot and a
537 further single-step is needed before the instruction finishes. */
539 extern int gdbarch_single_step_through_delay_p (struct gdbarch *gdbarch);
541 typedef int (gdbarch_single_step_through_delay_ftype) (struct gdbarch *gdbarch, struct frame_info *frame);
542 extern int gdbarch_single_step_through_delay (struct gdbarch *gdbarch, struct frame_info *frame);
543 extern void set_gdbarch_single_step_through_delay (struct gdbarch *gdbarch, gdbarch_single_step_through_delay_ftype *single_step_through_delay);
545 /* FIXME: cagney/2003-08-28: Need to find a better way of selecting the
546 disassembler. Perhaps objdump can handle it? */
548 typedef int (gdbarch_print_insn_ftype) (bfd_vma vma, struct disassemble_info *info);
549 extern int gdbarch_print_insn (struct gdbarch *gdbarch, bfd_vma vma, struct disassemble_info *info);
550 extern void set_gdbarch_print_insn (struct gdbarch *gdbarch, gdbarch_print_insn_ftype *print_insn);
552 typedef CORE_ADDR (gdbarch_skip_trampoline_code_ftype) (struct frame_info *frame, CORE_ADDR pc);
553 extern CORE_ADDR gdbarch_skip_trampoline_code (struct gdbarch *gdbarch, struct frame_info *frame, CORE_ADDR pc);
554 extern void set_gdbarch_skip_trampoline_code (struct gdbarch *gdbarch, gdbarch_skip_trampoline_code_ftype *skip_trampoline_code);
556 /* If in_solib_dynsym_resolve_code() returns true, and SKIP_SOLIB_RESOLVER
557 evaluates non-zero, this is the address where the debugger will place
558 a step-resume breakpoint to get us past the dynamic linker. */
560 typedef CORE_ADDR (gdbarch_skip_solib_resolver_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc);
561 extern CORE_ADDR gdbarch_skip_solib_resolver (struct gdbarch *gdbarch, CORE_ADDR pc);
562 extern void set_gdbarch_skip_solib_resolver (struct gdbarch *gdbarch, gdbarch_skip_solib_resolver_ftype *skip_solib_resolver);
564 /* Some systems also have trampoline code for returning from shared libs. */
566 typedef int (gdbarch_in_solib_return_trampoline_ftype) (CORE_ADDR pc, char *name);
567 extern int gdbarch_in_solib_return_trampoline (struct gdbarch *gdbarch, CORE_ADDR pc, char *name);
568 extern void set_gdbarch_in_solib_return_trampoline (struct gdbarch *gdbarch, gdbarch_in_solib_return_trampoline_ftype *in_solib_return_trampoline);
570 /* A target might have problems with watchpoints as soon as the stack
571 frame of the current function has been destroyed. This mostly happens
572 as the first action in a funtion's epilogue. in_function_epilogue_p()
573 is defined to return a non-zero value if either the given addr is one
574 instruction after the stack destroying instruction up to the trailing
575 return instruction or if we can figure out that the stack frame has
576 already been invalidated regardless of the value of addr. Targets
577 which don't suffer from that problem could just let this functionality
578 untouched. */
580 typedef int (gdbarch_in_function_epilogue_p_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
581 extern int gdbarch_in_function_epilogue_p (struct gdbarch *gdbarch, CORE_ADDR addr);
582 extern void set_gdbarch_in_function_epilogue_p (struct gdbarch *gdbarch, gdbarch_in_function_epilogue_p_ftype *in_function_epilogue_p);
584 /* Given a vector of command-line arguments, return a newly allocated
585 string which, when passed to the create_inferior function, will be
586 parsed (on Unix systems, by the shell) to yield the same vector.
587 This function should call error() if the argument vector is not
588 representable for this target or if this target does not support
589 command-line arguments.
590 ARGC is the number of elements in the vector.
591 ARGV is an array of strings, one per argument. */
593 typedef char * (gdbarch_construct_inferior_arguments_ftype) (struct gdbarch *gdbarch, int argc, char **argv);
594 extern char * gdbarch_construct_inferior_arguments (struct gdbarch *gdbarch, int argc, char **argv);
595 extern void set_gdbarch_construct_inferior_arguments (struct gdbarch *gdbarch, gdbarch_construct_inferior_arguments_ftype *construct_inferior_arguments);
597 typedef void (gdbarch_elf_make_msymbol_special_ftype) (asymbol *sym, struct minimal_symbol *msym);
598 extern void gdbarch_elf_make_msymbol_special (struct gdbarch *gdbarch, asymbol *sym, struct minimal_symbol *msym);
599 extern void set_gdbarch_elf_make_msymbol_special (struct gdbarch *gdbarch, gdbarch_elf_make_msymbol_special_ftype *elf_make_msymbol_special);
601 typedef void (gdbarch_coff_make_msymbol_special_ftype) (int val, struct minimal_symbol *msym);
602 extern void gdbarch_coff_make_msymbol_special (struct gdbarch *gdbarch, int val, struct minimal_symbol *msym);
603 extern void set_gdbarch_coff_make_msymbol_special (struct gdbarch *gdbarch, gdbarch_coff_make_msymbol_special_ftype *coff_make_msymbol_special);
605 extern int gdbarch_cannot_step_breakpoint (struct gdbarch *gdbarch);
606 extern void set_gdbarch_cannot_step_breakpoint (struct gdbarch *gdbarch, int cannot_step_breakpoint);
608 extern int gdbarch_have_nonsteppable_watchpoint (struct gdbarch *gdbarch);
609 extern void set_gdbarch_have_nonsteppable_watchpoint (struct gdbarch *gdbarch, int have_nonsteppable_watchpoint);
611 extern int gdbarch_address_class_type_flags_p (struct gdbarch *gdbarch);
613 typedef int (gdbarch_address_class_type_flags_ftype) (int byte_size, int dwarf2_addr_class);
614 extern int gdbarch_address_class_type_flags (struct gdbarch *gdbarch, int byte_size, int dwarf2_addr_class);
615 extern void set_gdbarch_address_class_type_flags (struct gdbarch *gdbarch, gdbarch_address_class_type_flags_ftype *address_class_type_flags);
617 extern int gdbarch_address_class_type_flags_to_name_p (struct gdbarch *gdbarch);
619 typedef const char * (gdbarch_address_class_type_flags_to_name_ftype) (struct gdbarch *gdbarch, int type_flags);
620 extern const char * gdbarch_address_class_type_flags_to_name (struct gdbarch *gdbarch, int type_flags);
621 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);
623 extern int gdbarch_address_class_name_to_type_flags_p (struct gdbarch *gdbarch);
625 typedef int (gdbarch_address_class_name_to_type_flags_ftype) (struct gdbarch *gdbarch, const char *name, int *type_flags_ptr);
626 extern int gdbarch_address_class_name_to_type_flags (struct gdbarch *gdbarch, const char *name, int *type_flags_ptr);
627 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);
629 /* Is a register in a group */
631 typedef int (gdbarch_register_reggroup_p_ftype) (struct gdbarch *gdbarch, int regnum, struct reggroup *reggroup);
632 extern int gdbarch_register_reggroup_p (struct gdbarch *gdbarch, int regnum, struct reggroup *reggroup);
633 extern void set_gdbarch_register_reggroup_p (struct gdbarch *gdbarch, gdbarch_register_reggroup_p_ftype *register_reggroup_p);
635 /* Fetch the pointer to the ith function argument. */
637 extern int gdbarch_fetch_pointer_argument_p (struct gdbarch *gdbarch);
639 typedef CORE_ADDR (gdbarch_fetch_pointer_argument_ftype) (struct frame_info *frame, int argi, struct type *type);
640 extern CORE_ADDR gdbarch_fetch_pointer_argument (struct gdbarch *gdbarch, struct frame_info *frame, int argi, struct type *type);
641 extern void set_gdbarch_fetch_pointer_argument (struct gdbarch *gdbarch, gdbarch_fetch_pointer_argument_ftype *fetch_pointer_argument);
643 /* Return the appropriate register set for a core file section with
644 name SECT_NAME and size SECT_SIZE. */
646 extern int gdbarch_regset_from_core_section_p (struct gdbarch *gdbarch);
648 typedef const struct regset * (gdbarch_regset_from_core_section_ftype) (struct gdbarch *gdbarch, const char *sect_name, size_t sect_size);
649 extern const struct regset * gdbarch_regset_from_core_section (struct gdbarch *gdbarch, const char *sect_name, size_t sect_size);
650 extern void set_gdbarch_regset_from_core_section (struct gdbarch *gdbarch, gdbarch_regset_from_core_section_ftype *regset_from_core_section);
652 /* When creating core dumps, some systems encode the PID in addition
653 to the LWP id in core file register section names. In those cases, the
654 "XXX" in ".reg/XXX" is encoded as [LWPID << 16 | PID]. This setting
655 is set to true for such architectures; false if "XXX" represents an LWP
656 or thread id with no special encoding. */
658 extern int gdbarch_core_reg_section_encodes_pid (struct gdbarch *gdbarch);
659 extern void set_gdbarch_core_reg_section_encodes_pid (struct gdbarch *gdbarch, int core_reg_section_encodes_pid);
661 /* Supported register notes in a core file. */
663 extern struct core_regset_section * gdbarch_core_regset_sections (struct gdbarch *gdbarch);
664 extern void set_gdbarch_core_regset_sections (struct gdbarch *gdbarch, struct core_regset_section * core_regset_sections);
666 /* Read offset OFFSET of TARGET_OBJECT_LIBRARIES formatted shared libraries list from
667 core file into buffer READBUF with length LEN. */
669 extern int gdbarch_core_xfer_shared_libraries_p (struct gdbarch *gdbarch);
671 typedef LONGEST (gdbarch_core_xfer_shared_libraries_ftype) (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, LONGEST len);
672 extern LONGEST gdbarch_core_xfer_shared_libraries (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, LONGEST len);
673 extern void set_gdbarch_core_xfer_shared_libraries (struct gdbarch *gdbarch, gdbarch_core_xfer_shared_libraries_ftype *core_xfer_shared_libraries);
675 /* How the core_stratum layer converts a PTID from a core file to a
676 string. */
678 extern int gdbarch_core_pid_to_str_p (struct gdbarch *gdbarch);
680 typedef char * (gdbarch_core_pid_to_str_ftype) (struct gdbarch *gdbarch, ptid_t ptid);
681 extern char * gdbarch_core_pid_to_str (struct gdbarch *gdbarch, ptid_t ptid);
682 extern void set_gdbarch_core_pid_to_str (struct gdbarch *gdbarch, gdbarch_core_pid_to_str_ftype *core_pid_to_str);
684 /* If the elements of C++ vtables are in-place function descriptors rather
685 than normal function pointers (which may point to code or a descriptor),
686 set this to one. */
688 extern int gdbarch_vtable_function_descriptors (struct gdbarch *gdbarch);
689 extern void set_gdbarch_vtable_function_descriptors (struct gdbarch *gdbarch, int vtable_function_descriptors);
691 /* Set if the least significant bit of the delta is used instead of the least
692 significant bit of the pfn for pointers to virtual member functions. */
694 extern int gdbarch_vbit_in_delta (struct gdbarch *gdbarch);
695 extern void set_gdbarch_vbit_in_delta (struct gdbarch *gdbarch, int vbit_in_delta);
697 /* Advance PC to next instruction in order to skip a permanent breakpoint. */
699 extern int gdbarch_skip_permanent_breakpoint_p (struct gdbarch *gdbarch);
701 typedef void (gdbarch_skip_permanent_breakpoint_ftype) (struct regcache *regcache);
702 extern void gdbarch_skip_permanent_breakpoint (struct gdbarch *gdbarch, struct regcache *regcache);
703 extern void set_gdbarch_skip_permanent_breakpoint (struct gdbarch *gdbarch, gdbarch_skip_permanent_breakpoint_ftype *skip_permanent_breakpoint);
705 /* The maximum length of an instruction on this architecture. */
707 extern int gdbarch_max_insn_length_p (struct gdbarch *gdbarch);
709 extern ULONGEST gdbarch_max_insn_length (struct gdbarch *gdbarch);
710 extern void set_gdbarch_max_insn_length (struct gdbarch *gdbarch, ULONGEST max_insn_length);
712 /* Copy the instruction at FROM to TO, and make any adjustments
713 necessary to single-step it at that address.
715 REGS holds the state the thread's registers will have before
716 executing the copied instruction; the PC in REGS will refer to FROM,
717 not the copy at TO. The caller should update it to point at TO later.
719 Return a pointer to data of the architecture's choice to be passed
720 to gdbarch_displaced_step_fixup. Or, return NULL to indicate that
721 the instruction's effects have been completely simulated, with the
722 resulting state written back to REGS.
724 For a general explanation of displaced stepping and how GDB uses it,
725 see the comments in infrun.c.
727 The TO area is only guaranteed to have space for
728 gdbarch_max_insn_length (arch) bytes, so this function must not
729 write more bytes than that to that area.
731 If you do not provide this function, GDB assumes that the
732 architecture does not support displaced stepping.
734 If your architecture doesn't need to adjust instructions before
735 single-stepping them, consider using simple_displaced_step_copy_insn
736 here. */
738 extern int gdbarch_displaced_step_copy_insn_p (struct gdbarch *gdbarch);
740 typedef struct displaced_step_closure * (gdbarch_displaced_step_copy_insn_ftype) (struct gdbarch *gdbarch, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
741 extern struct displaced_step_closure * gdbarch_displaced_step_copy_insn (struct gdbarch *gdbarch, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
742 extern void set_gdbarch_displaced_step_copy_insn (struct gdbarch *gdbarch, gdbarch_displaced_step_copy_insn_ftype *displaced_step_copy_insn);
744 /* Fix up the state resulting from successfully single-stepping a
745 displaced instruction, to give the result we would have gotten from
746 stepping the instruction in its original location.
748 REGS is the register state resulting from single-stepping the
749 displaced instruction.
751 CLOSURE is the result from the matching call to
752 gdbarch_displaced_step_copy_insn.
754 If you provide gdbarch_displaced_step_copy_insn.but not this
755 function, then GDB assumes that no fixup is needed after
756 single-stepping the instruction.
758 For a general explanation of displaced stepping and how GDB uses it,
759 see the comments in infrun.c. */
761 extern int gdbarch_displaced_step_fixup_p (struct gdbarch *gdbarch);
763 typedef void (gdbarch_displaced_step_fixup_ftype) (struct gdbarch *gdbarch, struct displaced_step_closure *closure, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
764 extern void gdbarch_displaced_step_fixup (struct gdbarch *gdbarch, struct displaced_step_closure *closure, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
765 extern void set_gdbarch_displaced_step_fixup (struct gdbarch *gdbarch, gdbarch_displaced_step_fixup_ftype *displaced_step_fixup);
767 /* Free a closure returned by gdbarch_displaced_step_copy_insn.
769 If you provide gdbarch_displaced_step_copy_insn, you must provide
770 this function as well.
772 If your architecture uses closures that don't need to be freed, then
773 you can use simple_displaced_step_free_closure here.
775 For a general explanation of displaced stepping and how GDB uses it,
776 see the comments in infrun.c. */
778 typedef void (gdbarch_displaced_step_free_closure_ftype) (struct gdbarch *gdbarch, struct displaced_step_closure *closure);
779 extern void gdbarch_displaced_step_free_closure (struct gdbarch *gdbarch, struct displaced_step_closure *closure);
780 extern void set_gdbarch_displaced_step_free_closure (struct gdbarch *gdbarch, gdbarch_displaced_step_free_closure_ftype *displaced_step_free_closure);
782 /* Return the address of an appropriate place to put displaced
783 instructions while we step over them. There need only be one such
784 place, since we're only stepping one thread over a breakpoint at a
785 time.
787 For a general explanation of displaced stepping and how GDB uses it,
788 see the comments in infrun.c. */
790 typedef CORE_ADDR (gdbarch_displaced_step_location_ftype) (struct gdbarch *gdbarch);
791 extern CORE_ADDR gdbarch_displaced_step_location (struct gdbarch *gdbarch);
792 extern void set_gdbarch_displaced_step_location (struct gdbarch *gdbarch, gdbarch_displaced_step_location_ftype *displaced_step_location);
794 /* Refresh overlay mapped state for section OSECT. */
796 extern int gdbarch_overlay_update_p (struct gdbarch *gdbarch);
798 typedef void (gdbarch_overlay_update_ftype) (struct obj_section *osect);
799 extern void gdbarch_overlay_update (struct gdbarch *gdbarch, struct obj_section *osect);
800 extern void set_gdbarch_overlay_update (struct gdbarch *gdbarch, gdbarch_overlay_update_ftype *overlay_update);
802 extern int gdbarch_core_read_description_p (struct gdbarch *gdbarch);
804 typedef const struct target_desc * (gdbarch_core_read_description_ftype) (struct gdbarch *gdbarch, struct target_ops *target, bfd *abfd);
805 extern const struct target_desc * gdbarch_core_read_description (struct gdbarch *gdbarch, struct target_ops *target, bfd *abfd);
806 extern void set_gdbarch_core_read_description (struct gdbarch *gdbarch, gdbarch_core_read_description_ftype *core_read_description);
808 /* Handle special encoding of static variables in stabs debug info. */
810 extern int gdbarch_static_transform_name_p (struct gdbarch *gdbarch);
812 typedef char * (gdbarch_static_transform_name_ftype) (char *name);
813 extern char * gdbarch_static_transform_name (struct gdbarch *gdbarch, char *name);
814 extern void set_gdbarch_static_transform_name (struct gdbarch *gdbarch, gdbarch_static_transform_name_ftype *static_transform_name);
816 /* Set if the address in N_SO or N_FUN stabs may be zero. */
818 extern int gdbarch_sofun_address_maybe_missing (struct gdbarch *gdbarch);
819 extern void set_gdbarch_sofun_address_maybe_missing (struct gdbarch *gdbarch, int sofun_address_maybe_missing);
821 /* Parse the instruction at ADDR storing in the record execution log
822 the registers REGCACHE and memory ranges that will be affected when
823 the instruction executes, along with their current values.
824 Return -1 if something goes wrong, 0 otherwise. */
826 extern int gdbarch_process_record_p (struct gdbarch *gdbarch);
828 typedef int (gdbarch_process_record_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr);
829 extern int gdbarch_process_record (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr);
830 extern void set_gdbarch_process_record (struct gdbarch *gdbarch, gdbarch_process_record_ftype *process_record);
832 /* Signal translation: translate inferior's signal (host's) number into
833 GDB's representation. */
835 typedef enum target_signal (gdbarch_target_signal_from_host_ftype) (struct gdbarch *gdbarch, int signo);
836 extern enum target_signal gdbarch_target_signal_from_host (struct gdbarch *gdbarch, int signo);
837 extern void set_gdbarch_target_signal_from_host (struct gdbarch *gdbarch, gdbarch_target_signal_from_host_ftype *target_signal_from_host);
839 /* Signal translation: translate GDB's signal number into inferior's host
840 signal number. */
842 typedef int (gdbarch_target_signal_to_host_ftype) (struct gdbarch *gdbarch, enum target_signal ts);
843 extern int gdbarch_target_signal_to_host (struct gdbarch *gdbarch, enum target_signal ts);
844 extern void set_gdbarch_target_signal_to_host (struct gdbarch *gdbarch, gdbarch_target_signal_to_host_ftype *target_signal_to_host);
846 /* Extra signal info inspection.
848 Return a type suitable to inspect extra signal information. */
850 extern int gdbarch_get_siginfo_type_p (struct gdbarch *gdbarch);
852 typedef struct type * (gdbarch_get_siginfo_type_ftype) (struct gdbarch *gdbarch);
853 extern struct type * gdbarch_get_siginfo_type (struct gdbarch *gdbarch);
854 extern void set_gdbarch_get_siginfo_type (struct gdbarch *gdbarch, gdbarch_get_siginfo_type_ftype *get_siginfo_type);
856 /* Record architecture-specific information from the symbol table. */
858 extern int gdbarch_record_special_symbol_p (struct gdbarch *gdbarch);
860 typedef void (gdbarch_record_special_symbol_ftype) (struct gdbarch *gdbarch, struct objfile *objfile, asymbol *sym);
861 extern void gdbarch_record_special_symbol (struct gdbarch *gdbarch, struct objfile *objfile, asymbol *sym);
862 extern void set_gdbarch_record_special_symbol (struct gdbarch *gdbarch, gdbarch_record_special_symbol_ftype *record_special_symbol);
864 /* True if the list of shared libraries is one and only for all
865 processes, as opposed to a list of shared libraries per inferior.
866 When this property is true, GDB assumes that since shared libraries
867 are shared across processes, so is all code. Hence, GDB further
868 assumes an inserted breakpoint location is visible to all processes. */
870 extern int gdbarch_has_global_solist (struct gdbarch *gdbarch);
871 extern void set_gdbarch_has_global_solist (struct gdbarch *gdbarch, int has_global_solist);
873 extern struct gdbarch_tdep *gdbarch_tdep (struct gdbarch *gdbarch);
876 /* Mechanism for co-ordinating the selection of a specific
877 architecture.
879 GDB targets (*-tdep.c) can register an interest in a specific
880 architecture. Other GDB components can register a need to maintain
881 per-architecture data.
883 The mechanisms below ensures that there is only a loose connection
884 between the set-architecture command and the various GDB
885 components. Each component can independently register their need
886 to maintain architecture specific data with gdbarch.
888 Pragmatics:
890 Previously, a single TARGET_ARCHITECTURE_HOOK was provided. It
891 didn't scale.
893 The more traditional mega-struct containing architecture specific
894 data for all the various GDB components was also considered. Since
895 GDB is built from a variable number of (fairly independent)
896 components it was determined that the global aproach was not
897 applicable. */
900 /* Register a new architectural family with GDB.
902 Register support for the specified ARCHITECTURE with GDB. When
903 gdbarch determines that the specified architecture has been
904 selected, the corresponding INIT function is called.
908 The INIT function takes two parameters: INFO which contains the
909 information available to gdbarch about the (possibly new)
910 architecture; ARCHES which is a list of the previously created
911 ``struct gdbarch'' for this architecture.
913 The INFO parameter is, as far as possible, be pre-initialized with
914 information obtained from INFO.ABFD or the global defaults.
916 The ARCHES parameter is a linked list (sorted most recently used)
917 of all the previously created architures for this architecture
918 family. The (possibly NULL) ARCHES->gdbarch can used to access
919 values from the previously selected architecture for this
920 architecture family. The global ``current_gdbarch'' shall not be
921 used.
923 The INIT function shall return any of: NULL - indicating that it
924 doesn't recognize the selected architecture; an existing ``struct
925 gdbarch'' from the ARCHES list - indicating that the new
926 architecture is just a synonym for an earlier architecture (see
927 gdbarch_list_lookup_by_info()); a newly created ``struct gdbarch''
928 - that describes the selected architecture (see gdbarch_alloc()).
930 The DUMP_TDEP function shall print out all target specific values.
931 Care should be taken to ensure that the function works in both the
932 multi-arch and non- multi-arch cases. */
934 struct gdbarch_list
936 struct gdbarch *gdbarch;
937 struct gdbarch_list *next;
940 struct gdbarch_info
942 /* Use default: NULL (ZERO). */
943 const struct bfd_arch_info *bfd_arch_info;
945 /* Use default: BFD_ENDIAN_UNKNOWN (NB: is not ZERO). */
946 int byte_order;
948 int byte_order_for_code;
950 /* Use default: NULL (ZERO). */
951 bfd *abfd;
953 /* Use default: NULL (ZERO). */
954 struct gdbarch_tdep_info *tdep_info;
956 /* Use default: GDB_OSABI_UNINITIALIZED (-1). */
957 enum gdb_osabi osabi;
959 /* Use default: NULL (ZERO). */
960 const struct target_desc *target_desc;
963 typedef struct gdbarch *(gdbarch_init_ftype) (struct gdbarch_info info, struct gdbarch_list *arches);
964 typedef void (gdbarch_dump_tdep_ftype) (struct gdbarch *gdbarch, struct ui_file *file);
966 /* DEPRECATED - use gdbarch_register() */
967 extern void register_gdbarch_init (enum bfd_architecture architecture, gdbarch_init_ftype *);
969 extern void gdbarch_register (enum bfd_architecture architecture,
970 gdbarch_init_ftype *,
971 gdbarch_dump_tdep_ftype *);
974 /* Return a freshly allocated, NULL terminated, array of the valid
975 architecture names. Since architectures are registered during the
976 _initialize phase this function only returns useful information
977 once initialization has been completed. */
979 extern const char **gdbarch_printable_names (void);
982 /* Helper function. Search the list of ARCHES for a GDBARCH that
983 matches the information provided by INFO. */
985 extern struct gdbarch_list *gdbarch_list_lookup_by_info (struct gdbarch_list *arches, const struct gdbarch_info *info);
988 /* Helper function. Create a preliminary ``struct gdbarch''. Perform
989 basic initialization using values obtained from the INFO and TDEP
990 parameters. set_gdbarch_*() functions are called to complete the
991 initialization of the object. */
993 extern struct gdbarch *gdbarch_alloc (const struct gdbarch_info *info, struct gdbarch_tdep *tdep);
996 /* Helper function. Free a partially-constructed ``struct gdbarch''.
997 It is assumed that the caller freeds the ``struct
998 gdbarch_tdep''. */
1000 extern void gdbarch_free (struct gdbarch *);
1003 /* Helper function. Allocate memory from the ``struct gdbarch''
1004 obstack. The memory is freed when the corresponding architecture
1005 is also freed. */
1007 extern void *gdbarch_obstack_zalloc (struct gdbarch *gdbarch, long size);
1008 #define GDBARCH_OBSTACK_CALLOC(GDBARCH, NR, TYPE) ((TYPE *) gdbarch_obstack_zalloc ((GDBARCH), (NR) * sizeof (TYPE)))
1009 #define GDBARCH_OBSTACK_ZALLOC(GDBARCH, TYPE) ((TYPE *) gdbarch_obstack_zalloc ((GDBARCH), sizeof (TYPE)))
1012 /* Helper function. Force an update of the current architecture.
1014 The actual architecture selected is determined by INFO, ``(gdb) set
1015 architecture'' et.al., the existing architecture and BFD's default
1016 architecture. INFO should be initialized to zero and then selected
1017 fields should be updated.
1019 Returns non-zero if the update succeeds */
1021 extern int gdbarch_update_p (struct gdbarch_info info);
1024 /* Helper function. Find an architecture matching info.
1026 INFO should be initialized using gdbarch_info_init, relevant fields
1027 set, and then finished using gdbarch_info_fill.
1029 Returns the corresponding architecture, or NULL if no matching
1030 architecture was found. "current_gdbarch" is not updated. */
1032 extern struct gdbarch *gdbarch_find_by_info (struct gdbarch_info info);
1035 /* Helper function. Set the global "current_gdbarch" to "gdbarch".
1037 FIXME: kettenis/20031124: Of the functions that follow, only
1038 gdbarch_from_bfd is supposed to survive. The others will
1039 dissappear since in the future GDB will (hopefully) be truly
1040 multi-arch. However, for now we're still stuck with the concept of
1041 a single active architecture. */
1043 extern void deprecated_current_gdbarch_select_hack (struct gdbarch *gdbarch);
1046 /* Register per-architecture data-pointer.
1048 Reserve space for a per-architecture data-pointer. An identifier
1049 for the reserved data-pointer is returned. That identifer should
1050 be saved in a local static variable.
1052 Memory for the per-architecture data shall be allocated using
1053 gdbarch_obstack_zalloc. That memory will be deleted when the
1054 corresponding architecture object is deleted.
1056 When a previously created architecture is re-selected, the
1057 per-architecture data-pointer for that previous architecture is
1058 restored. INIT() is not re-called.
1060 Multiple registrarants for any architecture are allowed (and
1061 strongly encouraged). */
1063 struct gdbarch_data;
1065 typedef void *(gdbarch_data_pre_init_ftype) (struct obstack *obstack);
1066 extern struct gdbarch_data *gdbarch_data_register_pre_init (gdbarch_data_pre_init_ftype *init);
1067 typedef void *(gdbarch_data_post_init_ftype) (struct gdbarch *gdbarch);
1068 extern struct gdbarch_data *gdbarch_data_register_post_init (gdbarch_data_post_init_ftype *init);
1069 extern void deprecated_set_gdbarch_data (struct gdbarch *gdbarch,
1070 struct gdbarch_data *data,
1071 void *pointer);
1073 extern void *gdbarch_data (struct gdbarch *gdbarch, struct gdbarch_data *);
1076 /* Set the dynamic target-system-dependent parameters (architecture,
1077 byte-order, ...) using information found in the BFD */
1079 extern void set_gdbarch_from_file (bfd *);
1082 /* Initialize the current architecture to the "first" one we find on
1083 our list. */
1085 extern void initialize_current_architecture (void);
1087 /* gdbarch trace variable */
1088 extern int gdbarch_debug;
1090 extern void gdbarch_dump (struct gdbarch *gdbarch, struct ui_file *file);
1092 #endif