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