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