* ax-gdb.c (gen_exp_binop_rest) [BINOP_SUBSCRIPT]: Error out if
[binutils-gdb.git] / gdb / gdbarch.h
blob1353ab1b6d5b668aae06aada7bc05e1edb937727
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,
6 2007, 2008, 2009 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;
55 struct syscall;
57 /* The architecture associated with the connection to the target.
59 The architecture vector provides some information that is really
60 a property of the target: The layout of certain packets, for instance;
61 or the solib_ops vector. Etc. To differentiate architecture accesses
62 to per-target properties from per-thread/per-frame/per-objfile properties,
63 accesses to per-target properties should be made through target_gdbarch.
65 Eventually, when support for multiple targets is implemented in
66 GDB, this global should be made target-specific. */
67 extern struct gdbarch *target_gdbarch;
70 /* The following are pre-initialized by GDBARCH. */
72 extern const struct bfd_arch_info * gdbarch_bfd_arch_info (struct gdbarch *gdbarch);
73 /* set_gdbarch_bfd_arch_info() - not applicable - pre-initialized. */
75 extern int gdbarch_byte_order (struct gdbarch *gdbarch);
76 /* set_gdbarch_byte_order() - not applicable - pre-initialized. */
78 extern int gdbarch_byte_order_for_code (struct gdbarch *gdbarch);
79 /* set_gdbarch_byte_order_for_code() - not applicable - pre-initialized. */
81 extern enum gdb_osabi gdbarch_osabi (struct gdbarch *gdbarch);
82 /* set_gdbarch_osabi() - not applicable - pre-initialized. */
84 extern const struct target_desc * gdbarch_target_desc (struct gdbarch *gdbarch);
85 /* set_gdbarch_target_desc() - not applicable - pre-initialized. */
88 /* The following are initialized by the target dependent code. */
90 /* The bit byte-order has to do just with numbering of bits in debugging symbols
91 and such. Conceptually, it's quite separate from byte/word byte order. */
93 extern int gdbarch_bits_big_endian (struct gdbarch *gdbarch);
94 extern void set_gdbarch_bits_big_endian (struct gdbarch *gdbarch, int bits_big_endian);
96 /* Number of bits in a char or unsigned char for the target machine.
97 Just like CHAR_BIT in <limits.h> but describes the target machine.
98 v:TARGET_CHAR_BIT:int:char_bit::::8 * sizeof (char):8::0:
100 Number of bits in a short or unsigned short for the target machine. */
102 extern int gdbarch_short_bit (struct gdbarch *gdbarch);
103 extern void set_gdbarch_short_bit (struct gdbarch *gdbarch, int short_bit);
105 /* Number of bits in an int or unsigned int for the target machine. */
107 extern int gdbarch_int_bit (struct gdbarch *gdbarch);
108 extern void set_gdbarch_int_bit (struct gdbarch *gdbarch, int int_bit);
110 /* Number of bits in a long or unsigned long for the target machine. */
112 extern int gdbarch_long_bit (struct gdbarch *gdbarch);
113 extern void set_gdbarch_long_bit (struct gdbarch *gdbarch, int long_bit);
115 /* Number of bits in a long long or unsigned long long for the target
116 machine. */
118 extern int gdbarch_long_long_bit (struct gdbarch *gdbarch);
119 extern void set_gdbarch_long_long_bit (struct gdbarch *gdbarch, int long_long_bit);
121 /* The ABI default bit-size and format for "float", "double", and "long
122 double". These bit/format pairs should eventually be combined into
123 a single object. For the moment, just initialize them as a pair.
124 Each format describes both the big and little endian layouts (if
125 useful). */
127 extern int gdbarch_float_bit (struct gdbarch *gdbarch);
128 extern void set_gdbarch_float_bit (struct gdbarch *gdbarch, int float_bit);
130 extern const struct floatformat ** gdbarch_float_format (struct gdbarch *gdbarch);
131 extern void set_gdbarch_float_format (struct gdbarch *gdbarch, const struct floatformat ** float_format);
133 extern int gdbarch_double_bit (struct gdbarch *gdbarch);
134 extern void set_gdbarch_double_bit (struct gdbarch *gdbarch, int double_bit);
136 extern const struct floatformat ** gdbarch_double_format (struct gdbarch *gdbarch);
137 extern void set_gdbarch_double_format (struct gdbarch *gdbarch, const struct floatformat ** double_format);
139 extern int gdbarch_long_double_bit (struct gdbarch *gdbarch);
140 extern void set_gdbarch_long_double_bit (struct gdbarch *gdbarch, int long_double_bit);
142 extern const struct floatformat ** gdbarch_long_double_format (struct gdbarch *gdbarch);
143 extern void set_gdbarch_long_double_format (struct gdbarch *gdbarch, const struct floatformat ** long_double_format);
145 /* For most targets, a pointer on the target and its representation as an
146 address in GDB have the same size and "look the same". For such a
147 target, you need only set gdbarch_ptr_bit and gdbarch_addr_bit
148 / addr_bit will be set from it.
150 If gdbarch_ptr_bit and gdbarch_addr_bit are different, you'll probably
151 also need to set gdbarch_pointer_to_address and gdbarch_address_to_pointer
152 as well.
154 ptr_bit is the size of a pointer on the target */
156 extern int gdbarch_ptr_bit (struct gdbarch *gdbarch);
157 extern void set_gdbarch_ptr_bit (struct gdbarch *gdbarch, int ptr_bit);
159 /* addr_bit is the size of a target address as represented in gdb */
161 extern int gdbarch_addr_bit (struct gdbarch *gdbarch);
162 extern void set_gdbarch_addr_bit (struct gdbarch *gdbarch, int addr_bit);
164 /* One if `char' acts like `signed char', zero if `unsigned char'. */
166 extern int gdbarch_char_signed (struct gdbarch *gdbarch);
167 extern void set_gdbarch_char_signed (struct gdbarch *gdbarch, int char_signed);
169 extern int gdbarch_read_pc_p (struct gdbarch *gdbarch);
171 typedef CORE_ADDR (gdbarch_read_pc_ftype) (struct regcache *regcache);
172 extern CORE_ADDR gdbarch_read_pc (struct gdbarch *gdbarch, struct regcache *regcache);
173 extern void set_gdbarch_read_pc (struct gdbarch *gdbarch, gdbarch_read_pc_ftype *read_pc);
175 extern int gdbarch_write_pc_p (struct gdbarch *gdbarch);
177 typedef void (gdbarch_write_pc_ftype) (struct regcache *regcache, CORE_ADDR val);
178 extern void gdbarch_write_pc (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR val);
179 extern void set_gdbarch_write_pc (struct gdbarch *gdbarch, gdbarch_write_pc_ftype *write_pc);
181 /* Function for getting target's idea of a frame pointer. FIXME: GDB's
182 whole scheme for dealing with "frames" and "frame pointers" needs a
183 serious shakedown. */
185 typedef void (gdbarch_virtual_frame_pointer_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc, int *frame_regnum, LONGEST *frame_offset);
186 extern void gdbarch_virtual_frame_pointer (struct gdbarch *gdbarch, CORE_ADDR pc, int *frame_regnum, LONGEST *frame_offset);
187 extern void set_gdbarch_virtual_frame_pointer (struct gdbarch *gdbarch, gdbarch_virtual_frame_pointer_ftype *virtual_frame_pointer);
189 extern int gdbarch_pseudo_register_read_p (struct gdbarch *gdbarch);
191 typedef void (gdbarch_pseudo_register_read_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, gdb_byte *buf);
192 extern void gdbarch_pseudo_register_read (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, gdb_byte *buf);
193 extern void set_gdbarch_pseudo_register_read (struct gdbarch *gdbarch, gdbarch_pseudo_register_read_ftype *pseudo_register_read);
195 extern int gdbarch_pseudo_register_write_p (struct gdbarch *gdbarch);
197 typedef void (gdbarch_pseudo_register_write_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, const gdb_byte *buf);
198 extern void gdbarch_pseudo_register_write (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, const gdb_byte *buf);
199 extern void set_gdbarch_pseudo_register_write (struct gdbarch *gdbarch, gdbarch_pseudo_register_write_ftype *pseudo_register_write);
201 extern int gdbarch_num_regs (struct gdbarch *gdbarch);
202 extern void set_gdbarch_num_regs (struct gdbarch *gdbarch, int num_regs);
204 /* This macro gives the number of pseudo-registers that live in the
205 register namespace but do not get fetched or stored on the target.
206 These pseudo-registers may be aliases for other registers,
207 combinations of other registers, or they may be computed by GDB. */
209 extern int gdbarch_num_pseudo_regs (struct gdbarch *gdbarch);
210 extern void set_gdbarch_num_pseudo_regs (struct gdbarch *gdbarch, int num_pseudo_regs);
212 /* GDB's standard (or well known) register numbers. These can map onto
213 a real register or a pseudo (computed) register or not be defined at
214 all (-1).
215 gdbarch_sp_regnum will hopefully be replaced by UNWIND_SP. */
217 extern int gdbarch_sp_regnum (struct gdbarch *gdbarch);
218 extern void set_gdbarch_sp_regnum (struct gdbarch *gdbarch, int sp_regnum);
220 extern int gdbarch_pc_regnum (struct gdbarch *gdbarch);
221 extern void set_gdbarch_pc_regnum (struct gdbarch *gdbarch, int pc_regnum);
223 extern int gdbarch_ps_regnum (struct gdbarch *gdbarch);
224 extern void set_gdbarch_ps_regnum (struct gdbarch *gdbarch, int ps_regnum);
226 extern int gdbarch_fp0_regnum (struct gdbarch *gdbarch);
227 extern void set_gdbarch_fp0_regnum (struct gdbarch *gdbarch, int fp0_regnum);
229 /* Convert stab register number (from `r' declaration) to a gdb REGNUM. */
231 typedef int (gdbarch_stab_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int stab_regnr);
232 extern int gdbarch_stab_reg_to_regnum (struct gdbarch *gdbarch, int stab_regnr);
233 extern void set_gdbarch_stab_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_stab_reg_to_regnum_ftype *stab_reg_to_regnum);
235 /* Provide a default mapping from a ecoff register number to a gdb REGNUM. */
237 typedef int (gdbarch_ecoff_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int ecoff_regnr);
238 extern int gdbarch_ecoff_reg_to_regnum (struct gdbarch *gdbarch, int ecoff_regnr);
239 extern void set_gdbarch_ecoff_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_ecoff_reg_to_regnum_ftype *ecoff_reg_to_regnum);
241 /* Convert from an sdb register number to an internal gdb register number. */
243 typedef int (gdbarch_sdb_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int sdb_regnr);
244 extern int gdbarch_sdb_reg_to_regnum (struct gdbarch *gdbarch, int sdb_regnr);
245 extern void set_gdbarch_sdb_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_sdb_reg_to_regnum_ftype *sdb_reg_to_regnum);
247 /* Provide a default mapping from a DWARF2 register number to a gdb REGNUM. */
249 typedef int (gdbarch_dwarf2_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int dwarf2_regnr);
250 extern int gdbarch_dwarf2_reg_to_regnum (struct gdbarch *gdbarch, int dwarf2_regnr);
251 extern void set_gdbarch_dwarf2_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_dwarf2_reg_to_regnum_ftype *dwarf2_reg_to_regnum);
253 typedef const char * (gdbarch_register_name_ftype) (struct gdbarch *gdbarch, int regnr);
254 extern const char * gdbarch_register_name (struct gdbarch *gdbarch, int regnr);
255 extern void set_gdbarch_register_name (struct gdbarch *gdbarch, gdbarch_register_name_ftype *register_name);
257 /* Return the type of a register specified by the architecture. Only
258 the register cache should call this function directly; others should
259 use "register_type". */
261 extern int gdbarch_register_type_p (struct gdbarch *gdbarch);
263 typedef struct type * (gdbarch_register_type_ftype) (struct gdbarch *gdbarch, int reg_nr);
264 extern struct type * gdbarch_register_type (struct gdbarch *gdbarch, int reg_nr);
265 extern void set_gdbarch_register_type (struct gdbarch *gdbarch, gdbarch_register_type_ftype *register_type);
267 /* See gdbint.texinfo, and PUSH_DUMMY_CALL. */
269 extern int gdbarch_dummy_id_p (struct gdbarch *gdbarch);
271 typedef struct frame_id (gdbarch_dummy_id_ftype) (struct gdbarch *gdbarch, struct frame_info *this_frame);
272 extern struct frame_id gdbarch_dummy_id (struct gdbarch *gdbarch, struct frame_info *this_frame);
273 extern void set_gdbarch_dummy_id (struct gdbarch *gdbarch, gdbarch_dummy_id_ftype *dummy_id);
275 /* Implement DUMMY_ID and PUSH_DUMMY_CALL, then delete
276 deprecated_fp_regnum. */
278 extern int gdbarch_deprecated_fp_regnum (struct gdbarch *gdbarch);
279 extern void set_gdbarch_deprecated_fp_regnum (struct gdbarch *gdbarch, int deprecated_fp_regnum);
281 /* See gdbint.texinfo. See infcall.c. */
283 extern int gdbarch_push_dummy_call_p (struct gdbarch *gdbarch);
285 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);
286 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);
287 extern void set_gdbarch_push_dummy_call (struct gdbarch *gdbarch, gdbarch_push_dummy_call_ftype *push_dummy_call);
289 extern int gdbarch_call_dummy_location (struct gdbarch *gdbarch);
290 extern void set_gdbarch_call_dummy_location (struct gdbarch *gdbarch, int call_dummy_location);
292 extern int gdbarch_push_dummy_code_p (struct gdbarch *gdbarch);
294 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);
295 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);
296 extern void set_gdbarch_push_dummy_code (struct gdbarch *gdbarch, gdbarch_push_dummy_code_ftype *push_dummy_code);
298 typedef void (gdbarch_print_registers_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, int regnum, int all);
299 extern void gdbarch_print_registers_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, int regnum, int all);
300 extern void set_gdbarch_print_registers_info (struct gdbarch *gdbarch, gdbarch_print_registers_info_ftype *print_registers_info);
302 extern int gdbarch_print_float_info_p (struct gdbarch *gdbarch);
304 typedef void (gdbarch_print_float_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
305 extern void gdbarch_print_float_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
306 extern void set_gdbarch_print_float_info (struct gdbarch *gdbarch, gdbarch_print_float_info_ftype *print_float_info);
308 extern int gdbarch_print_vector_info_p (struct gdbarch *gdbarch);
310 typedef void (gdbarch_print_vector_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
311 extern void gdbarch_print_vector_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
312 extern void set_gdbarch_print_vector_info (struct gdbarch *gdbarch, gdbarch_print_vector_info_ftype *print_vector_info);
314 /* MAP a GDB RAW register number onto a simulator register number. See
315 also include/...-sim.h. */
317 typedef int (gdbarch_register_sim_regno_ftype) (struct gdbarch *gdbarch, int reg_nr);
318 extern int gdbarch_register_sim_regno (struct gdbarch *gdbarch, int reg_nr);
319 extern void set_gdbarch_register_sim_regno (struct gdbarch *gdbarch, gdbarch_register_sim_regno_ftype *register_sim_regno);
321 typedef int (gdbarch_cannot_fetch_register_ftype) (struct gdbarch *gdbarch, int regnum);
322 extern int gdbarch_cannot_fetch_register (struct gdbarch *gdbarch, int regnum);
323 extern void set_gdbarch_cannot_fetch_register (struct gdbarch *gdbarch, gdbarch_cannot_fetch_register_ftype *cannot_fetch_register);
325 typedef int (gdbarch_cannot_store_register_ftype) (struct gdbarch *gdbarch, int regnum);
326 extern int gdbarch_cannot_store_register (struct gdbarch *gdbarch, int regnum);
327 extern void set_gdbarch_cannot_store_register (struct gdbarch *gdbarch, gdbarch_cannot_store_register_ftype *cannot_store_register);
329 /* setjmp/longjmp support. */
331 extern int gdbarch_get_longjmp_target_p (struct gdbarch *gdbarch);
333 typedef int (gdbarch_get_longjmp_target_ftype) (struct frame_info *frame, CORE_ADDR *pc);
334 extern int gdbarch_get_longjmp_target (struct gdbarch *gdbarch, struct frame_info *frame, CORE_ADDR *pc);
335 extern void set_gdbarch_get_longjmp_target (struct gdbarch *gdbarch, gdbarch_get_longjmp_target_ftype *get_longjmp_target);
337 extern int gdbarch_believe_pcc_promotion (struct gdbarch *gdbarch);
338 extern void set_gdbarch_believe_pcc_promotion (struct gdbarch *gdbarch, int believe_pcc_promotion);
340 typedef int (gdbarch_convert_register_p_ftype) (struct gdbarch *gdbarch, int regnum, struct type *type);
341 extern int gdbarch_convert_register_p (struct gdbarch *gdbarch, int regnum, struct type *type);
342 extern void set_gdbarch_convert_register_p (struct gdbarch *gdbarch, gdbarch_convert_register_p_ftype *convert_register_p);
344 typedef void (gdbarch_register_to_value_ftype) (struct frame_info *frame, int regnum, struct type *type, gdb_byte *buf);
345 extern void gdbarch_register_to_value (struct gdbarch *gdbarch, struct frame_info *frame, int regnum, struct type *type, gdb_byte *buf);
346 extern void set_gdbarch_register_to_value (struct gdbarch *gdbarch, gdbarch_register_to_value_ftype *register_to_value);
348 typedef void (gdbarch_value_to_register_ftype) (struct frame_info *frame, int regnum, struct type *type, const gdb_byte *buf);
349 extern void gdbarch_value_to_register (struct gdbarch *gdbarch, struct frame_info *frame, int regnum, struct type *type, const gdb_byte *buf);
350 extern void set_gdbarch_value_to_register (struct gdbarch *gdbarch, gdbarch_value_to_register_ftype *value_to_register);
352 /* Construct a value representing the contents of register REGNUM in
353 frame FRAME, interpreted as type TYPE. The routine needs to
354 allocate and return a struct value with all value attributes
355 (but not the value contents) filled in. */
357 typedef struct value * (gdbarch_value_from_register_ftype) (struct type *type, int regnum, struct frame_info *frame);
358 extern struct value * gdbarch_value_from_register (struct gdbarch *gdbarch, struct type *type, int regnum, struct frame_info *frame);
359 extern void set_gdbarch_value_from_register (struct gdbarch *gdbarch, gdbarch_value_from_register_ftype *value_from_register);
361 typedef CORE_ADDR (gdbarch_pointer_to_address_ftype) (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
362 extern CORE_ADDR gdbarch_pointer_to_address (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
363 extern void set_gdbarch_pointer_to_address (struct gdbarch *gdbarch, gdbarch_pointer_to_address_ftype *pointer_to_address);
365 typedef void (gdbarch_address_to_pointer_ftype) (struct gdbarch *gdbarch, struct type *type, gdb_byte *buf, CORE_ADDR addr);
366 extern void gdbarch_address_to_pointer (struct gdbarch *gdbarch, struct type *type, gdb_byte *buf, CORE_ADDR addr);
367 extern void set_gdbarch_address_to_pointer (struct gdbarch *gdbarch, gdbarch_address_to_pointer_ftype *address_to_pointer);
369 extern int gdbarch_integer_to_address_p (struct gdbarch *gdbarch);
371 typedef CORE_ADDR (gdbarch_integer_to_address_ftype) (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
372 extern CORE_ADDR gdbarch_integer_to_address (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
373 extern void set_gdbarch_integer_to_address (struct gdbarch *gdbarch, gdbarch_integer_to_address_ftype *integer_to_address);
375 /* Return the return-value convention that will be used by FUNCTYPE
376 to return a value of type VALTYPE. FUNCTYPE may be NULL in which
377 case the return convention is computed based only on VALTYPE.
379 If READBUF is not NULL, extract the return value and save it in this buffer.
381 If WRITEBUF is not NULL, it contains a return value which will be
382 stored into the appropriate register. This can be used when we want
383 to force the value returned by a function (see the "return" command
384 for instance). */
386 extern int gdbarch_return_value_p (struct gdbarch *gdbarch);
388 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);
389 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);
390 extern void set_gdbarch_return_value (struct gdbarch *gdbarch, gdbarch_return_value_ftype *return_value);
392 typedef CORE_ADDR (gdbarch_skip_prologue_ftype) (struct gdbarch *gdbarch, CORE_ADDR ip);
393 extern CORE_ADDR gdbarch_skip_prologue (struct gdbarch *gdbarch, CORE_ADDR ip);
394 extern void set_gdbarch_skip_prologue (struct gdbarch *gdbarch, gdbarch_skip_prologue_ftype *skip_prologue);
396 extern int gdbarch_skip_main_prologue_p (struct gdbarch *gdbarch);
398 typedef CORE_ADDR (gdbarch_skip_main_prologue_ftype) (struct gdbarch *gdbarch, CORE_ADDR ip);
399 extern CORE_ADDR gdbarch_skip_main_prologue (struct gdbarch *gdbarch, CORE_ADDR ip);
400 extern void set_gdbarch_skip_main_prologue (struct gdbarch *gdbarch, gdbarch_skip_main_prologue_ftype *skip_main_prologue);
402 typedef int (gdbarch_inner_than_ftype) (CORE_ADDR lhs, CORE_ADDR rhs);
403 extern int gdbarch_inner_than (struct gdbarch *gdbarch, CORE_ADDR lhs, CORE_ADDR rhs);
404 extern void set_gdbarch_inner_than (struct gdbarch *gdbarch, gdbarch_inner_than_ftype *inner_than);
406 typedef const gdb_byte * (gdbarch_breakpoint_from_pc_ftype) (struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *lenptr);
407 extern const gdb_byte * gdbarch_breakpoint_from_pc (struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *lenptr);
408 extern void set_gdbarch_breakpoint_from_pc (struct gdbarch *gdbarch, gdbarch_breakpoint_from_pc_ftype *breakpoint_from_pc);
410 /* Return the adjusted address and kind to use for Z0/Z1 packets.
411 KIND is usually the memory length of the breakpoint, but may have a
412 different target-specific meaning. */
414 typedef void (gdbarch_remote_breakpoint_from_pc_ftype) (struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *kindptr);
415 extern void gdbarch_remote_breakpoint_from_pc (struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *kindptr);
416 extern void set_gdbarch_remote_breakpoint_from_pc (struct gdbarch *gdbarch, gdbarch_remote_breakpoint_from_pc_ftype *remote_breakpoint_from_pc);
418 extern int gdbarch_adjust_breakpoint_address_p (struct gdbarch *gdbarch);
420 typedef CORE_ADDR (gdbarch_adjust_breakpoint_address_ftype) (struct gdbarch *gdbarch, CORE_ADDR bpaddr);
421 extern CORE_ADDR gdbarch_adjust_breakpoint_address (struct gdbarch *gdbarch, CORE_ADDR bpaddr);
422 extern void set_gdbarch_adjust_breakpoint_address (struct gdbarch *gdbarch, gdbarch_adjust_breakpoint_address_ftype *adjust_breakpoint_address);
424 typedef int (gdbarch_memory_insert_breakpoint_ftype) (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
425 extern int gdbarch_memory_insert_breakpoint (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
426 extern void set_gdbarch_memory_insert_breakpoint (struct gdbarch *gdbarch, gdbarch_memory_insert_breakpoint_ftype *memory_insert_breakpoint);
428 typedef int (gdbarch_memory_remove_breakpoint_ftype) (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
429 extern int gdbarch_memory_remove_breakpoint (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
430 extern void set_gdbarch_memory_remove_breakpoint (struct gdbarch *gdbarch, gdbarch_memory_remove_breakpoint_ftype *memory_remove_breakpoint);
432 extern CORE_ADDR gdbarch_decr_pc_after_break (struct gdbarch *gdbarch);
433 extern void set_gdbarch_decr_pc_after_break (struct gdbarch *gdbarch, CORE_ADDR decr_pc_after_break);
435 /* A function can be addressed by either it's "pointer" (possibly a
436 descriptor address) or "entry point" (first executable instruction).
437 The method "convert_from_func_ptr_addr" converting the former to the
438 latter. gdbarch_deprecated_function_start_offset is being used to implement
439 a simplified subset of that functionality - the function's address
440 corresponds to the "function pointer" and the function's start
441 corresponds to the "function entry point" - and hence is redundant. */
443 extern CORE_ADDR gdbarch_deprecated_function_start_offset (struct gdbarch *gdbarch);
444 extern void set_gdbarch_deprecated_function_start_offset (struct gdbarch *gdbarch, CORE_ADDR deprecated_function_start_offset);
446 /* Return the remote protocol register number associated with this
447 register. Normally the identity mapping. */
449 typedef int (gdbarch_remote_register_number_ftype) (struct gdbarch *gdbarch, int regno);
450 extern int gdbarch_remote_register_number (struct gdbarch *gdbarch, int regno);
451 extern void set_gdbarch_remote_register_number (struct gdbarch *gdbarch, gdbarch_remote_register_number_ftype *remote_register_number);
453 /* Fetch the target specific address used to represent a load module. */
455 extern int gdbarch_fetch_tls_load_module_address_p (struct gdbarch *gdbarch);
457 typedef CORE_ADDR (gdbarch_fetch_tls_load_module_address_ftype) (struct objfile *objfile);
458 extern CORE_ADDR gdbarch_fetch_tls_load_module_address (struct gdbarch *gdbarch, struct objfile *objfile);
459 extern void set_gdbarch_fetch_tls_load_module_address (struct gdbarch *gdbarch, gdbarch_fetch_tls_load_module_address_ftype *fetch_tls_load_module_address);
461 extern CORE_ADDR gdbarch_frame_args_skip (struct gdbarch *gdbarch);
462 extern void set_gdbarch_frame_args_skip (struct gdbarch *gdbarch, CORE_ADDR frame_args_skip);
464 extern int gdbarch_unwind_pc_p (struct gdbarch *gdbarch);
466 typedef CORE_ADDR (gdbarch_unwind_pc_ftype) (struct gdbarch *gdbarch, struct frame_info *next_frame);
467 extern CORE_ADDR gdbarch_unwind_pc (struct gdbarch *gdbarch, struct frame_info *next_frame);
468 extern void set_gdbarch_unwind_pc (struct gdbarch *gdbarch, gdbarch_unwind_pc_ftype *unwind_pc);
470 extern int gdbarch_unwind_sp_p (struct gdbarch *gdbarch);
472 typedef CORE_ADDR (gdbarch_unwind_sp_ftype) (struct gdbarch *gdbarch, struct frame_info *next_frame);
473 extern CORE_ADDR gdbarch_unwind_sp (struct gdbarch *gdbarch, struct frame_info *next_frame);
474 extern void set_gdbarch_unwind_sp (struct gdbarch *gdbarch, gdbarch_unwind_sp_ftype *unwind_sp);
476 /* DEPRECATED_FRAME_LOCALS_ADDRESS as been replaced by the per-frame
477 frame-base. Enable frame-base before frame-unwind. */
479 extern int gdbarch_frame_num_args_p (struct gdbarch *gdbarch);
481 typedef int (gdbarch_frame_num_args_ftype) (struct frame_info *frame);
482 extern int gdbarch_frame_num_args (struct gdbarch *gdbarch, struct frame_info *frame);
483 extern void set_gdbarch_frame_num_args (struct gdbarch *gdbarch, gdbarch_frame_num_args_ftype *frame_num_args);
485 extern int gdbarch_frame_align_p (struct gdbarch *gdbarch);
487 typedef CORE_ADDR (gdbarch_frame_align_ftype) (struct gdbarch *gdbarch, CORE_ADDR address);
488 extern CORE_ADDR gdbarch_frame_align (struct gdbarch *gdbarch, CORE_ADDR address);
489 extern void set_gdbarch_frame_align (struct gdbarch *gdbarch, gdbarch_frame_align_ftype *frame_align);
491 typedef int (gdbarch_stabs_argument_has_addr_ftype) (struct gdbarch *gdbarch, struct type *type);
492 extern int gdbarch_stabs_argument_has_addr (struct gdbarch *gdbarch, struct type *type);
493 extern void set_gdbarch_stabs_argument_has_addr (struct gdbarch *gdbarch, gdbarch_stabs_argument_has_addr_ftype *stabs_argument_has_addr);
495 extern int gdbarch_frame_red_zone_size (struct gdbarch *gdbarch);
496 extern void set_gdbarch_frame_red_zone_size (struct gdbarch *gdbarch, int frame_red_zone_size);
498 typedef CORE_ADDR (gdbarch_convert_from_func_ptr_addr_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr, struct target_ops *targ);
499 extern CORE_ADDR gdbarch_convert_from_func_ptr_addr (struct gdbarch *gdbarch, CORE_ADDR addr, struct target_ops *targ);
500 extern void set_gdbarch_convert_from_func_ptr_addr (struct gdbarch *gdbarch, gdbarch_convert_from_func_ptr_addr_ftype *convert_from_func_ptr_addr);
502 /* On some machines there are bits in addresses which are not really
503 part of the address, but are used by the kernel, the hardware, etc.
504 for special purposes. gdbarch_addr_bits_remove takes out any such bits so
505 we get a "real" address such as one would find in a symbol table.
506 This is used only for addresses of instructions, and even then I'm
507 not sure it's used in all contexts. It exists to deal with there
508 being a few stray bits in the PC which would mislead us, not as some
509 sort of generic thing to handle alignment or segmentation (it's
510 possible it should be in TARGET_READ_PC instead). */
512 typedef CORE_ADDR (gdbarch_addr_bits_remove_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
513 extern CORE_ADDR gdbarch_addr_bits_remove (struct gdbarch *gdbarch, CORE_ADDR addr);
514 extern void set_gdbarch_addr_bits_remove (struct gdbarch *gdbarch, gdbarch_addr_bits_remove_ftype *addr_bits_remove);
516 /* It is not at all clear why gdbarch_smash_text_address is not folded into
517 gdbarch_addr_bits_remove. */
519 typedef CORE_ADDR (gdbarch_smash_text_address_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
520 extern CORE_ADDR gdbarch_smash_text_address (struct gdbarch *gdbarch, CORE_ADDR addr);
521 extern void set_gdbarch_smash_text_address (struct gdbarch *gdbarch, gdbarch_smash_text_address_ftype *smash_text_address);
523 /* FIXME/cagney/2001-01-18: This should be split in two. A target method that
524 indicates if the target needs software single step. An ISA method to
525 implement it.
527 FIXME/cagney/2001-01-18: This should be replaced with something that inserts
528 breakpoints using the breakpoint system instead of blatting memory directly
529 (as with rs6000).
531 FIXME/cagney/2001-01-18: The logic is backwards. It should be asking if the
532 target can single step. If not, then implement single step using breakpoints.
534 A return value of 1 means that the software_single_step breakpoints
535 were inserted; 0 means they were not. */
537 extern int gdbarch_software_single_step_p (struct gdbarch *gdbarch);
539 typedef int (gdbarch_software_single_step_ftype) (struct frame_info *frame);
540 extern int gdbarch_software_single_step (struct gdbarch *gdbarch, struct frame_info *frame);
541 extern void set_gdbarch_software_single_step (struct gdbarch *gdbarch, gdbarch_software_single_step_ftype *software_single_step);
543 /* Return non-zero if the processor is executing a delay slot and a
544 further single-step is needed before the instruction finishes. */
546 extern int gdbarch_single_step_through_delay_p (struct gdbarch *gdbarch);
548 typedef int (gdbarch_single_step_through_delay_ftype) (struct gdbarch *gdbarch, struct frame_info *frame);
549 extern int gdbarch_single_step_through_delay (struct gdbarch *gdbarch, struct frame_info *frame);
550 extern void set_gdbarch_single_step_through_delay (struct gdbarch *gdbarch, gdbarch_single_step_through_delay_ftype *single_step_through_delay);
552 /* FIXME: cagney/2003-08-28: Need to find a better way of selecting the
553 disassembler. Perhaps objdump can handle it? */
555 typedef int (gdbarch_print_insn_ftype) (bfd_vma vma, struct disassemble_info *info);
556 extern int gdbarch_print_insn (struct gdbarch *gdbarch, bfd_vma vma, struct disassemble_info *info);
557 extern void set_gdbarch_print_insn (struct gdbarch *gdbarch, gdbarch_print_insn_ftype *print_insn);
559 typedef CORE_ADDR (gdbarch_skip_trampoline_code_ftype) (struct frame_info *frame, CORE_ADDR pc);
560 extern CORE_ADDR gdbarch_skip_trampoline_code (struct gdbarch *gdbarch, struct frame_info *frame, CORE_ADDR pc);
561 extern void set_gdbarch_skip_trampoline_code (struct gdbarch *gdbarch, gdbarch_skip_trampoline_code_ftype *skip_trampoline_code);
563 /* If in_solib_dynsym_resolve_code() returns true, and SKIP_SOLIB_RESOLVER
564 evaluates non-zero, this is the address where the debugger will place
565 a step-resume breakpoint to get us past the dynamic linker. */
567 typedef CORE_ADDR (gdbarch_skip_solib_resolver_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc);
568 extern CORE_ADDR gdbarch_skip_solib_resolver (struct gdbarch *gdbarch, CORE_ADDR pc);
569 extern void set_gdbarch_skip_solib_resolver (struct gdbarch *gdbarch, gdbarch_skip_solib_resolver_ftype *skip_solib_resolver);
571 /* Some systems also have trampoline code for returning from shared libs. */
573 typedef int (gdbarch_in_solib_return_trampoline_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc, char *name);
574 extern int gdbarch_in_solib_return_trampoline (struct gdbarch *gdbarch, CORE_ADDR pc, char *name);
575 extern void set_gdbarch_in_solib_return_trampoline (struct gdbarch *gdbarch, gdbarch_in_solib_return_trampoline_ftype *in_solib_return_trampoline);
577 /* A target might have problems with watchpoints as soon as the stack
578 frame of the current function has been destroyed. This mostly happens
579 as the first action in a funtion's epilogue. in_function_epilogue_p()
580 is defined to return a non-zero value if either the given addr is one
581 instruction after the stack destroying instruction up to the trailing
582 return instruction or if we can figure out that the stack frame has
583 already been invalidated regardless of the value of addr. Targets
584 which don't suffer from that problem could just let this functionality
585 untouched. */
587 typedef int (gdbarch_in_function_epilogue_p_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
588 extern int gdbarch_in_function_epilogue_p (struct gdbarch *gdbarch, CORE_ADDR addr);
589 extern void set_gdbarch_in_function_epilogue_p (struct gdbarch *gdbarch, gdbarch_in_function_epilogue_p_ftype *in_function_epilogue_p);
591 typedef void (gdbarch_elf_make_msymbol_special_ftype) (asymbol *sym, struct minimal_symbol *msym);
592 extern void gdbarch_elf_make_msymbol_special (struct gdbarch *gdbarch, asymbol *sym, struct minimal_symbol *msym);
593 extern void set_gdbarch_elf_make_msymbol_special (struct gdbarch *gdbarch, gdbarch_elf_make_msymbol_special_ftype *elf_make_msymbol_special);
595 typedef void (gdbarch_coff_make_msymbol_special_ftype) (int val, struct minimal_symbol *msym);
596 extern void gdbarch_coff_make_msymbol_special (struct gdbarch *gdbarch, int val, struct minimal_symbol *msym);
597 extern void set_gdbarch_coff_make_msymbol_special (struct gdbarch *gdbarch, gdbarch_coff_make_msymbol_special_ftype *coff_make_msymbol_special);
599 extern int gdbarch_cannot_step_breakpoint (struct gdbarch *gdbarch);
600 extern void set_gdbarch_cannot_step_breakpoint (struct gdbarch *gdbarch, int cannot_step_breakpoint);
602 extern int gdbarch_have_nonsteppable_watchpoint (struct gdbarch *gdbarch);
603 extern void set_gdbarch_have_nonsteppable_watchpoint (struct gdbarch *gdbarch, int have_nonsteppable_watchpoint);
605 extern int gdbarch_address_class_type_flags_p (struct gdbarch *gdbarch);
607 typedef int (gdbarch_address_class_type_flags_ftype) (int byte_size, int dwarf2_addr_class);
608 extern int gdbarch_address_class_type_flags (struct gdbarch *gdbarch, int byte_size, int dwarf2_addr_class);
609 extern void set_gdbarch_address_class_type_flags (struct gdbarch *gdbarch, gdbarch_address_class_type_flags_ftype *address_class_type_flags);
611 extern int gdbarch_address_class_type_flags_to_name_p (struct gdbarch *gdbarch);
613 typedef const char * (gdbarch_address_class_type_flags_to_name_ftype) (struct gdbarch *gdbarch, int type_flags);
614 extern const char * gdbarch_address_class_type_flags_to_name (struct gdbarch *gdbarch, int type_flags);
615 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);
617 extern int gdbarch_address_class_name_to_type_flags_p (struct gdbarch *gdbarch);
619 typedef int (gdbarch_address_class_name_to_type_flags_ftype) (struct gdbarch *gdbarch, const char *name, int *type_flags_ptr);
620 extern int gdbarch_address_class_name_to_type_flags (struct gdbarch *gdbarch, const char *name, int *type_flags_ptr);
621 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);
623 /* Is a register in a group */
625 typedef int (gdbarch_register_reggroup_p_ftype) (struct gdbarch *gdbarch, int regnum, struct reggroup *reggroup);
626 extern int gdbarch_register_reggroup_p (struct gdbarch *gdbarch, int regnum, struct reggroup *reggroup);
627 extern void set_gdbarch_register_reggroup_p (struct gdbarch *gdbarch, gdbarch_register_reggroup_p_ftype *register_reggroup_p);
629 /* Fetch the pointer to the ith function argument. */
631 extern int gdbarch_fetch_pointer_argument_p (struct gdbarch *gdbarch);
633 typedef CORE_ADDR (gdbarch_fetch_pointer_argument_ftype) (struct frame_info *frame, int argi, struct type *type);
634 extern CORE_ADDR gdbarch_fetch_pointer_argument (struct gdbarch *gdbarch, struct frame_info *frame, int argi, struct type *type);
635 extern void set_gdbarch_fetch_pointer_argument (struct gdbarch *gdbarch, gdbarch_fetch_pointer_argument_ftype *fetch_pointer_argument);
637 /* Return the appropriate register set for a core file section with
638 name SECT_NAME and size SECT_SIZE. */
640 extern int gdbarch_regset_from_core_section_p (struct gdbarch *gdbarch);
642 typedef const struct regset * (gdbarch_regset_from_core_section_ftype) (struct gdbarch *gdbarch, const char *sect_name, size_t sect_size);
643 extern const struct regset * gdbarch_regset_from_core_section (struct gdbarch *gdbarch, const char *sect_name, size_t sect_size);
644 extern void set_gdbarch_regset_from_core_section (struct gdbarch *gdbarch, gdbarch_regset_from_core_section_ftype *regset_from_core_section);
646 /* When creating core dumps, some systems encode the PID in addition
647 to the LWP id in core file register section names. In those cases, the
648 "XXX" in ".reg/XXX" is encoded as [LWPID << 16 | PID]. This setting
649 is set to true for such architectures; false if "XXX" represents an LWP
650 or thread id with no special encoding. */
652 extern int gdbarch_core_reg_section_encodes_pid (struct gdbarch *gdbarch);
653 extern void set_gdbarch_core_reg_section_encodes_pid (struct gdbarch *gdbarch, int core_reg_section_encodes_pid);
655 /* Supported register notes in a core file. */
657 extern struct core_regset_section * gdbarch_core_regset_sections (struct gdbarch *gdbarch);
658 extern void set_gdbarch_core_regset_sections (struct gdbarch *gdbarch, struct core_regset_section * core_regset_sections);
660 /* Read offset OFFSET of TARGET_OBJECT_LIBRARIES formatted shared libraries list from
661 core file into buffer READBUF with length LEN. */
663 extern int gdbarch_core_xfer_shared_libraries_p (struct gdbarch *gdbarch);
665 typedef LONGEST (gdbarch_core_xfer_shared_libraries_ftype) (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, LONGEST len);
666 extern LONGEST gdbarch_core_xfer_shared_libraries (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, LONGEST len);
667 extern void set_gdbarch_core_xfer_shared_libraries (struct gdbarch *gdbarch, gdbarch_core_xfer_shared_libraries_ftype *core_xfer_shared_libraries);
669 /* How the core_stratum layer converts a PTID from a core file to a
670 string. */
672 extern int gdbarch_core_pid_to_str_p (struct gdbarch *gdbarch);
674 typedef char * (gdbarch_core_pid_to_str_ftype) (struct gdbarch *gdbarch, ptid_t ptid);
675 extern char * gdbarch_core_pid_to_str (struct gdbarch *gdbarch, ptid_t ptid);
676 extern void set_gdbarch_core_pid_to_str (struct gdbarch *gdbarch, gdbarch_core_pid_to_str_ftype *core_pid_to_str);
678 /* BFD target to use when generating a core file. */
680 extern int gdbarch_gcore_bfd_target_p (struct gdbarch *gdbarch);
682 extern const char * gdbarch_gcore_bfd_target (struct gdbarch *gdbarch);
683 extern void set_gdbarch_gcore_bfd_target (struct gdbarch *gdbarch, const char * gcore_bfd_target);
685 /* If the elements of C++ vtables are in-place function descriptors rather
686 than normal function pointers (which may point to code or a descriptor),
687 set this to one. */
689 extern int gdbarch_vtable_function_descriptors (struct gdbarch *gdbarch);
690 extern void set_gdbarch_vtable_function_descriptors (struct gdbarch *gdbarch, int vtable_function_descriptors);
692 /* Set if the least significant bit of the delta is used instead of the least
693 significant bit of the pfn for pointers to virtual member functions. */
695 extern int gdbarch_vbit_in_delta (struct gdbarch *gdbarch);
696 extern void set_gdbarch_vbit_in_delta (struct gdbarch *gdbarch, int vbit_in_delta);
698 /* Advance PC to next instruction in order to skip a permanent breakpoint. */
700 extern int gdbarch_skip_permanent_breakpoint_p (struct gdbarch *gdbarch);
702 typedef void (gdbarch_skip_permanent_breakpoint_ftype) (struct regcache *regcache);
703 extern void gdbarch_skip_permanent_breakpoint (struct gdbarch *gdbarch, struct regcache *regcache);
704 extern void set_gdbarch_skip_permanent_breakpoint (struct gdbarch *gdbarch, gdbarch_skip_permanent_breakpoint_ftype *skip_permanent_breakpoint);
706 /* The maximum length of an instruction on this architecture. */
708 extern int gdbarch_max_insn_length_p (struct gdbarch *gdbarch);
710 extern ULONGEST gdbarch_max_insn_length (struct gdbarch *gdbarch);
711 extern void set_gdbarch_max_insn_length (struct gdbarch *gdbarch, ULONGEST max_insn_length);
713 /* Copy the instruction at FROM to TO, and make any adjustments
714 necessary to single-step it at that address.
716 REGS holds the state the thread's registers will have before
717 executing the copied instruction; the PC in REGS will refer to FROM,
718 not the copy at TO. The caller should update it to point at TO later.
720 Return a pointer to data of the architecture's choice to be passed
721 to gdbarch_displaced_step_fixup. Or, return NULL to indicate that
722 the instruction's effects have been completely simulated, with the
723 resulting state written back to REGS.
725 For a general explanation of displaced stepping and how GDB uses it,
726 see the comments in infrun.c.
728 The TO area is only guaranteed to have space for
729 gdbarch_max_insn_length (arch) bytes, so this function must not
730 write more bytes than that to that area.
732 If you do not provide this function, GDB assumes that the
733 architecture does not support displaced stepping.
735 If your architecture doesn't need to adjust instructions before
736 single-stepping them, consider using simple_displaced_step_copy_insn
737 here. */
739 extern int gdbarch_displaced_step_copy_insn_p (struct gdbarch *gdbarch);
741 typedef struct displaced_step_closure * (gdbarch_displaced_step_copy_insn_ftype) (struct gdbarch *gdbarch, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
742 extern struct displaced_step_closure * gdbarch_displaced_step_copy_insn (struct gdbarch *gdbarch, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
743 extern void set_gdbarch_displaced_step_copy_insn (struct gdbarch *gdbarch, gdbarch_displaced_step_copy_insn_ftype *displaced_step_copy_insn);
745 /* Return true if GDB should use hardware single-stepping to execute
746 the displaced instruction identified by CLOSURE. If false,
747 GDB will simply restart execution at the displaced instruction
748 location, and it is up to the target to ensure GDB will receive
749 control again (e.g. by placing a software breakpoint instruction
750 into the displaced instruction buffer).
752 The default implementation returns false on all targets that
753 provide a gdbarch_software_single_step routine, and true otherwise. */
755 typedef int (gdbarch_displaced_step_hw_singlestep_ftype) (struct gdbarch *gdbarch, struct displaced_step_closure *closure);
756 extern int gdbarch_displaced_step_hw_singlestep (struct gdbarch *gdbarch, struct displaced_step_closure *closure);
757 extern void set_gdbarch_displaced_step_hw_singlestep (struct gdbarch *gdbarch, gdbarch_displaced_step_hw_singlestep_ftype *displaced_step_hw_singlestep);
759 /* Fix up the state resulting from successfully single-stepping a
760 displaced instruction, to give the result we would have gotten from
761 stepping the instruction in its original location.
763 REGS is the register state resulting from single-stepping the
764 displaced instruction.
766 CLOSURE is the result from the matching call to
767 gdbarch_displaced_step_copy_insn.
769 If you provide gdbarch_displaced_step_copy_insn.but not this
770 function, then GDB assumes that no fixup is needed after
771 single-stepping the instruction.
773 For a general explanation of displaced stepping and how GDB uses it,
774 see the comments in infrun.c. */
776 extern int gdbarch_displaced_step_fixup_p (struct gdbarch *gdbarch);
778 typedef void (gdbarch_displaced_step_fixup_ftype) (struct gdbarch *gdbarch, struct displaced_step_closure *closure, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
779 extern void gdbarch_displaced_step_fixup (struct gdbarch *gdbarch, struct displaced_step_closure *closure, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
780 extern void set_gdbarch_displaced_step_fixup (struct gdbarch *gdbarch, gdbarch_displaced_step_fixup_ftype *displaced_step_fixup);
782 /* Free a closure returned by gdbarch_displaced_step_copy_insn.
784 If you provide gdbarch_displaced_step_copy_insn, you must provide
785 this function as well.
787 If your architecture uses closures that don't need to be freed, then
788 you can use simple_displaced_step_free_closure here.
790 For a general explanation of displaced stepping and how GDB uses it,
791 see the comments in infrun.c. */
793 typedef void (gdbarch_displaced_step_free_closure_ftype) (struct gdbarch *gdbarch, struct displaced_step_closure *closure);
794 extern void gdbarch_displaced_step_free_closure (struct gdbarch *gdbarch, struct displaced_step_closure *closure);
795 extern void set_gdbarch_displaced_step_free_closure (struct gdbarch *gdbarch, gdbarch_displaced_step_free_closure_ftype *displaced_step_free_closure);
797 /* Return the address of an appropriate place to put displaced
798 instructions while we step over them. There need only be one such
799 place, since we're only stepping one thread over a breakpoint at a
800 time.
802 For a general explanation of displaced stepping and how GDB uses it,
803 see the comments in infrun.c. */
805 typedef CORE_ADDR (gdbarch_displaced_step_location_ftype) (struct gdbarch *gdbarch);
806 extern CORE_ADDR gdbarch_displaced_step_location (struct gdbarch *gdbarch);
807 extern void set_gdbarch_displaced_step_location (struct gdbarch *gdbarch, gdbarch_displaced_step_location_ftype *displaced_step_location);
809 /* Refresh overlay mapped state for section OSECT. */
811 extern int gdbarch_overlay_update_p (struct gdbarch *gdbarch);
813 typedef void (gdbarch_overlay_update_ftype) (struct obj_section *osect);
814 extern void gdbarch_overlay_update (struct gdbarch *gdbarch, struct obj_section *osect);
815 extern void set_gdbarch_overlay_update (struct gdbarch *gdbarch, gdbarch_overlay_update_ftype *overlay_update);
817 extern int gdbarch_core_read_description_p (struct gdbarch *gdbarch);
819 typedef const struct target_desc * (gdbarch_core_read_description_ftype) (struct gdbarch *gdbarch, struct target_ops *target, bfd *abfd);
820 extern const struct target_desc * gdbarch_core_read_description (struct gdbarch *gdbarch, struct target_ops *target, bfd *abfd);
821 extern void set_gdbarch_core_read_description (struct gdbarch *gdbarch, gdbarch_core_read_description_ftype *core_read_description);
823 /* Handle special encoding of static variables in stabs debug info. */
825 extern int gdbarch_static_transform_name_p (struct gdbarch *gdbarch);
827 typedef char * (gdbarch_static_transform_name_ftype) (char *name);
828 extern char * gdbarch_static_transform_name (struct gdbarch *gdbarch, char *name);
829 extern void set_gdbarch_static_transform_name (struct gdbarch *gdbarch, gdbarch_static_transform_name_ftype *static_transform_name);
831 /* Set if the address in N_SO or N_FUN stabs may be zero. */
833 extern int gdbarch_sofun_address_maybe_missing (struct gdbarch *gdbarch);
834 extern void set_gdbarch_sofun_address_maybe_missing (struct gdbarch *gdbarch, int sofun_address_maybe_missing);
836 /* Parse the instruction at ADDR storing in the record execution log
837 the registers REGCACHE and memory ranges that will be affected when
838 the instruction executes, along with their current values.
839 Return -1 if something goes wrong, 0 otherwise. */
841 extern int gdbarch_process_record_p (struct gdbarch *gdbarch);
843 typedef int (gdbarch_process_record_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr);
844 extern int gdbarch_process_record (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr);
845 extern void set_gdbarch_process_record (struct gdbarch *gdbarch, gdbarch_process_record_ftype *process_record);
847 /* Save process state after a signal.
848 Return -1 if something goes wrong, 0 otherwise. */
850 extern int gdbarch_process_record_signal_p (struct gdbarch *gdbarch);
852 typedef int (gdbarch_process_record_signal_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, enum target_signal signal);
853 extern int gdbarch_process_record_signal (struct gdbarch *gdbarch, struct regcache *regcache, enum target_signal signal);
854 extern void set_gdbarch_process_record_signal (struct gdbarch *gdbarch, gdbarch_process_record_signal_ftype *process_record_signal);
856 /* Signal translation: translate inferior's signal (host's) number into
857 GDB's representation. */
859 typedef enum target_signal (gdbarch_target_signal_from_host_ftype) (struct gdbarch *gdbarch, int signo);
860 extern enum target_signal gdbarch_target_signal_from_host (struct gdbarch *gdbarch, int signo);
861 extern void set_gdbarch_target_signal_from_host (struct gdbarch *gdbarch, gdbarch_target_signal_from_host_ftype *target_signal_from_host);
863 /* Signal translation: translate GDB's signal number into inferior's host
864 signal number. */
866 typedef int (gdbarch_target_signal_to_host_ftype) (struct gdbarch *gdbarch, enum target_signal ts);
867 extern int gdbarch_target_signal_to_host (struct gdbarch *gdbarch, enum target_signal ts);
868 extern void set_gdbarch_target_signal_to_host (struct gdbarch *gdbarch, gdbarch_target_signal_to_host_ftype *target_signal_to_host);
870 /* Extra signal info inspection.
872 Return a type suitable to inspect extra signal information. */
874 extern int gdbarch_get_siginfo_type_p (struct gdbarch *gdbarch);
876 typedef struct type * (gdbarch_get_siginfo_type_ftype) (struct gdbarch *gdbarch);
877 extern struct type * gdbarch_get_siginfo_type (struct gdbarch *gdbarch);
878 extern void set_gdbarch_get_siginfo_type (struct gdbarch *gdbarch, gdbarch_get_siginfo_type_ftype *get_siginfo_type);
880 /* Record architecture-specific information from the symbol table. */
882 extern int gdbarch_record_special_symbol_p (struct gdbarch *gdbarch);
884 typedef void (gdbarch_record_special_symbol_ftype) (struct gdbarch *gdbarch, struct objfile *objfile, asymbol *sym);
885 extern void gdbarch_record_special_symbol (struct gdbarch *gdbarch, struct objfile *objfile, asymbol *sym);
886 extern void set_gdbarch_record_special_symbol (struct gdbarch *gdbarch, gdbarch_record_special_symbol_ftype *record_special_symbol);
888 /* Function for the 'catch syscall' feature.
889 Get architecture-specific system calls information from registers. */
891 extern int gdbarch_get_syscall_number_p (struct gdbarch *gdbarch);
893 typedef LONGEST (gdbarch_get_syscall_number_ftype) (struct gdbarch *gdbarch, ptid_t ptid);
894 extern LONGEST gdbarch_get_syscall_number (struct gdbarch *gdbarch, ptid_t ptid);
895 extern void set_gdbarch_get_syscall_number (struct gdbarch *gdbarch, gdbarch_get_syscall_number_ftype *get_syscall_number);
897 /* True if the list of shared libraries is one and only for all
898 processes, as opposed to a list of shared libraries per inferior.
899 This usually means that all processes, although may or may not share
900 an address space, will see the same set of symbols at the same
901 addresses. */
903 extern int gdbarch_has_global_solist (struct gdbarch *gdbarch);
904 extern void set_gdbarch_has_global_solist (struct gdbarch *gdbarch, int has_global_solist);
906 /* On some targets, even though each inferior has its own private
907 address space, the debug interface takes care of making breakpoints
908 visible to all address spaces automatically. For such cases,
909 this property should be set to true. */
911 extern int gdbarch_has_global_breakpoints (struct gdbarch *gdbarch);
912 extern void set_gdbarch_has_global_breakpoints (struct gdbarch *gdbarch, int has_global_breakpoints);
914 /* True if inferiors share an address space (e.g., uClinux). */
916 typedef int (gdbarch_has_shared_address_space_ftype) (struct gdbarch *gdbarch);
917 extern int gdbarch_has_shared_address_space (struct gdbarch *gdbarch);
918 extern void set_gdbarch_has_shared_address_space (struct gdbarch *gdbarch, gdbarch_has_shared_address_space_ftype *has_shared_address_space);
920 /* True if a fast tracepoint can be set at an address. */
922 typedef int (gdbarch_fast_tracepoint_valid_at_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr, int *isize, char **msg);
923 extern int gdbarch_fast_tracepoint_valid_at (struct gdbarch *gdbarch, CORE_ADDR addr, int *isize, char **msg);
924 extern void set_gdbarch_fast_tracepoint_valid_at (struct gdbarch *gdbarch, gdbarch_fast_tracepoint_valid_at_ftype *fast_tracepoint_valid_at);
926 /* Not NULL if a target has additonal field for qSupported. */
928 extern const char * gdbarch_qsupported (struct gdbarch *gdbarch);
929 extern void set_gdbarch_qsupported (struct gdbarch *gdbarch, const char * qsupported);
931 /* Definition for an unknown syscall, used basically in error-cases. */
932 #define UNKNOWN_SYSCALL (-1)
934 extern struct gdbarch_tdep *gdbarch_tdep (struct gdbarch *gdbarch);
937 /* Mechanism for co-ordinating the selection of a specific
938 architecture.
940 GDB targets (*-tdep.c) can register an interest in a specific
941 architecture. Other GDB components can register a need to maintain
942 per-architecture data.
944 The mechanisms below ensures that there is only a loose connection
945 between the set-architecture command and the various GDB
946 components. Each component can independently register their need
947 to maintain architecture specific data with gdbarch.
949 Pragmatics:
951 Previously, a single TARGET_ARCHITECTURE_HOOK was provided. It
952 didn't scale.
954 The more traditional mega-struct containing architecture specific
955 data for all the various GDB components was also considered. Since
956 GDB is built from a variable number of (fairly independent)
957 components it was determined that the global aproach was not
958 applicable. */
961 /* Register a new architectural family with GDB.
963 Register support for the specified ARCHITECTURE with GDB. When
964 gdbarch determines that the specified architecture has been
965 selected, the corresponding INIT function is called.
969 The INIT function takes two parameters: INFO which contains the
970 information available to gdbarch about the (possibly new)
971 architecture; ARCHES which is a list of the previously created
972 ``struct gdbarch'' for this architecture.
974 The INFO parameter is, as far as possible, be pre-initialized with
975 information obtained from INFO.ABFD or the global defaults.
977 The ARCHES parameter is a linked list (sorted most recently used)
978 of all the previously created architures for this architecture
979 family. The (possibly NULL) ARCHES->gdbarch can used to access
980 values from the previously selected architecture for this
981 architecture family.
983 The INIT function shall return any of: NULL - indicating that it
984 doesn't recognize the selected architecture; an existing ``struct
985 gdbarch'' from the ARCHES list - indicating that the new
986 architecture is just a synonym for an earlier architecture (see
987 gdbarch_list_lookup_by_info()); a newly created ``struct gdbarch''
988 - that describes the selected architecture (see gdbarch_alloc()).
990 The DUMP_TDEP function shall print out all target specific values.
991 Care should be taken to ensure that the function works in both the
992 multi-arch and non- multi-arch cases. */
994 struct gdbarch_list
996 struct gdbarch *gdbarch;
997 struct gdbarch_list *next;
1000 struct gdbarch_info
1002 /* Use default: NULL (ZERO). */
1003 const struct bfd_arch_info *bfd_arch_info;
1005 /* Use default: BFD_ENDIAN_UNKNOWN (NB: is not ZERO). */
1006 int byte_order;
1008 int byte_order_for_code;
1010 /* Use default: NULL (ZERO). */
1011 bfd *abfd;
1013 /* Use default: NULL (ZERO). */
1014 struct gdbarch_tdep_info *tdep_info;
1016 /* Use default: GDB_OSABI_UNINITIALIZED (-1). */
1017 enum gdb_osabi osabi;
1019 /* Use default: NULL (ZERO). */
1020 const struct target_desc *target_desc;
1023 typedef struct gdbarch *(gdbarch_init_ftype) (struct gdbarch_info info, struct gdbarch_list *arches);
1024 typedef void (gdbarch_dump_tdep_ftype) (struct gdbarch *gdbarch, struct ui_file *file);
1026 /* DEPRECATED - use gdbarch_register() */
1027 extern void register_gdbarch_init (enum bfd_architecture architecture, gdbarch_init_ftype *);
1029 extern void gdbarch_register (enum bfd_architecture architecture,
1030 gdbarch_init_ftype *,
1031 gdbarch_dump_tdep_ftype *);
1034 /* Return a freshly allocated, NULL terminated, array of the valid
1035 architecture names. Since architectures are registered during the
1036 _initialize phase this function only returns useful information
1037 once initialization has been completed. */
1039 extern const char **gdbarch_printable_names (void);
1042 /* Helper function. Search the list of ARCHES for a GDBARCH that
1043 matches the information provided by INFO. */
1045 extern struct gdbarch_list *gdbarch_list_lookup_by_info (struct gdbarch_list *arches, const struct gdbarch_info *info);
1048 /* Helper function. Create a preliminary ``struct gdbarch''. Perform
1049 basic initialization using values obtained from the INFO and TDEP
1050 parameters. set_gdbarch_*() functions are called to complete the
1051 initialization of the object. */
1053 extern struct gdbarch *gdbarch_alloc (const struct gdbarch_info *info, struct gdbarch_tdep *tdep);
1056 /* Helper function. Free a partially-constructed ``struct gdbarch''.
1057 It is assumed that the caller freeds the ``struct
1058 gdbarch_tdep''. */
1060 extern void gdbarch_free (struct gdbarch *);
1063 /* Helper function. Allocate memory from the ``struct gdbarch''
1064 obstack. The memory is freed when the corresponding architecture
1065 is also freed. */
1067 extern void *gdbarch_obstack_zalloc (struct gdbarch *gdbarch, long size);
1068 #define GDBARCH_OBSTACK_CALLOC(GDBARCH, NR, TYPE) ((TYPE *) gdbarch_obstack_zalloc ((GDBARCH), (NR) * sizeof (TYPE)))
1069 #define GDBARCH_OBSTACK_ZALLOC(GDBARCH, TYPE) ((TYPE *) gdbarch_obstack_zalloc ((GDBARCH), sizeof (TYPE)))
1072 /* Helper function. Force an update of the current architecture.
1074 The actual architecture selected is determined by INFO, ``(gdb) set
1075 architecture'' et.al., the existing architecture and BFD's default
1076 architecture. INFO should be initialized to zero and then selected
1077 fields should be updated.
1079 Returns non-zero if the update succeeds */
1081 extern int gdbarch_update_p (struct gdbarch_info info);
1084 /* Helper function. Find an architecture matching info.
1086 INFO should be initialized using gdbarch_info_init, relevant fields
1087 set, and then finished using gdbarch_info_fill.
1089 Returns the corresponding architecture, or NULL if no matching
1090 architecture was found. */
1092 extern struct gdbarch *gdbarch_find_by_info (struct gdbarch_info info);
1095 /* Helper function. Set the global "target_gdbarch" to "gdbarch".
1097 FIXME: kettenis/20031124: Of the functions that follow, only
1098 gdbarch_from_bfd is supposed to survive. The others will
1099 dissappear since in the future GDB will (hopefully) be truly
1100 multi-arch. However, for now we're still stuck with the concept of
1101 a single active architecture. */
1103 extern void deprecated_target_gdbarch_select_hack (struct gdbarch *gdbarch);
1106 /* Register per-architecture data-pointer.
1108 Reserve space for a per-architecture data-pointer. An identifier
1109 for the reserved data-pointer is returned. That identifer should
1110 be saved in a local static variable.
1112 Memory for the per-architecture data shall be allocated using
1113 gdbarch_obstack_zalloc. That memory will be deleted when the
1114 corresponding architecture object is deleted.
1116 When a previously created architecture is re-selected, the
1117 per-architecture data-pointer for that previous architecture is
1118 restored. INIT() is not re-called.
1120 Multiple registrarants for any architecture are allowed (and
1121 strongly encouraged). */
1123 struct gdbarch_data;
1125 typedef void *(gdbarch_data_pre_init_ftype) (struct obstack *obstack);
1126 extern struct gdbarch_data *gdbarch_data_register_pre_init (gdbarch_data_pre_init_ftype *init);
1127 typedef void *(gdbarch_data_post_init_ftype) (struct gdbarch *gdbarch);
1128 extern struct gdbarch_data *gdbarch_data_register_post_init (gdbarch_data_post_init_ftype *init);
1129 extern void deprecated_set_gdbarch_data (struct gdbarch *gdbarch,
1130 struct gdbarch_data *data,
1131 void *pointer);
1133 extern void *gdbarch_data (struct gdbarch *gdbarch, struct gdbarch_data *);
1136 /* Set the dynamic target-system-dependent parameters (architecture,
1137 byte-order, ...) using information found in the BFD */
1139 extern void set_gdbarch_from_file (bfd *);
1142 /* Initialize the current architecture to the "first" one we find on
1143 our list. */
1145 extern void initialize_current_architecture (void);
1147 /* gdbarch trace variable */
1148 extern int gdbarch_debug;
1150 extern void gdbarch_dump (struct gdbarch *gdbarch, struct ui_file *file);
1152 #endif