GDB: Add ChangeLog entry inadvertently omitted from commit.
[external/binutils.git] / gdb / gdbarch.h
1 /* *INDENT-OFF* */ /* THIS FILE IS GENERATED -*- buffer-read-only: t -*- */
2 /* vi:set ro: */
3
4 /* Dynamic architecture support for GDB, the GNU debugger.
5
6    Copyright (C) 1998-2018 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 #include <vector>
39 #include "frame.h"
40 #include "dis-asm.h"
41 #include "gdb_obstack.h"
42
43 struct floatformat;
44 struct ui_file;
45 struct value;
46 struct objfile;
47 struct obj_section;
48 struct minimal_symbol;
49 struct regcache;
50 struct reggroup;
51 struct regset;
52 struct disassemble_info;
53 struct target_ops;
54 struct obstack;
55 struct bp_target_info;
56 struct target_desc;
57 struct symbol;
58 struct displaced_step_closure;
59 struct syscall;
60 struct agent_expr;
61 struct axs_value;
62 struct stap_parse_info;
63 struct parser_state;
64 struct ravenscar_arch_ops;
65 struct mem_range;
66 struct syscalls_info;
67 struct thread_info;
68 struct ui_out;
69
70 #include "regcache.h"
71
72 /* The architecture associated with the inferior through the
73    connection to the target.
74
75    The architecture vector provides some information that is really a
76    property of the inferior, accessed through a particular target:
77    ptrace operations; the layout of certain RSP packets; the solib_ops
78    vector; etc.  To differentiate architecture accesses to
79    per-inferior/target properties from
80    per-thread/per-frame/per-objfile properties, accesses to
81    per-inferior/target properties should be made through this
82    gdbarch.  */
83
84 /* This is a convenience wrapper for 'current_inferior ()->gdbarch'.  */
85 extern struct gdbarch *target_gdbarch (void);
86
87 /* Callback type for the 'iterate_over_objfiles_in_search_order'
88    gdbarch  method.  */
89
90 typedef int (iterate_over_objfiles_in_search_order_cb_ftype)
91   (struct objfile *objfile, void *cb_data);
92
93 /* Callback type for regset section iterators.  The callback usually
94    invokes the REGSET's supply or collect method, to which it must
95    pass a buffer - for collects this buffer will need to be created using
96    COLLECT_SIZE, for supply the existing buffer being read from should
97    be at least SUPPLY_SIZE.  SECT_NAME is a BFD section name, and HUMAN_NAME
98    is used for diagnostic messages.  CB_DATA should have been passed
99    unchanged through the iterator.  */
100
101 typedef void (iterate_over_regset_sections_cb)
102   (const char *sect_name, int supply_size, int collect_size,
103    const struct regset *regset, const char *human_name, void *cb_data);
104
105 /* For a function call, does the function return a value using a
106    normal value return or a structure return - passing a hidden
107    argument pointing to storage.  For the latter, there are two
108    cases: language-mandated structure return and target ABI
109    structure return.  */
110
111 enum function_call_return_method
112 {
113   /* Standard value return.  */
114   return_method_normal = 0,
115
116   /* Language ABI structure return.  This is handled
117      by passing the return location as the first parameter to
118      the function, even preceding "this".  */
119   return_method_hidden_param,
120
121   /* Target ABI struct return.  This is target-specific; for instance,
122      on ia64 the first argument is passed in out0 but the hidden
123      structure return pointer would normally be passed in r8.  */
124   return_method_struct,
125 };
126
127
128
129 /* The following are pre-initialized by GDBARCH.  */
130
131 extern const struct bfd_arch_info * gdbarch_bfd_arch_info (struct gdbarch *gdbarch);
132 /* set_gdbarch_bfd_arch_info() - not applicable - pre-initialized.  */
133
134 extern enum bfd_endian gdbarch_byte_order (struct gdbarch *gdbarch);
135 /* set_gdbarch_byte_order() - not applicable - pre-initialized.  */
136
137 extern enum bfd_endian gdbarch_byte_order_for_code (struct gdbarch *gdbarch);
138 /* set_gdbarch_byte_order_for_code() - not applicable - pre-initialized.  */
139
140 extern enum gdb_osabi gdbarch_osabi (struct gdbarch *gdbarch);
141 /* set_gdbarch_osabi() - not applicable - pre-initialized.  */
142
143 extern const struct target_desc * gdbarch_target_desc (struct gdbarch *gdbarch);
144 /* set_gdbarch_target_desc() - not applicable - pre-initialized.  */
145
146
147 /* The following are initialized by the target dependent code.  */
148
149 /* The bit byte-order has to do just with numbering of bits in debugging symbols
150    and such.  Conceptually, it's quite separate from byte/word byte order. */
151
152 extern int gdbarch_bits_big_endian (struct gdbarch *gdbarch);
153 extern void set_gdbarch_bits_big_endian (struct gdbarch *gdbarch, int bits_big_endian);
154
155 /* Number of bits in a short or unsigned short for the target machine. */
156
157 extern int gdbarch_short_bit (struct gdbarch *gdbarch);
158 extern void set_gdbarch_short_bit (struct gdbarch *gdbarch, int short_bit);
159
160 /* Number of bits in an int or unsigned int for the target machine. */
161
162 extern int gdbarch_int_bit (struct gdbarch *gdbarch);
163 extern void set_gdbarch_int_bit (struct gdbarch *gdbarch, int int_bit);
164
165 /* Number of bits in a long or unsigned long for the target machine. */
166
167 extern int gdbarch_long_bit (struct gdbarch *gdbarch);
168 extern void set_gdbarch_long_bit (struct gdbarch *gdbarch, int long_bit);
169
170 /* Number of bits in a long long or unsigned long long for the target
171    machine. */
172
173 extern int gdbarch_long_long_bit (struct gdbarch *gdbarch);
174 extern void set_gdbarch_long_long_bit (struct gdbarch *gdbarch, int long_long_bit);
175
176 /* The ABI default bit-size and format for "half", "float", "double", and
177    "long double".  These bit/format pairs should eventually be combined
178    into a single object.  For the moment, just initialize them as a pair.
179    Each format describes both the big and little endian layouts (if
180    useful). */
181
182 extern int gdbarch_half_bit (struct gdbarch *gdbarch);
183 extern void set_gdbarch_half_bit (struct gdbarch *gdbarch, int half_bit);
184
185 extern const struct floatformat ** gdbarch_half_format (struct gdbarch *gdbarch);
186 extern void set_gdbarch_half_format (struct gdbarch *gdbarch, const struct floatformat ** half_format);
187
188 extern int gdbarch_float_bit (struct gdbarch *gdbarch);
189 extern void set_gdbarch_float_bit (struct gdbarch *gdbarch, int float_bit);
190
191 extern const struct floatformat ** gdbarch_float_format (struct gdbarch *gdbarch);
192 extern void set_gdbarch_float_format (struct gdbarch *gdbarch, const struct floatformat ** float_format);
193
194 extern int gdbarch_double_bit (struct gdbarch *gdbarch);
195 extern void set_gdbarch_double_bit (struct gdbarch *gdbarch, int double_bit);
196
197 extern const struct floatformat ** gdbarch_double_format (struct gdbarch *gdbarch);
198 extern void set_gdbarch_double_format (struct gdbarch *gdbarch, const struct floatformat ** double_format);
199
200 extern int gdbarch_long_double_bit (struct gdbarch *gdbarch);
201 extern void set_gdbarch_long_double_bit (struct gdbarch *gdbarch, int long_double_bit);
202
203 extern const struct floatformat ** gdbarch_long_double_format (struct gdbarch *gdbarch);
204 extern void set_gdbarch_long_double_format (struct gdbarch *gdbarch, const struct floatformat ** long_double_format);
205
206 /* The ABI default bit-size for "wchar_t".  wchar_t is a built-in type
207    starting with C++11. */
208
209 extern int gdbarch_wchar_bit (struct gdbarch *gdbarch);
210 extern void set_gdbarch_wchar_bit (struct gdbarch *gdbarch, int wchar_bit);
211
212 /* One if `wchar_t' is signed, zero if unsigned. */
213
214 extern int gdbarch_wchar_signed (struct gdbarch *gdbarch);
215 extern void set_gdbarch_wchar_signed (struct gdbarch *gdbarch, int wchar_signed);
216
217 /* Returns the floating-point format to be used for values of length LENGTH.
218    NAME, if non-NULL, is the type name, which may be used to distinguish
219    different target formats of the same length. */
220
221 typedef const struct floatformat ** (gdbarch_floatformat_for_type_ftype) (struct gdbarch *gdbarch, const char *name, int length);
222 extern const struct floatformat ** gdbarch_floatformat_for_type (struct gdbarch *gdbarch, const char *name, int length);
223 extern void set_gdbarch_floatformat_for_type (struct gdbarch *gdbarch, gdbarch_floatformat_for_type_ftype *floatformat_for_type);
224
225 /* For most targets, a pointer on the target and its representation as an
226    address in GDB have the same size and "look the same".  For such a
227    target, you need only set gdbarch_ptr_bit and gdbarch_addr_bit
228    / addr_bit will be set from it.
229   
230    If gdbarch_ptr_bit and gdbarch_addr_bit are different, you'll probably
231    also need to set gdbarch_dwarf2_addr_size, gdbarch_pointer_to_address and
232    gdbarch_address_to_pointer as well.
233   
234    ptr_bit is the size of a pointer on the target */
235
236 extern int gdbarch_ptr_bit (struct gdbarch *gdbarch);
237 extern void set_gdbarch_ptr_bit (struct gdbarch *gdbarch, int ptr_bit);
238
239 /* addr_bit is the size of a target address as represented in gdb */
240
241 extern int gdbarch_addr_bit (struct gdbarch *gdbarch);
242 extern void set_gdbarch_addr_bit (struct gdbarch *gdbarch, int addr_bit);
243
244 /* dwarf2_addr_size is the target address size as used in the Dwarf debug
245    info.  For .debug_frame FDEs, this is supposed to be the target address
246    size from the associated CU header, and which is equivalent to the
247    DWARF2_ADDR_SIZE as defined by the target specific GCC back-end.
248    Unfortunately there is no good way to determine this value.  Therefore
249    dwarf2_addr_size simply defaults to the target pointer size.
250   
251    dwarf2_addr_size is not used for .eh_frame FDEs, which are generally
252    defined using the target's pointer size so far.
253   
254    Note that dwarf2_addr_size only needs to be redefined by a target if the
255    GCC back-end defines a DWARF2_ADDR_SIZE other than the target pointer size,
256    and if Dwarf versions < 4 need to be supported. */
257
258 extern int gdbarch_dwarf2_addr_size (struct gdbarch *gdbarch);
259 extern void set_gdbarch_dwarf2_addr_size (struct gdbarch *gdbarch, int dwarf2_addr_size);
260
261 /* One if `char' acts like `signed char', zero if `unsigned char'. */
262
263 extern int gdbarch_char_signed (struct gdbarch *gdbarch);
264 extern void set_gdbarch_char_signed (struct gdbarch *gdbarch, int char_signed);
265
266 extern int gdbarch_read_pc_p (struct gdbarch *gdbarch);
267
268 typedef CORE_ADDR (gdbarch_read_pc_ftype) (readable_regcache *regcache);
269 extern CORE_ADDR gdbarch_read_pc (struct gdbarch *gdbarch, readable_regcache *regcache);
270 extern void set_gdbarch_read_pc (struct gdbarch *gdbarch, gdbarch_read_pc_ftype *read_pc);
271
272 extern int gdbarch_write_pc_p (struct gdbarch *gdbarch);
273
274 typedef void (gdbarch_write_pc_ftype) (struct regcache *regcache, CORE_ADDR val);
275 extern void gdbarch_write_pc (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR val);
276 extern void set_gdbarch_write_pc (struct gdbarch *gdbarch, gdbarch_write_pc_ftype *write_pc);
277
278 /* Function for getting target's idea of a frame pointer.  FIXME: GDB's
279    whole scheme for dealing with "frames" and "frame pointers" needs a
280    serious shakedown. */
281
282 typedef void (gdbarch_virtual_frame_pointer_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc, int *frame_regnum, LONGEST *frame_offset);
283 extern void gdbarch_virtual_frame_pointer (struct gdbarch *gdbarch, CORE_ADDR pc, int *frame_regnum, LONGEST *frame_offset);
284 extern void set_gdbarch_virtual_frame_pointer (struct gdbarch *gdbarch, gdbarch_virtual_frame_pointer_ftype *virtual_frame_pointer);
285
286 extern int gdbarch_pseudo_register_read_p (struct gdbarch *gdbarch);
287
288 typedef enum register_status (gdbarch_pseudo_register_read_ftype) (struct gdbarch *gdbarch, readable_regcache *regcache, int cookednum, gdb_byte *buf);
289 extern enum register_status gdbarch_pseudo_register_read (struct gdbarch *gdbarch, readable_regcache *regcache, int cookednum, gdb_byte *buf);
290 extern void set_gdbarch_pseudo_register_read (struct gdbarch *gdbarch, gdbarch_pseudo_register_read_ftype *pseudo_register_read);
291
292 /* Read a register into a new struct value.  If the register is wholly
293    or partly unavailable, this should call mark_value_bytes_unavailable
294    as appropriate.  If this is defined, then pseudo_register_read will
295    never be called. */
296
297 extern int gdbarch_pseudo_register_read_value_p (struct gdbarch *gdbarch);
298
299 typedef struct value * (gdbarch_pseudo_register_read_value_ftype) (struct gdbarch *gdbarch, readable_regcache *regcache, int cookednum);
300 extern struct value * gdbarch_pseudo_register_read_value (struct gdbarch *gdbarch, readable_regcache *regcache, int cookednum);
301 extern void set_gdbarch_pseudo_register_read_value (struct gdbarch *gdbarch, gdbarch_pseudo_register_read_value_ftype *pseudo_register_read_value);
302
303 extern int gdbarch_pseudo_register_write_p (struct gdbarch *gdbarch);
304
305 typedef void (gdbarch_pseudo_register_write_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, const gdb_byte *buf);
306 extern void gdbarch_pseudo_register_write (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, const gdb_byte *buf);
307 extern void set_gdbarch_pseudo_register_write (struct gdbarch *gdbarch, gdbarch_pseudo_register_write_ftype *pseudo_register_write);
308
309 extern int gdbarch_num_regs (struct gdbarch *gdbarch);
310 extern void set_gdbarch_num_regs (struct gdbarch *gdbarch, int num_regs);
311
312 /* This macro gives the number of pseudo-registers that live in the
313    register namespace but do not get fetched or stored on the target.
314    These pseudo-registers may be aliases for other registers,
315    combinations of other registers, or they may be computed by GDB. */
316
317 extern int gdbarch_num_pseudo_regs (struct gdbarch *gdbarch);
318 extern void set_gdbarch_num_pseudo_regs (struct gdbarch *gdbarch, int num_pseudo_regs);
319
320 /* Assemble agent expression bytecode to collect pseudo-register REG.
321    Return -1 if something goes wrong, 0 otherwise. */
322
323 extern int gdbarch_ax_pseudo_register_collect_p (struct gdbarch *gdbarch);
324
325 typedef int (gdbarch_ax_pseudo_register_collect_ftype) (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
326 extern int gdbarch_ax_pseudo_register_collect (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
327 extern void set_gdbarch_ax_pseudo_register_collect (struct gdbarch *gdbarch, gdbarch_ax_pseudo_register_collect_ftype *ax_pseudo_register_collect);
328
329 /* Assemble agent expression bytecode to push the value of pseudo-register
330    REG on the interpreter stack.
331    Return -1 if something goes wrong, 0 otherwise. */
332
333 extern int gdbarch_ax_pseudo_register_push_stack_p (struct gdbarch *gdbarch);
334
335 typedef int (gdbarch_ax_pseudo_register_push_stack_ftype) (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
336 extern int gdbarch_ax_pseudo_register_push_stack (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
337 extern void set_gdbarch_ax_pseudo_register_push_stack (struct gdbarch *gdbarch, gdbarch_ax_pseudo_register_push_stack_ftype *ax_pseudo_register_push_stack);
338
339 /* Some targets/architectures can do extra processing/display of
340    segmentation faults.  E.g., Intel MPX boundary faults.
341    Call the architecture dependent function to handle the fault.
342    UIOUT is the output stream where the handler will place information. */
343
344 extern int gdbarch_handle_segmentation_fault_p (struct gdbarch *gdbarch);
345
346 typedef void (gdbarch_handle_segmentation_fault_ftype) (struct gdbarch *gdbarch, struct ui_out *uiout);
347 extern void gdbarch_handle_segmentation_fault (struct gdbarch *gdbarch, struct ui_out *uiout);
348 extern void set_gdbarch_handle_segmentation_fault (struct gdbarch *gdbarch, gdbarch_handle_segmentation_fault_ftype *handle_segmentation_fault);
349
350 /* GDB's standard (or well known) register numbers.  These can map onto
351    a real register or a pseudo (computed) register or not be defined at
352    all (-1).
353    gdbarch_sp_regnum will hopefully be replaced by UNWIND_SP. */
354
355 extern int gdbarch_sp_regnum (struct gdbarch *gdbarch);
356 extern void set_gdbarch_sp_regnum (struct gdbarch *gdbarch, int sp_regnum);
357
358 extern int gdbarch_pc_regnum (struct gdbarch *gdbarch);
359 extern void set_gdbarch_pc_regnum (struct gdbarch *gdbarch, int pc_regnum);
360
361 extern int gdbarch_ps_regnum (struct gdbarch *gdbarch);
362 extern void set_gdbarch_ps_regnum (struct gdbarch *gdbarch, int ps_regnum);
363
364 extern int gdbarch_fp0_regnum (struct gdbarch *gdbarch);
365 extern void set_gdbarch_fp0_regnum (struct gdbarch *gdbarch, int fp0_regnum);
366
367 /* Convert stab register number (from `r' declaration) to a gdb REGNUM. */
368
369 typedef int (gdbarch_stab_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int stab_regnr);
370 extern int gdbarch_stab_reg_to_regnum (struct gdbarch *gdbarch, int stab_regnr);
371 extern void set_gdbarch_stab_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_stab_reg_to_regnum_ftype *stab_reg_to_regnum);
372
373 /* Provide a default mapping from a ecoff register number to a gdb REGNUM. */
374
375 typedef int (gdbarch_ecoff_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int ecoff_regnr);
376 extern int gdbarch_ecoff_reg_to_regnum (struct gdbarch *gdbarch, int ecoff_regnr);
377 extern void set_gdbarch_ecoff_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_ecoff_reg_to_regnum_ftype *ecoff_reg_to_regnum);
378
379 /* Convert from an sdb register number to an internal gdb register number. */
380
381 typedef int (gdbarch_sdb_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int sdb_regnr);
382 extern int gdbarch_sdb_reg_to_regnum (struct gdbarch *gdbarch, int sdb_regnr);
383 extern void set_gdbarch_sdb_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_sdb_reg_to_regnum_ftype *sdb_reg_to_regnum);
384
385 /* Provide a default mapping from a DWARF2 register number to a gdb REGNUM.
386    Return -1 for bad REGNUM.  Note: Several targets get this wrong. */
387
388 typedef int (gdbarch_dwarf2_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int dwarf2_regnr);
389 extern int gdbarch_dwarf2_reg_to_regnum (struct gdbarch *gdbarch, int dwarf2_regnr);
390 extern void set_gdbarch_dwarf2_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_dwarf2_reg_to_regnum_ftype *dwarf2_reg_to_regnum);
391
392 typedef const char * (gdbarch_register_name_ftype) (struct gdbarch *gdbarch, int regnr);
393 extern const char * gdbarch_register_name (struct gdbarch *gdbarch, int regnr);
394 extern void set_gdbarch_register_name (struct gdbarch *gdbarch, gdbarch_register_name_ftype *register_name);
395
396 /* Return the type of a register specified by the architecture.  Only
397    the register cache should call this function directly; others should
398    use "register_type". */
399
400 extern int gdbarch_register_type_p (struct gdbarch *gdbarch);
401
402 typedef struct type * (gdbarch_register_type_ftype) (struct gdbarch *gdbarch, int reg_nr);
403 extern struct type * gdbarch_register_type (struct gdbarch *gdbarch, int reg_nr);
404 extern void set_gdbarch_register_type (struct gdbarch *gdbarch, gdbarch_register_type_ftype *register_type);
405
406 extern int gdbarch_dummy_id_p (struct gdbarch *gdbarch);
407
408 typedef struct frame_id (gdbarch_dummy_id_ftype) (struct gdbarch *gdbarch, struct frame_info *this_frame);
409 extern struct frame_id gdbarch_dummy_id (struct gdbarch *gdbarch, struct frame_info *this_frame);
410 extern void set_gdbarch_dummy_id (struct gdbarch *gdbarch, gdbarch_dummy_id_ftype *dummy_id);
411
412 /* Implement DUMMY_ID and PUSH_DUMMY_CALL, then delete
413    deprecated_fp_regnum. */
414
415 extern int gdbarch_deprecated_fp_regnum (struct gdbarch *gdbarch);
416 extern void set_gdbarch_deprecated_fp_regnum (struct gdbarch *gdbarch, int deprecated_fp_regnum);
417
418 extern int gdbarch_push_dummy_call_p (struct gdbarch *gdbarch);
419
420 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, function_call_return_method return_method, CORE_ADDR struct_addr);
421 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, function_call_return_method return_method, CORE_ADDR struct_addr);
422 extern void set_gdbarch_push_dummy_call (struct gdbarch *gdbarch, gdbarch_push_dummy_call_ftype *push_dummy_call);
423
424 extern int gdbarch_call_dummy_location (struct gdbarch *gdbarch);
425 extern void set_gdbarch_call_dummy_location (struct gdbarch *gdbarch, int call_dummy_location);
426
427 extern int gdbarch_push_dummy_code_p (struct gdbarch *gdbarch);
428
429 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);
430 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);
431 extern void set_gdbarch_push_dummy_code (struct gdbarch *gdbarch, gdbarch_push_dummy_code_ftype *push_dummy_code);
432
433 /* Return true if the code of FRAME is writable. */
434
435 typedef int (gdbarch_code_of_frame_writable_ftype) (struct gdbarch *gdbarch, struct frame_info *frame);
436 extern int gdbarch_code_of_frame_writable (struct gdbarch *gdbarch, struct frame_info *frame);
437 extern void set_gdbarch_code_of_frame_writable (struct gdbarch *gdbarch, gdbarch_code_of_frame_writable_ftype *code_of_frame_writable);
438
439 typedef void (gdbarch_print_registers_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, int regnum, int all);
440 extern void gdbarch_print_registers_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, int regnum, int all);
441 extern void set_gdbarch_print_registers_info (struct gdbarch *gdbarch, gdbarch_print_registers_info_ftype *print_registers_info);
442
443 typedef void (gdbarch_print_float_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
444 extern void gdbarch_print_float_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
445 extern void set_gdbarch_print_float_info (struct gdbarch *gdbarch, gdbarch_print_float_info_ftype *print_float_info);
446
447 extern int gdbarch_print_vector_info_p (struct gdbarch *gdbarch);
448
449 typedef void (gdbarch_print_vector_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
450 extern void gdbarch_print_vector_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
451 extern void set_gdbarch_print_vector_info (struct gdbarch *gdbarch, gdbarch_print_vector_info_ftype *print_vector_info);
452
453 /* MAP a GDB RAW register number onto a simulator register number.  See
454    also include/...-sim.h. */
455
456 typedef int (gdbarch_register_sim_regno_ftype) (struct gdbarch *gdbarch, int reg_nr);
457 extern int gdbarch_register_sim_regno (struct gdbarch *gdbarch, int reg_nr);
458 extern void set_gdbarch_register_sim_regno (struct gdbarch *gdbarch, gdbarch_register_sim_regno_ftype *register_sim_regno);
459
460 typedef int (gdbarch_cannot_fetch_register_ftype) (struct gdbarch *gdbarch, int regnum);
461 extern int gdbarch_cannot_fetch_register (struct gdbarch *gdbarch, int regnum);
462 extern void set_gdbarch_cannot_fetch_register (struct gdbarch *gdbarch, gdbarch_cannot_fetch_register_ftype *cannot_fetch_register);
463
464 typedef int (gdbarch_cannot_store_register_ftype) (struct gdbarch *gdbarch, int regnum);
465 extern int gdbarch_cannot_store_register (struct gdbarch *gdbarch, int regnum);
466 extern void set_gdbarch_cannot_store_register (struct gdbarch *gdbarch, gdbarch_cannot_store_register_ftype *cannot_store_register);
467
468 /* Determine the address where a longjmp will land and save this address
469    in PC.  Return nonzero on success.
470   
471    FRAME corresponds to the longjmp frame. */
472
473 extern int gdbarch_get_longjmp_target_p (struct gdbarch *gdbarch);
474
475 typedef int (gdbarch_get_longjmp_target_ftype) (struct frame_info *frame, CORE_ADDR *pc);
476 extern int gdbarch_get_longjmp_target (struct gdbarch *gdbarch, struct frame_info *frame, CORE_ADDR *pc);
477 extern void set_gdbarch_get_longjmp_target (struct gdbarch *gdbarch, gdbarch_get_longjmp_target_ftype *get_longjmp_target);
478
479 extern int gdbarch_believe_pcc_promotion (struct gdbarch *gdbarch);
480 extern void set_gdbarch_believe_pcc_promotion (struct gdbarch *gdbarch, int believe_pcc_promotion);
481
482 typedef int (gdbarch_convert_register_p_ftype) (struct gdbarch *gdbarch, int regnum, struct type *type);
483 extern int gdbarch_convert_register_p (struct gdbarch *gdbarch, int regnum, struct type *type);
484 extern void set_gdbarch_convert_register_p (struct gdbarch *gdbarch, gdbarch_convert_register_p_ftype *convert_register_p);
485
486 typedef int (gdbarch_register_to_value_ftype) (struct frame_info *frame, int regnum, struct type *type, gdb_byte *buf, int *optimizedp, int *unavailablep);
487 extern int gdbarch_register_to_value (struct gdbarch *gdbarch, struct frame_info *frame, int regnum, struct type *type, gdb_byte *buf, int *optimizedp, int *unavailablep);
488 extern void set_gdbarch_register_to_value (struct gdbarch *gdbarch, gdbarch_register_to_value_ftype *register_to_value);
489
490 typedef void (gdbarch_value_to_register_ftype) (struct frame_info *frame, int regnum, struct type *type, const gdb_byte *buf);
491 extern void gdbarch_value_to_register (struct gdbarch *gdbarch, struct frame_info *frame, int regnum, struct type *type, const gdb_byte *buf);
492 extern void set_gdbarch_value_to_register (struct gdbarch *gdbarch, gdbarch_value_to_register_ftype *value_to_register);
493
494 /* Construct a value representing the contents of register REGNUM in
495    frame FRAME_ID, interpreted as type TYPE.  The routine needs to
496    allocate and return a struct value with all value attributes
497    (but not the value contents) filled in. */
498
499 typedef struct value * (gdbarch_value_from_register_ftype) (struct gdbarch *gdbarch, struct type *type, int regnum, struct frame_id frame_id);
500 extern struct value * gdbarch_value_from_register (struct gdbarch *gdbarch, struct type *type, int regnum, struct frame_id frame_id);
501 extern void set_gdbarch_value_from_register (struct gdbarch *gdbarch, gdbarch_value_from_register_ftype *value_from_register);
502
503 typedef CORE_ADDR (gdbarch_pointer_to_address_ftype) (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
504 extern CORE_ADDR gdbarch_pointer_to_address (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
505 extern void set_gdbarch_pointer_to_address (struct gdbarch *gdbarch, gdbarch_pointer_to_address_ftype *pointer_to_address);
506
507 typedef void (gdbarch_address_to_pointer_ftype) (struct gdbarch *gdbarch, struct type *type, gdb_byte *buf, CORE_ADDR addr);
508 extern void gdbarch_address_to_pointer (struct gdbarch *gdbarch, struct type *type, gdb_byte *buf, CORE_ADDR addr);
509 extern void set_gdbarch_address_to_pointer (struct gdbarch *gdbarch, gdbarch_address_to_pointer_ftype *address_to_pointer);
510
511 extern int gdbarch_integer_to_address_p (struct gdbarch *gdbarch);
512
513 typedef CORE_ADDR (gdbarch_integer_to_address_ftype) (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
514 extern CORE_ADDR gdbarch_integer_to_address (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
515 extern void set_gdbarch_integer_to_address (struct gdbarch *gdbarch, gdbarch_integer_to_address_ftype *integer_to_address);
516
517 /* Return the return-value convention that will be used by FUNCTION
518    to return a value of type VALTYPE.  FUNCTION may be NULL in which
519    case the return convention is computed based only on VALTYPE.
520   
521    If READBUF is not NULL, extract the return value and save it in this buffer.
522   
523    If WRITEBUF is not NULL, it contains a return value which will be
524    stored into the appropriate register.  This can be used when we want
525    to force the value returned by a function (see the "return" command
526    for instance). */
527
528 extern int gdbarch_return_value_p (struct gdbarch *gdbarch);
529
530 typedef enum return_value_convention (gdbarch_return_value_ftype) (struct gdbarch *gdbarch, struct value *function, struct type *valtype, struct regcache *regcache, gdb_byte *readbuf, const gdb_byte *writebuf);
531 extern enum return_value_convention gdbarch_return_value (struct gdbarch *gdbarch, struct value *function, struct type *valtype, struct regcache *regcache, gdb_byte *readbuf, const gdb_byte *writebuf);
532 extern void set_gdbarch_return_value (struct gdbarch *gdbarch, gdbarch_return_value_ftype *return_value);
533
534 /* Return true if the return value of function is stored in the first hidden
535    parameter.  In theory, this feature should be language-dependent, specified
536    by language and its ABI, such as C++.  Unfortunately, compiler may
537    implement it to a target-dependent feature.  So that we need such hook here
538    to be aware of this in GDB. */
539
540 typedef int (gdbarch_return_in_first_hidden_param_p_ftype) (struct gdbarch *gdbarch, struct type *type);
541 extern int gdbarch_return_in_first_hidden_param_p (struct gdbarch *gdbarch, struct type *type);
542 extern void set_gdbarch_return_in_first_hidden_param_p (struct gdbarch *gdbarch, gdbarch_return_in_first_hidden_param_p_ftype *return_in_first_hidden_param_p);
543
544 typedef CORE_ADDR (gdbarch_skip_prologue_ftype) (struct gdbarch *gdbarch, CORE_ADDR ip);
545 extern CORE_ADDR gdbarch_skip_prologue (struct gdbarch *gdbarch, CORE_ADDR ip);
546 extern void set_gdbarch_skip_prologue (struct gdbarch *gdbarch, gdbarch_skip_prologue_ftype *skip_prologue);
547
548 extern int gdbarch_skip_main_prologue_p (struct gdbarch *gdbarch);
549
550 typedef CORE_ADDR (gdbarch_skip_main_prologue_ftype) (struct gdbarch *gdbarch, CORE_ADDR ip);
551 extern CORE_ADDR gdbarch_skip_main_prologue (struct gdbarch *gdbarch, CORE_ADDR ip);
552 extern void set_gdbarch_skip_main_prologue (struct gdbarch *gdbarch, gdbarch_skip_main_prologue_ftype *skip_main_prologue);
553
554 /* On some platforms, a single function may provide multiple entry points,
555    e.g. one that is used for function-pointer calls and a different one
556    that is used for direct function calls.
557    In order to ensure that breakpoints set on the function will trigger
558    no matter via which entry point the function is entered, a platform
559    may provide the skip_entrypoint callback.  It is called with IP set
560    to the main entry point of a function (as determined by the symbol table),
561    and should return the address of the innermost entry point, where the
562    actual breakpoint needs to be set.  Note that skip_entrypoint is used
563    by GDB common code even when debugging optimized code, where skip_prologue
564    is not used. */
565
566 extern int gdbarch_skip_entrypoint_p (struct gdbarch *gdbarch);
567
568 typedef CORE_ADDR (gdbarch_skip_entrypoint_ftype) (struct gdbarch *gdbarch, CORE_ADDR ip);
569 extern CORE_ADDR gdbarch_skip_entrypoint (struct gdbarch *gdbarch, CORE_ADDR ip);
570 extern void set_gdbarch_skip_entrypoint (struct gdbarch *gdbarch, gdbarch_skip_entrypoint_ftype *skip_entrypoint);
571
572 typedef int (gdbarch_inner_than_ftype) (CORE_ADDR lhs, CORE_ADDR rhs);
573 extern int gdbarch_inner_than (struct gdbarch *gdbarch, CORE_ADDR lhs, CORE_ADDR rhs);
574 extern void set_gdbarch_inner_than (struct gdbarch *gdbarch, gdbarch_inner_than_ftype *inner_than);
575
576 typedef const gdb_byte * (gdbarch_breakpoint_from_pc_ftype) (struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *lenptr);
577 extern const gdb_byte * gdbarch_breakpoint_from_pc (struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *lenptr);
578 extern void set_gdbarch_breakpoint_from_pc (struct gdbarch *gdbarch, gdbarch_breakpoint_from_pc_ftype *breakpoint_from_pc);
579
580 /* Return the breakpoint kind for this target based on *PCPTR. */
581
582 typedef int (gdbarch_breakpoint_kind_from_pc_ftype) (struct gdbarch *gdbarch, CORE_ADDR *pcptr);
583 extern int gdbarch_breakpoint_kind_from_pc (struct gdbarch *gdbarch, CORE_ADDR *pcptr);
584 extern void set_gdbarch_breakpoint_kind_from_pc (struct gdbarch *gdbarch, gdbarch_breakpoint_kind_from_pc_ftype *breakpoint_kind_from_pc);
585
586 /* Return the software breakpoint from KIND.  KIND can have target
587    specific meaning like the Z0 kind parameter.
588    SIZE is set to the software breakpoint's length in memory. */
589
590 typedef const gdb_byte * (gdbarch_sw_breakpoint_from_kind_ftype) (struct gdbarch *gdbarch, int kind, int *size);
591 extern const gdb_byte * gdbarch_sw_breakpoint_from_kind (struct gdbarch *gdbarch, int kind, int *size);
592 extern void set_gdbarch_sw_breakpoint_from_kind (struct gdbarch *gdbarch, gdbarch_sw_breakpoint_from_kind_ftype *sw_breakpoint_from_kind);
593
594 /* Return the breakpoint kind for this target based on the current
595    processor state (e.g. the current instruction mode on ARM) and the
596    *PCPTR.  In default, it is gdbarch->breakpoint_kind_from_pc. */
597
598 typedef int (gdbarch_breakpoint_kind_from_current_state_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR *pcptr);
599 extern int gdbarch_breakpoint_kind_from_current_state (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR *pcptr);
600 extern void set_gdbarch_breakpoint_kind_from_current_state (struct gdbarch *gdbarch, gdbarch_breakpoint_kind_from_current_state_ftype *breakpoint_kind_from_current_state);
601
602 extern int gdbarch_adjust_breakpoint_address_p (struct gdbarch *gdbarch);
603
604 typedef CORE_ADDR (gdbarch_adjust_breakpoint_address_ftype) (struct gdbarch *gdbarch, CORE_ADDR bpaddr);
605 extern CORE_ADDR gdbarch_adjust_breakpoint_address (struct gdbarch *gdbarch, CORE_ADDR bpaddr);
606 extern void set_gdbarch_adjust_breakpoint_address (struct gdbarch *gdbarch, gdbarch_adjust_breakpoint_address_ftype *adjust_breakpoint_address);
607
608 typedef int (gdbarch_memory_insert_breakpoint_ftype) (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
609 extern int gdbarch_memory_insert_breakpoint (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
610 extern void set_gdbarch_memory_insert_breakpoint (struct gdbarch *gdbarch, gdbarch_memory_insert_breakpoint_ftype *memory_insert_breakpoint);
611
612 typedef int (gdbarch_memory_remove_breakpoint_ftype) (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
613 extern int gdbarch_memory_remove_breakpoint (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
614 extern void set_gdbarch_memory_remove_breakpoint (struct gdbarch *gdbarch, gdbarch_memory_remove_breakpoint_ftype *memory_remove_breakpoint);
615
616 extern CORE_ADDR gdbarch_decr_pc_after_break (struct gdbarch *gdbarch);
617 extern void set_gdbarch_decr_pc_after_break (struct gdbarch *gdbarch, CORE_ADDR decr_pc_after_break);
618
619 /* A function can be addressed by either it's "pointer" (possibly a
620    descriptor address) or "entry point" (first executable instruction).
621    The method "convert_from_func_ptr_addr" converting the former to the
622    latter.  gdbarch_deprecated_function_start_offset is being used to implement
623    a simplified subset of that functionality - the function's address
624    corresponds to the "function pointer" and the function's start
625    corresponds to the "function entry point" - and hence is redundant. */
626
627 extern CORE_ADDR gdbarch_deprecated_function_start_offset (struct gdbarch *gdbarch);
628 extern void set_gdbarch_deprecated_function_start_offset (struct gdbarch *gdbarch, CORE_ADDR deprecated_function_start_offset);
629
630 /* Return the remote protocol register number associated with this
631    register.  Normally the identity mapping. */
632
633 typedef int (gdbarch_remote_register_number_ftype) (struct gdbarch *gdbarch, int regno);
634 extern int gdbarch_remote_register_number (struct gdbarch *gdbarch, int regno);
635 extern void set_gdbarch_remote_register_number (struct gdbarch *gdbarch, gdbarch_remote_register_number_ftype *remote_register_number);
636
637 /* Fetch the target specific address used to represent a load module. */
638
639 extern int gdbarch_fetch_tls_load_module_address_p (struct gdbarch *gdbarch);
640
641 typedef CORE_ADDR (gdbarch_fetch_tls_load_module_address_ftype) (struct objfile *objfile);
642 extern CORE_ADDR gdbarch_fetch_tls_load_module_address (struct gdbarch *gdbarch, struct objfile *objfile);
643 extern void set_gdbarch_fetch_tls_load_module_address (struct gdbarch *gdbarch, gdbarch_fetch_tls_load_module_address_ftype *fetch_tls_load_module_address);
644
645 extern CORE_ADDR gdbarch_frame_args_skip (struct gdbarch *gdbarch);
646 extern void set_gdbarch_frame_args_skip (struct gdbarch *gdbarch, CORE_ADDR frame_args_skip);
647
648 extern int gdbarch_unwind_pc_p (struct gdbarch *gdbarch);
649
650 typedef CORE_ADDR (gdbarch_unwind_pc_ftype) (struct gdbarch *gdbarch, struct frame_info *next_frame);
651 extern CORE_ADDR gdbarch_unwind_pc (struct gdbarch *gdbarch, struct frame_info *next_frame);
652 extern void set_gdbarch_unwind_pc (struct gdbarch *gdbarch, gdbarch_unwind_pc_ftype *unwind_pc);
653
654 extern int gdbarch_unwind_sp_p (struct gdbarch *gdbarch);
655
656 typedef CORE_ADDR (gdbarch_unwind_sp_ftype) (struct gdbarch *gdbarch, struct frame_info *next_frame);
657 extern CORE_ADDR gdbarch_unwind_sp (struct gdbarch *gdbarch, struct frame_info *next_frame);
658 extern void set_gdbarch_unwind_sp (struct gdbarch *gdbarch, gdbarch_unwind_sp_ftype *unwind_sp);
659
660 /* DEPRECATED_FRAME_LOCALS_ADDRESS as been replaced by the per-frame
661    frame-base.  Enable frame-base before frame-unwind. */
662
663 extern int gdbarch_frame_num_args_p (struct gdbarch *gdbarch);
664
665 typedef int (gdbarch_frame_num_args_ftype) (struct frame_info *frame);
666 extern int gdbarch_frame_num_args (struct gdbarch *gdbarch, struct frame_info *frame);
667 extern void set_gdbarch_frame_num_args (struct gdbarch *gdbarch, gdbarch_frame_num_args_ftype *frame_num_args);
668
669 extern int gdbarch_frame_align_p (struct gdbarch *gdbarch);
670
671 typedef CORE_ADDR (gdbarch_frame_align_ftype) (struct gdbarch *gdbarch, CORE_ADDR address);
672 extern CORE_ADDR gdbarch_frame_align (struct gdbarch *gdbarch, CORE_ADDR address);
673 extern void set_gdbarch_frame_align (struct gdbarch *gdbarch, gdbarch_frame_align_ftype *frame_align);
674
675 typedef int (gdbarch_stabs_argument_has_addr_ftype) (struct gdbarch *gdbarch, struct type *type);
676 extern int gdbarch_stabs_argument_has_addr (struct gdbarch *gdbarch, struct type *type);
677 extern void set_gdbarch_stabs_argument_has_addr (struct gdbarch *gdbarch, gdbarch_stabs_argument_has_addr_ftype *stabs_argument_has_addr);
678
679 extern int gdbarch_frame_red_zone_size (struct gdbarch *gdbarch);
680 extern void set_gdbarch_frame_red_zone_size (struct gdbarch *gdbarch, int frame_red_zone_size);
681
682 typedef CORE_ADDR (gdbarch_convert_from_func_ptr_addr_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr, struct target_ops *targ);
683 extern CORE_ADDR gdbarch_convert_from_func_ptr_addr (struct gdbarch *gdbarch, CORE_ADDR addr, struct target_ops *targ);
684 extern void set_gdbarch_convert_from_func_ptr_addr (struct gdbarch *gdbarch, gdbarch_convert_from_func_ptr_addr_ftype *convert_from_func_ptr_addr);
685
686 /* On some machines there are bits in addresses which are not really
687    part of the address, but are used by the kernel, the hardware, etc.
688    for special purposes.  gdbarch_addr_bits_remove takes out any such bits so
689    we get a "real" address such as one would find in a symbol table.
690    This is used only for addresses of instructions, and even then I'm
691    not sure it's used in all contexts.  It exists to deal with there
692    being a few stray bits in the PC which would mislead us, not as some
693    sort of generic thing to handle alignment or segmentation (it's
694    possible it should be in TARGET_READ_PC instead). */
695
696 typedef CORE_ADDR (gdbarch_addr_bits_remove_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
697 extern CORE_ADDR gdbarch_addr_bits_remove (struct gdbarch *gdbarch, CORE_ADDR addr);
698 extern void set_gdbarch_addr_bits_remove (struct gdbarch *gdbarch, gdbarch_addr_bits_remove_ftype *addr_bits_remove);
699
700 /* On some machines, not all bits of an address word are significant.
701    For example, on AArch64, the top bits of an address known as the "tag"
702    are ignored by the kernel, the hardware, etc. and can be regarded as
703    additional data associated with the address. */
704
705 extern int gdbarch_significant_addr_bit (struct gdbarch *gdbarch);
706 extern void set_gdbarch_significant_addr_bit (struct gdbarch *gdbarch, int significant_addr_bit);
707
708 /* FIXME/cagney/2001-01-18: This should be split in two.  A target method that
709    indicates if the target needs software single step.  An ISA method to
710    implement it.
711   
712    FIXME/cagney/2001-01-18: The logic is backwards.  It should be asking if the
713    target can single step.  If not, then implement single step using breakpoints.
714   
715    Return a vector of addresses on which the software single step
716    breakpoints should be inserted.  NULL means software single step is
717    not used.
718    Multiple breakpoints may be inserted for some instructions such as
719    conditional branch.  However, each implementation must always evaluate
720    the condition and only put the breakpoint at the branch destination if
721    the condition is true, so that we ensure forward progress when stepping
722    past a conditional branch to self. */
723
724 extern int gdbarch_software_single_step_p (struct gdbarch *gdbarch);
725
726 typedef std::vector<CORE_ADDR> (gdbarch_software_single_step_ftype) (struct regcache *regcache);
727 extern std::vector<CORE_ADDR> gdbarch_software_single_step (struct gdbarch *gdbarch, struct regcache *regcache);
728 extern void set_gdbarch_software_single_step (struct gdbarch *gdbarch, gdbarch_software_single_step_ftype *software_single_step);
729
730 /* Return non-zero if the processor is executing a delay slot and a
731    further single-step is needed before the instruction finishes. */
732
733 extern int gdbarch_single_step_through_delay_p (struct gdbarch *gdbarch);
734
735 typedef int (gdbarch_single_step_through_delay_ftype) (struct gdbarch *gdbarch, struct frame_info *frame);
736 extern int gdbarch_single_step_through_delay (struct gdbarch *gdbarch, struct frame_info *frame);
737 extern void set_gdbarch_single_step_through_delay (struct gdbarch *gdbarch, gdbarch_single_step_through_delay_ftype *single_step_through_delay);
738
739 /* FIXME: cagney/2003-08-28: Need to find a better way of selecting the
740    disassembler.  Perhaps objdump can handle it? */
741
742 typedef int (gdbarch_print_insn_ftype) (bfd_vma vma, struct disassemble_info *info);
743 extern int gdbarch_print_insn (struct gdbarch *gdbarch, bfd_vma vma, struct disassemble_info *info);
744 extern void set_gdbarch_print_insn (struct gdbarch *gdbarch, gdbarch_print_insn_ftype *print_insn);
745
746 typedef CORE_ADDR (gdbarch_skip_trampoline_code_ftype) (struct frame_info *frame, CORE_ADDR pc);
747 extern CORE_ADDR gdbarch_skip_trampoline_code (struct gdbarch *gdbarch, struct frame_info *frame, CORE_ADDR pc);
748 extern void set_gdbarch_skip_trampoline_code (struct gdbarch *gdbarch, gdbarch_skip_trampoline_code_ftype *skip_trampoline_code);
749
750 /* If in_solib_dynsym_resolve_code() returns true, and SKIP_SOLIB_RESOLVER
751    evaluates non-zero, this is the address where the debugger will place
752    a step-resume breakpoint to get us past the dynamic linker. */
753
754 typedef CORE_ADDR (gdbarch_skip_solib_resolver_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc);
755 extern CORE_ADDR gdbarch_skip_solib_resolver (struct gdbarch *gdbarch, CORE_ADDR pc);
756 extern void set_gdbarch_skip_solib_resolver (struct gdbarch *gdbarch, gdbarch_skip_solib_resolver_ftype *skip_solib_resolver);
757
758 /* Some systems also have trampoline code for returning from shared libs. */
759
760 typedef int (gdbarch_in_solib_return_trampoline_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc, const char *name);
761 extern int gdbarch_in_solib_return_trampoline (struct gdbarch *gdbarch, CORE_ADDR pc, const char *name);
762 extern void set_gdbarch_in_solib_return_trampoline (struct gdbarch *gdbarch, gdbarch_in_solib_return_trampoline_ftype *in_solib_return_trampoline);
763
764 /* Return true if PC lies inside an indirect branch thunk. */
765
766 typedef bool (gdbarch_in_indirect_branch_thunk_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc);
767 extern bool gdbarch_in_indirect_branch_thunk (struct gdbarch *gdbarch, CORE_ADDR pc);
768 extern void set_gdbarch_in_indirect_branch_thunk (struct gdbarch *gdbarch, gdbarch_in_indirect_branch_thunk_ftype *in_indirect_branch_thunk);
769
770 /* A target might have problems with watchpoints as soon as the stack
771    frame of the current function has been destroyed.  This mostly happens
772    as the first action in a function's epilogue.  stack_frame_destroyed_p()
773    is defined to return a non-zero value if either the given addr is one
774    instruction after the stack destroying instruction up to the trailing
775    return instruction or if we can figure out that the stack frame has
776    already been invalidated regardless of the value of addr.  Targets
777    which don't suffer from that problem could just let this functionality
778    untouched. */
779
780 typedef int (gdbarch_stack_frame_destroyed_p_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
781 extern int gdbarch_stack_frame_destroyed_p (struct gdbarch *gdbarch, CORE_ADDR addr);
782 extern void set_gdbarch_stack_frame_destroyed_p (struct gdbarch *gdbarch, gdbarch_stack_frame_destroyed_p_ftype *stack_frame_destroyed_p);
783
784 /* Process an ELF symbol in the minimal symbol table in a backend-specific
785    way.  Normally this hook is supposed to do nothing, however if required,
786    then this hook can be used to apply tranformations to symbols that are
787    considered special in some way.  For example the MIPS backend uses it
788    to interpret `st_other' information to mark compressed code symbols so
789    that they can be treated in the appropriate manner in the processing of
790    the main symbol table and DWARF-2 records. */
791
792 extern int gdbarch_elf_make_msymbol_special_p (struct gdbarch *gdbarch);
793
794 typedef void (gdbarch_elf_make_msymbol_special_ftype) (asymbol *sym, struct minimal_symbol *msym);
795 extern void gdbarch_elf_make_msymbol_special (struct gdbarch *gdbarch, asymbol *sym, struct minimal_symbol *msym);
796 extern void set_gdbarch_elf_make_msymbol_special (struct gdbarch *gdbarch, gdbarch_elf_make_msymbol_special_ftype *elf_make_msymbol_special);
797
798 typedef void (gdbarch_coff_make_msymbol_special_ftype) (int val, struct minimal_symbol *msym);
799 extern void gdbarch_coff_make_msymbol_special (struct gdbarch *gdbarch, int val, struct minimal_symbol *msym);
800 extern void set_gdbarch_coff_make_msymbol_special (struct gdbarch *gdbarch, gdbarch_coff_make_msymbol_special_ftype *coff_make_msymbol_special);
801
802 /* Process a symbol in the main symbol table in a backend-specific way.
803    Normally this hook is supposed to do nothing, however if required,
804    then this hook can be used to apply tranformations to symbols that
805    are considered special in some way.  This is currently used by the
806    MIPS backend to make sure compressed code symbols have the ISA bit
807    set.  This in turn is needed for symbol values seen in GDB to match
808    the values used at the runtime by the program itself, for function
809    and label references. */
810
811 typedef void (gdbarch_make_symbol_special_ftype) (struct symbol *sym, struct objfile *objfile);
812 extern void gdbarch_make_symbol_special (struct gdbarch *gdbarch, struct symbol *sym, struct objfile *objfile);
813 extern void set_gdbarch_make_symbol_special (struct gdbarch *gdbarch, gdbarch_make_symbol_special_ftype *make_symbol_special);
814
815 /* Adjust the address retrieved from a DWARF-2 record other than a line
816    entry in a backend-specific way.  Normally this hook is supposed to
817    return the address passed unchanged, however if that is incorrect for
818    any reason, then this hook can be used to fix the address up in the
819    required manner.  This is currently used by the MIPS backend to make
820    sure addresses in FDE, range records, etc. referring to compressed
821    code have the ISA bit set, matching line information and the symbol
822    table. */
823
824 typedef CORE_ADDR (gdbarch_adjust_dwarf2_addr_ftype) (CORE_ADDR pc);
825 extern CORE_ADDR gdbarch_adjust_dwarf2_addr (struct gdbarch *gdbarch, CORE_ADDR pc);
826 extern void set_gdbarch_adjust_dwarf2_addr (struct gdbarch *gdbarch, gdbarch_adjust_dwarf2_addr_ftype *adjust_dwarf2_addr);
827
828 /* Adjust the address updated by a line entry in a backend-specific way.
829    Normally this hook is supposed to return the address passed unchanged,
830    however in the case of inconsistencies in these records, this hook can
831    be used to fix them up in the required manner.  This is currently used
832    by the MIPS backend to make sure all line addresses in compressed code
833    are presented with the ISA bit set, which is not always the case.  This
834    in turn ensures breakpoint addresses are correctly matched against the
835    stop PC. */
836
837 typedef CORE_ADDR (gdbarch_adjust_dwarf2_line_ftype) (CORE_ADDR addr, int rel);
838 extern CORE_ADDR gdbarch_adjust_dwarf2_line (struct gdbarch *gdbarch, CORE_ADDR addr, int rel);
839 extern void set_gdbarch_adjust_dwarf2_line (struct gdbarch *gdbarch, gdbarch_adjust_dwarf2_line_ftype *adjust_dwarf2_line);
840
841 extern int gdbarch_cannot_step_breakpoint (struct gdbarch *gdbarch);
842 extern void set_gdbarch_cannot_step_breakpoint (struct gdbarch *gdbarch, int cannot_step_breakpoint);
843
844 /* See comment in target.h about continuable, steppable and
845    non-steppable watchpoints. */
846
847 extern int gdbarch_have_nonsteppable_watchpoint (struct gdbarch *gdbarch);
848 extern void set_gdbarch_have_nonsteppable_watchpoint (struct gdbarch *gdbarch, int have_nonsteppable_watchpoint);
849
850 extern int gdbarch_address_class_type_flags_p (struct gdbarch *gdbarch);
851
852 typedef int (gdbarch_address_class_type_flags_ftype) (int byte_size, int dwarf2_addr_class);
853 extern int gdbarch_address_class_type_flags (struct gdbarch *gdbarch, int byte_size, int dwarf2_addr_class);
854 extern void set_gdbarch_address_class_type_flags (struct gdbarch *gdbarch, gdbarch_address_class_type_flags_ftype *address_class_type_flags);
855
856 extern int gdbarch_address_class_type_flags_to_name_p (struct gdbarch *gdbarch);
857
858 typedef const char * (gdbarch_address_class_type_flags_to_name_ftype) (struct gdbarch *gdbarch, int type_flags);
859 extern const char * gdbarch_address_class_type_flags_to_name (struct gdbarch *gdbarch, int type_flags);
860 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);
861
862 /* Execute vendor-specific DWARF Call Frame Instruction.  OP is the instruction.
863    FS are passed from the generic execute_cfa_program function. */
864
865 typedef bool (gdbarch_execute_dwarf_cfa_vendor_op_ftype) (struct gdbarch *gdbarch, gdb_byte op, struct dwarf2_frame_state *fs);
866 extern bool gdbarch_execute_dwarf_cfa_vendor_op (struct gdbarch *gdbarch, gdb_byte op, struct dwarf2_frame_state *fs);
867 extern void set_gdbarch_execute_dwarf_cfa_vendor_op (struct gdbarch *gdbarch, gdbarch_execute_dwarf_cfa_vendor_op_ftype *execute_dwarf_cfa_vendor_op);
868
869 /* Return the appropriate type_flags for the supplied address class.
870    This function should return 1 if the address class was recognized and
871    type_flags was set, zero otherwise. */
872
873 extern int gdbarch_address_class_name_to_type_flags_p (struct gdbarch *gdbarch);
874
875 typedef int (gdbarch_address_class_name_to_type_flags_ftype) (struct gdbarch *gdbarch, const char *name, int *type_flags_ptr);
876 extern int gdbarch_address_class_name_to_type_flags (struct gdbarch *gdbarch, const char *name, int *type_flags_ptr);
877 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);
878
879 /* Is a register in a group */
880
881 typedef int (gdbarch_register_reggroup_p_ftype) (struct gdbarch *gdbarch, int regnum, struct reggroup *reggroup);
882 extern int gdbarch_register_reggroup_p (struct gdbarch *gdbarch, int regnum, struct reggroup *reggroup);
883 extern void set_gdbarch_register_reggroup_p (struct gdbarch *gdbarch, gdbarch_register_reggroup_p_ftype *register_reggroup_p);
884
885 /* Fetch the pointer to the ith function argument. */
886
887 extern int gdbarch_fetch_pointer_argument_p (struct gdbarch *gdbarch);
888
889 typedef CORE_ADDR (gdbarch_fetch_pointer_argument_ftype) (struct frame_info *frame, int argi, struct type *type);
890 extern CORE_ADDR gdbarch_fetch_pointer_argument (struct gdbarch *gdbarch, struct frame_info *frame, int argi, struct type *type);
891 extern void set_gdbarch_fetch_pointer_argument (struct gdbarch *gdbarch, gdbarch_fetch_pointer_argument_ftype *fetch_pointer_argument);
892
893 /* Iterate over all supported register notes in a core file.  For each
894    supported register note section, the iterator must call CB and pass
895    CB_DATA unchanged.  If REGCACHE is not NULL, the iterator can limit
896    the supported register note sections based on the current register
897    values.  Otherwise it should enumerate all supported register note
898    sections. */
899
900 extern int gdbarch_iterate_over_regset_sections_p (struct gdbarch *gdbarch);
901
902 typedef void (gdbarch_iterate_over_regset_sections_ftype) (struct gdbarch *gdbarch, iterate_over_regset_sections_cb *cb, void *cb_data, const struct regcache *regcache);
903 extern void gdbarch_iterate_over_regset_sections (struct gdbarch *gdbarch, iterate_over_regset_sections_cb *cb, void *cb_data, const struct regcache *regcache);
904 extern void set_gdbarch_iterate_over_regset_sections (struct gdbarch *gdbarch, gdbarch_iterate_over_regset_sections_ftype *iterate_over_regset_sections);
905
906 /* Create core file notes */
907
908 extern int gdbarch_make_corefile_notes_p (struct gdbarch *gdbarch);
909
910 typedef char * (gdbarch_make_corefile_notes_ftype) (struct gdbarch *gdbarch, bfd *obfd, int *note_size);
911 extern char * gdbarch_make_corefile_notes (struct gdbarch *gdbarch, bfd *obfd, int *note_size);
912 extern void set_gdbarch_make_corefile_notes (struct gdbarch *gdbarch, gdbarch_make_corefile_notes_ftype *make_corefile_notes);
913
914 /* Find core file memory regions */
915
916 extern int gdbarch_find_memory_regions_p (struct gdbarch *gdbarch);
917
918 typedef int (gdbarch_find_memory_regions_ftype) (struct gdbarch *gdbarch, find_memory_region_ftype func, void *data);
919 extern int gdbarch_find_memory_regions (struct gdbarch *gdbarch, find_memory_region_ftype func, void *data);
920 extern void set_gdbarch_find_memory_regions (struct gdbarch *gdbarch, gdbarch_find_memory_regions_ftype *find_memory_regions);
921
922 /* Read offset OFFSET of TARGET_OBJECT_LIBRARIES formatted shared libraries list from
923    core file into buffer READBUF with length LEN.  Return the number of bytes read
924    (zero indicates failure).
925    failed, otherwise, return the red length of READBUF. */
926
927 extern int gdbarch_core_xfer_shared_libraries_p (struct gdbarch *gdbarch);
928
929 typedef ULONGEST (gdbarch_core_xfer_shared_libraries_ftype) (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
930 extern ULONGEST gdbarch_core_xfer_shared_libraries (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
931 extern void set_gdbarch_core_xfer_shared_libraries (struct gdbarch *gdbarch, gdbarch_core_xfer_shared_libraries_ftype *core_xfer_shared_libraries);
932
933 /* Read offset OFFSET of TARGET_OBJECT_LIBRARIES_AIX formatted shared
934    libraries list from core file into buffer READBUF with length LEN.
935    Return the number of bytes read (zero indicates failure). */
936
937 extern int gdbarch_core_xfer_shared_libraries_aix_p (struct gdbarch *gdbarch);
938
939 typedef ULONGEST (gdbarch_core_xfer_shared_libraries_aix_ftype) (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
940 extern ULONGEST gdbarch_core_xfer_shared_libraries_aix (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
941 extern void set_gdbarch_core_xfer_shared_libraries_aix (struct gdbarch *gdbarch, gdbarch_core_xfer_shared_libraries_aix_ftype *core_xfer_shared_libraries_aix);
942
943 /* How the core target converts a PTID from a core file to a string. */
944
945 extern int gdbarch_core_pid_to_str_p (struct gdbarch *gdbarch);
946
947 typedef const char * (gdbarch_core_pid_to_str_ftype) (struct gdbarch *gdbarch, ptid_t ptid);
948 extern const char * gdbarch_core_pid_to_str (struct gdbarch *gdbarch, ptid_t ptid);
949 extern void set_gdbarch_core_pid_to_str (struct gdbarch *gdbarch, gdbarch_core_pid_to_str_ftype *core_pid_to_str);
950
951 /* How the core target extracts the name of a thread from a core file. */
952
953 extern int gdbarch_core_thread_name_p (struct gdbarch *gdbarch);
954
955 typedef const char * (gdbarch_core_thread_name_ftype) (struct gdbarch *gdbarch, struct thread_info *thr);
956 extern const char * gdbarch_core_thread_name (struct gdbarch *gdbarch, struct thread_info *thr);
957 extern void set_gdbarch_core_thread_name (struct gdbarch *gdbarch, gdbarch_core_thread_name_ftype *core_thread_name);
958
959 /* Read offset OFFSET of TARGET_OBJECT_SIGNAL_INFO signal information
960    from core file into buffer READBUF with length LEN.  Return the number
961    of bytes read (zero indicates EOF, a negative value indicates failure). */
962
963 extern int gdbarch_core_xfer_siginfo_p (struct gdbarch *gdbarch);
964
965 typedef LONGEST (gdbarch_core_xfer_siginfo_ftype) (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
966 extern LONGEST gdbarch_core_xfer_siginfo (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
967 extern void set_gdbarch_core_xfer_siginfo (struct gdbarch *gdbarch, gdbarch_core_xfer_siginfo_ftype *core_xfer_siginfo);
968
969 /* BFD target to use when generating a core file. */
970
971 extern int gdbarch_gcore_bfd_target_p (struct gdbarch *gdbarch);
972
973 extern const char * gdbarch_gcore_bfd_target (struct gdbarch *gdbarch);
974 extern void set_gdbarch_gcore_bfd_target (struct gdbarch *gdbarch, const char * gcore_bfd_target);
975
976 /* If the elements of C++ vtables are in-place function descriptors rather
977    than normal function pointers (which may point to code or a descriptor),
978    set this to one. */
979
980 extern int gdbarch_vtable_function_descriptors (struct gdbarch *gdbarch);
981 extern void set_gdbarch_vtable_function_descriptors (struct gdbarch *gdbarch, int vtable_function_descriptors);
982
983 /* Set if the least significant bit of the delta is used instead of the least
984    significant bit of the pfn for pointers to virtual member functions. */
985
986 extern int gdbarch_vbit_in_delta (struct gdbarch *gdbarch);
987 extern void set_gdbarch_vbit_in_delta (struct gdbarch *gdbarch, int vbit_in_delta);
988
989 /* Advance PC to next instruction in order to skip a permanent breakpoint. */
990
991 typedef void (gdbarch_skip_permanent_breakpoint_ftype) (struct regcache *regcache);
992 extern void gdbarch_skip_permanent_breakpoint (struct gdbarch *gdbarch, struct regcache *regcache);
993 extern void set_gdbarch_skip_permanent_breakpoint (struct gdbarch *gdbarch, gdbarch_skip_permanent_breakpoint_ftype *skip_permanent_breakpoint);
994
995 /* The maximum length of an instruction on this architecture in bytes. */
996
997 extern int gdbarch_max_insn_length_p (struct gdbarch *gdbarch);
998
999 extern ULONGEST gdbarch_max_insn_length (struct gdbarch *gdbarch);
1000 extern void set_gdbarch_max_insn_length (struct gdbarch *gdbarch, ULONGEST max_insn_length);
1001
1002 /* Copy the instruction at FROM to TO, and make any adjustments
1003    necessary to single-step it at that address.
1004   
1005    REGS holds the state the thread's registers will have before
1006    executing the copied instruction; the PC in REGS will refer to FROM,
1007    not the copy at TO.  The caller should update it to point at TO later.
1008   
1009    Return a pointer to data of the architecture's choice to be passed
1010    to gdbarch_displaced_step_fixup.  Or, return NULL to indicate that
1011    the instruction's effects have been completely simulated, with the
1012    resulting state written back to REGS.
1013   
1014    For a general explanation of displaced stepping and how GDB uses it,
1015    see the comments in infrun.c.
1016   
1017    The TO area is only guaranteed to have space for
1018    gdbarch_max_insn_length (arch) bytes, so this function must not
1019    write more bytes than that to that area.
1020   
1021    If you do not provide this function, GDB assumes that the
1022    architecture does not support displaced stepping.
1023   
1024    If the instruction cannot execute out of line, return NULL.  The
1025    core falls back to stepping past the instruction in-line instead in
1026    that case. */
1027
1028 extern int gdbarch_displaced_step_copy_insn_p (struct gdbarch *gdbarch);
1029
1030 typedef struct displaced_step_closure * (gdbarch_displaced_step_copy_insn_ftype) (struct gdbarch *gdbarch, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
1031 extern struct displaced_step_closure * gdbarch_displaced_step_copy_insn (struct gdbarch *gdbarch, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
1032 extern void set_gdbarch_displaced_step_copy_insn (struct gdbarch *gdbarch, gdbarch_displaced_step_copy_insn_ftype *displaced_step_copy_insn);
1033
1034 /* Return true if GDB should use hardware single-stepping to execute
1035    the displaced instruction identified by CLOSURE.  If false,
1036    GDB will simply restart execution at the displaced instruction
1037    location, and it is up to the target to ensure GDB will receive
1038    control again (e.g. by placing a software breakpoint instruction
1039    into the displaced instruction buffer).
1040   
1041    The default implementation returns false on all targets that
1042    provide a gdbarch_software_single_step routine, and true otherwise. */
1043
1044 typedef int (gdbarch_displaced_step_hw_singlestep_ftype) (struct gdbarch *gdbarch, struct displaced_step_closure *closure);
1045 extern int gdbarch_displaced_step_hw_singlestep (struct gdbarch *gdbarch, struct displaced_step_closure *closure);
1046 extern void set_gdbarch_displaced_step_hw_singlestep (struct gdbarch *gdbarch, gdbarch_displaced_step_hw_singlestep_ftype *displaced_step_hw_singlestep);
1047
1048 /* Fix up the state resulting from successfully single-stepping a
1049    displaced instruction, to give the result we would have gotten from
1050    stepping the instruction in its original location.
1051   
1052    REGS is the register state resulting from single-stepping the
1053    displaced instruction.
1054   
1055    CLOSURE is the result from the matching call to
1056    gdbarch_displaced_step_copy_insn.
1057   
1058    If you provide gdbarch_displaced_step_copy_insn.but not this
1059    function, then GDB assumes that no fixup is needed after
1060    single-stepping the instruction.
1061   
1062    For a general explanation of displaced stepping and how GDB uses it,
1063    see the comments in infrun.c. */
1064
1065 extern int gdbarch_displaced_step_fixup_p (struct gdbarch *gdbarch);
1066
1067 typedef void (gdbarch_displaced_step_fixup_ftype) (struct gdbarch *gdbarch, struct displaced_step_closure *closure, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
1068 extern void gdbarch_displaced_step_fixup (struct gdbarch *gdbarch, struct displaced_step_closure *closure, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
1069 extern void set_gdbarch_displaced_step_fixup (struct gdbarch *gdbarch, gdbarch_displaced_step_fixup_ftype *displaced_step_fixup);
1070
1071 /* Return the address of an appropriate place to put displaced
1072    instructions while we step over them.  There need only be one such
1073    place, since we're only stepping one thread over a breakpoint at a
1074    time.
1075   
1076    For a general explanation of displaced stepping and how GDB uses it,
1077    see the comments in infrun.c. */
1078
1079 typedef CORE_ADDR (gdbarch_displaced_step_location_ftype) (struct gdbarch *gdbarch);
1080 extern CORE_ADDR gdbarch_displaced_step_location (struct gdbarch *gdbarch);
1081 extern void set_gdbarch_displaced_step_location (struct gdbarch *gdbarch, gdbarch_displaced_step_location_ftype *displaced_step_location);
1082
1083 /* Relocate an instruction to execute at a different address.  OLDLOC
1084    is the address in the inferior memory where the instruction to
1085    relocate is currently at.  On input, TO points to the destination
1086    where we want the instruction to be copied (and possibly adjusted)
1087    to.  On output, it points to one past the end of the resulting
1088    instruction(s).  The effect of executing the instruction at TO shall
1089    be the same as if executing it at FROM.  For example, call
1090    instructions that implicitly push the return address on the stack
1091    should be adjusted to return to the instruction after OLDLOC;
1092    relative branches, and other PC-relative instructions need the
1093    offset adjusted; etc. */
1094
1095 extern int gdbarch_relocate_instruction_p (struct gdbarch *gdbarch);
1096
1097 typedef void (gdbarch_relocate_instruction_ftype) (struct gdbarch *gdbarch, CORE_ADDR *to, CORE_ADDR from);
1098 extern void gdbarch_relocate_instruction (struct gdbarch *gdbarch, CORE_ADDR *to, CORE_ADDR from);
1099 extern void set_gdbarch_relocate_instruction (struct gdbarch *gdbarch, gdbarch_relocate_instruction_ftype *relocate_instruction);
1100
1101 /* Refresh overlay mapped state for section OSECT. */
1102
1103 extern int gdbarch_overlay_update_p (struct gdbarch *gdbarch);
1104
1105 typedef void (gdbarch_overlay_update_ftype) (struct obj_section *osect);
1106 extern void gdbarch_overlay_update (struct gdbarch *gdbarch, struct obj_section *osect);
1107 extern void set_gdbarch_overlay_update (struct gdbarch *gdbarch, gdbarch_overlay_update_ftype *overlay_update);
1108
1109 extern int gdbarch_core_read_description_p (struct gdbarch *gdbarch);
1110
1111 typedef const struct target_desc * (gdbarch_core_read_description_ftype) (struct gdbarch *gdbarch, struct target_ops *target, bfd *abfd);
1112 extern const struct target_desc * gdbarch_core_read_description (struct gdbarch *gdbarch, struct target_ops *target, bfd *abfd);
1113 extern void set_gdbarch_core_read_description (struct gdbarch *gdbarch, gdbarch_core_read_description_ftype *core_read_description);
1114
1115 /* Handle special encoding of static variables in stabs debug info. */
1116
1117 extern int gdbarch_static_transform_name_p (struct gdbarch *gdbarch);
1118
1119 typedef const char * (gdbarch_static_transform_name_ftype) (const char *name);
1120 extern const char * gdbarch_static_transform_name (struct gdbarch *gdbarch, const char *name);
1121 extern void set_gdbarch_static_transform_name (struct gdbarch *gdbarch, gdbarch_static_transform_name_ftype *static_transform_name);
1122
1123 /* Set if the address in N_SO or N_FUN stabs may be zero. */
1124
1125 extern int gdbarch_sofun_address_maybe_missing (struct gdbarch *gdbarch);
1126 extern void set_gdbarch_sofun_address_maybe_missing (struct gdbarch *gdbarch, int sofun_address_maybe_missing);
1127
1128 /* Parse the instruction at ADDR storing in the record execution log
1129    the registers REGCACHE and memory ranges that will be affected when
1130    the instruction executes, along with their current values.
1131    Return -1 if something goes wrong, 0 otherwise. */
1132
1133 extern int gdbarch_process_record_p (struct gdbarch *gdbarch);
1134
1135 typedef int (gdbarch_process_record_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr);
1136 extern int gdbarch_process_record (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr);
1137 extern void set_gdbarch_process_record (struct gdbarch *gdbarch, gdbarch_process_record_ftype *process_record);
1138
1139 /* Save process state after a signal.
1140    Return -1 if something goes wrong, 0 otherwise. */
1141
1142 extern int gdbarch_process_record_signal_p (struct gdbarch *gdbarch);
1143
1144 typedef int (gdbarch_process_record_signal_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, enum gdb_signal signal);
1145 extern int gdbarch_process_record_signal (struct gdbarch *gdbarch, struct regcache *regcache, enum gdb_signal signal);
1146 extern void set_gdbarch_process_record_signal (struct gdbarch *gdbarch, gdbarch_process_record_signal_ftype *process_record_signal);
1147
1148 /* Signal translation: translate inferior's signal (target's) number
1149    into GDB's representation.  The implementation of this method must
1150    be host independent.  IOW, don't rely on symbols of the NAT_FILE
1151    header (the nm-*.h files), the host <signal.h> header, or similar
1152    headers.  This is mainly used when cross-debugging core files ---
1153    "Live" targets hide the translation behind the target interface
1154    (target_wait, target_resume, etc.). */
1155
1156 extern int gdbarch_gdb_signal_from_target_p (struct gdbarch *gdbarch);
1157
1158 typedef enum gdb_signal (gdbarch_gdb_signal_from_target_ftype) (struct gdbarch *gdbarch, int signo);
1159 extern enum gdb_signal gdbarch_gdb_signal_from_target (struct gdbarch *gdbarch, int signo);
1160 extern void set_gdbarch_gdb_signal_from_target (struct gdbarch *gdbarch, gdbarch_gdb_signal_from_target_ftype *gdb_signal_from_target);
1161
1162 /* Signal translation: translate the GDB's internal signal number into
1163    the inferior's signal (target's) representation.  The implementation
1164    of this method must be host independent.  IOW, don't rely on symbols
1165    of the NAT_FILE header (the nm-*.h files), the host <signal.h>
1166    header, or similar headers.
1167    Return the target signal number if found, or -1 if the GDB internal
1168    signal number is invalid. */
1169
1170 extern int gdbarch_gdb_signal_to_target_p (struct gdbarch *gdbarch);
1171
1172 typedef int (gdbarch_gdb_signal_to_target_ftype) (struct gdbarch *gdbarch, enum gdb_signal signal);
1173 extern int gdbarch_gdb_signal_to_target (struct gdbarch *gdbarch, enum gdb_signal signal);
1174 extern void set_gdbarch_gdb_signal_to_target (struct gdbarch *gdbarch, gdbarch_gdb_signal_to_target_ftype *gdb_signal_to_target);
1175
1176 /* Extra signal info inspection.
1177   
1178    Return a type suitable to inspect extra signal information. */
1179
1180 extern int gdbarch_get_siginfo_type_p (struct gdbarch *gdbarch);
1181
1182 typedef struct type * (gdbarch_get_siginfo_type_ftype) (struct gdbarch *gdbarch);
1183 extern struct type * gdbarch_get_siginfo_type (struct gdbarch *gdbarch);
1184 extern void set_gdbarch_get_siginfo_type (struct gdbarch *gdbarch, gdbarch_get_siginfo_type_ftype *get_siginfo_type);
1185
1186 /* Record architecture-specific information from the symbol table. */
1187
1188 extern int gdbarch_record_special_symbol_p (struct gdbarch *gdbarch);
1189
1190 typedef void (gdbarch_record_special_symbol_ftype) (struct gdbarch *gdbarch, struct objfile *objfile, asymbol *sym);
1191 extern void gdbarch_record_special_symbol (struct gdbarch *gdbarch, struct objfile *objfile, asymbol *sym);
1192 extern void set_gdbarch_record_special_symbol (struct gdbarch *gdbarch, gdbarch_record_special_symbol_ftype *record_special_symbol);
1193
1194 /* Function for the 'catch syscall' feature.
1195    Get architecture-specific system calls information from registers. */
1196
1197 extern int gdbarch_get_syscall_number_p (struct gdbarch *gdbarch);
1198
1199 typedef LONGEST (gdbarch_get_syscall_number_ftype) (struct gdbarch *gdbarch, thread_info *thread);
1200 extern LONGEST gdbarch_get_syscall_number (struct gdbarch *gdbarch, thread_info *thread);
1201 extern void set_gdbarch_get_syscall_number (struct gdbarch *gdbarch, gdbarch_get_syscall_number_ftype *get_syscall_number);
1202
1203 /* The filename of the XML syscall for this architecture. */
1204
1205 extern const char * gdbarch_xml_syscall_file (struct gdbarch *gdbarch);
1206 extern void set_gdbarch_xml_syscall_file (struct gdbarch *gdbarch, const char * xml_syscall_file);
1207
1208 /* Information about system calls from this architecture */
1209
1210 extern struct syscalls_info * gdbarch_syscalls_info (struct gdbarch *gdbarch);
1211 extern void set_gdbarch_syscalls_info (struct gdbarch *gdbarch, struct syscalls_info * syscalls_info);
1212
1213 /* SystemTap related fields and functions.
1214    A NULL-terminated array of prefixes used to mark an integer constant
1215    on the architecture's assembly.
1216    For example, on x86 integer constants are written as:
1217   
1218     $10 ;; integer constant 10
1219   
1220    in this case, this prefix would be the character `$'. */
1221
1222 extern const char *const * gdbarch_stap_integer_prefixes (struct gdbarch *gdbarch);
1223 extern void set_gdbarch_stap_integer_prefixes (struct gdbarch *gdbarch, const char *const * stap_integer_prefixes);
1224
1225 /* A NULL-terminated array of suffixes used to mark an integer constant
1226    on the architecture's assembly. */
1227
1228 extern const char *const * gdbarch_stap_integer_suffixes (struct gdbarch *gdbarch);
1229 extern void set_gdbarch_stap_integer_suffixes (struct gdbarch *gdbarch, const char *const * stap_integer_suffixes);
1230
1231 /* A NULL-terminated array of prefixes used to mark a register name on
1232    the architecture's assembly.
1233    For example, on x86 the register name is written as:
1234   
1235     %eax ;; register eax
1236   
1237    in this case, this prefix would be the character `%'. */
1238
1239 extern const char *const * gdbarch_stap_register_prefixes (struct gdbarch *gdbarch);
1240 extern void set_gdbarch_stap_register_prefixes (struct gdbarch *gdbarch, const char *const * stap_register_prefixes);
1241
1242 /* A NULL-terminated array of suffixes used to mark a register name on
1243    the architecture's assembly. */
1244
1245 extern const char *const * gdbarch_stap_register_suffixes (struct gdbarch *gdbarch);
1246 extern void set_gdbarch_stap_register_suffixes (struct gdbarch *gdbarch, const char *const * stap_register_suffixes);
1247
1248 /* A NULL-terminated array of prefixes used to mark a register
1249    indirection on the architecture's assembly.
1250    For example, on x86 the register indirection is written as:
1251   
1252     (%eax) ;; indirecting eax
1253   
1254    in this case, this prefix would be the charater `('.
1255   
1256    Please note that we use the indirection prefix also for register
1257    displacement, e.g., `4(%eax)' on x86. */
1258
1259 extern const char *const * gdbarch_stap_register_indirection_prefixes (struct gdbarch *gdbarch);
1260 extern void set_gdbarch_stap_register_indirection_prefixes (struct gdbarch *gdbarch, const char *const * stap_register_indirection_prefixes);
1261
1262 /* A NULL-terminated array of suffixes used to mark a register
1263    indirection on the architecture's assembly.
1264    For example, on x86 the register indirection is written as:
1265   
1266     (%eax) ;; indirecting eax
1267   
1268    in this case, this prefix would be the charater `)'.
1269   
1270    Please note that we use the indirection suffix also for register
1271    displacement, e.g., `4(%eax)' on x86. */
1272
1273 extern const char *const * gdbarch_stap_register_indirection_suffixes (struct gdbarch *gdbarch);
1274 extern void set_gdbarch_stap_register_indirection_suffixes (struct gdbarch *gdbarch, const char *const * stap_register_indirection_suffixes);
1275
1276 /* Prefix(es) used to name a register using GDB's nomenclature.
1277   
1278    For example, on PPC a register is represented by a number in the assembly
1279    language (e.g., `10' is the 10th general-purpose register).  However,
1280    inside GDB this same register has an `r' appended to its name, so the 10th
1281    register would be represented as `r10' internally. */
1282
1283 extern const char * gdbarch_stap_gdb_register_prefix (struct gdbarch *gdbarch);
1284 extern void set_gdbarch_stap_gdb_register_prefix (struct gdbarch *gdbarch, const char * stap_gdb_register_prefix);
1285
1286 /* Suffix used to name a register using GDB's nomenclature. */
1287
1288 extern const char * gdbarch_stap_gdb_register_suffix (struct gdbarch *gdbarch);
1289 extern void set_gdbarch_stap_gdb_register_suffix (struct gdbarch *gdbarch, const char * stap_gdb_register_suffix);
1290
1291 /* Check if S is a single operand.
1292   
1293    Single operands can be:
1294     - Literal integers, e.g. `$10' on x86
1295     - Register access, e.g. `%eax' on x86
1296     - Register indirection, e.g. `(%eax)' on x86
1297     - Register displacement, e.g. `4(%eax)' on x86
1298   
1299    This function should check for these patterns on the string
1300    and return 1 if some were found, or zero otherwise.  Please try to match
1301    as much info as you can from the string, i.e., if you have to match
1302    something like `(%', do not match just the `('. */
1303
1304 extern int gdbarch_stap_is_single_operand_p (struct gdbarch *gdbarch);
1305
1306 typedef int (gdbarch_stap_is_single_operand_ftype) (struct gdbarch *gdbarch, const char *s);
1307 extern int gdbarch_stap_is_single_operand (struct gdbarch *gdbarch, const char *s);
1308 extern void set_gdbarch_stap_is_single_operand (struct gdbarch *gdbarch, gdbarch_stap_is_single_operand_ftype *stap_is_single_operand);
1309
1310 /* Function used to handle a "special case" in the parser.
1311   
1312    A "special case" is considered to be an unknown token, i.e., a token
1313    that the parser does not know how to parse.  A good example of special
1314    case would be ARM's register displacement syntax:
1315   
1316     [R0, #4]  ;; displacing R0 by 4
1317   
1318    Since the parser assumes that a register displacement is of the form:
1319   
1320     <number> <indirection_prefix> <register_name> <indirection_suffix>
1321   
1322    it means that it will not be able to recognize and parse this odd syntax.
1323    Therefore, we should add a special case function that will handle this token.
1324   
1325    This function should generate the proper expression form of the expression
1326    using GDB's internal expression mechanism (e.g., `write_exp_elt_opcode'
1327    and so on).  It should also return 1 if the parsing was successful, or zero
1328    if the token was not recognized as a special token (in this case, returning
1329    zero means that the special parser is deferring the parsing to the generic
1330    parser), and should advance the buffer pointer (p->arg). */
1331
1332 extern int gdbarch_stap_parse_special_token_p (struct gdbarch *gdbarch);
1333
1334 typedef int (gdbarch_stap_parse_special_token_ftype) (struct gdbarch *gdbarch, struct stap_parse_info *p);
1335 extern int gdbarch_stap_parse_special_token (struct gdbarch *gdbarch, struct stap_parse_info *p);
1336 extern void set_gdbarch_stap_parse_special_token (struct gdbarch *gdbarch, gdbarch_stap_parse_special_token_ftype *stap_parse_special_token);
1337
1338 /* DTrace related functions.
1339    The expression to compute the NARTGth+1 argument to a DTrace USDT probe.
1340    NARG must be >= 0. */
1341
1342 extern int gdbarch_dtrace_parse_probe_argument_p (struct gdbarch *gdbarch);
1343
1344 typedef void (gdbarch_dtrace_parse_probe_argument_ftype) (struct gdbarch *gdbarch, struct parser_state *pstate, int narg);
1345 extern void gdbarch_dtrace_parse_probe_argument (struct gdbarch *gdbarch, struct parser_state *pstate, int narg);
1346 extern void set_gdbarch_dtrace_parse_probe_argument (struct gdbarch *gdbarch, gdbarch_dtrace_parse_probe_argument_ftype *dtrace_parse_probe_argument);
1347
1348 /* True if the given ADDR does not contain the instruction sequence
1349    corresponding to a disabled DTrace is-enabled probe. */
1350
1351 extern int gdbarch_dtrace_probe_is_enabled_p (struct gdbarch *gdbarch);
1352
1353 typedef int (gdbarch_dtrace_probe_is_enabled_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
1354 extern int gdbarch_dtrace_probe_is_enabled (struct gdbarch *gdbarch, CORE_ADDR addr);
1355 extern void set_gdbarch_dtrace_probe_is_enabled (struct gdbarch *gdbarch, gdbarch_dtrace_probe_is_enabled_ftype *dtrace_probe_is_enabled);
1356
1357 /* Enable a DTrace is-enabled probe at ADDR. */
1358
1359 extern int gdbarch_dtrace_enable_probe_p (struct gdbarch *gdbarch);
1360
1361 typedef void (gdbarch_dtrace_enable_probe_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
1362 extern void gdbarch_dtrace_enable_probe (struct gdbarch *gdbarch, CORE_ADDR addr);
1363 extern void set_gdbarch_dtrace_enable_probe (struct gdbarch *gdbarch, gdbarch_dtrace_enable_probe_ftype *dtrace_enable_probe);
1364
1365 /* Disable a DTrace is-enabled probe at ADDR. */
1366
1367 extern int gdbarch_dtrace_disable_probe_p (struct gdbarch *gdbarch);
1368
1369 typedef void (gdbarch_dtrace_disable_probe_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
1370 extern void gdbarch_dtrace_disable_probe (struct gdbarch *gdbarch, CORE_ADDR addr);
1371 extern void set_gdbarch_dtrace_disable_probe (struct gdbarch *gdbarch, gdbarch_dtrace_disable_probe_ftype *dtrace_disable_probe);
1372
1373 /* True if the list of shared libraries is one and only for all
1374    processes, as opposed to a list of shared libraries per inferior.
1375    This usually means that all processes, although may or may not share
1376    an address space, will see the same set of symbols at the same
1377    addresses. */
1378
1379 extern int gdbarch_has_global_solist (struct gdbarch *gdbarch);
1380 extern void set_gdbarch_has_global_solist (struct gdbarch *gdbarch, int has_global_solist);
1381
1382 /* On some targets, even though each inferior has its own private
1383    address space, the debug interface takes care of making breakpoints
1384    visible to all address spaces automatically.  For such cases,
1385    this property should be set to true. */
1386
1387 extern int gdbarch_has_global_breakpoints (struct gdbarch *gdbarch);
1388 extern void set_gdbarch_has_global_breakpoints (struct gdbarch *gdbarch, int has_global_breakpoints);
1389
1390 /* True if inferiors share an address space (e.g., uClinux). */
1391
1392 typedef int (gdbarch_has_shared_address_space_ftype) (struct gdbarch *gdbarch);
1393 extern int gdbarch_has_shared_address_space (struct gdbarch *gdbarch);
1394 extern void set_gdbarch_has_shared_address_space (struct gdbarch *gdbarch, gdbarch_has_shared_address_space_ftype *has_shared_address_space);
1395
1396 /* True if a fast tracepoint can be set at an address. */
1397
1398 typedef int (gdbarch_fast_tracepoint_valid_at_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr, std::string *msg);
1399 extern int gdbarch_fast_tracepoint_valid_at (struct gdbarch *gdbarch, CORE_ADDR addr, std::string *msg);
1400 extern void set_gdbarch_fast_tracepoint_valid_at (struct gdbarch *gdbarch, gdbarch_fast_tracepoint_valid_at_ftype *fast_tracepoint_valid_at);
1401
1402 /* Guess register state based on tracepoint location.  Used for tracepoints
1403    where no registers have been collected, but there's only one location,
1404    allowing us to guess the PC value, and perhaps some other registers.
1405    On entry, regcache has all registers marked as unavailable. */
1406
1407 typedef void (gdbarch_guess_tracepoint_registers_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr);
1408 extern void gdbarch_guess_tracepoint_registers (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr);
1409 extern void set_gdbarch_guess_tracepoint_registers (struct gdbarch *gdbarch, gdbarch_guess_tracepoint_registers_ftype *guess_tracepoint_registers);
1410
1411 /* Return the "auto" target charset. */
1412
1413 typedef const char * (gdbarch_auto_charset_ftype) (void);
1414 extern const char * gdbarch_auto_charset (struct gdbarch *gdbarch);
1415 extern void set_gdbarch_auto_charset (struct gdbarch *gdbarch, gdbarch_auto_charset_ftype *auto_charset);
1416
1417 /* Return the "auto" target wide charset. */
1418
1419 typedef const char * (gdbarch_auto_wide_charset_ftype) (void);
1420 extern const char * gdbarch_auto_wide_charset (struct gdbarch *gdbarch);
1421 extern void set_gdbarch_auto_wide_charset (struct gdbarch *gdbarch, gdbarch_auto_wide_charset_ftype *auto_wide_charset);
1422
1423 /* If non-empty, this is a file extension that will be opened in place
1424    of the file extension reported by the shared library list.
1425   
1426    This is most useful for toolchains that use a post-linker tool,
1427    where the names of the files run on the target differ in extension
1428    compared to the names of the files GDB should load for debug info. */
1429
1430 extern const char * gdbarch_solib_symbols_extension (struct gdbarch *gdbarch);
1431 extern void set_gdbarch_solib_symbols_extension (struct gdbarch *gdbarch, const char * solib_symbols_extension);
1432
1433 /* If true, the target OS has DOS-based file system semantics.  That
1434    is, absolute paths include a drive name, and the backslash is
1435    considered a directory separator. */
1436
1437 extern int gdbarch_has_dos_based_file_system (struct gdbarch *gdbarch);
1438 extern void set_gdbarch_has_dos_based_file_system (struct gdbarch *gdbarch, int has_dos_based_file_system);
1439
1440 /* Generate bytecodes to collect the return address in a frame.
1441    Since the bytecodes run on the target, possibly with GDB not even
1442    connected, the full unwinding machinery is not available, and
1443    typically this function will issue bytecodes for one or more likely
1444    places that the return address may be found. */
1445
1446 typedef void (gdbarch_gen_return_address_ftype) (struct gdbarch *gdbarch, struct agent_expr *ax, struct axs_value *value, CORE_ADDR scope);
1447 extern void gdbarch_gen_return_address (struct gdbarch *gdbarch, struct agent_expr *ax, struct axs_value *value, CORE_ADDR scope);
1448 extern void set_gdbarch_gen_return_address (struct gdbarch *gdbarch, gdbarch_gen_return_address_ftype *gen_return_address);
1449
1450 /* Implement the "info proc" command. */
1451
1452 extern int gdbarch_info_proc_p (struct gdbarch *gdbarch);
1453
1454 typedef void (gdbarch_info_proc_ftype) (struct gdbarch *gdbarch, const char *args, enum info_proc_what what);
1455 extern void gdbarch_info_proc (struct gdbarch *gdbarch, const char *args, enum info_proc_what what);
1456 extern void set_gdbarch_info_proc (struct gdbarch *gdbarch, gdbarch_info_proc_ftype *info_proc);
1457
1458 /* Implement the "info proc" command for core files.  Noe that there
1459    are two "info_proc"-like methods on gdbarch -- one for core files,
1460    one for live targets. */
1461
1462 extern int gdbarch_core_info_proc_p (struct gdbarch *gdbarch);
1463
1464 typedef void (gdbarch_core_info_proc_ftype) (struct gdbarch *gdbarch, const char *args, enum info_proc_what what);
1465 extern void gdbarch_core_info_proc (struct gdbarch *gdbarch, const char *args, enum info_proc_what what);
1466 extern void set_gdbarch_core_info_proc (struct gdbarch *gdbarch, gdbarch_core_info_proc_ftype *core_info_proc);
1467
1468 /* Iterate over all objfiles in the order that makes the most sense
1469    for the architecture to make global symbol searches.
1470   
1471    CB is a callback function where OBJFILE is the objfile to be searched,
1472    and CB_DATA a pointer to user-defined data (the same data that is passed
1473    when calling this gdbarch method).  The iteration stops if this function
1474    returns nonzero.
1475   
1476    CB_DATA is a pointer to some user-defined data to be passed to
1477    the callback.
1478   
1479    If not NULL, CURRENT_OBJFILE corresponds to the objfile being
1480    inspected when the symbol search was requested. */
1481
1482 typedef void (gdbarch_iterate_over_objfiles_in_search_order_ftype) (struct gdbarch *gdbarch, iterate_over_objfiles_in_search_order_cb_ftype *cb, void *cb_data, struct objfile *current_objfile);
1483 extern void gdbarch_iterate_over_objfiles_in_search_order (struct gdbarch *gdbarch, iterate_over_objfiles_in_search_order_cb_ftype *cb, void *cb_data, struct objfile *current_objfile);
1484 extern void set_gdbarch_iterate_over_objfiles_in_search_order (struct gdbarch *gdbarch, gdbarch_iterate_over_objfiles_in_search_order_ftype *iterate_over_objfiles_in_search_order);
1485
1486 /* Ravenscar arch-dependent ops. */
1487
1488 extern struct ravenscar_arch_ops * gdbarch_ravenscar_ops (struct gdbarch *gdbarch);
1489 extern void set_gdbarch_ravenscar_ops (struct gdbarch *gdbarch, struct ravenscar_arch_ops * ravenscar_ops);
1490
1491 /* Return non-zero if the instruction at ADDR is a call; zero otherwise. */
1492
1493 typedef int (gdbarch_insn_is_call_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
1494 extern int gdbarch_insn_is_call (struct gdbarch *gdbarch, CORE_ADDR addr);
1495 extern void set_gdbarch_insn_is_call (struct gdbarch *gdbarch, gdbarch_insn_is_call_ftype *insn_is_call);
1496
1497 /* Return non-zero if the instruction at ADDR is a return; zero otherwise. */
1498
1499 typedef int (gdbarch_insn_is_ret_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
1500 extern int gdbarch_insn_is_ret (struct gdbarch *gdbarch, CORE_ADDR addr);
1501 extern void set_gdbarch_insn_is_ret (struct gdbarch *gdbarch, gdbarch_insn_is_ret_ftype *insn_is_ret);
1502
1503 /* Return non-zero if the instruction at ADDR is a jump; zero otherwise. */
1504
1505 typedef int (gdbarch_insn_is_jump_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
1506 extern int gdbarch_insn_is_jump (struct gdbarch *gdbarch, CORE_ADDR addr);
1507 extern void set_gdbarch_insn_is_jump (struct gdbarch *gdbarch, gdbarch_insn_is_jump_ftype *insn_is_jump);
1508
1509 /* Read one auxv entry from *READPTR, not reading locations >= ENDPTR.
1510    Return 0 if *READPTR is already at the end of the buffer.
1511    Return -1 if there is insufficient buffer for a whole entry.
1512    Return 1 if an entry was read into *TYPEP and *VALP. */
1513
1514 extern int gdbarch_auxv_parse_p (struct gdbarch *gdbarch);
1515
1516 typedef int (gdbarch_auxv_parse_ftype) (struct gdbarch *gdbarch, gdb_byte **readptr, gdb_byte *endptr, CORE_ADDR *typep, CORE_ADDR *valp);
1517 extern int gdbarch_auxv_parse (struct gdbarch *gdbarch, gdb_byte **readptr, gdb_byte *endptr, CORE_ADDR *typep, CORE_ADDR *valp);
1518 extern void set_gdbarch_auxv_parse (struct gdbarch *gdbarch, gdbarch_auxv_parse_ftype *auxv_parse);
1519
1520 /* Print the description of a single auxv entry described by TYPE and VAL
1521    to FILE. */
1522
1523 typedef void (gdbarch_print_auxv_entry_ftype) (struct gdbarch *gdbarch, struct ui_file *file, CORE_ADDR type, CORE_ADDR val);
1524 extern void gdbarch_print_auxv_entry (struct gdbarch *gdbarch, struct ui_file *file, CORE_ADDR type, CORE_ADDR val);
1525 extern void set_gdbarch_print_auxv_entry (struct gdbarch *gdbarch, gdbarch_print_auxv_entry_ftype *print_auxv_entry);
1526
1527 /* Find the address range of the current inferior's vsyscall/vDSO, and
1528    write it to *RANGE.  If the vsyscall's length can't be determined, a
1529    range with zero length is returned.  Returns true if the vsyscall is
1530    found, false otherwise. */
1531
1532 typedef int (gdbarch_vsyscall_range_ftype) (struct gdbarch *gdbarch, struct mem_range *range);
1533 extern int gdbarch_vsyscall_range (struct gdbarch *gdbarch, struct mem_range *range);
1534 extern void set_gdbarch_vsyscall_range (struct gdbarch *gdbarch, gdbarch_vsyscall_range_ftype *vsyscall_range);
1535
1536 /* Allocate SIZE bytes of PROT protected page aligned memory in inferior.
1537    PROT has GDB_MMAP_PROT_* bitmask format.
1538    Throw an error if it is not possible.  Returned address is always valid. */
1539
1540 typedef CORE_ADDR (gdbarch_infcall_mmap_ftype) (CORE_ADDR size, unsigned prot);
1541 extern CORE_ADDR gdbarch_infcall_mmap (struct gdbarch *gdbarch, CORE_ADDR size, unsigned prot);
1542 extern void set_gdbarch_infcall_mmap (struct gdbarch *gdbarch, gdbarch_infcall_mmap_ftype *infcall_mmap);
1543
1544 /* Deallocate SIZE bytes of memory at ADDR in inferior from gdbarch_infcall_mmap.
1545    Print a warning if it is not possible. */
1546
1547 typedef void (gdbarch_infcall_munmap_ftype) (CORE_ADDR addr, CORE_ADDR size);
1548 extern void gdbarch_infcall_munmap (struct gdbarch *gdbarch, CORE_ADDR addr, CORE_ADDR size);
1549 extern void set_gdbarch_infcall_munmap (struct gdbarch *gdbarch, gdbarch_infcall_munmap_ftype *infcall_munmap);
1550
1551 /* Return string (caller has to use xfree for it) with options for GCC
1552    to produce code for this target, typically "-m64", "-m32" or "-m31".
1553    These options are put before CU's DW_AT_producer compilation options so that
1554    they can override it.  Method may also return NULL. */
1555
1556 typedef char * (gdbarch_gcc_target_options_ftype) (struct gdbarch *gdbarch);
1557 extern char * gdbarch_gcc_target_options (struct gdbarch *gdbarch);
1558 extern void set_gdbarch_gcc_target_options (struct gdbarch *gdbarch, gdbarch_gcc_target_options_ftype *gcc_target_options);
1559
1560 /* Return a regular expression that matches names used by this
1561    architecture in GNU configury triplets.  The result is statically
1562    allocated and must not be freed.  The default implementation simply
1563    returns the BFD architecture name, which is correct in nearly every
1564    case. */
1565
1566 typedef const char * (gdbarch_gnu_triplet_regexp_ftype) (struct gdbarch *gdbarch);
1567 extern const char * gdbarch_gnu_triplet_regexp (struct gdbarch *gdbarch);
1568 extern void set_gdbarch_gnu_triplet_regexp (struct gdbarch *gdbarch, gdbarch_gnu_triplet_regexp_ftype *gnu_triplet_regexp);
1569
1570 /* Return the size in 8-bit bytes of an addressable memory unit on this
1571    architecture.  This corresponds to the number of 8-bit bytes associated to
1572    each address in memory. */
1573
1574 typedef int (gdbarch_addressable_memory_unit_size_ftype) (struct gdbarch *gdbarch);
1575 extern int gdbarch_addressable_memory_unit_size (struct gdbarch *gdbarch);
1576 extern void set_gdbarch_addressable_memory_unit_size (struct gdbarch *gdbarch, gdbarch_addressable_memory_unit_size_ftype *addressable_memory_unit_size);
1577
1578 /* Functions for allowing a target to modify its disassembler options. */
1579
1580 extern const char * gdbarch_disassembler_options_implicit (struct gdbarch *gdbarch);
1581 extern void set_gdbarch_disassembler_options_implicit (struct gdbarch *gdbarch, const char * disassembler_options_implicit);
1582
1583 extern char ** gdbarch_disassembler_options (struct gdbarch *gdbarch);
1584 extern void set_gdbarch_disassembler_options (struct gdbarch *gdbarch, char ** disassembler_options);
1585
1586 extern const disasm_options_and_args_t * gdbarch_valid_disassembler_options (struct gdbarch *gdbarch);
1587 extern void set_gdbarch_valid_disassembler_options (struct gdbarch *gdbarch, const disasm_options_and_args_t * valid_disassembler_options);
1588
1589 /* Type alignment. */
1590
1591 typedef ULONGEST (gdbarch_type_align_ftype) (struct gdbarch *gdbarch, struct type *type);
1592 extern ULONGEST gdbarch_type_align (struct gdbarch *gdbarch, struct type *type);
1593 extern void set_gdbarch_type_align (struct gdbarch *gdbarch, gdbarch_type_align_ftype *type_align);
1594
1595 /* Definition for an unknown syscall, used basically in error-cases.  */
1596 #define UNKNOWN_SYSCALL (-1)
1597
1598 extern struct gdbarch_tdep *gdbarch_tdep (struct gdbarch *gdbarch);
1599
1600
1601 /* Mechanism for co-ordinating the selection of a specific
1602    architecture.
1603
1604    GDB targets (*-tdep.c) can register an interest in a specific
1605    architecture.  Other GDB components can register a need to maintain
1606    per-architecture data.
1607
1608    The mechanisms below ensures that there is only a loose connection
1609    between the set-architecture command and the various GDB
1610    components.  Each component can independently register their need
1611    to maintain architecture specific data with gdbarch.
1612
1613    Pragmatics:
1614
1615    Previously, a single TARGET_ARCHITECTURE_HOOK was provided.  It
1616    didn't scale.
1617
1618    The more traditional mega-struct containing architecture specific
1619    data for all the various GDB components was also considered.  Since
1620    GDB is built from a variable number of (fairly independent)
1621    components it was determined that the global aproach was not
1622    applicable.  */
1623
1624
1625 /* Register a new architectural family with GDB.
1626
1627    Register support for the specified ARCHITECTURE with GDB.  When
1628    gdbarch determines that the specified architecture has been
1629    selected, the corresponding INIT function is called.
1630
1631    --
1632
1633    The INIT function takes two parameters: INFO which contains the
1634    information available to gdbarch about the (possibly new)
1635    architecture; ARCHES which is a list of the previously created
1636    ``struct gdbarch'' for this architecture.
1637
1638    The INFO parameter is, as far as possible, be pre-initialized with
1639    information obtained from INFO.ABFD or the global defaults.
1640
1641    The ARCHES parameter is a linked list (sorted most recently used)
1642    of all the previously created architures for this architecture
1643    family.  The (possibly NULL) ARCHES->gdbarch can used to access
1644    values from the previously selected architecture for this
1645    architecture family.
1646
1647    The INIT function shall return any of: NULL - indicating that it
1648    doesn't recognize the selected architecture; an existing ``struct
1649    gdbarch'' from the ARCHES list - indicating that the new
1650    architecture is just a synonym for an earlier architecture (see
1651    gdbarch_list_lookup_by_info()); a newly created ``struct gdbarch''
1652    - that describes the selected architecture (see gdbarch_alloc()).
1653
1654    The DUMP_TDEP function shall print out all target specific values.
1655    Care should be taken to ensure that the function works in both the
1656    multi-arch and non- multi-arch cases.  */
1657
1658 struct gdbarch_list
1659 {
1660   struct gdbarch *gdbarch;
1661   struct gdbarch_list *next;
1662 };
1663
1664 struct gdbarch_info
1665 {
1666   /* Use default: NULL (ZERO).  */
1667   const struct bfd_arch_info *bfd_arch_info;
1668
1669   /* Use default: BFD_ENDIAN_UNKNOWN (NB: is not ZERO).  */
1670   enum bfd_endian byte_order;
1671
1672   enum bfd_endian byte_order_for_code;
1673
1674   /* Use default: NULL (ZERO).  */
1675   bfd *abfd;
1676
1677   /* Use default: NULL (ZERO).  */
1678   union
1679     {
1680       /* Architecture-specific information.  The generic form for targets
1681          that have extra requirements.  */
1682       struct gdbarch_tdep_info *tdep_info;
1683
1684       /* Architecture-specific target description data.  Numerous targets
1685          need only this, so give them an easy way to hold it.  */
1686       struct tdesc_arch_data *tdesc_data;
1687
1688       /* SPU file system ID.  This is a single integer, so using the
1689          generic form would only complicate code.  Other targets may
1690          reuse this member if suitable.  */
1691       int *id;
1692     };
1693
1694   /* Use default: GDB_OSABI_UNINITIALIZED (-1).  */
1695   enum gdb_osabi osabi;
1696
1697   /* Use default: NULL (ZERO).  */
1698   const struct target_desc *target_desc;
1699 };
1700
1701 typedef struct gdbarch *(gdbarch_init_ftype) (struct gdbarch_info info, struct gdbarch_list *arches);
1702 typedef void (gdbarch_dump_tdep_ftype) (struct gdbarch *gdbarch, struct ui_file *file);
1703
1704 /* DEPRECATED - use gdbarch_register() */
1705 extern void register_gdbarch_init (enum bfd_architecture architecture, gdbarch_init_ftype *);
1706
1707 extern void gdbarch_register (enum bfd_architecture architecture,
1708                               gdbarch_init_ftype *,
1709                               gdbarch_dump_tdep_ftype *);
1710
1711
1712 /* Return a freshly allocated, NULL terminated, array of the valid
1713    architecture names.  Since architectures are registered during the
1714    _initialize phase this function only returns useful information
1715    once initialization has been completed.  */
1716
1717 extern const char **gdbarch_printable_names (void);
1718
1719
1720 /* Helper function.  Search the list of ARCHES for a GDBARCH that
1721    matches the information provided by INFO.  */
1722
1723 extern struct gdbarch_list *gdbarch_list_lookup_by_info (struct gdbarch_list *arches, const struct gdbarch_info *info);
1724
1725
1726 /* Helper function.  Create a preliminary ``struct gdbarch''.  Perform
1727    basic initialization using values obtained from the INFO and TDEP
1728    parameters.  set_gdbarch_*() functions are called to complete the
1729    initialization of the object.  */
1730
1731 extern struct gdbarch *gdbarch_alloc (const struct gdbarch_info *info, struct gdbarch_tdep *tdep);
1732
1733
1734 /* Helper function.  Free a partially-constructed ``struct gdbarch''.
1735    It is assumed that the caller freeds the ``struct
1736    gdbarch_tdep''.  */
1737
1738 extern void gdbarch_free (struct gdbarch *);
1739
1740 /* Get the obstack owned by ARCH.  */
1741
1742 extern obstack *gdbarch_obstack (gdbarch *arch);
1743
1744 /* Helper function.  Allocate memory from the ``struct gdbarch''
1745    obstack.  The memory is freed when the corresponding architecture
1746    is also freed.  */
1747
1748 #define GDBARCH_OBSTACK_CALLOC(GDBARCH, NR, TYPE)   obstack_calloc<TYPE> (gdbarch_obstack ((GDBARCH)), (NR))
1749
1750 #define GDBARCH_OBSTACK_ZALLOC(GDBARCH, TYPE)   obstack_zalloc<TYPE> (gdbarch_obstack ((GDBARCH)))
1751
1752 /* Duplicate STRING, returning an equivalent string that's allocated on the
1753    obstack associated with GDBARCH.  The string is freed when the corresponding
1754    architecture is also freed.  */
1755
1756 extern char *gdbarch_obstack_strdup (struct gdbarch *arch, const char *string);
1757
1758 /* Helper function.  Force an update of the current architecture.
1759
1760    The actual architecture selected is determined by INFO, ``(gdb) set
1761    architecture'' et.al., the existing architecture and BFD's default
1762    architecture.  INFO should be initialized to zero and then selected
1763    fields should be updated.
1764
1765    Returns non-zero if the update succeeds.  */
1766
1767 extern int gdbarch_update_p (struct gdbarch_info info);
1768
1769
1770 /* Helper function.  Find an architecture matching info.
1771
1772    INFO should be initialized using gdbarch_info_init, relevant fields
1773    set, and then finished using gdbarch_info_fill.
1774
1775    Returns the corresponding architecture, or NULL if no matching
1776    architecture was found.  */
1777
1778 extern struct gdbarch *gdbarch_find_by_info (struct gdbarch_info info);
1779
1780
1781 /* Helper function.  Set the target gdbarch to "gdbarch".  */
1782
1783 extern void set_target_gdbarch (struct gdbarch *gdbarch);
1784
1785
1786 /* Register per-architecture data-pointer.
1787
1788    Reserve space for a per-architecture data-pointer.  An identifier
1789    for the reserved data-pointer is returned.  That identifer should
1790    be saved in a local static variable.
1791
1792    Memory for the per-architecture data shall be allocated using
1793    gdbarch_obstack_zalloc.  That memory will be deleted when the
1794    corresponding architecture object is deleted.
1795
1796    When a previously created architecture is re-selected, the
1797    per-architecture data-pointer for that previous architecture is
1798    restored.  INIT() is not re-called.
1799
1800    Multiple registrarants for any architecture are allowed (and
1801    strongly encouraged).  */
1802
1803 struct gdbarch_data;
1804
1805 typedef void *(gdbarch_data_pre_init_ftype) (struct obstack *obstack);
1806 extern struct gdbarch_data *gdbarch_data_register_pre_init (gdbarch_data_pre_init_ftype *init);
1807 typedef void *(gdbarch_data_post_init_ftype) (struct gdbarch *gdbarch);
1808 extern struct gdbarch_data *gdbarch_data_register_post_init (gdbarch_data_post_init_ftype *init);
1809 extern void deprecated_set_gdbarch_data (struct gdbarch *gdbarch,
1810                                          struct gdbarch_data *data,
1811                                          void *pointer);
1812
1813 extern void *gdbarch_data (struct gdbarch *gdbarch, struct gdbarch_data *);
1814
1815
1816 /* Set the dynamic target-system-dependent parameters (architecture,
1817    byte-order, ...) using information found in the BFD.  */
1818
1819 extern void set_gdbarch_from_file (bfd *);
1820
1821
1822 /* Initialize the current architecture to the "first" one we find on
1823    our list.  */
1824
1825 extern void initialize_current_architecture (void);
1826
1827 /* gdbarch trace variable */
1828 extern unsigned int gdbarch_debug;
1829
1830 extern void gdbarch_dump (struct gdbarch *gdbarch, struct ui_file *file);
1831
1832 /* Return the number of cooked registers (raw + pseudo) for ARCH.  */
1833
1834 static inline int
1835 gdbarch_num_cooked_regs (gdbarch *arch)
1836 {
1837   return gdbarch_num_regs (arch) + gdbarch_num_pseudo_regs (arch);
1838 }
1839
1840 #endif