]> git.ipfire.org Git - thirdparty/binutils-gdb.git/blob - gdb/gdbarch.h
2009-09-21 Hui Zhu <teawater@gmail.com>
[thirdparty/binutils-gdb.git] / gdb / gdbarch.h
1 /* *INDENT-OFF* */ /* THIS FILE IS GENERATED */
2
3 /* Dynamic architecture support for GDB, the GNU debugger.
4
5 Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007
6 Free Software Foundation, Inc.
7
8 This file is part of GDB.
9
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
14
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
19
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22
23 /* This file was created with the aid of ``gdbarch.sh''.
24
25 The Bourne shell script ``gdbarch.sh'' creates the files
26 ``new-gdbarch.c'' and ``new-gdbarch.h and then compares them
27 against the existing ``gdbarch.[hc]''. Any differences found
28 being reported.
29
30 If editing this file, please also run gdbarch.sh and merge any
31 changes into that script. Conversely, when making sweeping changes
32 to this file, modifying gdbarch.sh and using its output may prove
33 easier. */
34
35 #ifndef GDBARCH_H
36 #define GDBARCH_H
37
38 struct floatformat;
39 struct ui_file;
40 struct frame_info;
41 struct value;
42 struct objfile;
43 struct obj_section;
44 struct minimal_symbol;
45 struct regcache;
46 struct reggroup;
47 struct regset;
48 struct disassemble_info;
49 struct target_ops;
50 struct obstack;
51 struct bp_target_info;
52 struct target_desc;
53 struct displaced_step_closure;
54 struct core_regset_section;
55 struct syscall;
56
57 /* The architecture associated with the connection to the target.
58
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.
64
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;
68
69
70 /* The following are pre-initialized by GDBARCH. */
71
72 extern const struct bfd_arch_info * gdbarch_bfd_arch_info (struct gdbarch *gdbarch);
73 /* set_gdbarch_bfd_arch_info() - not applicable - pre-initialized. */
74
75 extern int gdbarch_byte_order (struct gdbarch *gdbarch);
76 /* set_gdbarch_byte_order() - not applicable - pre-initialized. */
77
78 extern int gdbarch_byte_order_for_code (struct gdbarch *gdbarch);
79 /* set_gdbarch_byte_order_for_code() - not applicable - pre-initialized. */
80
81 extern enum gdb_osabi gdbarch_osabi (struct gdbarch *gdbarch);
82 /* set_gdbarch_osabi() - not applicable - pre-initialized. */
83
84 extern const struct target_desc * gdbarch_target_desc (struct gdbarch *gdbarch);
85 /* set_gdbarch_target_desc() - not applicable - pre-initialized. */
86
87
88 /* The following are initialized by the target dependent code. */
89
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. */
92
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);
95
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:
99
100 Number of bits in a short or unsigned short for the target machine. */
101
102 extern int gdbarch_short_bit (struct gdbarch *gdbarch);
103 extern void set_gdbarch_short_bit (struct gdbarch *gdbarch, int short_bit);
104
105 /* Number of bits in an int or unsigned int for the target machine. */
106
107 extern int gdbarch_int_bit (struct gdbarch *gdbarch);
108 extern void set_gdbarch_int_bit (struct gdbarch *gdbarch, int int_bit);
109
110 /* Number of bits in a long or unsigned long for the target machine. */
111
112 extern int gdbarch_long_bit (struct gdbarch *gdbarch);
113 extern void set_gdbarch_long_bit (struct gdbarch *gdbarch, int long_bit);
114
115 /* Number of bits in a long long or unsigned long long for the target
116 machine. */
117
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);
120
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). */
126
127 extern int gdbarch_float_bit (struct gdbarch *gdbarch);
128 extern void set_gdbarch_float_bit (struct gdbarch *gdbarch, int float_bit);
129
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);
132
133 extern int gdbarch_double_bit (struct gdbarch *gdbarch);
134 extern void set_gdbarch_double_bit (struct gdbarch *gdbarch, int double_bit);
135
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);
138
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);
141
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);
144
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.
149
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.
153
154 ptr_bit is the size of a pointer on the target */
155
156 extern int gdbarch_ptr_bit (struct gdbarch *gdbarch);
157 extern void set_gdbarch_ptr_bit (struct gdbarch *gdbarch, int ptr_bit);
158
159 /* addr_bit is the size of a target address as represented in gdb */
160
161 extern int gdbarch_addr_bit (struct gdbarch *gdbarch);
162 extern void set_gdbarch_addr_bit (struct gdbarch *gdbarch, int addr_bit);
163
164 /* One if `char' acts like `signed char', zero if `unsigned char'. */
165
166 extern int gdbarch_char_signed (struct gdbarch *gdbarch);
167 extern void set_gdbarch_char_signed (struct gdbarch *gdbarch, int char_signed);
168
169 extern int gdbarch_read_pc_p (struct gdbarch *gdbarch);
170
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);
174
175 extern int gdbarch_write_pc_p (struct gdbarch *gdbarch);
176
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);
180
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. */
184
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);
188
189 extern int gdbarch_pseudo_register_read_p (struct gdbarch *gdbarch);
190
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);
194
195 extern int gdbarch_pseudo_register_write_p (struct gdbarch *gdbarch);
196
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);
200
201 extern int gdbarch_num_regs (struct gdbarch *gdbarch);
202 extern void set_gdbarch_num_regs (struct gdbarch *gdbarch, int num_regs);
203
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. */
208
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);
211
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. */
216
217 extern int gdbarch_sp_regnum (struct gdbarch *gdbarch);
218 extern void set_gdbarch_sp_regnum (struct gdbarch *gdbarch, int sp_regnum);
219
220 extern int gdbarch_pc_regnum (struct gdbarch *gdbarch);
221 extern void set_gdbarch_pc_regnum (struct gdbarch *gdbarch, int pc_regnum);
222
223 extern int gdbarch_ps_regnum (struct gdbarch *gdbarch);
224 extern void set_gdbarch_ps_regnum (struct gdbarch *gdbarch, int ps_regnum);
225
226 extern int gdbarch_fp0_regnum (struct gdbarch *gdbarch);
227 extern void set_gdbarch_fp0_regnum (struct gdbarch *gdbarch, int fp0_regnum);
228
229 /* Convert stab register number (from `r' declaration) to a gdb REGNUM. */
230
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);
234
235 /* Provide a default mapping from a ecoff register number to a gdb REGNUM. */
236
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);
240
241 /* Convert from an sdb register number to an internal gdb register number. */
242
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);
246
247 /* Provide a default mapping from a DWARF2 register number to a gdb REGNUM. */
248
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);
252
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);
256
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". */
260
261 extern int gdbarch_register_type_p (struct gdbarch *gdbarch);
262
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);
266
267 /* See gdbint.texinfo, and PUSH_DUMMY_CALL. */
268
269 extern int gdbarch_dummy_id_p (struct gdbarch *gdbarch);
270
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);
274
275 /* Implement DUMMY_ID and PUSH_DUMMY_CALL, then delete
276 deprecated_fp_regnum. */
277
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);
280
281 /* See gdbint.texinfo. See infcall.c. */
282
283 extern int gdbarch_push_dummy_call_p (struct gdbarch *gdbarch);
284
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);
288
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);
291
292 extern int gdbarch_push_dummy_code_p (struct gdbarch *gdbarch);
293
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);
297
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);
301
302 extern int gdbarch_print_float_info_p (struct gdbarch *gdbarch);
303
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);
307
308 extern int gdbarch_print_vector_info_p (struct gdbarch *gdbarch);
309
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);
313
314 /* MAP a GDB RAW register number onto a simulator register number. See
315 also include/...-sim.h. */
316
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);
320
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);
324
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);
328
329 /* setjmp/longjmp support. */
330
331 extern int gdbarch_get_longjmp_target_p (struct gdbarch *gdbarch);
332
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);
336
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);
339
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);
343
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);
347
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);
351
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. */
356
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);
360
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);
364
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);
368
369 extern int gdbarch_integer_to_address_p (struct gdbarch *gdbarch);
370
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);
374
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.
378
379 If READBUF is not NULL, extract the return value and save it in this buffer.
380
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). */
385
386 extern int gdbarch_return_value_p (struct gdbarch *gdbarch);
387
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);
391
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);
395
396 extern int gdbarch_skip_main_prologue_p (struct gdbarch *gdbarch);
397
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);
401
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);
405
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);
409
410 extern int gdbarch_adjust_breakpoint_address_p (struct gdbarch *gdbarch);
411
412 typedef CORE_ADDR (gdbarch_adjust_breakpoint_address_ftype) (struct gdbarch *gdbarch, CORE_ADDR bpaddr);
413 extern CORE_ADDR gdbarch_adjust_breakpoint_address (struct gdbarch *gdbarch, CORE_ADDR bpaddr);
414 extern void set_gdbarch_adjust_breakpoint_address (struct gdbarch *gdbarch, gdbarch_adjust_breakpoint_address_ftype *adjust_breakpoint_address);
415
416 typedef int (gdbarch_memory_insert_breakpoint_ftype) (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
417 extern int gdbarch_memory_insert_breakpoint (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
418 extern void set_gdbarch_memory_insert_breakpoint (struct gdbarch *gdbarch, gdbarch_memory_insert_breakpoint_ftype *memory_insert_breakpoint);
419
420 typedef int (gdbarch_memory_remove_breakpoint_ftype) (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
421 extern int gdbarch_memory_remove_breakpoint (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
422 extern void set_gdbarch_memory_remove_breakpoint (struct gdbarch *gdbarch, gdbarch_memory_remove_breakpoint_ftype *memory_remove_breakpoint);
423
424 extern CORE_ADDR gdbarch_decr_pc_after_break (struct gdbarch *gdbarch);
425 extern void set_gdbarch_decr_pc_after_break (struct gdbarch *gdbarch, CORE_ADDR decr_pc_after_break);
426
427 /* A function can be addressed by either it's "pointer" (possibly a
428 descriptor address) or "entry point" (first executable instruction).
429 The method "convert_from_func_ptr_addr" converting the former to the
430 latter. gdbarch_deprecated_function_start_offset is being used to implement
431 a simplified subset of that functionality - the function's address
432 corresponds to the "function pointer" and the function's start
433 corresponds to the "function entry point" - and hence is redundant. */
434
435 extern CORE_ADDR gdbarch_deprecated_function_start_offset (struct gdbarch *gdbarch);
436 extern void set_gdbarch_deprecated_function_start_offset (struct gdbarch *gdbarch, CORE_ADDR deprecated_function_start_offset);
437
438 /* Return the remote protocol register number associated with this
439 register. Normally the identity mapping. */
440
441 typedef int (gdbarch_remote_register_number_ftype) (struct gdbarch *gdbarch, int regno);
442 extern int gdbarch_remote_register_number (struct gdbarch *gdbarch, int regno);
443 extern void set_gdbarch_remote_register_number (struct gdbarch *gdbarch, gdbarch_remote_register_number_ftype *remote_register_number);
444
445 /* Fetch the target specific address used to represent a load module. */
446
447 extern int gdbarch_fetch_tls_load_module_address_p (struct gdbarch *gdbarch);
448
449 typedef CORE_ADDR (gdbarch_fetch_tls_load_module_address_ftype) (struct objfile *objfile);
450 extern CORE_ADDR gdbarch_fetch_tls_load_module_address (struct gdbarch *gdbarch, struct objfile *objfile);
451 extern void set_gdbarch_fetch_tls_load_module_address (struct gdbarch *gdbarch, gdbarch_fetch_tls_load_module_address_ftype *fetch_tls_load_module_address);
452
453 extern CORE_ADDR gdbarch_frame_args_skip (struct gdbarch *gdbarch);
454 extern void set_gdbarch_frame_args_skip (struct gdbarch *gdbarch, CORE_ADDR frame_args_skip);
455
456 extern int gdbarch_unwind_pc_p (struct gdbarch *gdbarch);
457
458 typedef CORE_ADDR (gdbarch_unwind_pc_ftype) (struct gdbarch *gdbarch, struct frame_info *next_frame);
459 extern CORE_ADDR gdbarch_unwind_pc (struct gdbarch *gdbarch, struct frame_info *next_frame);
460 extern void set_gdbarch_unwind_pc (struct gdbarch *gdbarch, gdbarch_unwind_pc_ftype *unwind_pc);
461
462 extern int gdbarch_unwind_sp_p (struct gdbarch *gdbarch);
463
464 typedef CORE_ADDR (gdbarch_unwind_sp_ftype) (struct gdbarch *gdbarch, struct frame_info *next_frame);
465 extern CORE_ADDR gdbarch_unwind_sp (struct gdbarch *gdbarch, struct frame_info *next_frame);
466 extern void set_gdbarch_unwind_sp (struct gdbarch *gdbarch, gdbarch_unwind_sp_ftype *unwind_sp);
467
468 /* DEPRECATED_FRAME_LOCALS_ADDRESS as been replaced by the per-frame
469 frame-base. Enable frame-base before frame-unwind. */
470
471 extern int gdbarch_frame_num_args_p (struct gdbarch *gdbarch);
472
473 typedef int (gdbarch_frame_num_args_ftype) (struct frame_info *frame);
474 extern int gdbarch_frame_num_args (struct gdbarch *gdbarch, struct frame_info *frame);
475 extern void set_gdbarch_frame_num_args (struct gdbarch *gdbarch, gdbarch_frame_num_args_ftype *frame_num_args);
476
477 extern int gdbarch_frame_align_p (struct gdbarch *gdbarch);
478
479 typedef CORE_ADDR (gdbarch_frame_align_ftype) (struct gdbarch *gdbarch, CORE_ADDR address);
480 extern CORE_ADDR gdbarch_frame_align (struct gdbarch *gdbarch, CORE_ADDR address);
481 extern void set_gdbarch_frame_align (struct gdbarch *gdbarch, gdbarch_frame_align_ftype *frame_align);
482
483 typedef int (gdbarch_stabs_argument_has_addr_ftype) (struct gdbarch *gdbarch, struct type *type);
484 extern int gdbarch_stabs_argument_has_addr (struct gdbarch *gdbarch, struct type *type);
485 extern void set_gdbarch_stabs_argument_has_addr (struct gdbarch *gdbarch, gdbarch_stabs_argument_has_addr_ftype *stabs_argument_has_addr);
486
487 extern int gdbarch_frame_red_zone_size (struct gdbarch *gdbarch);
488 extern void set_gdbarch_frame_red_zone_size (struct gdbarch *gdbarch, int frame_red_zone_size);
489
490 typedef CORE_ADDR (gdbarch_convert_from_func_ptr_addr_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr, struct target_ops *targ);
491 extern CORE_ADDR gdbarch_convert_from_func_ptr_addr (struct gdbarch *gdbarch, CORE_ADDR addr, struct target_ops *targ);
492 extern void set_gdbarch_convert_from_func_ptr_addr (struct gdbarch *gdbarch, gdbarch_convert_from_func_ptr_addr_ftype *convert_from_func_ptr_addr);
493
494 /* On some machines there are bits in addresses which are not really
495 part of the address, but are used by the kernel, the hardware, etc.
496 for special purposes. gdbarch_addr_bits_remove takes out any such bits so
497 we get a "real" address such as one would find in a symbol table.
498 This is used only for addresses of instructions, and even then I'm
499 not sure it's used in all contexts. It exists to deal with there
500 being a few stray bits in the PC which would mislead us, not as some
501 sort of generic thing to handle alignment or segmentation (it's
502 possible it should be in TARGET_READ_PC instead). */
503
504 typedef CORE_ADDR (gdbarch_addr_bits_remove_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
505 extern CORE_ADDR gdbarch_addr_bits_remove (struct gdbarch *gdbarch, CORE_ADDR addr);
506 extern void set_gdbarch_addr_bits_remove (struct gdbarch *gdbarch, gdbarch_addr_bits_remove_ftype *addr_bits_remove);
507
508 /* It is not at all clear why gdbarch_smash_text_address is not folded into
509 gdbarch_addr_bits_remove. */
510
511 typedef CORE_ADDR (gdbarch_smash_text_address_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
512 extern CORE_ADDR gdbarch_smash_text_address (struct gdbarch *gdbarch, CORE_ADDR addr);
513 extern void set_gdbarch_smash_text_address (struct gdbarch *gdbarch, gdbarch_smash_text_address_ftype *smash_text_address);
514
515 /* FIXME/cagney/2001-01-18: This should be split in two. A target method that
516 indicates if the target needs software single step. An ISA method to
517 implement it.
518
519 FIXME/cagney/2001-01-18: This should be replaced with something that inserts
520 breakpoints using the breakpoint system instead of blatting memory directly
521 (as with rs6000).
522
523 FIXME/cagney/2001-01-18: The logic is backwards. It should be asking if the
524 target can single step. If not, then implement single step using breakpoints.
525
526 A return value of 1 means that the software_single_step breakpoints
527 were inserted; 0 means they were not. */
528
529 extern int gdbarch_software_single_step_p (struct gdbarch *gdbarch);
530
531 typedef int (gdbarch_software_single_step_ftype) (struct frame_info *frame);
532 extern int gdbarch_software_single_step (struct gdbarch *gdbarch, struct frame_info *frame);
533 extern void set_gdbarch_software_single_step (struct gdbarch *gdbarch, gdbarch_software_single_step_ftype *software_single_step);
534
535 /* Return non-zero if the processor is executing a delay slot and a
536 further single-step is needed before the instruction finishes. */
537
538 extern int gdbarch_single_step_through_delay_p (struct gdbarch *gdbarch);
539
540 typedef int (gdbarch_single_step_through_delay_ftype) (struct gdbarch *gdbarch, struct frame_info *frame);
541 extern int gdbarch_single_step_through_delay (struct gdbarch *gdbarch, struct frame_info *frame);
542 extern void set_gdbarch_single_step_through_delay (struct gdbarch *gdbarch, gdbarch_single_step_through_delay_ftype *single_step_through_delay);
543
544 /* FIXME: cagney/2003-08-28: Need to find a better way of selecting the
545 disassembler. Perhaps objdump can handle it? */
546
547 typedef int (gdbarch_print_insn_ftype) (bfd_vma vma, struct disassemble_info *info);
548 extern int gdbarch_print_insn (struct gdbarch *gdbarch, bfd_vma vma, struct disassemble_info *info);
549 extern void set_gdbarch_print_insn (struct gdbarch *gdbarch, gdbarch_print_insn_ftype *print_insn);
550
551 typedef CORE_ADDR (gdbarch_skip_trampoline_code_ftype) (struct frame_info *frame, CORE_ADDR pc);
552 extern CORE_ADDR gdbarch_skip_trampoline_code (struct gdbarch *gdbarch, struct frame_info *frame, CORE_ADDR pc);
553 extern void set_gdbarch_skip_trampoline_code (struct gdbarch *gdbarch, gdbarch_skip_trampoline_code_ftype *skip_trampoline_code);
554
555 /* If in_solib_dynsym_resolve_code() returns true, and SKIP_SOLIB_RESOLVER
556 evaluates non-zero, this is the address where the debugger will place
557 a step-resume breakpoint to get us past the dynamic linker. */
558
559 typedef CORE_ADDR (gdbarch_skip_solib_resolver_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc);
560 extern CORE_ADDR gdbarch_skip_solib_resolver (struct gdbarch *gdbarch, CORE_ADDR pc);
561 extern void set_gdbarch_skip_solib_resolver (struct gdbarch *gdbarch, gdbarch_skip_solib_resolver_ftype *skip_solib_resolver);
562
563 /* Some systems also have trampoline code for returning from shared libs. */
564
565 typedef int (gdbarch_in_solib_return_trampoline_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc, char *name);
566 extern int gdbarch_in_solib_return_trampoline (struct gdbarch *gdbarch, CORE_ADDR pc, char *name);
567 extern void set_gdbarch_in_solib_return_trampoline (struct gdbarch *gdbarch, gdbarch_in_solib_return_trampoline_ftype *in_solib_return_trampoline);
568
569 /* A target might have problems with watchpoints as soon as the stack
570 frame of the current function has been destroyed. This mostly happens
571 as the first action in a funtion's epilogue. in_function_epilogue_p()
572 is defined to return a non-zero value if either the given addr is one
573 instruction after the stack destroying instruction up to the trailing
574 return instruction or if we can figure out that the stack frame has
575 already been invalidated regardless of the value of addr. Targets
576 which don't suffer from that problem could just let this functionality
577 untouched. */
578
579 typedef int (gdbarch_in_function_epilogue_p_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
580 extern int gdbarch_in_function_epilogue_p (struct gdbarch *gdbarch, CORE_ADDR addr);
581 extern void set_gdbarch_in_function_epilogue_p (struct gdbarch *gdbarch, gdbarch_in_function_epilogue_p_ftype *in_function_epilogue_p);
582
583 typedef void (gdbarch_elf_make_msymbol_special_ftype) (asymbol *sym, struct minimal_symbol *msym);
584 extern void gdbarch_elf_make_msymbol_special (struct gdbarch *gdbarch, asymbol *sym, struct minimal_symbol *msym);
585 extern void set_gdbarch_elf_make_msymbol_special (struct gdbarch *gdbarch, gdbarch_elf_make_msymbol_special_ftype *elf_make_msymbol_special);
586
587 typedef void (gdbarch_coff_make_msymbol_special_ftype) (int val, struct minimal_symbol *msym);
588 extern void gdbarch_coff_make_msymbol_special (struct gdbarch *gdbarch, int val, struct minimal_symbol *msym);
589 extern void set_gdbarch_coff_make_msymbol_special (struct gdbarch *gdbarch, gdbarch_coff_make_msymbol_special_ftype *coff_make_msymbol_special);
590
591 extern int gdbarch_cannot_step_breakpoint (struct gdbarch *gdbarch);
592 extern void set_gdbarch_cannot_step_breakpoint (struct gdbarch *gdbarch, int cannot_step_breakpoint);
593
594 extern int gdbarch_have_nonsteppable_watchpoint (struct gdbarch *gdbarch);
595 extern void set_gdbarch_have_nonsteppable_watchpoint (struct gdbarch *gdbarch, int have_nonsteppable_watchpoint);
596
597 extern int gdbarch_address_class_type_flags_p (struct gdbarch *gdbarch);
598
599 typedef int (gdbarch_address_class_type_flags_ftype) (int byte_size, int dwarf2_addr_class);
600 extern int gdbarch_address_class_type_flags (struct gdbarch *gdbarch, int byte_size, int dwarf2_addr_class);
601 extern void set_gdbarch_address_class_type_flags (struct gdbarch *gdbarch, gdbarch_address_class_type_flags_ftype *address_class_type_flags);
602
603 extern int gdbarch_address_class_type_flags_to_name_p (struct gdbarch *gdbarch);
604
605 typedef const char * (gdbarch_address_class_type_flags_to_name_ftype) (struct gdbarch *gdbarch, int type_flags);
606 extern const char * gdbarch_address_class_type_flags_to_name (struct gdbarch *gdbarch, int type_flags);
607 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);
608
609 extern int gdbarch_address_class_name_to_type_flags_p (struct gdbarch *gdbarch);
610
611 typedef int (gdbarch_address_class_name_to_type_flags_ftype) (struct gdbarch *gdbarch, const char *name, int *type_flags_ptr);
612 extern int gdbarch_address_class_name_to_type_flags (struct gdbarch *gdbarch, const char *name, int *type_flags_ptr);
613 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);
614
615 /* Is a register in a group */
616
617 typedef int (gdbarch_register_reggroup_p_ftype) (struct gdbarch *gdbarch, int regnum, struct reggroup *reggroup);
618 extern int gdbarch_register_reggroup_p (struct gdbarch *gdbarch, int regnum, struct reggroup *reggroup);
619 extern void set_gdbarch_register_reggroup_p (struct gdbarch *gdbarch, gdbarch_register_reggroup_p_ftype *register_reggroup_p);
620
621 /* Fetch the pointer to the ith function argument. */
622
623 extern int gdbarch_fetch_pointer_argument_p (struct gdbarch *gdbarch);
624
625 typedef CORE_ADDR (gdbarch_fetch_pointer_argument_ftype) (struct frame_info *frame, int argi, struct type *type);
626 extern CORE_ADDR gdbarch_fetch_pointer_argument (struct gdbarch *gdbarch, struct frame_info *frame, int argi, struct type *type);
627 extern void set_gdbarch_fetch_pointer_argument (struct gdbarch *gdbarch, gdbarch_fetch_pointer_argument_ftype *fetch_pointer_argument);
628
629 /* Return the appropriate register set for a core file section with
630 name SECT_NAME and size SECT_SIZE. */
631
632 extern int gdbarch_regset_from_core_section_p (struct gdbarch *gdbarch);
633
634 typedef const struct regset * (gdbarch_regset_from_core_section_ftype) (struct gdbarch *gdbarch, const char *sect_name, size_t sect_size);
635 extern const struct regset * gdbarch_regset_from_core_section (struct gdbarch *gdbarch, const char *sect_name, size_t sect_size);
636 extern void set_gdbarch_regset_from_core_section (struct gdbarch *gdbarch, gdbarch_regset_from_core_section_ftype *regset_from_core_section);
637
638 /* When creating core dumps, some systems encode the PID in addition
639 to the LWP id in core file register section names. In those cases, the
640 "XXX" in ".reg/XXX" is encoded as [LWPID << 16 | PID]. This setting
641 is set to true for such architectures; false if "XXX" represents an LWP
642 or thread id with no special encoding. */
643
644 extern int gdbarch_core_reg_section_encodes_pid (struct gdbarch *gdbarch);
645 extern void set_gdbarch_core_reg_section_encodes_pid (struct gdbarch *gdbarch, int core_reg_section_encodes_pid);
646
647 /* Supported register notes in a core file. */
648
649 extern struct core_regset_section * gdbarch_core_regset_sections (struct gdbarch *gdbarch);
650 extern void set_gdbarch_core_regset_sections (struct gdbarch *gdbarch, struct core_regset_section * core_regset_sections);
651
652 /* Read offset OFFSET of TARGET_OBJECT_LIBRARIES formatted shared libraries list from
653 core file into buffer READBUF with length LEN. */
654
655 extern int gdbarch_core_xfer_shared_libraries_p (struct gdbarch *gdbarch);
656
657 typedef LONGEST (gdbarch_core_xfer_shared_libraries_ftype) (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, LONGEST len);
658 extern LONGEST gdbarch_core_xfer_shared_libraries (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, LONGEST len);
659 extern void set_gdbarch_core_xfer_shared_libraries (struct gdbarch *gdbarch, gdbarch_core_xfer_shared_libraries_ftype *core_xfer_shared_libraries);
660
661 /* How the core_stratum layer converts a PTID from a core file to a
662 string. */
663
664 extern int gdbarch_core_pid_to_str_p (struct gdbarch *gdbarch);
665
666 typedef char * (gdbarch_core_pid_to_str_ftype) (struct gdbarch *gdbarch, ptid_t ptid);
667 extern char * gdbarch_core_pid_to_str (struct gdbarch *gdbarch, ptid_t ptid);
668 extern void set_gdbarch_core_pid_to_str (struct gdbarch *gdbarch, gdbarch_core_pid_to_str_ftype *core_pid_to_str);
669
670 /* BFD target to use when generating a core file. */
671
672 extern int gdbarch_gcore_bfd_target_p (struct gdbarch *gdbarch);
673
674 extern const char * gdbarch_gcore_bfd_target (struct gdbarch *gdbarch);
675 extern void set_gdbarch_gcore_bfd_target (struct gdbarch *gdbarch, const char * gcore_bfd_target);
676
677 /* If the elements of C++ vtables are in-place function descriptors rather
678 than normal function pointers (which may point to code or a descriptor),
679 set this to one. */
680
681 extern int gdbarch_vtable_function_descriptors (struct gdbarch *gdbarch);
682 extern void set_gdbarch_vtable_function_descriptors (struct gdbarch *gdbarch, int vtable_function_descriptors);
683
684 /* Set if the least significant bit of the delta is used instead of the least
685 significant bit of the pfn for pointers to virtual member functions. */
686
687 extern int gdbarch_vbit_in_delta (struct gdbarch *gdbarch);
688 extern void set_gdbarch_vbit_in_delta (struct gdbarch *gdbarch, int vbit_in_delta);
689
690 /* Advance PC to next instruction in order to skip a permanent breakpoint. */
691
692 extern int gdbarch_skip_permanent_breakpoint_p (struct gdbarch *gdbarch);
693
694 typedef void (gdbarch_skip_permanent_breakpoint_ftype) (struct regcache *regcache);
695 extern void gdbarch_skip_permanent_breakpoint (struct gdbarch *gdbarch, struct regcache *regcache);
696 extern void set_gdbarch_skip_permanent_breakpoint (struct gdbarch *gdbarch, gdbarch_skip_permanent_breakpoint_ftype *skip_permanent_breakpoint);
697
698 /* The maximum length of an instruction on this architecture. */
699
700 extern int gdbarch_max_insn_length_p (struct gdbarch *gdbarch);
701
702 extern ULONGEST gdbarch_max_insn_length (struct gdbarch *gdbarch);
703 extern void set_gdbarch_max_insn_length (struct gdbarch *gdbarch, ULONGEST max_insn_length);
704
705 /* Copy the instruction at FROM to TO, and make any adjustments
706 necessary to single-step it at that address.
707
708 REGS holds the state the thread's registers will have before
709 executing the copied instruction; the PC in REGS will refer to FROM,
710 not the copy at TO. The caller should update it to point at TO later.
711
712 Return a pointer to data of the architecture's choice to be passed
713 to gdbarch_displaced_step_fixup. Or, return NULL to indicate that
714 the instruction's effects have been completely simulated, with the
715 resulting state written back to REGS.
716
717 For a general explanation of displaced stepping and how GDB uses it,
718 see the comments in infrun.c.
719
720 The TO area is only guaranteed to have space for
721 gdbarch_max_insn_length (arch) bytes, so this function must not
722 write more bytes than that to that area.
723
724 If you do not provide this function, GDB assumes that the
725 architecture does not support displaced stepping.
726
727 If your architecture doesn't need to adjust instructions before
728 single-stepping them, consider using simple_displaced_step_copy_insn
729 here. */
730
731 extern int gdbarch_displaced_step_copy_insn_p (struct gdbarch *gdbarch);
732
733 typedef struct displaced_step_closure * (gdbarch_displaced_step_copy_insn_ftype) (struct gdbarch *gdbarch, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
734 extern struct displaced_step_closure * gdbarch_displaced_step_copy_insn (struct gdbarch *gdbarch, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
735 extern void set_gdbarch_displaced_step_copy_insn (struct gdbarch *gdbarch, gdbarch_displaced_step_copy_insn_ftype *displaced_step_copy_insn);
736
737 /* Fix up the state resulting from successfully single-stepping a
738 displaced instruction, to give the result we would have gotten from
739 stepping the instruction in its original location.
740
741 REGS is the register state resulting from single-stepping the
742 displaced instruction.
743
744 CLOSURE is the result from the matching call to
745 gdbarch_displaced_step_copy_insn.
746
747 If you provide gdbarch_displaced_step_copy_insn.but not this
748 function, then GDB assumes that no fixup is needed after
749 single-stepping the instruction.
750
751 For a general explanation of displaced stepping and how GDB uses it,
752 see the comments in infrun.c. */
753
754 extern int gdbarch_displaced_step_fixup_p (struct gdbarch *gdbarch);
755
756 typedef void (gdbarch_displaced_step_fixup_ftype) (struct gdbarch *gdbarch, struct displaced_step_closure *closure, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
757 extern void gdbarch_displaced_step_fixup (struct gdbarch *gdbarch, struct displaced_step_closure *closure, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
758 extern void set_gdbarch_displaced_step_fixup (struct gdbarch *gdbarch, gdbarch_displaced_step_fixup_ftype *displaced_step_fixup);
759
760 /* Free a closure returned by gdbarch_displaced_step_copy_insn.
761
762 If you provide gdbarch_displaced_step_copy_insn, you must provide
763 this function as well.
764
765 If your architecture uses closures that don't need to be freed, then
766 you can use simple_displaced_step_free_closure here.
767
768 For a general explanation of displaced stepping and how GDB uses it,
769 see the comments in infrun.c. */
770
771 typedef void (gdbarch_displaced_step_free_closure_ftype) (struct gdbarch *gdbarch, struct displaced_step_closure *closure);
772 extern void gdbarch_displaced_step_free_closure (struct gdbarch *gdbarch, struct displaced_step_closure *closure);
773 extern void set_gdbarch_displaced_step_free_closure (struct gdbarch *gdbarch, gdbarch_displaced_step_free_closure_ftype *displaced_step_free_closure);
774
775 /* Return the address of an appropriate place to put displaced
776 instructions while we step over them. There need only be one such
777 place, since we're only stepping one thread over a breakpoint at a
778 time.
779
780 For a general explanation of displaced stepping and how GDB uses it,
781 see the comments in infrun.c. */
782
783 typedef CORE_ADDR (gdbarch_displaced_step_location_ftype) (struct gdbarch *gdbarch);
784 extern CORE_ADDR gdbarch_displaced_step_location (struct gdbarch *gdbarch);
785 extern void set_gdbarch_displaced_step_location (struct gdbarch *gdbarch, gdbarch_displaced_step_location_ftype *displaced_step_location);
786
787 /* Refresh overlay mapped state for section OSECT. */
788
789 extern int gdbarch_overlay_update_p (struct gdbarch *gdbarch);
790
791 typedef void (gdbarch_overlay_update_ftype) (struct obj_section *osect);
792 extern void gdbarch_overlay_update (struct gdbarch *gdbarch, struct obj_section *osect);
793 extern void set_gdbarch_overlay_update (struct gdbarch *gdbarch, gdbarch_overlay_update_ftype *overlay_update);
794
795 extern int gdbarch_core_read_description_p (struct gdbarch *gdbarch);
796
797 typedef const struct target_desc * (gdbarch_core_read_description_ftype) (struct gdbarch *gdbarch, struct target_ops *target, bfd *abfd);
798 extern const struct target_desc * gdbarch_core_read_description (struct gdbarch *gdbarch, struct target_ops *target, bfd *abfd);
799 extern void set_gdbarch_core_read_description (struct gdbarch *gdbarch, gdbarch_core_read_description_ftype *core_read_description);
800
801 /* Handle special encoding of static variables in stabs debug info. */
802
803 extern int gdbarch_static_transform_name_p (struct gdbarch *gdbarch);
804
805 typedef char * (gdbarch_static_transform_name_ftype) (char *name);
806 extern char * gdbarch_static_transform_name (struct gdbarch *gdbarch, char *name);
807 extern void set_gdbarch_static_transform_name (struct gdbarch *gdbarch, gdbarch_static_transform_name_ftype *static_transform_name);
808
809 /* Set if the address in N_SO or N_FUN stabs may be zero. */
810
811 extern int gdbarch_sofun_address_maybe_missing (struct gdbarch *gdbarch);
812 extern void set_gdbarch_sofun_address_maybe_missing (struct gdbarch *gdbarch, int sofun_address_maybe_missing);
813
814 /* Parse the instruction at ADDR storing in the record execution log
815 the registers REGCACHE and memory ranges that will be affected when
816 the instruction executes, along with their current values.
817 Return -1 if something goes wrong, 0 otherwise. */
818
819 extern int gdbarch_process_record_p (struct gdbarch *gdbarch);
820
821 typedef int (gdbarch_process_record_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr);
822 extern int gdbarch_process_record (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr);
823 extern void set_gdbarch_process_record (struct gdbarch *gdbarch, gdbarch_process_record_ftype *process_record);
824
825 /* Save process state after a signal.
826 Return -1 if something goes wrong, 0 otherwise. */
827
828 extern int gdbarch_process_record_signal_p (struct gdbarch *gdbarch);
829
830 typedef int (gdbarch_process_record_signal_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, enum target_signal signal);
831 extern int gdbarch_process_record_signal (struct gdbarch *gdbarch, struct regcache *regcache, enum target_signal signal);
832 extern void set_gdbarch_process_record_signal (struct gdbarch *gdbarch, gdbarch_process_record_signal_ftype *process_record_signal);
833
834 /* Signal translation: translate inferior's signal (host's) number into
835 GDB's representation. */
836
837 typedef enum target_signal (gdbarch_target_signal_from_host_ftype) (struct gdbarch *gdbarch, int signo);
838 extern enum target_signal gdbarch_target_signal_from_host (struct gdbarch *gdbarch, int signo);
839 extern void set_gdbarch_target_signal_from_host (struct gdbarch *gdbarch, gdbarch_target_signal_from_host_ftype *target_signal_from_host);
840
841 /* Signal translation: translate GDB's signal number into inferior's host
842 signal number. */
843
844 typedef int (gdbarch_target_signal_to_host_ftype) (struct gdbarch *gdbarch, enum target_signal ts);
845 extern int gdbarch_target_signal_to_host (struct gdbarch *gdbarch, enum target_signal ts);
846 extern void set_gdbarch_target_signal_to_host (struct gdbarch *gdbarch, gdbarch_target_signal_to_host_ftype *target_signal_to_host);
847
848 /* Extra signal info inspection.
849
850 Return a type suitable to inspect extra signal information. */
851
852 extern int gdbarch_get_siginfo_type_p (struct gdbarch *gdbarch);
853
854 typedef struct type * (gdbarch_get_siginfo_type_ftype) (struct gdbarch *gdbarch);
855 extern struct type * gdbarch_get_siginfo_type (struct gdbarch *gdbarch);
856 extern void set_gdbarch_get_siginfo_type (struct gdbarch *gdbarch, gdbarch_get_siginfo_type_ftype *get_siginfo_type);
857
858 /* Record architecture-specific information from the symbol table. */
859
860 extern int gdbarch_record_special_symbol_p (struct gdbarch *gdbarch);
861
862 typedef void (gdbarch_record_special_symbol_ftype) (struct gdbarch *gdbarch, struct objfile *objfile, asymbol *sym);
863 extern void gdbarch_record_special_symbol (struct gdbarch *gdbarch, struct objfile *objfile, asymbol *sym);
864 extern void set_gdbarch_record_special_symbol (struct gdbarch *gdbarch, gdbarch_record_special_symbol_ftype *record_special_symbol);
865
866 /* Function for the 'catch syscall' feature.
867 Get architecture-specific system calls information from registers. */
868
869 extern int gdbarch_get_syscall_number_p (struct gdbarch *gdbarch);
870
871 typedef LONGEST (gdbarch_get_syscall_number_ftype) (struct gdbarch *gdbarch, ptid_t ptid);
872 extern LONGEST gdbarch_get_syscall_number (struct gdbarch *gdbarch, ptid_t ptid);
873 extern void set_gdbarch_get_syscall_number (struct gdbarch *gdbarch, gdbarch_get_syscall_number_ftype *get_syscall_number);
874
875 /* True if the list of shared libraries is one and only for all
876 processes, as opposed to a list of shared libraries per inferior.
877 This usually means that all processes, although may or may not share
878 an address space, will see the same set of symbols at the same
879 addresses. */
880
881 extern int gdbarch_has_global_solist (struct gdbarch *gdbarch);
882 extern void set_gdbarch_has_global_solist (struct gdbarch *gdbarch, int has_global_solist);
883
884 /* On some targets, even though each inferior has its own private
885 address space, the debug interface takes care of making breakpoints
886 visible to all address spaces automatically. For such cases,
887 this property should be set to true. */
888
889 extern int gdbarch_has_global_breakpoints (struct gdbarch *gdbarch);
890 extern void set_gdbarch_has_global_breakpoints (struct gdbarch *gdbarch, int has_global_breakpoints);
891
892 /* Definition for an unknown syscall, used basically in error-cases. */
893 #define UNKNOWN_SYSCALL (-1)
894
895 extern struct gdbarch_tdep *gdbarch_tdep (struct gdbarch *gdbarch);
896
897
898 /* Mechanism for co-ordinating the selection of a specific
899 architecture.
900
901 GDB targets (*-tdep.c) can register an interest in a specific
902 architecture. Other GDB components can register a need to maintain
903 per-architecture data.
904
905 The mechanisms below ensures that there is only a loose connection
906 between the set-architecture command and the various GDB
907 components. Each component can independently register their need
908 to maintain architecture specific data with gdbarch.
909
910 Pragmatics:
911
912 Previously, a single TARGET_ARCHITECTURE_HOOK was provided. It
913 didn't scale.
914
915 The more traditional mega-struct containing architecture specific
916 data for all the various GDB components was also considered. Since
917 GDB is built from a variable number of (fairly independent)
918 components it was determined that the global aproach was not
919 applicable. */
920
921
922 /* Register a new architectural family with GDB.
923
924 Register support for the specified ARCHITECTURE with GDB. When
925 gdbarch determines that the specified architecture has been
926 selected, the corresponding INIT function is called.
927
928 --
929
930 The INIT function takes two parameters: INFO which contains the
931 information available to gdbarch about the (possibly new)
932 architecture; ARCHES which is a list of the previously created
933 ``struct gdbarch'' for this architecture.
934
935 The INFO parameter is, as far as possible, be pre-initialized with
936 information obtained from INFO.ABFD or the global defaults.
937
938 The ARCHES parameter is a linked list (sorted most recently used)
939 of all the previously created architures for this architecture
940 family. The (possibly NULL) ARCHES->gdbarch can used to access
941 values from the previously selected architecture for this
942 architecture family.
943
944 The INIT function shall return any of: NULL - indicating that it
945 doesn't recognize the selected architecture; an existing ``struct
946 gdbarch'' from the ARCHES list - indicating that the new
947 architecture is just a synonym for an earlier architecture (see
948 gdbarch_list_lookup_by_info()); a newly created ``struct gdbarch''
949 - that describes the selected architecture (see gdbarch_alloc()).
950
951 The DUMP_TDEP function shall print out all target specific values.
952 Care should be taken to ensure that the function works in both the
953 multi-arch and non- multi-arch cases. */
954
955 struct gdbarch_list
956 {
957 struct gdbarch *gdbarch;
958 struct gdbarch_list *next;
959 };
960
961 struct gdbarch_info
962 {
963 /* Use default: NULL (ZERO). */
964 const struct bfd_arch_info *bfd_arch_info;
965
966 /* Use default: BFD_ENDIAN_UNKNOWN (NB: is not ZERO). */
967 int byte_order;
968
969 int byte_order_for_code;
970
971 /* Use default: NULL (ZERO). */
972 bfd *abfd;
973
974 /* Use default: NULL (ZERO). */
975 struct gdbarch_tdep_info *tdep_info;
976
977 /* Use default: GDB_OSABI_UNINITIALIZED (-1). */
978 enum gdb_osabi osabi;
979
980 /* Use default: NULL (ZERO). */
981 const struct target_desc *target_desc;
982 };
983
984 typedef struct gdbarch *(gdbarch_init_ftype) (struct gdbarch_info info, struct gdbarch_list *arches);
985 typedef void (gdbarch_dump_tdep_ftype) (struct gdbarch *gdbarch, struct ui_file *file);
986
987 /* DEPRECATED - use gdbarch_register() */
988 extern void register_gdbarch_init (enum bfd_architecture architecture, gdbarch_init_ftype *);
989
990 extern void gdbarch_register (enum bfd_architecture architecture,
991 gdbarch_init_ftype *,
992 gdbarch_dump_tdep_ftype *);
993
994
995 /* Return a freshly allocated, NULL terminated, array of the valid
996 architecture names. Since architectures are registered during the
997 _initialize phase this function only returns useful information
998 once initialization has been completed. */
999
1000 extern const char **gdbarch_printable_names (void);
1001
1002
1003 /* Helper function. Search the list of ARCHES for a GDBARCH that
1004 matches the information provided by INFO. */
1005
1006 extern struct gdbarch_list *gdbarch_list_lookup_by_info (struct gdbarch_list *arches, const struct gdbarch_info *info);
1007
1008
1009 /* Helper function. Create a preliminary ``struct gdbarch''. Perform
1010 basic initialization using values obtained from the INFO and TDEP
1011 parameters. set_gdbarch_*() functions are called to complete the
1012 initialization of the object. */
1013
1014 extern struct gdbarch *gdbarch_alloc (const struct gdbarch_info *info, struct gdbarch_tdep *tdep);
1015
1016
1017 /* Helper function. Free a partially-constructed ``struct gdbarch''.
1018 It is assumed that the caller freeds the ``struct
1019 gdbarch_tdep''. */
1020
1021 extern void gdbarch_free (struct gdbarch *);
1022
1023
1024 /* Helper function. Allocate memory from the ``struct gdbarch''
1025 obstack. The memory is freed when the corresponding architecture
1026 is also freed. */
1027
1028 extern void *gdbarch_obstack_zalloc (struct gdbarch *gdbarch, long size);
1029 #define GDBARCH_OBSTACK_CALLOC(GDBARCH, NR, TYPE) ((TYPE *) gdbarch_obstack_zalloc ((GDBARCH), (NR) * sizeof (TYPE)))
1030 #define GDBARCH_OBSTACK_ZALLOC(GDBARCH, TYPE) ((TYPE *) gdbarch_obstack_zalloc ((GDBARCH), sizeof (TYPE)))
1031
1032
1033 /* Helper function. Force an update of the current architecture.
1034
1035 The actual architecture selected is determined by INFO, ``(gdb) set
1036 architecture'' et.al., the existing architecture and BFD's default
1037 architecture. INFO should be initialized to zero and then selected
1038 fields should be updated.
1039
1040 Returns non-zero if the update succeeds */
1041
1042 extern int gdbarch_update_p (struct gdbarch_info info);
1043
1044
1045 /* Helper function. Find an architecture matching info.
1046
1047 INFO should be initialized using gdbarch_info_init, relevant fields
1048 set, and then finished using gdbarch_info_fill.
1049
1050 Returns the corresponding architecture, or NULL if no matching
1051 architecture was found. */
1052
1053 extern struct gdbarch *gdbarch_find_by_info (struct gdbarch_info info);
1054
1055
1056 /* Helper function. Set the global "target_gdbarch" to "gdbarch".
1057
1058 FIXME: kettenis/20031124: Of the functions that follow, only
1059 gdbarch_from_bfd is supposed to survive. The others will
1060 dissappear since in the future GDB will (hopefully) be truly
1061 multi-arch. However, for now we're still stuck with the concept of
1062 a single active architecture. */
1063
1064 extern void deprecated_target_gdbarch_select_hack (struct gdbarch *gdbarch);
1065
1066
1067 /* Register per-architecture data-pointer.
1068
1069 Reserve space for a per-architecture data-pointer. An identifier
1070 for the reserved data-pointer is returned. That identifer should
1071 be saved in a local static variable.
1072
1073 Memory for the per-architecture data shall be allocated using
1074 gdbarch_obstack_zalloc. That memory will be deleted when the
1075 corresponding architecture object is deleted.
1076
1077 When a previously created architecture is re-selected, the
1078 per-architecture data-pointer for that previous architecture is
1079 restored. INIT() is not re-called.
1080
1081 Multiple registrarants for any architecture are allowed (and
1082 strongly encouraged). */
1083
1084 struct gdbarch_data;
1085
1086 typedef void *(gdbarch_data_pre_init_ftype) (struct obstack *obstack);
1087 extern struct gdbarch_data *gdbarch_data_register_pre_init (gdbarch_data_pre_init_ftype *init);
1088 typedef void *(gdbarch_data_post_init_ftype) (struct gdbarch *gdbarch);
1089 extern struct gdbarch_data *gdbarch_data_register_post_init (gdbarch_data_post_init_ftype *init);
1090 extern void deprecated_set_gdbarch_data (struct gdbarch *gdbarch,
1091 struct gdbarch_data *data,
1092 void *pointer);
1093
1094 extern void *gdbarch_data (struct gdbarch *gdbarch, struct gdbarch_data *);
1095
1096
1097 /* Set the dynamic target-system-dependent parameters (architecture,
1098 byte-order, ...) using information found in the BFD */
1099
1100 extern void set_gdbarch_from_file (bfd *);
1101
1102
1103 /* Initialize the current architecture to the "first" one we find on
1104 our list. */
1105
1106 extern void initialize_current_architecture (void);
1107
1108 /* gdbarch trace variable */
1109 extern int gdbarch_debug;
1110
1111 extern void gdbarch_dump (struct gdbarch *gdbarch, struct ui_file *file);
1112
1113 #endif