gdb/gdbarch.sh

   1 #!/bin/sh -u
   2
   3 # Architecture commands for GDB, the GNU debugger.
   4 #
   5 # Copyright (C) 1998-2019 Free Software Foundation, Inc.
   6 #
   7 # This file is part of GDB.
   8 #
   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.
  13 #
  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.
  18 #
  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/>.
  21
  22 # Make certain that the script is not running in an internationalized
  23 # environment.
  24 LANG=C ; export LANG
  25 LC_ALL=C ; export LC_ALL
  26
  27
  28 compare_new ()
  29 {
  30     file=$1
  31     if test ! -r ${file}
  32     then
  33         echo "${file} missing? cp new-${file} ${file}" 1>&2
  34     elif diff -u ${file} new-${file}
  35     then
  36         echo "${file} unchanged" 1>&2
  37     else
  38         echo "${file} has changed? cp new-${file} ${file}" 1>&2
  39     fi
  40 }
  41
  42
  43 # Format of the input table
  44 read="class returntype function formal actual staticdefault predefault postdefault invalid_p print garbage_at_eol"
  45
  46 do_read ()
  47 {
  48     comment=""
  49     class=""
  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
  54     do
  55         if test "${line}" = ""
  56         then
  57             continue
  58         elif test "${line}" = "#" -a "${comment}" = ""
  59         then
  60             continue
  61         elif expr "${line}" : "#" > /dev/null
  62         then
  63             comment="${comment}
  64 ${line}"
  65         else
  66
  67             # The semantics of IFS varies between different SH's.  Some
  68             # treat ``;;' as three fields while some treat it as just two.
  69             # Work around this by eliminating ``;;'' ....
  70             line="`echo "${line}" | sed -e 's/;;/; ;/g' -e 's/;;/; ;/g'`"
  71
  72             OFS="${IFS}" ; IFS="[;]"
  73             eval read ${read} <<EOF
  74 ${line}
  75 EOF
  76             IFS="${OFS}"
  77
  78             if test -n "${garbage_at_eol}"
  79             then
  80                 echo "Garbage at end-of-line in ${line}" 1>&2
  81                 kill $$
  82                 exit 1
  83             fi
  84
  85             # .... and then going back through each field and strip out those
  86             # that ended up with just that space character.
  87             for r in ${read}
  88             do
  89                 if eval test \"\${${r}}\" = \"\ \"
  90                 then
  91                     eval ${r}=""
  92                 fi
  93             done
  94
  95             case "${class}" in
  96                 m ) staticdefault="${predefault}" ;;
  97                 M ) staticdefault="0" ;;
  98                 * ) test "${staticdefault}" || staticdefault=0 ;;
  99             esac
 100
 101             case "${class}" in
 102             F | V | M )
 103                 case "${invalid_p}" in
 104                 "" )
 105                     if test -n "${predefault}"
 106                     then
 107                         #invalid_p="gdbarch->${function} == ${predefault}"
 108                         predicate="gdbarch->${function} != ${predefault}"
 109                     elif class_is_variable_p
 110                     then
 111                         predicate="gdbarch->${function} != 0"
 112                     elif class_is_function_p
 113                     then
 114                         predicate="gdbarch->${function} != NULL"
 115                     fi
 116                     ;;
 117                 * )
 118                     echo "Predicate function ${function} with invalid_p." 1>&2
 119                     kill $$
 120                     exit 1
 121                     ;;
 122                 esac
 123             esac
 124
 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.
 131
 132             if [ -n "${postdefault}" ]
 133             then
 134                 fallbackdefault="${postdefault}"
 135             elif [ -n "${predefault}" ]
 136             then
 137                 fallbackdefault="${predefault}"
 138             else
 139                 fallbackdefault="0"
 140             fi
 141
 142             #NOT YET: See gdbarch.log for basic verification of
 143             # database
 144
 145             break
 146         fi
 147     done
 148     if [ -n "${class}" ]
 149     then
 150         true
 151     else
 152         false
 153     fi
 154 }
 155
 156
 157 fallback_default_p ()
 158 {
 159     [ -n "${postdefault}" -a "x${invalid_p}" != "x0" ] \
 160         || [ -n "${predefault}" -a "x${invalid_p}" = "x0" ]
 161 }
 162
 163 class_is_variable_p ()
 164 {
 165     case "${class}" in
 166         *v* | *V* ) true ;;
 167         * ) false ;;
 168     esac
 169 }
 170
 171 class_is_function_p ()
 172 {
 173     case "${class}" in
 174         *f* | *F* | *m* | *M* ) true ;;
 175         * ) false ;;
 176     esac
 177 }
 178
 179 class_is_multiarch_p ()
 180 {
 181     case "${class}" in
 182         *m* | *M* ) true ;;
 183         * ) false ;;
 184     esac
 185 }
 186
 187 class_is_predicate_p ()
 188 {
 189     case "${class}" in
 190         *F* | *V* | *M* ) true ;;
 191         * ) false ;;
 192     esac
 193 }
 194
 195 class_is_info_p ()
 196 {
 197     case "${class}" in
 198         *i* ) true ;;
 199         * ) false ;;
 200     esac
 201 }
 202
 203
 204 # dump out/verify the doco
 205 for field in ${read}
 206 do
 207   case ${field} in
 208
 209     class ) : ;;
 210
 211         # # -> line disable
 212         # f -> function
 213         #   hiding a function
 214         # F -> function + predicate
 215         #   hiding a function + predicate to test function validity
 216         # v -> variable
 217         #   hiding a variable
 218         # V -> variable + predicate
 219         #   hiding a variable + predicate to test variables validity
 220         # i -> set from info
 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
 226
 227     returntype ) : ;;
 228
 229         # For functions, the return type; for variables, the data type
 230
 231     function ) : ;;
 232
 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.
 236
 237     formal ) : ;;
 238
 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.
 243
 244     actual ) : ;;
 245
 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.
 249
 250     staticdefault ) : ;;
 251
 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.
 256
 257         # If STATICDEFAULT is empty, zero is used.
 258
 259     predefault ) : ;;
 260
 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.
 265
 266         # If PREDEFAULT is empty, zero is used.
 267
 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.
 271
 272         # A zero PREDEFAULT function will force the fallback to call
 273         # internal_error().
 274
 275         # Variable declarations can refer to ``gdbarch'' which will
 276         # contain the current architecture.  Care should be taken.
 277
 278     postdefault ) : ;;
 279
 280         # A value to assign to MEMBER of the new gdbarch object should
 281         # the target architecture code fail to change the PREDEFAULT
 282         # value.
 283
 284         # If POSTDEFAULT is empty, no post update is performed.
 285
 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.
 289
 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
 293         # PREDEFAULT).
 294
 295         # You cannot specify both a zero INVALID_P and a POSTDEFAULT.
 296
 297         # Variable declarations can refer to ``gdbarch'' which
 298         # will contain the current architecture.  Care should be
 299         # taken.
 300
 301     invalid_p ) : ;;
 302
 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()
 308         # is called.
 309
 310         # If INVALID_P is empty, a check that MEMBER is no longer
 311         # equal to PREDEFAULT is used.
 312
 313         # The expression ``0'' disables the INVALID_P check making
 314         # PREDEFAULT a legitimate value.
 315
 316         # See also PREDEFAULT and POSTDEFAULT.
 317
 318     print ) : ;;
 319
 320         # An optional expression that convers MEMBER to a value
 321         # suitable for formatting using %s.
 322
 323         # If PRINT is empty, core_addr_to_string_nz (for CORE_ADDR)
 324         # or plongest (anything else) is used.
 325
 326     garbage_at_eol ) : ;;
 327
 328         # Catches stray fields.
 329
 330     *)
 331         echo "Bad field ${field}"
 332         exit 1;;
 333   esac
 334 done
 335
 336
 337 function_list ()
 338 {
 339   # See below (DOCO) for description of each field
 340   cat <<EOF
 341 i;const struct bfd_arch_info *;bfd_arch_info;;;&bfd_default_arch_struct;;;;gdbarch_bfd_arch_info (gdbarch)->printable_name
 342 #
 343 i;enum bfd_endian;byte_order;;;BFD_ENDIAN_BIG
 344 i;enum bfd_endian;byte_order_for_code;;;BFD_ENDIAN_BIG
 345 #
 346 i;enum gdb_osabi;osabi;;;GDB_OSABI_UNKNOWN
 347 #
 348 i;const struct target_desc *;target_desc;;;;;;;host_address_to_string (gdbarch->target_desc)
 349
 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
 353
 354 # Number of bits in a short or unsigned short for the target machine.
 355 v;int;short_bit;;;8 * sizeof (short);2*TARGET_CHAR_BIT;;0
 356 # Number of bits in an int or unsigned int for the target machine.
 357 v;int;int_bit;;;8 * sizeof (int);4*TARGET_CHAR_BIT;;0
 358 # Number of bits in a long or unsigned long for the target machine.
 359 v;int;long_bit;;;8 * sizeof (long);4*TARGET_CHAR_BIT;;0
 360 # Number of bits in a long long or unsigned long long for the target
 361 # machine.
 362 v;int;long_long_bit;;;8 * sizeof (LONGEST);2*gdbarch->long_bit;;0
 363
 364 # The ABI default bit-size and format for "half", "float", "double", and
 365 # "long double".  These bit/format pairs should eventually be combined
 366 # into a single object.  For the moment, just initialize them as a pair.
 367 # Each format describes both the big and little endian layouts (if
 368 # useful).
 369
 370 v;int;half_bit;;;16;2*TARGET_CHAR_BIT;;0
 371 v;const struct floatformat **;half_format;;;;;floatformats_ieee_half;;pformat (gdbarch->half_format)
 372 v;int;float_bit;;;8 * sizeof (float);4*TARGET_CHAR_BIT;;0
 373 v;const struct floatformat **;float_format;;;;;floatformats_ieee_single;;pformat (gdbarch->float_format)
 374 v;int;double_bit;;;8 * sizeof (double);8*TARGET_CHAR_BIT;;0
 375 v;const struct floatformat **;double_format;;;;;floatformats_ieee_double;;pformat (gdbarch->double_format)
 376 v;int;long_double_bit;;;8 * sizeof (long double);8*TARGET_CHAR_BIT;;0
 377 v;const struct floatformat **;long_double_format;;;;;floatformats_ieee_double;;pformat (gdbarch->long_double_format)
 378
 379 # The ABI default bit-size for "wchar_t".  wchar_t is a built-in type
 380 # starting with C++11.
 381 v;int;wchar_bit;;;8 * sizeof (wchar_t);4*TARGET_CHAR_BIT;;0
 382 # One if \`wchar_t' is signed, zero if unsigned.
 383 v;int;wchar_signed;;;1;-1;1
 384
 385 # Returns the floating-point format to be used for values of length LENGTH.
 386 # NAME, if non-NULL, is the type name, which may be used to distinguish
 387 # different target formats of the same length.
 388 m;const struct floatformat **;floatformat_for_type;const char *name, int length;name, length;0;default_floatformat_for_type;;0
 389
 390 # For most targets, a pointer on the target and its representation as an
 391 # address in GDB have the same size and "look the same".  For such a
 392 # target, you need only set gdbarch_ptr_bit and gdbarch_addr_bit
 393 # / addr_bit will be set from it.
 394 #
 395 # If gdbarch_ptr_bit and gdbarch_addr_bit are different, you'll probably
 396 # also need to set gdbarch_dwarf2_addr_size, gdbarch_pointer_to_address and
 397 # gdbarch_address_to_pointer as well.
 398 #
 399 # ptr_bit is the size of a pointer on the target
 400 v;int;ptr_bit;;;8 * sizeof (void*);gdbarch->int_bit;;0
 401 # addr_bit is the size of a target address as represented in gdb
 402 v;int;addr_bit;;;8 * sizeof (void*);0;gdbarch_ptr_bit (gdbarch);
 403 #
 404 # dwarf2_addr_size is the target address size as used in the Dwarf debug
 405 # info.  For .debug_frame FDEs, this is supposed to be the target address
 406 # size from the associated CU header, and which is equivalent to the
 407 # DWARF2_ADDR_SIZE as defined by the target specific GCC back-end.
 408 # Unfortunately there is no good way to determine this value.  Therefore
 409 # dwarf2_addr_size simply defaults to the target pointer size.
 410 #
 411 # dwarf2_addr_size is not used for .eh_frame FDEs, which are generally
 412 # defined using the target's pointer size so far.
 413 #
 414 # Note that dwarf2_addr_size only needs to be redefined by a target if the
 415 # GCC back-end defines a DWARF2_ADDR_SIZE other than the target pointer size,
 416 # and if Dwarf versions < 4 need to be supported.
 417 v;int;dwarf2_addr_size;;;sizeof (void*);0;gdbarch_ptr_bit (gdbarch) / TARGET_CHAR_BIT;
 418 #
 419 # One if \`char' acts like \`signed char', zero if \`unsigned char'.
 420 v;int;char_signed;;;1;-1;1
 421 #
 422 F;CORE_ADDR;read_pc;readable_regcache *regcache;regcache
 423 F;void;write_pc;struct regcache *regcache, CORE_ADDR val;regcache, val
 424 # Function for getting target's idea of a frame pointer.  FIXME: GDB's
 425 # whole scheme for dealing with "frames" and "frame pointers" needs a
 426 # serious shakedown.
 427 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
 428 #
 429 M;enum register_status;pseudo_register_read;readable_regcache *regcache, int cookednum, gdb_byte *buf;regcache, cookednum, buf
 430 # Read a register into a new struct value.  If the register is wholly
 431 # or partly unavailable, this should call mark_value_bytes_unavailable
 432 # as appropriate.  If this is defined, then pseudo_register_read will
 433 # never be called.
 434 M;struct value *;pseudo_register_read_value;readable_regcache *regcache, int cookednum;regcache, cookednum
 435 M;void;pseudo_register_write;struct regcache *regcache, int cookednum, const gdb_byte *buf;regcache, cookednum, buf
 436 #
 437 v;int;num_regs;;;0;-1
 438 # This macro gives the number of pseudo-registers that live in the
 439 # register namespace but do not get fetched or stored on the target.
 440 # These pseudo-registers may be aliases for other registers,
 441 # combinations of other registers, or they may be computed by GDB.
 442 v;int;num_pseudo_regs;;;0;0;;0
 443
 444 # Assemble agent expression bytecode to collect pseudo-register REG.
 445 # Return -1 if something goes wrong, 0 otherwise.
 446 M;int;ax_pseudo_register_collect;struct agent_expr *ax, int reg;ax, reg
 447
 448 # Assemble agent expression bytecode to push the value of pseudo-register
 449 # REG on the interpreter stack.
 450 # Return -1 if something goes wrong, 0 otherwise.
 451 M;int;ax_pseudo_register_push_stack;struct agent_expr *ax, int reg;ax, reg
 452
 453 # Some targets/architectures can do extra processing/display of
 454 # segmentation faults.  E.g., Intel MPX boundary faults.
 455 # Call the architecture dependent function to handle the fault.
 456 # UIOUT is the output stream where the handler will place information.
 457 M;void;handle_segmentation_fault;struct ui_out *uiout;uiout
 458
 459 # GDB's standard (or well known) register numbers.  These can map onto
 460 # a real register or a pseudo (computed) register or not be defined at
 461 # all (-1).
 462 # gdbarch_sp_regnum will hopefully be replaced by UNWIND_SP.
 463 v;int;sp_regnum;;;-1;-1;;0
 464 v;int;pc_regnum;;;-1;-1;;0
 465 v;int;ps_regnum;;;-1;-1;;0
 466 v;int;fp0_regnum;;;0;-1;;0
 467 # Convert stab register number (from \`r\' declaration) to a gdb REGNUM.
 468 m;int;stab_reg_to_regnum;int stab_regnr;stab_regnr;;no_op_reg_to_regnum;;0
 469 # Provide a default mapping from a ecoff register number to a gdb REGNUM.
 470 m;int;ecoff_reg_to_regnum;int ecoff_regnr;ecoff_regnr;;no_op_reg_to_regnum;;0
 471 # Convert from an sdb register number to an internal gdb register number.
 472 m;int;sdb_reg_to_regnum;int sdb_regnr;sdb_regnr;;no_op_reg_to_regnum;;0
 473 # Provide a default mapping from a DWARF2 register number to a gdb REGNUM.
 474 # Return -1 for bad REGNUM.  Note: Several targets get this wrong.
 475 m;int;dwarf2_reg_to_regnum;int dwarf2_regnr;dwarf2_regnr;;no_op_reg_to_regnum;;0
 476 m;const char *;register_name;int regnr;regnr;;0
 477
 478 # Return the type of a register specified by the architecture.  Only
 479 # the register cache should call this function directly; others should
 480 # use "register_type".
 481 M;struct type *;register_type;int reg_nr;reg_nr
 482
 483 # Generate a dummy frame_id for THIS_FRAME assuming that the frame is
 484 # a dummy frame.  A dummy frame is created before an inferior call,
 485 # the frame_id returned here must match the frame_id that was built
 486 # for the inferior call.  Usually this means the returned frame_id's
 487 # stack address should match the address returned by
 488 # gdbarch_push_dummy_call, and the returned frame_id's code address
 489 # should match the address at which the breakpoint was set in the dummy
 490 # frame.
 491 m;struct frame_id;dummy_id;struct frame_info *this_frame;this_frame;;default_dummy_id;;0
 492 # Implement DUMMY_ID and PUSH_DUMMY_CALL, then delete
 493 # deprecated_fp_regnum.
 494 v;int;deprecated_fp_regnum;;;-1;-1;;0
 495
 496 M;CORE_ADDR;push_dummy_call;struct value *function, struct regcache *regcache, CORE_ADDR bp_addr, int nargs, struct value **args, CORE_ADDR sp, function_call_return_method return_method, CORE_ADDR struct_addr;function, regcache, bp_addr, nargs, args, sp, return_method, struct_addr
 497 v;int;call_dummy_location;;;;AT_ENTRY_POINT;;0
 498 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
 499
 500 # Return true if the code of FRAME is writable.
 501 m;int;code_of_frame_writable;struct frame_info *frame;frame;;default_code_of_frame_writable;;0
 502
 503 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
 504 m;void;print_float_info;struct ui_file *file, struct frame_info *frame, const char *args;file, frame, args;;default_print_float_info;;0
 505 M;void;print_vector_info;struct ui_file *file, struct frame_info *frame, const char *args;file, frame, args
 506 # MAP a GDB RAW register number onto a simulator register number.  See
 507 # also include/...-sim.h.
 508 m;int;register_sim_regno;int reg_nr;reg_nr;;legacy_register_sim_regno;;0
 509 m;int;cannot_fetch_register;int regnum;regnum;;cannot_register_not;;0
 510 m;int;cannot_store_register;int regnum;regnum;;cannot_register_not;;0
 511
 512 # Determine the address where a longjmp will land and save this address
 513 # in PC.  Return nonzero on success.
 514 #
 515 # FRAME corresponds to the longjmp frame.
 516 F;int;get_longjmp_target;struct frame_info *frame, CORE_ADDR *pc;frame, pc
 517
 518 #
 519 v;int;believe_pcc_promotion;;;;;;;
 520 #
 521 m;int;convert_register_p;int regnum, struct type *type;regnum, type;0;generic_convert_register_p;;0
 522 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
 523 f;void;value_to_register;struct frame_info *frame, int regnum, struct type *type, const gdb_byte *buf;frame, regnum, type, buf;0
 524 # Construct a value representing the contents of register REGNUM in
 525 # frame FRAME_ID, interpreted as type TYPE.  The routine needs to
 526 # allocate and return a struct value with all value attributes
 527 # (but not the value contents) filled in.
 528 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
 529 #
 530 m;CORE_ADDR;pointer_to_address;struct type *type, const gdb_byte *buf;type, buf;;unsigned_pointer_to_address;;0
 531 m;void;address_to_pointer;struct type *type, gdb_byte *buf, CORE_ADDR addr;type, buf, addr;;unsigned_address_to_pointer;;0
 532 M;CORE_ADDR;integer_to_address;struct type *type, const gdb_byte *buf;type, buf
 533
 534 # Return the return-value convention that will be used by FUNCTION
 535 # to return a value of type VALTYPE.  FUNCTION may be NULL in which
 536 # case the return convention is computed based only on VALTYPE.
 537 #
 538 # If READBUF is not NULL, extract the return value and save it in this buffer.
 539 #
 540 # If WRITEBUF is not NULL, it contains a return value which will be
 541 # stored into the appropriate register.  This can be used when we want
 542 # to force the value returned by a function (see the "return" command
 543 # for instance).
 544 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
 545
 546 # Return true if the return value of function is stored in the first hidden
 547 # parameter.  In theory, this feature should be language-dependent, specified
 548 # by language and its ABI, such as C++.  Unfortunately, compiler may
 549 # implement it to a target-dependent feature.  So that we need such hook here
 550 # to be aware of this in GDB.
 551 m;int;return_in_first_hidden_param_p;struct type *type;type;;default_return_in_first_hidden_param_p;;0
 552
 553 m;CORE_ADDR;skip_prologue;CORE_ADDR ip;ip;0;0
 554 M;CORE_ADDR;skip_main_prologue;CORE_ADDR ip;ip
 555 # On some platforms, a single function may provide multiple entry points,
 556 # e.g. one that is used for function-pointer calls and a different one
 557 # that is used for direct function calls.
 558 # In order to ensure that breakpoints set on the function will trigger
 559 # no matter via which entry point the function is entered, a platform
 560 # may provide the skip_entrypoint callback.  It is called with IP set
 561 # to the main entry point of a function (as determined by the symbol table),
 562 # and should return the address of the innermost entry point, where the
 563 # actual breakpoint needs to be set.  Note that skip_entrypoint is used
 564 # by GDB common code even when debugging optimized code, where skip_prologue
 565 # is not used.
 566 M;CORE_ADDR;skip_entrypoint;CORE_ADDR ip;ip
 567
 568 f;int;inner_than;CORE_ADDR lhs, CORE_ADDR rhs;lhs, rhs;0;0
 569 m;const gdb_byte *;breakpoint_from_pc;CORE_ADDR *pcptr, int *lenptr;pcptr, lenptr;0;default_breakpoint_from_pc;;0
 570
 571 # Return the breakpoint kind for this target based on *PCPTR.
 572 m;int;breakpoint_kind_from_pc;CORE_ADDR *pcptr;pcptr;;0;
 573
 574 # Return the software breakpoint from KIND.  KIND can have target
 575 # specific meaning like the Z0 kind parameter.
 576 # SIZE is set to the software breakpoint's length in memory.
 577 m;const gdb_byte *;sw_breakpoint_from_kind;int kind, int *size;kind, size;;NULL;;0
 578
 579 # Return the breakpoint kind for this target based on the current
 580 # processor state (e.g. the current instruction mode on ARM) and the
 581 # *PCPTR.  In default, it is gdbarch->breakpoint_kind_from_pc.
 582 m;int;breakpoint_kind_from_current_state;struct regcache *regcache, CORE_ADDR *pcptr;regcache, pcptr;0;default_breakpoint_kind_from_current_state;;0
 583
 584 M;CORE_ADDR;adjust_breakpoint_address;CORE_ADDR bpaddr;bpaddr
 585 m;int;memory_insert_breakpoint;struct bp_target_info *bp_tgt;bp_tgt;0;default_memory_insert_breakpoint;;0
 586 m;int;memory_remove_breakpoint;struct bp_target_info *bp_tgt;bp_tgt;0;default_memory_remove_breakpoint;;0
 587 v;CORE_ADDR;decr_pc_after_break;;;0;;;0
 588
 589 # A function can be addressed by either it's "pointer" (possibly a
 590 # descriptor address) or "entry point" (first executable instruction).
 591 # The method "convert_from_func_ptr_addr" converting the former to the
 592 # latter.  gdbarch_deprecated_function_start_offset is being used to implement
 593 # a simplified subset of that functionality - the function's address
 594 # corresponds to the "function pointer" and the function's start
 595 # corresponds to the "function entry point" - and hence is redundant.
 596
 597 v;CORE_ADDR;deprecated_function_start_offset;;;0;;;0
 598
 599 # Return the remote protocol register number associated with this
 600 # register.  Normally the identity mapping.
 601 m;int;remote_register_number;int regno;regno;;default_remote_register_number;;0
 602
 603 # Fetch the target specific address used to represent a load module.
 604 F;CORE_ADDR;fetch_tls_load_module_address;struct objfile *objfile;objfile
 605 #
 606 v;CORE_ADDR;frame_args_skip;;;0;;;0
 607 m;CORE_ADDR;unwind_pc;struct frame_info *next_frame;next_frame;;default_unwind_pc;;0
 608 m;CORE_ADDR;unwind_sp;struct frame_info *next_frame;next_frame;;default_unwind_sp;;0
 609 # DEPRECATED_FRAME_LOCALS_ADDRESS as been replaced by the per-frame
 610 # frame-base.  Enable frame-base before frame-unwind.
 611 F;int;frame_num_args;struct frame_info *frame;frame
 612 #
 613 M;CORE_ADDR;frame_align;CORE_ADDR address;address
 614 m;int;stabs_argument_has_addr;struct type *type;type;;default_stabs_argument_has_addr;;0
 615 v;int;frame_red_zone_size
 616 #
 617 m;CORE_ADDR;convert_from_func_ptr_addr;CORE_ADDR addr, struct target_ops *targ;addr, targ;;convert_from_func_ptr_addr_identity;;0
 618 # On some machines there are bits in addresses which are not really
 619 # part of the address, but are used by the kernel, the hardware, etc.
 620 # for special purposes.  gdbarch_addr_bits_remove takes out any such bits so
 621 # we get a "real" address such as one would find in a symbol table.
 622 # This is used only for addresses of instructions, and even then I'm
 623 # not sure it's used in all contexts.  It exists to deal with there
 624 # being a few stray bits in the PC which would mislead us, not as some
 625 # sort of generic thing to handle alignment or segmentation (it's
 626 # possible it should be in TARGET_READ_PC instead).
 627 m;CORE_ADDR;addr_bits_remove;CORE_ADDR addr;addr;;core_addr_identity;;0
 628
 629 # On some machines, not all bits of an address word are significant.
 630 # For example, on AArch64, the top bits of an address known as the "tag"
 631 # are ignored by the kernel, the hardware, etc. and can be regarded as
 632 # additional data associated with the address.
 633 v;int;significant_addr_bit;;;;;;0
 634
 635 # FIXME/cagney/2001-01-18: This should be split in two.  A target method that
 636 # indicates if the target needs software single step.  An ISA method to
 637 # implement it.
 638 #
 639 # FIXME/cagney/2001-01-18: The logic is backwards.  It should be asking if the
 640 # target can single step.  If not, then implement single step using breakpoints.
 641 #
 642 # Return a vector of addresses on which the software single step
 643 # breakpoints should be inserted.  NULL means software single step is
 644 # not used.
 645 # Multiple breakpoints may be inserted for some instructions such as
 646 # conditional branch.  However, each implementation must always evaluate
 647 # the condition and only put the breakpoint at the branch destination if
 648 # the condition is true, so that we ensure forward progress when stepping
 649 # past a conditional branch to self.
 650 F;std::vector<CORE_ADDR>;software_single_step;struct regcache *regcache;regcache
 651
 652 # Return non-zero if the processor is executing a delay slot and a
 653 # further single-step is needed before the instruction finishes.
 654 M;int;single_step_through_delay;struct frame_info *frame;frame
 655 # FIXME: cagney/2003-08-28: Need to find a better way of selecting the
 656 # disassembler.  Perhaps objdump can handle it?
 657 f;int;print_insn;bfd_vma vma, struct disassemble_info *info;vma, info;;default_print_insn;;0
 658 f;CORE_ADDR;skip_trampoline_code;struct frame_info *frame, CORE_ADDR pc;frame, pc;;generic_skip_trampoline_code;;0
 659
 660
 661 # If in_solib_dynsym_resolve_code() returns true, and SKIP_SOLIB_RESOLVER
 662 # evaluates non-zero, this is the address where the debugger will place
 663 # a step-resume breakpoint to get us past the dynamic linker.
 664 m;CORE_ADDR;skip_solib_resolver;CORE_ADDR pc;pc;;generic_skip_solib_resolver;;0
 665 # Some systems also have trampoline code for returning from shared libs.
 666 m;int;in_solib_return_trampoline;CORE_ADDR pc, const char *name;pc, name;;generic_in_solib_return_trampoline;;0
 667
 668 # Return true if PC lies inside an indirect branch thunk.
 669 m;bool;in_indirect_branch_thunk;CORE_ADDR pc;pc;;default_in_indirect_branch_thunk;;0
 670
 671 # A target might have problems with watchpoints as soon as the stack
 672 # frame of the current function has been destroyed.  This mostly happens
 673 # as the first action in a function's epilogue.  stack_frame_destroyed_p()
 674 # is defined to return a non-zero value if either the given addr is one
 675 # instruction after the stack destroying instruction up to the trailing
 676 # return instruction or if we can figure out that the stack frame has
 677 # already been invalidated regardless of the value of addr.  Targets
 678 # which don't suffer from that problem could just let this functionality
 679 # untouched.
 680 m;int;stack_frame_destroyed_p;CORE_ADDR addr;addr;0;generic_stack_frame_destroyed_p;;0
 681 # Process an ELF symbol in the minimal symbol table in a backend-specific
 682 # way.  Normally this hook is supposed to do nothing, however if required,
 683 # then this hook can be used to apply tranformations to symbols that are
 684 # considered special in some way.  For example the MIPS backend uses it
 685 # to interpret \`st_other' information to mark compressed code symbols so
 686 # that they can be treated in the appropriate manner in the processing of
 687 # the main symbol table and DWARF-2 records.
 688 F;void;elf_make_msymbol_special;asymbol *sym, struct minimal_symbol *msym;sym, msym
 689 f;void;coff_make_msymbol_special;int val, struct minimal_symbol *msym;val, msym;;default_coff_make_msymbol_special;;0
 690 # Process a symbol in the main symbol table in a backend-specific way.
 691 # Normally this hook is supposed to do nothing, however if required,
 692 # then this hook can be used to apply tranformations to symbols that
 693 # are considered special in some way.  This is currently used by the
 694 # MIPS backend to make sure compressed code symbols have the ISA bit
 695 # set.  This in turn is needed for symbol values seen in GDB to match
 696 # the values used at the runtime by the program itself, for function
 697 # and label references.
 698 f;void;make_symbol_special;struct symbol *sym, struct objfile *objfile;sym, objfile;;default_make_symbol_special;;0
 699 # Adjust the address retrieved from a DWARF-2 record other than a line
 700 # entry in a backend-specific way.  Normally this hook is supposed to
 701 # return the address passed unchanged, however if that is incorrect for
 702 # any reason, then this hook can be used to fix the address up in the
 703 # required manner.  This is currently used by the MIPS backend to make
 704 # sure addresses in FDE, range records, etc. referring to compressed
 705 # code have the ISA bit set, matching line information and the symbol
 706 # table.
 707 f;CORE_ADDR;adjust_dwarf2_addr;CORE_ADDR pc;pc;;default_adjust_dwarf2_addr;;0
 708 # Adjust the address updated by a line entry in a backend-specific way.
 709 # Normally this hook is supposed to return the address passed unchanged,
 710 # however in the case of inconsistencies in these records, this hook can
 711 # be used to fix them up in the required manner.  This is currently used
 712 # by the MIPS backend to make sure all line addresses in compressed code
 713 # are presented with the ISA bit set, which is not always the case.  This
 714 # in turn ensures breakpoint addresses are correctly matched against the
 715 # stop PC.
 716 f;CORE_ADDR;adjust_dwarf2_line;CORE_ADDR addr, int rel;addr, rel;;default_adjust_dwarf2_line;;0
 717 v;int;cannot_step_breakpoint;;;0;0;;0
 718 # See comment in target.h about continuable, steppable and
 719 # non-steppable watchpoints.
 720 v;int;have_nonsteppable_watchpoint;;;0;0;;0
 721 F;int;address_class_type_flags;int byte_size, int dwarf2_addr_class;byte_size, dwarf2_addr_class
 722 M;const char *;address_class_type_flags_to_name;int type_flags;type_flags
 723 # Execute vendor-specific DWARF Call Frame Instruction.  OP is the instruction.
 724 # FS are passed from the generic execute_cfa_program function.
 725 m;bool;execute_dwarf_cfa_vendor_op;gdb_byte op, struct dwarf2_frame_state *fs;op, fs;;default_execute_dwarf_cfa_vendor_op;;0
 726
 727 # Return the appropriate type_flags for the supplied address class.
 728 # This function should return 1 if the address class was recognized and
 729 # type_flags was set, zero otherwise.
 730 M;int;address_class_name_to_type_flags;const char *name, int *type_flags_ptr;name, type_flags_ptr
 731 # Is a register in a group
 732 m;int;register_reggroup_p;int regnum, struct reggroup *reggroup;regnum, reggroup;;default_register_reggroup_p;;0
 733 # Fetch the pointer to the ith function argument.
 734 F;CORE_ADDR;fetch_pointer_argument;struct frame_info *frame, int argi, struct type *type;frame, argi, type
 735
 736 # Iterate over all supported register notes in a core file.  For each
 737 # supported register note section, the iterator must call CB and pass
 738 # CB_DATA unchanged.  If REGCACHE is not NULL, the iterator can limit
 739 # the supported register note sections based on the current register
 740 # values.  Otherwise it should enumerate all supported register note
 741 # sections.
 742 M;void;iterate_over_regset_sections;iterate_over_regset_sections_cb *cb, void *cb_data, const struct regcache *regcache;cb, cb_data, regcache
 743
 744 # Create core file notes
 745 M;char *;make_corefile_notes;bfd *obfd, int *note_size;obfd, note_size
 746
 747 # Find core file memory regions
 748 M;int;find_memory_regions;find_memory_region_ftype func, void *data;func, data
 749
 750 # Read offset OFFSET of TARGET_OBJECT_LIBRARIES formatted shared libraries list from
 751 # core file into buffer READBUF with length LEN.  Return the number of bytes read
 752 # (zero indicates failure).
 753 # failed, otherwise, return the red length of READBUF.
 754 M;ULONGEST;core_xfer_shared_libraries;gdb_byte *readbuf, ULONGEST offset, ULONGEST len;readbuf, offset, len
 755
 756 # Read offset OFFSET of TARGET_OBJECT_LIBRARIES_AIX formatted shared
 757 # libraries list from core file into buffer READBUF with length LEN.
 758 # Return the number of bytes read (zero indicates failure).
 759 M;ULONGEST;core_xfer_shared_libraries_aix;gdb_byte *readbuf, ULONGEST offset, ULONGEST len;readbuf, offset, len
 760
 761 # How the core target converts a PTID from a core file to a string.
 762 M;const char *;core_pid_to_str;ptid_t ptid;ptid
 763
 764 # How the core target extracts the name of a thread from a core file.
 765 M;const char *;core_thread_name;struct thread_info *thr;thr
 766
 767 # Read offset OFFSET of TARGET_OBJECT_SIGNAL_INFO signal information
 768 # from core file into buffer READBUF with length LEN.  Return the number
 769 # of bytes read (zero indicates EOF, a negative value indicates failure).
 770 M;LONGEST;core_xfer_siginfo;gdb_byte *readbuf, ULONGEST offset, ULONGEST len; readbuf, offset, len
 771
 772 # BFD target to use when generating a core file.
 773 V;const char *;gcore_bfd_target;;;0;0;;;pstring (gdbarch->gcore_bfd_target)
 774
 775 # If the elements of C++ vtables are in-place function descriptors rather
 776 # than normal function pointers (which may point to code or a descriptor),
 777 # set this to one.
 778 v;int;vtable_function_descriptors;;;0;0;;0
 779
 780 # Set if the least significant bit of the delta is used instead of the least
 781 # significant bit of the pfn for pointers to virtual member functions.
 782 v;int;vbit_in_delta;;;0;0;;0
 783
 784 # Advance PC to next instruction in order to skip a permanent breakpoint.
 785 f;void;skip_permanent_breakpoint;struct regcache *regcache;regcache;default_skip_permanent_breakpoint;default_skip_permanent_breakpoint;;0
 786
 787 # The maximum length of an instruction on this architecture in bytes.
 788 V;ULONGEST;max_insn_length;;;0;0
 789
 790 # Copy the instruction at FROM to TO, and make any adjustments
 791 # necessary to single-step it at that address.
 792 #
 793 # REGS holds the state the thread's registers will have before
 794 # executing the copied instruction; the PC in REGS will refer to FROM,
 795 # not the copy at TO.  The caller should update it to point at TO later.
 796 #
 797 # Return a pointer to data of the architecture's choice to be passed
 798 # to gdbarch_displaced_step_fixup.  Or, return NULL to indicate that
 799 # the instruction's effects have been completely simulated, with the
 800 # resulting state written back to REGS.
 801 #
 802 # For a general explanation of displaced stepping and how GDB uses it,
 803 # see the comments in infrun.c.
 804 #
 805 # The TO area is only guaranteed to have space for
 806 # gdbarch_max_insn_length (arch) bytes, so this function must not
 807 # write more bytes than that to that area.
 808 #
 809 # If you do not provide this function, GDB assumes that the
 810 # architecture does not support displaced stepping.
 811 #
 812 # If the instruction cannot execute out of line, return NULL.  The
 813 # core falls back to stepping past the instruction in-line instead in
 814 # that case.
 815 M;struct displaced_step_closure *;displaced_step_copy_insn;CORE_ADDR from, CORE_ADDR to, struct regcache *regs;from, to, regs
 816
 817 # Return true if GDB should use hardware single-stepping to execute
 818 # the displaced instruction identified by CLOSURE.  If false,
 819 # GDB will simply restart execution at the displaced instruction
 820 # location, and it is up to the target to ensure GDB will receive
 821 # control again (e.g. by placing a software breakpoint instruction
 822 # into the displaced instruction buffer).
 823 #
 824 # The default implementation returns false on all targets that
 825 # provide a gdbarch_software_single_step routine, and true otherwise.
 826 m;int;displaced_step_hw_singlestep;struct displaced_step_closure *closure;closure;;default_displaced_step_hw_singlestep;;0
 827
 828 # Fix up the state resulting from successfully single-stepping a
 829 # displaced instruction, to give the result we would have gotten from
 830 # stepping the instruction in its original location.
 831 #
 832 # REGS is the register state resulting from single-stepping the
 833 # displaced instruction.
 834 #
 835 # CLOSURE is the result from the matching call to
 836 # gdbarch_displaced_step_copy_insn.
 837 #
 838 # If you provide gdbarch_displaced_step_copy_insn.but not this
 839 # function, then GDB assumes that no fixup is needed after
 840 # single-stepping the instruction.
 841 #
 842 # For a general explanation of displaced stepping and how GDB uses it,
 843 # see the comments in infrun.c.
 844 M;void;displaced_step_fixup;struct displaced_step_closure *closure, CORE_ADDR from, CORE_ADDR to, struct regcache *regs;closure, from, to, regs;;NULL
 845
 846 # Return the address of an appropriate place to put displaced
 847 # instructions while we step over them.  There need only be one such
 848 # place, since we're only stepping one thread over a breakpoint at a
 849 # time.
 850 #
 851 # For a general explanation of displaced stepping and how GDB uses it,
 852 # see the comments in infrun.c.
 853 m;CORE_ADDR;displaced_step_location;void;;;NULL;;(! gdbarch->displaced_step_location) != (! gdbarch->displaced_step_copy_insn)
 854
 855 # Relocate an instruction to execute at a different address.  OLDLOC
 856 # is the address in the inferior memory where the instruction to
 857 # relocate is currently at.  On input, TO points to the destination
 858 # where we want the instruction to be copied (and possibly adjusted)
 859 # to.  On output, it points to one past the end of the resulting
 860 # instruction(s).  The effect of executing the instruction at TO shall
 861 # be the same as if executing it at FROM.  For example, call
 862 # instructions that implicitly push the return address on the stack
 863 # should be adjusted to return to the instruction after OLDLOC;
 864 # relative branches, and other PC-relative instructions need the
 865 # offset adjusted; etc.
 866 M;void;relocate_instruction;CORE_ADDR *to, CORE_ADDR from;to, from;;NULL
 867
 868 # Refresh overlay mapped state for section OSECT.
 869 F;void;overlay_update;struct obj_section *osect;osect
 870
 871 M;const struct target_desc *;core_read_description;struct target_ops *target, bfd *abfd;target, abfd
 872
 873 # Handle special encoding of static variables in stabs debug info.
 874 F;const char *;static_transform_name;const char *name;name
 875 # Set if the address in N_SO or N_FUN stabs may be zero.
 876 v;int;sofun_address_maybe_missing;;;0;0;;0
 877
 878 # Parse the instruction at ADDR storing in the record execution log
 879 # the registers REGCACHE and memory ranges that will be affected when
 880 # the instruction executes, along with their current values.
 881 # Return -1 if something goes wrong, 0 otherwise.
 882 M;int;process_record;struct regcache *regcache, CORE_ADDR addr;regcache, addr
 883
 884 # Save process state after a signal.
 885 # Return -1 if something goes wrong, 0 otherwise.
 886 M;int;process_record_signal;struct regcache *regcache, enum gdb_signal signal;regcache, signal
 887
 888 # Signal translation: translate inferior's signal (target's) number
 889 # into GDB's representation.  The implementation of this method must
 890 # be host independent.  IOW, don't rely on symbols of the NAT_FILE
 891 # header (the nm-*.h files), the host <signal.h> header, or similar
 892 # headers.  This is mainly used when cross-debugging core files ---
 893 # "Live" targets hide the translation behind the target interface
 894 # (target_wait, target_resume, etc.).
 895 M;enum gdb_signal;gdb_signal_from_target;int signo;signo
 896
 897 # Signal translation: translate the GDB's internal signal number into
 898 # the inferior's signal (target's) representation.  The implementation
 899 # of this method must be host independent.  IOW, don't rely on symbols
 900 # of the NAT_FILE header (the nm-*.h files), the host <signal.h>
 901 # header, or similar headers.
 902 # Return the target signal number if found, or -1 if the GDB internal
 903 # signal number is invalid.
 904 M;int;gdb_signal_to_target;enum gdb_signal signal;signal
 905
 906 # Extra signal info inspection.
 907 #
 908 # Return a type suitable to inspect extra signal information.
 909 M;struct type *;get_siginfo_type;void;
 910
 911 # Record architecture-specific information from the symbol table.
 912 M;void;record_special_symbol;struct objfile *objfile, asymbol *sym;objfile, sym
 913
 914 # Function for the 'catch syscall' feature.
 915
 916 # Get architecture-specific system calls information from registers.
 917 M;LONGEST;get_syscall_number;thread_info *thread;thread
 918
 919 # The filename of the XML syscall for this architecture.
 920 v;const char *;xml_syscall_file;;;0;0;;0;pstring (gdbarch->xml_syscall_file)
 921
 922 # Information about system calls from this architecture
 923 v;struct syscalls_info *;syscalls_info;;;0;0;;0;host_address_to_string (gdbarch->syscalls_info)
 924
 925 # SystemTap related fields and functions.
 926
 927 # A NULL-terminated array of prefixes used to mark an integer constant
 928 # on the architecture's assembly.
 929 # For example, on x86 integer constants are written as:
 930 #
 931 #  \$10 ;; integer constant 10
 932 #
 933 # in this case, this prefix would be the character \`\$\'.
 934 v;const char *const *;stap_integer_prefixes;;;0;0;;0;pstring_list (gdbarch->stap_integer_prefixes)
 935
 936 # A NULL-terminated array of suffixes used to mark an integer constant
 937 # on the architecture's assembly.
 938 v;const char *const *;stap_integer_suffixes;;;0;0;;0;pstring_list (gdbarch->stap_integer_suffixes)
 939
 940 # A NULL-terminated array of prefixes used to mark a register name on
 941 # the architecture's assembly.
 942 # For example, on x86 the register name is written as:
 943 #
 944 #  \%eax ;; register eax
 945 #
 946 # in this case, this prefix would be the character \`\%\'.
 947 v;const char *const *;stap_register_prefixes;;;0;0;;0;pstring_list (gdbarch->stap_register_prefixes)
 948
 949 # A NULL-terminated array of suffixes used to mark a register name on
 950 # the architecture's assembly.
 951 v;const char *const *;stap_register_suffixes;;;0;0;;0;pstring_list (gdbarch->stap_register_suffixes)
 952
 953 # A NULL-terminated array of prefixes used to mark a register
 954 # indirection on the architecture's assembly.
 955 # For example, on x86 the register indirection is written as:
 956 #
 957 #  \(\%eax\) ;; indirecting eax
 958 #
 959 # in this case, this prefix would be the charater \`\(\'.
 960 #
 961 # Please note that we use the indirection prefix also for register
 962 # displacement, e.g., \`4\(\%eax\)\' on x86.
 963 v;const char *const *;stap_register_indirection_prefixes;;;0;0;;0;pstring_list (gdbarch->stap_register_indirection_prefixes)
 964
 965 # A NULL-terminated array of suffixes used to mark a register
 966 # indirection on the architecture's assembly.
 967 # For example, on x86 the register indirection is written as:
 968 #
 969 #  \(\%eax\) ;; indirecting eax
 970 #
 971 # in this case, this prefix would be the charater \`\)\'.
 972 #
 973 # Please note that we use the indirection suffix also for register
 974 # displacement, e.g., \`4\(\%eax\)\' on x86.
 975 v;const char *const *;stap_register_indirection_suffixes;;;0;0;;0;pstring_list (gdbarch->stap_register_indirection_suffixes)
 976
 977 # Prefix(es) used to name a register using GDB's nomenclature.
 978 #
 979 # For example, on PPC a register is represented by a number in the assembly
 980 # language (e.g., \`10\' is the 10th general-purpose register).  However,
 981 # inside GDB this same register has an \`r\' appended to its name, so the 10th
 982 # register would be represented as \`r10\' internally.
 983 v;const char *;stap_gdb_register_prefix;;;0;0;;0;pstring (gdbarch->stap_gdb_register_prefix)
 984
 985 # Suffix used to name a register using GDB's nomenclature.
 986 v;const char *;stap_gdb_register_suffix;;;0;0;;0;pstring (gdbarch->stap_gdb_register_suffix)
 987
 988 # Check if S is a single operand.
 989 #
 990 # Single operands can be:
 991 #  \- Literal integers, e.g. \`\$10\' on x86
 992 #  \- Register access, e.g. \`\%eax\' on x86
 993 #  \- Register indirection, e.g. \`\(\%eax\)\' on x86
 994 #  \- Register displacement, e.g. \`4\(\%eax\)\' on x86
 995 #
 996 # This function should check for these patterns on the string
 997 # and return 1 if some were found, or zero otherwise.  Please try to match
 998 # as much info as you can from the string, i.e., if you have to match
 999 # something like \`\(\%\', do not match just the \`\(\'.
1000 M;int;stap_is_single_operand;const char *s;s
1001
1002 # Function used to handle a "special case" in the parser.
1003 #
1004 # A "special case" is considered to be an unknown token, i.e., a token
1005 # that the parser does not know how to parse.  A good example of special
1006 # case would be ARM's register displacement syntax:
1007 #
1008 #  [R0, #4]  ;; displacing R0 by 4
1009 #
1010 # Since the parser assumes that a register displacement is of the form:
1011 #
1012 #  <number> <indirection_prefix> <register_name> <indirection_suffix>
1013 #
1014 # it means that it will not be able to recognize and parse this odd syntax.
1015 # Therefore, we should add a special case function that will handle this token.
1016 #
1017 # This function should generate the proper expression form of the expression
1018 # using GDB\'s internal expression mechanism (e.g., \`write_exp_elt_opcode\'
1019 # and so on).  It should also return 1 if the parsing was successful, or zero
1020 # if the token was not recognized as a special token (in this case, returning
1021 # zero means that the special parser is deferring the parsing to the generic
1022 # parser), and should advance the buffer pointer (p->arg).
1023 M;int;stap_parse_special_token;struct stap_parse_info *p;p
1024
1025 # Perform arch-dependent adjustments to a register name.
1026 #
1027 # In very specific situations, it may be necessary for the register
1028 # name present in a SystemTap probe's argument to be handled in a
1029 # special way.  For example, on i386, GCC may over-optimize the
1030 # register allocation and use smaller registers than necessary.  In
1031 # such cases, the client that is reading and evaluating the SystemTap
1032 # probe (ourselves) will need to actually fetch values from the wider
1033 # version of the register in question.
1034 #
1035 # To illustrate the example, consider the following probe argument
1036 # (i386):
1037 #
1038 #    4@%ax
1039 #
1040 # This argument says that its value can be found at the %ax register,
1041 # which is a 16-bit register.  However, the argument's prefix says
1042 # that its type is "uint32_t", which is 32-bit in size.  Therefore, in
1043 # this case, GDB should actually fetch the probe's value from register
1044 # %eax, not %ax.  In this scenario, this function would actually
1045 # replace the register name from %ax to %eax.
1046 #
1047 # The rationale for this can be found at PR breakpoints/24541.
1048 M;void;stap_adjust_register;struct stap_parse_info *p, std::string \&regname, int regnum;p, regname, regnum
1049
1050 # DTrace related functions.
1051
1052 # The expression to compute the NARTGth+1 argument to a DTrace USDT probe.
1053 # NARG must be >= 0.
1054 M;void;dtrace_parse_probe_argument;struct parser_state *pstate, int narg;pstate, narg
1055
1056 # True if the given ADDR does not contain the instruction sequence
1057 # corresponding to a disabled DTrace is-enabled probe.
1058 M;int;dtrace_probe_is_enabled;CORE_ADDR addr;addr
1059
1060 # Enable a DTrace is-enabled probe at ADDR.
1061 M;void;dtrace_enable_probe;CORE_ADDR addr;addr
1062
1063 # Disable a DTrace is-enabled probe at ADDR.
1064 M;void;dtrace_disable_probe;CORE_ADDR addr;addr
1065
1066 # True if the list of shared libraries is one and only for all
1067 # processes, as opposed to a list of shared libraries per inferior.
1068 # This usually means that all processes, although may or may not share
1069 # an address space, will see the same set of symbols at the same
1070 # addresses.
1071 v;int;has_global_solist;;;0;0;;0
1072
1073 # On some targets, even though each inferior has its own private
1074 # address space, the debug interface takes care of making breakpoints
1075 # visible to all address spaces automatically.  For such cases,
1076 # this property should be set to true.
1077 v;int;has_global_breakpoints;;;0;0;;0
1078
1079 # True if inferiors share an address space (e.g., uClinux).
1080 m;int;has_shared_address_space;void;;;default_has_shared_address_space;;0
1081
1082 # True if a fast tracepoint can be set at an address.
1083 m;int;fast_tracepoint_valid_at;CORE_ADDR addr, std::string *msg;addr, msg;;default_fast_tracepoint_valid_at;;0
1084
1085 # Guess register state based on tracepoint location.  Used for tracepoints
1086 # where no registers have been collected, but there's only one location,
1087 # allowing us to guess the PC value, and perhaps some other registers.
1088 # On entry, regcache has all registers marked as unavailable.
1089 m;void;guess_tracepoint_registers;struct regcache *regcache, CORE_ADDR addr;regcache, addr;;default_guess_tracepoint_registers;;0
1090
1091 # Return the "auto" target charset.
1092 f;const char *;auto_charset;void;;default_auto_charset;default_auto_charset;;0
1093 # Return the "auto" target wide charset.
1094 f;const char *;auto_wide_charset;void;;default_auto_wide_charset;default_auto_wide_charset;;0
1095
1096 # If non-empty, this is a file extension that will be opened in place
1097 # of the file extension reported by the shared library list.
1098 #
1099 # This is most useful for toolchains that use a post-linker tool,
1100 # where the names of the files run on the target differ in extension
1101 # compared to the names of the files GDB should load for debug info.
1102 v;const char *;solib_symbols_extension;;;;;;;pstring (gdbarch->solib_symbols_extension)
1103
1104 # If true, the target OS has DOS-based file system semantics.  That
1105 # is, absolute paths include a drive name, and the backslash is
1106 # considered a directory separator.
1107 v;int;has_dos_based_file_system;;;0;0;;0
1108
1109 # Generate bytecodes to collect the return address in a frame.
1110 # Since the bytecodes run on the target, possibly with GDB not even
1111 # connected, the full unwinding machinery is not available, and
1112 # typically this function will issue bytecodes for one or more likely
1113 # places that the return address may be found.
1114 m;void;gen_return_address;struct agent_expr *ax, struct axs_value *value, CORE_ADDR scope;ax, value, scope;;default_gen_return_address;;0
1115
1116 # Implement the "info proc" command.
1117 M;void;info_proc;const char *args, enum info_proc_what what;args, what
1118
1119 # Implement the "info proc" command for core files.  Noe that there
1120 # are two "info_proc"-like methods on gdbarch -- one for core files,
1121 # one for live targets.
1122 M;void;core_info_proc;const char *args, enum info_proc_what what;args, what
1123
1124 # Iterate over all objfiles in the order that makes the most sense
1125 # for the architecture to make global symbol searches.
1126 #
1127 # CB is a callback function where OBJFILE is the objfile to be searched,
1128 # and CB_DATA a pointer to user-defined data (the same data that is passed
1129 # when calling this gdbarch method).  The iteration stops if this function
1130 # returns nonzero.
1131 #
1132 # CB_DATA is a pointer to some user-defined data to be passed to
1133 # the callback.
1134 #
1135 # If not NULL, CURRENT_OBJFILE corresponds to the objfile being
1136 # inspected when the symbol search was requested.
1137 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
1138
1139 # Ravenscar arch-dependent ops.
1140 v;struct ravenscar_arch_ops *;ravenscar_ops;;;NULL;NULL;;0;host_address_to_string (gdbarch->ravenscar_ops)
1141
1142 # Return non-zero if the instruction at ADDR is a call; zero otherwise.
1143 m;int;insn_is_call;CORE_ADDR addr;addr;;default_insn_is_call;;0
1144
1145 # Return non-zero if the instruction at ADDR is a return; zero otherwise.
1146 m;int;insn_is_ret;CORE_ADDR addr;addr;;default_insn_is_ret;;0
1147
1148 # Return non-zero if the instruction at ADDR is a jump; zero otherwise.
1149 m;int;insn_is_jump;CORE_ADDR addr;addr;;default_insn_is_jump;;0
1150
1151 # Read one auxv entry from *READPTR, not reading locations >= ENDPTR.
1152 # Return 0 if *READPTR is already at the end of the buffer.
1153 # Return -1 if there is insufficient buffer for a whole entry.
1154 # Return 1 if an entry was read into *TYPEP and *VALP.
1155 M;int;auxv_parse;gdb_byte **readptr, gdb_byte *endptr, CORE_ADDR *typep, CORE_ADDR *valp;readptr, endptr, typep, valp
1156
1157 # Print the description of a single auxv entry described by TYPE and VAL
1158 # to FILE.
1159 m;void;print_auxv_entry;struct ui_file *file, CORE_ADDR type, CORE_ADDR val;file, type, val;;default_print_auxv_entry;;0
1160
1161 # Find the address range of the current inferior's vsyscall/vDSO, and
1162 # write it to *RANGE.  If the vsyscall's length can't be determined, a
1163 # range with zero length is returned.  Returns true if the vsyscall is
1164 # found, false otherwise.
1165 m;int;vsyscall_range;struct mem_range *range;range;;default_vsyscall_range;;0
1166
1167 # Allocate SIZE bytes of PROT protected page aligned memory in inferior.
1168 # PROT has GDB_MMAP_PROT_* bitmask format.
1169 # Throw an error if it is not possible.  Returned address is always valid.
1170 f;CORE_ADDR;infcall_mmap;CORE_ADDR size, unsigned prot;size, prot;;default_infcall_mmap;;0
1171
1172 # Deallocate SIZE bytes of memory at ADDR in inferior from gdbarch_infcall_mmap.
1173 # Print a warning if it is not possible.
1174 f;void;infcall_munmap;CORE_ADDR addr, CORE_ADDR size;addr, size;;default_infcall_munmap;;0
1175
1176 # Return string (caller has to use xfree for it) with options for GCC
1177 # to produce code for this target, typically "-m64", "-m32" or "-m31".
1178 # These options are put before CU's DW_AT_producer compilation options so that
1179 # they can override it.  Method may also return NULL.
1180 m;char *;gcc_target_options;void;;;default_gcc_target_options;;0
1181
1182 # Return a regular expression that matches names used by this
1183 # architecture in GNU configury triplets.  The result is statically
1184 # allocated and must not be freed.  The default implementation simply
1185 # returns the BFD architecture name, which is correct in nearly every
1186 # case.
1187 m;const char *;gnu_triplet_regexp;void;;;default_gnu_triplet_regexp;;0
1188
1189 # Return the size in 8-bit bytes of an addressable memory unit on this
1190 # architecture.  This corresponds to the number of 8-bit bytes associated to
1191 # each address in memory.
1192 m;int;addressable_memory_unit_size;void;;;default_addressable_memory_unit_size;;0
1193
1194 # Functions for allowing a target to modify its disassembler options.
1195 v;const char *;disassembler_options_implicit;;;0;0;;0;pstring (gdbarch->disassembler_options_implicit)
1196 v;char **;disassembler_options;;;0;0;;0;pstring_ptr (gdbarch->disassembler_options)
1197 v;const disasm_options_and_args_t *;valid_disassembler_options;;;0;0;;0;host_address_to_string (gdbarch->valid_disassembler_options)
1198
1199 # Type alignment.
1200 m;ULONGEST;type_align;struct type *type;type;;default_type_align;;0
1201
1202 EOF
1203 }
1204
1205 #
1206 # The .log file
1207 #
1208 exec > new-gdbarch.log
1209 function_list | while do_read
1210 do
1211     cat <<EOF
1212 ${class} ${returntype} ${function} ($formal)
1213 EOF
1214     for r in ${read}
1215     do
1216         eval echo \"\ \ \ \ ${r}=\${${r}}\"
1217     done
1218     if class_is_predicate_p && fallback_default_p
1219     then
1220         echo "Error: predicate function ${function} can not have a non- multi-arch default" 1>&2
1221         kill $$
1222         exit 1
1223     fi
1224     if [ "x${invalid_p}" = "x0" -a -n "${postdefault}" ]
1225     then
1226         echo "Error: postdefault is useless when invalid_p=0" 1>&2
1227         kill $$
1228         exit 1
1229     fi
1230     if class_is_multiarch_p
1231     then
1232         if class_is_predicate_p ; then :
1233         elif test "x${predefault}" = "x"
1234         then
1235             echo "Error: pure multi-arch function ${function} must have a predefault" 1>&2
1236             kill $$
1237             exit 1
1238         fi
1239     fi
1240     echo ""
1241 done
1242
1243 exec 1>&2
1244 compare_new gdbarch.log
1245
1246
1247 copyright ()
1248 {
1249 cat <<EOF
1250 /* *INDENT-OFF* */ /* THIS FILE IS GENERATED -*- buffer-read-only: t -*- */
1251 /* vi:set ro: */
1252
1253 /* Dynamic architecture support for GDB, the GNU debugger.
1254
1255    Copyright (C) 1998-2019 Free Software Foundation, Inc.
1256
1257    This file is part of GDB.
1258
1259    This program is free software; you can redistribute it and/or modify
1260    it under the terms of the GNU General Public License as published by
1261    the Free Software Foundation; either version 3 of the License, or
1262    (at your option) any later version.
1263
1264    This program is distributed in the hope that it will be useful,
1265    but WITHOUT ANY WARRANTY; without even the implied warranty of
1266    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
1267    GNU General Public License for more details.
1268
1269    You should have received a copy of the GNU General Public License
1270    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
1271
1272 /* This file was created with the aid of \`\`gdbarch.sh''.
1273
1274    The Bourne shell script \`\`gdbarch.sh'' creates the files
1275    \`\`new-gdbarch.c'' and \`\`new-gdbarch.h and then compares them
1276    against the existing \`\`gdbarch.[hc]''.  Any differences found
1277    being reported.
1278
1279    If editing this file, please also run gdbarch.sh and merge any
1280    changes into that script. Conversely, when making sweeping changes
1281    to this file, modifying gdbarch.sh and using its output may prove
1282    easier.  */
1283
1284 EOF
1285 }
1286
1287 #
1288 # The .h file
1289 #
1290
1291 exec > new-gdbarch.h
1292 copyright
1293 cat <<EOF
1294 #ifndef GDBARCH_H
1295 #define GDBARCH_H
1296
1297 #include <vector>
1298 #include "frame.h"
1299 #include "dis-asm.h"
1300 #include "gdb_obstack.h"
1301
1302 struct floatformat;
1303 struct ui_file;
1304 struct value;
1305 struct objfile;
1306 struct obj_section;
1307 struct minimal_symbol;
1308 struct regcache;
1309 struct reggroup;
1310 struct regset;
1311 struct disassemble_info;
1312 struct target_ops;
1313 struct obstack;
1314 struct bp_target_info;
1315 struct target_desc;
1316 struct symbol;
1317 struct displaced_step_closure;
1318 struct syscall;
1319 struct agent_expr;
1320 struct axs_value;
1321 struct stap_parse_info;
1322 struct parser_state;
1323 struct ravenscar_arch_ops;
1324 struct mem_range;
1325 struct syscalls_info;
1326 struct thread_info;
1327 struct ui_out;
1328
1329 #include "regcache.h"
1330
1331 /* The architecture associated with the inferior through the
1332    connection to the target.
1333
1334    The architecture vector provides some information that is really a
1335    property of the inferior, accessed through a particular target:
1336    ptrace operations; the layout of certain RSP packets; the solib_ops
1337    vector; etc.  To differentiate architecture accesses to
1338    per-inferior/target properties from
1339    per-thread/per-frame/per-objfile properties, accesses to
1340    per-inferior/target properties should be made through this
1341    gdbarch.  */
1342
1343 /* This is a convenience wrapper for 'current_inferior ()->gdbarch'.  */
1344 extern struct gdbarch *target_gdbarch (void);
1345
1346 /* Callback type for the 'iterate_over_objfiles_in_search_order'
1347    gdbarch  method.  */
1348
1349 typedef int (iterate_over_objfiles_in_search_order_cb_ftype)
1350   (struct objfile *objfile, void *cb_data);
1351
1352 /* Callback type for regset section iterators.  The callback usually
1353    invokes the REGSET's supply or collect method, to which it must
1354    pass a buffer - for collects this buffer will need to be created using
1355    COLLECT_SIZE, for supply the existing buffer being read from should
1356    be at least SUPPLY_SIZE.  SECT_NAME is a BFD section name, and HUMAN_NAME
1357    is used for diagnostic messages.  CB_DATA should have been passed
1358    unchanged through the iterator.  */
1359
1360 typedef void (iterate_over_regset_sections_cb)
1361   (const char *sect_name, int supply_size, int collect_size,
1362    const struct regset *regset, const char *human_name, void *cb_data);
1363
1364 /* For a function call, does the function return a value using a
1365    normal value return or a structure return - passing a hidden
1366    argument pointing to storage.  For the latter, there are two
1367    cases: language-mandated structure return and target ABI
1368    structure return.  */
1369
1370 enum function_call_return_method
1371 {
1372   /* Standard value return.  */
1373   return_method_normal = 0,
1374
1375   /* Language ABI structure return.  This is handled
1376      by passing the return location as the first parameter to
1377      the function, even preceding "this".  */
1378   return_method_hidden_param,
1379
1380   /* Target ABI struct return.  This is target-specific; for instance,
1381      on ia64 the first argument is passed in out0 but the hidden
1382      structure return pointer would normally be passed in r8.  */
1383   return_method_struct,
1384 };
1385
1386 EOF
1387
1388 # function typedef's
1389 printf "\n"
1390 printf "\n"
1391 printf "/* The following are pre-initialized by GDBARCH.  */\n"
1392 function_list | while do_read
1393 do
1394     if class_is_info_p
1395     then
1396         printf "\n"
1397         printf "extern ${returntype} gdbarch_${function} (struct gdbarch *gdbarch);\n"
1398         printf "/* set_gdbarch_${function}() - not applicable - pre-initialized.  */\n"
1399     fi
1400 done
1401
1402 # function typedef's
1403 printf "\n"
1404 printf "\n"
1405 printf "/* The following are initialized by the target dependent code.  */\n"
1406 function_list | while do_read
1407 do
1408     if [ -n "${comment}" ]
1409     then
1410         echo "${comment}" | sed \
1411             -e '2 s,#,/*,' \
1412             -e '3,$ s,#,  ,' \
1413             -e '$ s,$, */,'
1414     fi
1415
1416     if class_is_predicate_p
1417     then
1418         printf "\n"
1419         printf "extern int gdbarch_${function}_p (struct gdbarch *gdbarch);\n"
1420     fi
1421     if class_is_variable_p
1422     then
1423         printf "\n"
1424         printf "extern ${returntype} gdbarch_${function} (struct gdbarch *gdbarch);\n"
1425         printf "extern void set_gdbarch_${function} (struct gdbarch *gdbarch, ${returntype} ${function});\n"
1426     fi
1427     if class_is_function_p
1428     then
1429         printf "\n"
1430         if [ "x${formal}" = "xvoid" ] && class_is_multiarch_p
1431         then
1432             printf "typedef ${returntype} (gdbarch_${function}_ftype) (struct gdbarch *gdbarch);\n"
1433         elif class_is_multiarch_p
1434         then
1435             printf "typedef ${returntype} (gdbarch_${function}_ftype) (struct gdbarch *gdbarch, ${formal});\n"
1436         else
1437             printf "typedef ${returntype} (gdbarch_${function}_ftype) (${formal});\n"
1438         fi
1439         if [ "x${formal}" = "xvoid" ]
1440         then
1441           printf "extern ${returntype} gdbarch_${function} (struct gdbarch *gdbarch);\n"
1442         else
1443           printf "extern ${returntype} gdbarch_${function} (struct gdbarch *gdbarch, ${formal});\n"
1444         fi
1445         printf "extern void set_gdbarch_${function} (struct gdbarch *gdbarch, gdbarch_${function}_ftype *${function});\n"
1446     fi
1447 done
1448
1449 # close it off
1450 cat <<EOF
1451
1452 extern struct gdbarch_tdep *gdbarch_tdep (struct gdbarch *gdbarch);
1453
1454
1455 /* Mechanism for co-ordinating the selection of a specific
1456    architecture.
1457
1458    GDB targets (*-tdep.c) can register an interest in a specific
1459    architecture.  Other GDB components can register a need to maintain
1460    per-architecture data.
1461
1462    The mechanisms below ensures that there is only a loose connection
1463    between the set-architecture command and the various GDB
1464    components.  Each component can independently register their need
1465    to maintain architecture specific data with gdbarch.
1466
1467    Pragmatics:
1468
1469    Previously, a single TARGET_ARCHITECTURE_HOOK was provided.  It
1470    didn't scale.
1471
1472    The more traditional mega-struct containing architecture specific
1473    data for all the various GDB components was also considered.  Since
1474    GDB is built from a variable number of (fairly independent)
1475    components it was determined that the global aproach was not
1476    applicable.  */
1477
1478
1479 /* Register a new architectural family with GDB.
1480
1481    Register support for the specified ARCHITECTURE with GDB.  When
1482    gdbarch determines that the specified architecture has been
1483    selected, the corresponding INIT function is called.
1484
1485    --
1486
1487    The INIT function takes two parameters: INFO which contains the
1488    information available to gdbarch about the (possibly new)
1489    architecture; ARCHES which is a list of the previously created
1490    \`\`struct gdbarch'' for this architecture.
1491
1492    The INFO parameter is, as far as possible, be pre-initialized with
1493    information obtained from INFO.ABFD or the global defaults.
1494
1495    The ARCHES parameter is a linked list (sorted most recently used)
1496    of all the previously created architures for this architecture
1497    family.  The (possibly NULL) ARCHES->gdbarch can used to access
1498    values from the previously selected architecture for this
1499    architecture family.
1500
1501    The INIT function shall return any of: NULL - indicating that it
1502    doesn't recognize the selected architecture; an existing \`\`struct
1503    gdbarch'' from the ARCHES list - indicating that the new
1504    architecture is just a synonym for an earlier architecture (see
1505    gdbarch_list_lookup_by_info()); a newly created \`\`struct gdbarch''
1506    - that describes the selected architecture (see gdbarch_alloc()).
1507
1508    The DUMP_TDEP function shall print out all target specific values.
1509    Care should be taken to ensure that the function works in both the
1510    multi-arch and non- multi-arch cases.  */
1511
1512 struct gdbarch_list
1513 {
1514   struct gdbarch *gdbarch;
1515   struct gdbarch_list *next;
1516 };
1517
1518 struct gdbarch_info
1519 {
1520   /* Use default: NULL (ZERO).  */
1521   const struct bfd_arch_info *bfd_arch_info;
1522
1523   /* Use default: BFD_ENDIAN_UNKNOWN (NB: is not ZERO).  */
1524   enum bfd_endian byte_order;
1525
1526   enum bfd_endian byte_order_for_code;
1527
1528   /* Use default: NULL (ZERO).  */
1529   bfd *abfd;
1530
1531   /* Use default: NULL (ZERO).  */
1532   union
1533     {
1534       /* Architecture-specific information.  The generic form for targets
1535          that have extra requirements.  */
1536       struct gdbarch_tdep_info *tdep_info;
1537
1538       /* Architecture-specific target description data.  Numerous targets
1539          need only this, so give them an easy way to hold it.  */
1540       struct tdesc_arch_data *tdesc_data;
1541
1542       /* SPU file system ID.  This is a single integer, so using the
1543          generic form would only complicate code.  Other targets may
1544          reuse this member if suitable.  */
1545       int *id;
1546     };
1547
1548   /* Use default: GDB_OSABI_UNINITIALIZED (-1).  */
1549   enum gdb_osabi osabi;
1550
1551   /* Use default: NULL (ZERO).  */
1552   const struct target_desc *target_desc;
1553 };
1554
1555 typedef struct gdbarch *(gdbarch_init_ftype) (struct gdbarch_info info, struct gdbarch_list *arches);
1556 typedef void (gdbarch_dump_tdep_ftype) (struct gdbarch *gdbarch, struct ui_file *file);
1557
1558 /* DEPRECATED - use gdbarch_register() */
1559 extern void register_gdbarch_init (enum bfd_architecture architecture, gdbarch_init_ftype *);
1560
1561 extern void gdbarch_register (enum bfd_architecture architecture,
1562                               gdbarch_init_ftype *,
1563                               gdbarch_dump_tdep_ftype *);
1564
1565
1566 /* Return a freshly allocated, NULL terminated, array of the valid
1567    architecture names.  Since architectures are registered during the
1568    _initialize phase this function only returns useful information
1569    once initialization has been completed.  */
1570
1571 extern const char **gdbarch_printable_names (void);
1572
1573
1574 /* Helper function.  Search the list of ARCHES for a GDBARCH that
1575    matches the information provided by INFO.  */
1576
1577 extern struct gdbarch_list *gdbarch_list_lookup_by_info (struct gdbarch_list *arches, const struct gdbarch_info *info);
1578
1579
1580 /* Helper function.  Create a preliminary \`\`struct gdbarch''.  Perform
1581    basic initialization using values obtained from the INFO and TDEP
1582    parameters.  set_gdbarch_*() functions are called to complete the
1583    initialization of the object.  */
1584
1585 extern struct gdbarch *gdbarch_alloc (const struct gdbarch_info *info, struct gdbarch_tdep *tdep);
1586
1587
1588 /* Helper function.  Free a partially-constructed \`\`struct gdbarch''.
1589    It is assumed that the caller freeds the \`\`struct
1590    gdbarch_tdep''.  */
1591
1592 extern void gdbarch_free (struct gdbarch *);
1593
1594 /* Get the obstack owned by ARCH.  */
1595
1596 extern obstack *gdbarch_obstack (gdbarch *arch);
1597
1598 /* Helper function.  Allocate memory from the \`\`struct gdbarch''
1599    obstack.  The memory is freed when the corresponding architecture
1600    is also freed.  */
1601
1602 #define GDBARCH_OBSTACK_CALLOC(GDBARCH, NR, TYPE) \
1603   obstack_calloc<TYPE> (gdbarch_obstack ((GDBARCH)), (NR))
1604
1605 #define GDBARCH_OBSTACK_ZALLOC(GDBARCH, TYPE) \
1606   obstack_zalloc<TYPE> (gdbarch_obstack ((GDBARCH)))
1607
1608 /* Duplicate STRING, returning an equivalent string that's allocated on the
1609    obstack associated with GDBARCH.  The string is freed when the corresponding
1610    architecture is also freed.  */
1611
1612 extern char *gdbarch_obstack_strdup (struct gdbarch *arch, const char *string);
1613
1614 /* Helper function.  Force an update of the current architecture.
1615
1616    The actual architecture selected is determined by INFO, \`\`(gdb) set
1617    architecture'' et.al., the existing architecture and BFD's default
1618    architecture.  INFO should be initialized to zero and then selected
1619    fields should be updated.
1620
1621    Returns non-zero if the update succeeds.  */
1622
1623 extern int gdbarch_update_p (struct gdbarch_info info);
1624
1625
1626 /* Helper function.  Find an architecture matching info.
1627
1628    INFO should be initialized using gdbarch_info_init, relevant fields
1629    set, and then finished using gdbarch_info_fill.
1630
1631    Returns the corresponding architecture, or NULL if no matching
1632    architecture was found.  */
1633
1634 extern struct gdbarch *gdbarch_find_by_info (struct gdbarch_info info);
1635
1636
1637 /* Helper function.  Set the target gdbarch to "gdbarch".  */
1638
1639 extern void set_target_gdbarch (struct gdbarch *gdbarch);
1640
1641
1642 /* Register per-architecture data-pointer.
1643
1644    Reserve space for a per-architecture data-pointer.  An identifier
1645    for the reserved data-pointer is returned.  That identifer should
1646    be saved in a local static variable.
1647
1648    Memory for the per-architecture data shall be allocated using
1649    gdbarch_obstack_zalloc.  That memory will be deleted when the
1650    corresponding architecture object is deleted.
1651
1652    When a previously created architecture is re-selected, the
1653    per-architecture data-pointer for that previous architecture is
1654    restored.  INIT() is not re-called.
1655
1656    Multiple registrarants for any architecture are allowed (and
1657    strongly encouraged).  */
1658
1659 struct gdbarch_data;
1660
1661 typedef void *(gdbarch_data_pre_init_ftype) (struct obstack *obstack);
1662 extern struct gdbarch_data *gdbarch_data_register_pre_init (gdbarch_data_pre_init_ftype *init);
1663 typedef void *(gdbarch_data_post_init_ftype) (struct gdbarch *gdbarch);
1664 extern struct gdbarch_data *gdbarch_data_register_post_init (gdbarch_data_post_init_ftype *init);
1665 extern void deprecated_set_gdbarch_data (struct gdbarch *gdbarch,
1666                                          struct gdbarch_data *data,
1667                                          void *pointer);
1668
1669 extern void *gdbarch_data (struct gdbarch *gdbarch, struct gdbarch_data *);
1670
1671
1672 /* Set the dynamic target-system-dependent parameters (architecture,
1673    byte-order, ...) using information found in the BFD.  */
1674
1675 extern void set_gdbarch_from_file (bfd *);
1676
1677
1678 /* Initialize the current architecture to the "first" one we find on
1679    our list.  */
1680
1681 extern void initialize_current_architecture (void);
1682
1683 /* gdbarch trace variable */
1684 extern unsigned int gdbarch_debug;
1685
1686 extern void gdbarch_dump (struct gdbarch *gdbarch, struct ui_file *file);
1687
1688 /* Return the number of cooked registers (raw + pseudo) for ARCH.  */
1689
1690 static inline int
1691 gdbarch_num_cooked_regs (gdbarch *arch)
1692 {
1693   return gdbarch_num_regs (arch) + gdbarch_num_pseudo_regs (arch);
1694 }
1695
1696 #endif
1697 EOF
1698 exec 1>&2
1699 #../move-if-change new-gdbarch.h gdbarch.h
1700 compare_new gdbarch.h
1701
1702
1703 #
1704 # C file
1705 #
1706
1707 exec > new-gdbarch.c
1708 copyright
1709 cat <<EOF
1710
1711 #include "defs.h"
1712 #include "arch-utils.h"
1713
1714 #include "gdbcmd.h"
1715 #include "inferior.h"
1716 #include "symcat.h"
1717
1718 #include "floatformat.h"
1719 #include "reggroups.h"
1720 #include "osabi.h"
1721 #include "gdb_obstack.h"
1722 #include "observable.h"
1723 #include "regcache.h"
1724 #include "objfiles.h"
1725 #include "auxv.h"
1726 #include "frame-unwind.h"
1727 #include "dummy-frame.h"
1728
1729 /* Static function declarations */
1730
1731 static void alloc_gdbarch_data (struct gdbarch *);
1732
1733 /* Non-zero if we want to trace architecture code.  */
1734
1735 #ifndef GDBARCH_DEBUG
1736 #define GDBARCH_DEBUG 0
1737 #endif
1738 unsigned int gdbarch_debug = GDBARCH_DEBUG;
1739 static void
1740 show_gdbarch_debug (struct ui_file *file, int from_tty,
1741                     struct cmd_list_element *c, const char *value)
1742 {
1743   fprintf_filtered (file, _("Architecture debugging is %s.\\n"), value);
1744 }
1745
1746 static const char *
1747 pformat (const struct floatformat **format)
1748 {
1749   if (format == NULL)
1750     return "(null)";
1751   else
1752     /* Just print out one of them - this is only for diagnostics.  */
1753     return format[0]->name;
1754 }
1755
1756 static const char *
1757 pstring (const char *string)
1758 {
1759   if (string == NULL)
1760     return "(null)";
1761   return string;
1762 }
1763
1764 static const char *
1765 pstring_ptr (char **string)
1766 {
1767   if (string == NULL || *string == NULL)
1768     return "(null)";
1769   return *string;
1770 }
1771
1772 /* Helper function to print a list of strings, represented as "const
1773    char *const *".  The list is printed comma-separated.  */
1774
1775 static const char *
1776 pstring_list (const char *const *list)
1777 {
1778   static char ret[100];
1779   const char *const *p;
1780   size_t offset = 0;
1781
1782   if (list == NULL)
1783     return "(null)";
1784
1785   ret[0] = '\0';
1786   for (p = list; *p != NULL && offset < sizeof (ret); ++p)
1787     {
1788       size_t s = xsnprintf (ret + offset, sizeof (ret) - offset, "%s, ", *p);
1789       offset += 2 + s;
1790     }
1791
1792   if (offset > 0)
1793     {
1794       gdb_assert (offset - 2 < sizeof (ret));
1795       ret[offset - 2] = '\0';
1796     }
1797
1798   return ret;
1799 }
1800
1801 EOF
1802
1803 # gdbarch open the gdbarch object
1804 printf "\n"
1805 printf "/* Maintain the struct gdbarch object.  */\n"
1806 printf "\n"
1807 printf "struct gdbarch\n"
1808 printf "{\n"
1809 printf "  /* Has this architecture been fully initialized?  */\n"
1810 printf "  int initialized_p;\n"
1811 printf "\n"
1812 printf "  /* An obstack bound to the lifetime of the architecture.  */\n"
1813 printf "  struct obstack *obstack;\n"
1814 printf "\n"
1815 printf "  /* basic architectural information.  */\n"
1816 function_list | while do_read
1817 do
1818     if class_is_info_p
1819     then
1820         printf "  ${returntype} ${function};\n"
1821     fi
1822 done
1823 printf "\n"
1824 printf "  /* target specific vector.  */\n"
1825 printf "  struct gdbarch_tdep *tdep;\n"
1826 printf "  gdbarch_dump_tdep_ftype *dump_tdep;\n"
1827 printf "\n"
1828 printf "  /* per-architecture data-pointers.  */\n"
1829 printf "  unsigned nr_data;\n"
1830 printf "  void **data;\n"
1831 printf "\n"
1832 cat <<EOF
1833   /* Multi-arch values.
1834
1835      When extending this structure you must:
1836
1837      Add the field below.
1838
1839      Declare set/get functions and define the corresponding
1840      macro in gdbarch.h.
1841
1842      gdbarch_alloc(): If zero/NULL is not a suitable default,
1843      initialize the new field.
1844
1845      verify_gdbarch(): Confirm that the target updated the field
1846      correctly.
1847
1848      gdbarch_dump(): Add a fprintf_unfiltered call so that the new
1849      field is dumped out
1850
1851      get_gdbarch(): Implement the set/get functions (probably using
1852      the macro's as shortcuts).
1853
1854      */
1855
1856 EOF
1857 function_list | while do_read
1858 do
1859     if class_is_variable_p
1860     then
1861         printf "  ${returntype} ${function};\n"
1862     elif class_is_function_p
1863     then
1864         printf "  gdbarch_${function}_ftype *${function};\n"
1865     fi
1866 done
1867 printf "};\n"
1868
1869 # Create a new gdbarch struct
1870 cat <<EOF
1871
1872 /* Create a new \`\`struct gdbarch'' based on information provided by
1873    \`\`struct gdbarch_info''.  */
1874 EOF
1875 printf "\n"
1876 cat <<EOF
1877 struct gdbarch *
1878 gdbarch_alloc (const struct gdbarch_info *info,
1879                struct gdbarch_tdep *tdep)
1880 {
1881   struct gdbarch *gdbarch;
1882
1883   /* Create an obstack for allocating all the per-architecture memory,
1884      then use that to allocate the architecture vector.  */
1885   struct obstack *obstack = XNEW (struct obstack);
1886   obstack_init (obstack);
1887   gdbarch = XOBNEW (obstack, struct gdbarch);
1888   memset (gdbarch, 0, sizeof (*gdbarch));
1889   gdbarch->obstack = obstack;
1890
1891   alloc_gdbarch_data (gdbarch);
1892
1893   gdbarch->tdep = tdep;
1894 EOF
1895 printf "\n"
1896 function_list | while do_read
1897 do
1898     if class_is_info_p
1899     then
1900         printf "  gdbarch->${function} = info->${function};\n"
1901     fi
1902 done
1903 printf "\n"
1904 printf "  /* Force the explicit initialization of these.  */\n"
1905 function_list | while do_read
1906 do
1907     if class_is_function_p || class_is_variable_p
1908     then
1909         if [ -n "${predefault}" -a "x${predefault}" != "x0" ]
1910         then
1911           printf "  gdbarch->${function} = ${predefault};\n"
1912         fi
1913     fi
1914 done
1915 cat <<EOF
1916   /* gdbarch_alloc() */
1917
1918   return gdbarch;
1919 }
1920 EOF
1921
1922 # Free a gdbarch struct.
1923 printf "\n"
1924 printf "\n"
1925 cat <<EOF
1926
1927 obstack *gdbarch_obstack (gdbarch *arch)
1928 {
1929   return arch->obstack;
1930 }
1931
1932 /* See gdbarch.h.  */
1933
1934 char *
1935 gdbarch_obstack_strdup (struct gdbarch *arch, const char *string)
1936 {
1937   return obstack_strdup (arch->obstack, string);
1938 }
1939
1940
1941 /* Free a gdbarch struct.  This should never happen in normal
1942    operation --- once you've created a gdbarch, you keep it around.
1943    However, if an architecture's init function encounters an error
1944    building the structure, it may need to clean up a partially
1945    constructed gdbarch.  */
1946
1947 void
1948 gdbarch_free (struct gdbarch *arch)
1949 {
1950   struct obstack *obstack;
1951
1952   gdb_assert (arch != NULL);
1953   gdb_assert (!arch->initialized_p);
1954   obstack = arch->obstack;
1955   obstack_free (obstack, 0); /* Includes the ARCH.  */
1956   xfree (obstack);
1957 }
1958 EOF
1959
1960 # verify a new architecture
1961 cat <<EOF
1962
1963
1964 /* Ensure that all values in a GDBARCH are reasonable.  */
1965
1966 static void
1967 verify_gdbarch (struct gdbarch *gdbarch)
1968 {
1969   string_file log;
1970
1971   /* fundamental */
1972   if (gdbarch->byte_order == BFD_ENDIAN_UNKNOWN)
1973     log.puts ("\n\tbyte-order");
1974   if (gdbarch->bfd_arch_info == NULL)
1975     log.puts ("\n\tbfd_arch_info");
1976   /* Check those that need to be defined for the given multi-arch level.  */
1977 EOF
1978 function_list | while do_read
1979 do
1980     if class_is_function_p || class_is_variable_p
1981     then
1982         if [ "x${invalid_p}" = "x0" ]
1983         then
1984             printf "  /* Skip verify of ${function}, invalid_p == 0 */\n"
1985         elif class_is_predicate_p
1986         then
1987             printf "  /* Skip verify of ${function}, has predicate.  */\n"
1988         # FIXME: See do_read for potential simplification
1989         elif [ -n "${invalid_p}" -a -n "${postdefault}" ]
1990         then
1991             printf "  if (${invalid_p})\n"
1992             printf "    gdbarch->${function} = ${postdefault};\n"
1993         elif [ -n "${predefault}" -a -n "${postdefault}" ]
1994         then
1995             printf "  if (gdbarch->${function} == ${predefault})\n"
1996             printf "    gdbarch->${function} = ${postdefault};\n"
1997         elif [ -n "${postdefault}" ]
1998         then
1999             printf "  if (gdbarch->${function} == 0)\n"
2000             printf "    gdbarch->${function} = ${postdefault};\n"
2001         elif [ -n "${invalid_p}" ]
2002         then
2003             printf "  if (${invalid_p})\n"
2004             printf "    log.puts (\"\\\\n\\\\t${function}\");\n"
2005         elif [ -n "${predefault}" ]
2006         then
2007             printf "  if (gdbarch->${function} == ${predefault})\n"
2008             printf "    log.puts (\"\\\\n\\\\t${function}\");\n"
2009         fi
2010     fi
2011 done
2012 cat <<EOF
2013   if (!log.empty ())
2014     internal_error (__FILE__, __LINE__,
2015                     _("verify_gdbarch: the following are invalid ...%s"),
2016                     log.c_str ());
2017 }
2018 EOF
2019
2020 # dump the structure
2021 printf "\n"
2022 printf "\n"
2023 cat <<EOF
2024 /* Print out the details of the current architecture.  */
2025
2026 void
2027 gdbarch_dump (struct gdbarch *gdbarch, struct ui_file *file)
2028 {
2029   const char *gdb_nm_file = "<not-defined>";
2030
2031 #if defined (GDB_NM_FILE)
2032   gdb_nm_file = GDB_NM_FILE;
2033 #endif
2034   fprintf_unfiltered (file,
2035                       "gdbarch_dump: GDB_NM_FILE = %s\\n",
2036                       gdb_nm_file);
2037 EOF
2038 function_list | sort '-t;' -k 3 | while do_read
2039 do
2040     # First the predicate
2041     if class_is_predicate_p
2042     then
2043         printf "  fprintf_unfiltered (file,\n"
2044         printf "                      \"gdbarch_dump: gdbarch_${function}_p() = %%d\\\\n\",\n"
2045         printf "                      gdbarch_${function}_p (gdbarch));\n"
2046     fi
2047     # Print the corresponding value.
2048     if class_is_function_p
2049     then
2050         printf "  fprintf_unfiltered (file,\n"
2051         printf "                      \"gdbarch_dump: ${function} = <%%s>\\\\n\",\n"
2052         printf "                      host_address_to_string (gdbarch->${function}));\n"
2053     else
2054         # It is a variable
2055         case "${print}:${returntype}" in
2056             :CORE_ADDR )
2057                 fmt="%s"
2058                 print="core_addr_to_string_nz (gdbarch->${function})"
2059                 ;;
2060             :* )
2061                 fmt="%s"
2062                 print="plongest (gdbarch->${function})"
2063                 ;;
2064             * )
2065                 fmt="%s"
2066                 ;;
2067         esac
2068         printf "  fprintf_unfiltered (file,\n"
2069         printf "                      \"gdbarch_dump: ${function} = %s\\\\n\",\n" "${fmt}"
2070         printf "                      ${print});\n"
2071     fi
2072 done
2073 cat <<EOF
2074   if (gdbarch->dump_tdep != NULL)
2075     gdbarch->dump_tdep (gdbarch, file);
2076 }
2077 EOF
2078
2079
2080 # GET/SET
2081 printf "\n"
2082 cat <<EOF
2083 struct gdbarch_tdep *
2084 gdbarch_tdep (struct gdbarch *gdbarch)
2085 {
2086   if (gdbarch_debug >= 2)
2087     fprintf_unfiltered (gdb_stdlog, "gdbarch_tdep called\\n");
2088   return gdbarch->tdep;
2089 }
2090 EOF
2091 printf "\n"
2092 function_list | while do_read
2093 do
2094     if class_is_predicate_p
2095     then
2096         printf "\n"
2097         printf "int\n"
2098         printf "gdbarch_${function}_p (struct gdbarch *gdbarch)\n"
2099         printf "{\n"
2100         printf "  gdb_assert (gdbarch != NULL);\n"
2101         printf "  return ${predicate};\n"
2102         printf "}\n"
2103     fi
2104     if class_is_function_p
2105     then
2106         printf "\n"
2107         printf "${returntype}\n"
2108         if [ "x${formal}" = "xvoid" ]
2109         then
2110           printf "gdbarch_${function} (struct gdbarch *gdbarch)\n"
2111         else
2112           printf "gdbarch_${function} (struct gdbarch *gdbarch, ${formal})\n"
2113         fi
2114         printf "{\n"
2115         printf "  gdb_assert (gdbarch != NULL);\n"
2116         printf "  gdb_assert (gdbarch->${function} != NULL);\n"
2117         if class_is_predicate_p && test -n "${predefault}"
2118         then
2119             # Allow a call to a function with a predicate.
2120             printf "  /* Do not check predicate: ${predicate}, allow call.  */\n"
2121         fi
2122         printf "  if (gdbarch_debug >= 2)\n"
2123         printf "    fprintf_unfiltered (gdb_stdlog, \"gdbarch_${function} called\\\\n\");\n"
2124         if [ "x${actual}" = "x-" -o "x${actual}" = "x" ]
2125         then
2126             if class_is_multiarch_p
2127             then
2128                 params="gdbarch"
2129             else
2130                 params=""
2131             fi
2132         else
2133             if class_is_multiarch_p
2134             then
2135                 params="gdbarch, ${actual}"
2136             else
2137                 params="${actual}"
2138             fi
2139         fi
2140         if [ "x${returntype}" = "xvoid" ]
2141         then
2142           printf "  gdbarch->${function} (${params});\n"
2143         else
2144           printf "  return gdbarch->${function} (${params});\n"
2145         fi
2146         printf "}\n"
2147         printf "\n"
2148         printf "void\n"
2149         printf "set_gdbarch_${function} (struct gdbarch *gdbarch,\n"
2150         printf "            `echo ${function} | sed -e 's/./ /g'`  gdbarch_${function}_ftype ${function})\n"
2151         printf "{\n"
2152         printf "  gdbarch->${function} = ${function};\n"
2153         printf "}\n"
2154     elif class_is_variable_p
2155     then
2156         printf "\n"
2157         printf "${returntype}\n"
2158         printf "gdbarch_${function} (struct gdbarch *gdbarch)\n"
2159         printf "{\n"
2160         printf "  gdb_assert (gdbarch != NULL);\n"
2161         if [ "x${invalid_p}" = "x0" ]
2162         then
2163             printf "  /* Skip verify of ${function}, invalid_p == 0 */\n"
2164         elif [ -n "${invalid_p}" ]
2165         then
2166             printf "  /* Check variable is valid.  */\n"
2167             printf "  gdb_assert (!(${invalid_p}));\n"
2168         elif [ -n "${predefault}" ]
2169         then
2170             printf "  /* Check variable changed from pre-default.  */\n"
2171             printf "  gdb_assert (gdbarch->${function} != ${predefault});\n"
2172         fi
2173         printf "  if (gdbarch_debug >= 2)\n"
2174         printf "    fprintf_unfiltered (gdb_stdlog, \"gdbarch_${function} called\\\\n\");\n"
2175         printf "  return gdbarch->${function};\n"
2176         printf "}\n"
2177         printf "\n"
2178         printf "void\n"
2179         printf "set_gdbarch_${function} (struct gdbarch *gdbarch,\n"
2180         printf "            `echo ${function} | sed -e 's/./ /g'`  ${returntype} ${function})\n"
2181         printf "{\n"
2182         printf "  gdbarch->${function} = ${function};\n"
2183         printf "}\n"
2184     elif class_is_info_p
2185     then
2186         printf "\n"
2187         printf "${returntype}\n"
2188         printf "gdbarch_${function} (struct gdbarch *gdbarch)\n"
2189         printf "{\n"
2190         printf "  gdb_assert (gdbarch != NULL);\n"
2191         printf "  if (gdbarch_debug >= 2)\n"
2192         printf "    fprintf_unfiltered (gdb_stdlog, \"gdbarch_${function} called\\\\n\");\n"
2193         printf "  return gdbarch->${function};\n"
2194         printf "}\n"
2195     fi
2196 done
2197
2198 # All the trailing guff
2199 cat <<EOF
2200
2201
2202 /* Keep a registry of per-architecture data-pointers required by GDB
2203    modules.  */
2204
2205 struct gdbarch_data
2206 {
2207   unsigned index;
2208   int init_p;
2209   gdbarch_data_pre_init_ftype *pre_init;
2210   gdbarch_data_post_init_ftype *post_init;
2211 };
2212
2213 struct gdbarch_data_registration
2214 {
2215   struct gdbarch_data *data;
2216   struct gdbarch_data_registration *next;
2217 };
2218
2219 struct gdbarch_data_registry
2220 {
2221   unsigned nr;
2222   struct gdbarch_data_registration *registrations;
2223 };
2224
2225 struct gdbarch_data_registry gdbarch_data_registry =
2226 {
2227   0, NULL,
2228 };
2229
2230 static struct gdbarch_data *
2231 gdbarch_data_register (gdbarch_data_pre_init_ftype *pre_init,
2232                        gdbarch_data_post_init_ftype *post_init)
2233 {
2234   struct gdbarch_data_registration **curr;
2235
2236   /* Append the new registration.  */
2237   for (curr = &gdbarch_data_registry.registrations;
2238        (*curr) != NULL;
2239        curr = &(*curr)->next);
2240   (*curr) = XNEW (struct gdbarch_data_registration);
2241   (*curr)->next = NULL;
2242   (*curr)->data = XNEW (struct gdbarch_data);
2243   (*curr)->data->index = gdbarch_data_registry.nr++;
2244   (*curr)->data->pre_init = pre_init;
2245   (*curr)->data->post_init = post_init;
2246   (*curr)->data->init_p = 1;
2247   return (*curr)->data;
2248 }
2249
2250 struct gdbarch_data *
2251 gdbarch_data_register_pre_init (gdbarch_data_pre_init_ftype *pre_init)
2252 {
2253   return gdbarch_data_register (pre_init, NULL);
2254 }
2255
2256 struct gdbarch_data *
2257 gdbarch_data_register_post_init (gdbarch_data_post_init_ftype *post_init)
2258 {
2259   return gdbarch_data_register (NULL, post_init);
2260 }
2261
2262 /* Create/delete the gdbarch data vector.  */
2263
2264 static void
2265 alloc_gdbarch_data (struct gdbarch *gdbarch)
2266 {
2267   gdb_assert (gdbarch->data == NULL);
2268   gdbarch->nr_data = gdbarch_data_registry.nr;
2269   gdbarch->data = GDBARCH_OBSTACK_CALLOC (gdbarch, gdbarch->nr_data, void *);
2270 }
2271
2272 /* Initialize the current value of the specified per-architecture
2273    data-pointer.  */
2274
2275 void
2276 deprecated_set_gdbarch_data (struct gdbarch *gdbarch,
2277                              struct gdbarch_data *data,
2278                              void *pointer)
2279 {
2280   gdb_assert (data->index < gdbarch->nr_data);
2281   gdb_assert (gdbarch->data[data->index] == NULL);
2282   gdb_assert (data->pre_init == NULL);
2283   gdbarch->data[data->index] = pointer;
2284 }
2285
2286 /* Return the current value of the specified per-architecture
2287    data-pointer.  */
2288
2289 void *
2290 gdbarch_data (struct gdbarch *gdbarch, struct gdbarch_data *data)
2291 {
2292   gdb_assert (data->index < gdbarch->nr_data);
2293   if (gdbarch->data[data->index] == NULL)
2294     {
2295       /* The data-pointer isn't initialized, call init() to get a
2296          value.  */
2297       if (data->pre_init != NULL)
2298         /* Mid architecture creation: pass just the obstack, and not
2299            the entire architecture, as that way it isn't possible for
2300            pre-init code to refer to undefined architecture
2301            fields.  */
2302         gdbarch->data[data->index] = data->pre_init (gdbarch->obstack);
2303       else if (gdbarch->initialized_p
2304                && data->post_init != NULL)
2305         /* Post architecture creation: pass the entire architecture
2306            (as all fields are valid), but be careful to also detect
2307            recursive references.  */
2308         {
2309           gdb_assert (data->init_p);
2310           data->init_p = 0;
2311           gdbarch->data[data->index] = data->post_init (gdbarch);
2312           data->init_p = 1;
2313         }
2314       else
2315         /* The architecture initialization hasn't completed - punt -
2316          hope that the caller knows what they are doing.  Once
2317          deprecated_set_gdbarch_data has been initialized, this can be
2318          changed to an internal error.  */
2319         return NULL;
2320       gdb_assert (gdbarch->data[data->index] != NULL);
2321     }
2322   return gdbarch->data[data->index];
2323 }
2324
2325
2326 /* Keep a registry of the architectures known by GDB.  */
2327
2328 struct gdbarch_registration
2329 {
2330   enum bfd_architecture bfd_architecture;
2331   gdbarch_init_ftype *init;
2332   gdbarch_dump_tdep_ftype *dump_tdep;
2333   struct gdbarch_list *arches;
2334   struct gdbarch_registration *next;
2335 };
2336
2337 static struct gdbarch_registration *gdbarch_registry = NULL;
2338
2339 static void
2340 append_name (const char ***buf, int *nr, const char *name)
2341 {
2342   *buf = XRESIZEVEC (const char *, *buf, *nr + 1);
2343   (*buf)[*nr] = name;
2344   *nr += 1;
2345 }
2346
2347 const char **
2348 gdbarch_printable_names (void)
2349 {
2350   /* Accumulate a list of names based on the registed list of
2351      architectures.  */
2352   int nr_arches = 0;
2353   const char **arches = NULL;
2354   struct gdbarch_registration *rego;
2355
2356   for (rego = gdbarch_registry;
2357        rego != NULL;
2358        rego = rego->next)
2359     {
2360       const struct bfd_arch_info *ap;
2361       ap = bfd_lookup_arch (rego->bfd_architecture, 0);
2362       if (ap == NULL)
2363         internal_error (__FILE__, __LINE__,
2364                         _("gdbarch_architecture_names: multi-arch unknown"));
2365       do
2366         {
2367           append_name (&arches, &nr_arches, ap->printable_name);
2368           ap = ap->next;
2369         }
2370       while (ap != NULL);
2371     }
2372   append_name (&arches, &nr_arches, NULL);
2373   return arches;
2374 }
2375
2376
2377 void
2378 gdbarch_register (enum bfd_architecture bfd_architecture,
2379                   gdbarch_init_ftype *init,
2380                   gdbarch_dump_tdep_ftype *dump_tdep)
2381 {
2382   struct gdbarch_registration **curr;
2383   const struct bfd_arch_info *bfd_arch_info;
2384
2385   /* Check that BFD recognizes this architecture */
2386   bfd_arch_info = bfd_lookup_arch (bfd_architecture, 0);
2387   if (bfd_arch_info == NULL)
2388     {
2389       internal_error (__FILE__, __LINE__,
2390                       _("gdbarch: Attempt to register "
2391                         "unknown architecture (%d)"),
2392                       bfd_architecture);
2393     }
2394   /* Check that we haven't seen this architecture before.  */
2395   for (curr = &gdbarch_registry;
2396        (*curr) != NULL;
2397        curr = &(*curr)->next)
2398     {
2399       if (bfd_architecture == (*curr)->bfd_architecture)
2400         internal_error (__FILE__, __LINE__,
2401                         _("gdbarch: Duplicate registration "
2402                           "of architecture (%s)"),
2403                         bfd_arch_info->printable_name);
2404     }
2405   /* log it */
2406   if (gdbarch_debug)
2407     fprintf_unfiltered (gdb_stdlog, "register_gdbarch_init (%s, %s)\n",
2408                         bfd_arch_info->printable_name,
2409                         host_address_to_string (init));
2410   /* Append it */
2411   (*curr) = XNEW (struct gdbarch_registration);
2412   (*curr)->bfd_architecture = bfd_architecture;
2413   (*curr)->init = init;
2414   (*curr)->dump_tdep = dump_tdep;
2415   (*curr)->arches = NULL;
2416   (*curr)->next = NULL;
2417 }
2418
2419 void
2420 register_gdbarch_init (enum bfd_architecture bfd_architecture,
2421                        gdbarch_init_ftype *init)
2422 {
2423   gdbarch_register (bfd_architecture, init, NULL);
2424 }
2425
2426
2427 /* Look for an architecture using gdbarch_info.  */
2428
2429 struct gdbarch_list *
2430 gdbarch_list_lookup_by_info (struct gdbarch_list *arches,
2431                              const struct gdbarch_info *info)
2432 {
2433   for (; arches != NULL; arches = arches->next)
2434     {
2435       if (info->bfd_arch_info != arches->gdbarch->bfd_arch_info)
2436         continue;
2437       if (info->byte_order != arches->gdbarch->byte_order)
2438         continue;
2439       if (info->osabi != arches->gdbarch->osabi)
2440         continue;
2441       if (info->target_desc != arches->gdbarch->target_desc)
2442         continue;
2443       return arches;
2444     }
2445   return NULL;
2446 }
2447
2448
2449 /* Find an architecture that matches the specified INFO.  Create a new
2450    architecture if needed.  Return that new architecture.  */
2451
2452 struct gdbarch *
2453 gdbarch_find_by_info (struct gdbarch_info info)
2454 {
2455   struct gdbarch *new_gdbarch;
2456   struct gdbarch_registration *rego;
2457
2458   /* Fill in missing parts of the INFO struct using a number of
2459      sources: "set ..."; INFOabfd supplied; and the global
2460      defaults.  */
2461   gdbarch_info_fill (&info);
2462
2463   /* Must have found some sort of architecture.  */
2464   gdb_assert (info.bfd_arch_info != NULL);
2465
2466   if (gdbarch_debug)
2467     {
2468       fprintf_unfiltered (gdb_stdlog,
2469                           "gdbarch_find_by_info: info.bfd_arch_info %s\n",
2470                           (info.bfd_arch_info != NULL
2471                            ? info.bfd_arch_info->printable_name
2472                            : "(null)"));
2473       fprintf_unfiltered (gdb_stdlog,
2474                           "gdbarch_find_by_info: info.byte_order %d (%s)\n",
2475                           info.byte_order,
2476                           (info.byte_order == BFD_ENDIAN_BIG ? "big"
2477                            : info.byte_order == BFD_ENDIAN_LITTLE ? "little"
2478                            : "default"));
2479       fprintf_unfiltered (gdb_stdlog,
2480                           "gdbarch_find_by_info: info.osabi %d (%s)\n",
2481                           info.osabi, gdbarch_osabi_name (info.osabi));
2482       fprintf_unfiltered (gdb_stdlog,
2483                           "gdbarch_find_by_info: info.abfd %s\n",
2484                           host_address_to_string (info.abfd));
2485       fprintf_unfiltered (gdb_stdlog,
2486                           "gdbarch_find_by_info: info.tdep_info %s\n",
2487                           host_address_to_string (info.tdep_info));
2488     }
2489
2490   /* Find the tdep code that knows about this architecture.  */
2491   for (rego = gdbarch_registry;
2492        rego != NULL;
2493        rego = rego->next)
2494     if (rego->bfd_architecture == info.bfd_arch_info->arch)
2495       break;
2496   if (rego == NULL)
2497     {
2498       if (gdbarch_debug)
2499         fprintf_unfiltered (gdb_stdlog, "gdbarch_find_by_info: "
2500                             "No matching architecture\n");
2501       return 0;
2502     }
2503
2504   /* Ask the tdep code for an architecture that matches "info".  */
2505   new_gdbarch = rego->init (info, rego->arches);
2506
2507   /* Did the tdep code like it?  No.  Reject the change and revert to
2508      the old architecture.  */
2509   if (new_gdbarch == NULL)
2510     {
2511       if (gdbarch_debug)
2512         fprintf_unfiltered (gdb_stdlog, "gdbarch_find_by_info: "
2513                             "Target rejected architecture\n");
2514       return NULL;
2515     }
2516
2517   /* Is this a pre-existing architecture (as determined by already
2518      being initialized)?  Move it to the front of the architecture
2519      list (keeping the list sorted Most Recently Used).  */
2520   if (new_gdbarch->initialized_p)
2521     {
2522       struct gdbarch_list **list;
2523       struct gdbarch_list *self;
2524       if (gdbarch_debug)
2525         fprintf_unfiltered (gdb_stdlog, "gdbarch_find_by_info: "
2526                             "Previous architecture %s (%s) selected\n",
2527                             host_address_to_string (new_gdbarch),
2528                             new_gdbarch->bfd_arch_info->printable_name);
2529       /* Find the existing arch in the list.  */
2530       for (list = &rego->arches;
2531            (*list) != NULL && (*list)->gdbarch != new_gdbarch;
2532            list = &(*list)->next);
2533       /* It had better be in the list of architectures.  */
2534       gdb_assert ((*list) != NULL && (*list)->gdbarch == new_gdbarch);
2535       /* Unlink SELF.  */
2536       self = (*list);
2537       (*list) = self->next;
2538       /* Insert SELF at the front.  */
2539       self->next = rego->arches;
2540       rego->arches = self;
2541       /* Return it.  */
2542       return new_gdbarch;
2543     }
2544
2545   /* It's a new architecture.  */
2546   if (gdbarch_debug)
2547     fprintf_unfiltered (gdb_stdlog, "gdbarch_find_by_info: "
2548                         "New architecture %s (%s) selected\n",
2549                         host_address_to_string (new_gdbarch),
2550                         new_gdbarch->bfd_arch_info->printable_name);
2551
2552   /* Insert the new architecture into the front of the architecture
2553      list (keep the list sorted Most Recently Used).  */
2554   {
2555     struct gdbarch_list *self = XNEW (struct gdbarch_list);
2556     self->next = rego->arches;
2557     self->gdbarch = new_gdbarch;
2558     rego->arches = self;
2559   }
2560
2561   /* Check that the newly installed architecture is valid.  Plug in
2562      any post init values.  */
2563   new_gdbarch->dump_tdep = rego->dump_tdep;
2564   verify_gdbarch (new_gdbarch);
2565   new_gdbarch->initialized_p = 1;
2566
2567   if (gdbarch_debug)
2568     gdbarch_dump (new_gdbarch, gdb_stdlog);
2569
2570   return new_gdbarch;
2571 }
2572
2573 /* Make the specified architecture current.  */
2574
2575 void
2576 set_target_gdbarch (struct gdbarch *new_gdbarch)
2577 {
2578   gdb_assert (new_gdbarch != NULL);
2579   gdb_assert (new_gdbarch->initialized_p);
2580   current_inferior ()->gdbarch = new_gdbarch;
2581   gdb::observers::architecture_changed.notify (new_gdbarch);
2582   registers_changed ();
2583 }
2584
2585 /* Return the current inferior's arch.  */
2586
2587 struct gdbarch *
2588 target_gdbarch (void)
2589 {
2590   return current_inferior ()->gdbarch;
2591 }
2592
2593 void
2594 _initialize_gdbarch (void)
2595 {
2596   add_setshow_zuinteger_cmd ("arch", class_maintenance, &gdbarch_debug, _("\\
2597 Set architecture debugging."), _("\\
2598 Show architecture debugging."), _("\\
2599 When non-zero, architecture debugging is enabled."),
2600                             NULL,
2601                             show_gdbarch_debug,
2602                             &setdebuglist, &showdebuglist);
2603 }
2604 EOF
2605
2606 # close things off
2607 exec 1>&2
2608 #../move-if-change new-gdbarch.c gdbarch.c
2609 compare_new gdbarch.c