Automatic date update in version.in
[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-2019 Free Software Foundation, Inc.
7
8 This file is part of GDB.
9
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
14
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
19
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22
23 /* This file was created with the aid of ``gdbarch.sh''.
24
25 The Bourne shell script ``gdbarch.sh'' creates the files
26 ``new-gdbarch.c'' and ``new-gdbarch.h and then compares them
27 against the existing ``gdbarch.[hc]''. Any differences found
28 being reported.
29
30 If editing this file, please also run gdbarch.sh and merge any
31 changes into that script. Conversely, when making sweeping changes
32 to this file, modifying gdbarch.sh and using its output may prove
33 easier. */
34
35 #ifndef GDBARCH_H
36 #define GDBARCH_H
37
38 #include <vector>
39 #include "frame.h"
40 #include "dis-asm.h"
41 #include "gdb_obstack.h"
42
43 struct floatformat;
44 struct ui_file;
45 struct value;
46 struct objfile;
47 struct obj_section;
48 struct minimal_symbol;
49 struct regcache;
50 struct reggroup;
51 struct regset;
52 struct disassemble_info;
53 struct target_ops;
54 struct obstack;
55 struct bp_target_info;
56 struct target_desc;
57 struct symbol;
58 struct displaced_step_closure;
59 struct syscall;
60 struct agent_expr;
61 struct axs_value;
62 struct stap_parse_info;
63 struct expr_builder;
64 struct ravenscar_arch_ops;
65 struct mem_range;
66 struct syscalls_info;
67 struct thread_info;
68 struct ui_out;
69
70 #include "regcache.h"
71
72 /* The architecture associated with the inferior through the
73 connection to the target.
74
75 The architecture vector provides some information that is really a
76 property of the inferior, accessed through a particular target:
77 ptrace operations; the layout of certain RSP packets; the solib_ops
78 vector; etc. To differentiate architecture accesses to
79 per-inferior/target properties from
80 per-thread/per-frame/per-objfile properties, accesses to
81 per-inferior/target properties should be made through this
82 gdbarch. */
83
84 /* This is a convenience wrapper for 'current_inferior ()->gdbarch'. */
85 extern struct gdbarch *target_gdbarch (void);
86
87 /* Callback type for the 'iterate_over_objfiles_in_search_order'
88 gdbarch method. */
89
90 typedef int (iterate_over_objfiles_in_search_order_cb_ftype)
91 (struct objfile *objfile, void *cb_data);
92
93 /* Callback type for regset section iterators. The callback usually
94 invokes the REGSET's supply or collect method, to which it must
95 pass a buffer - for collects this buffer will need to be created using
96 COLLECT_SIZE, for supply the existing buffer being read from should
97 be at least SUPPLY_SIZE. SECT_NAME is a BFD section name, and HUMAN_NAME
98 is used for diagnostic messages. CB_DATA should have been passed
99 unchanged through the iterator. */
100
101 typedef void (iterate_over_regset_sections_cb)
102 (const char *sect_name, int supply_size, int collect_size,
103 const struct regset *regset, const char *human_name, void *cb_data);
104
105 /* For a function call, does the function return a value using a
106 normal value return or a structure return - passing a hidden
107 argument pointing to storage. For the latter, there are two
108 cases: language-mandated structure return and target ABI
109 structure return. */
110
111 enum function_call_return_method
112 {
113 /* Standard value return. */
114 return_method_normal = 0,
115
116 /* Language ABI structure return. This is handled
117 by passing the return location as the first parameter to
118 the function, even preceding "this". */
119 return_method_hidden_param,
120
121 /* Target ABI struct return. This is target-specific; for instance,
122 on ia64 the first argument is passed in out0 but the hidden
123 structure return pointer would normally be passed in r8. */
124 return_method_struct,
125 };
126
127
128
129 /* The following are pre-initialized by GDBARCH. */
130
131 extern const struct bfd_arch_info * gdbarch_bfd_arch_info (struct gdbarch *gdbarch);
132 /* set_gdbarch_bfd_arch_info() - not applicable - pre-initialized. */
133
134 extern enum bfd_endian gdbarch_byte_order (struct gdbarch *gdbarch);
135 /* set_gdbarch_byte_order() - not applicable - pre-initialized. */
136
137 extern enum bfd_endian gdbarch_byte_order_for_code (struct gdbarch *gdbarch);
138 /* set_gdbarch_byte_order_for_code() - not applicable - pre-initialized. */
139
140 extern enum gdb_osabi gdbarch_osabi (struct gdbarch *gdbarch);
141 /* set_gdbarch_osabi() - not applicable - pre-initialized. */
142
143 extern const struct target_desc * gdbarch_target_desc (struct gdbarch *gdbarch);
144 /* set_gdbarch_target_desc() - not applicable - pre-initialized. */
145
146
147 /* The following are initialized by the target dependent code. */
148
149 /* Number of bits in a short or unsigned short for the target machine. */
150
151 extern int gdbarch_short_bit (struct gdbarch *gdbarch);
152 extern void set_gdbarch_short_bit (struct gdbarch *gdbarch, int short_bit);
153
154 /* Number of bits in an int or unsigned int for the target machine. */
155
156 extern int gdbarch_int_bit (struct gdbarch *gdbarch);
157 extern void set_gdbarch_int_bit (struct gdbarch *gdbarch, int int_bit);
158
159 /* Number of bits in a long or unsigned long for the target machine. */
160
161 extern int gdbarch_long_bit (struct gdbarch *gdbarch);
162 extern void set_gdbarch_long_bit (struct gdbarch *gdbarch, int long_bit);
163
164 /* Number of bits in a long long or unsigned long long for the target
165 machine. */
166
167 extern int gdbarch_long_long_bit (struct gdbarch *gdbarch);
168 extern void set_gdbarch_long_long_bit (struct gdbarch *gdbarch, int long_long_bit);
169
170 /* The ABI default bit-size and format for "half", "float", "double", and
171 "long double". These bit/format pairs should eventually be combined
172 into a single object. For the moment, just initialize them as a pair.
173 Each format describes both the big and little endian layouts (if
174 useful). */
175
176 extern int gdbarch_half_bit (struct gdbarch *gdbarch);
177 extern void set_gdbarch_half_bit (struct gdbarch *gdbarch, int half_bit);
178
179 extern const struct floatformat ** gdbarch_half_format (struct gdbarch *gdbarch);
180 extern void set_gdbarch_half_format (struct gdbarch *gdbarch, const struct floatformat ** half_format);
181
182 extern int gdbarch_float_bit (struct gdbarch *gdbarch);
183 extern void set_gdbarch_float_bit (struct gdbarch *gdbarch, int float_bit);
184
185 extern const struct floatformat ** gdbarch_float_format (struct gdbarch *gdbarch);
186 extern void set_gdbarch_float_format (struct gdbarch *gdbarch, const struct floatformat ** float_format);
187
188 extern int gdbarch_double_bit (struct gdbarch *gdbarch);
189 extern void set_gdbarch_double_bit (struct gdbarch *gdbarch, int double_bit);
190
191 extern const struct floatformat ** gdbarch_double_format (struct gdbarch *gdbarch);
192 extern void set_gdbarch_double_format (struct gdbarch *gdbarch, const struct floatformat ** double_format);
193
194 extern int gdbarch_long_double_bit (struct gdbarch *gdbarch);
195 extern void set_gdbarch_long_double_bit (struct gdbarch *gdbarch, int long_double_bit);
196
197 extern const struct floatformat ** gdbarch_long_double_format (struct gdbarch *gdbarch);
198 extern void set_gdbarch_long_double_format (struct gdbarch *gdbarch, const struct floatformat ** long_double_format);
199
200 /* The ABI default bit-size for "wchar_t". wchar_t is a built-in type
201 starting with C++11. */
202
203 extern int gdbarch_wchar_bit (struct gdbarch *gdbarch);
204 extern void set_gdbarch_wchar_bit (struct gdbarch *gdbarch, int wchar_bit);
205
206 /* One if `wchar_t' is signed, zero if unsigned. */
207
208 extern int gdbarch_wchar_signed (struct gdbarch *gdbarch);
209 extern void set_gdbarch_wchar_signed (struct gdbarch *gdbarch, int wchar_signed);
210
211 /* Returns the floating-point format to be used for values of length LENGTH.
212 NAME, if non-NULL, is the type name, which may be used to distinguish
213 different target formats of the same length. */
214
215 typedef const struct floatformat ** (gdbarch_floatformat_for_type_ftype) (struct gdbarch *gdbarch, const char *name, int length);
216 extern const struct floatformat ** gdbarch_floatformat_for_type (struct gdbarch *gdbarch, const char *name, int length);
217 extern void set_gdbarch_floatformat_for_type (struct gdbarch *gdbarch, gdbarch_floatformat_for_type_ftype *floatformat_for_type);
218
219 /* For most targets, a pointer on the target and its representation as an
220 address in GDB have the same size and "look the same". For such a
221 target, you need only set gdbarch_ptr_bit and gdbarch_addr_bit
222 / addr_bit will be set from it.
223
224 If gdbarch_ptr_bit and gdbarch_addr_bit are different, you'll probably
225 also need to set gdbarch_dwarf2_addr_size, gdbarch_pointer_to_address and
226 gdbarch_address_to_pointer as well.
227
228 ptr_bit is the size of a pointer on the target */
229
230 extern int gdbarch_ptr_bit (struct gdbarch *gdbarch);
231 extern void set_gdbarch_ptr_bit (struct gdbarch *gdbarch, int ptr_bit);
232
233 /* addr_bit is the size of a target address as represented in gdb */
234
235 extern int gdbarch_addr_bit (struct gdbarch *gdbarch);
236 extern void set_gdbarch_addr_bit (struct gdbarch *gdbarch, int addr_bit);
237
238 /* dwarf2_addr_size is the target address size as used in the Dwarf debug
239 info. For .debug_frame FDEs, this is supposed to be the target address
240 size from the associated CU header, and which is equivalent to the
241 DWARF2_ADDR_SIZE as defined by the target specific GCC back-end.
242 Unfortunately there is no good way to determine this value. Therefore
243 dwarf2_addr_size simply defaults to the target pointer size.
244
245 dwarf2_addr_size is not used for .eh_frame FDEs, which are generally
246 defined using the target's pointer size so far.
247
248 Note that dwarf2_addr_size only needs to be redefined by a target if the
249 GCC back-end defines a DWARF2_ADDR_SIZE other than the target pointer size,
250 and if Dwarf versions < 4 need to be supported. */
251
252 extern int gdbarch_dwarf2_addr_size (struct gdbarch *gdbarch);
253 extern void set_gdbarch_dwarf2_addr_size (struct gdbarch *gdbarch, int dwarf2_addr_size);
254
255 /* One if `char' acts like `signed char', zero if `unsigned char'. */
256
257 extern int gdbarch_char_signed (struct gdbarch *gdbarch);
258 extern void set_gdbarch_char_signed (struct gdbarch *gdbarch, int char_signed);
259
260 extern int gdbarch_read_pc_p (struct gdbarch *gdbarch);
261
262 typedef CORE_ADDR (gdbarch_read_pc_ftype) (readable_regcache *regcache);
263 extern CORE_ADDR gdbarch_read_pc (struct gdbarch *gdbarch, readable_regcache *regcache);
264 extern void set_gdbarch_read_pc (struct gdbarch *gdbarch, gdbarch_read_pc_ftype *read_pc);
265
266 extern int gdbarch_write_pc_p (struct gdbarch *gdbarch);
267
268 typedef void (gdbarch_write_pc_ftype) (struct regcache *regcache, CORE_ADDR val);
269 extern void gdbarch_write_pc (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR val);
270 extern void set_gdbarch_write_pc (struct gdbarch *gdbarch, gdbarch_write_pc_ftype *write_pc);
271
272 /* Function for getting target's idea of a frame pointer. FIXME: GDB's
273 whole scheme for dealing with "frames" and "frame pointers" needs a
274 serious shakedown. */
275
276 typedef void (gdbarch_virtual_frame_pointer_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc, int *frame_regnum, LONGEST *frame_offset);
277 extern void gdbarch_virtual_frame_pointer (struct gdbarch *gdbarch, CORE_ADDR pc, int *frame_regnum, LONGEST *frame_offset);
278 extern void set_gdbarch_virtual_frame_pointer (struct gdbarch *gdbarch, gdbarch_virtual_frame_pointer_ftype *virtual_frame_pointer);
279
280 extern int gdbarch_pseudo_register_read_p (struct gdbarch *gdbarch);
281
282 typedef enum register_status (gdbarch_pseudo_register_read_ftype) (struct gdbarch *gdbarch, readable_regcache *regcache, int cookednum, gdb_byte *buf);
283 extern enum register_status gdbarch_pseudo_register_read (struct gdbarch *gdbarch, readable_regcache *regcache, int cookednum, gdb_byte *buf);
284 extern void set_gdbarch_pseudo_register_read (struct gdbarch *gdbarch, gdbarch_pseudo_register_read_ftype *pseudo_register_read);
285
286 /* Read a register into a new struct value. If the register is wholly
287 or partly unavailable, this should call mark_value_bytes_unavailable
288 as appropriate. If this is defined, then pseudo_register_read will
289 never be called. */
290
291 extern int gdbarch_pseudo_register_read_value_p (struct gdbarch *gdbarch);
292
293 typedef struct value * (gdbarch_pseudo_register_read_value_ftype) (struct gdbarch *gdbarch, readable_regcache *regcache, int cookednum);
294 extern struct value * gdbarch_pseudo_register_read_value (struct gdbarch *gdbarch, readable_regcache *regcache, int cookednum);
295 extern void set_gdbarch_pseudo_register_read_value (struct gdbarch *gdbarch, gdbarch_pseudo_register_read_value_ftype *pseudo_register_read_value);
296
297 extern int gdbarch_pseudo_register_write_p (struct gdbarch *gdbarch);
298
299 typedef void (gdbarch_pseudo_register_write_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, const gdb_byte *buf);
300 extern void gdbarch_pseudo_register_write (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, const gdb_byte *buf);
301 extern void set_gdbarch_pseudo_register_write (struct gdbarch *gdbarch, gdbarch_pseudo_register_write_ftype *pseudo_register_write);
302
303 extern int gdbarch_num_regs (struct gdbarch *gdbarch);
304 extern void set_gdbarch_num_regs (struct gdbarch *gdbarch, int num_regs);
305
306 /* This macro gives the number of pseudo-registers that live in the
307 register namespace but do not get fetched or stored on the target.
308 These pseudo-registers may be aliases for other registers,
309 combinations of other registers, or they may be computed by GDB. */
310
311 extern int gdbarch_num_pseudo_regs (struct gdbarch *gdbarch);
312 extern void set_gdbarch_num_pseudo_regs (struct gdbarch *gdbarch, int num_pseudo_regs);
313
314 /* Assemble agent expression bytecode to collect pseudo-register REG.
315 Return -1 if something goes wrong, 0 otherwise. */
316
317 extern int gdbarch_ax_pseudo_register_collect_p (struct gdbarch *gdbarch);
318
319 typedef int (gdbarch_ax_pseudo_register_collect_ftype) (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
320 extern int gdbarch_ax_pseudo_register_collect (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
321 extern void set_gdbarch_ax_pseudo_register_collect (struct gdbarch *gdbarch, gdbarch_ax_pseudo_register_collect_ftype *ax_pseudo_register_collect);
322
323 /* Assemble agent expression bytecode to push the value of pseudo-register
324 REG on the interpreter stack.
325 Return -1 if something goes wrong, 0 otherwise. */
326
327 extern int gdbarch_ax_pseudo_register_push_stack_p (struct gdbarch *gdbarch);
328
329 typedef int (gdbarch_ax_pseudo_register_push_stack_ftype) (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
330 extern int gdbarch_ax_pseudo_register_push_stack (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
331 extern void set_gdbarch_ax_pseudo_register_push_stack (struct gdbarch *gdbarch, gdbarch_ax_pseudo_register_push_stack_ftype *ax_pseudo_register_push_stack);
332
333 /* Some targets/architectures can do extra processing/display of
334 segmentation faults. E.g., Intel MPX boundary faults.
335 Call the architecture dependent function to handle the fault.
336 UIOUT is the output stream where the handler will place information. */
337
338 extern int gdbarch_handle_segmentation_fault_p (struct gdbarch *gdbarch);
339
340 typedef void (gdbarch_handle_segmentation_fault_ftype) (struct gdbarch *gdbarch, struct ui_out *uiout);
341 extern void gdbarch_handle_segmentation_fault (struct gdbarch *gdbarch, struct ui_out *uiout);
342 extern void set_gdbarch_handle_segmentation_fault (struct gdbarch *gdbarch, gdbarch_handle_segmentation_fault_ftype *handle_segmentation_fault);
343
344 /* GDB's standard (or well known) register numbers. These can map onto
345 a real register or a pseudo (computed) register or not be defined at
346 all (-1).
347 gdbarch_sp_regnum will hopefully be replaced by UNWIND_SP. */
348
349 extern int gdbarch_sp_regnum (struct gdbarch *gdbarch);
350 extern void set_gdbarch_sp_regnum (struct gdbarch *gdbarch, int sp_regnum);
351
352 extern int gdbarch_pc_regnum (struct gdbarch *gdbarch);
353 extern void set_gdbarch_pc_regnum (struct gdbarch *gdbarch, int pc_regnum);
354
355 extern int gdbarch_ps_regnum (struct gdbarch *gdbarch);
356 extern void set_gdbarch_ps_regnum (struct gdbarch *gdbarch, int ps_regnum);
357
358 extern int gdbarch_fp0_regnum (struct gdbarch *gdbarch);
359 extern void set_gdbarch_fp0_regnum (struct gdbarch *gdbarch, int fp0_regnum);
360
361 /* Convert stab register number (from `r' declaration) to a gdb REGNUM. */
362
363 typedef int (gdbarch_stab_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int stab_regnr);
364 extern int gdbarch_stab_reg_to_regnum (struct gdbarch *gdbarch, int stab_regnr);
365 extern void set_gdbarch_stab_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_stab_reg_to_regnum_ftype *stab_reg_to_regnum);
366
367 /* Provide a default mapping from a ecoff register number to a gdb REGNUM. */
368
369 typedef int (gdbarch_ecoff_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int ecoff_regnr);
370 extern int gdbarch_ecoff_reg_to_regnum (struct gdbarch *gdbarch, int ecoff_regnr);
371 extern void set_gdbarch_ecoff_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_ecoff_reg_to_regnum_ftype *ecoff_reg_to_regnum);
372
373 /* Convert from an sdb register number to an internal gdb register number. */
374
375 typedef int (gdbarch_sdb_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int sdb_regnr);
376 extern int gdbarch_sdb_reg_to_regnum (struct gdbarch *gdbarch, int sdb_regnr);
377 extern void set_gdbarch_sdb_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_sdb_reg_to_regnum_ftype *sdb_reg_to_regnum);
378
379 /* Provide a default mapping from a DWARF2 register number to a gdb REGNUM.
380 Return -1 for bad REGNUM. Note: Several targets get this wrong. */
381
382 typedef int (gdbarch_dwarf2_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int dwarf2_regnr);
383 extern int gdbarch_dwarf2_reg_to_regnum (struct gdbarch *gdbarch, int dwarf2_regnr);
384 extern void set_gdbarch_dwarf2_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_dwarf2_reg_to_regnum_ftype *dwarf2_reg_to_regnum);
385
386 typedef const char * (gdbarch_register_name_ftype) (struct gdbarch *gdbarch, int regnr);
387 extern const char * gdbarch_register_name (struct gdbarch *gdbarch, int regnr);
388 extern void set_gdbarch_register_name (struct gdbarch *gdbarch, gdbarch_register_name_ftype *register_name);
389
390 /* Return the type of a register specified by the architecture. Only
391 the register cache should call this function directly; others should
392 use "register_type". */
393
394 extern int gdbarch_register_type_p (struct gdbarch *gdbarch);
395
396 typedef struct type * (gdbarch_register_type_ftype) (struct gdbarch *gdbarch, int reg_nr);
397 extern struct type * gdbarch_register_type (struct gdbarch *gdbarch, int reg_nr);
398 extern void set_gdbarch_register_type (struct gdbarch *gdbarch, gdbarch_register_type_ftype *register_type);
399
400 /* Generate a dummy frame_id for THIS_FRAME assuming that the frame is
401 a dummy frame. A dummy frame is created before an inferior call,
402 the frame_id returned here must match the frame_id that was built
403 for the inferior call. Usually this means the returned frame_id's
404 stack address should match the address returned by
405 gdbarch_push_dummy_call, and the returned frame_id's code address
406 should match the address at which the breakpoint was set in the dummy
407 frame. */
408
409 typedef struct frame_id (gdbarch_dummy_id_ftype) (struct gdbarch *gdbarch, struct frame_info *this_frame);
410 extern struct frame_id gdbarch_dummy_id (struct gdbarch *gdbarch, struct frame_info *this_frame);
411 extern void set_gdbarch_dummy_id (struct gdbarch *gdbarch, gdbarch_dummy_id_ftype *dummy_id);
412
413 /* Implement DUMMY_ID and PUSH_DUMMY_CALL, then delete
414 deprecated_fp_regnum. */
415
416 extern int gdbarch_deprecated_fp_regnum (struct gdbarch *gdbarch);
417 extern void set_gdbarch_deprecated_fp_regnum (struct gdbarch *gdbarch, int deprecated_fp_regnum);
418
419 extern int gdbarch_push_dummy_call_p (struct gdbarch *gdbarch);
420
421 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);
422 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);
423 extern void set_gdbarch_push_dummy_call (struct gdbarch *gdbarch, gdbarch_push_dummy_call_ftype *push_dummy_call);
424
425 extern int gdbarch_call_dummy_location (struct gdbarch *gdbarch);
426 extern void set_gdbarch_call_dummy_location (struct gdbarch *gdbarch, int call_dummy_location);
427
428 extern int gdbarch_push_dummy_code_p (struct gdbarch *gdbarch);
429
430 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);
431 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);
432 extern void set_gdbarch_push_dummy_code (struct gdbarch *gdbarch, gdbarch_push_dummy_code_ftype *push_dummy_code);
433
434 /* Return true if the code of FRAME is writable. */
435
436 typedef int (gdbarch_code_of_frame_writable_ftype) (struct gdbarch *gdbarch, struct frame_info *frame);
437 extern int gdbarch_code_of_frame_writable (struct gdbarch *gdbarch, struct frame_info *frame);
438 extern void set_gdbarch_code_of_frame_writable (struct gdbarch *gdbarch, gdbarch_code_of_frame_writable_ftype *code_of_frame_writable);
439
440 typedef void (gdbarch_print_registers_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, int regnum, int all);
441 extern void gdbarch_print_registers_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, int regnum, int all);
442 extern void set_gdbarch_print_registers_info (struct gdbarch *gdbarch, gdbarch_print_registers_info_ftype *print_registers_info);
443
444 typedef void (gdbarch_print_float_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
445 extern void gdbarch_print_float_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
446 extern void set_gdbarch_print_float_info (struct gdbarch *gdbarch, gdbarch_print_float_info_ftype *print_float_info);
447
448 extern int gdbarch_print_vector_info_p (struct gdbarch *gdbarch);
449
450 typedef void (gdbarch_print_vector_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
451 extern void gdbarch_print_vector_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
452 extern void set_gdbarch_print_vector_info (struct gdbarch *gdbarch, gdbarch_print_vector_info_ftype *print_vector_info);
453
454 /* MAP a GDB RAW register number onto a simulator register number. See
455 also include/...-sim.h. */
456
457 typedef int (gdbarch_register_sim_regno_ftype) (struct gdbarch *gdbarch, int reg_nr);
458 extern int gdbarch_register_sim_regno (struct gdbarch *gdbarch, int reg_nr);
459 extern void set_gdbarch_register_sim_regno (struct gdbarch *gdbarch, gdbarch_register_sim_regno_ftype *register_sim_regno);
460
461 typedef int (gdbarch_cannot_fetch_register_ftype) (struct gdbarch *gdbarch, int regnum);
462 extern int gdbarch_cannot_fetch_register (struct gdbarch *gdbarch, int regnum);
463 extern void set_gdbarch_cannot_fetch_register (struct gdbarch *gdbarch, gdbarch_cannot_fetch_register_ftype *cannot_fetch_register);
464
465 typedef int (gdbarch_cannot_store_register_ftype) (struct gdbarch *gdbarch, int regnum);
466 extern int gdbarch_cannot_store_register (struct gdbarch *gdbarch, int regnum);
467 extern void set_gdbarch_cannot_store_register (struct gdbarch *gdbarch, gdbarch_cannot_store_register_ftype *cannot_store_register);
468
469 /* Determine the address where a longjmp will land and save this address
470 in PC. Return nonzero on success.
471
472 FRAME corresponds to the longjmp frame. */
473
474 extern int gdbarch_get_longjmp_target_p (struct gdbarch *gdbarch);
475
476 typedef int (gdbarch_get_longjmp_target_ftype) (struct frame_info *frame, CORE_ADDR *pc);
477 extern int gdbarch_get_longjmp_target (struct gdbarch *gdbarch, struct frame_info *frame, CORE_ADDR *pc);
478 extern void set_gdbarch_get_longjmp_target (struct gdbarch *gdbarch, gdbarch_get_longjmp_target_ftype *get_longjmp_target);
479
480 extern int gdbarch_believe_pcc_promotion (struct gdbarch *gdbarch);
481 extern void set_gdbarch_believe_pcc_promotion (struct gdbarch *gdbarch, int believe_pcc_promotion);
482
483 typedef int (gdbarch_convert_register_p_ftype) (struct gdbarch *gdbarch, int regnum, struct type *type);
484 extern int gdbarch_convert_register_p (struct gdbarch *gdbarch, int regnum, struct type *type);
485 extern void set_gdbarch_convert_register_p (struct gdbarch *gdbarch, gdbarch_convert_register_p_ftype *convert_register_p);
486
487 typedef int (gdbarch_register_to_value_ftype) (struct frame_info *frame, int regnum, struct type *type, gdb_byte *buf, int *optimizedp, int *unavailablep);
488 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);
489 extern void set_gdbarch_register_to_value (struct gdbarch *gdbarch, gdbarch_register_to_value_ftype *register_to_value);
490
491 typedef void (gdbarch_value_to_register_ftype) (struct frame_info *frame, int regnum, struct type *type, const gdb_byte *buf);
492 extern void gdbarch_value_to_register (struct gdbarch *gdbarch, struct frame_info *frame, int regnum, struct type *type, const gdb_byte *buf);
493 extern void set_gdbarch_value_to_register (struct gdbarch *gdbarch, gdbarch_value_to_register_ftype *value_to_register);
494
495 /* Construct a value representing the contents of register REGNUM in
496 frame FRAME_ID, interpreted as type TYPE. The routine needs to
497 allocate and return a struct value with all value attributes
498 (but not the value contents) filled in. */
499
500 typedef struct value * (gdbarch_value_from_register_ftype) (struct gdbarch *gdbarch, struct type *type, int regnum, struct frame_id frame_id);
501 extern struct value * gdbarch_value_from_register (struct gdbarch *gdbarch, struct type *type, int regnum, struct frame_id frame_id);
502 extern void set_gdbarch_value_from_register (struct gdbarch *gdbarch, gdbarch_value_from_register_ftype *value_from_register);
503
504 typedef CORE_ADDR (gdbarch_pointer_to_address_ftype) (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
505 extern CORE_ADDR gdbarch_pointer_to_address (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
506 extern void set_gdbarch_pointer_to_address (struct gdbarch *gdbarch, gdbarch_pointer_to_address_ftype *pointer_to_address);
507
508 typedef void (gdbarch_address_to_pointer_ftype) (struct gdbarch *gdbarch, struct type *type, gdb_byte *buf, CORE_ADDR addr);
509 extern void gdbarch_address_to_pointer (struct gdbarch *gdbarch, struct type *type, gdb_byte *buf, CORE_ADDR addr);
510 extern void set_gdbarch_address_to_pointer (struct gdbarch *gdbarch, gdbarch_address_to_pointer_ftype *address_to_pointer);
511
512 extern int gdbarch_integer_to_address_p (struct gdbarch *gdbarch);
513
514 typedef CORE_ADDR (gdbarch_integer_to_address_ftype) (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
515 extern CORE_ADDR gdbarch_integer_to_address (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
516 extern void set_gdbarch_integer_to_address (struct gdbarch *gdbarch, gdbarch_integer_to_address_ftype *integer_to_address);
517
518 /* Return the return-value convention that will be used by FUNCTION
519 to return a value of type VALTYPE. FUNCTION may be NULL in which
520 case the return convention is computed based only on VALTYPE.
521
522 If READBUF is not NULL, extract the return value and save it in this buffer.
523
524 If WRITEBUF is not NULL, it contains a return value which will be
525 stored into the appropriate register. This can be used when we want
526 to force the value returned by a function (see the "return" command
527 for instance). */
528
529 extern int gdbarch_return_value_p (struct gdbarch *gdbarch);
530
531 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);
532 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);
533 extern void set_gdbarch_return_value (struct gdbarch *gdbarch, gdbarch_return_value_ftype *return_value);
534
535 /* Return true if the return value of function is stored in the first hidden
536 parameter. In theory, this feature should be language-dependent, specified
537 by language and its ABI, such as C++. Unfortunately, compiler may
538 implement it to a target-dependent feature. So that we need such hook here
539 to be aware of this in GDB. */
540
541 typedef int (gdbarch_return_in_first_hidden_param_p_ftype) (struct gdbarch *gdbarch, struct type *type);
542 extern int gdbarch_return_in_first_hidden_param_p (struct gdbarch *gdbarch, struct type *type);
543 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);
544
545 typedef CORE_ADDR (gdbarch_skip_prologue_ftype) (struct gdbarch *gdbarch, CORE_ADDR ip);
546 extern CORE_ADDR gdbarch_skip_prologue (struct gdbarch *gdbarch, CORE_ADDR ip);
547 extern void set_gdbarch_skip_prologue (struct gdbarch *gdbarch, gdbarch_skip_prologue_ftype *skip_prologue);
548
549 extern int gdbarch_skip_main_prologue_p (struct gdbarch *gdbarch);
550
551 typedef CORE_ADDR (gdbarch_skip_main_prologue_ftype) (struct gdbarch *gdbarch, CORE_ADDR ip);
552 extern CORE_ADDR gdbarch_skip_main_prologue (struct gdbarch *gdbarch, CORE_ADDR ip);
553 extern void set_gdbarch_skip_main_prologue (struct gdbarch *gdbarch, gdbarch_skip_main_prologue_ftype *skip_main_prologue);
554
555 /* On some platforms, a single function may provide multiple entry points,
556 e.g. one that is used for function-pointer calls and a different one
557 that is used for direct function calls.
558 In order to ensure that breakpoints set on the function will trigger
559 no matter via which entry point the function is entered, a platform
560 may provide the skip_entrypoint callback. It is called with IP set
561 to the main entry point of a function (as determined by the symbol table),
562 and should return the address of the innermost entry point, where the
563 actual breakpoint needs to be set. Note that skip_entrypoint is used
564 by GDB common code even when debugging optimized code, where skip_prologue
565 is not used. */
566
567 extern int gdbarch_skip_entrypoint_p (struct gdbarch *gdbarch);
568
569 typedef CORE_ADDR (gdbarch_skip_entrypoint_ftype) (struct gdbarch *gdbarch, CORE_ADDR ip);
570 extern CORE_ADDR gdbarch_skip_entrypoint (struct gdbarch *gdbarch, CORE_ADDR ip);
571 extern void set_gdbarch_skip_entrypoint (struct gdbarch *gdbarch, gdbarch_skip_entrypoint_ftype *skip_entrypoint);
572
573 typedef int (gdbarch_inner_than_ftype) (CORE_ADDR lhs, CORE_ADDR rhs);
574 extern int gdbarch_inner_than (struct gdbarch *gdbarch, CORE_ADDR lhs, CORE_ADDR rhs);
575 extern void set_gdbarch_inner_than (struct gdbarch *gdbarch, gdbarch_inner_than_ftype *inner_than);
576
577 typedef const gdb_byte * (gdbarch_breakpoint_from_pc_ftype) (struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *lenptr);
578 extern const gdb_byte * gdbarch_breakpoint_from_pc (struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *lenptr);
579 extern void set_gdbarch_breakpoint_from_pc (struct gdbarch *gdbarch, gdbarch_breakpoint_from_pc_ftype *breakpoint_from_pc);
580
581 /* Return the breakpoint kind for this target based on *PCPTR. */
582
583 typedef int (gdbarch_breakpoint_kind_from_pc_ftype) (struct gdbarch *gdbarch, CORE_ADDR *pcptr);
584 extern int gdbarch_breakpoint_kind_from_pc (struct gdbarch *gdbarch, CORE_ADDR *pcptr);
585 extern void set_gdbarch_breakpoint_kind_from_pc (struct gdbarch *gdbarch, gdbarch_breakpoint_kind_from_pc_ftype *breakpoint_kind_from_pc);
586
587 /* Return the software breakpoint from KIND. KIND can have target
588 specific meaning like the Z0 kind parameter.
589 SIZE is set to the software breakpoint's length in memory. */
590
591 typedef const gdb_byte * (gdbarch_sw_breakpoint_from_kind_ftype) (struct gdbarch *gdbarch, int kind, int *size);
592 extern const gdb_byte * gdbarch_sw_breakpoint_from_kind (struct gdbarch *gdbarch, int kind, int *size);
593 extern void set_gdbarch_sw_breakpoint_from_kind (struct gdbarch *gdbarch, gdbarch_sw_breakpoint_from_kind_ftype *sw_breakpoint_from_kind);
594
595 /* Return the breakpoint kind for this target based on the current
596 processor state (e.g. the current instruction mode on ARM) and the
597 *PCPTR. In default, it is gdbarch->breakpoint_kind_from_pc. */
598
599 typedef int (gdbarch_breakpoint_kind_from_current_state_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR *pcptr);
600 extern int gdbarch_breakpoint_kind_from_current_state (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR *pcptr);
601 extern void set_gdbarch_breakpoint_kind_from_current_state (struct gdbarch *gdbarch, gdbarch_breakpoint_kind_from_current_state_ftype *breakpoint_kind_from_current_state);
602
603 extern int gdbarch_adjust_breakpoint_address_p (struct gdbarch *gdbarch);
604
605 typedef CORE_ADDR (gdbarch_adjust_breakpoint_address_ftype) (struct gdbarch *gdbarch, CORE_ADDR bpaddr);
606 extern CORE_ADDR gdbarch_adjust_breakpoint_address (struct gdbarch *gdbarch, CORE_ADDR bpaddr);
607 extern void set_gdbarch_adjust_breakpoint_address (struct gdbarch *gdbarch, gdbarch_adjust_breakpoint_address_ftype *adjust_breakpoint_address);
608
609 typedef int (gdbarch_memory_insert_breakpoint_ftype) (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
610 extern int gdbarch_memory_insert_breakpoint (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
611 extern void set_gdbarch_memory_insert_breakpoint (struct gdbarch *gdbarch, gdbarch_memory_insert_breakpoint_ftype *memory_insert_breakpoint);
612
613 typedef int (gdbarch_memory_remove_breakpoint_ftype) (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
614 extern int gdbarch_memory_remove_breakpoint (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
615 extern void set_gdbarch_memory_remove_breakpoint (struct gdbarch *gdbarch, gdbarch_memory_remove_breakpoint_ftype *memory_remove_breakpoint);
616
617 extern CORE_ADDR gdbarch_decr_pc_after_break (struct gdbarch *gdbarch);
618 extern void set_gdbarch_decr_pc_after_break (struct gdbarch *gdbarch, CORE_ADDR decr_pc_after_break);
619
620 /* A function can be addressed by either it's "pointer" (possibly a
621 descriptor address) or "entry point" (first executable instruction).
622 The method "convert_from_func_ptr_addr" converting the former to the
623 latter. gdbarch_deprecated_function_start_offset is being used to implement
624 a simplified subset of that functionality - the function's address
625 corresponds to the "function pointer" and the function's start
626 corresponds to the "function entry point" - and hence is redundant. */
627
628 extern CORE_ADDR gdbarch_deprecated_function_start_offset (struct gdbarch *gdbarch);
629 extern void set_gdbarch_deprecated_function_start_offset (struct gdbarch *gdbarch, CORE_ADDR deprecated_function_start_offset);
630
631 /* Return the remote protocol register number associated with this
632 register. Normally the identity mapping. */
633
634 typedef int (gdbarch_remote_register_number_ftype) (struct gdbarch *gdbarch, int regno);
635 extern int gdbarch_remote_register_number (struct gdbarch *gdbarch, int regno);
636 extern void set_gdbarch_remote_register_number (struct gdbarch *gdbarch, gdbarch_remote_register_number_ftype *remote_register_number);
637
638 /* Fetch the target specific address used to represent a load module. */
639
640 extern int gdbarch_fetch_tls_load_module_address_p (struct gdbarch *gdbarch);
641
642 typedef CORE_ADDR (gdbarch_fetch_tls_load_module_address_ftype) (struct objfile *objfile);
643 extern CORE_ADDR gdbarch_fetch_tls_load_module_address (struct gdbarch *gdbarch, struct objfile *objfile);
644 extern void set_gdbarch_fetch_tls_load_module_address (struct gdbarch *gdbarch, gdbarch_fetch_tls_load_module_address_ftype *fetch_tls_load_module_address);
645
646 /* Return the thread-local address at OFFSET in the thread-local
647 storage for the thread PTID and the shared library or executable
648 file given by LM_ADDR. If that block of thread-local storage hasn't
649 been allocated yet, this function may throw an error. LM_ADDR may
650 be zero for statically linked multithreaded inferiors. */
651
652 extern int gdbarch_get_thread_local_address_p (struct gdbarch *gdbarch);
653
654 typedef CORE_ADDR (gdbarch_get_thread_local_address_ftype) (struct gdbarch *gdbarch, ptid_t ptid, CORE_ADDR lm_addr, CORE_ADDR offset);
655 extern CORE_ADDR gdbarch_get_thread_local_address (struct gdbarch *gdbarch, ptid_t ptid, CORE_ADDR lm_addr, CORE_ADDR offset);
656 extern void set_gdbarch_get_thread_local_address (struct gdbarch *gdbarch, gdbarch_get_thread_local_address_ftype *get_thread_local_address);
657
658 extern CORE_ADDR gdbarch_frame_args_skip (struct gdbarch *gdbarch);
659 extern void set_gdbarch_frame_args_skip (struct gdbarch *gdbarch, CORE_ADDR frame_args_skip);
660
661 typedef CORE_ADDR (gdbarch_unwind_pc_ftype) (struct gdbarch *gdbarch, struct frame_info *next_frame);
662 extern CORE_ADDR gdbarch_unwind_pc (struct gdbarch *gdbarch, struct frame_info *next_frame);
663 extern void set_gdbarch_unwind_pc (struct gdbarch *gdbarch, gdbarch_unwind_pc_ftype *unwind_pc);
664
665 typedef CORE_ADDR (gdbarch_unwind_sp_ftype) (struct gdbarch *gdbarch, struct frame_info *next_frame);
666 extern CORE_ADDR gdbarch_unwind_sp (struct gdbarch *gdbarch, struct frame_info *next_frame);
667 extern void set_gdbarch_unwind_sp (struct gdbarch *gdbarch, gdbarch_unwind_sp_ftype *unwind_sp);
668
669 /* DEPRECATED_FRAME_LOCALS_ADDRESS as been replaced by the per-frame
670 frame-base. Enable frame-base before frame-unwind. */
671
672 extern int gdbarch_frame_num_args_p (struct gdbarch *gdbarch);
673
674 typedef int (gdbarch_frame_num_args_ftype) (struct frame_info *frame);
675 extern int gdbarch_frame_num_args (struct gdbarch *gdbarch, struct frame_info *frame);
676 extern void set_gdbarch_frame_num_args (struct gdbarch *gdbarch, gdbarch_frame_num_args_ftype *frame_num_args);
677
678 extern int gdbarch_frame_align_p (struct gdbarch *gdbarch);
679
680 typedef CORE_ADDR (gdbarch_frame_align_ftype) (struct gdbarch *gdbarch, CORE_ADDR address);
681 extern CORE_ADDR gdbarch_frame_align (struct gdbarch *gdbarch, CORE_ADDR address);
682 extern void set_gdbarch_frame_align (struct gdbarch *gdbarch, gdbarch_frame_align_ftype *frame_align);
683
684 typedef int (gdbarch_stabs_argument_has_addr_ftype) (struct gdbarch *gdbarch, struct type *type);
685 extern int gdbarch_stabs_argument_has_addr (struct gdbarch *gdbarch, struct type *type);
686 extern void set_gdbarch_stabs_argument_has_addr (struct gdbarch *gdbarch, gdbarch_stabs_argument_has_addr_ftype *stabs_argument_has_addr);
687
688 extern int gdbarch_frame_red_zone_size (struct gdbarch *gdbarch);
689 extern void set_gdbarch_frame_red_zone_size (struct gdbarch *gdbarch, int frame_red_zone_size);
690
691 typedef CORE_ADDR (gdbarch_convert_from_func_ptr_addr_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr, struct target_ops *targ);
692 extern CORE_ADDR gdbarch_convert_from_func_ptr_addr (struct gdbarch *gdbarch, CORE_ADDR addr, struct target_ops *targ);
693 extern void set_gdbarch_convert_from_func_ptr_addr (struct gdbarch *gdbarch, gdbarch_convert_from_func_ptr_addr_ftype *convert_from_func_ptr_addr);
694
695 /* On some machines there are bits in addresses which are not really
696 part of the address, but are used by the kernel, the hardware, etc.
697 for special purposes. gdbarch_addr_bits_remove takes out any such bits so
698 we get a "real" address such as one would find in a symbol table.
699 This is used only for addresses of instructions, and even then I'm
700 not sure it's used in all contexts. It exists to deal with there
701 being a few stray bits in the PC which would mislead us, not as some
702 sort of generic thing to handle alignment or segmentation (it's
703 possible it should be in TARGET_READ_PC instead). */
704
705 typedef CORE_ADDR (gdbarch_addr_bits_remove_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
706 extern CORE_ADDR gdbarch_addr_bits_remove (struct gdbarch *gdbarch, CORE_ADDR addr);
707 extern void set_gdbarch_addr_bits_remove (struct gdbarch *gdbarch, gdbarch_addr_bits_remove_ftype *addr_bits_remove);
708
709 /* On some machines, not all bits of an address word are significant.
710 For example, on AArch64, the top bits of an address known as the "tag"
711 are ignored by the kernel, the hardware, etc. and can be regarded as
712 additional data associated with the address. */
713
714 extern int gdbarch_significant_addr_bit (struct gdbarch *gdbarch);
715 extern void set_gdbarch_significant_addr_bit (struct gdbarch *gdbarch, int significant_addr_bit);
716
717 /* FIXME/cagney/2001-01-18: This should be split in two. A target method that
718 indicates if the target needs software single step. An ISA method to
719 implement it.
720
721 FIXME/cagney/2001-01-18: The logic is backwards. It should be asking if the
722 target can single step. If not, then implement single step using breakpoints.
723
724 Return a vector of addresses on which the software single step
725 breakpoints should be inserted. NULL means software single step is
726 not used.
727 Multiple breakpoints may be inserted for some instructions such as
728 conditional branch. However, each implementation must always evaluate
729 the condition and only put the breakpoint at the branch destination if
730 the condition is true, so that we ensure forward progress when stepping
731 past a conditional branch to self. */
732
733 extern int gdbarch_software_single_step_p (struct gdbarch *gdbarch);
734
735 typedef std::vector<CORE_ADDR> (gdbarch_software_single_step_ftype) (struct regcache *regcache);
736 extern std::vector<CORE_ADDR> gdbarch_software_single_step (struct gdbarch *gdbarch, struct regcache *regcache);
737 extern void set_gdbarch_software_single_step (struct gdbarch *gdbarch, gdbarch_software_single_step_ftype *software_single_step);
738
739 /* Return non-zero if the processor is executing a delay slot and a
740 further single-step is needed before the instruction finishes. */
741
742 extern int gdbarch_single_step_through_delay_p (struct gdbarch *gdbarch);
743
744 typedef int (gdbarch_single_step_through_delay_ftype) (struct gdbarch *gdbarch, struct frame_info *frame);
745 extern int gdbarch_single_step_through_delay (struct gdbarch *gdbarch, struct frame_info *frame);
746 extern void set_gdbarch_single_step_through_delay (struct gdbarch *gdbarch, gdbarch_single_step_through_delay_ftype *single_step_through_delay);
747
748 /* FIXME: cagney/2003-08-28: Need to find a better way of selecting the
749 disassembler. Perhaps objdump can handle it? */
750
751 typedef int (gdbarch_print_insn_ftype) (bfd_vma vma, struct disassemble_info *info);
752 extern int gdbarch_print_insn (struct gdbarch *gdbarch, bfd_vma vma, struct disassemble_info *info);
753 extern void set_gdbarch_print_insn (struct gdbarch *gdbarch, gdbarch_print_insn_ftype *print_insn);
754
755 typedef CORE_ADDR (gdbarch_skip_trampoline_code_ftype) (struct frame_info *frame, CORE_ADDR pc);
756 extern CORE_ADDR gdbarch_skip_trampoline_code (struct gdbarch *gdbarch, struct frame_info *frame, CORE_ADDR pc);
757 extern void set_gdbarch_skip_trampoline_code (struct gdbarch *gdbarch, gdbarch_skip_trampoline_code_ftype *skip_trampoline_code);
758
759 /* If in_solib_dynsym_resolve_code() returns true, and SKIP_SOLIB_RESOLVER
760 evaluates non-zero, this is the address where the debugger will place
761 a step-resume breakpoint to get us past the dynamic linker. */
762
763 typedef CORE_ADDR (gdbarch_skip_solib_resolver_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc);
764 extern CORE_ADDR gdbarch_skip_solib_resolver (struct gdbarch *gdbarch, CORE_ADDR pc);
765 extern void set_gdbarch_skip_solib_resolver (struct gdbarch *gdbarch, gdbarch_skip_solib_resolver_ftype *skip_solib_resolver);
766
767 /* Some systems also have trampoline code for returning from shared libs. */
768
769 typedef int (gdbarch_in_solib_return_trampoline_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc, const char *name);
770 extern int gdbarch_in_solib_return_trampoline (struct gdbarch *gdbarch, CORE_ADDR pc, const char *name);
771 extern void set_gdbarch_in_solib_return_trampoline (struct gdbarch *gdbarch, gdbarch_in_solib_return_trampoline_ftype *in_solib_return_trampoline);
772
773 /* Return true if PC lies inside an indirect branch thunk. */
774
775 typedef bool (gdbarch_in_indirect_branch_thunk_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc);
776 extern bool gdbarch_in_indirect_branch_thunk (struct gdbarch *gdbarch, CORE_ADDR pc);
777 extern void set_gdbarch_in_indirect_branch_thunk (struct gdbarch *gdbarch, gdbarch_in_indirect_branch_thunk_ftype *in_indirect_branch_thunk);
778
779 /* A target might have problems with watchpoints as soon as the stack
780 frame of the current function has been destroyed. This mostly happens
781 as the first action in a function's epilogue. stack_frame_destroyed_p()
782 is defined to return a non-zero value if either the given addr is one
783 instruction after the stack destroying instruction up to the trailing
784 return instruction or if we can figure out that the stack frame has
785 already been invalidated regardless of the value of addr. Targets
786 which don't suffer from that problem could just let this functionality
787 untouched. */
788
789 typedef int (gdbarch_stack_frame_destroyed_p_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
790 extern int gdbarch_stack_frame_destroyed_p (struct gdbarch *gdbarch, CORE_ADDR addr);
791 extern void set_gdbarch_stack_frame_destroyed_p (struct gdbarch *gdbarch, gdbarch_stack_frame_destroyed_p_ftype *stack_frame_destroyed_p);
792
793 /* Process an ELF symbol in the minimal symbol table in a backend-specific
794 way. Normally this hook is supposed to do nothing, however if required,
795 then this hook can be used to apply tranformations to symbols that are
796 considered special in some way. For example the MIPS backend uses it
797 to interpret `st_other' information to mark compressed code symbols so
798 that they can be treated in the appropriate manner in the processing of
799 the main symbol table and DWARF-2 records. */
800
801 extern int gdbarch_elf_make_msymbol_special_p (struct gdbarch *gdbarch);
802
803 typedef void (gdbarch_elf_make_msymbol_special_ftype) (asymbol *sym, struct minimal_symbol *msym);
804 extern void gdbarch_elf_make_msymbol_special (struct gdbarch *gdbarch, asymbol *sym, struct minimal_symbol *msym);
805 extern void set_gdbarch_elf_make_msymbol_special (struct gdbarch *gdbarch, gdbarch_elf_make_msymbol_special_ftype *elf_make_msymbol_special);
806
807 typedef void (gdbarch_coff_make_msymbol_special_ftype) (int val, struct minimal_symbol *msym);
808 extern void gdbarch_coff_make_msymbol_special (struct gdbarch *gdbarch, int val, struct minimal_symbol *msym);
809 extern void set_gdbarch_coff_make_msymbol_special (struct gdbarch *gdbarch, gdbarch_coff_make_msymbol_special_ftype *coff_make_msymbol_special);
810
811 /* Process a symbol in the main symbol table in a backend-specific way.
812 Normally this hook is supposed to do nothing, however if required,
813 then this hook can be used to apply tranformations to symbols that
814 are considered special in some way. This is currently used by the
815 MIPS backend to make sure compressed code symbols have the ISA bit
816 set. This in turn is needed for symbol values seen in GDB to match
817 the values used at the runtime by the program itself, for function
818 and label references. */
819
820 typedef void (gdbarch_make_symbol_special_ftype) (struct symbol *sym, struct objfile *objfile);
821 extern void gdbarch_make_symbol_special (struct gdbarch *gdbarch, struct symbol *sym, struct objfile *objfile);
822 extern void set_gdbarch_make_symbol_special (struct gdbarch *gdbarch, gdbarch_make_symbol_special_ftype *make_symbol_special);
823
824 /* Adjust the address retrieved from a DWARF-2 record other than a line
825 entry in a backend-specific way. Normally this hook is supposed to
826 return the address passed unchanged, however if that is incorrect for
827 any reason, then this hook can be used to fix the address up in the
828 required manner. This is currently used by the MIPS backend to make
829 sure addresses in FDE, range records, etc. referring to compressed
830 code have the ISA bit set, matching line information and the symbol
831 table. */
832
833 typedef CORE_ADDR (gdbarch_adjust_dwarf2_addr_ftype) (CORE_ADDR pc);
834 extern CORE_ADDR gdbarch_adjust_dwarf2_addr (struct gdbarch *gdbarch, CORE_ADDR pc);
835 extern void set_gdbarch_adjust_dwarf2_addr (struct gdbarch *gdbarch, gdbarch_adjust_dwarf2_addr_ftype *adjust_dwarf2_addr);
836
837 /* Adjust the address updated by a line entry in a backend-specific way.
838 Normally this hook is supposed to return the address passed unchanged,
839 however in the case of inconsistencies in these records, this hook can
840 be used to fix them up in the required manner. This is currently used
841 by the MIPS backend to make sure all line addresses in compressed code
842 are presented with the ISA bit set, which is not always the case. This
843 in turn ensures breakpoint addresses are correctly matched against the
844 stop PC. */
845
846 typedef CORE_ADDR (gdbarch_adjust_dwarf2_line_ftype) (CORE_ADDR addr, int rel);
847 extern CORE_ADDR gdbarch_adjust_dwarf2_line (struct gdbarch *gdbarch, CORE_ADDR addr, int rel);
848 extern void set_gdbarch_adjust_dwarf2_line (struct gdbarch *gdbarch, gdbarch_adjust_dwarf2_line_ftype *adjust_dwarf2_line);
849
850 extern int gdbarch_cannot_step_breakpoint (struct gdbarch *gdbarch);
851 extern void set_gdbarch_cannot_step_breakpoint (struct gdbarch *gdbarch, int cannot_step_breakpoint);
852
853 /* See comment in target.h about continuable, steppable and
854 non-steppable watchpoints. */
855
856 extern int gdbarch_have_nonsteppable_watchpoint (struct gdbarch *gdbarch);
857 extern void set_gdbarch_have_nonsteppable_watchpoint (struct gdbarch *gdbarch, int have_nonsteppable_watchpoint);
858
859 extern int gdbarch_address_class_type_flags_p (struct gdbarch *gdbarch);
860
861 typedef int (gdbarch_address_class_type_flags_ftype) (int byte_size, int dwarf2_addr_class);
862 extern int gdbarch_address_class_type_flags (struct gdbarch *gdbarch, int byte_size, int dwarf2_addr_class);
863 extern void set_gdbarch_address_class_type_flags (struct gdbarch *gdbarch, gdbarch_address_class_type_flags_ftype *address_class_type_flags);
864
865 extern int gdbarch_address_class_type_flags_to_name_p (struct gdbarch *gdbarch);
866
867 typedef const char * (gdbarch_address_class_type_flags_to_name_ftype) (struct gdbarch *gdbarch, int type_flags);
868 extern const char * gdbarch_address_class_type_flags_to_name (struct gdbarch *gdbarch, int type_flags);
869 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);
870
871 /* Execute vendor-specific DWARF Call Frame Instruction. OP is the instruction.
872 FS are passed from the generic execute_cfa_program function. */
873
874 typedef bool (gdbarch_execute_dwarf_cfa_vendor_op_ftype) (struct gdbarch *gdbarch, gdb_byte op, struct dwarf2_frame_state *fs);
875 extern bool gdbarch_execute_dwarf_cfa_vendor_op (struct gdbarch *gdbarch, gdb_byte op, struct dwarf2_frame_state *fs);
876 extern void set_gdbarch_execute_dwarf_cfa_vendor_op (struct gdbarch *gdbarch, gdbarch_execute_dwarf_cfa_vendor_op_ftype *execute_dwarf_cfa_vendor_op);
877
878 /* Return the appropriate type_flags for the supplied address class.
879 This function should return 1 if the address class was recognized and
880 type_flags was set, zero otherwise. */
881
882 extern int gdbarch_address_class_name_to_type_flags_p (struct gdbarch *gdbarch);
883
884 typedef int (gdbarch_address_class_name_to_type_flags_ftype) (struct gdbarch *gdbarch, const char *name, int *type_flags_ptr);
885 extern int gdbarch_address_class_name_to_type_flags (struct gdbarch *gdbarch, const char *name, int *type_flags_ptr);
886 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);
887
888 /* Is a register in a group */
889
890 typedef int (gdbarch_register_reggroup_p_ftype) (struct gdbarch *gdbarch, int regnum, struct reggroup *reggroup);
891 extern int gdbarch_register_reggroup_p (struct gdbarch *gdbarch, int regnum, struct reggroup *reggroup);
892 extern void set_gdbarch_register_reggroup_p (struct gdbarch *gdbarch, gdbarch_register_reggroup_p_ftype *register_reggroup_p);
893
894 /* Fetch the pointer to the ith function argument. */
895
896 extern int gdbarch_fetch_pointer_argument_p (struct gdbarch *gdbarch);
897
898 typedef CORE_ADDR (gdbarch_fetch_pointer_argument_ftype) (struct frame_info *frame, int argi, struct type *type);
899 extern CORE_ADDR gdbarch_fetch_pointer_argument (struct gdbarch *gdbarch, struct frame_info *frame, int argi, struct type *type);
900 extern void set_gdbarch_fetch_pointer_argument (struct gdbarch *gdbarch, gdbarch_fetch_pointer_argument_ftype *fetch_pointer_argument);
901
902 /* Iterate over all supported register notes in a core file. For each
903 supported register note section, the iterator must call CB and pass
904 CB_DATA unchanged. If REGCACHE is not NULL, the iterator can limit
905 the supported register note sections based on the current register
906 values. Otherwise it should enumerate all supported register note
907 sections. */
908
909 extern int gdbarch_iterate_over_regset_sections_p (struct gdbarch *gdbarch);
910
911 typedef void (gdbarch_iterate_over_regset_sections_ftype) (struct gdbarch *gdbarch, iterate_over_regset_sections_cb *cb, void *cb_data, const struct regcache *regcache);
912 extern void gdbarch_iterate_over_regset_sections (struct gdbarch *gdbarch, iterate_over_regset_sections_cb *cb, void *cb_data, const struct regcache *regcache);
913 extern void set_gdbarch_iterate_over_regset_sections (struct gdbarch *gdbarch, gdbarch_iterate_over_regset_sections_ftype *iterate_over_regset_sections);
914
915 /* Create core file notes */
916
917 extern int gdbarch_make_corefile_notes_p (struct gdbarch *gdbarch);
918
919 typedef char * (gdbarch_make_corefile_notes_ftype) (struct gdbarch *gdbarch, bfd *obfd, int *note_size);
920 extern char * gdbarch_make_corefile_notes (struct gdbarch *gdbarch, bfd *obfd, int *note_size);
921 extern void set_gdbarch_make_corefile_notes (struct gdbarch *gdbarch, gdbarch_make_corefile_notes_ftype *make_corefile_notes);
922
923 /* Find core file memory regions */
924
925 extern int gdbarch_find_memory_regions_p (struct gdbarch *gdbarch);
926
927 typedef int (gdbarch_find_memory_regions_ftype) (struct gdbarch *gdbarch, find_memory_region_ftype func, void *data);
928 extern int gdbarch_find_memory_regions (struct gdbarch *gdbarch, find_memory_region_ftype func, void *data);
929 extern void set_gdbarch_find_memory_regions (struct gdbarch *gdbarch, gdbarch_find_memory_regions_ftype *find_memory_regions);
930
931 /* Read offset OFFSET of TARGET_OBJECT_LIBRARIES formatted shared libraries list from
932 core file into buffer READBUF with length LEN. Return the number of bytes read
933 (zero indicates failure).
934 failed, otherwise, return the red length of READBUF. */
935
936 extern int gdbarch_core_xfer_shared_libraries_p (struct gdbarch *gdbarch);
937
938 typedef ULONGEST (gdbarch_core_xfer_shared_libraries_ftype) (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
939 extern ULONGEST gdbarch_core_xfer_shared_libraries (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
940 extern void set_gdbarch_core_xfer_shared_libraries (struct gdbarch *gdbarch, gdbarch_core_xfer_shared_libraries_ftype *core_xfer_shared_libraries);
941
942 /* Read offset OFFSET of TARGET_OBJECT_LIBRARIES_AIX formatted shared
943 libraries list from core file into buffer READBUF with length LEN.
944 Return the number of bytes read (zero indicates failure). */
945
946 extern int gdbarch_core_xfer_shared_libraries_aix_p (struct gdbarch *gdbarch);
947
948 typedef ULONGEST (gdbarch_core_xfer_shared_libraries_aix_ftype) (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
949 extern ULONGEST gdbarch_core_xfer_shared_libraries_aix (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
950 extern void set_gdbarch_core_xfer_shared_libraries_aix (struct gdbarch *gdbarch, gdbarch_core_xfer_shared_libraries_aix_ftype *core_xfer_shared_libraries_aix);
951
952 /* How the core target converts a PTID from a core file to a string. */
953
954 extern int gdbarch_core_pid_to_str_p (struct gdbarch *gdbarch);
955
956 typedef std::string (gdbarch_core_pid_to_str_ftype) (struct gdbarch *gdbarch, ptid_t ptid);
957 extern std::string gdbarch_core_pid_to_str (struct gdbarch *gdbarch, ptid_t ptid);
958 extern void set_gdbarch_core_pid_to_str (struct gdbarch *gdbarch, gdbarch_core_pid_to_str_ftype *core_pid_to_str);
959
960 /* How the core target extracts the name of a thread from a core file. */
961
962 extern int gdbarch_core_thread_name_p (struct gdbarch *gdbarch);
963
964 typedef const char * (gdbarch_core_thread_name_ftype) (struct gdbarch *gdbarch, struct thread_info *thr);
965 extern const char * gdbarch_core_thread_name (struct gdbarch *gdbarch, struct thread_info *thr);
966 extern void set_gdbarch_core_thread_name (struct gdbarch *gdbarch, gdbarch_core_thread_name_ftype *core_thread_name);
967
968 /* Read offset OFFSET of TARGET_OBJECT_SIGNAL_INFO signal information
969 from core file into buffer READBUF with length LEN. Return the number
970 of bytes read (zero indicates EOF, a negative value indicates failure). */
971
972 extern int gdbarch_core_xfer_siginfo_p (struct gdbarch *gdbarch);
973
974 typedef LONGEST (gdbarch_core_xfer_siginfo_ftype) (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
975 extern LONGEST gdbarch_core_xfer_siginfo (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
976 extern void set_gdbarch_core_xfer_siginfo (struct gdbarch *gdbarch, gdbarch_core_xfer_siginfo_ftype *core_xfer_siginfo);
977
978 /* BFD target to use when generating a core file. */
979
980 extern int gdbarch_gcore_bfd_target_p (struct gdbarch *gdbarch);
981
982 extern const char * gdbarch_gcore_bfd_target (struct gdbarch *gdbarch);
983 extern void set_gdbarch_gcore_bfd_target (struct gdbarch *gdbarch, const char * gcore_bfd_target);
984
985 /* If the elements of C++ vtables are in-place function descriptors rather
986 than normal function pointers (which may point to code or a descriptor),
987 set this to one. */
988
989 extern int gdbarch_vtable_function_descriptors (struct gdbarch *gdbarch);
990 extern void set_gdbarch_vtable_function_descriptors (struct gdbarch *gdbarch, int vtable_function_descriptors);
991
992 /* Set if the least significant bit of the delta is used instead of the least
993 significant bit of the pfn for pointers to virtual member functions. */
994
995 extern int gdbarch_vbit_in_delta (struct gdbarch *gdbarch);
996 extern void set_gdbarch_vbit_in_delta (struct gdbarch *gdbarch, int vbit_in_delta);
997
998 /* Advance PC to next instruction in order to skip a permanent breakpoint. */
999
1000 typedef void (gdbarch_skip_permanent_breakpoint_ftype) (struct regcache *regcache);
1001 extern void gdbarch_skip_permanent_breakpoint (struct gdbarch *gdbarch, struct regcache *regcache);
1002 extern void set_gdbarch_skip_permanent_breakpoint (struct gdbarch *gdbarch, gdbarch_skip_permanent_breakpoint_ftype *skip_permanent_breakpoint);
1003
1004 /* The maximum length of an instruction on this architecture in bytes. */
1005
1006 extern int gdbarch_max_insn_length_p (struct gdbarch *gdbarch);
1007
1008 extern ULONGEST gdbarch_max_insn_length (struct gdbarch *gdbarch);
1009 extern void set_gdbarch_max_insn_length (struct gdbarch *gdbarch, ULONGEST max_insn_length);
1010
1011 /* Copy the instruction at FROM to TO, and make any adjustments
1012 necessary to single-step it at that address.
1013
1014 REGS holds the state the thread's registers will have before
1015 executing the copied instruction; the PC in REGS will refer to FROM,
1016 not the copy at TO. The caller should update it to point at TO later.
1017
1018 Return a pointer to data of the architecture's choice to be passed
1019 to gdbarch_displaced_step_fixup. Or, return NULL to indicate that
1020 the instruction's effects have been completely simulated, with the
1021 resulting state written back to REGS.
1022
1023 For a general explanation of displaced stepping and how GDB uses it,
1024 see the comments in infrun.c.
1025
1026 The TO area is only guaranteed to have space for
1027 gdbarch_max_insn_length (arch) bytes, so this function must not
1028 write more bytes than that to that area.
1029
1030 If you do not provide this function, GDB assumes that the
1031 architecture does not support displaced stepping.
1032
1033 If the instruction cannot execute out of line, return NULL. The
1034 core falls back to stepping past the instruction in-line instead in
1035 that case. */
1036
1037 extern int gdbarch_displaced_step_copy_insn_p (struct gdbarch *gdbarch);
1038
1039 typedef struct displaced_step_closure * (gdbarch_displaced_step_copy_insn_ftype) (struct gdbarch *gdbarch, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
1040 extern struct displaced_step_closure * gdbarch_displaced_step_copy_insn (struct gdbarch *gdbarch, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
1041 extern void set_gdbarch_displaced_step_copy_insn (struct gdbarch *gdbarch, gdbarch_displaced_step_copy_insn_ftype *displaced_step_copy_insn);
1042
1043 /* Return true if GDB should use hardware single-stepping to execute
1044 the displaced instruction identified by CLOSURE. If false,
1045 GDB will simply restart execution at the displaced instruction
1046 location, and it is up to the target to ensure GDB will receive
1047 control again (e.g. by placing a software breakpoint instruction
1048 into the displaced instruction buffer).
1049
1050 The default implementation returns false on all targets that
1051 provide a gdbarch_software_single_step routine, and true otherwise. */
1052
1053 typedef int (gdbarch_displaced_step_hw_singlestep_ftype) (struct gdbarch *gdbarch, struct displaced_step_closure *closure);
1054 extern int gdbarch_displaced_step_hw_singlestep (struct gdbarch *gdbarch, struct displaced_step_closure *closure);
1055 extern void set_gdbarch_displaced_step_hw_singlestep (struct gdbarch *gdbarch, gdbarch_displaced_step_hw_singlestep_ftype *displaced_step_hw_singlestep);
1056
1057 /* Fix up the state resulting from successfully single-stepping a
1058 displaced instruction, to give the result we would have gotten from
1059 stepping the instruction in its original location.
1060
1061 REGS is the register state resulting from single-stepping the
1062 displaced instruction.
1063
1064 CLOSURE is the result from the matching call to
1065 gdbarch_displaced_step_copy_insn.
1066
1067 If you provide gdbarch_displaced_step_copy_insn.but not this
1068 function, then GDB assumes that no fixup is needed after
1069 single-stepping the instruction.
1070
1071 For a general explanation of displaced stepping and how GDB uses it,
1072 see the comments in infrun.c. */
1073
1074 extern int gdbarch_displaced_step_fixup_p (struct gdbarch *gdbarch);
1075
1076 typedef void (gdbarch_displaced_step_fixup_ftype) (struct gdbarch *gdbarch, struct displaced_step_closure *closure, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
1077 extern void gdbarch_displaced_step_fixup (struct gdbarch *gdbarch, struct displaced_step_closure *closure, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
1078 extern void set_gdbarch_displaced_step_fixup (struct gdbarch *gdbarch, gdbarch_displaced_step_fixup_ftype *displaced_step_fixup);
1079
1080 /* Return the address of an appropriate place to put displaced
1081 instructions while we step over them. There need only be one such
1082 place, since we're only stepping one thread over a breakpoint at a
1083 time.
1084
1085 For a general explanation of displaced stepping and how GDB uses it,
1086 see the comments in infrun.c. */
1087
1088 typedef CORE_ADDR (gdbarch_displaced_step_location_ftype) (struct gdbarch *gdbarch);
1089 extern CORE_ADDR gdbarch_displaced_step_location (struct gdbarch *gdbarch);
1090 extern void set_gdbarch_displaced_step_location (struct gdbarch *gdbarch, gdbarch_displaced_step_location_ftype *displaced_step_location);
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 /* Read one auxv entry from *READPTR, not reading locations >= ENDPTR.
1549 Return 0 if *READPTR is already at the end of the buffer.
1550 Return -1 if there is insufficient buffer for a whole entry.
1551 Return 1 if an entry was read into *TYPEP and *VALP. */
1552
1553 extern int gdbarch_auxv_parse_p (struct gdbarch *gdbarch);
1554
1555 typedef int (gdbarch_auxv_parse_ftype) (struct gdbarch *gdbarch, gdb_byte **readptr, gdb_byte *endptr, CORE_ADDR *typep, CORE_ADDR *valp);
1556 extern int gdbarch_auxv_parse (struct gdbarch *gdbarch, gdb_byte **readptr, gdb_byte *endptr, CORE_ADDR *typep, CORE_ADDR *valp);
1557 extern void set_gdbarch_auxv_parse (struct gdbarch *gdbarch, gdbarch_auxv_parse_ftype *auxv_parse);
1558
1559 /* Print the description of a single auxv entry described by TYPE and VAL
1560 to FILE. */
1561
1562 typedef void (gdbarch_print_auxv_entry_ftype) (struct gdbarch *gdbarch, struct ui_file *file, CORE_ADDR type, CORE_ADDR val);
1563 extern void gdbarch_print_auxv_entry (struct gdbarch *gdbarch, struct ui_file *file, CORE_ADDR type, CORE_ADDR val);
1564 extern void set_gdbarch_print_auxv_entry (struct gdbarch *gdbarch, gdbarch_print_auxv_entry_ftype *print_auxv_entry);
1565
1566 /* Find the address range of the current inferior's vsyscall/vDSO, and
1567 write it to *RANGE. If the vsyscall's length can't be determined, a
1568 range with zero length is returned. Returns true if the vsyscall is
1569 found, false otherwise. */
1570
1571 typedef int (gdbarch_vsyscall_range_ftype) (struct gdbarch *gdbarch, struct mem_range *range);
1572 extern int gdbarch_vsyscall_range (struct gdbarch *gdbarch, struct mem_range *range);
1573 extern void set_gdbarch_vsyscall_range (struct gdbarch *gdbarch, gdbarch_vsyscall_range_ftype *vsyscall_range);
1574
1575 /* Allocate SIZE bytes of PROT protected page aligned memory in inferior.
1576 PROT has GDB_MMAP_PROT_* bitmask format.
1577 Throw an error if it is not possible. Returned address is always valid. */
1578
1579 typedef CORE_ADDR (gdbarch_infcall_mmap_ftype) (CORE_ADDR size, unsigned prot);
1580 extern CORE_ADDR gdbarch_infcall_mmap (struct gdbarch *gdbarch, CORE_ADDR size, unsigned prot);
1581 extern void set_gdbarch_infcall_mmap (struct gdbarch *gdbarch, gdbarch_infcall_mmap_ftype *infcall_mmap);
1582
1583 /* Deallocate SIZE bytes of memory at ADDR in inferior from gdbarch_infcall_mmap.
1584 Print a warning if it is not possible. */
1585
1586 typedef void (gdbarch_infcall_munmap_ftype) (CORE_ADDR addr, CORE_ADDR size);
1587 extern void gdbarch_infcall_munmap (struct gdbarch *gdbarch, CORE_ADDR addr, CORE_ADDR size);
1588 extern void set_gdbarch_infcall_munmap (struct gdbarch *gdbarch, gdbarch_infcall_munmap_ftype *infcall_munmap);
1589
1590 /* Return string (caller has to use xfree for it) with options for GCC
1591 to produce code for this target, typically "-m64", "-m32" or "-m31".
1592 These options are put before CU's DW_AT_producer compilation options so that
1593 they can override it. */
1594
1595 typedef std::string (gdbarch_gcc_target_options_ftype) (struct gdbarch *gdbarch);
1596 extern std::string gdbarch_gcc_target_options (struct gdbarch *gdbarch);
1597 extern void set_gdbarch_gcc_target_options (struct gdbarch *gdbarch, gdbarch_gcc_target_options_ftype *gcc_target_options);
1598
1599 /* Return a regular expression that matches names used by this
1600 architecture in GNU configury triplets. The result is statically
1601 allocated and must not be freed. The default implementation simply
1602 returns the BFD architecture name, which is correct in nearly every
1603 case. */
1604
1605 typedef const char * (gdbarch_gnu_triplet_regexp_ftype) (struct gdbarch *gdbarch);
1606 extern const char * gdbarch_gnu_triplet_regexp (struct gdbarch *gdbarch);
1607 extern void set_gdbarch_gnu_triplet_regexp (struct gdbarch *gdbarch, gdbarch_gnu_triplet_regexp_ftype *gnu_triplet_regexp);
1608
1609 /* Return the size in 8-bit bytes of an addressable memory unit on this
1610 architecture. This corresponds to the number of 8-bit bytes associated to
1611 each address in memory. */
1612
1613 typedef int (gdbarch_addressable_memory_unit_size_ftype) (struct gdbarch *gdbarch);
1614 extern int gdbarch_addressable_memory_unit_size (struct gdbarch *gdbarch);
1615 extern void set_gdbarch_addressable_memory_unit_size (struct gdbarch *gdbarch, gdbarch_addressable_memory_unit_size_ftype *addressable_memory_unit_size);
1616
1617 /* Functions for allowing a target to modify its disassembler options. */
1618
1619 extern const char * gdbarch_disassembler_options_implicit (struct gdbarch *gdbarch);
1620 extern void set_gdbarch_disassembler_options_implicit (struct gdbarch *gdbarch, const char * disassembler_options_implicit);
1621
1622 extern char ** gdbarch_disassembler_options (struct gdbarch *gdbarch);
1623 extern void set_gdbarch_disassembler_options (struct gdbarch *gdbarch, char ** disassembler_options);
1624
1625 extern const disasm_options_and_args_t * gdbarch_valid_disassembler_options (struct gdbarch *gdbarch);
1626 extern void set_gdbarch_valid_disassembler_options (struct gdbarch *gdbarch, const disasm_options_and_args_t * valid_disassembler_options);
1627
1628 /* Type alignment override method. Return the architecture specific
1629 alignment required for TYPE. If there is no special handling
1630 required for TYPE then return the value 0, GDB will then apply the
1631 default rules as laid out in gdbtypes.c:type_align. */
1632
1633 typedef ULONGEST (gdbarch_type_align_ftype) (struct gdbarch *gdbarch, struct type *type);
1634 extern ULONGEST gdbarch_type_align (struct gdbarch *gdbarch, struct type *type);
1635 extern void set_gdbarch_type_align (struct gdbarch *gdbarch, gdbarch_type_align_ftype *type_align);
1636
1637 /* Return a string containing any flags for the given PC in the given FRAME. */
1638
1639 typedef std::string (gdbarch_get_pc_address_flags_ftype) (frame_info *frame, CORE_ADDR pc);
1640 extern std::string gdbarch_get_pc_address_flags (struct gdbarch *gdbarch, frame_info *frame, CORE_ADDR pc);
1641 extern void set_gdbarch_get_pc_address_flags (struct gdbarch *gdbarch, gdbarch_get_pc_address_flags_ftype *get_pc_address_flags);
1642
1643 extern struct gdbarch_tdep *gdbarch_tdep (struct gdbarch *gdbarch);
1644
1645
1646 /* Mechanism for co-ordinating the selection of a specific
1647 architecture.
1648
1649 GDB targets (*-tdep.c) can register an interest in a specific
1650 architecture. Other GDB components can register a need to maintain
1651 per-architecture data.
1652
1653 The mechanisms below ensures that there is only a loose connection
1654 between the set-architecture command and the various GDB
1655 components. Each component can independently register their need
1656 to maintain architecture specific data with gdbarch.
1657
1658 Pragmatics:
1659
1660 Previously, a single TARGET_ARCHITECTURE_HOOK was provided. It
1661 didn't scale.
1662
1663 The more traditional mega-struct containing architecture specific
1664 data for all the various GDB components was also considered. Since
1665 GDB is built from a variable number of (fairly independent)
1666 components it was determined that the global aproach was not
1667 applicable. */
1668
1669
1670 /* Register a new architectural family with GDB.
1671
1672 Register support for the specified ARCHITECTURE with GDB. When
1673 gdbarch determines that the specified architecture has been
1674 selected, the corresponding INIT function is called.
1675
1676 --
1677
1678 The INIT function takes two parameters: INFO which contains the
1679 information available to gdbarch about the (possibly new)
1680 architecture; ARCHES which is a list of the previously created
1681 ``struct gdbarch'' for this architecture.
1682
1683 The INFO parameter is, as far as possible, be pre-initialized with
1684 information obtained from INFO.ABFD or the global defaults.
1685
1686 The ARCHES parameter is a linked list (sorted most recently used)
1687 of all the previously created architures for this architecture
1688 family. The (possibly NULL) ARCHES->gdbarch can used to access
1689 values from the previously selected architecture for this
1690 architecture family.
1691
1692 The INIT function shall return any of: NULL - indicating that it
1693 doesn't recognize the selected architecture; an existing ``struct
1694 gdbarch'' from the ARCHES list - indicating that the new
1695 architecture is just a synonym for an earlier architecture (see
1696 gdbarch_list_lookup_by_info()); a newly created ``struct gdbarch''
1697 - that describes the selected architecture (see gdbarch_alloc()).
1698
1699 The DUMP_TDEP function shall print out all target specific values.
1700 Care should be taken to ensure that the function works in both the
1701 multi-arch and non- multi-arch cases. */
1702
1703 struct gdbarch_list
1704 {
1705 struct gdbarch *gdbarch;
1706 struct gdbarch_list *next;
1707 };
1708
1709 struct gdbarch_info
1710 {
1711 /* Use default: NULL (ZERO). */
1712 const struct bfd_arch_info *bfd_arch_info;
1713
1714 /* Use default: BFD_ENDIAN_UNKNOWN (NB: is not ZERO). */
1715 enum bfd_endian byte_order;
1716
1717 enum bfd_endian byte_order_for_code;
1718
1719 /* Use default: NULL (ZERO). */
1720 bfd *abfd;
1721
1722 /* Use default: NULL (ZERO). */
1723 union
1724 {
1725 /* Architecture-specific information. The generic form for targets
1726 that have extra requirements. */
1727 struct gdbarch_tdep_info *tdep_info;
1728
1729 /* Architecture-specific target description data. Numerous targets
1730 need only this, so give them an easy way to hold it. */
1731 struct tdesc_arch_data *tdesc_data;
1732
1733 /* SPU file system ID. This is a single integer, so using the
1734 generic form would only complicate code. Other targets may
1735 reuse this member if suitable. */
1736 int *id;
1737 };
1738
1739 /* Use default: GDB_OSABI_UNINITIALIZED (-1). */
1740 enum gdb_osabi osabi;
1741
1742 /* Use default: NULL (ZERO). */
1743 const struct target_desc *target_desc;
1744 };
1745
1746 typedef struct gdbarch *(gdbarch_init_ftype) (struct gdbarch_info info, struct gdbarch_list *arches);
1747 typedef void (gdbarch_dump_tdep_ftype) (struct gdbarch *gdbarch, struct ui_file *file);
1748
1749 /* DEPRECATED - use gdbarch_register() */
1750 extern void register_gdbarch_init (enum bfd_architecture architecture, gdbarch_init_ftype *);
1751
1752 extern void gdbarch_register (enum bfd_architecture architecture,
1753 gdbarch_init_ftype *,
1754 gdbarch_dump_tdep_ftype *);
1755
1756
1757 /* Return a freshly allocated, NULL terminated, array of the valid
1758 architecture names. Since architectures are registered during the
1759 _initialize phase this function only returns useful information
1760 once initialization has been completed. */
1761
1762 extern const char **gdbarch_printable_names (void);
1763
1764
1765 /* Helper function. Search the list of ARCHES for a GDBARCH that
1766 matches the information provided by INFO. */
1767
1768 extern struct gdbarch_list *gdbarch_list_lookup_by_info (struct gdbarch_list *arches, const struct gdbarch_info *info);
1769
1770
1771 /* Helper function. Create a preliminary ``struct gdbarch''. Perform
1772 basic initialization using values obtained from the INFO and TDEP
1773 parameters. set_gdbarch_*() functions are called to complete the
1774 initialization of the object. */
1775
1776 extern struct gdbarch *gdbarch_alloc (const struct gdbarch_info *info, struct gdbarch_tdep *tdep);
1777
1778
1779 /* Helper function. Free a partially-constructed ``struct gdbarch''.
1780 It is assumed that the caller freeds the ``struct
1781 gdbarch_tdep''. */
1782
1783 extern void gdbarch_free (struct gdbarch *);
1784
1785 /* Get the obstack owned by ARCH. */
1786
1787 extern obstack *gdbarch_obstack (gdbarch *arch);
1788
1789 /* Helper function. Allocate memory from the ``struct gdbarch''
1790 obstack. The memory is freed when the corresponding architecture
1791 is also freed. */
1792
1793 #define GDBARCH_OBSTACK_CALLOC(GDBARCH, NR, TYPE) obstack_calloc<TYPE> (gdbarch_obstack ((GDBARCH)), (NR))
1794
1795 #define GDBARCH_OBSTACK_ZALLOC(GDBARCH, TYPE) obstack_zalloc<TYPE> (gdbarch_obstack ((GDBARCH)))
1796
1797 /* Duplicate STRING, returning an equivalent string that's allocated on the
1798 obstack associated with GDBARCH. The string is freed when the corresponding
1799 architecture is also freed. */
1800
1801 extern char *gdbarch_obstack_strdup (struct gdbarch *arch, const char *string);
1802
1803 /* Helper function. Force an update of the current architecture.
1804
1805 The actual architecture selected is determined by INFO, ``(gdb) set
1806 architecture'' et.al., the existing architecture and BFD's default
1807 architecture. INFO should be initialized to zero and then selected
1808 fields should be updated.
1809
1810 Returns non-zero if the update succeeds. */
1811
1812 extern int gdbarch_update_p (struct gdbarch_info info);
1813
1814
1815 /* Helper function. Find an architecture matching info.
1816
1817 INFO should be initialized using gdbarch_info_init, relevant fields
1818 set, and then finished using gdbarch_info_fill.
1819
1820 Returns the corresponding architecture, or NULL if no matching
1821 architecture was found. */
1822
1823 extern struct gdbarch *gdbarch_find_by_info (struct gdbarch_info info);
1824
1825
1826 /* Helper function. Set the target gdbarch to "gdbarch". */
1827
1828 extern void set_target_gdbarch (struct gdbarch *gdbarch);
1829
1830
1831 /* Register per-architecture data-pointer.
1832
1833 Reserve space for a per-architecture data-pointer. An identifier
1834 for the reserved data-pointer is returned. That identifer should
1835 be saved in a local static variable.
1836
1837 Memory for the per-architecture data shall be allocated using
1838 gdbarch_obstack_zalloc. That memory will be deleted when the
1839 corresponding architecture object is deleted.
1840
1841 When a previously created architecture is re-selected, the
1842 per-architecture data-pointer for that previous architecture is
1843 restored. INIT() is not re-called.
1844
1845 Multiple registrarants for any architecture are allowed (and
1846 strongly encouraged). */
1847
1848 struct gdbarch_data;
1849
1850 typedef void *(gdbarch_data_pre_init_ftype) (struct obstack *obstack);
1851 extern struct gdbarch_data *gdbarch_data_register_pre_init (gdbarch_data_pre_init_ftype *init);
1852 typedef void *(gdbarch_data_post_init_ftype) (struct gdbarch *gdbarch);
1853 extern struct gdbarch_data *gdbarch_data_register_post_init (gdbarch_data_post_init_ftype *init);
1854 extern void deprecated_set_gdbarch_data (struct gdbarch *gdbarch,
1855 struct gdbarch_data *data,
1856 void *pointer);
1857
1858 extern void *gdbarch_data (struct gdbarch *gdbarch, struct gdbarch_data *);
1859
1860
1861 /* Set the dynamic target-system-dependent parameters (architecture,
1862 byte-order, ...) using information found in the BFD. */
1863
1864 extern void set_gdbarch_from_file (bfd *);
1865
1866
1867 /* Initialize the current architecture to the "first" one we find on
1868 our list. */
1869
1870 extern void initialize_current_architecture (void);
1871
1872 /* gdbarch trace variable */
1873 extern unsigned int gdbarch_debug;
1874
1875 extern void gdbarch_dump (struct gdbarch *gdbarch, struct ui_file *file);
1876
1877 /* Return the number of cooked registers (raw + pseudo) for ARCH. */
1878
1879 static inline int
1880 gdbarch_num_cooked_regs (gdbarch *arch)
1881 {
1882 return gdbarch_num_regs (arch) + gdbarch_num_pseudo_regs (arch);
1883 }
1884
1885 #endif
This page took 0.076252 seconds and 4 git commands to generate.