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