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