1 # Dynamic architecture support for GDB, the GNU debugger.
3 # Copyright (C) 1998-2023 Free Software Foundation, Inc.
5 # This file is part of GDB.
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.
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.
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/>.
20 # How to add to gdbarch:
22 # There are four kinds of fields in gdbarch:
24 # * Info - you should never need this; it is only for things that are
25 # copied directly from the gdbarch_info.
27 # * Value - a variable.
29 # * Function - a function pointer.
31 # * Method - a function pointer, but the function takes a gdbarch as
32 # its first parameter.
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
38 # All parameters are keyword-only. This is done to help catch typos.
40 # Some parameters are shared among all types (including Info):
42 # * "name" - required, the name of the field.
44 # * "type" - required, the type of the field. For functions and
45 # methods, this is the return type.
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.
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.
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.)
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.
63 # * "predefault", "postdefault", and "invalid" - These are used for
64 # the initialization and verification steps:
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
70 # After initialization is complete (that is, after the tdep code has a
71 # chance to change the settings), the post-initialization step is
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.
77 # After the possible "postdefault" assignment, validation is
78 # performed for fields that don't have a "predicate".
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
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
90 # Function and Method share:
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.
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).
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'.
112 # * "implement" - optional, a boolean. If True (the default), a
113 # wrapper function for this function will be emitted.
115 from gdbarch_types
import Function
, Info
, Method
, Value
118 type="const struct bfd_arch_info *",
119 name
="bfd_arch_info",
120 printer
="gdbarch_bfd_arch_info (gdbarch)->printable_name",
124 type="enum bfd_endian",
129 type="enum bfd_endian",
130 name
="byte_order_for_code",
134 type="enum gdb_osabi",
139 type="const struct target_desc *",
141 printer
="host_address_to_string (gdbarch->target_desc)",
146 Number of bits in a short or unsigned short for the target machine.
150 predefault
="2*TARGET_CHAR_BIT",
156 Number of bits in an int or unsigned int for the target machine.
160 predefault
="4*TARGET_CHAR_BIT",
164 long_bit_predefault
= "4*TARGET_CHAR_BIT"
167 Number of bits in a long or unsigned long for the target machine.
171 predefault
=long_bit_predefault
,
177 Number of bits in a long long or unsigned long long for the target
181 name
="long_long_bit",
182 predefault
="2*" + long_bit_predefault
,
188 The ABI default bit-size and format for "bfloat16", "half", "float", "double", and
189 "long double". These bit/format pairs should eventually be combined
190 into a single object. For the moment, just initialize them as a pair.
191 Each format describes both the big and little endian layouts (if
196 predefault
="2*TARGET_CHAR_BIT",
201 type="const struct floatformat **",
202 name
="bfloat16_format",
203 predefault
="floatformats_bfloat16",
204 printer
="pformat (gdbarch, gdbarch->bfloat16_format)",
211 predefault
="2*TARGET_CHAR_BIT",
216 type="const struct floatformat **",
218 predefault
="floatformats_ieee_half",
219 printer
="pformat (gdbarch, gdbarch->half_format)",
226 predefault
="4*TARGET_CHAR_BIT",
231 type="const struct floatformat **",
233 predefault
="floatformats_ieee_single",
234 printer
="pformat (gdbarch, gdbarch->float_format)",
241 predefault
="8*TARGET_CHAR_BIT",
246 type="const struct floatformat **",
247 name
="double_format",
248 predefault
="floatformats_ieee_double",
249 printer
="pformat (gdbarch, gdbarch->double_format)",
255 name
="long_double_bit",
256 predefault
="8*TARGET_CHAR_BIT",
261 type="const struct floatformat **",
262 name
="long_double_format",
263 predefault
="floatformats_ieee_double",
264 printer
="pformat (gdbarch, gdbarch->long_double_format)",
270 The ABI default bit-size for "wchar_t". wchar_t is a built-in type
275 predefault
="4*TARGET_CHAR_BIT",
281 One if `wchar_t' is signed, zero if unsigned.
292 Returns the floating-point format to be used for values of length LENGTH.
293 NAME, if non-NULL, is the type name, which may be used to distinguish
294 different target formats of the same length.
296 type="const struct floatformat **",
297 name
="floatformat_for_type",
298 params
=[("const char *", "name"), ("int", "length")],
299 predefault
="default_floatformat_for_type",
305 For most targets, a pointer on the target and its representation as an
306 address in GDB have the same size and "look the same". For such a
307 target, you need only set gdbarch_ptr_bit and gdbarch_addr_bit
308 / addr_bit will be set from it.
310 If gdbarch_ptr_bit and gdbarch_addr_bit are different, you'll probably
311 also need to set gdbarch_dwarf2_addr_size, gdbarch_pointer_to_address and
312 gdbarch_address_to_pointer as well.
314 ptr_bit is the size of a pointer on the target
318 predefault
=int_bit
.predefault
,
324 addr_bit is the size of a target address as represented in gdb
329 postdefault
="gdbarch_ptr_bit (gdbarch)",
335 dwarf2_addr_size is the target address size as used in the Dwarf debug
336 info. For .debug_frame FDEs, this is supposed to be the target address
337 size from the associated CU header, and which is equivalent to the
338 DWARF2_ADDR_SIZE as defined by the target specific GCC back-end.
339 Unfortunately there is no good way to determine this value. Therefore
340 dwarf2_addr_size simply defaults to the target pointer size.
342 dwarf2_addr_size is not used for .eh_frame FDEs, which are generally
343 defined using the target's pointer size so far.
345 Note that dwarf2_addr_size only needs to be redefined by a target if the
346 GCC back-end defines a DWARF2_ADDR_SIZE other than the target pointer size,
347 and if Dwarf versions < 4 need to be supported.
350 name
="dwarf2_addr_size",
351 postdefault
="gdbarch_ptr_bit (gdbarch) / TARGET_CHAR_BIT",
357 One if `char' acts like `signed char', zero if `unsigned char'.
369 params
=[("readable_regcache *", "regcache")],
376 params
=[("struct regcache *", "regcache"), ("CORE_ADDR", "val")],
382 Function for getting target's idea of a frame pointer. FIXME: GDB's
383 whole scheme for dealing with "frames" and "frame pointers" needs a
387 name
="virtual_frame_pointer",
390 ("int *", "frame_regnum"),
391 ("LONGEST *", "frame_offset"),
393 predefault
="legacy_virtual_frame_pointer",
398 type="enum register_status",
399 name
="pseudo_register_read",
401 ("readable_regcache *", "regcache"),
402 ("int", "cookednum"),
403 ("gdb_byte *", "buf"),
410 Read a register into a new struct value. If the register is wholly
411 or partly unavailable, this should call mark_value_bytes_unavailable
412 as appropriate. If this is defined, then pseudo_register_read will
415 type="struct value *",
416 name
="pseudo_register_read_value",
417 params
=[("readable_regcache *", "regcache"), ("int", "cookednum")],
423 name
="pseudo_register_write",
425 ("struct regcache *", "regcache"),
426 ("int", "cookednum"),
427 ("const gdb_byte *", "buf"),
440 This macro gives the number of pseudo-registers that live in the
441 register namespace but do not get fetched or stored on the target.
442 These pseudo-registers may be aliases for other registers,
443 combinations of other registers, or they may be computed by GDB.
446 name
="num_pseudo_regs",
453 Assemble agent expression bytecode to collect pseudo-register REG.
454 Return -1 if something goes wrong, 0 otherwise.
457 name
="ax_pseudo_register_collect",
458 params
=[("struct agent_expr *", "ax"), ("int", "reg")],
464 Assemble agent expression bytecode to push the value of pseudo-register
465 REG on the interpreter stack.
466 Return -1 if something goes wrong, 0 otherwise.
469 name
="ax_pseudo_register_push_stack",
470 params
=[("struct agent_expr *", "ax"), ("int", "reg")],
476 Some architectures can display additional information for specific
478 UIOUT is the output stream where the handler will place information.
481 name
="report_signal_info",
482 params
=[("struct ui_out *", "uiout"), ("enum gdb_signal", "siggnal")],
488 GDB's standard (or well known) register numbers. These can map onto
489 a real register or a pseudo (computed) register or not be defined at
491 gdbarch_sp_regnum will hopefully be replaced by UNWIND_SP.
522 Convert stab register number (from `r' declaration) to a gdb REGNUM.
525 name
="stab_reg_to_regnum",
526 params
=[("int", "stab_regnr")],
527 predefault
="no_op_reg_to_regnum",
533 Provide a default mapping from a ecoff register number to a gdb REGNUM.
536 name
="ecoff_reg_to_regnum",
537 params
=[("int", "ecoff_regnr")],
538 predefault
="no_op_reg_to_regnum",
544 Convert from an sdb register number to an internal gdb register number.
547 name
="sdb_reg_to_regnum",
548 params
=[("int", "sdb_regnr")],
549 predefault
="no_op_reg_to_regnum",
555 Provide a default mapping from a DWARF2 register number to a gdb REGNUM.
556 Return -1 for bad REGNUM. Note: Several targets get this wrong.
559 name
="dwarf2_reg_to_regnum",
560 params
=[("int", "dwarf2_regnr")],
561 predefault
="no_op_reg_to_regnum",
567 Return the name of register REGNR for the specified architecture.
568 REGNR 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
570 GDBARCH, then this function will return an empty string, this function
571 should never return nullptr.
574 name
="register_name",
575 params
=[("int", "regnr")],
576 param_checks
=["regnr >= 0", "regnr < gdbarch_num_cooked_regs (gdbarch)"],
577 result_checks
=["result != nullptr"],
582 Return the type of a register specified by the architecture. Only
583 the register cache should call this function directly; others should
586 type="struct type *",
587 name
="register_type",
588 params
=[("int", "reg_nr")],
593 Generate a dummy frame_id for THIS_FRAME assuming that the frame is
594 a dummy frame. A dummy frame is created before an inferior call,
595 the frame_id returned here must match the frame_id that was built
596 for the inferior call. Usually this means the returned frame_id's
597 stack address should match the address returned by
598 gdbarch_push_dummy_call, and the returned frame_id's code address
599 should match the address at which the breakpoint was set in the dummy
602 type="struct frame_id",
604 params
=[("frame_info_ptr", "this_frame")],
605 predefault
="default_dummy_id",
611 Implement DUMMY_ID and PUSH_DUMMY_CALL, then delete
612 deprecated_fp_regnum.
615 name
="deprecated_fp_regnum",
622 name
="push_dummy_call",
624 ("struct value *", "function"),
625 ("struct regcache *", "regcache"),
626 ("CORE_ADDR", "bp_addr"),
628 ("struct value **", "args"),
630 ("function_call_return_method", "return_method"),
631 ("CORE_ADDR", "struct_addr"),
637 type="enum call_dummy_location_type",
638 name
="call_dummy_location",
639 predefault
="AT_ENTRY_POINT",
645 name
="push_dummy_code",
648 ("CORE_ADDR", "funaddr"),
649 ("struct value **", "args"),
651 ("struct type *", "value_type"),
652 ("CORE_ADDR *", "real_pc"),
653 ("CORE_ADDR *", "bp_addr"),
654 ("struct regcache *", "regcache"),
661 Return true if the code of FRAME is writable.
664 name
="code_of_frame_writable",
665 params
=[("frame_info_ptr", "frame")],
666 predefault
="default_code_of_frame_writable",
672 name
="print_registers_info",
674 ("struct ui_file *", "file"),
675 ("frame_info_ptr", "frame"),
679 predefault
="default_print_registers_info",
685 name
="print_float_info",
687 ("struct ui_file *", "file"),
688 ("frame_info_ptr", "frame"),
689 ("const char *", "args"),
691 predefault
="default_print_float_info",
697 name
="print_vector_info",
699 ("struct ui_file *", "file"),
700 ("frame_info_ptr", "frame"),
701 ("const char *", "args"),
708 MAP a GDB RAW register number onto a simulator register number. See
709 also include/...-sim.h.
712 name
="register_sim_regno",
713 params
=[("int", "reg_nr")],
714 predefault
="legacy_register_sim_regno",
720 name
="cannot_fetch_register",
721 params
=[("int", "regnum")],
722 predefault
="cannot_register_not",
728 name
="cannot_store_register",
729 params
=[("int", "regnum")],
730 predefault
="cannot_register_not",
736 Determine the address where a longjmp will land and save this address
737 in PC. Return nonzero on success.
739 FRAME corresponds to the longjmp frame.
742 name
="get_longjmp_target",
743 params
=[("frame_info_ptr", "frame"), ("CORE_ADDR *", "pc")],
749 name
="believe_pcc_promotion",
755 name
="convert_register_p",
756 params
=[("int", "regnum"), ("struct type *", "type")],
757 predefault
="generic_convert_register_p",
763 name
="register_to_value",
765 ("frame_info_ptr", "frame"),
767 ("struct type *", "type"),
768 ("gdb_byte *", "buf"),
769 ("int *", "optimizedp"),
770 ("int *", "unavailablep"),
777 name
="value_to_register",
779 ("frame_info_ptr", "frame"),
781 ("struct type *", "type"),
782 ("const gdb_byte *", "buf"),
789 Construct a value representing the contents of register REGNUM in
790 frame FRAME_ID, interpreted as type TYPE. The routine needs to
791 allocate and return a struct value with all value attributes
792 (but not the value contents) filled in.
794 type="struct value *",
795 name
="value_from_register",
797 ("struct type *", "type"),
799 ("struct frame_id", "frame_id"),
801 predefault
="default_value_from_register",
807 name
="pointer_to_address",
808 params
=[("struct type *", "type"), ("const gdb_byte *", "buf")],
809 predefault
="unsigned_pointer_to_address",
815 name
="address_to_pointer",
816 params
=[("struct type *", "type"), ("gdb_byte *", "buf"), ("CORE_ADDR", "addr")],
817 predefault
="unsigned_address_to_pointer",
823 name
="integer_to_address",
824 params
=[("struct type *", "type"), ("const gdb_byte *", "buf")],
830 Return the return-value convention that will be used by FUNCTION
831 to return a value of type VALTYPE. FUNCTION may be NULL in which
832 case the return convention is computed based only on VALTYPE.
834 If READBUF is not NULL, extract the return value and save it in this buffer.
836 If WRITEBUF is not NULL, it contains a return value which will be
837 stored into the appropriate register. This can be used when we want
838 to force the value returned by a function (see the "return" command
841 NOTE: it is better to implement return_value_as_value instead, as that
842 method can properly handle variably-sized types.
844 type="enum return_value_convention",
847 ("struct value *", "function"),
848 ("struct type *", "valtype"),
849 ("struct regcache *", "regcache"),
850 ("gdb_byte *", "readbuf"),
851 ("const gdb_byte *", "writebuf"),
854 # We don't want to accidentally introduce calls to this, as gdb
855 # should only ever call return_value_new (see below).
861 Return the return-value convention that will be used by FUNCTION
862 to return a value of type VALTYPE. FUNCTION may be NULL in which
863 case the return convention is computed based only on VALTYPE.
865 If READ_VALUE is not NULL, extract the return value and save it in
868 If WRITEBUF is not NULL, it contains a return value which will be
869 stored into the appropriate register. This can be used when we want
870 to force the value returned by a function (see the "return" command
873 type="enum return_value_convention",
874 name
="return_value_as_value",
876 ("struct value *", "function"),
877 ("struct type *", "valtype"),
878 ("struct regcache *", "regcache"),
879 ("struct value **", "read_value"),
880 ("const gdb_byte *", "writebuf"),
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
886 invalid
="(gdbarch->return_value_as_value == default_gdbarch_return_value) == (gdbarch->return_value == nullptr)",
891 Return the address at which the value being returned from
892 the current function will be stored. This routine is only
893 called if the current function uses the the "struct return
896 May return 0 when unable to determine that address.""",
898 name
="get_return_buf_addr",
899 params
=[("struct type *", "val_type"), ("frame_info_ptr", "cur_frame")],
900 predefault
="default_get_return_buf_addr",
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.
916 Return true if the typedef record needs to be replaced.".
918 Return 0 by default""",
920 name
="dwarf2_omit_typedef_p",
922 ("struct type *", "target_type"),
923 ("const char *", "producer"),
924 ("const char *", "name"),
926 predefault
="default_dwarf2_omit_typedef_p",
932 Update PC when trying to find a call site. This is useful on
933 architectures where the call site PC, as reported in the DWARF, can be
934 incorrect for some reason.
936 The passed-in PC will be an address in the inferior. GDB will have
937 already failed to find a call site at this PC. This function may
938 simply return its parameter if it thinks that should be the correct
941 name
="update_call_site_pc",
942 params
=[("CORE_ADDR", "pc")],
943 predefault
="default_update_call_site_pc",
949 Return true if the return value of function is stored in the first hidden
950 parameter. In theory, this feature should be language-dependent, specified
951 by language and its ABI, such as C++. Unfortunately, compiler may
952 implement it to a target-dependent feature. So that we need such hook here
953 to be aware of this in GDB.
956 name
="return_in_first_hidden_param_p",
957 params
=[("struct type *", "type")],
958 predefault
="default_return_in_first_hidden_param_p",
964 name
="skip_prologue",
965 params
=[("CORE_ADDR", "ip")],
970 name
="skip_main_prologue",
971 params
=[("CORE_ADDR", "ip")],
977 On some platforms, a single function may provide multiple entry points,
978 e.g. one that is used for function-pointer calls and a different one
979 that is used for direct function calls.
980 In order to ensure that breakpoints set on the function will trigger
981 no matter via which entry point the function is entered, a platform
982 may provide the skip_entrypoint callback. It is called with IP set
983 to the main entry point of a function (as determined by the symbol table),
984 and should return the address of the innermost entry point, where the
985 actual breakpoint needs to be set. Note that skip_entrypoint is used
986 by GDB common code even when debugging optimized code, where skip_prologue
990 name
="skip_entrypoint",
991 params
=[("CORE_ADDR", "ip")],
998 params
=[("CORE_ADDR", "lhs"), ("CORE_ADDR", "rhs")],
1002 type="const gdb_byte *",
1003 name
="breakpoint_from_pc",
1004 params
=[("CORE_ADDR *", "pcptr"), ("int *", "lenptr")],
1005 predefault
="default_breakpoint_from_pc",
1011 Return the breakpoint kind for this target based on *PCPTR.
1014 name
="breakpoint_kind_from_pc",
1015 params
=[("CORE_ADDR *", "pcptr")],
1020 Return the software breakpoint from KIND. KIND can have target
1021 specific meaning like the Z0 kind parameter.
1022 SIZE is set to the software breakpoint's length in memory.
1024 type="const gdb_byte *",
1025 name
="sw_breakpoint_from_kind",
1026 params
=[("int", "kind"), ("int *", "size")],
1033 Return the breakpoint kind for this target based on the current
1034 processor state (e.g. the current instruction mode on ARM) and the
1035 *PCPTR. In default, it is gdbarch->breakpoint_kind_from_pc.
1038 name
="breakpoint_kind_from_current_state",
1039 params
=[("struct regcache *", "regcache"), ("CORE_ADDR *", "pcptr")],
1040 predefault
="default_breakpoint_kind_from_current_state",
1046 name
="adjust_breakpoint_address",
1047 params
=[("CORE_ADDR", "bpaddr")],
1053 name
="memory_insert_breakpoint",
1054 params
=[("struct bp_target_info *", "bp_tgt")],
1055 predefault
="default_memory_insert_breakpoint",
1061 name
="memory_remove_breakpoint",
1062 params
=[("struct bp_target_info *", "bp_tgt")],
1063 predefault
="default_memory_remove_breakpoint",
1069 name
="decr_pc_after_break",
1075 A function can be addressed by either its "pointer" (possibly a
1076 descriptor address) or "entry point" (first executable instruction).
1077 The method "convert_from_func_ptr_addr" converting the former to the
1078 latter. gdbarch_deprecated_function_start_offset is being used to implement
1079 a simplified subset of that functionality - the function's address
1080 corresponds to the "function pointer" and the function's start
1081 corresponds to the "function entry point" - and hence is redundant.
1084 name
="deprecated_function_start_offset",
1090 Return the remote protocol register number associated with this
1091 register. Normally the identity mapping.
1094 name
="remote_register_number",
1095 params
=[("int", "regno")],
1096 predefault
="default_remote_register_number",
1102 Fetch the target specific address used to represent a load module.
1105 name
="fetch_tls_load_module_address",
1106 params
=[("struct objfile *", "objfile")],
1112 Return the thread-local address at OFFSET in the thread-local
1113 storage for the thread PTID and the shared library or executable
1114 file given by LM_ADDR. If that block of thread-local storage hasn't
1115 been allocated yet, this function may throw an error. LM_ADDR may
1116 be zero for statically linked multithreaded inferiors.
1119 name
="get_thread_local_address",
1120 params
=[("ptid_t", "ptid"), ("CORE_ADDR", "lm_addr"), ("CORE_ADDR", "offset")],
1126 name
="frame_args_skip",
1133 params
=[("frame_info_ptr", "next_frame")],
1134 predefault
="default_unwind_pc",
1141 params
=[("frame_info_ptr", "next_frame")],
1142 predefault
="default_unwind_sp",
1148 DEPRECATED_FRAME_LOCALS_ADDRESS as been replaced by the per-frame
1149 frame-base. Enable frame-base before frame-unwind.
1152 name
="frame_num_args",
1153 params
=[("frame_info_ptr", "frame")],
1160 params
=[("CORE_ADDR", "address")],
1166 name
="stabs_argument_has_addr",
1167 params
=[("struct type *", "type")],
1168 predefault
="default_stabs_argument_has_addr",
1174 name
="frame_red_zone_size",
1180 name
="convert_from_func_ptr_addr",
1181 params
=[("CORE_ADDR", "addr"), ("struct target_ops *", "targ")],
1182 predefault
="convert_from_func_ptr_addr_identity",
1188 On some machines there are bits in addresses which are not really
1189 part of the address, but are used by the kernel, the hardware, etc.
1190 for special purposes. gdbarch_addr_bits_remove takes out any such bits so
1191 we get a "real" address such as one would find in a symbol table.
1192 This is used only for addresses of instructions, and even then I'm
1193 not sure it's used in all contexts. It exists to deal with there
1194 being a few stray bits in the PC which would mislead us, not as some
1195 sort of generic thing to handle alignment or segmentation (it's
1196 possible it should be in TARGET_READ_PC instead).
1199 name
="addr_bits_remove",
1200 params
=[("CORE_ADDR", "addr")],
1201 predefault
="core_addr_identity",
1207 On some architectures, not all bits of a pointer are significant.
1208 On AArch64, for example, the top bits of a pointer may carry a "tag", which
1209 can be ignored by the kernel and the hardware. The "tag" can be regarded as
1210 additional data associated with the pointer, but it is not part of the address.
1212 Given a pointer for the architecture, this hook removes all the
1213 non-significant bits and sign-extends things as needed. It gets used to remove
1214 non-address bits from data pointers (for example, removing the AArch64 MTE tag
1215 bits from a pointer) and from code pointers (removing the AArch64 PAC signature
1216 from a pointer containing the return address).
1219 name
="remove_non_address_bits",
1220 params
=[("CORE_ADDR", "pointer")],
1221 predefault
="default_remove_non_address_bits",
1227 Return a string representation of the memory tag TAG.
1230 name
="memtag_to_string",
1231 params
=[("struct value *", "tag")],
1232 predefault
="default_memtag_to_string",
1238 Return true if ADDRESS contains a tag and false otherwise. ADDRESS
1239 must be either a pointer or a reference type.
1242 name
="tagged_address_p",
1243 params
=[("struct value *", "address")],
1244 predefault
="default_tagged_address_p",
1250 Return true if the tag from ADDRESS matches the memory tag for that
1251 particular address. Return false otherwise.
1254 name
="memtag_matches_p",
1255 params
=[("struct value *", "address")],
1256 predefault
="default_memtag_matches_p",
1262 Set the tags of type TAG_TYPE, for the memory address range
1263 [ADDRESS, ADDRESS + LENGTH) to TAGS.
1264 Return true if successful and false otherwise.
1269 ("struct value *", "address"),
1270 ("size_t", "length"),
1271 ("const gdb::byte_vector &", "tags"),
1272 ("memtag_type", "tag_type"),
1274 predefault
="default_set_memtags",
1280 Return the tag of type TAG_TYPE associated with the memory address ADDRESS,
1281 assuming ADDRESS is tagged.
1283 type="struct value *",
1285 params
=[("struct value *", "address"), ("memtag_type", "tag_type")],
1286 predefault
="default_get_memtag",
1292 memtag_granule_size is the size of the allocation tag granule, for
1293 architectures that support memory tagging.
1294 This is 0 for architectures that do not support memory tagging.
1295 For a non-zero value, this represents the number of bytes of memory per tag.
1298 name
="memtag_granule_size",
1304 FIXME/cagney/2001-01-18: This should be split in two. A target method that
1305 indicates if the target needs software single step. An ISA method to
1308 FIXME/cagney/2001-01-18: The logic is backwards. It should be asking if the
1309 target can single step. If not, then implement single step using breakpoints.
1311 Return a vector of addresses on which the software single step
1312 breakpoints should be inserted. NULL means software single step is
1314 Multiple breakpoints may be inserted for some instructions such as
1315 conditional branch. However, each implementation must always evaluate
1316 the condition and only put the breakpoint at the branch destination if
1317 the condition is true, so that we ensure forward progress when stepping
1318 past a conditional branch to self.
1320 type="std::vector<CORE_ADDR>",
1321 name
="software_single_step",
1322 params
=[("struct regcache *", "regcache")],
1328 Return non-zero if the processor is executing a delay slot and a
1329 further single-step is needed before the instruction finishes.
1332 name
="single_step_through_delay",
1333 params
=[("frame_info_ptr", "frame")],
1339 FIXME: cagney/2003-08-28: Need to find a better way of selecting the
1340 disassembler. Perhaps objdump can handle it?
1344 params
=[("bfd_vma", "vma"), ("struct disassemble_info *", "info")],
1345 predefault
="default_print_insn",
1351 name
="skip_trampoline_code",
1352 params
=[("frame_info_ptr", "frame"), ("CORE_ADDR", "pc")],
1353 predefault
="generic_skip_trampoline_code",
1358 comment
="Vtable of solib operations functions.",
1359 type="const struct target_so_ops *",
1361 predefault
="&solib_target_so_ops",
1362 printer
="host_address_to_string (gdbarch->so_ops)",
1368 If in_solib_dynsym_resolve_code() returns true, and SKIP_SOLIB_RESOLVER
1369 evaluates non-zero, this is the address where the debugger will place
1370 a step-resume breakpoint to get us past the dynamic linker.
1373 name
="skip_solib_resolver",
1374 params
=[("CORE_ADDR", "pc")],
1375 predefault
="generic_skip_solib_resolver",
1381 Some systems also have trampoline code for returning from shared libs.
1384 name
="in_solib_return_trampoline",
1385 params
=[("CORE_ADDR", "pc"), ("const char *", "name")],
1386 predefault
="generic_in_solib_return_trampoline",
1392 Return true if PC lies inside an indirect branch thunk.
1395 name
="in_indirect_branch_thunk",
1396 params
=[("CORE_ADDR", "pc")],
1397 predefault
="default_in_indirect_branch_thunk",
1403 A target might have problems with watchpoints as soon as the stack
1404 frame of the current function has been destroyed. This mostly happens
1405 as the first action in a function's epilogue. stack_frame_destroyed_p()
1406 is defined to return a non-zero value if either the given addr is one
1407 instruction after the stack destroying instruction up to the trailing
1408 return instruction or if we can figure out that the stack frame has
1409 already been invalidated regardless of the value of addr. Targets
1410 which don't suffer from that problem could just let this functionality
1414 name
="stack_frame_destroyed_p",
1415 params
=[("CORE_ADDR", "addr")],
1416 predefault
="generic_stack_frame_destroyed_p",
1422 Process an ELF symbol in the minimal symbol table in a backend-specific
1423 way. Normally this hook is supposed to do nothing, however if required,
1424 then this hook can be used to apply tranformations to symbols that are
1425 considered special in some way. For example the MIPS backend uses it
1426 to interpret `st_other' information to mark compressed code symbols so
1427 that they can be treated in the appropriate manner in the processing of
1428 the main symbol table and DWARF-2 records.
1431 name
="elf_make_msymbol_special",
1432 params
=[("asymbol *", "sym"), ("struct minimal_symbol *", "msym")],
1438 name
="coff_make_msymbol_special",
1439 params
=[("int", "val"), ("struct minimal_symbol *", "msym")],
1440 predefault
="default_coff_make_msymbol_special",
1446 Process a symbol in the main symbol table in a backend-specific way.
1447 Normally this hook is supposed to do nothing, however if required,
1448 then this hook can be used to apply tranformations to symbols that
1449 are considered special in some way. This is currently used by the
1450 MIPS backend to make sure compressed code symbols have the ISA bit
1451 set. This in turn is needed for symbol values seen in GDB to match
1452 the values used at the runtime by the program itself, for function
1453 and label references.
1456 name
="make_symbol_special",
1457 params
=[("struct symbol *", "sym"), ("struct objfile *", "objfile")],
1458 predefault
="default_make_symbol_special",
1464 Adjust the address retrieved from a DWARF-2 record other than a line
1465 entry in a backend-specific way. Normally this hook is supposed to
1466 return the address passed unchanged, however if that is incorrect for
1467 any reason, then this hook can be used to fix the address up in the
1468 required manner. This is currently used by the MIPS backend to make
1469 sure addresses in FDE, range records, etc. referring to compressed
1470 code have the ISA bit set, matching line information and the symbol
1474 name
="adjust_dwarf2_addr",
1475 params
=[("CORE_ADDR", "pc")],
1476 predefault
="default_adjust_dwarf2_addr",
1482 Adjust the address updated by a line entry in a backend-specific way.
1483 Normally this hook is supposed to return the address passed unchanged,
1484 however in the case of inconsistencies in these records, this hook can
1485 be used to fix them up in the required manner. This is currently used
1486 by the MIPS backend to make sure all line addresses in compressed code
1487 are presented with the ISA bit set, which is not always the case. This
1488 in turn ensures breakpoint addresses are correctly matched against the
1492 name
="adjust_dwarf2_line",
1493 params
=[("CORE_ADDR", "addr"), ("int", "rel")],
1494 predefault
="default_adjust_dwarf2_line",
1500 name
="cannot_step_breakpoint",
1507 See comment in target.h about continuable, steppable and
1508 non-steppable watchpoints.
1511 name
="have_nonsteppable_watchpoint",
1517 type="type_instance_flags",
1518 name
="address_class_type_flags",
1519 params
=[("int", "byte_size"), ("int", "dwarf2_addr_class")],
1524 type="const char *",
1525 name
="address_class_type_flags_to_name",
1526 params
=[("type_instance_flags", "type_flags")],
1532 Execute vendor-specific DWARF Call Frame Instruction. OP is the instruction.
1533 FS are passed from the generic execute_cfa_program function.
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",
1544 Return the appropriate type_flags for the supplied address class.
1545 This function should return true if the address class was recognized and
1546 type_flags was set, false otherwise.
1549 name
="address_class_name_to_type_flags",
1550 params
=[("const char *", "name"), ("type_instance_flags *", "type_flags_ptr")],
1556 Is a register in a group
1559 name
="register_reggroup_p",
1560 params
=[("int", "regnum"), ("const struct reggroup *", "reggroup")],
1561 predefault
="default_register_reggroup_p",
1567 Fetch the pointer to the ith function argument.
1570 name
="fetch_pointer_argument",
1572 ("frame_info_ptr", "frame"),
1574 ("struct type *", "type"),
1581 Iterate over all supported register notes in a core file. For each
1582 supported register note section, the iterator must call CB and pass
1583 CB_DATA unchanged. If REGCACHE is not NULL, the iterator can limit
1584 the supported register note sections based on the current register
1585 values. Otherwise it should enumerate all supported register note
1589 name
="iterate_over_regset_sections",
1591 ("iterate_over_regset_sections_cb *", "cb"),
1592 ("void *", "cb_data"),
1593 ("const struct regcache *", "regcache"),
1600 Create core file notes
1602 type="gdb::unique_xmalloc_ptr<char>",
1603 name
="make_corefile_notes",
1604 params
=[("bfd *", "obfd"), ("int *", "note_size")],
1610 Find core file memory regions
1613 name
="find_memory_regions",
1614 params
=[("find_memory_region_ftype", "func"), ("void *", "data")],
1620 Given a bfd OBFD, segment ADDRESS and SIZE, create a memory tag section to be dumped to a core file
1623 name
="create_memtag_section",
1624 params
=[("bfd *", "obfd"), ("CORE_ADDR", "address"), ("size_t", "size")],
1630 Given a memory tag section OSEC, fill OSEC's contents with the appropriate tag data
1633 name
="fill_memtag_section",
1634 params
=[("asection *", "osec")],
1640 Decode a memory tag SECTION and return the tags of type TYPE contained in
1641 the memory range [ADDRESS, ADDRESS + LENGTH).
1642 If no tags were found, return an empty vector.
1644 type="gdb::byte_vector",
1645 name
="decode_memtag_section",
1647 ("bfd_section *", "section"),
1649 ("CORE_ADDR", "address"),
1650 ("size_t", "length"),
1657 Read offset OFFSET of TARGET_OBJECT_LIBRARIES formatted shared libraries list from
1658 core file into buffer READBUF with length LEN. Return the number of bytes read
1659 (zero indicates failure).
1660 failed, otherwise, return the red length of READBUF.
1663 name
="core_xfer_shared_libraries",
1664 params
=[("gdb_byte *", "readbuf"), ("ULONGEST", "offset"), ("ULONGEST", "len")],
1670 Read offset OFFSET of TARGET_OBJECT_LIBRARIES_AIX formatted shared
1671 libraries list from core file into buffer READBUF with length LEN.
1672 Return the number of bytes read (zero indicates failure).
1675 name
="core_xfer_shared_libraries_aix",
1676 params
=[("gdb_byte *", "readbuf"), ("ULONGEST", "offset"), ("ULONGEST", "len")],
1682 How the core target converts a PTID from a core file to a string.
1685 name
="core_pid_to_str",
1686 params
=[("ptid_t", "ptid")],
1692 How the core target extracts the name of a thread from a core file.
1694 type="const char *",
1695 name
="core_thread_name",
1696 params
=[("struct thread_info *", "thr")],
1702 Read offset OFFSET of TARGET_OBJECT_SIGNAL_INFO signal information
1703 from core file into buffer READBUF with length LEN. Return the number
1704 of bytes read (zero indicates EOF, a negative value indicates failure).
1707 name
="core_xfer_siginfo",
1708 params
=[("gdb_byte *", "readbuf"), ("ULONGEST", "offset"), ("ULONGEST", "len")],
1714 Read x86 XSAVE layout information from core file into XSAVE_LAYOUT.
1715 Returns true if the layout was read successfully.
1718 name
="core_read_x86_xsave_layout",
1719 params
=[("x86_xsave_layout &", "xsave_layout")],
1725 BFD target to use when generating a core file.
1727 type="const char *",
1728 name
="gcore_bfd_target",
1730 printer
="pstring (gdbarch->gcore_bfd_target)",
1735 If the elements of C++ vtables are in-place function descriptors rather
1736 than normal function pointers (which may point to code or a descriptor),
1740 name
="vtable_function_descriptors",
1747 Set if the least significant bit of the delta is used instead of the least
1748 significant bit of the pfn for pointers to virtual member functions.
1751 name
="vbit_in_delta",
1757 Advance PC to next instruction in order to skip a permanent breakpoint.
1760 name
="skip_permanent_breakpoint",
1761 params
=[("struct regcache *", "regcache")],
1762 predefault
="default_skip_permanent_breakpoint",
1768 The maximum length of an instruction on this architecture in bytes.
1771 name
="max_insn_length",
1778 Copy the instruction at FROM to TO, and make any adjustments
1779 necessary to single-step it at that address.
1781 REGS holds the state the thread's registers will have before
1782 executing the copied instruction; the PC in REGS will refer to FROM,
1783 not the copy at TO. The caller should update it to point at TO later.
1785 Return a pointer to data of the architecture's choice to be passed
1786 to gdbarch_displaced_step_fixup.
1788 For a general explanation of displaced stepping and how GDB uses it,
1789 see the comments in infrun.c.
1791 The TO area is only guaranteed to have space for
1792 gdbarch_displaced_step_buffer_length (arch) octets, so this
1793 function must not write more octets than that to this area.
1795 If you do not provide this function, GDB assumes that the
1796 architecture does not support displaced stepping.
1798 If the instruction cannot execute out of line, return NULL. The
1799 core falls back to stepping past the instruction in-line instead in
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")],
1810 Return true if GDB should use hardware single-stepping to execute a displaced
1811 step instruction. If false, GDB will simply restart execution at the
1812 displaced instruction location, and it is up to the target to ensure GDB will
1813 receive control again (e.g. by placing a software breakpoint instruction into
1814 the displaced instruction buffer).
1816 The default implementation returns false on all targets that provide a
1817 gdbarch_software_single_step routine, and true otherwise.
1820 name
="displaced_step_hw_singlestep",
1822 predefault
="default_displaced_step_hw_singlestep",
1828 Fix up the state after attempting to single-step a displaced
1829 instruction, to give the result we would have gotten from stepping the
1830 instruction in its original location.
1832 REGS is the register state resulting from single-stepping the
1833 displaced instruction.
1835 CLOSURE is the result from the matching call to
1836 gdbarch_displaced_step_copy_insn.
1838 FROM is the address where the instruction was original located, TO is
1839 the address of the displaced buffer where the instruction was copied
1842 COMPLETED_P is true if GDB stopped as a result of the requested step
1843 having completed (e.g. the inferior stopped with SIGTRAP), otherwise
1844 COMPLETED_P is false and GDB stopped for some other reason. In the
1845 case where a single instruction is expanded to multiple replacement
1846 instructions for stepping then it may be necessary to read the current
1847 program counter from REGS in order to decide how far through the
1848 series of replacement instructions the inferior got before stopping,
1849 this may impact what will need fixing up in this function.
1851 For a general explanation of displaced stepping and how GDB uses it,
1852 see the comments in infrun.c.
1855 name
="displaced_step_fixup",
1857 ("struct displaced_step_copy_insn_closure *", "closure"),
1858 ("CORE_ADDR", "from"),
1859 ("CORE_ADDR", "to"),
1860 ("struct regcache *", "regs"),
1861 ("bool", "completed_p"),
1865 invalid
="(gdbarch->displaced_step_copy_insn == nullptr) != (gdbarch->displaced_step_fixup == nullptr)",
1870 Prepare THREAD for it to displaced step the instruction at its current PC.
1872 Throw an exception if any unexpected error happens.
1874 type="displaced_step_prepare_status",
1875 name
="displaced_step_prepare",
1876 params
=[("thread_info *", "thread"), ("CORE_ADDR &", "displaced_pc")],
1882 Clean up after a displaced step of THREAD.
1884 It is possible for the displaced-stepped instruction to have caused
1885 the thread to exit. The implementation can detect this case by
1886 checking if WS.kind is TARGET_WAITKIND_THREAD_EXITED.
1888 type="displaced_step_finish_status",
1889 name
="displaced_step_finish",
1890 params
=[("thread_info *", "thread"), ("const target_waitstatus &", "ws")],
1892 invalid
="(! gdbarch->displaced_step_finish) != (! gdbarch->displaced_step_prepare)",
1897 Return the closure associated to the displaced step buffer that is at ADDR.
1899 type="const displaced_step_copy_insn_closure *",
1900 name
="displaced_step_copy_insn_closure_by_addr",
1901 params
=[("inferior *", "inf"), ("CORE_ADDR", "addr")],
1907 PARENT_INF has forked and CHILD_PTID is the ptid of the child. Restore the
1908 contents of all displaced step buffers in the child's address space.
1911 name
="displaced_step_restore_all_in_ptid",
1912 params
=[("inferior *", "parent_inf"), ("ptid_t", "child_ptid")],
1918 The maximum length in octets required for a displaced-step instruction
1919 buffer. By default this will be the same as gdbarch::max_insn_length,
1920 but should be overridden for architectures that might expand a
1921 displaced-step instruction to multiple replacement instructions.
1924 name
="displaced_step_buffer_length",
1926 postdefault
="gdbarch->max_insn_length",
1927 invalid
="gdbarch->displaced_step_buffer_length < gdbarch->max_insn_length",
1932 Relocate an instruction to execute at a different address. OLDLOC
1933 is the address in the inferior memory where the instruction to
1934 relocate is currently at. On input, TO points to the destination
1935 where we want the instruction to be copied (and possibly adjusted)
1936 to. On output, it points to one past the end of the resulting
1937 instruction(s). The effect of executing the instruction at TO shall
1938 be the same as if executing it at FROM. For example, call
1939 instructions that implicitly push the return address on the stack
1940 should be adjusted to return to the instruction after OLDLOC;
1941 relative branches, and other PC-relative instructions need the
1942 offset adjusted; etc.
1945 name
="relocate_instruction",
1946 params
=[("CORE_ADDR *", "to"), ("CORE_ADDR", "from")],
1953 Refresh overlay mapped state for section OSECT.
1956 name
="overlay_update",
1957 params
=[("struct obj_section *", "osect")],
1962 type="const struct target_desc *",
1963 name
="core_read_description",
1964 params
=[("struct target_ops *", "target"), ("bfd *", "abfd")],
1970 Set if the address in N_SO or N_FUN stabs may be zero.
1973 name
="sofun_address_maybe_missing",
1980 Parse the instruction at ADDR storing in the record execution log
1981 the registers REGCACHE and memory ranges that will be affected when
1982 the instruction executes, along with their current values.
1983 Return -1 if something goes wrong, 0 otherwise.
1986 name
="process_record",
1987 params
=[("struct regcache *", "regcache"), ("CORE_ADDR", "addr")],
1993 Save process state after a signal.
1994 Return -1 if something goes wrong, 0 otherwise.
1997 name
="process_record_signal",
1998 params
=[("struct regcache *", "regcache"), ("enum gdb_signal", "signal")],
2004 Signal translation: translate inferior's signal (target's) number
2005 into GDB's representation. The implementation of this method must
2006 be host independent. IOW, don't rely on symbols of the NAT_FILE
2007 header (the nm-*.h files), the host <signal.h> header, or similar
2008 headers. This is mainly used when cross-debugging core files ---
2009 "Live" targets hide the translation behind the target interface
2010 (target_wait, target_resume, etc.).
2012 type="enum gdb_signal",
2013 name
="gdb_signal_from_target",
2014 params
=[("int", "signo")],
2020 Signal translation: translate the GDB's internal signal number into
2021 the inferior's signal (target's) representation. The implementation
2022 of this method must be host independent. IOW, don't rely on symbols
2023 of the NAT_FILE header (the nm-*.h files), the host <signal.h>
2024 header, or similar headers.
2025 Return the target signal number if found, or -1 if the GDB internal
2026 signal number is invalid.
2029 name
="gdb_signal_to_target",
2030 params
=[("enum gdb_signal", "signal")],
2036 Extra signal info inspection.
2038 Return a type suitable to inspect extra signal information.
2040 type="struct type *",
2041 name
="get_siginfo_type",
2048 Record architecture-specific information from the symbol table.
2051 name
="record_special_symbol",
2052 params
=[("struct objfile *", "objfile"), ("asymbol *", "sym")],
2058 Function for the 'catch syscall' feature.
2059 Get architecture-specific system calls information from registers.
2062 name
="get_syscall_number",
2063 params
=[("thread_info *", "thread")],
2069 The filename of the XML syscall for this architecture.
2071 type="const char *",
2072 name
="xml_syscall_file",
2074 printer
="pstring (gdbarch->xml_syscall_file)",
2079 Information about system calls from this architecture
2081 type="struct syscalls_info *",
2082 name
="syscalls_info",
2084 printer
="host_address_to_string (gdbarch->syscalls_info)",
2089 SystemTap related fields and functions.
2090 A NULL-terminated array of prefixes used to mark an integer constant
2091 on the architecture's assembly.
2092 For example, on x86 integer constants are written as:
2094 $10 ;; integer constant 10
2096 in this case, this prefix would be the character `$'.
2098 type="const char *const *",
2099 name
="stap_integer_prefixes",
2101 printer
="pstring_list (gdbarch->stap_integer_prefixes)",
2106 A NULL-terminated array of suffixes used to mark an integer constant
2107 on the architecture's assembly.
2109 type="const char *const *",
2110 name
="stap_integer_suffixes",
2112 printer
="pstring_list (gdbarch->stap_integer_suffixes)",
2117 A NULL-terminated array of prefixes used to mark a register name on
2118 the architecture's assembly.
2119 For example, on x86 the register name is written as:
2121 %eax ;; register eax
2123 in this case, this prefix would be the character `%'.
2125 type="const char *const *",
2126 name
="stap_register_prefixes",
2128 printer
="pstring_list (gdbarch->stap_register_prefixes)",
2133 A NULL-terminated array of suffixes used to mark a register name on
2134 the architecture's assembly.
2136 type="const char *const *",
2137 name
="stap_register_suffixes",
2139 printer
="pstring_list (gdbarch->stap_register_suffixes)",
2144 A NULL-terminated array of prefixes used to mark a register
2145 indirection on the architecture's assembly.
2146 For example, on x86 the register indirection is written as:
2148 (%eax) ;; indirecting eax
2150 in this case, this prefix would be the charater `('.
2152 Please note that we use the indirection prefix also for register
2153 displacement, e.g., `4(%eax)' on x86.
2155 type="const char *const *",
2156 name
="stap_register_indirection_prefixes",
2158 printer
="pstring_list (gdbarch->stap_register_indirection_prefixes)",
2163 A NULL-terminated array of suffixes used to mark a register
2164 indirection on the architecture's assembly.
2165 For example, on x86 the register indirection is written as:
2167 (%eax) ;; indirecting eax
2169 in this case, this prefix would be the charater `)'.
2171 Please note that we use the indirection suffix also for register
2172 displacement, e.g., `4(%eax)' on x86.
2174 type="const char *const *",
2175 name
="stap_register_indirection_suffixes",
2177 printer
="pstring_list (gdbarch->stap_register_indirection_suffixes)",
2182 Prefix(es) used to name a register using GDB's nomenclature.
2184 For example, on PPC a register is represented by a number in the assembly
2185 language (e.g., `10' is the 10th general-purpose register). However,
2186 inside GDB this same register has an `r' appended to its name, so the 10th
2187 register would be represented as `r10' internally.
2189 type="const char *",
2190 name
="stap_gdb_register_prefix",
2192 printer
="pstring (gdbarch->stap_gdb_register_prefix)",
2197 Suffix used to name a register using GDB's nomenclature.
2199 type="const char *",
2200 name
="stap_gdb_register_suffix",
2202 printer
="pstring (gdbarch->stap_gdb_register_suffix)",
2207 Check if S is a single operand.
2209 Single operands can be:
2210 - Literal integers, e.g. `$10' on x86
2211 - Register access, e.g. `%eax' on x86
2212 - Register indirection, e.g. `(%eax)' on x86
2213 - Register displacement, e.g. `4(%eax)' on x86
2215 This function should check for these patterns on the string
2216 and return 1 if some were found, or zero otherwise. Please try to match
2217 as much info as you can from the string, i.e., if you have to match
2218 something like `(%', do not match just the `('.
2221 name
="stap_is_single_operand",
2222 params
=[("const char *", "s")],
2228 Function used to handle a "special case" in the parser.
2230 A "special case" is considered to be an unknown token, i.e., a token
2231 that the parser does not know how to parse. A good example of special
2232 case would be ARM's register displacement syntax:
2234 [R0, #4] ;; displacing R0 by 4
2236 Since the parser assumes that a register displacement is of the form:
2238 <number> <indirection_prefix> <register_name> <indirection_suffix>
2240 it means that it will not be able to recognize and parse this odd syntax.
2241 Therefore, we should add a special case function that will handle this token.
2243 This function should generate the proper expression form of the expression
2244 using GDB's internal expression mechanism (e.g., `write_exp_elt_opcode'
2245 and so on). It should also return 1 if the parsing was successful, or zero
2246 if the token was not recognized as a special token (in this case, returning
2247 zero means that the special parser is deferring the parsing to the generic
2248 parser), and should advance the buffer pointer (p->arg).
2250 type="expr::operation_up",
2251 name
="stap_parse_special_token",
2252 params
=[("struct stap_parse_info *", "p")],
2258 Perform arch-dependent adjustments to a register name.
2260 In very specific situations, it may be necessary for the register
2261 name present in a SystemTap probe's argument to be handled in a
2262 special way. For example, on i386, GCC may over-optimize the
2263 register allocation and use smaller registers than necessary. In
2264 such cases, the client that is reading and evaluating the SystemTap
2265 probe (ourselves) will need to actually fetch values from the wider
2266 version of the register in question.
2268 To illustrate the example, consider the following probe argument
2273 This argument says that its value can be found at the %ax register,
2274 which is a 16-bit register. However, the argument's prefix says
2275 that its type is "uint32_t", which is 32-bit in size. Therefore, in
2276 this case, GDB should actually fetch the probe's value from register
2277 %eax, not %ax. In this scenario, this function would actually
2278 replace the register name from %ax to %eax.
2280 The rationale for this can be found at PR breakpoints/24541.
2283 name
="stap_adjust_register",
2285 ("struct stap_parse_info *", "p"),
2286 ("const std::string &", "regname"),
2294 DTrace related functions.
2295 The expression to compute the NARTGth+1 argument to a DTrace USDT probe.
2298 type="expr::operation_up",
2299 name
="dtrace_parse_probe_argument",
2300 params
=[("int", "narg")],
2306 True if the given ADDR does not contain the instruction sequence
2307 corresponding to a disabled DTrace is-enabled probe.
2310 name
="dtrace_probe_is_enabled",
2311 params
=[("CORE_ADDR", "addr")],
2317 Enable a DTrace is-enabled probe at ADDR.
2320 name
="dtrace_enable_probe",
2321 params
=[("CORE_ADDR", "addr")],
2327 Disable a DTrace is-enabled probe at ADDR.
2330 name
="dtrace_disable_probe",
2331 params
=[("CORE_ADDR", "addr")],
2337 True if the list of shared libraries is one and only for all
2338 processes, as opposed to a list of shared libraries per inferior.
2339 This usually means that all processes, although may or may not share
2340 an address space, will see the same set of symbols at the same
2344 name
="has_global_solist",
2351 On some targets, even though each inferior has its own private
2352 address space, the debug interface takes care of making breakpoints
2353 visible to all address spaces automatically. For such cases,
2354 this property should be set to true.
2357 name
="has_global_breakpoints",
2364 True if inferiors share an address space (e.g., uClinux).
2367 name
="has_shared_address_space",
2369 predefault
="default_has_shared_address_space",
2375 True if a fast tracepoint can be set at an address.
2378 name
="fast_tracepoint_valid_at",
2379 params
=[("CORE_ADDR", "addr"), ("std::string *", "msg")],
2380 predefault
="default_fast_tracepoint_valid_at",
2386 Guess register state based on tracepoint location. Used for tracepoints
2387 where no registers have been collected, but there's only one location,
2388 allowing us to guess the PC value, and perhaps some other registers.
2389 On entry, regcache has all registers marked as unavailable.
2392 name
="guess_tracepoint_registers",
2393 params
=[("struct regcache *", "regcache"), ("CORE_ADDR", "addr")],
2394 predefault
="default_guess_tracepoint_registers",
2400 Return the "auto" target charset.
2402 type="const char *",
2403 name
="auto_charset",
2405 predefault
="default_auto_charset",
2411 Return the "auto" target wide charset.
2413 type="const char *",
2414 name
="auto_wide_charset",
2416 predefault
="default_auto_wide_charset",
2422 If non-empty, this is a file extension that will be opened in place
2423 of the file extension reported by the shared library list.
2425 This is most useful for toolchains that use a post-linker tool,
2426 where the names of the files run on the target differ in extension
2427 compared to the names of the files GDB should load for debug info.
2429 type="const char *",
2430 name
="solib_symbols_extension",
2432 printer
="pstring (gdbarch->solib_symbols_extension)",
2437 If true, the target OS has DOS-based file system semantics. That
2438 is, absolute paths include a drive name, and the backslash is
2439 considered a directory separator.
2442 name
="has_dos_based_file_system",
2449 Generate bytecodes to collect the return address in a frame.
2450 Since the bytecodes run on the target, possibly with GDB not even
2451 connected, the full unwinding machinery is not available, and
2452 typically this function will issue bytecodes for one or more likely
2453 places that the return address may be found.
2456 name
="gen_return_address",
2458 ("struct agent_expr *", "ax"),
2459 ("struct axs_value *", "value"),
2460 ("CORE_ADDR", "scope"),
2462 predefault
="default_gen_return_address",
2468 Implement the "info proc" command.
2472 params
=[("const char *", "args"), ("enum info_proc_what", "what")],
2478 Implement the "info proc" command for core files. Noe that there
2479 are two "info_proc"-like methods on gdbarch -- one for core files,
2480 one for live targets.
2483 name
="core_info_proc",
2484 params
=[("const char *", "args"), ("enum info_proc_what", "what")],
2490 Iterate over all objfiles in the order that makes the most sense
2491 for the architecture to make global symbol searches.
2493 CB is a callback function passed an objfile to be searched. The iteration stops
2494 if this function returns nonzero.
2496 If not NULL, CURRENT_OBJFILE corresponds to the objfile being
2497 inspected when the symbol search was requested.
2500 name
="iterate_over_objfiles_in_search_order",
2502 ("iterate_over_objfiles_in_search_order_cb_ftype", "cb"),
2503 ("struct objfile *", "current_objfile"),
2505 predefault
="default_iterate_over_objfiles_in_search_order",
2511 Ravenscar arch-dependent ops.
2513 type="struct ravenscar_arch_ops *",
2514 name
="ravenscar_ops",
2517 printer
="host_address_to_string (gdbarch->ravenscar_ops)",
2522 Return non-zero if the instruction at ADDR is a call; zero otherwise.
2525 name
="insn_is_call",
2526 params
=[("CORE_ADDR", "addr")],
2527 predefault
="default_insn_is_call",
2533 Return non-zero if the instruction at ADDR is a return; zero otherwise.
2537 params
=[("CORE_ADDR", "addr")],
2538 predefault
="default_insn_is_ret",
2544 Return non-zero if the instruction at ADDR is a jump; zero otherwise.
2547 name
="insn_is_jump",
2548 params
=[("CORE_ADDR", "addr")],
2549 predefault
="default_insn_is_jump",
2555 Return true if there's a program/permanent breakpoint planted in
2556 memory at ADDRESS, return false otherwise.
2559 name
="program_breakpoint_here_p",
2560 params
=[("CORE_ADDR", "address")],
2561 predefault
="default_program_breakpoint_here_p",
2567 Read one auxv entry from *READPTR, not reading locations >= ENDPTR.
2568 Return 0 if *READPTR is already at the end of the buffer.
2569 Return -1 if there is insufficient buffer for a whole entry.
2570 Return 1 if an entry was read into *TYPEP and *VALP.
2575 ("const gdb_byte **", "readptr"),
2576 ("const gdb_byte *", "endptr"),
2577 ("CORE_ADDR *", "typep"),
2578 ("CORE_ADDR *", "valp"),
2585 Print the description of a single auxv entry described by TYPE and VAL
2589 name
="print_auxv_entry",
2590 params
=[("struct ui_file *", "file"), ("CORE_ADDR", "type"), ("CORE_ADDR", "val")],
2591 predefault
="default_print_auxv_entry",
2597 Find the address range of the current inferior's vsyscall/vDSO, and
2598 write it to *RANGE. If the vsyscall's length can't be determined, a
2599 range with zero length is returned. Returns true if the vsyscall is
2600 found, false otherwise.
2603 name
="vsyscall_range",
2604 params
=[("struct mem_range *", "range")],
2605 predefault
="default_vsyscall_range",
2611 Allocate SIZE bytes of PROT protected page aligned memory in inferior.
2612 PROT has GDB_MMAP_PROT_* bitmask format.
2613 Throw an error if it is not possible. Returned address is always valid.
2616 name
="infcall_mmap",
2617 params
=[("CORE_ADDR", "size"), ("unsigned", "prot")],
2618 predefault
="default_infcall_mmap",
2624 Deallocate SIZE bytes of memory at ADDR in inferior from gdbarch_infcall_mmap.
2625 Print a warning if it is not possible.
2628 name
="infcall_munmap",
2629 params
=[("CORE_ADDR", "addr"), ("CORE_ADDR", "size")],
2630 predefault
="default_infcall_munmap",
2636 Return string (caller has to use xfree for it) with options for GCC
2637 to produce code for this target, typically "-m64", "-m32" or "-m31".
2638 These options are put before CU's DW_AT_producer compilation options so that
2639 they can override it.
2642 name
="gcc_target_options",
2644 predefault
="default_gcc_target_options",
2650 Return a regular expression that matches names used by this
2651 architecture in GNU configury triplets. The result is statically
2652 allocated and must not be freed. The default implementation simply
2653 returns the BFD architecture name, which is correct in nearly every
2656 type="const char *",
2657 name
="gnu_triplet_regexp",
2659 predefault
="default_gnu_triplet_regexp",
2665 Return the size in 8-bit bytes of an addressable memory unit on this
2666 architecture. This corresponds to the number of 8-bit bytes associated to
2667 each address in memory.
2670 name
="addressable_memory_unit_size",
2672 predefault
="default_addressable_memory_unit_size",
2678 Functions for allowing a target to modify its disassembler options.
2680 type="const char *",
2681 name
="disassembler_options_implicit",
2683 printer
="pstring (gdbarch->disassembler_options_implicit)",
2688 name
="disassembler_options",
2690 printer
="pstring_ptr (gdbarch->disassembler_options)",
2694 type="const disasm_options_and_args_t *",
2695 name
="valid_disassembler_options",
2697 printer
="host_address_to_string (gdbarch->valid_disassembler_options)",
2702 Type alignment override method. Return the architecture specific
2703 alignment required for TYPE. If there is no special handling
2704 required for TYPE then return the value 0, GDB will then apply the
2705 default rules as laid out in gdbtypes.c:type_align.
2709 params
=[("struct type *", "type")],
2710 predefault
="default_type_align",
2716 Return a string containing any flags for the given PC in the given FRAME.
2719 name
="get_pc_address_flags",
2720 params
=[("frame_info_ptr", "frame"), ("CORE_ADDR", "pc")],
2721 predefault
="default_get_pc_address_flags",
2727 Read core file mappings
2730 name
="read_core_file_mappings",
2732 ("struct bfd *", "cbfd"),
2733 ("read_core_file_mappings_pre_loop_ftype", "pre_loop_cb"),
2734 ("read_core_file_mappings_loop_ftype", "loop_cb"),
2736 predefault
="default_read_core_file_mappings",
2742 Return true if the target description for all threads should be read from the
2743 target description core file note(s). Return false if the target description
2744 for all threads should be inferred from the core file contents/sections.
2746 The corefile's bfd is passed through COREFILE_BFD.
2749 name
="use_target_description_from_corefile_notes",
2750 params
=[("struct bfd *", "corefile_bfd")],
2751 predefault
="default_use_target_description_from_corefile_notes",