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