GDB (xrefs)
Loading...
Searching...
No Matches
gdbarch_components.py
Go to the documentation of this file.
1# Dynamic architecture support for GDB, the GNU debugger.
2
3# Copyright (C) 1998-2023 Free Software Foundation, Inc.
4
5# This file is part of GDB.
6
7# This program is free software; you can redistribute it and/or modify
8# it under the terms of the GNU General Public License as published by
9# the Free Software Foundation; either version 3 of the License, or
10# (at your option) any later version.
11
12# This program is distributed in the hope that it will be useful,
13# but WITHOUT ANY WARRANTY; without even the implied warranty of
14# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15# GNU General Public License for more details.
16
17# You should have received a copy of the GNU General Public License
18# along with this program. If not, see <http://www.gnu.org/licenses/>.
19
20# How to add to gdbarch:
21#
22# There are four kinds of fields in gdbarch:
23#
24# * Info - you should never need this; it is only for things that are
25# copied directly from the gdbarch_info.
26#
27# * Value - a variable.
28#
29# * Function - a function pointer.
30#
31# * Method - a function pointer, but the function takes a gdbarch as
32# its first parameter.
33#
34# You construct a new one with a call to one of those functions. So,
35# for instance, you can use the function named "Value" to make a new
36# Value.
37#
38# All parameters are keyword-only. This is done to help catch typos.
39#
40# Some parameters are shared among all types (including Info):
41#
42# * "name" - required, the name of the field.
43#
44# * "type" - required, the type of the field. For functions and
45# methods, this is the return type.
46#
47# * "printer" - an expression to turn this field into a 'const char
48# *'. This is used for dumping. The string must live long enough to
49# be passed to printf.
50#
51# Value, Function, and Method share some more parameters. Some of
52# these work in conjunction in a somewhat complicated way, so they are
53# described in a separate sub-section below.
54#
55# * "comment" - a comment that's written to the .h file. Please
56# always use this. (It isn't currently a required option for
57# historical reasons.)
58#
59# * "predicate" - a boolean, if True then a _p predicate function will
60# be generated. The predicate will use the generic validation
61# function for the field. See below.
62#
63# * "predefault", "postdefault", and "invalid" - These are used for
64# the initialization and verification steps:
65#
66# A gdbarch is zero-initialized. Then, if a field has a "predefault",
67# the field is set to that value. This becomes the field's initial
68# value.
69#
70# After initialization is complete (that is, after the tdep code has a
71# chance to change the settings), the post-initialization step is
72# done.
73#
74# If the field still has its initial value (see above), and the field
75# has a "postdefault", then the field is set to this value.
76#
77# After the possible "postdefault" assignment, validation is
78# performed for fields that don't have a "predicate".
79#
80# If the field has an "invalid" attribute with a string value, then
81# this string is the expression that should evaluate to true when the
82# field is invalid.
83#
84# Otherwise, if "invalid" is True (the default), then the generic
85# validation function is used: the field is considered invalid it
86# still contains its default value. This validation is what is used
87# within the _p predicate function if the field has "predicate" set to
88# True.
89#
90# Function and Method share:
91#
92# * "params" - required, a tuple of tuples. Each inner tuple is a
93# pair of the form (TYPE, NAME), where TYPE is the type of this
94# argument, and NAME is the name. Note that while the names could be
95# auto-generated, this approach lets the "comment" field refer to
96# arguments in a nicer way. It is also just nicer for users.
97#
98# * "param_checks" - optional, a list of strings. Each string is an
99# expression that is placed within a gdb_assert before the call is
100# made to the Function/Method implementation. Each expression is
101# something that should be true, and it is expected that the
102# expression will make use of the parameters named in 'params' (though
103# this is not required).
104#
105# * "result_checks" - optional, a list of strings. Each string is an
106# expression that is placed within a gdb_assert after the call to the
107# Function/Method implementation. Within each expression the variable
108# 'result' can be used to reference the result of the function/method
109# implementation. The 'result_checks' can only be used if the 'type'
110# of this Function/Method is not 'void'.
111#
112# * "implement" - optional, a boolean. If True (the default), a
113# wrapper function for this function will be emitted.
114
115from gdbarch_types import Function, Info, Method, Value
116
117Info(
118 type="const struct bfd_arch_info *",
119 name="bfd_arch_info",
120 printer="gdbarch_bfd_arch_info (gdbarch)->printable_name",
121)
122
123Info(
124 type="enum bfd_endian",
125 name="byte_order",
126)
127
128Info(
129 type="enum bfd_endian",
130 name="byte_order_for_code",
131)
132
133Info(
134 type="enum gdb_osabi",
135 name="osabi",
136)
137
138Info(
139 type="const struct target_desc *",
140 name="target_desc",
141 printer="host_address_to_string (gdbarch->target_desc)",
142)
143
144Value(
145 comment="""
146Number of bits in a short or unsigned short for the target machine.
147""",
148 type="int",
149 name="short_bit",
150 predefault="2*TARGET_CHAR_BIT",
151 invalid=False,
152)
153
154int_bit = Value(
155 comment="""
156Number of bits in an int or unsigned int for the target machine.
157""",
158 type="int",
159 name="int_bit",
160 predefault="4*TARGET_CHAR_BIT",
161 invalid=False,
162)
163
164long_bit_predefault = "4*TARGET_CHAR_BIT"
165long_bit = Value(
166 comment="""
167Number of bits in a long or unsigned long for the target machine.
168""",
169 type="int",
170 name="long_bit",
171 predefault=long_bit_predefault,
172 invalid=False,
173)
174
175Value(
176 comment="""
177Number of bits in a long long or unsigned long long for the target
178machine.
179""",
180 type="int",
181 name="long_long_bit",
182 predefault="2*" + long_bit_predefault,
183 invalid=False,
184)
185
186Value(
187 comment="""
188The ABI default bit-size and format for "bfloat16", "half", "float", "double", and
189"long double". These bit/format pairs should eventually be combined
190into a single object. For the moment, just initialize them as a pair.
191Each format describes both the big and little endian layouts (if
192useful).
193""",
194 type="int",
195 name="bfloat16_bit",
196 predefault="2*TARGET_CHAR_BIT",
197 invalid=False,
198)
199
200Value(
201 type="const struct floatformat **",
202 name="bfloat16_format",
203 predefault="floatformats_bfloat16",
204 printer="pformat (gdbarch, gdbarch->bfloat16_format)",
205 invalid=False,
206)
207
208Value(
209 type="int",
210 name="half_bit",
211 predefault="2*TARGET_CHAR_BIT",
212 invalid=False,
213)
214
215Value(
216 type="const struct floatformat **",
217 name="half_format",
218 predefault="floatformats_ieee_half",
219 printer="pformat (gdbarch, gdbarch->half_format)",
220 invalid=False,
221)
222
223Value(
224 type="int",
225 name="float_bit",
226 predefault="4*TARGET_CHAR_BIT",
227 invalid=False,
228)
229
230Value(
231 type="const struct floatformat **",
232 name="float_format",
233 predefault="floatformats_ieee_single",
234 printer="pformat (gdbarch, gdbarch->float_format)",
235 invalid=False,
236)
237
238Value(
239 type="int",
240 name="double_bit",
241 predefault="8*TARGET_CHAR_BIT",
242 invalid=False,
243)
244
245Value(
246 type="const struct floatformat **",
247 name="double_format",
248 predefault="floatformats_ieee_double",
249 printer="pformat (gdbarch, gdbarch->double_format)",
250 invalid=False,
251)
252
253Value(
254 type="int",
255 name="long_double_bit",
256 predefault="8*TARGET_CHAR_BIT",
257 invalid=False,
258)
259
260Value(
261 type="const struct floatformat **",
262 name="long_double_format",
263 predefault="floatformats_ieee_double",
264 printer="pformat (gdbarch, gdbarch->long_double_format)",
265 invalid=False,
266)
267
268Value(
269 comment="""
270The ABI default bit-size for "wchar_t". wchar_t is a built-in type
271starting with C++11.
272""",
273 type="int",
274 name="wchar_bit",
275 predefault="4*TARGET_CHAR_BIT",
276 invalid=False,
277)
278
279Value(
280 comment="""
281One if `wchar_t' is signed, zero if unsigned.
282""",
283 type="int",
284 name="wchar_signed",
285 predefault="-1",
286 postdefault="1",
287 invalid=False,
288)
289
290Method(
291 comment="""
292Returns the floating-point format to be used for values of length LENGTH.
293NAME, if non-NULL, is the type name, which may be used to distinguish
294different target formats of the same length.
295""",
296 type="const struct floatformat **",
297 name="floatformat_for_type",
298 params=[("const char *", "name"), ("int", "length")],
299 predefault="default_floatformat_for_type",
300 invalid=False,
301)
302
303Value(
304 comment="""
305For most targets, a pointer on the target and its representation as an
306address in GDB have the same size and "look the same". For such a
307target, you need only set gdbarch_ptr_bit and gdbarch_addr_bit
308/ addr_bit will be set from it.
309
310If gdbarch_ptr_bit and gdbarch_addr_bit are different, you'll probably
311also need to set gdbarch_dwarf2_addr_size, gdbarch_pointer_to_address and
312gdbarch_address_to_pointer as well.
313
314ptr_bit is the size of a pointer on the target
315""",
316 type="int",
317 name="ptr_bit",
318 predefault=int_bit.predefault,
319 invalid=False,
320)
321
322Value(
323 comment="""
324addr_bit is the size of a target address as represented in gdb
325""",
326 type="int",
327 name="addr_bit",
328 predefault="0",
329 postdefault="gdbarch_ptr_bit (gdbarch)",
330 invalid=False,
331)
332
333Value(
334 comment="""
335dwarf2_addr_size is the target address size as used in the Dwarf debug
336info. For .debug_frame FDEs, this is supposed to be the target address
337size from the associated CU header, and which is equivalent to the
338DWARF2_ADDR_SIZE as defined by the target specific GCC back-end.
339Unfortunately there is no good way to determine this value. Therefore
340dwarf2_addr_size simply defaults to the target pointer size.
341
342dwarf2_addr_size is not used for .eh_frame FDEs, which are generally
343defined using the target's pointer size so far.
344
345Note that dwarf2_addr_size only needs to be redefined by a target if the
346GCC back-end defines a DWARF2_ADDR_SIZE other than the target pointer size,
347and if Dwarf versions < 4 need to be supported.
348""",
349 type="int",
350 name="dwarf2_addr_size",
351 postdefault="gdbarch_ptr_bit (gdbarch) / TARGET_CHAR_BIT",
352 invalid=False,
353)
354
355Value(
356 comment="""
357One if `char' acts like `signed char', zero if `unsigned char'.
358""",
359 type="int",
360 name="char_signed",
361 predefault="-1",
362 postdefault="1",
363 invalid=False,
364)
365
367 type="CORE_ADDR",
368 name="read_pc",
369 params=[("readable_regcache *", "regcache")],
370 predicate=True,
371)
372
374 type="void",
375 name="write_pc",
376 params=[("struct regcache *", "regcache"), ("CORE_ADDR", "val")],
377 predicate=True,
378)
379
380Method(
381 comment="""
382Function for getting target's idea of a frame pointer. FIXME: GDB's
383whole scheme for dealing with "frames" and "frame pointers" needs a
384serious shakedown.
385""",
386 type="void",
387 name="virtual_frame_pointer",
388 params=[
389 ("CORE_ADDR", "pc"),
390 ("int *", "frame_regnum"),
391 ("LONGEST *", "frame_offset"),
392 ],
393 predefault="legacy_virtual_frame_pointer",
394 invalid=False,
395)
396
397Method(
398 type="enum register_status",
399 name="pseudo_register_read",
400 params=[
401 ("readable_regcache *", "regcache"),
402 ("int", "cookednum"),
403 ("gdb_byte *", "buf"),
404 ],
405 predicate=True,
406)
407
408Method(
409 comment="""
410Read a register into a new struct value. If the register is wholly
411or partly unavailable, this should call mark_value_bytes_unavailable
412as appropriate. If this is defined, then pseudo_register_read will
413never be called.
414""",
415 type="struct value *",
416 name="pseudo_register_read_value",
417 params=[("readable_regcache *", "regcache"), ("int", "cookednum")],
418 predicate=True,
419)
420
421Method(
422 type="void",
423 name="pseudo_register_write",
424 params=[
425 ("struct regcache *", "regcache"),
426 ("int", "cookednum"),
427 ("const gdb_byte *", "buf"),
428 ],
429 predicate=True,
430)
431
432Value(
433 type="int",
434 name="num_regs",
435 predefault="-1",
436)
437
438Value(
439 comment="""
440This macro gives the number of pseudo-registers that live in the
441register namespace but do not get fetched or stored on the target.
442These pseudo-registers may be aliases for other registers,
443combinations of other registers, or they may be computed by GDB.
444""",
445 type="int",
446 name="num_pseudo_regs",
447 predefault="0",
448 invalid=False,
449)
450
451Method(
452 comment="""
453Assemble agent expression bytecode to collect pseudo-register REG.
454Return -1 if something goes wrong, 0 otherwise.
455""",
456 type="int",
457 name="ax_pseudo_register_collect",
458 params=[("struct agent_expr *", "ax"), ("int", "reg")],
459 predicate=True,
460)
461
462Method(
463 comment="""
464Assemble agent expression bytecode to push the value of pseudo-register
465REG on the interpreter stack.
466Return -1 if something goes wrong, 0 otherwise.
467""",
468 type="int",
469 name="ax_pseudo_register_push_stack",
470 params=[("struct agent_expr *", "ax"), ("int", "reg")],
471 predicate=True,
472)
473
474Method(
475 comment="""
476Some architectures can display additional information for specific
477signals.
478UIOUT is the output stream where the handler will place information.
479""",
480 type="void",
481 name="report_signal_info",
482 params=[("struct ui_out *", "uiout"), ("enum gdb_signal", "siggnal")],
483 predicate=True,
484)
485
486Value(
487 comment="""
488GDB's standard (or well known) register numbers. These can map onto
489a real register or a pseudo (computed) register or not be defined at
490all (-1).
491gdbarch_sp_regnum will hopefully be replaced by UNWIND_SP.
492""",
493 type="int",
494 name="sp_regnum",
495 predefault="-1",
496 invalid=False,
497)
498
499Value(
500 type="int",
501 name="pc_regnum",
502 predefault="-1",
503 invalid=False,
504)
505
506Value(
507 type="int",
508 name="ps_regnum",
509 predefault="-1",
510 invalid=False,
511)
512
513Value(
514 type="int",
515 name="fp0_regnum",
516 predefault="-1",
517 invalid=False,
518)
519
520Method(
521 comment="""
522Convert stab register number (from `r' declaration) to a gdb REGNUM.
523""",
524 type="int",
525 name="stab_reg_to_regnum",
526 params=[("int", "stab_regnr")],
527 predefault="no_op_reg_to_regnum",
528 invalid=False,
529)
530
531Method(
532 comment="""
533Provide a default mapping from a ecoff register number to a gdb REGNUM.
534""",
535 type="int",
536 name="ecoff_reg_to_regnum",
537 params=[("int", "ecoff_regnr")],
538 predefault="no_op_reg_to_regnum",
539 invalid=False,
540)
541
542Method(
543 comment="""
544Convert from an sdb register number to an internal gdb register number.
545""",
546 type="int",
547 name="sdb_reg_to_regnum",
548 params=[("int", "sdb_regnr")],
549 predefault="no_op_reg_to_regnum",
550 invalid=False,
551)
552
553Method(
554 comment="""
555Provide a default mapping from a DWARF2 register number to a gdb REGNUM.
556Return -1 for bad REGNUM. Note: Several targets get this wrong.
557""",
558 type="int",
559 name="dwarf2_reg_to_regnum",
560 params=[("int", "dwarf2_regnr")],
561 predefault="no_op_reg_to_regnum",
562 invalid=False,
563)
564
565Method(
566 comment="""
567Return the name of register REGNR for the specified architecture.
568REGNR can be any value greater than, or equal to zero, and less than
569'gdbarch_num_cooked_regs (GDBARCH)'. If REGNR is not supported for
570GDBARCH, then this function will return an empty string, this function
571should never return nullptr.
572""",
573 type="const char *",
574 name="register_name",
575 params=[("int", "regnr")],
576 param_checks=["regnr >= 0", "regnr < gdbarch_num_cooked_regs (gdbarch)"],
577 result_checks=["result != nullptr"],
578)
579
580Method(
581 comment="""
582Return the type of a register specified by the architecture. Only
583the register cache should call this function directly; others should
584use "register_type".
585""",
586 type="struct type *",
587 name="register_type",
588 params=[("int", "reg_nr")],
589)
590
591Method(
592 comment="""
593Generate a dummy frame_id for THIS_FRAME assuming that the frame is
594a dummy frame. A dummy frame is created before an inferior call,
595the frame_id returned here must match the frame_id that was built
596for the inferior call. Usually this means the returned frame_id's
597stack address should match the address returned by
598gdbarch_push_dummy_call, and the returned frame_id's code address
599should match the address at which the breakpoint was set in the dummy
600frame.
601""",
602 type="struct frame_id",
603 name="dummy_id",
604 params=[("frame_info_ptr", "this_frame")],
605 predefault="default_dummy_id",
606 invalid=False,
607)
608
609Value(
610 comment="""
611Implement DUMMY_ID and PUSH_DUMMY_CALL, then delete
612deprecated_fp_regnum.
613""",
614 type="int",
615 name="deprecated_fp_regnum",
616 predefault="-1",
617 invalid=False,
618)
619
620Method(
621 type="CORE_ADDR",
622 name="push_dummy_call",
623 params=[
624 ("struct value *", "function"),
625 ("struct regcache *", "regcache"),
626 ("CORE_ADDR", "bp_addr"),
627 ("int", "nargs"),
628 ("struct value **", "args"),
629 ("CORE_ADDR", "sp"),
630 ("function_call_return_method", "return_method"),
631 ("CORE_ADDR", "struct_addr"),
632 ],
633 predicate=True,
634)
635
636Value(
637 type="enum call_dummy_location_type",
638 name="call_dummy_location",
639 predefault="AT_ENTRY_POINT",
640 invalid=False,
641)
642
643Method(
644 type="CORE_ADDR",
645 name="push_dummy_code",
646 params=[
647 ("CORE_ADDR", "sp"),
648 ("CORE_ADDR", "funaddr"),
649 ("struct value **", "args"),
650 ("int", "nargs"),
651 ("struct type *", "value_type"),
652 ("CORE_ADDR *", "real_pc"),
653 ("CORE_ADDR *", "bp_addr"),
654 ("struct regcache *", "regcache"),
655 ],
656 predicate=True,
657)
658
659Method(
660 comment="""
661Return true if the code of FRAME is writable.
662""",
663 type="int",
664 name="code_of_frame_writable",
665 params=[("frame_info_ptr", "frame")],
666 predefault="default_code_of_frame_writable",
667 invalid=False,
668)
669
670Method(
671 type="void",
672 name="print_registers_info",
673 params=[
674 ("struct ui_file *", "file"),
675 ("frame_info_ptr", "frame"),
676 ("int", "regnum"),
677 ("int", "all"),
678 ],
679 predefault="default_print_registers_info",
680 invalid=False,
681)
682
683Method(
684 type="void",
685 name="print_float_info",
686 params=[
687 ("struct ui_file *", "file"),
688 ("frame_info_ptr", "frame"),
689 ("const char *", "args"),
690 ],
691 predefault="default_print_float_info",
692 invalid=False,
693)
694
695Method(
696 type="void",
697 name="print_vector_info",
698 params=[
699 ("struct ui_file *", "file"),
700 ("frame_info_ptr", "frame"),
701 ("const char *", "args"),
702 ],
703 predicate=True,
704)
705
706Method(
707 comment="""
708MAP a GDB RAW register number onto a simulator register number. See
709also include/...-sim.h.
710""",
711 type="int",
712 name="register_sim_regno",
713 params=[("int", "reg_nr")],
714 predefault="legacy_register_sim_regno",
715 invalid=False,
716)
717
718Method(
719 type="int",
720 name="cannot_fetch_register",
721 params=[("int", "regnum")],
722 predefault="cannot_register_not",
723 invalid=False,
724)
725
726Method(
727 type="int",
728 name="cannot_store_register",
729 params=[("int", "regnum")],
730 predefault="cannot_register_not",
731 invalid=False,
732)
733
735 comment="""
736Determine the address where a longjmp will land and save this address
737in PC. Return nonzero on success.
738
739FRAME corresponds to the longjmp frame.
740""",
741 type="int",
742 name="get_longjmp_target",
743 params=[("frame_info_ptr", "frame"), ("CORE_ADDR *", "pc")],
744 predicate=True,
745)
746
747Value(
748 type="int",
749 name="believe_pcc_promotion",
750 invalid=False,
751)
752
753Method(
754 type="int",
755 name="convert_register_p",
756 params=[("int", "regnum"), ("struct type *", "type")],
757 predefault="generic_convert_register_p",
758 invalid=False,
759)
760
762 type="int",
763 name="register_to_value",
764 params=[
765 ("frame_info_ptr", "frame"),
766 ("int", "regnum"),
767 ("struct type *", "type"),
768 ("gdb_byte *", "buf"),
769 ("int *", "optimizedp"),
770 ("int *", "unavailablep"),
771 ],
772 invalid=False,
773)
774
776 type="void",
777 name="value_to_register",
778 params=[
779 ("frame_info_ptr", "frame"),
780 ("int", "regnum"),
781 ("struct type *", "type"),
782 ("const gdb_byte *", "buf"),
783 ],
784 invalid=False,
785)
786
787Method(
788 comment="""
789Construct a value representing the contents of register REGNUM in
790frame FRAME_ID, interpreted as type TYPE. The routine needs to
791allocate and return a struct value with all value attributes
792(but not the value contents) filled in.
793""",
794 type="struct value *",
795 name="value_from_register",
796 params=[
797 ("struct type *", "type"),
798 ("int", "regnum"),
799 ("struct frame_id", "frame_id"),
800 ],
801 predefault="default_value_from_register",
802 invalid=False,
803)
804
805Method(
806 type="CORE_ADDR",
807 name="pointer_to_address",
808 params=[("struct type *", "type"), ("const gdb_byte *", "buf")],
809 predefault="unsigned_pointer_to_address",
810 invalid=False,
811)
812
813Method(
814 type="void",
815 name="address_to_pointer",
816 params=[("struct type *", "type"), ("gdb_byte *", "buf"), ("CORE_ADDR", "addr")],
817 predefault="unsigned_address_to_pointer",
818 invalid=False,
819)
820
821Method(
822 type="CORE_ADDR",
823 name="integer_to_address",
824 params=[("struct type *", "type"), ("const gdb_byte *", "buf")],
825 predicate=True,
826)
827
828Method(
829 comment="""
830Return the return-value convention that will be used by FUNCTION
831to return a value of type VALTYPE. FUNCTION may be NULL in which
832case the return convention is computed based only on VALTYPE.
833
834If READBUF is not NULL, extract the return value and save it in this buffer.
835
836If WRITEBUF is not NULL, it contains a return value which will be
837stored into the appropriate register. This can be used when we want
838to force the value returned by a function (see the "return" command
839for instance).
840
841NOTE: it is better to implement return_value_as_value instead, as that
842method can properly handle variably-sized types.
843""",
844 type="enum return_value_convention",
845 name="return_value",
846 params=[
847 ("struct value *", "function"),
848 ("struct type *", "valtype"),
849 ("struct regcache *", "regcache"),
850 ("gdb_byte *", "readbuf"),
851 ("const gdb_byte *", "writebuf"),
852 ],
853 invalid=False,
854 # We don't want to accidentally introduce calls to this, as gdb
855 # should only ever call return_value_new (see below).
856 implement=False,
857)
858
859Method(
860 comment="""
861Return the return-value convention that will be used by FUNCTION
862to return a value of type VALTYPE. FUNCTION may be NULL in which
863case the return convention is computed based only on VALTYPE.
864
865If READ_VALUE is not NULL, extract the return value and save it in
866this pointer.
867
868If WRITEBUF is not NULL, it contains a return value which will be
869stored into the appropriate register. This can be used when we want
870to force the value returned by a function (see the "return" command
871for instance).
872""",
873 type="enum return_value_convention",
874 name="return_value_as_value",
875 params=[
876 ("struct value *", "function"),
877 ("struct type *", "valtype"),
878 ("struct regcache *", "regcache"),
879 ("struct value **", "read_value"),
880 ("const gdb_byte *", "writebuf"),
881 ],
882 predefault="default_gdbarch_return_value",
883 # If we're using the default, then the other method must be set;
884 # but if we aren't using the default here then the other method
885 # must not be set.
886 invalid="(gdbarch->return_value_as_value == default_gdbarch_return_value) == (gdbarch->return_value == nullptr)",
887)
888
890 comment="""
891Return the address at which the value being returned from
892the current function will be stored. This routine is only
893called if the current function uses the the "struct return
894convention".
895
896May return 0 when unable to determine that address.""",
897 type="CORE_ADDR",
898 name="get_return_buf_addr",
899 params=[("struct type *", "val_type"), ("frame_info_ptr", "cur_frame")],
900 predefault="default_get_return_buf_addr",
901 invalid=False,
902)
903
904
905# The DWARF info currently does not distinguish between IEEE 128-bit floating
906# point values and the IBM 128-bit floating point format. GCC has an internal
907# hack to identify the IEEE 128-bit floating point value. The long double is a
908# defined base type in C. The GCC hack uses a typedef for long double to
909# reference_Float128 base to identify the long double as and IEEE 128-bit
910# value. The following method is used to "fix" the long double type to be a
911# base type with the IEEE float format info from the _Float128 basetype and
912# the long double name. With the fix, the proper name is printed for the
913# GDB typedef command.
915 comment="""
916Return true if the typedef record needs to be replaced.".
917
918Return 0 by default""",
919 type="bool",
920 name="dwarf2_omit_typedef_p",
921 params=[
922 ("struct type *", "target_type"),
923 ("const char *", "producer"),
924 ("const char *", "name"),
925 ],
926 predefault="default_dwarf2_omit_typedef_p",
927 invalid=False,
928)
929
930Method(
931 comment="""
932Update PC when trying to find a call site. This is useful on
933architectures where the call site PC, as reported in the DWARF, can be
934incorrect for some reason.
935
936The passed-in PC will be an address in the inferior. GDB will have
937already failed to find a call site at this PC. This function may
938simply return its parameter if it thinks that should be the correct
939address.""",
940 type="CORE_ADDR",
941 name="update_call_site_pc",
942 params=[("CORE_ADDR", "pc")],
943 predefault="default_update_call_site_pc",
944 invalid=False,
945)
946
947Method(
948 comment="""
949Return true if the return value of function is stored in the first hidden
950parameter. In theory, this feature should be language-dependent, specified
951by language and its ABI, such as C++. Unfortunately, compiler may
952implement it to a target-dependent feature. So that we need such hook here
953to be aware of this in GDB.
954""",
955 type="int",
956 name="return_in_first_hidden_param_p",
957 params=[("struct type *", "type")],
958 predefault="default_return_in_first_hidden_param_p",
959 invalid=False,
960)
961
962Method(
963 type="CORE_ADDR",
964 name="skip_prologue",
965 params=[("CORE_ADDR", "ip")],
966)
967
968Method(
969 type="CORE_ADDR",
970 name="skip_main_prologue",
971 params=[("CORE_ADDR", "ip")],
972 predicate=True,
973)
974
975Method(
976 comment="""
977On some platforms, a single function may provide multiple entry points,
978e.g. one that is used for function-pointer calls and a different one
979that is used for direct function calls.
980In order to ensure that breakpoints set on the function will trigger
981no matter via which entry point the function is entered, a platform
982may provide the skip_entrypoint callback. It is called with IP set
983to the main entry point of a function (as determined by the symbol table),
984and should return the address of the innermost entry point, where the
985actual breakpoint needs to be set. Note that skip_entrypoint is used
986by GDB common code even when debugging optimized code, where skip_prologue
987is not used.
988""",
989 type="CORE_ADDR",
990 name="skip_entrypoint",
991 params=[("CORE_ADDR", "ip")],
992 predicate=True,
993)
994
996 type="int",
997 name="inner_than",
998 params=[("CORE_ADDR", "lhs"), ("CORE_ADDR", "rhs")],
999)
1000
1001Method(
1002 type="const gdb_byte *",
1003 name="breakpoint_from_pc",
1004 params=[("CORE_ADDR *", "pcptr"), ("int *", "lenptr")],
1005 predefault="default_breakpoint_from_pc",
1006 invalid=False,
1007)
1008
1009Method(
1010 comment="""
1011Return the breakpoint kind for this target based on *PCPTR.
1012""",
1013 type="int",
1014 name="breakpoint_kind_from_pc",
1015 params=[("CORE_ADDR *", "pcptr")],
1016)
1017
1018Method(
1019 comment="""
1020Return the software breakpoint from KIND. KIND can have target
1021specific meaning like the Z0 kind parameter.
1022SIZE is set to the software breakpoint's length in memory.
1023""",
1024 type="const gdb_byte *",
1025 name="sw_breakpoint_from_kind",
1026 params=[("int", "kind"), ("int *", "size")],
1027 predefault="NULL",
1028 invalid=False,
1029)
1030
1031Method(
1032 comment="""
1033Return the breakpoint kind for this target based on the current
1034processor state (e.g. the current instruction mode on ARM) and the
1035*PCPTR. In default, it is gdbarch->breakpoint_kind_from_pc.
1036""",
1037 type="int",
1038 name="breakpoint_kind_from_current_state",
1039 params=[("struct regcache *", "regcache"), ("CORE_ADDR *", "pcptr")],
1040 predefault="default_breakpoint_kind_from_current_state",
1041 invalid=False,
1042)
1043
1044Method(
1045 type="CORE_ADDR",
1046 name="adjust_breakpoint_address",
1047 params=[("CORE_ADDR", "bpaddr")],
1048 predicate=True,
1049)
1050
1051Method(
1052 type="int",
1053 name="memory_insert_breakpoint",
1054 params=[("struct bp_target_info *", "bp_tgt")],
1055 predefault="default_memory_insert_breakpoint",
1056 invalid=False,
1057)
1058
1059Method(
1060 type="int",
1061 name="memory_remove_breakpoint",
1062 params=[("struct bp_target_info *", "bp_tgt")],
1063 predefault="default_memory_remove_breakpoint",
1064 invalid=False,
1065)
1066
1067Value(
1068 type="CORE_ADDR",
1069 name="decr_pc_after_break",
1070 invalid=False,
1071)
1072
1073Value(
1074 comment="""
1075A function can be addressed by either its "pointer" (possibly a
1076descriptor address) or "entry point" (first executable instruction).
1077The method "convert_from_func_ptr_addr" converting the former to the
1078latter. gdbarch_deprecated_function_start_offset is being used to implement
1079a simplified subset of that functionality - the function's address
1080corresponds to the "function pointer" and the function's start
1081corresponds to the "function entry point" - and hence is redundant.
1082""",
1083 type="CORE_ADDR",
1084 name="deprecated_function_start_offset",
1085 invalid=False,
1086)
1087
1088Method(
1089 comment="""
1090Return the remote protocol register number associated with this
1091register. Normally the identity mapping.
1092""",
1093 type="int",
1094 name="remote_register_number",
1095 params=[("int", "regno")],
1096 predefault="default_remote_register_number",
1097 invalid=False,
1098)
1099
1100Function(
1101 comment="""
1102Fetch the target specific address used to represent a load module.
1103""",
1104 type="CORE_ADDR",
1105 name="fetch_tls_load_module_address",
1106 params=[("struct objfile *", "objfile")],
1107 predicate=True,
1108)
1109
1110Method(
1111 comment="""
1112Return the thread-local address at OFFSET in the thread-local
1113storage for the thread PTID and the shared library or executable
1114file given by LM_ADDR. If that block of thread-local storage hasn't
1115been allocated yet, this function may throw an error. LM_ADDR may
1116be zero for statically linked multithreaded inferiors.
1117""",
1118 type="CORE_ADDR",
1119 name="get_thread_local_address",
1120 params=[("ptid_t", "ptid"), ("CORE_ADDR", "lm_addr"), ("CORE_ADDR", "offset")],
1121 predicate=True,
1122)
1123
1124Value(
1125 type="CORE_ADDR",
1126 name="frame_args_skip",
1127 invalid=False,
1128)
1129
1130Method(
1131 type="CORE_ADDR",
1132 name="unwind_pc",
1133 params=[("frame_info_ptr", "next_frame")],
1134 predefault="default_unwind_pc",
1135 invalid=False,
1136)
1137
1138Method(
1139 type="CORE_ADDR",
1140 name="unwind_sp",
1141 params=[("frame_info_ptr", "next_frame")],
1142 predefault="default_unwind_sp",
1143 invalid=False,
1144)
1145
1146Function(
1147 comment="""
1148DEPRECATED_FRAME_LOCALS_ADDRESS as been replaced by the per-frame
1149frame-base. Enable frame-base before frame-unwind.
1150""",
1151 type="int",
1152 name="frame_num_args",
1153 params=[("frame_info_ptr", "frame")],
1154 predicate=True,
1155)
1156
1157Method(
1158 type="CORE_ADDR",
1159 name="frame_align",
1160 params=[("CORE_ADDR", "address")],
1161 predicate=True,
1162)
1163
1164Method(
1165 type="int",
1166 name="stabs_argument_has_addr",
1167 params=[("struct type *", "type")],
1168 predefault="default_stabs_argument_has_addr",
1169 invalid=False,
1170)
1171
1172Value(
1173 type="int",
1174 name="frame_red_zone_size",
1175 invalid=False,
1176)
1177
1178Method(
1179 type="CORE_ADDR",
1180 name="convert_from_func_ptr_addr",
1181 params=[("CORE_ADDR", "addr"), ("struct target_ops *", "targ")],
1182 predefault="convert_from_func_ptr_addr_identity",
1183 invalid=False,
1184)
1185
1186Method(
1187 comment="""
1188On some machines there are bits in addresses which are not really
1189part of the address, but are used by the kernel, the hardware, etc.
1190for special purposes. gdbarch_addr_bits_remove takes out any such bits so
1191we get a "real" address such as one would find in a symbol table.
1192This is used only for addresses of instructions, and even then I'm
1193not sure it's used in all contexts. It exists to deal with there
1194being a few stray bits in the PC which would mislead us, not as some
1195sort of generic thing to handle alignment or segmentation (it's
1196possible it should be in TARGET_READ_PC instead).
1197""",
1198 type="CORE_ADDR",
1199 name="addr_bits_remove",
1200 params=[("CORE_ADDR", "addr")],
1201 predefault="core_addr_identity",
1202 invalid=False,
1203)
1204
1205Method(
1206 comment="""
1207On some architectures, not all bits of a pointer are significant.
1208On AArch64, for example, the top bits of a pointer may carry a "tag", which
1209can be ignored by the kernel and the hardware. The "tag" can be regarded as
1210additional data associated with the pointer, but it is not part of the address.
1211
1212Given a pointer for the architecture, this hook removes all the
1213non-significant bits and sign-extends things as needed. It gets used to remove
1214non-address bits from data pointers (for example, removing the AArch64 MTE tag
1215bits from a pointer) and from code pointers (removing the AArch64 PAC signature
1216from a pointer containing the return address).
1217""",
1218 type="CORE_ADDR",
1219 name="remove_non_address_bits",
1220 params=[("CORE_ADDR", "pointer")],
1221 predefault="default_remove_non_address_bits",
1222 invalid=False,
1223)
1224
1225Method(
1226 comment="""
1227Return a string representation of the memory tag TAG.
1228""",
1229 type="std::string",
1230 name="memtag_to_string",
1231 params=[("struct value *", "tag")],
1232 predefault="default_memtag_to_string",
1233 invalid=False,
1234)
1235
1236Method(
1237 comment="""
1238Return true if ADDRESS contains a tag and false otherwise. ADDRESS
1239must be either a pointer or a reference type.
1240""",
1241 type="bool",
1242 name="tagged_address_p",
1243 params=[("struct value *", "address")],
1244 predefault="default_tagged_address_p",
1245 invalid=False,
1246)
1247
1248Method(
1249 comment="""
1250Return true if the tag from ADDRESS matches the memory tag for that
1251particular address. Return false otherwise.
1252""",
1253 type="bool",
1254 name="memtag_matches_p",
1255 params=[("struct value *", "address")],
1256 predefault="default_memtag_matches_p",
1257 invalid=False,
1258)
1259
1260Method(
1261 comment="""
1262Set the tags of type TAG_TYPE, for the memory address range
1263[ADDRESS, ADDRESS + LENGTH) to TAGS.
1264Return true if successful and false otherwise.
1265""",
1266 type="bool",
1267 name="set_memtags",
1268 params=[
1269 ("struct value *", "address"),
1270 ("size_t", "length"),
1271 ("const gdb::byte_vector &", "tags"),
1272 ("memtag_type", "tag_type"),
1273 ],
1274 predefault="default_set_memtags",
1275 invalid=False,
1276)
1277
1278Method(
1279 comment="""
1280Return the tag of type TAG_TYPE associated with the memory address ADDRESS,
1281assuming ADDRESS is tagged.
1282""",
1283 type="struct value *",
1284 name="get_memtag",
1285 params=[("struct value *", "address"), ("memtag_type", "tag_type")],
1286 predefault="default_get_memtag",
1287 invalid=False,
1288)
1289
1290Value(
1291 comment="""
1292memtag_granule_size is the size of the allocation tag granule, for
1293architectures that support memory tagging.
1294This is 0 for architectures that do not support memory tagging.
1295For a non-zero value, this represents the number of bytes of memory per tag.
1296""",
1297 type="CORE_ADDR",
1298 name="memtag_granule_size",
1299 invalid=False,
1300)
1301
1302Function(
1303 comment="""
1304FIXME/cagney/2001-01-18: This should be split in two. A target method that
1305indicates if the target needs software single step. An ISA method to
1306implement it.
1307
1308FIXME/cagney/2001-01-18: The logic is backwards. It should be asking if the
1309target can single step. If not, then implement single step using breakpoints.
1310
1311Return a vector of addresses on which the software single step
1312breakpoints should be inserted. NULL means software single step is
1313not used.
1314Multiple breakpoints may be inserted for some instructions such as
1315conditional branch. However, each implementation must always evaluate
1316the condition and only put the breakpoint at the branch destination if
1317the condition is true, so that we ensure forward progress when stepping
1318past a conditional branch to self.
1319""",
1320 type="std::vector<CORE_ADDR>",
1321 name="software_single_step",
1322 params=[("struct regcache *", "regcache")],
1323 predicate=True,
1324)
1325
1326Method(
1327 comment="""
1328Return non-zero if the processor is executing a delay slot and a
1329further single-step is needed before the instruction finishes.
1330""",
1331 type="int",
1332 name="single_step_through_delay",
1333 params=[("frame_info_ptr", "frame")],
1334 predicate=True,
1335)
1336
1337Function(
1338 comment="""
1339FIXME: cagney/2003-08-28: Need to find a better way of selecting the
1340disassembler. Perhaps objdump can handle it?
1341""",
1342 type="int",
1343 name="print_insn",
1344 params=[("bfd_vma", "vma"), ("struct disassemble_info *", "info")],
1345 predefault="default_print_insn",
1346 invalid=False,
1347)
1348
1349Function(
1350 type="CORE_ADDR",
1351 name="skip_trampoline_code",
1352 params=[("frame_info_ptr", "frame"), ("CORE_ADDR", "pc")],
1353 predefault="generic_skip_trampoline_code",
1354 invalid=False,
1355)
1356
1357Value(
1358 comment="Vtable of solib operations functions.",
1359 type="const struct target_so_ops *",
1360 name="so_ops",
1361 predefault="&solib_target_so_ops",
1362 printer="host_address_to_string (gdbarch->so_ops)",
1363 invalid=False,
1364)
1365
1366Method(
1367 comment="""
1368If in_solib_dynsym_resolve_code() returns true, and SKIP_SOLIB_RESOLVER
1369evaluates non-zero, this is the address where the debugger will place
1370a step-resume breakpoint to get us past the dynamic linker.
1371""",
1372 type="CORE_ADDR",
1373 name="skip_solib_resolver",
1374 params=[("CORE_ADDR", "pc")],
1375 predefault="generic_skip_solib_resolver",
1376 invalid=False,
1377)
1378
1379Method(
1380 comment="""
1381Some systems also have trampoline code for returning from shared libs.
1382""",
1383 type="int",
1384 name="in_solib_return_trampoline",
1385 params=[("CORE_ADDR", "pc"), ("const char *", "name")],
1386 predefault="generic_in_solib_return_trampoline",
1387 invalid=False,
1388)
1389
1390Method(
1391 comment="""
1392Return true if PC lies inside an indirect branch thunk.
1393""",
1394 type="bool",
1395 name="in_indirect_branch_thunk",
1396 params=[("CORE_ADDR", "pc")],
1397 predefault="default_in_indirect_branch_thunk",
1398 invalid=False,
1399)
1400
1401Method(
1402 comment="""
1403A target might have problems with watchpoints as soon as the stack
1404frame of the current function has been destroyed. This mostly happens
1405as the first action in a function's epilogue. stack_frame_destroyed_p()
1406is defined to return a non-zero value if either the given addr is one
1407instruction after the stack destroying instruction up to the trailing
1408return instruction or if we can figure out that the stack frame has
1409already been invalidated regardless of the value of addr. Targets
1410which don't suffer from that problem could just let this functionality
1411untouched.
1412""",
1413 type="int",
1414 name="stack_frame_destroyed_p",
1415 params=[("CORE_ADDR", "addr")],
1416 predefault="generic_stack_frame_destroyed_p",
1417 invalid=False,
1418)
1419
1420Function(
1421 comment="""
1422Process an ELF symbol in the minimal symbol table in a backend-specific
1423way. Normally this hook is supposed to do nothing, however if required,
1424then this hook can be used to apply tranformations to symbols that are
1425considered special in some way. For example the MIPS backend uses it
1426to interpret `st_other' information to mark compressed code symbols so
1427that they can be treated in the appropriate manner in the processing of
1428the main symbol table and DWARF-2 records.
1429""",
1430 type="void",
1431 name="elf_make_msymbol_special",
1432 params=[("asymbol *", "sym"), ("struct minimal_symbol *", "msym")],
1433 predicate=True,
1434)
1435
1436Function(
1437 type="void",
1438 name="coff_make_msymbol_special",
1439 params=[("int", "val"), ("struct minimal_symbol *", "msym")],
1440 predefault="default_coff_make_msymbol_special",
1441 invalid=False,
1442)
1443
1444Function(
1445 comment="""
1446Process a symbol in the main symbol table in a backend-specific way.
1447Normally this hook is supposed to do nothing, however if required,
1448then this hook can be used to apply tranformations to symbols that
1449are considered special in some way. This is currently used by the
1450MIPS backend to make sure compressed code symbols have the ISA bit
1451set. This in turn is needed for symbol values seen in GDB to match
1452the values used at the runtime by the program itself, for function
1453and label references.
1454""",
1455 type="void",
1456 name="make_symbol_special",
1457 params=[("struct symbol *", "sym"), ("struct objfile *", "objfile")],
1458 predefault="default_make_symbol_special",
1459 invalid=False,
1460)
1461
1462Function(
1463 comment="""
1464Adjust the address retrieved from a DWARF-2 record other than a line
1465entry in a backend-specific way. Normally this hook is supposed to
1466return the address passed unchanged, however if that is incorrect for
1467any reason, then this hook can be used to fix the address up in the
1468required manner. This is currently used by the MIPS backend to make
1469sure addresses in FDE, range records, etc. referring to compressed
1470code have the ISA bit set, matching line information and the symbol
1471table.
1472""",
1473 type="CORE_ADDR",
1474 name="adjust_dwarf2_addr",
1475 params=[("CORE_ADDR", "pc")],
1476 predefault="default_adjust_dwarf2_addr",
1477 invalid=False,
1478)
1479
1480Function(
1481 comment="""
1482Adjust the address updated by a line entry in a backend-specific way.
1483Normally this hook is supposed to return the address passed unchanged,
1484however in the case of inconsistencies in these records, this hook can
1485be used to fix them up in the required manner. This is currently used
1486by the MIPS backend to make sure all line addresses in compressed code
1487are presented with the ISA bit set, which is not always the case. This
1488in turn ensures breakpoint addresses are correctly matched against the
1489stop PC.
1490""",
1491 type="CORE_ADDR",
1492 name="adjust_dwarf2_line",
1493 params=[("CORE_ADDR", "addr"), ("int", "rel")],
1494 predefault="default_adjust_dwarf2_line",
1495 invalid=False,
1496)
1497
1498Value(
1499 type="int",
1500 name="cannot_step_breakpoint",
1501 predefault="0",
1502 invalid=False,
1503)
1504
1505Value(
1506 comment="""
1507See comment in target.h about continuable, steppable and
1508non-steppable watchpoints.
1509""",
1510 type="int",
1511 name="have_nonsteppable_watchpoint",
1512 predefault="0",
1513 invalid=False,
1514)
1515
1516Function(
1517 type="type_instance_flags",
1518 name="address_class_type_flags",
1519 params=[("int", "byte_size"), ("int", "dwarf2_addr_class")],
1520 predicate=True,
1521)
1522
1523Method(
1524 type="const char *",
1525 name="address_class_type_flags_to_name",
1526 params=[("type_instance_flags", "type_flags")],
1527 predicate=True,
1528)
1529
1530Method(
1531 comment="""
1532Execute vendor-specific DWARF Call Frame Instruction. OP is the instruction.
1533FS are passed from the generic execute_cfa_program function.
1534""",
1535 type="bool",
1536 name="execute_dwarf_cfa_vendor_op",
1537 params=[("gdb_byte", "op"), ("struct dwarf2_frame_state *", "fs")],
1538 predefault="default_execute_dwarf_cfa_vendor_op",
1539 invalid=False,
1540)
1541
1542Method(
1543 comment="""
1544Return the appropriate type_flags for the supplied address class.
1545This function should return true if the address class was recognized and
1546type_flags was set, false otherwise.
1547""",
1548 type="bool",
1549 name="address_class_name_to_type_flags",
1550 params=[("const char *", "name"), ("type_instance_flags *", "type_flags_ptr")],
1551 predicate=True,
1552)
1553
1554Method(
1555 comment="""
1556Is a register in a group
1557""",
1558 type="int",
1559 name="register_reggroup_p",
1560 params=[("int", "regnum"), ("const struct reggroup *", "reggroup")],
1561 predefault="default_register_reggroup_p",
1562 invalid=False,
1563)
1564
1565Function(
1566 comment="""
1567Fetch the pointer to the ith function argument.
1568""",
1569 type="CORE_ADDR",
1570 name="fetch_pointer_argument",
1571 params=[
1572 ("frame_info_ptr", "frame"),
1573 ("int", "argi"),
1574 ("struct type *", "type"),
1575 ],
1576 predicate=True,
1577)
1578
1579Method(
1580 comment="""
1581Iterate over all supported register notes in a core file. For each
1582supported register note section, the iterator must call CB and pass
1583CB_DATA unchanged. If REGCACHE is not NULL, the iterator can limit
1584the supported register note sections based on the current register
1585values. Otherwise it should enumerate all supported register note
1586sections.
1587""",
1588 type="void",
1589 name="iterate_over_regset_sections",
1590 params=[
1591 ("iterate_over_regset_sections_cb *", "cb"),
1592 ("void *", "cb_data"),
1593 ("const struct regcache *", "regcache"),
1594 ],
1595 predicate=True,
1596)
1597
1598Method(
1599 comment="""
1600Create core file notes
1601""",
1602 type="gdb::unique_xmalloc_ptr<char>",
1603 name="make_corefile_notes",
1604 params=[("bfd *", "obfd"), ("int *", "note_size")],
1605 predicate=True,
1606)
1607
1608Method(
1609 comment="""
1610Find core file memory regions
1611""",
1612 type="int",
1613 name="find_memory_regions",
1614 params=[("find_memory_region_ftype", "func"), ("void *", "data")],
1615 predicate=True,
1616)
1617
1618Method(
1619 comment="""
1620Given a bfd OBFD, segment ADDRESS and SIZE, create a memory tag section to be dumped to a core file
1621""",
1622 type="asection *",
1623 name="create_memtag_section",
1624 params=[("bfd *", "obfd"), ("CORE_ADDR", "address"), ("size_t", "size")],
1625 predicate=True,
1626)
1627
1628Method(
1629 comment="""
1630Given a memory tag section OSEC, fill OSEC's contents with the appropriate tag data
1631""",
1632 type="bool",
1633 name="fill_memtag_section",
1634 params=[("asection *", "osec")],
1635 predicate=True,
1636)
1637
1638Method(
1639 comment="""
1640Decode a memory tag SECTION and return the tags of type TYPE contained in
1641the memory range [ADDRESS, ADDRESS + LENGTH).
1642If no tags were found, return an empty vector.
1643""",
1644 type="gdb::byte_vector",
1645 name="decode_memtag_section",
1646 params=[
1647 ("bfd_section *", "section"),
1648 ("int", "type"),
1649 ("CORE_ADDR", "address"),
1650 ("size_t", "length"),
1651 ],
1652 predicate=True,
1653)
1654
1655Method(
1656 comment="""
1657Read offset OFFSET of TARGET_OBJECT_LIBRARIES formatted shared libraries list from
1658core file into buffer READBUF with length LEN. Return the number of bytes read
1659(zero indicates failure).
1660failed, otherwise, return the red length of READBUF.
1661""",
1662 type="ULONGEST",
1663 name="core_xfer_shared_libraries",
1664 params=[("gdb_byte *", "readbuf"), ("ULONGEST", "offset"), ("ULONGEST", "len")],
1665 predicate=True,
1666)
1667
1668Method(
1669 comment="""
1670Read offset OFFSET of TARGET_OBJECT_LIBRARIES_AIX formatted shared
1671libraries list from core file into buffer READBUF with length LEN.
1672Return the number of bytes read (zero indicates failure).
1673""",
1674 type="ULONGEST",
1675 name="core_xfer_shared_libraries_aix",
1676 params=[("gdb_byte *", "readbuf"), ("ULONGEST", "offset"), ("ULONGEST", "len")],
1677 predicate=True,
1678)
1679
1680Method(
1681 comment="""
1682How the core target converts a PTID from a core file to a string.
1683""",
1684 type="std::string",
1685 name="core_pid_to_str",
1686 params=[("ptid_t", "ptid")],
1687 predicate=True,
1688)
1689
1690Method(
1691 comment="""
1692How the core target extracts the name of a thread from a core file.
1693""",
1694 type="const char *",
1695 name="core_thread_name",
1696 params=[("struct thread_info *", "thr")],
1697 predicate=True,
1698)
1699
1700Method(
1701 comment="""
1702Read offset OFFSET of TARGET_OBJECT_SIGNAL_INFO signal information
1703from core file into buffer READBUF with length LEN. Return the number
1704of bytes read (zero indicates EOF, a negative value indicates failure).
1705""",
1706 type="LONGEST",
1707 name="core_xfer_siginfo",
1708 params=[("gdb_byte *", "readbuf"), ("ULONGEST", "offset"), ("ULONGEST", "len")],
1709 predicate=True,
1710)
1711
1712Method(
1713 comment="""
1714Read x86 XSAVE layout information from core file into XSAVE_LAYOUT.
1715Returns true if the layout was read successfully.
1716""",
1717 type="bool",
1718 name="core_read_x86_xsave_layout",
1719 params=[("x86_xsave_layout &", "xsave_layout")],
1720 predicate=True,
1721)
1722
1723Value(
1724 comment="""
1725BFD target to use when generating a core file.
1726""",
1727 type="const char *",
1728 name="gcore_bfd_target",
1729 predicate=True,
1730 printer="pstring (gdbarch->gcore_bfd_target)",
1731)
1732
1733Value(
1734 comment="""
1735If the elements of C++ vtables are in-place function descriptors rather
1736than normal function pointers (which may point to code or a descriptor),
1737set this to one.
1738""",
1739 type="int",
1740 name="vtable_function_descriptors",
1741 predefault="0",
1742 invalid=False,
1743)
1744
1745Value(
1746 comment="""
1747Set if the least significant bit of the delta is used instead of the least
1748significant bit of the pfn for pointers to virtual member functions.
1749""",
1750 type="int",
1751 name="vbit_in_delta",
1752 invalid=False,
1753)
1754
1755Function(
1756 comment="""
1757Advance PC to next instruction in order to skip a permanent breakpoint.
1758""",
1759 type="void",
1760 name="skip_permanent_breakpoint",
1761 params=[("struct regcache *", "regcache")],
1762 predefault="default_skip_permanent_breakpoint",
1763 invalid=False,
1764)
1765
1766Value(
1767 comment="""
1768The maximum length of an instruction on this architecture in bytes.
1769""",
1770 type="ULONGEST",
1771 name="max_insn_length",
1772 predefault="0",
1773 predicate=True,
1774)
1775
1776Method(
1777 comment="""
1778Copy the instruction at FROM to TO, and make any adjustments
1779necessary to single-step it at that address.
1780
1781REGS holds the state the thread's registers will have before
1782executing the copied instruction; the PC in REGS will refer to FROM,
1783not the copy at TO. The caller should update it to point at TO later.
1784
1785Return a pointer to data of the architecture's choice to be passed
1786to gdbarch_displaced_step_fixup.
1787
1788For a general explanation of displaced stepping and how GDB uses it,
1789see the comments in infrun.c.
1790
1791The TO area is only guaranteed to have space for
1792gdbarch_displaced_step_buffer_length (arch) octets, so this
1793function must not write more octets than that to this area.
1794
1795If you do not provide this function, GDB assumes that the
1796architecture does not support displaced stepping.
1797
1798If the instruction cannot execute out of line, return NULL. The
1799core falls back to stepping past the instruction in-line instead in
1800that case.
1801""",
1802 type="displaced_step_copy_insn_closure_up",
1803 name="displaced_step_copy_insn",
1804 params=[("CORE_ADDR", "from"), ("CORE_ADDR", "to"), ("struct regcache *", "regs")],
1805 predicate=True,
1806)
1807
1808Method(
1809 comment="""
1810Return true if GDB should use hardware single-stepping to execute a displaced
1811step instruction. If false, GDB will simply restart execution at the
1812displaced instruction location, and it is up to the target to ensure GDB will
1813receive control again (e.g. by placing a software breakpoint instruction into
1814the displaced instruction buffer).
1815
1816The default implementation returns false on all targets that provide a
1817gdbarch_software_single_step routine, and true otherwise.
1818""",
1819 type="bool",
1820 name="displaced_step_hw_singlestep",
1821 params=[],
1822 predefault="default_displaced_step_hw_singlestep",
1823 invalid=False,
1824)
1825
1826Method(
1827 comment="""
1828Fix up the state after attempting to single-step a displaced
1829instruction, to give the result we would have gotten from stepping the
1830instruction in its original location.
1831
1832REGS is the register state resulting from single-stepping the
1833displaced instruction.
1834
1835CLOSURE is the result from the matching call to
1836gdbarch_displaced_step_copy_insn.
1837
1838FROM is the address where the instruction was original located, TO is
1839the address of the displaced buffer where the instruction was copied
1840to for stepping.
1841
1842COMPLETED_P is true if GDB stopped as a result of the requested step
1843having completed (e.g. the inferior stopped with SIGTRAP), otherwise
1844COMPLETED_P is false and GDB stopped for some other reason. In the
1845case where a single instruction is expanded to multiple replacement
1846instructions for stepping then it may be necessary to read the current
1847program counter from REGS in order to decide how far through the
1848series of replacement instructions the inferior got before stopping,
1849this may impact what will need fixing up in this function.
1850
1851For a general explanation of displaced stepping and how GDB uses it,
1852see the comments in infrun.c.
1853""",
1854 type="void",
1855 name="displaced_step_fixup",
1856 params=[
1857 ("struct displaced_step_copy_insn_closure *", "closure"),
1858 ("CORE_ADDR", "from"),
1859 ("CORE_ADDR", "to"),
1860 ("struct regcache *", "regs"),
1861 ("bool", "completed_p"),
1862 ],
1863 predicate=False,
1864 predefault="NULL",
1865 invalid="(gdbarch->displaced_step_copy_insn == nullptr) != (gdbarch->displaced_step_fixup == nullptr)",
1866)
1867
1868Method(
1869 comment="""
1870Prepare THREAD for it to displaced step the instruction at its current PC.
1871
1872Throw an exception if any unexpected error happens.
1873""",
1874 type="displaced_step_prepare_status",
1875 name="displaced_step_prepare",
1876 params=[("thread_info *", "thread"), ("CORE_ADDR &", "displaced_pc")],
1877 predicate=True,
1878)
1879
1880Method(
1881 comment="""
1882Clean up after a displaced step of THREAD.
1883""",
1884 type="displaced_step_finish_status",
1885 name="displaced_step_finish",
1886 params=[("thread_info *", "thread"), ("const target_waitstatus &", "ws")],
1887 predefault="NULL",
1888 invalid="(! gdbarch->displaced_step_finish) != (! gdbarch->displaced_step_prepare)",
1889)
1890
1891Function(
1892 comment="""
1893Return the closure associated to the displaced step buffer that is at ADDR.
1894""",
1895 type="const displaced_step_copy_insn_closure *",
1896 name="displaced_step_copy_insn_closure_by_addr",
1897 params=[("inferior *", "inf"), ("CORE_ADDR", "addr")],
1898 predicate=True,
1899)
1900
1901Function(
1902 comment="""
1903PARENT_INF has forked and CHILD_PTID is the ptid of the child. Restore the
1904contents of all displaced step buffers in the child's address space.
1905""",
1906 type="void",
1907 name="displaced_step_restore_all_in_ptid",
1908 params=[("inferior *", "parent_inf"), ("ptid_t", "child_ptid")],
1909 invalid=False,
1910)
1911
1912Value(
1913 comment="""
1914The maximum length in octets required for a displaced-step instruction
1915buffer. By default this will be the same as gdbarch::max_insn_length,
1916but should be overridden for architectures that might expand a
1917displaced-step instruction to multiple replacement instructions.
1918""",
1919 type="ULONGEST",
1920 name="displaced_step_buffer_length",
1921 predefault="0",
1922 postdefault="gdbarch->max_insn_length",
1923 invalid="gdbarch->displaced_step_buffer_length < gdbarch->max_insn_length",
1924)
1925
1926Method(
1927 comment="""
1928Relocate an instruction to execute at a different address. OLDLOC
1929is the address in the inferior memory where the instruction to
1930relocate is currently at. On input, TO points to the destination
1931where we want the instruction to be copied (and possibly adjusted)
1932to. On output, it points to one past the end of the resulting
1933instruction(s). The effect of executing the instruction at TO shall
1934be the same as if executing it at FROM. For example, call
1935instructions that implicitly push the return address on the stack
1936should be adjusted to return to the instruction after OLDLOC;
1937relative branches, and other PC-relative instructions need the
1938offset adjusted; etc.
1939""",
1940 type="void",
1941 name="relocate_instruction",
1942 params=[("CORE_ADDR *", "to"), ("CORE_ADDR", "from")],
1943 predicate=True,
1944 predefault="NULL",
1945)
1946
1947Function(
1948 comment="""
1949Refresh overlay mapped state for section OSECT.
1950""",
1951 type="void",
1952 name="overlay_update",
1953 params=[("struct obj_section *", "osect")],
1954 predicate=True,
1955)
1956
1957Method(
1958 type="const struct target_desc *",
1959 name="core_read_description",
1960 params=[("struct target_ops *", "target"), ("bfd *", "abfd")],
1961 predicate=True,
1962)
1963
1964Value(
1965 comment="""
1966Set if the address in N_SO or N_FUN stabs may be zero.
1967""",
1968 type="int",
1969 name="sofun_address_maybe_missing",
1970 predefault="0",
1971 invalid=False,
1972)
1973
1974Method(
1975 comment="""
1976Parse the instruction at ADDR storing in the record execution log
1977the registers REGCACHE and memory ranges that will be affected when
1978the instruction executes, along with their current values.
1979Return -1 if something goes wrong, 0 otherwise.
1980""",
1981 type="int",
1982 name="process_record",
1983 params=[("struct regcache *", "regcache"), ("CORE_ADDR", "addr")],
1984 predicate=True,
1985)
1986
1987Method(
1988 comment="""
1989Save process state after a signal.
1990Return -1 if something goes wrong, 0 otherwise.
1991""",
1992 type="int",
1993 name="process_record_signal",
1994 params=[("struct regcache *", "regcache"), ("enum gdb_signal", "signal")],
1995 predicate=True,
1996)
1997
1998Method(
1999 comment="""
2000Signal translation: translate inferior's signal (target's) number
2001into GDB's representation. The implementation of this method must
2002be host independent. IOW, don't rely on symbols of the NAT_FILE
2003header (the nm-*.h files), the host <signal.h> header, or similar
2004headers. This is mainly used when cross-debugging core files ---
2005"Live" targets hide the translation behind the target interface
2006(target_wait, target_resume, etc.).
2007""",
2008 type="enum gdb_signal",
2009 name="gdb_signal_from_target",
2010 params=[("int", "signo")],
2011 predicate=True,
2012)
2013
2014Method(
2015 comment="""
2016Signal translation: translate the GDB's internal signal number into
2017the inferior's signal (target's) representation. The implementation
2018of this method must be host independent. IOW, don't rely on symbols
2019of the NAT_FILE header (the nm-*.h files), the host <signal.h>
2020header, or similar headers.
2021Return the target signal number if found, or -1 if the GDB internal
2022signal number is invalid.
2023""",
2024 type="int",
2025 name="gdb_signal_to_target",
2026 params=[("enum gdb_signal", "signal")],
2027 predicate=True,
2028)
2029
2030Method(
2031 comment="""
2032Extra signal info inspection.
2033
2034Return a type suitable to inspect extra signal information.
2035""",
2036 type="struct type *",
2037 name="get_siginfo_type",
2038 params=[],
2039 predicate=True,
2040)
2041
2042Method(
2043 comment="""
2044Record architecture-specific information from the symbol table.
2045""",
2046 type="void",
2047 name="record_special_symbol",
2048 params=[("struct objfile *", "objfile"), ("asymbol *", "sym")],
2049 predicate=True,
2050)
2051
2052Method(
2053 comment="""
2054Function for the 'catch syscall' feature.
2055Get architecture-specific system calls information from registers.
2056""",
2057 type="LONGEST",
2058 name="get_syscall_number",
2059 params=[("thread_info *", "thread")],
2060 predicate=True,
2061)
2062
2063Value(
2064 comment="""
2065The filename of the XML syscall for this architecture.
2066""",
2067 type="const char *",
2068 name="xml_syscall_file",
2069 invalid=False,
2070 printer="pstring (gdbarch->xml_syscall_file)",
2071)
2072
2073Value(
2074 comment="""
2075Information about system calls from this architecture
2076""",
2077 type="struct syscalls_info *",
2078 name="syscalls_info",
2079 invalid=False,
2080 printer="host_address_to_string (gdbarch->syscalls_info)",
2081)
2082
2083Value(
2084 comment="""
2085SystemTap related fields and functions.
2086A NULL-terminated array of prefixes used to mark an integer constant
2087on the architecture's assembly.
2088For example, on x86 integer constants are written as:
2089
2090$10 ;; integer constant 10
2091
2092in this case, this prefix would be the character `$'.
2093""",
2094 type="const char *const *",
2095 name="stap_integer_prefixes",
2096 invalid=False,
2097 printer="pstring_list (gdbarch->stap_integer_prefixes)",
2098)
2099
2100Value(
2101 comment="""
2102A NULL-terminated array of suffixes used to mark an integer constant
2103on the architecture's assembly.
2104""",
2105 type="const char *const *",
2106 name="stap_integer_suffixes",
2107 invalid=False,
2108 printer="pstring_list (gdbarch->stap_integer_suffixes)",
2109)
2110
2111Value(
2112 comment="""
2113A NULL-terminated array of prefixes used to mark a register name on
2114the architecture's assembly.
2115For example, on x86 the register name is written as:
2116
2117%eax ;; register eax
2118
2119in this case, this prefix would be the character `%'.
2120""",
2121 type="const char *const *",
2122 name="stap_register_prefixes",
2123 invalid=False,
2124 printer="pstring_list (gdbarch->stap_register_prefixes)",
2125)
2126
2127Value(
2128 comment="""
2129A NULL-terminated array of suffixes used to mark a register name on
2130the architecture's assembly.
2131""",
2132 type="const char *const *",
2133 name="stap_register_suffixes",
2134 invalid=False,
2135 printer="pstring_list (gdbarch->stap_register_suffixes)",
2136)
2137
2138Value(
2139 comment="""
2140A NULL-terminated array of prefixes used to mark a register
2141indirection on the architecture's assembly.
2142For example, on x86 the register indirection is written as:
2143
2144(%eax) ;; indirecting eax
2145
2146in this case, this prefix would be the charater `('.
2147
2148Please note that we use the indirection prefix also for register
2149displacement, e.g., `4(%eax)' on x86.
2150""",
2151 type="const char *const *",
2152 name="stap_register_indirection_prefixes",
2153 invalid=False,
2154 printer="pstring_list (gdbarch->stap_register_indirection_prefixes)",
2155)
2156
2157Value(
2158 comment="""
2159A NULL-terminated array of suffixes used to mark a register
2160indirection on the architecture's assembly.
2161For example, on x86 the register indirection is written as:
2162
2163(%eax) ;; indirecting eax
2164
2165in this case, this prefix would be the charater `)'.
2166
2167Please note that we use the indirection suffix also for register
2168displacement, e.g., `4(%eax)' on x86.
2169""",
2170 type="const char *const *",
2171 name="stap_register_indirection_suffixes",
2172 invalid=False,
2173 printer="pstring_list (gdbarch->stap_register_indirection_suffixes)",
2174)
2175
2176Value(
2177 comment="""
2178Prefix(es) used to name a register using GDB's nomenclature.
2179
2180For example, on PPC a register is represented by a number in the assembly
2181language (e.g., `10' is the 10th general-purpose register). However,
2182inside GDB this same register has an `r' appended to its name, so the 10th
2183register would be represented as `r10' internally.
2184""",
2185 type="const char *",
2186 name="stap_gdb_register_prefix",
2187 invalid=False,
2188 printer="pstring (gdbarch->stap_gdb_register_prefix)",
2189)
2190
2191Value(
2192 comment="""
2193Suffix used to name a register using GDB's nomenclature.
2194""",
2195 type="const char *",
2196 name="stap_gdb_register_suffix",
2197 invalid=False,
2198 printer="pstring (gdbarch->stap_gdb_register_suffix)",
2199)
2200
2201Method(
2202 comment="""
2203Check if S is a single operand.
2204
2205Single operands can be:
2206- Literal integers, e.g. `$10' on x86
2207- Register access, e.g. `%eax' on x86
2208- Register indirection, e.g. `(%eax)' on x86
2209- Register displacement, e.g. `4(%eax)' on x86
2210
2211This function should check for these patterns on the string
2212and return 1 if some were found, or zero otherwise. Please try to match
2213as much info as you can from the string, i.e., if you have to match
2214something like `(%', do not match just the `('.
2215""",
2216 type="int",
2217 name="stap_is_single_operand",
2218 params=[("const char *", "s")],
2219 predicate=True,
2220)
2221
2222Method(
2223 comment="""
2224Function used to handle a "special case" in the parser.
2225
2226A "special case" is considered to be an unknown token, i.e., a token
2227that the parser does not know how to parse. A good example of special
2228case would be ARM's register displacement syntax:
2229
2230[R0, #4] ;; displacing R0 by 4
2231
2232Since the parser assumes that a register displacement is of the form:
2233
2234<number> <indirection_prefix> <register_name> <indirection_suffix>
2235
2236it means that it will not be able to recognize and parse this odd syntax.
2237Therefore, we should add a special case function that will handle this token.
2238
2239This function should generate the proper expression form of the expression
2240using GDB's internal expression mechanism (e.g., `write_exp_elt_opcode'
2241and so on). It should also return 1 if the parsing was successful, or zero
2242if the token was not recognized as a special token (in this case, returning
2243zero means that the special parser is deferring the parsing to the generic
2244parser), and should advance the buffer pointer (p->arg).
2245""",
2246 type="expr::operation_up",
2247 name="stap_parse_special_token",
2248 params=[("struct stap_parse_info *", "p")],
2249 predicate=True,
2250)
2251
2252Method(
2253 comment="""
2254Perform arch-dependent adjustments to a register name.
2255
2256In very specific situations, it may be necessary for the register
2257name present in a SystemTap probe's argument to be handled in a
2258special way. For example, on i386, GCC may over-optimize the
2259register allocation and use smaller registers than necessary. In
2260such cases, the client that is reading and evaluating the SystemTap
2261probe (ourselves) will need to actually fetch values from the wider
2262version of the register in question.
2263
2264To illustrate the example, consider the following probe argument
2265(i386):
2266
22674@%ax
2268
2269This argument says that its value can be found at the %ax register,
2270which is a 16-bit register. However, the argument's prefix says
2271that its type is "uint32_t", which is 32-bit in size. Therefore, in
2272this case, GDB should actually fetch the probe's value from register
2273%eax, not %ax. In this scenario, this function would actually
2274replace the register name from %ax to %eax.
2275
2276The rationale for this can be found at PR breakpoints/24541.
2277""",
2278 type="std::string",
2279 name="stap_adjust_register",
2280 params=[
2281 ("struct stap_parse_info *", "p"),
2282 ("const std::string &", "regname"),
2283 ("int", "regnum"),
2284 ],
2285 predicate=True,
2286)
2287
2288Method(
2289 comment="""
2290DTrace related functions.
2291The expression to compute the NARTGth+1 argument to a DTrace USDT probe.
2292NARG must be >= 0.
2293""",
2294 type="expr::operation_up",
2295 name="dtrace_parse_probe_argument",
2296 params=[("int", "narg")],
2297 predicate=True,
2298)
2299
2300Method(
2301 comment="""
2302True if the given ADDR does not contain the instruction sequence
2303corresponding to a disabled DTrace is-enabled probe.
2304""",
2305 type="int",
2306 name="dtrace_probe_is_enabled",
2307 params=[("CORE_ADDR", "addr")],
2308 predicate=True,
2309)
2310
2311Method(
2312 comment="""
2313Enable a DTrace is-enabled probe at ADDR.
2314""",
2315 type="void",
2316 name="dtrace_enable_probe",
2317 params=[("CORE_ADDR", "addr")],
2318 predicate=True,
2319)
2320
2321Method(
2322 comment="""
2323Disable a DTrace is-enabled probe at ADDR.
2324""",
2325 type="void",
2326 name="dtrace_disable_probe",
2327 params=[("CORE_ADDR", "addr")],
2328 predicate=True,
2329)
2330
2331Value(
2332 comment="""
2333True if the list of shared libraries is one and only for all
2334processes, as opposed to a list of shared libraries per inferior.
2335This usually means that all processes, although may or may not share
2336an address space, will see the same set of symbols at the same
2337addresses.
2338""",
2339 type="int",
2340 name="has_global_solist",
2341 predefault="0",
2342 invalid=False,
2343)
2344
2345Value(
2346 comment="""
2347On some targets, even though each inferior has its own private
2348address space, the debug interface takes care of making breakpoints
2349visible to all address spaces automatically. For such cases,
2350this property should be set to true.
2351""",
2352 type="int",
2353 name="has_global_breakpoints",
2354 predefault="0",
2355 invalid=False,
2356)
2357
2358Method(
2359 comment="""
2360True if inferiors share an address space (e.g., uClinux).
2361""",
2362 type="int",
2363 name="has_shared_address_space",
2364 params=[],
2365 predefault="default_has_shared_address_space",
2366 invalid=False,
2367)
2368
2369Method(
2370 comment="""
2371True if a fast tracepoint can be set at an address.
2372""",
2373 type="int",
2374 name="fast_tracepoint_valid_at",
2375 params=[("CORE_ADDR", "addr"), ("std::string *", "msg")],
2376 predefault="default_fast_tracepoint_valid_at",
2377 invalid=False,
2378)
2379
2380Method(
2381 comment="""
2382Guess register state based on tracepoint location. Used for tracepoints
2383where no registers have been collected, but there's only one location,
2384allowing us to guess the PC value, and perhaps some other registers.
2385On entry, regcache has all registers marked as unavailable.
2386""",
2387 type="void",
2388 name="guess_tracepoint_registers",
2389 params=[("struct regcache *", "regcache"), ("CORE_ADDR", "addr")],
2390 predefault="default_guess_tracepoint_registers",
2391 invalid=False,
2392)
2393
2394Function(
2395 comment="""
2396Return the "auto" target charset.
2397""",
2398 type="const char *",
2399 name="auto_charset",
2400 params=[],
2401 predefault="default_auto_charset",
2402 invalid=False,
2403)
2404
2405Function(
2406 comment="""
2407Return the "auto" target wide charset.
2408""",
2409 type="const char *",
2410 name="auto_wide_charset",
2411 params=[],
2412 predefault="default_auto_wide_charset",
2413 invalid=False,
2414)
2415
2416Value(
2417 comment="""
2418If non-empty, this is a file extension that will be opened in place
2419of the file extension reported by the shared library list.
2420
2421This is most useful for toolchains that use a post-linker tool,
2422where the names of the files run on the target differ in extension
2423compared to the names of the files GDB should load for debug info.
2424""",
2425 type="const char *",
2426 name="solib_symbols_extension",
2427 invalid=False,
2428 printer="pstring (gdbarch->solib_symbols_extension)",
2429)
2430
2431Value(
2432 comment="""
2433If true, the target OS has DOS-based file system semantics. That
2434is, absolute paths include a drive name, and the backslash is
2435considered a directory separator.
2436""",
2437 type="int",
2438 name="has_dos_based_file_system",
2439 predefault="0",
2440 invalid=False,
2441)
2442
2443Method(
2444 comment="""
2445Generate bytecodes to collect the return address in a frame.
2446Since the bytecodes run on the target, possibly with GDB not even
2447connected, the full unwinding machinery is not available, and
2448typically this function will issue bytecodes for one or more likely
2449places that the return address may be found.
2450""",
2451 type="void",
2452 name="gen_return_address",
2453 params=[
2454 ("struct agent_expr *", "ax"),
2455 ("struct axs_value *", "value"),
2456 ("CORE_ADDR", "scope"),
2457 ],
2458 predefault="default_gen_return_address",
2459 invalid=False,
2460)
2461
2462Method(
2463 comment="""
2464Implement the "info proc" command.
2465""",
2466 type="void",
2467 name="info_proc",
2468 params=[("const char *", "args"), ("enum info_proc_what", "what")],
2469 predicate=True,
2470)
2471
2472Method(
2473 comment="""
2474Implement the "info proc" command for core files. Noe that there
2475are two "info_proc"-like methods on gdbarch -- one for core files,
2476one for live targets.
2477""",
2478 type="void",
2479 name="core_info_proc",
2480 params=[("const char *", "args"), ("enum info_proc_what", "what")],
2481 predicate=True,
2482)
2483
2484Method(
2485 comment="""
2486Iterate over all objfiles in the order that makes the most sense
2487for the architecture to make global symbol searches.
2488
2489CB is a callback function passed an objfile to be searched. The iteration stops
2490if this function returns nonzero.
2491
2492If not NULL, CURRENT_OBJFILE corresponds to the objfile being
2493inspected when the symbol search was requested.
2494""",
2495 type="void",
2496 name="iterate_over_objfiles_in_search_order",
2497 params=[
2498 ("iterate_over_objfiles_in_search_order_cb_ftype", "cb"),
2499 ("struct objfile *", "current_objfile"),
2500 ],
2501 predefault="default_iterate_over_objfiles_in_search_order",
2502 invalid=False,
2503)
2504
2505Value(
2506 comment="""
2507Ravenscar arch-dependent ops.
2508""",
2509 type="struct ravenscar_arch_ops *",
2510 name="ravenscar_ops",
2511 predefault="NULL",
2512 invalid=False,
2513 printer="host_address_to_string (gdbarch->ravenscar_ops)",
2514)
2515
2516Method(
2517 comment="""
2518Return non-zero if the instruction at ADDR is a call; zero otherwise.
2519""",
2520 type="int",
2521 name="insn_is_call",
2522 params=[("CORE_ADDR", "addr")],
2523 predefault="default_insn_is_call",
2524 invalid=False,
2525)
2526
2527Method(
2528 comment="""
2529Return non-zero if the instruction at ADDR is a return; zero otherwise.
2530""",
2531 type="int",
2532 name="insn_is_ret",
2533 params=[("CORE_ADDR", "addr")],
2534 predefault="default_insn_is_ret",
2535 invalid=False,
2536)
2537
2538Method(
2539 comment="""
2540Return non-zero if the instruction at ADDR is a jump; zero otherwise.
2541""",
2542 type="int",
2543 name="insn_is_jump",
2544 params=[("CORE_ADDR", "addr")],
2545 predefault="default_insn_is_jump",
2546 invalid=False,
2547)
2548
2549Method(
2550 comment="""
2551Return true if there's a program/permanent breakpoint planted in
2552memory at ADDRESS, return false otherwise.
2553""",
2554 type="bool",
2555 name="program_breakpoint_here_p",
2556 params=[("CORE_ADDR", "address")],
2557 predefault="default_program_breakpoint_here_p",
2558 invalid=False,
2559)
2560
2561Method(
2562 comment="""
2563Read one auxv entry from *READPTR, not reading locations >= ENDPTR.
2564Return 0 if *READPTR is already at the end of the buffer.
2565Return -1 if there is insufficient buffer for a whole entry.
2566Return 1 if an entry was read into *TYPEP and *VALP.
2567""",
2568 type="int",
2569 name="auxv_parse",
2570 params=[
2571 ("const gdb_byte **", "readptr"),
2572 ("const gdb_byte *", "endptr"),
2573 ("CORE_ADDR *", "typep"),
2574 ("CORE_ADDR *", "valp"),
2575 ],
2576 predicate=True,
2577)
2578
2579Method(
2580 comment="""
2581Print the description of a single auxv entry described by TYPE and VAL
2582to FILE.
2583""",
2584 type="void",
2585 name="print_auxv_entry",
2586 params=[("struct ui_file *", "file"), ("CORE_ADDR", "type"), ("CORE_ADDR", "val")],
2587 predefault="default_print_auxv_entry",
2588 invalid=False,
2589)
2590
2591Method(
2592 comment="""
2593Find the address range of the current inferior's vsyscall/vDSO, and
2594write it to *RANGE. If the vsyscall's length can't be determined, a
2595range with zero length is returned. Returns true if the vsyscall is
2596found, false otherwise.
2597""",
2598 type="int",
2599 name="vsyscall_range",
2600 params=[("struct mem_range *", "range")],
2601 predefault="default_vsyscall_range",
2602 invalid=False,
2603)
2604
2605Function(
2606 comment="""
2607Allocate SIZE bytes of PROT protected page aligned memory in inferior.
2608PROT has GDB_MMAP_PROT_* bitmask format.
2609Throw an error if it is not possible. Returned address is always valid.
2610""",
2611 type="CORE_ADDR",
2612 name="infcall_mmap",
2613 params=[("CORE_ADDR", "size"), ("unsigned", "prot")],
2614 predefault="default_infcall_mmap",
2615 invalid=False,
2616)
2617
2618Function(
2619 comment="""
2620Deallocate SIZE bytes of memory at ADDR in inferior from gdbarch_infcall_mmap.
2621Print a warning if it is not possible.
2622""",
2623 type="void",
2624 name="infcall_munmap",
2625 params=[("CORE_ADDR", "addr"), ("CORE_ADDR", "size")],
2626 predefault="default_infcall_munmap",
2627 invalid=False,
2628)
2629
2630Method(
2631 comment="""
2632Return string (caller has to use xfree for it) with options for GCC
2633to produce code for this target, typically "-m64", "-m32" or "-m31".
2634These options are put before CU's DW_AT_producer compilation options so that
2635they can override it.
2636""",
2637 type="std::string",
2638 name="gcc_target_options",
2639 params=[],
2640 predefault="default_gcc_target_options",
2641 invalid=False,
2642)
2643
2644Method(
2645 comment="""
2646Return a regular expression that matches names used by this
2647architecture in GNU configury triplets. The result is statically
2648allocated and must not be freed. The default implementation simply
2649returns the BFD architecture name, which is correct in nearly every
2650case.
2651""",
2652 type="const char *",
2653 name="gnu_triplet_regexp",
2654 params=[],
2655 predefault="default_gnu_triplet_regexp",
2656 invalid=False,
2657)
2658
2659Method(
2660 comment="""
2661Return the size in 8-bit bytes of an addressable memory unit on this
2662architecture. This corresponds to the number of 8-bit bytes associated to
2663each address in memory.
2664""",
2665 type="int",
2666 name="addressable_memory_unit_size",
2667 params=[],
2668 predefault="default_addressable_memory_unit_size",
2669 invalid=False,
2670)
2671
2672Value(
2673 comment="""
2674Functions for allowing a target to modify its disassembler options.
2675""",
2676 type="const char *",
2677 name="disassembler_options_implicit",
2678 invalid=False,
2679 printer="pstring (gdbarch->disassembler_options_implicit)",
2680)
2681
2682Value(
2683 type="char **",
2684 name="disassembler_options",
2685 invalid=False,
2686 printer="pstring_ptr (gdbarch->disassembler_options)",
2687)
2688
2689Value(
2690 type="const disasm_options_and_args_t *",
2691 name="valid_disassembler_options",
2692 invalid=False,
2693 printer="host_address_to_string (gdbarch->valid_disassembler_options)",
2694)
2695
2696Method(
2697 comment="""
2698Type alignment override method. Return the architecture specific
2699alignment required for TYPE. If there is no special handling
2700required for TYPE then return the value 0, GDB will then apply the
2701default rules as laid out in gdbtypes.c:type_align.
2702""",
2703 type="ULONGEST",
2704 name="type_align",
2705 params=[("struct type *", "type")],
2706 predefault="default_type_align",
2707 invalid=False,
2708)
2709
2710Function(
2711 comment="""
2712Return a string containing any flags for the given PC in the given FRAME.
2713""",
2714 type="std::string",
2715 name="get_pc_address_flags",
2716 params=[("frame_info_ptr", "frame"), ("CORE_ADDR", "pc")],
2717 predefault="default_get_pc_address_flags",
2718 invalid=False,
2719)
2720
2721Method(
2722 comment="""
2723Read core file mappings
2724""",
2725 type="void",
2726 name="read_core_file_mappings",
2727 params=[
2728 ("struct bfd *", "cbfd"),
2729 ("read_core_file_mappings_pre_loop_ftype", "pre_loop_cb"),
2730 ("read_core_file_mappings_loop_ftype", "loop_cb"),
2731 ],
2732 predefault="default_read_core_file_mappings",
2733 invalid=False,
2734)
2735
2736Method(
2737 comment="""
2738Return true if the target description for all threads should be read from the
2739target description core file note(s). Return false if the target description
2740for all threads should be inferred from the core file contents/sections.
2741
2742The corefile's bfd is passed through COREFILE_BFD.
2743""",
2744 type="bool",
2745 name="use_target_description_from_corefile_notes",
2746 params=[("struct bfd *", "corefile_bfd")],
2747 predefault="default_use_target_description_from_corefile_notes",
2748 invalid=False,
2749)