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