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