3 # Architecture commands for GDB, the GNU debugger.
5 # Copyright (C) 1998-2016 Free Software Foundation, Inc.
7 # This file is part of GDB.
9 # This program is free software; you can redistribute it and/or modify
10 # it under the terms of the GNU General Public License as published by
11 # the Free Software Foundation; either version 3 of the License, or
12 # (at your option) any later version.
14 # This program is distributed in the hope that it will be useful,
15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 # GNU General Public License for more details.
19 # You should have received a copy of the GNU General Public License
20 # along with this program. If not, see <http://www.gnu.org/licenses/>.
22 # Make certain that the script is not running in an internationalized
25 LC_ALL=C ; export LC_ALL
33 echo "${file} missing? cp new-${file} ${file}" 1>&2
34 elif diff -u ${file} new-${file}
36 echo "${file} unchanged" 1>&2
38 echo "${file} has changed? cp new-${file} ${file}" 1>&2
43 # Format of the input table
44 read="class returntype function formal actual staticdefault predefault postdefault invalid_p print garbage_at_eol"
50 # On some SH's, 'read' trims leading and trailing whitespace by
51 # default (e.g., bash), while on others (e.g., dash), it doesn't.
52 # Set IFS to empty to disable the trimming everywhere.
53 while IFS='' read line
55 if test "${line}" = ""
58 elif test "${line}" = "#" -a "${comment}" = ""
61 elif expr "${line}" : "#" > /dev/null
67 # The semantics of IFS varies between different SH's. Some
68 # treat ``::' as three fields while some treat it as just too.
69 # Work around this by eliminating ``::'' ....
70 line="`echo "${line}" | sed -e 's/::/: :/g' -e 's/::/: :/g'`"
72 OFS="${IFS}" ; IFS="[:]"
73 eval read ${read} <<EOF
78 if test -n "${garbage_at_eol}"
80 echo "Garbage at end-of-line in ${line}" 1>&2
85 # .... and then going back through each field and strip out those
86 # that ended up with just that space character.
89 if eval test \"\${${r}}\" = \"\ \"
96 m ) staticdefault="${predefault}" ;;
97 M ) staticdefault="0" ;;
98 * ) test "${staticdefault}" || staticdefault=0 ;;
103 case "${invalid_p}" in
105 if test -n "${predefault}"
107 #invalid_p="gdbarch->${function} == ${predefault}"
108 predicate="gdbarch->${function} != ${predefault}"
109 elif class_is_variable_p
111 predicate="gdbarch->${function} != 0"
112 elif class_is_function_p
114 predicate="gdbarch->${function} != NULL"
118 echo "Predicate function ${function} with invalid_p." 1>&2
125 # PREDEFAULT is a valid fallback definition of MEMBER when
126 # multi-arch is not enabled. This ensures that the
127 # default value, when multi-arch is the same as the
128 # default value when not multi-arch. POSTDEFAULT is
129 # always a valid definition of MEMBER as this again
130 # ensures consistency.
132 if [ -n "${postdefault}" ]
134 fallbackdefault="${postdefault}"
135 elif [ -n "${predefault}" ]
137 fallbackdefault="${predefault}"
142 #NOT YET: See gdbarch.log for basic verification of
157 fallback_default_p ()
159 [ -n "${postdefault}" -a "x${invalid_p}" != "x0" ] \
160 || [ -n "${predefault}" -a "x${invalid_p}" = "x0" ]
163 class_is_variable_p ()
171 class_is_function_p ()
174 *f* | *F* | *m* | *M* ) true ;;
179 class_is_multiarch_p ()
187 class_is_predicate_p ()
190 *F* | *V* | *M* ) true ;;
204 # dump out/verify the doco
214 # F -> function + predicate
215 # hiding a function + predicate to test function validity
218 # V -> variable + predicate
219 # hiding a variable + predicate to test variables validity
221 # hiding something from the ``struct info'' object
222 # m -> multi-arch function
223 # hiding a multi-arch function (parameterised with the architecture)
224 # M -> multi-arch function + predicate
225 # hiding a multi-arch function + predicate to test function validity
229 # For functions, the return type; for variables, the data type
233 # For functions, the member function name; for variables, the
234 # variable name. Member function names are always prefixed with
235 # ``gdbarch_'' for name-space purity.
239 # The formal argument list. It is assumed that the formal
240 # argument list includes the actual name of each list element.
241 # A function with no arguments shall have ``void'' as the
242 # formal argument list.
246 # The list of actual arguments. The arguments specified shall
247 # match the FORMAL list given above. Functions with out
248 # arguments leave this blank.
252 # To help with the GDB startup a static gdbarch object is
253 # created. STATICDEFAULT is the value to insert into that
254 # static gdbarch object. Since this a static object only
255 # simple expressions can be used.
257 # If STATICDEFAULT is empty, zero is used.
261 # An initial value to assign to MEMBER of the freshly
262 # malloc()ed gdbarch object. After initialization, the
263 # freshly malloc()ed object is passed to the target
264 # architecture code for further updates.
266 # If PREDEFAULT is empty, zero is used.
268 # A non-empty PREDEFAULT, an empty POSTDEFAULT and a zero
269 # INVALID_P are specified, PREDEFAULT will be used as the
270 # default for the non- multi-arch target.
272 # A zero PREDEFAULT function will force the fallback to call
275 # Variable declarations can refer to ``gdbarch'' which will
276 # contain the current architecture. Care should be taken.
280 # A value to assign to MEMBER of the new gdbarch object should
281 # the target architecture code fail to change the PREDEFAULT
284 # If POSTDEFAULT is empty, no post update is performed.
286 # If both INVALID_P and POSTDEFAULT are non-empty then
287 # INVALID_P will be used to determine if MEMBER should be
288 # changed to POSTDEFAULT.
290 # If a non-empty POSTDEFAULT and a zero INVALID_P are
291 # specified, POSTDEFAULT will be used as the default for the
292 # non- multi-arch target (regardless of the value of
295 # You cannot specify both a zero INVALID_P and a POSTDEFAULT.
297 # Variable declarations can refer to ``gdbarch'' which
298 # will contain the current architecture. Care should be
303 # A predicate equation that validates MEMBER. Non-zero is
304 # returned if the code creating the new architecture failed to
305 # initialize MEMBER or the initialized the member is invalid.
306 # If POSTDEFAULT is non-empty then MEMBER will be updated to
307 # that value. If POSTDEFAULT is empty then internal_error()
310 # If INVALID_P is empty, a check that MEMBER is no longer
311 # equal to PREDEFAULT is used.
313 # The expression ``0'' disables the INVALID_P check making
314 # PREDEFAULT a legitimate value.
316 # See also PREDEFAULT and POSTDEFAULT.
320 # An optional expression that convers MEMBER to a value
321 # suitable for formatting using %s.
323 # If PRINT is empty, core_addr_to_string_nz (for CORE_ADDR)
324 # or plongest (anything else) is used.
326 garbage_at_eol ) : ;;
328 # Catches stray fields.
331 echo "Bad field ${field}"
339 # See below (DOCO) for description of each field
341 i:const struct bfd_arch_info *:bfd_arch_info:::&bfd_default_arch_struct::::gdbarch_bfd_arch_info (gdbarch)->printable_name
343 i:enum bfd_endian:byte_order:::BFD_ENDIAN_BIG
344 i:enum bfd_endian:byte_order_for_code:::BFD_ENDIAN_BIG
346 i:enum gdb_osabi:osabi:::GDB_OSABI_UNKNOWN
348 i:const struct target_desc *:target_desc:::::::host_address_to_string (gdbarch->target_desc)
350 # The bit byte-order has to do just with numbering of bits in debugging symbols
351 # and such. Conceptually, it's quite separate from byte/word byte order.
352 v:int:bits_big_endian:::1:(gdbarch->byte_order == BFD_ENDIAN_BIG)::0
354 # Number of bits in a char or unsigned char for the target machine.
355 # Just like CHAR_BIT in <limits.h> but describes the target machine.
356 # v:TARGET_CHAR_BIT:int:char_bit::::8 * sizeof (char):8::0:
358 # Number of bits in a short or unsigned short for the target machine.
359 v:int:short_bit:::8 * sizeof (short):2*TARGET_CHAR_BIT::0
360 # Number of bits in an int or unsigned int for the target machine.
361 v:int:int_bit:::8 * sizeof (int):4*TARGET_CHAR_BIT::0
362 # Number of bits in a long or unsigned long for the target machine.
363 v:int:long_bit:::8 * sizeof (long):4*TARGET_CHAR_BIT::0
364 # Number of bits in a long long or unsigned long long for the target
366 v:int:long_long_bit:::8 * sizeof (LONGEST):2*gdbarch->long_bit::0
367 # Alignment of a long long or unsigned long long for the target
369 v:int:long_long_align_bit:::8 * sizeof (LONGEST):2*gdbarch->long_bit::0
371 # The ABI default bit-size and format for "half", "float", "double", and
372 # "long double". These bit/format pairs should eventually be combined
373 # into a single object. For the moment, just initialize them as a pair.
374 # Each format describes both the big and little endian layouts (if
377 v:int:half_bit:::16:2*TARGET_CHAR_BIT::0
378 v:const struct floatformat **:half_format:::::floatformats_ieee_half::pformat (gdbarch->half_format)
379 v:int:float_bit:::8 * sizeof (float):4*TARGET_CHAR_BIT::0
380 v:const struct floatformat **:float_format:::::floatformats_ieee_single::pformat (gdbarch->float_format)
381 v:int:double_bit:::8 * sizeof (double):8*TARGET_CHAR_BIT::0
382 v:const struct floatformat **:double_format:::::floatformats_ieee_double::pformat (gdbarch->double_format)
383 v:int:long_double_bit:::8 * sizeof (long double):8*TARGET_CHAR_BIT::0
384 v:const struct floatformat **:long_double_format:::::floatformats_ieee_double::pformat (gdbarch->long_double_format)
386 # Returns the floating-point format to be used for values of length LENGTH.
387 # NAME, if non-NULL, is the type name, which may be used to distinguish
388 # different target formats of the same length.
389 m:const struct floatformat **:floatformat_for_type:const char *name, int length:name, length:0:default_floatformat_for_type::0
391 # For most targets, a pointer on the target and its representation as an
392 # address in GDB have the same size and "look the same". For such a
393 # target, you need only set gdbarch_ptr_bit and gdbarch_addr_bit
394 # / addr_bit will be set from it.
396 # If gdbarch_ptr_bit and gdbarch_addr_bit are different, you'll probably
397 # also need to set gdbarch_dwarf2_addr_size, gdbarch_pointer_to_address and
398 # gdbarch_address_to_pointer as well.
400 # ptr_bit is the size of a pointer on the target
401 v:int:ptr_bit:::8 * sizeof (void*):gdbarch->int_bit::0
402 # addr_bit is the size of a target address as represented in gdb
403 v:int:addr_bit:::8 * sizeof (void*):0:gdbarch_ptr_bit (gdbarch):
405 # dwarf2_addr_size is the target address size as used in the Dwarf debug
406 # info. For .debug_frame FDEs, this is supposed to be the target address
407 # size from the associated CU header, and which is equivalent to the
408 # DWARF2_ADDR_SIZE as defined by the target specific GCC back-end.
409 # Unfortunately there is no good way to determine this value. Therefore
410 # dwarf2_addr_size simply defaults to the target pointer size.
412 # dwarf2_addr_size is not used for .eh_frame FDEs, which are generally
413 # defined using the target's pointer size so far.
415 # Note that dwarf2_addr_size only needs to be redefined by a target if the
416 # GCC back-end defines a DWARF2_ADDR_SIZE other than the target pointer size,
417 # and if Dwarf versions < 4 need to be supported.
418 v:int:dwarf2_addr_size:::sizeof (void*):0:gdbarch_ptr_bit (gdbarch) / TARGET_CHAR_BIT:
420 # One if \`char' acts like \`signed char', zero if \`unsigned char'.
421 v:int:char_signed:::1:-1:1
423 F:CORE_ADDR:read_pc:struct regcache *regcache:regcache
424 F:void:write_pc:struct regcache *regcache, CORE_ADDR val:regcache, val
425 # Function for getting target's idea of a frame pointer. FIXME: GDB's
426 # whole scheme for dealing with "frames" and "frame pointers" needs a
428 m:void:virtual_frame_pointer:CORE_ADDR pc, int *frame_regnum, LONGEST *frame_offset:pc, frame_regnum, frame_offset:0:legacy_virtual_frame_pointer::0
430 M:enum register_status:pseudo_register_read:struct regcache *regcache, int cookednum, gdb_byte *buf:regcache, cookednum, buf
431 # Read a register into a new struct value. If the register is wholly
432 # or partly unavailable, this should call mark_value_bytes_unavailable
433 # as appropriate. If this is defined, then pseudo_register_read will
435 M:struct value *:pseudo_register_read_value:struct regcache *regcache, int cookednum:regcache, cookednum
436 M:void:pseudo_register_write:struct regcache *regcache, int cookednum, const gdb_byte *buf:regcache, cookednum, buf
438 v:int:num_regs:::0:-1
439 # This macro gives the number of pseudo-registers that live in the
440 # register namespace but do not get fetched or stored on the target.
441 # These pseudo-registers may be aliases for other registers,
442 # combinations of other registers, or they may be computed by GDB.
443 v:int:num_pseudo_regs:::0:0::0
445 # Assemble agent expression bytecode to collect pseudo-register REG.
446 # Return -1 if something goes wrong, 0 otherwise.
447 M:int:ax_pseudo_register_collect:struct agent_expr *ax, int reg:ax, reg
449 # Assemble agent expression bytecode to push the value of pseudo-register
450 # REG on the interpreter stack.
451 # Return -1 if something goes wrong, 0 otherwise.
452 M:int:ax_pseudo_register_push_stack:struct agent_expr *ax, int reg:ax, reg
454 # Some targets/architectures can do extra processing/display of
455 # segmentation faults. E.g., Intel MPX boundary faults.
456 # Call the architecture dependent function to handle the fault.
457 # UIOUT is the output stream where the handler will place information.
458 M:void:handle_segmentation_fault:struct ui_out *uiout:uiout
460 # GDB's standard (or well known) register numbers. These can map onto
461 # a real register or a pseudo (computed) register or not be defined at
463 # gdbarch_sp_regnum will hopefully be replaced by UNWIND_SP.
464 v:int:sp_regnum:::-1:-1::0
465 v:int:pc_regnum:::-1:-1::0
466 v:int:ps_regnum:::-1:-1::0
467 v:int:fp0_regnum:::0:-1::0
468 # Convert stab register number (from \`r\' declaration) to a gdb REGNUM.
469 m:int:stab_reg_to_regnum:int stab_regnr:stab_regnr::no_op_reg_to_regnum::0
470 # Provide a default mapping from a ecoff register number to a gdb REGNUM.
471 m:int:ecoff_reg_to_regnum:int ecoff_regnr:ecoff_regnr::no_op_reg_to_regnum::0
472 # Convert from an sdb register number to an internal gdb register number.
473 m:int:sdb_reg_to_regnum:int sdb_regnr:sdb_regnr::no_op_reg_to_regnum::0
474 # Provide a default mapping from a DWARF2 register number to a gdb REGNUM.
475 # Return -1 for bad REGNUM. Note: Several targets get this wrong.
476 m:int:dwarf2_reg_to_regnum:int dwarf2_regnr:dwarf2_regnr::no_op_reg_to_regnum::0
477 m:const char *:register_name:int regnr:regnr::0
479 # Return the type of a register specified by the architecture. Only
480 # the register cache should call this function directly; others should
481 # use "register_type".
482 M:struct type *:register_type:int reg_nr:reg_nr
484 M:struct frame_id:dummy_id:struct frame_info *this_frame:this_frame
485 # Implement DUMMY_ID and PUSH_DUMMY_CALL, then delete
486 # deprecated_fp_regnum.
487 v:int:deprecated_fp_regnum:::-1:-1::0
489 M:CORE_ADDR:push_dummy_call:struct value *function, struct regcache *regcache, CORE_ADDR bp_addr, int nargs, struct value **args, CORE_ADDR sp, int struct_return, CORE_ADDR struct_addr:function, regcache, bp_addr, nargs, args, sp, struct_return, struct_addr
490 v:int:call_dummy_location::::AT_ENTRY_POINT::0
491 M:CORE_ADDR:push_dummy_code:CORE_ADDR sp, CORE_ADDR funaddr, struct value **args, int nargs, struct type *value_type, CORE_ADDR *real_pc, CORE_ADDR *bp_addr, struct regcache *regcache:sp, funaddr, args, nargs, value_type, real_pc, bp_addr, regcache
493 # Return true if the code of FRAME is writable.
494 m:int:code_of_frame_writable:struct frame_info *frame:frame::default_code_of_frame_writable::0
496 m:void:print_registers_info:struct ui_file *file, struct frame_info *frame, int regnum, int all:file, frame, regnum, all::default_print_registers_info::0
497 m:void:print_float_info:struct ui_file *file, struct frame_info *frame, const char *args:file, frame, args::default_print_float_info::0
498 M:void:print_vector_info:struct ui_file *file, struct frame_info *frame, const char *args:file, frame, args
499 # MAP a GDB RAW register number onto a simulator register number. See
500 # also include/...-sim.h.
501 m:int:register_sim_regno:int reg_nr:reg_nr::legacy_register_sim_regno::0
502 m:int:cannot_fetch_register:int regnum:regnum::cannot_register_not::0
503 m:int:cannot_store_register:int regnum:regnum::cannot_register_not::0
505 # Determine the address where a longjmp will land and save this address
506 # in PC. Return nonzero on success.
508 # FRAME corresponds to the longjmp frame.
509 F:int:get_longjmp_target:struct frame_info *frame, CORE_ADDR *pc:frame, pc
512 v:int:believe_pcc_promotion:::::::
514 m:int:convert_register_p:int regnum, struct type *type:regnum, type:0:generic_convert_register_p::0
515 f:int:register_to_value:struct frame_info *frame, int regnum, struct type *type, gdb_byte *buf, int *optimizedp, int *unavailablep:frame, regnum, type, buf, optimizedp, unavailablep:0
516 f:void:value_to_register:struct frame_info *frame, int regnum, struct type *type, const gdb_byte *buf:frame, regnum, type, buf:0
517 # Construct a value representing the contents of register REGNUM in
518 # frame FRAME_ID, interpreted as type TYPE. The routine needs to
519 # allocate and return a struct value with all value attributes
520 # (but not the value contents) filled in.
521 m:struct value *:value_from_register:struct type *type, int regnum, struct frame_id frame_id:type, regnum, frame_id::default_value_from_register::0
523 m:CORE_ADDR:pointer_to_address:struct type *type, const gdb_byte *buf:type, buf::unsigned_pointer_to_address::0
524 m:void:address_to_pointer:struct type *type, gdb_byte *buf, CORE_ADDR addr:type, buf, addr::unsigned_address_to_pointer::0
525 M:CORE_ADDR:integer_to_address:struct type *type, const gdb_byte *buf:type, buf
527 # Return the return-value convention that will be used by FUNCTION
528 # to return a value of type VALTYPE. FUNCTION may be NULL in which
529 # case the return convention is computed based only on VALTYPE.
531 # If READBUF is not NULL, extract the return value and save it in this buffer.
533 # If WRITEBUF is not NULL, it contains a return value which will be
534 # stored into the appropriate register. This can be used when we want
535 # to force the value returned by a function (see the "return" command
537 M:enum return_value_convention:return_value:struct value *function, struct type *valtype, struct regcache *regcache, gdb_byte *readbuf, const gdb_byte *writebuf:function, valtype, regcache, readbuf, writebuf
539 # Return true if the return value of function is stored in the first hidden
540 # parameter. In theory, this feature should be language-dependent, specified
541 # by language and its ABI, such as C++. Unfortunately, compiler may
542 # implement it to a target-dependent feature. So that we need such hook here
543 # to be aware of this in GDB.
544 m:int:return_in_first_hidden_param_p:struct type *type:type::default_return_in_first_hidden_param_p::0
546 m:CORE_ADDR:skip_prologue:CORE_ADDR ip:ip:0:0
547 M:CORE_ADDR:skip_main_prologue:CORE_ADDR ip:ip
548 # On some platforms, a single function may provide multiple entry points,
549 # e.g. one that is used for function-pointer calls and a different one
550 # that is used for direct function calls.
551 # In order to ensure that breakpoints set on the function will trigger
552 # no matter via which entry point the function is entered, a platform
553 # may provide the skip_entrypoint callback. It is called with IP set
554 # to the main entry point of a function (as determined by the symbol table),
555 # and should return the address of the innermost entry point, where the
556 # actual breakpoint needs to be set. Note that skip_entrypoint is used
557 # by GDB common code even when debugging optimized code, where skip_prologue
559 M:CORE_ADDR:skip_entrypoint:CORE_ADDR ip:ip
561 f:int:inner_than:CORE_ADDR lhs, CORE_ADDR rhs:lhs, rhs:0:0
562 m:const gdb_byte *:breakpoint_from_pc:CORE_ADDR *pcptr, int *lenptr:pcptr, lenptr:0:default_breakpoint_from_pc::0
564 # Return the breakpoint kind for this target based on *PCPTR.
565 m:int:breakpoint_kind_from_pc:CORE_ADDR *pcptr:pcptr::0:
567 # Return the software breakpoint from KIND. KIND can have target
568 # specific meaning like the Z0 kind parameter.
569 # SIZE is set to the software breakpoint's length in memory.
570 m:const gdb_byte *:sw_breakpoint_from_kind:int kind, int *size:kind, size::NULL::0
572 # Return the breakpoint kind for this target based on the current
573 # processor state (e.g. the current instruction mode on ARM) and the
574 # *PCPTR. In default, it is gdbarch->breakpoint_kind_from_pc.
575 m:int:breakpoint_kind_from_current_state:struct regcache *regcache, CORE_ADDR *pcptr:regcache, pcptr:0:default_breakpoint_kind_from_current_state::0
577 M:CORE_ADDR:adjust_breakpoint_address:CORE_ADDR bpaddr:bpaddr
578 m:int:memory_insert_breakpoint:struct bp_target_info *bp_tgt:bp_tgt:0:default_memory_insert_breakpoint::0
579 m:int:memory_remove_breakpoint:struct bp_target_info *bp_tgt:bp_tgt:0:default_memory_remove_breakpoint::0
580 v:CORE_ADDR:decr_pc_after_break:::0:::0
582 # A function can be addressed by either it's "pointer" (possibly a
583 # descriptor address) or "entry point" (first executable instruction).
584 # The method "convert_from_func_ptr_addr" converting the former to the
585 # latter. gdbarch_deprecated_function_start_offset is being used to implement
586 # a simplified subset of that functionality - the function's address
587 # corresponds to the "function pointer" and the function's start
588 # corresponds to the "function entry point" - and hence is redundant.
590 v:CORE_ADDR:deprecated_function_start_offset:::0:::0
592 # Return the remote protocol register number associated with this
593 # register. Normally the identity mapping.
594 m:int:remote_register_number:int regno:regno::default_remote_register_number::0
596 # Fetch the target specific address used to represent a load module.
597 F:CORE_ADDR:fetch_tls_load_module_address:struct objfile *objfile:objfile
599 v:CORE_ADDR:frame_args_skip:::0:::0
600 M:CORE_ADDR:unwind_pc:struct frame_info *next_frame:next_frame
601 M:CORE_ADDR:unwind_sp:struct frame_info *next_frame:next_frame
602 # DEPRECATED_FRAME_LOCALS_ADDRESS as been replaced by the per-frame
603 # frame-base. Enable frame-base before frame-unwind.
604 F:int:frame_num_args:struct frame_info *frame:frame
606 M:CORE_ADDR:frame_align:CORE_ADDR address:address
607 m:int:stabs_argument_has_addr:struct type *type:type::default_stabs_argument_has_addr::0
608 v:int:frame_red_zone_size
610 m:CORE_ADDR:convert_from_func_ptr_addr:CORE_ADDR addr, struct target_ops *targ:addr, targ::convert_from_func_ptr_addr_identity::0
611 # On some machines there are bits in addresses which are not really
612 # part of the address, but are used by the kernel, the hardware, etc.
613 # for special purposes. gdbarch_addr_bits_remove takes out any such bits so
614 # we get a "real" address such as one would find in a symbol table.
615 # This is used only for addresses of instructions, and even then I'm
616 # not sure it's used in all contexts. It exists to deal with there
617 # being a few stray bits in the PC which would mislead us, not as some
618 # sort of generic thing to handle alignment or segmentation (it's
619 # possible it should be in TARGET_READ_PC instead).
620 m:CORE_ADDR:addr_bits_remove:CORE_ADDR addr:addr::core_addr_identity::0
622 # FIXME/cagney/2001-01-18: This should be split in two. A target method that
623 # indicates if the target needs software single step. An ISA method to
626 # FIXME/cagney/2001-01-18: The logic is backwards. It should be asking if the
627 # target can single step. If not, then implement single step using breakpoints.
629 # A return value of 1 means that the software_single_step breakpoints
630 # were inserted; 0 means they were not. Multiple breakpoints may be
631 # inserted for some instructions such as conditional branch. However,
632 # each implementation must always evaluate the condition and only put
633 # the breakpoint at the branch destination if the condition is true, so
634 # that we ensure forward progress when stepping past a conditional
636 F:int:software_single_step:struct frame_info *frame:frame
638 # Return non-zero if the processor is executing a delay slot and a
639 # further single-step is needed before the instruction finishes.
640 M:int:single_step_through_delay:struct frame_info *frame:frame
641 # FIXME: cagney/2003-08-28: Need to find a better way of selecting the
642 # disassembler. Perhaps objdump can handle it?
643 f:int:print_insn:bfd_vma vma, struct disassemble_info *info:vma, info::0:
644 f:CORE_ADDR:skip_trampoline_code:struct frame_info *frame, CORE_ADDR pc:frame, pc::generic_skip_trampoline_code::0
647 # If in_solib_dynsym_resolve_code() returns true, and SKIP_SOLIB_RESOLVER
648 # evaluates non-zero, this is the address where the debugger will place
649 # a step-resume breakpoint to get us past the dynamic linker.
650 m:CORE_ADDR:skip_solib_resolver:CORE_ADDR pc:pc::generic_skip_solib_resolver::0
651 # Some systems also have trampoline code for returning from shared libs.
652 m:int:in_solib_return_trampoline:CORE_ADDR pc, const char *name:pc, name::generic_in_solib_return_trampoline::0
654 # A target might have problems with watchpoints as soon as the stack
655 # frame of the current function has been destroyed. This mostly happens
656 # as the first action in a function's epilogue. stack_frame_destroyed_p()
657 # is defined to return a non-zero value if either the given addr is one
658 # instruction after the stack destroying instruction up to the trailing
659 # return instruction or if we can figure out that the stack frame has
660 # already been invalidated regardless of the value of addr. Targets
661 # which don't suffer from that problem could just let this functionality
663 m:int:stack_frame_destroyed_p:CORE_ADDR addr:addr:0:generic_stack_frame_destroyed_p::0
664 # Process an ELF symbol in the minimal symbol table in a backend-specific
665 # way. Normally this hook is supposed to do nothing, however if required,
666 # then this hook can be used to apply tranformations to symbols that are
667 # considered special in some way. For example the MIPS backend uses it
668 # to interpret \`st_other' information to mark compressed code symbols so
669 # that they can be treated in the appropriate manner in the processing of
670 # the main symbol table and DWARF-2 records.
671 F:void:elf_make_msymbol_special:asymbol *sym, struct minimal_symbol *msym:sym, msym
672 f:void:coff_make_msymbol_special:int val, struct minimal_symbol *msym:val, msym::default_coff_make_msymbol_special::0
673 # Process a symbol in the main symbol table in a backend-specific way.
674 # Normally this hook is supposed to do nothing, however if required,
675 # then this hook can be used to apply tranformations to symbols that
676 # are considered special in some way. This is currently used by the
677 # MIPS backend to make sure compressed code symbols have the ISA bit
678 # set. This in turn is needed for symbol values seen in GDB to match
679 # the values used at the runtime by the program itself, for function
680 # and label references.
681 f:void:make_symbol_special:struct symbol *sym, struct objfile *objfile:sym, objfile::default_make_symbol_special::0
682 # Adjust the address retrieved from a DWARF-2 record other than a line
683 # entry in a backend-specific way. Normally this hook is supposed to
684 # return the address passed unchanged, however if that is incorrect for
685 # any reason, then this hook can be used to fix the address up in the
686 # required manner. This is currently used by the MIPS backend to make
687 # sure addresses in FDE, range records, etc. referring to compressed
688 # code have the ISA bit set, matching line information and the symbol
690 f:CORE_ADDR:adjust_dwarf2_addr:CORE_ADDR pc:pc::default_adjust_dwarf2_addr::0
691 # Adjust the address updated by a line entry in a backend-specific way.
692 # Normally this hook is supposed to return the address passed unchanged,
693 # however in the case of inconsistencies in these records, this hook can
694 # be used to fix them up in the required manner. This is currently used
695 # by the MIPS backend to make sure all line addresses in compressed code
696 # are presented with the ISA bit set, which is not always the case. This
697 # in turn ensures breakpoint addresses are correctly matched against the
699 f:CORE_ADDR:adjust_dwarf2_line:CORE_ADDR addr, int rel:addr, rel::default_adjust_dwarf2_line::0
700 v:int:cannot_step_breakpoint:::0:0::0
701 v:int:have_nonsteppable_watchpoint:::0:0::0
702 F:int:address_class_type_flags:int byte_size, int dwarf2_addr_class:byte_size, dwarf2_addr_class
703 M:const char *:address_class_type_flags_to_name:int type_flags:type_flags
705 # Return the appropriate type_flags for the supplied address class.
706 # This function should return 1 if the address class was recognized and
707 # type_flags was set, zero otherwise.
708 M:int:address_class_name_to_type_flags:const char *name, int *type_flags_ptr:name, type_flags_ptr
709 # Is a register in a group
710 m:int:register_reggroup_p:int regnum, struct reggroup *reggroup:regnum, reggroup::default_register_reggroup_p::0
711 # Fetch the pointer to the ith function argument.
712 F:CORE_ADDR:fetch_pointer_argument:struct frame_info *frame, int argi, struct type *type:frame, argi, type
714 # Iterate over all supported register notes in a core file. For each
715 # supported register note section, the iterator must call CB and pass
716 # CB_DATA unchanged. If REGCACHE is not NULL, the iterator can limit
717 # the supported register note sections based on the current register
718 # values. Otherwise it should enumerate all supported register note
720 M:void:iterate_over_regset_sections:iterate_over_regset_sections_cb *cb, void *cb_data, const struct regcache *regcache:cb, cb_data, regcache
722 # Create core file notes
723 M:char *:make_corefile_notes:bfd *obfd, int *note_size:obfd, note_size
725 # The elfcore writer hook to use to write Linux prpsinfo notes to core
726 # files. Most Linux architectures use the same prpsinfo32 or
727 # prpsinfo64 layouts, and so won't need to provide this hook, as we
728 # call the Linux generic routines in bfd to write prpsinfo notes by
730 F:char *:elfcore_write_linux_prpsinfo:bfd *obfd, char *note_data, int *note_size, const struct elf_internal_linux_prpsinfo *info:obfd, note_data, note_size, info
732 # Find core file memory regions
733 M:int:find_memory_regions:find_memory_region_ftype func, void *data:func, data
735 # Read offset OFFSET of TARGET_OBJECT_LIBRARIES formatted shared libraries list from
736 # core file into buffer READBUF with length LEN. Return the number of bytes read
737 # (zero indicates failure).
738 # failed, otherwise, return the red length of READBUF.
739 M:ULONGEST:core_xfer_shared_libraries:gdb_byte *readbuf, ULONGEST offset, ULONGEST len:readbuf, offset, len
741 # Read offset OFFSET of TARGET_OBJECT_LIBRARIES_AIX formatted shared
742 # libraries list from core file into buffer READBUF with length LEN.
743 # Return the number of bytes read (zero indicates failure).
744 M:ULONGEST:core_xfer_shared_libraries_aix:gdb_byte *readbuf, ULONGEST offset, ULONGEST len:readbuf, offset, len
746 # How the core target converts a PTID from a core file to a string.
747 M:char *:core_pid_to_str:ptid_t ptid:ptid
749 # How the core target extracts the name of a thread from a core file.
750 M:const char *:core_thread_name:struct thread_info *thr:thr
752 # BFD target to use when generating a core file.
753 V:const char *:gcore_bfd_target:::0:0:::pstring (gdbarch->gcore_bfd_target)
755 # If the elements of C++ vtables are in-place function descriptors rather
756 # than normal function pointers (which may point to code or a descriptor),
758 v:int:vtable_function_descriptors:::0:0::0
760 # Set if the least significant bit of the delta is used instead of the least
761 # significant bit of the pfn for pointers to virtual member functions.
762 v:int:vbit_in_delta:::0:0::0
764 # Advance PC to next instruction in order to skip a permanent breakpoint.
765 f:void:skip_permanent_breakpoint:struct regcache *regcache:regcache:default_skip_permanent_breakpoint:default_skip_permanent_breakpoint::0
767 # The maximum length of an instruction on this architecture in bytes.
768 V:ULONGEST:max_insn_length:::0:0
770 # Copy the instruction at FROM to TO, and make any adjustments
771 # necessary to single-step it at that address.
773 # REGS holds the state the thread's registers will have before
774 # executing the copied instruction; the PC in REGS will refer to FROM,
775 # not the copy at TO. The caller should update it to point at TO later.
777 # Return a pointer to data of the architecture's choice to be passed
778 # to gdbarch_displaced_step_fixup. Or, return NULL to indicate that
779 # the instruction's effects have been completely simulated, with the
780 # resulting state written back to REGS.
782 # For a general explanation of displaced stepping and how GDB uses it,
783 # see the comments in infrun.c.
785 # The TO area is only guaranteed to have space for
786 # gdbarch_max_insn_length (arch) bytes, so this function must not
787 # write more bytes than that to that area.
789 # If you do not provide this function, GDB assumes that the
790 # architecture does not support displaced stepping.
792 # If your architecture doesn't need to adjust instructions before
793 # single-stepping them, consider using simple_displaced_step_copy_insn
796 # If the instruction cannot execute out of line, return NULL. The
797 # core falls back to stepping past the instruction in-line instead in
799 M:struct displaced_step_closure *:displaced_step_copy_insn:CORE_ADDR from, CORE_ADDR to, struct regcache *regs:from, to, regs
801 # Return true if GDB should use hardware single-stepping to execute
802 # the displaced instruction identified by CLOSURE. If false,
803 # GDB will simply restart execution at the displaced instruction
804 # location, and it is up to the target to ensure GDB will receive
805 # control again (e.g. by placing a software breakpoint instruction
806 # into the displaced instruction buffer).
808 # The default implementation returns false on all targets that
809 # provide a gdbarch_software_single_step routine, and true otherwise.
810 m:int:displaced_step_hw_singlestep:struct displaced_step_closure *closure:closure::default_displaced_step_hw_singlestep::0
812 # Fix up the state resulting from successfully single-stepping a
813 # displaced instruction, to give the result we would have gotten from
814 # stepping the instruction in its original location.
816 # REGS is the register state resulting from single-stepping the
817 # displaced instruction.
819 # CLOSURE is the result from the matching call to
820 # gdbarch_displaced_step_copy_insn.
822 # If you provide gdbarch_displaced_step_copy_insn.but not this
823 # function, then GDB assumes that no fixup is needed after
824 # single-stepping the instruction.
826 # For a general explanation of displaced stepping and how GDB uses it,
827 # see the comments in infrun.c.
828 M:void:displaced_step_fixup:struct displaced_step_closure *closure, CORE_ADDR from, CORE_ADDR to, struct regcache *regs:closure, from, to, regs::NULL
830 # Free a closure returned by gdbarch_displaced_step_copy_insn.
832 # If you provide gdbarch_displaced_step_copy_insn, you must provide
833 # this function as well.
835 # If your architecture uses closures that don't need to be freed, then
836 # you can use simple_displaced_step_free_closure here.
838 # For a general explanation of displaced stepping and how GDB uses it,
839 # see the comments in infrun.c.
840 m:void:displaced_step_free_closure:struct displaced_step_closure *closure:closure::NULL::(! gdbarch->displaced_step_free_closure) != (! gdbarch->displaced_step_copy_insn)
842 # Return the address of an appropriate place to put displaced
843 # instructions while we step over them. There need only be one such
844 # place, since we're only stepping one thread over a breakpoint at a
847 # For a general explanation of displaced stepping and how GDB uses it,
848 # see the comments in infrun.c.
849 m:CORE_ADDR:displaced_step_location:void:::NULL::(! gdbarch->displaced_step_location) != (! gdbarch->displaced_step_copy_insn)
851 # Relocate an instruction to execute at a different address. OLDLOC
852 # is the address in the inferior memory where the instruction to
853 # relocate is currently at. On input, TO points to the destination
854 # where we want the instruction to be copied (and possibly adjusted)
855 # to. On output, it points to one past the end of the resulting
856 # instruction(s). The effect of executing the instruction at TO shall
857 # be the same as if executing it at FROM. For example, call
858 # instructions that implicitly push the return address on the stack
859 # should be adjusted to return to the instruction after OLDLOC;
860 # relative branches, and other PC-relative instructions need the
861 # offset adjusted; etc.
862 M:void:relocate_instruction:CORE_ADDR *to, CORE_ADDR from:to, from::NULL
864 # Refresh overlay mapped state for section OSECT.
865 F:void:overlay_update:struct obj_section *osect:osect
867 M:const struct target_desc *:core_read_description:struct target_ops *target, bfd *abfd:target, abfd
869 # Handle special encoding of static variables in stabs debug info.
870 F:const char *:static_transform_name:const char *name:name
871 # Set if the address in N_SO or N_FUN stabs may be zero.
872 v:int:sofun_address_maybe_missing:::0:0::0
874 # Parse the instruction at ADDR storing in the record execution log
875 # the registers REGCACHE and memory ranges that will be affected when
876 # the instruction executes, along with their current values.
877 # Return -1 if something goes wrong, 0 otherwise.
878 M:int:process_record:struct regcache *regcache, CORE_ADDR addr:regcache, addr
880 # Save process state after a signal.
881 # Return -1 if something goes wrong, 0 otherwise.
882 M:int:process_record_signal:struct regcache *regcache, enum gdb_signal signal:regcache, signal
884 # Signal translation: translate inferior's signal (target's) number
885 # into GDB's representation. The implementation of this method must
886 # be host independent. IOW, don't rely on symbols of the NAT_FILE
887 # header (the nm-*.h files), the host <signal.h> header, or similar
888 # headers. This is mainly used when cross-debugging core files ---
889 # "Live" targets hide the translation behind the target interface
890 # (target_wait, target_resume, etc.).
891 M:enum gdb_signal:gdb_signal_from_target:int signo:signo
893 # Signal translation: translate the GDB's internal signal number into
894 # the inferior's signal (target's) representation. The implementation
895 # of this method must be host independent. IOW, don't rely on symbols
896 # of the NAT_FILE header (the nm-*.h files), the host <signal.h>
897 # header, or similar headers.
898 # Return the target signal number if found, or -1 if the GDB internal
899 # signal number is invalid.
900 M:int:gdb_signal_to_target:enum gdb_signal signal:signal
902 # Extra signal info inspection.
904 # Return a type suitable to inspect extra signal information.
905 M:struct type *:get_siginfo_type:void:
907 # Record architecture-specific information from the symbol table.
908 M:void:record_special_symbol:struct objfile *objfile, asymbol *sym:objfile, sym
910 # Function for the 'catch syscall' feature.
912 # Get architecture-specific system calls information from registers.
913 M:LONGEST:get_syscall_number:ptid_t ptid:ptid
915 # The filename of the XML syscall for this architecture.
916 v:const char *:xml_syscall_file:::0:0::0:pstring (gdbarch->xml_syscall_file)
918 # Information about system calls from this architecture
919 v:struct syscalls_info *:syscalls_info:::0:0::0:host_address_to_string (gdbarch->syscalls_info)
921 # SystemTap related fields and functions.
923 # A NULL-terminated array of prefixes used to mark an integer constant
924 # on the architecture's assembly.
925 # For example, on x86 integer constants are written as:
927 # \$10 ;; integer constant 10
929 # in this case, this prefix would be the character \`\$\'.
930 v:const char *const *:stap_integer_prefixes:::0:0::0:pstring_list (gdbarch->stap_integer_prefixes)
932 # A NULL-terminated array of suffixes used to mark an integer constant
933 # on the architecture's assembly.
934 v:const char *const *:stap_integer_suffixes:::0:0::0:pstring_list (gdbarch->stap_integer_suffixes)
936 # A NULL-terminated array of prefixes used to mark a register name on
937 # the architecture's assembly.
938 # For example, on x86 the register name is written as:
940 # \%eax ;; register eax
942 # in this case, this prefix would be the character \`\%\'.
943 v:const char *const *:stap_register_prefixes:::0:0::0:pstring_list (gdbarch->stap_register_prefixes)
945 # A NULL-terminated array of suffixes used to mark a register name on
946 # the architecture's assembly.
947 v:const char *const *:stap_register_suffixes:::0:0::0:pstring_list (gdbarch->stap_register_suffixes)
949 # A NULL-terminated array of prefixes used to mark a register
950 # indirection on the architecture's assembly.
951 # For example, on x86 the register indirection is written as:
953 # \(\%eax\) ;; indirecting eax
955 # in this case, this prefix would be the charater \`\(\'.
957 # Please note that we use the indirection prefix also for register
958 # displacement, e.g., \`4\(\%eax\)\' on x86.
959 v:const char *const *:stap_register_indirection_prefixes:::0:0::0:pstring_list (gdbarch->stap_register_indirection_prefixes)
961 # A NULL-terminated array of suffixes used to mark a register
962 # indirection on the architecture's assembly.
963 # For example, on x86 the register indirection is written as:
965 # \(\%eax\) ;; indirecting eax
967 # in this case, this prefix would be the charater \`\)\'.
969 # Please note that we use the indirection suffix also for register
970 # displacement, e.g., \`4\(\%eax\)\' on x86.
971 v:const char *const *:stap_register_indirection_suffixes:::0:0::0:pstring_list (gdbarch->stap_register_indirection_suffixes)
973 # Prefix(es) used to name a register using GDB's nomenclature.
975 # For example, on PPC a register is represented by a number in the assembly
976 # language (e.g., \`10\' is the 10th general-purpose register). However,
977 # inside GDB this same register has an \`r\' appended to its name, so the 10th
978 # register would be represented as \`r10\' internally.
979 v:const char *:stap_gdb_register_prefix:::0:0::0:pstring (gdbarch->stap_gdb_register_prefix)
981 # Suffix used to name a register using GDB's nomenclature.
982 v:const char *:stap_gdb_register_suffix:::0:0::0:pstring (gdbarch->stap_gdb_register_suffix)
984 # Check if S is a single operand.
986 # Single operands can be:
987 # \- Literal integers, e.g. \`\$10\' on x86
988 # \- Register access, e.g. \`\%eax\' on x86
989 # \- Register indirection, e.g. \`\(\%eax\)\' on x86
990 # \- Register displacement, e.g. \`4\(\%eax\)\' on x86
992 # This function should check for these patterns on the string
993 # and return 1 if some were found, or zero otherwise. Please try to match
994 # as much info as you can from the string, i.e., if you have to match
995 # something like \`\(\%\', do not match just the \`\(\'.
996 M:int:stap_is_single_operand:const char *s:s
998 # Function used to handle a "special case" in the parser.
1000 # A "special case" is considered to be an unknown token, i.e., a token
1001 # that the parser does not know how to parse. A good example of special
1002 # case would be ARM's register displacement syntax:
1004 # [R0, #4] ;; displacing R0 by 4
1006 # Since the parser assumes that a register displacement is of the form:
1008 # <number> <indirection_prefix> <register_name> <indirection_suffix>
1010 # it means that it will not be able to recognize and parse this odd syntax.
1011 # Therefore, we should add a special case function that will handle this token.
1013 # This function should generate the proper expression form of the expression
1014 # using GDB\'s internal expression mechanism (e.g., \`write_exp_elt_opcode\'
1015 # and so on). It should also return 1 if the parsing was successful, or zero
1016 # if the token was not recognized as a special token (in this case, returning
1017 # zero means that the special parser is deferring the parsing to the generic
1018 # parser), and should advance the buffer pointer (p->arg).
1019 M:int:stap_parse_special_token:struct stap_parse_info *p:p
1021 # DTrace related functions.
1023 # The expression to compute the NARTGth+1 argument to a DTrace USDT probe.
1024 # NARG must be >= 0.
1025 M:void:dtrace_parse_probe_argument:struct parser_state *pstate, int narg:pstate, narg
1027 # True if the given ADDR does not contain the instruction sequence
1028 # corresponding to a disabled DTrace is-enabled probe.
1029 M:int:dtrace_probe_is_enabled:CORE_ADDR addr:addr
1031 # Enable a DTrace is-enabled probe at ADDR.
1032 M:void:dtrace_enable_probe:CORE_ADDR addr:addr
1034 # Disable a DTrace is-enabled probe at ADDR.
1035 M:void:dtrace_disable_probe:CORE_ADDR addr:addr
1037 # True if the list of shared libraries is one and only for all
1038 # processes, as opposed to a list of shared libraries per inferior.
1039 # This usually means that all processes, although may or may not share
1040 # an address space, will see the same set of symbols at the same
1042 v:int:has_global_solist:::0:0::0
1044 # On some targets, even though each inferior has its own private
1045 # address space, the debug interface takes care of making breakpoints
1046 # visible to all address spaces automatically. For such cases,
1047 # this property should be set to true.
1048 v:int:has_global_breakpoints:::0:0::0
1050 # True if inferiors share an address space (e.g., uClinux).
1051 m:int:has_shared_address_space:void:::default_has_shared_address_space::0
1053 # True if a fast tracepoint can be set at an address.
1054 m:int:fast_tracepoint_valid_at:CORE_ADDR addr, char **msg:addr, msg::default_fast_tracepoint_valid_at::0
1056 # Guess register state based on tracepoint location. Used for tracepoints
1057 # where no registers have been collected, but there's only one location,
1058 # allowing us to guess the PC value, and perhaps some other registers.
1059 # On entry, regcache has all registers marked as unavailable.
1060 m:void:guess_tracepoint_registers:struct regcache *regcache, CORE_ADDR addr:regcache, addr::default_guess_tracepoint_registers::0
1062 # Return the "auto" target charset.
1063 f:const char *:auto_charset:void::default_auto_charset:default_auto_charset::0
1064 # Return the "auto" target wide charset.
1065 f:const char *:auto_wide_charset:void::default_auto_wide_charset:default_auto_wide_charset::0
1067 # If non-empty, this is a file extension that will be opened in place
1068 # of the file extension reported by the shared library list.
1070 # This is most useful for toolchains that use a post-linker tool,
1071 # where the names of the files run on the target differ in extension
1072 # compared to the names of the files GDB should load for debug info.
1073 v:const char *:solib_symbols_extension:::::::pstring (gdbarch->solib_symbols_extension)
1075 # If true, the target OS has DOS-based file system semantics. That
1076 # is, absolute paths include a drive name, and the backslash is
1077 # considered a directory separator.
1078 v:int:has_dos_based_file_system:::0:0::0
1080 # Generate bytecodes to collect the return address in a frame.
1081 # Since the bytecodes run on the target, possibly with GDB not even
1082 # connected, the full unwinding machinery is not available, and
1083 # typically this function will issue bytecodes for one or more likely
1084 # places that the return address may be found.
1085 m:void:gen_return_address:struct agent_expr *ax, struct axs_value *value, CORE_ADDR scope:ax, value, scope::default_gen_return_address::0
1087 # Implement the "info proc" command.
1088 M:void:info_proc:const char *args, enum info_proc_what what:args, what
1090 # Implement the "info proc" command for core files. Noe that there
1091 # are two "info_proc"-like methods on gdbarch -- one for core files,
1092 # one for live targets.
1093 M:void:core_info_proc:const char *args, enum info_proc_what what:args, what
1095 # Iterate over all objfiles in the order that makes the most sense
1096 # for the architecture to make global symbol searches.
1098 # CB is a callback function where OBJFILE is the objfile to be searched,
1099 # and CB_DATA a pointer to user-defined data (the same data that is passed
1100 # when calling this gdbarch method). The iteration stops if this function
1103 # CB_DATA is a pointer to some user-defined data to be passed to
1106 # If not NULL, CURRENT_OBJFILE corresponds to the objfile being
1107 # inspected when the symbol search was requested.
1108 m:void:iterate_over_objfiles_in_search_order:iterate_over_objfiles_in_search_order_cb_ftype *cb, void *cb_data, struct objfile *current_objfile:cb, cb_data, current_objfile:0:default_iterate_over_objfiles_in_search_order::0
1110 # Ravenscar arch-dependent ops.
1111 v:struct ravenscar_arch_ops *:ravenscar_ops:::NULL:NULL::0:host_address_to_string (gdbarch->ravenscar_ops)
1113 # Return non-zero if the instruction at ADDR is a call; zero otherwise.
1114 m:int:insn_is_call:CORE_ADDR addr:addr::default_insn_is_call::0
1116 # Return non-zero if the instruction at ADDR is a return; zero otherwise.
1117 m:int:insn_is_ret:CORE_ADDR addr:addr::default_insn_is_ret::0
1119 # Return non-zero if the instruction at ADDR is a jump; zero otherwise.
1120 m:int:insn_is_jump:CORE_ADDR addr:addr::default_insn_is_jump::0
1122 # Read one auxv entry from *READPTR, not reading locations >= ENDPTR.
1123 # Return 0 if *READPTR is already at the end of the buffer.
1124 # Return -1 if there is insufficient buffer for a whole entry.
1125 # Return 1 if an entry was read into *TYPEP and *VALP.
1126 M:int:auxv_parse:gdb_byte **readptr, gdb_byte *endptr, CORE_ADDR *typep, CORE_ADDR *valp:readptr, endptr, typep, valp
1128 # Print the description of a single auxv entry described by TYPE and VAL
1130 m:void:print_auxv_entry:struct ui_file *file, CORE_ADDR type, CORE_ADDR val:file, type, val::default_print_auxv_entry::0
1132 # Find the address range of the current inferior's vsyscall/vDSO, and
1133 # write it to *RANGE. If the vsyscall's length can't be determined, a
1134 # range with zero length is returned. Returns true if the vsyscall is
1135 # found, false otherwise.
1136 m:int:vsyscall_range:struct mem_range *range:range::default_vsyscall_range::0
1138 # Allocate SIZE bytes of PROT protected page aligned memory in inferior.
1139 # PROT has GDB_MMAP_PROT_* bitmask format.
1140 # Throw an error if it is not possible. Returned address is always valid.
1141 f:CORE_ADDR:infcall_mmap:CORE_ADDR size, unsigned prot:size, prot::default_infcall_mmap::0
1143 # Deallocate SIZE bytes of memory at ADDR in inferior from gdbarch_infcall_mmap.
1144 # Print a warning if it is not possible.
1145 f:void:infcall_munmap:CORE_ADDR addr, CORE_ADDR size:addr, size::default_infcall_munmap::0
1147 # Return string (caller has to use xfree for it) with options for GCC
1148 # to produce code for this target, typically "-m64", "-m32" or "-m31".
1149 # These options are put before CU's DW_AT_producer compilation options so that
1150 # they can override it. Method may also return NULL.
1151 m:char *:gcc_target_options:void:::default_gcc_target_options::0
1153 # Return a regular expression that matches names used by this
1154 # architecture in GNU configury triplets. The result is statically
1155 # allocated and must not be freed. The default implementation simply
1156 # returns the BFD architecture name, which is correct in nearly every
1158 m:const char *:gnu_triplet_regexp:void:::default_gnu_triplet_regexp::0
1160 # Return the size in 8-bit bytes of an addressable memory unit on this
1161 # architecture. This corresponds to the number of 8-bit bytes associated to
1162 # each address in memory.
1163 m:int:addressable_memory_unit_size:void:::default_addressable_memory_unit_size::0
1171 exec > new-gdbarch.log
1172 function_list | while do_read
1175 ${class} ${returntype} ${function} ($formal)
1179 eval echo \"\ \ \ \ ${r}=\${${r}}\"
1181 if class_is_predicate_p && fallback_default_p
1183 echo "Error: predicate function ${function} can not have a non- multi-arch default" 1>&2
1187 if [ "x${invalid_p}" = "x0" -a -n "${postdefault}" ]
1189 echo "Error: postdefault is useless when invalid_p=0" 1>&2
1193 if class_is_multiarch_p
1195 if class_is_predicate_p ; then :
1196 elif test "x${predefault}" = "x"
1198 echo "Error: pure multi-arch function ${function} must have a predefault" 1>&2
1207 compare_new gdbarch.log
1213 /* *INDENT-OFF* */ /* THIS FILE IS GENERATED -*- buffer-read-only: t -*- */
1216 /* Dynamic architecture support for GDB, the GNU debugger.
1218 Copyright (C) 1998-2016 Free Software Foundation, Inc.
1220 This file is part of GDB.
1222 This program is free software; you can redistribute it and/or modify
1223 it under the terms of the GNU General Public License as published by
1224 the Free Software Foundation; either version 3 of the License, or
1225 (at your option) any later version.
1227 This program is distributed in the hope that it will be useful,
1228 but WITHOUT ANY WARRANTY; without even the implied warranty of
1229 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1230 GNU General Public License for more details.
1232 You should have received a copy of the GNU General Public License
1233 along with this program. If not, see <http://www.gnu.org/licenses/>. */
1235 /* This file was created with the aid of \`\`gdbarch.sh''.
1237 The Bourne shell script \`\`gdbarch.sh'' creates the files
1238 \`\`new-gdbarch.c'' and \`\`new-gdbarch.h and then compares them
1239 against the existing \`\`gdbarch.[hc]''. Any differences found
1242 If editing this file, please also run gdbarch.sh and merge any
1243 changes into that script. Conversely, when making sweeping changes
1244 to this file, modifying gdbarch.sh and using its output may prove
1254 exec > new-gdbarch.h
1267 struct minimal_symbol;
1271 struct disassemble_info;
1274 struct bp_target_info;
1278 struct displaced_step_closure;
1282 struct stap_parse_info;
1283 struct parser_state;
1284 struct ravenscar_arch_ops;
1285 struct elf_internal_linux_prpsinfo;
1287 struct syscalls_info;
1291 #include "regcache.h"
1293 /* The architecture associated with the inferior through the
1294 connection to the target.
1296 The architecture vector provides some information that is really a
1297 property of the inferior, accessed through a particular target:
1298 ptrace operations; the layout of certain RSP packets; the solib_ops
1299 vector; etc. To differentiate architecture accesses to
1300 per-inferior/target properties from
1301 per-thread/per-frame/per-objfile properties, accesses to
1302 per-inferior/target properties should be made through this
1305 /* This is a convenience wrapper for 'current_inferior ()->gdbarch'. */
1306 extern struct gdbarch *target_gdbarch (void);
1308 /* Callback type for the 'iterate_over_objfiles_in_search_order'
1311 typedef int (iterate_over_objfiles_in_search_order_cb_ftype)
1312 (struct objfile *objfile, void *cb_data);
1314 /* Callback type for regset section iterators. The callback usually
1315 invokes the REGSET's supply or collect method, to which it must
1316 pass a buffer with at least the given SIZE. SECT_NAME is a BFD
1317 section name, and HUMAN_NAME is used for diagnostic messages.
1318 CB_DATA should have been passed unchanged through the iterator. */
1320 typedef void (iterate_over_regset_sections_cb)
1321 (const char *sect_name, int size, const struct regset *regset,
1322 const char *human_name, void *cb_data);
1325 # function typedef's
1328 printf "/* The following are pre-initialized by GDBARCH. */\n"
1329 function_list | while do_read
1334 printf "extern ${returntype} gdbarch_${function} (struct gdbarch *gdbarch);\n"
1335 printf "/* set_gdbarch_${function}() - not applicable - pre-initialized. */\n"
1339 # function typedef's
1342 printf "/* The following are initialized by the target dependent code. */\n"
1343 function_list | while do_read
1345 if [ -n "${comment}" ]
1347 echo "${comment}" | sed \
1353 if class_is_predicate_p
1356 printf "extern int gdbarch_${function}_p (struct gdbarch *gdbarch);\n"
1358 if class_is_variable_p
1361 printf "extern ${returntype} gdbarch_${function} (struct gdbarch *gdbarch);\n"
1362 printf "extern void set_gdbarch_${function} (struct gdbarch *gdbarch, ${returntype} ${function});\n"
1364 if class_is_function_p
1367 if [ "x${formal}" = "xvoid" ] && class_is_multiarch_p
1369 printf "typedef ${returntype} (gdbarch_${function}_ftype) (struct gdbarch *gdbarch);\n"
1370 elif class_is_multiarch_p
1372 printf "typedef ${returntype} (gdbarch_${function}_ftype) (struct gdbarch *gdbarch, ${formal});\n"
1374 printf "typedef ${returntype} (gdbarch_${function}_ftype) (${formal});\n"
1376 if [ "x${formal}" = "xvoid" ]
1378 printf "extern ${returntype} gdbarch_${function} (struct gdbarch *gdbarch);\n"
1380 printf "extern ${returntype} gdbarch_${function} (struct gdbarch *gdbarch, ${formal});\n"
1382 printf "extern void set_gdbarch_${function} (struct gdbarch *gdbarch, gdbarch_${function}_ftype *${function});\n"
1389 /* Definition for an unknown syscall, used basically in error-cases. */
1390 #define UNKNOWN_SYSCALL (-1)
1392 extern struct gdbarch_tdep *gdbarch_tdep (struct gdbarch *gdbarch);
1395 /* Mechanism for co-ordinating the selection of a specific
1398 GDB targets (*-tdep.c) can register an interest in a specific
1399 architecture. Other GDB components can register a need to maintain
1400 per-architecture data.
1402 The mechanisms below ensures that there is only a loose connection
1403 between the set-architecture command and the various GDB
1404 components. Each component can independently register their need
1405 to maintain architecture specific data with gdbarch.
1409 Previously, a single TARGET_ARCHITECTURE_HOOK was provided. It
1412 The more traditional mega-struct containing architecture specific
1413 data for all the various GDB components was also considered. Since
1414 GDB is built from a variable number of (fairly independent)
1415 components it was determined that the global aproach was not
1419 /* Register a new architectural family with GDB.
1421 Register support for the specified ARCHITECTURE with GDB. When
1422 gdbarch determines that the specified architecture has been
1423 selected, the corresponding INIT function is called.
1427 The INIT function takes two parameters: INFO which contains the
1428 information available to gdbarch about the (possibly new)
1429 architecture; ARCHES which is a list of the previously created
1430 \`\`struct gdbarch'' for this architecture.
1432 The INFO parameter is, as far as possible, be pre-initialized with
1433 information obtained from INFO.ABFD or the global defaults.
1435 The ARCHES parameter is a linked list (sorted most recently used)
1436 of all the previously created architures for this architecture
1437 family. The (possibly NULL) ARCHES->gdbarch can used to access
1438 values from the previously selected architecture for this
1439 architecture family.
1441 The INIT function shall return any of: NULL - indicating that it
1442 doesn't recognize the selected architecture; an existing \`\`struct
1443 gdbarch'' from the ARCHES list - indicating that the new
1444 architecture is just a synonym for an earlier architecture (see
1445 gdbarch_list_lookup_by_info()); a newly created \`\`struct gdbarch''
1446 - that describes the selected architecture (see gdbarch_alloc()).
1448 The DUMP_TDEP function shall print out all target specific values.
1449 Care should be taken to ensure that the function works in both the
1450 multi-arch and non- multi-arch cases. */
1454 struct gdbarch *gdbarch;
1455 struct gdbarch_list *next;
1460 /* Use default: NULL (ZERO). */
1461 const struct bfd_arch_info *bfd_arch_info;
1463 /* Use default: BFD_ENDIAN_UNKNOWN (NB: is not ZERO). */
1464 enum bfd_endian byte_order;
1466 enum bfd_endian byte_order_for_code;
1468 /* Use default: NULL (ZERO). */
1471 /* Use default: NULL (ZERO). */
1474 /* Use default: GDB_OSABI_UNINITIALIZED (-1). */
1475 enum gdb_osabi osabi;
1477 /* Use default: NULL (ZERO). */
1478 const struct target_desc *target_desc;
1481 typedef struct gdbarch *(gdbarch_init_ftype) (struct gdbarch_info info, struct gdbarch_list *arches);
1482 typedef void (gdbarch_dump_tdep_ftype) (struct gdbarch *gdbarch, struct ui_file *file);
1484 /* DEPRECATED - use gdbarch_register() */
1485 extern void register_gdbarch_init (enum bfd_architecture architecture, gdbarch_init_ftype *);
1487 extern void gdbarch_register (enum bfd_architecture architecture,
1488 gdbarch_init_ftype *,
1489 gdbarch_dump_tdep_ftype *);
1492 /* Return a freshly allocated, NULL terminated, array of the valid
1493 architecture names. Since architectures are registered during the
1494 _initialize phase this function only returns useful information
1495 once initialization has been completed. */
1497 extern const char **gdbarch_printable_names (void);
1500 /* Helper function. Search the list of ARCHES for a GDBARCH that
1501 matches the information provided by INFO. */
1503 extern struct gdbarch_list *gdbarch_list_lookup_by_info (struct gdbarch_list *arches, const struct gdbarch_info *info);
1506 /* Helper function. Create a preliminary \`\`struct gdbarch''. Perform
1507 basic initialization using values obtained from the INFO and TDEP
1508 parameters. set_gdbarch_*() functions are called to complete the
1509 initialization of the object. */
1511 extern struct gdbarch *gdbarch_alloc (const struct gdbarch_info *info, struct gdbarch_tdep *tdep);
1514 /* Helper function. Free a partially-constructed \`\`struct gdbarch''.
1515 It is assumed that the caller freeds the \`\`struct
1518 extern void gdbarch_free (struct gdbarch *);
1521 /* Helper function. Allocate memory from the \`\`struct gdbarch''
1522 obstack. The memory is freed when the corresponding architecture
1525 extern void *gdbarch_obstack_zalloc (struct gdbarch *gdbarch, long size);
1526 #define GDBARCH_OBSTACK_CALLOC(GDBARCH, NR, TYPE) ((TYPE *) gdbarch_obstack_zalloc ((GDBARCH), (NR) * sizeof (TYPE)))
1527 #define GDBARCH_OBSTACK_ZALLOC(GDBARCH, TYPE) ((TYPE *) gdbarch_obstack_zalloc ((GDBARCH), sizeof (TYPE)))
1529 /* Duplicate STRING, returning an equivalent string that's allocated on the
1530 obstack associated with GDBARCH. The string is freed when the corresponding
1531 architecture is also freed. */
1533 extern char *gdbarch_obstack_strdup (struct gdbarch *arch, const char *string);
1535 /* Helper function. Force an update of the current architecture.
1537 The actual architecture selected is determined by INFO, \`\`(gdb) set
1538 architecture'' et.al., the existing architecture and BFD's default
1539 architecture. INFO should be initialized to zero and then selected
1540 fields should be updated.
1542 Returns non-zero if the update succeeds. */
1544 extern int gdbarch_update_p (struct gdbarch_info info);
1547 /* Helper function. Find an architecture matching info.
1549 INFO should be initialized using gdbarch_info_init, relevant fields
1550 set, and then finished using gdbarch_info_fill.
1552 Returns the corresponding architecture, or NULL if no matching
1553 architecture was found. */
1555 extern struct gdbarch *gdbarch_find_by_info (struct gdbarch_info info);
1558 /* Helper function. Set the target gdbarch to "gdbarch". */
1560 extern void set_target_gdbarch (struct gdbarch *gdbarch);
1563 /* Register per-architecture data-pointer.
1565 Reserve space for a per-architecture data-pointer. An identifier
1566 for the reserved data-pointer is returned. That identifer should
1567 be saved in a local static variable.
1569 Memory for the per-architecture data shall be allocated using
1570 gdbarch_obstack_zalloc. That memory will be deleted when the
1571 corresponding architecture object is deleted.
1573 When a previously created architecture is re-selected, the
1574 per-architecture data-pointer for that previous architecture is
1575 restored. INIT() is not re-called.
1577 Multiple registrarants for any architecture are allowed (and
1578 strongly encouraged). */
1580 struct gdbarch_data;
1582 typedef void *(gdbarch_data_pre_init_ftype) (struct obstack *obstack);
1583 extern struct gdbarch_data *gdbarch_data_register_pre_init (gdbarch_data_pre_init_ftype *init);
1584 typedef void *(gdbarch_data_post_init_ftype) (struct gdbarch *gdbarch);
1585 extern struct gdbarch_data *gdbarch_data_register_post_init (gdbarch_data_post_init_ftype *init);
1586 extern void deprecated_set_gdbarch_data (struct gdbarch *gdbarch,
1587 struct gdbarch_data *data,
1590 extern void *gdbarch_data (struct gdbarch *gdbarch, struct gdbarch_data *);
1593 /* Set the dynamic target-system-dependent parameters (architecture,
1594 byte-order, ...) using information found in the BFD. */
1596 extern void set_gdbarch_from_file (bfd *);
1599 /* Initialize the current architecture to the "first" one we find on
1602 extern void initialize_current_architecture (void);
1604 /* gdbarch trace variable */
1605 extern unsigned int gdbarch_debug;
1607 extern void gdbarch_dump (struct gdbarch *gdbarch, struct ui_file *file);
1612 #../move-if-change new-gdbarch.h gdbarch.h
1613 compare_new gdbarch.h
1620 exec > new-gdbarch.c
1625 #include "arch-utils.h"
1628 #include "inferior.h"
1631 #include "floatformat.h"
1632 #include "reggroups.h"
1634 #include "gdb_obstack.h"
1635 #include "observer.h"
1636 #include "regcache.h"
1637 #include "objfiles.h"
1640 /* Static function declarations */
1642 static void alloc_gdbarch_data (struct gdbarch *);
1644 /* Non-zero if we want to trace architecture code. */
1646 #ifndef GDBARCH_DEBUG
1647 #define GDBARCH_DEBUG 0
1649 unsigned int gdbarch_debug = GDBARCH_DEBUG;
1651 show_gdbarch_debug (struct ui_file *file, int from_tty,
1652 struct cmd_list_element *c, const char *value)
1654 fprintf_filtered (file, _("Architecture debugging is %s.\\n"), value);
1658 pformat (const struct floatformat **format)
1663 /* Just print out one of them - this is only for diagnostics. */
1664 return format[0]->name;
1668 pstring (const char *string)
1675 /* Helper function to print a list of strings, represented as "const
1676 char *const *". The list is printed comma-separated. */
1679 pstring_list (const char *const *list)
1681 static char ret[100];
1682 const char *const *p;
1689 for (p = list; *p != NULL && offset < sizeof (ret); ++p)
1691 size_t s = xsnprintf (ret + offset, sizeof (ret) - offset, "%s, ", *p);
1697 gdb_assert (offset - 2 < sizeof (ret));
1698 ret[offset - 2] = '\0';
1706 # gdbarch open the gdbarch object
1708 printf "/* Maintain the struct gdbarch object. */\n"
1710 printf "struct gdbarch\n"
1712 printf " /* Has this architecture been fully initialized? */\n"
1713 printf " int initialized_p;\n"
1715 printf " /* An obstack bound to the lifetime of the architecture. */\n"
1716 printf " struct obstack *obstack;\n"
1718 printf " /* basic architectural information. */\n"
1719 function_list | while do_read
1723 printf " ${returntype} ${function};\n"
1727 printf " /* target specific vector. */\n"
1728 printf " struct gdbarch_tdep *tdep;\n"
1729 printf " gdbarch_dump_tdep_ftype *dump_tdep;\n"
1731 printf " /* per-architecture data-pointers. */\n"
1732 printf " unsigned nr_data;\n"
1733 printf " void **data;\n"
1736 /* Multi-arch values.
1738 When extending this structure you must:
1740 Add the field below.
1742 Declare set/get functions and define the corresponding
1745 gdbarch_alloc(): If zero/NULL is not a suitable default,
1746 initialize the new field.
1748 verify_gdbarch(): Confirm that the target updated the field
1751 gdbarch_dump(): Add a fprintf_unfiltered call so that the new
1754 get_gdbarch(): Implement the set/get functions (probably using
1755 the macro's as shortcuts).
1760 function_list | while do_read
1762 if class_is_variable_p
1764 printf " ${returntype} ${function};\n"
1765 elif class_is_function_p
1767 printf " gdbarch_${function}_ftype *${function};\n"
1772 # Create a new gdbarch struct
1775 /* Create a new \`\`struct gdbarch'' based on information provided by
1776 \`\`struct gdbarch_info''. */
1781 gdbarch_alloc (const struct gdbarch_info *info,
1782 struct gdbarch_tdep *tdep)
1784 struct gdbarch *gdbarch;
1786 /* Create an obstack for allocating all the per-architecture memory,
1787 then use that to allocate the architecture vector. */
1788 struct obstack *obstack = XNEW (struct obstack);
1789 obstack_init (obstack);
1790 gdbarch = XOBNEW (obstack, struct gdbarch);
1791 memset (gdbarch, 0, sizeof (*gdbarch));
1792 gdbarch->obstack = obstack;
1794 alloc_gdbarch_data (gdbarch);
1796 gdbarch->tdep = tdep;
1799 function_list | while do_read
1803 printf " gdbarch->${function} = info->${function};\n"
1807 printf " /* Force the explicit initialization of these. */\n"
1808 function_list | while do_read
1810 if class_is_function_p || class_is_variable_p
1812 if [ -n "${predefault}" -a "x${predefault}" != "x0" ]
1814 printf " gdbarch->${function} = ${predefault};\n"
1819 /* gdbarch_alloc() */
1825 # Free a gdbarch struct.
1829 /* Allocate extra space using the per-architecture obstack. */
1832 gdbarch_obstack_zalloc (struct gdbarch *arch, long size)
1834 void *data = obstack_alloc (arch->obstack, size);
1836 memset (data, 0, size);
1840 /* See gdbarch.h. */
1843 gdbarch_obstack_strdup (struct gdbarch *arch, const char *string)
1845 return obstack_strdup (arch->obstack, string);
1849 /* Free a gdbarch struct. This should never happen in normal
1850 operation --- once you've created a gdbarch, you keep it around.
1851 However, if an architecture's init function encounters an error
1852 building the structure, it may need to clean up a partially
1853 constructed gdbarch. */
1856 gdbarch_free (struct gdbarch *arch)
1858 struct obstack *obstack;
1860 gdb_assert (arch != NULL);
1861 gdb_assert (!arch->initialized_p);
1862 obstack = arch->obstack;
1863 obstack_free (obstack, 0); /* Includes the ARCH. */
1868 # verify a new architecture
1872 /* Ensure that all values in a GDBARCH are reasonable. */
1875 verify_gdbarch (struct gdbarch *gdbarch)
1877 struct ui_file *log;
1878 struct cleanup *cleanups;
1882 log = mem_fileopen ();
1883 cleanups = make_cleanup_ui_file_delete (log);
1885 if (gdbarch->byte_order == BFD_ENDIAN_UNKNOWN)
1886 fprintf_unfiltered (log, "\n\tbyte-order");
1887 if (gdbarch->bfd_arch_info == NULL)
1888 fprintf_unfiltered (log, "\n\tbfd_arch_info");
1889 /* Check those that need to be defined for the given multi-arch level. */
1891 function_list | while do_read
1893 if class_is_function_p || class_is_variable_p
1895 if [ "x${invalid_p}" = "x0" ]
1897 printf " /* Skip verify of ${function}, invalid_p == 0 */\n"
1898 elif class_is_predicate_p
1900 printf " /* Skip verify of ${function}, has predicate. */\n"
1901 # FIXME: See do_read for potential simplification
1902 elif [ -n "${invalid_p}" -a -n "${postdefault}" ]
1904 printf " if (${invalid_p})\n"
1905 printf " gdbarch->${function} = ${postdefault};\n"
1906 elif [ -n "${predefault}" -a -n "${postdefault}" ]
1908 printf " if (gdbarch->${function} == ${predefault})\n"
1909 printf " gdbarch->${function} = ${postdefault};\n"
1910 elif [ -n "${postdefault}" ]
1912 printf " if (gdbarch->${function} == 0)\n"
1913 printf " gdbarch->${function} = ${postdefault};\n"
1914 elif [ -n "${invalid_p}" ]
1916 printf " if (${invalid_p})\n"
1917 printf " fprintf_unfiltered (log, \"\\\\n\\\\t${function}\");\n"
1918 elif [ -n "${predefault}" ]
1920 printf " if (gdbarch->${function} == ${predefault})\n"
1921 printf " fprintf_unfiltered (log, \"\\\\n\\\\t${function}\");\n"
1926 buf = ui_file_xstrdup (log, &length);
1927 make_cleanup (xfree, buf);
1929 internal_error (__FILE__, __LINE__,
1930 _("verify_gdbarch: the following are invalid ...%s"),
1932 do_cleanups (cleanups);
1936 # dump the structure
1940 /* Print out the details of the current architecture. */
1943 gdbarch_dump (struct gdbarch *gdbarch, struct ui_file *file)
1945 const char *gdb_nm_file = "<not-defined>";
1947 #if defined (GDB_NM_FILE)
1948 gdb_nm_file = GDB_NM_FILE;
1950 fprintf_unfiltered (file,
1951 "gdbarch_dump: GDB_NM_FILE = %s\\n",
1954 function_list | sort -t: -k 3 | while do_read
1956 # First the predicate
1957 if class_is_predicate_p
1959 printf " fprintf_unfiltered (file,\n"
1960 printf " \"gdbarch_dump: gdbarch_${function}_p() = %%d\\\\n\",\n"
1961 printf " gdbarch_${function}_p (gdbarch));\n"
1963 # Print the corresponding value.
1964 if class_is_function_p
1966 printf " fprintf_unfiltered (file,\n"
1967 printf " \"gdbarch_dump: ${function} = <%%s>\\\\n\",\n"
1968 printf " host_address_to_string (gdbarch->${function}));\n"
1971 case "${print}:${returntype}" in
1974 print="core_addr_to_string_nz (gdbarch->${function})"
1978 print="plongest (gdbarch->${function})"
1984 printf " fprintf_unfiltered (file,\n"
1985 printf " \"gdbarch_dump: ${function} = %s\\\\n\",\n" "${fmt}"
1986 printf " ${print});\n"
1990 if (gdbarch->dump_tdep != NULL)
1991 gdbarch->dump_tdep (gdbarch, file);
1999 struct gdbarch_tdep *
2000 gdbarch_tdep (struct gdbarch *gdbarch)
2002 if (gdbarch_debug >= 2)
2003 fprintf_unfiltered (gdb_stdlog, "gdbarch_tdep called\\n");
2004 return gdbarch->tdep;
2008 function_list | while do_read
2010 if class_is_predicate_p
2014 printf "gdbarch_${function}_p (struct gdbarch *gdbarch)\n"
2016 printf " gdb_assert (gdbarch != NULL);\n"
2017 printf " return ${predicate};\n"
2020 if class_is_function_p
2023 printf "${returntype}\n"
2024 if [ "x${formal}" = "xvoid" ]
2026 printf "gdbarch_${function} (struct gdbarch *gdbarch)\n"
2028 printf "gdbarch_${function} (struct gdbarch *gdbarch, ${formal})\n"
2031 printf " gdb_assert (gdbarch != NULL);\n"
2032 printf " gdb_assert (gdbarch->${function} != NULL);\n"
2033 if class_is_predicate_p && test -n "${predefault}"
2035 # Allow a call to a function with a predicate.
2036 printf " /* Do not check predicate: ${predicate}, allow call. */\n"
2038 printf " if (gdbarch_debug >= 2)\n"
2039 printf " fprintf_unfiltered (gdb_stdlog, \"gdbarch_${function} called\\\\n\");\n"
2040 if [ "x${actual}" = "x-" -o "x${actual}" = "x" ]
2042 if class_is_multiarch_p
2049 if class_is_multiarch_p
2051 params="gdbarch, ${actual}"
2056 if [ "x${returntype}" = "xvoid" ]
2058 printf " gdbarch->${function} (${params});\n"
2060 printf " return gdbarch->${function} (${params});\n"
2065 printf "set_gdbarch_${function} (struct gdbarch *gdbarch,\n"
2066 printf " `echo ${function} | sed -e 's/./ /g'` gdbarch_${function}_ftype ${function})\n"
2068 printf " gdbarch->${function} = ${function};\n"
2070 elif class_is_variable_p
2073 printf "${returntype}\n"
2074 printf "gdbarch_${function} (struct gdbarch *gdbarch)\n"
2076 printf " gdb_assert (gdbarch != NULL);\n"
2077 if [ "x${invalid_p}" = "x0" ]
2079 printf " /* Skip verify of ${function}, invalid_p == 0 */\n"
2080 elif [ -n "${invalid_p}" ]
2082 printf " /* Check variable is valid. */\n"
2083 printf " gdb_assert (!(${invalid_p}));\n"
2084 elif [ -n "${predefault}" ]
2086 printf " /* Check variable changed from pre-default. */\n"
2087 printf " gdb_assert (gdbarch->${function} != ${predefault});\n"
2089 printf " if (gdbarch_debug >= 2)\n"
2090 printf " fprintf_unfiltered (gdb_stdlog, \"gdbarch_${function} called\\\\n\");\n"
2091 printf " return gdbarch->${function};\n"
2095 printf "set_gdbarch_${function} (struct gdbarch *gdbarch,\n"
2096 printf " `echo ${function} | sed -e 's/./ /g'` ${returntype} ${function})\n"
2098 printf " gdbarch->${function} = ${function};\n"
2100 elif class_is_info_p
2103 printf "${returntype}\n"
2104 printf "gdbarch_${function} (struct gdbarch *gdbarch)\n"
2106 printf " gdb_assert (gdbarch != NULL);\n"
2107 printf " if (gdbarch_debug >= 2)\n"
2108 printf " fprintf_unfiltered (gdb_stdlog, \"gdbarch_${function} called\\\\n\");\n"
2109 printf " return gdbarch->${function};\n"
2114 # All the trailing guff
2118 /* Keep a registry of per-architecture data-pointers required by GDB
2125 gdbarch_data_pre_init_ftype *pre_init;
2126 gdbarch_data_post_init_ftype *post_init;
2129 struct gdbarch_data_registration
2131 struct gdbarch_data *data;
2132 struct gdbarch_data_registration *next;
2135 struct gdbarch_data_registry
2138 struct gdbarch_data_registration *registrations;
2141 struct gdbarch_data_registry gdbarch_data_registry =
2146 static struct gdbarch_data *
2147 gdbarch_data_register (gdbarch_data_pre_init_ftype *pre_init,
2148 gdbarch_data_post_init_ftype *post_init)
2150 struct gdbarch_data_registration **curr;
2152 /* Append the new registration. */
2153 for (curr = &gdbarch_data_registry.registrations;
2155 curr = &(*curr)->next);
2156 (*curr) = XNEW (struct gdbarch_data_registration);
2157 (*curr)->next = NULL;
2158 (*curr)->data = XNEW (struct gdbarch_data);
2159 (*curr)->data->index = gdbarch_data_registry.nr++;
2160 (*curr)->data->pre_init = pre_init;
2161 (*curr)->data->post_init = post_init;
2162 (*curr)->data->init_p = 1;
2163 return (*curr)->data;
2166 struct gdbarch_data *
2167 gdbarch_data_register_pre_init (gdbarch_data_pre_init_ftype *pre_init)
2169 return gdbarch_data_register (pre_init, NULL);
2172 struct gdbarch_data *
2173 gdbarch_data_register_post_init (gdbarch_data_post_init_ftype *post_init)
2175 return gdbarch_data_register (NULL, post_init);
2178 /* Create/delete the gdbarch data vector. */
2181 alloc_gdbarch_data (struct gdbarch *gdbarch)
2183 gdb_assert (gdbarch->data == NULL);
2184 gdbarch->nr_data = gdbarch_data_registry.nr;
2185 gdbarch->data = GDBARCH_OBSTACK_CALLOC (gdbarch, gdbarch->nr_data, void *);
2188 /* Initialize the current value of the specified per-architecture
2192 deprecated_set_gdbarch_data (struct gdbarch *gdbarch,
2193 struct gdbarch_data *data,
2196 gdb_assert (data->index < gdbarch->nr_data);
2197 gdb_assert (gdbarch->data[data->index] == NULL);
2198 gdb_assert (data->pre_init == NULL);
2199 gdbarch->data[data->index] = pointer;
2202 /* Return the current value of the specified per-architecture
2206 gdbarch_data (struct gdbarch *gdbarch, struct gdbarch_data *data)
2208 gdb_assert (data->index < gdbarch->nr_data);
2209 if (gdbarch->data[data->index] == NULL)
2211 /* The data-pointer isn't initialized, call init() to get a
2213 if (data->pre_init != NULL)
2214 /* Mid architecture creation: pass just the obstack, and not
2215 the entire architecture, as that way it isn't possible for
2216 pre-init code to refer to undefined architecture
2218 gdbarch->data[data->index] = data->pre_init (gdbarch->obstack);
2219 else if (gdbarch->initialized_p
2220 && data->post_init != NULL)
2221 /* Post architecture creation: pass the entire architecture
2222 (as all fields are valid), but be careful to also detect
2223 recursive references. */
2225 gdb_assert (data->init_p);
2227 gdbarch->data[data->index] = data->post_init (gdbarch);
2231 /* The architecture initialization hasn't completed - punt -
2232 hope that the caller knows what they are doing. Once
2233 deprecated_set_gdbarch_data has been initialized, this can be
2234 changed to an internal error. */
2236 gdb_assert (gdbarch->data[data->index] != NULL);
2238 return gdbarch->data[data->index];
2242 /* Keep a registry of the architectures known by GDB. */
2244 struct gdbarch_registration
2246 enum bfd_architecture bfd_architecture;
2247 gdbarch_init_ftype *init;
2248 gdbarch_dump_tdep_ftype *dump_tdep;
2249 struct gdbarch_list *arches;
2250 struct gdbarch_registration *next;
2253 static struct gdbarch_registration *gdbarch_registry = NULL;
2256 append_name (const char ***buf, int *nr, const char *name)
2258 *buf = XRESIZEVEC (const char *, *buf, *nr + 1);
2264 gdbarch_printable_names (void)
2266 /* Accumulate a list of names based on the registed list of
2269 const char **arches = NULL;
2270 struct gdbarch_registration *rego;
2272 for (rego = gdbarch_registry;
2276 const struct bfd_arch_info *ap;
2277 ap = bfd_lookup_arch (rego->bfd_architecture, 0);
2279 internal_error (__FILE__, __LINE__,
2280 _("gdbarch_architecture_names: multi-arch unknown"));
2283 append_name (&arches, &nr_arches, ap->printable_name);
2288 append_name (&arches, &nr_arches, NULL);
2294 gdbarch_register (enum bfd_architecture bfd_architecture,
2295 gdbarch_init_ftype *init,
2296 gdbarch_dump_tdep_ftype *dump_tdep)
2298 struct gdbarch_registration **curr;
2299 const struct bfd_arch_info *bfd_arch_info;
2301 /* Check that BFD recognizes this architecture */
2302 bfd_arch_info = bfd_lookup_arch (bfd_architecture, 0);
2303 if (bfd_arch_info == NULL)
2305 internal_error (__FILE__, __LINE__,
2306 _("gdbarch: Attempt to register "
2307 "unknown architecture (%d)"),
2310 /* Check that we haven't seen this architecture before. */
2311 for (curr = &gdbarch_registry;
2313 curr = &(*curr)->next)
2315 if (bfd_architecture == (*curr)->bfd_architecture)
2316 internal_error (__FILE__, __LINE__,
2317 _("gdbarch: Duplicate registration "
2318 "of architecture (%s)"),
2319 bfd_arch_info->printable_name);
2323 fprintf_unfiltered (gdb_stdlog, "register_gdbarch_init (%s, %s)\n",
2324 bfd_arch_info->printable_name,
2325 host_address_to_string (init));
2327 (*curr) = XNEW (struct gdbarch_registration);
2328 (*curr)->bfd_architecture = bfd_architecture;
2329 (*curr)->init = init;
2330 (*curr)->dump_tdep = dump_tdep;
2331 (*curr)->arches = NULL;
2332 (*curr)->next = NULL;
2336 register_gdbarch_init (enum bfd_architecture bfd_architecture,
2337 gdbarch_init_ftype *init)
2339 gdbarch_register (bfd_architecture, init, NULL);
2343 /* Look for an architecture using gdbarch_info. */
2345 struct gdbarch_list *
2346 gdbarch_list_lookup_by_info (struct gdbarch_list *arches,
2347 const struct gdbarch_info *info)
2349 for (; arches != NULL; arches = arches->next)
2351 if (info->bfd_arch_info != arches->gdbarch->bfd_arch_info)
2353 if (info->byte_order != arches->gdbarch->byte_order)
2355 if (info->osabi != arches->gdbarch->osabi)
2357 if (info->target_desc != arches->gdbarch->target_desc)
2365 /* Find an architecture that matches the specified INFO. Create a new
2366 architecture if needed. Return that new architecture. */
2369 gdbarch_find_by_info (struct gdbarch_info info)
2371 struct gdbarch *new_gdbarch;
2372 struct gdbarch_registration *rego;
2374 /* Fill in missing parts of the INFO struct using a number of
2375 sources: "set ..."; INFOabfd supplied; and the global
2377 gdbarch_info_fill (&info);
2379 /* Must have found some sort of architecture. */
2380 gdb_assert (info.bfd_arch_info != NULL);
2384 fprintf_unfiltered (gdb_stdlog,
2385 "gdbarch_find_by_info: info.bfd_arch_info %s\n",
2386 (info.bfd_arch_info != NULL
2387 ? info.bfd_arch_info->printable_name
2389 fprintf_unfiltered (gdb_stdlog,
2390 "gdbarch_find_by_info: info.byte_order %d (%s)\n",
2392 (info.byte_order == BFD_ENDIAN_BIG ? "big"
2393 : info.byte_order == BFD_ENDIAN_LITTLE ? "little"
2395 fprintf_unfiltered (gdb_stdlog,
2396 "gdbarch_find_by_info: info.osabi %d (%s)\n",
2397 info.osabi, gdbarch_osabi_name (info.osabi));
2398 fprintf_unfiltered (gdb_stdlog,
2399 "gdbarch_find_by_info: info.abfd %s\n",
2400 host_address_to_string (info.abfd));
2401 fprintf_unfiltered (gdb_stdlog,
2402 "gdbarch_find_by_info: info.tdep_info %s\n",
2403 host_address_to_string (info.tdep_info));
2406 /* Find the tdep code that knows about this architecture. */
2407 for (rego = gdbarch_registry;
2410 if (rego->bfd_architecture == info.bfd_arch_info->arch)
2415 fprintf_unfiltered (gdb_stdlog, "gdbarch_find_by_info: "
2416 "No matching architecture\n");
2420 /* Ask the tdep code for an architecture that matches "info". */
2421 new_gdbarch = rego->init (info, rego->arches);
2423 /* Did the tdep code like it? No. Reject the change and revert to
2424 the old architecture. */
2425 if (new_gdbarch == NULL)
2428 fprintf_unfiltered (gdb_stdlog, "gdbarch_find_by_info: "
2429 "Target rejected architecture\n");
2433 /* Is this a pre-existing architecture (as determined by already
2434 being initialized)? Move it to the front of the architecture
2435 list (keeping the list sorted Most Recently Used). */
2436 if (new_gdbarch->initialized_p)
2438 struct gdbarch_list **list;
2439 struct gdbarch_list *self;
2441 fprintf_unfiltered (gdb_stdlog, "gdbarch_find_by_info: "
2442 "Previous architecture %s (%s) selected\n",
2443 host_address_to_string (new_gdbarch),
2444 new_gdbarch->bfd_arch_info->printable_name);
2445 /* Find the existing arch in the list. */
2446 for (list = ®o->arches;
2447 (*list) != NULL && (*list)->gdbarch != new_gdbarch;
2448 list = &(*list)->next);
2449 /* It had better be in the list of architectures. */
2450 gdb_assert ((*list) != NULL && (*list)->gdbarch == new_gdbarch);
2453 (*list) = self->next;
2454 /* Insert SELF at the front. */
2455 self->next = rego->arches;
2456 rego->arches = self;
2461 /* It's a new architecture. */
2463 fprintf_unfiltered (gdb_stdlog, "gdbarch_find_by_info: "
2464 "New architecture %s (%s) selected\n",
2465 host_address_to_string (new_gdbarch),
2466 new_gdbarch->bfd_arch_info->printable_name);
2468 /* Insert the new architecture into the front of the architecture
2469 list (keep the list sorted Most Recently Used). */
2471 struct gdbarch_list *self = XNEW (struct gdbarch_list);
2472 self->next = rego->arches;
2473 self->gdbarch = new_gdbarch;
2474 rego->arches = self;
2477 /* Check that the newly installed architecture is valid. Plug in
2478 any post init values. */
2479 new_gdbarch->dump_tdep = rego->dump_tdep;
2480 verify_gdbarch (new_gdbarch);
2481 new_gdbarch->initialized_p = 1;
2484 gdbarch_dump (new_gdbarch, gdb_stdlog);
2489 /* Make the specified architecture current. */
2492 set_target_gdbarch (struct gdbarch *new_gdbarch)
2494 gdb_assert (new_gdbarch != NULL);
2495 gdb_assert (new_gdbarch->initialized_p);
2496 current_inferior ()->gdbarch = new_gdbarch;
2497 observer_notify_architecture_changed (new_gdbarch);
2498 registers_changed ();
2501 /* Return the current inferior's arch. */
2504 target_gdbarch (void)
2506 return current_inferior ()->gdbarch;
2509 extern void _initialize_gdbarch (void);
2512 _initialize_gdbarch (void)
2514 add_setshow_zuinteger_cmd ("arch", class_maintenance, &gdbarch_debug, _("\\
2515 Set architecture debugging."), _("\\
2516 Show architecture debugging."), _("\\
2517 When non-zero, architecture debugging is enabled."),
2520 &setdebuglist, &showdebuglist);
2526 #../move-if-change new-gdbarch.c gdbarch.c
2527 compare_new gdbarch.c