gdb/gdbtypes.h

   1 /* Internal type definitions for GDB.
   2
   3    Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
   4    2002, 2003, 2004, 2006, 2007, 2008 Free Software Foundation, Inc.
   5
   6    Contributed by Cygnus Support, using pieces from other GDB modules.
   7
   8    This file is part of GDB.
   9
  10    This program is free software; you can redistribute it and/or modify
  11    it under the terms of the GNU General Public License as published by
  12    the Free Software Foundation; either version 3 of the License, or
  13    (at your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18    GNU General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  22
  23 #if !defined (GDBTYPES_H)
  24 #define GDBTYPES_H 1
  25
  26 #include "hashtab.h"
  27
  28 /* Forward declarations for prototypes.  */
  29 struct field;
  30 struct block;
  31
  32 /* Some macros for char-based bitfields.  */
  33
  34 #define B_SET(a,x)      ((a)[(x)>>3] |= (1 << ((x)&7)))
  35 #define B_CLR(a,x)      ((a)[(x)>>3] &= ~(1 << ((x)&7)))
  36 #define B_TST(a,x)      ((a)[(x)>>3] & (1 << ((x)&7)))
  37 #define B_TYPE          unsigned char
  38 #define B_BYTES(x)      ( 1 + ((x)>>3) )
  39 #define B_CLRALL(a,x)   memset ((a), 0, B_BYTES(x))
  40
  41 /* Different kinds of data types are distinguished by the `code' field.  */
  42
  43 enum type_code
  44   {
  45     TYPE_CODE_UNDEF,            /* Not used; catches errors */
  46     TYPE_CODE_PTR,              /* Pointer type */
  47
  48     /* Array type with lower & upper bounds.
  49
  50        Regardless of the language, GDB represents multidimensional
  51        array types the way C does: as arrays of arrays.  So an
  52        instance of a GDB array type T can always be seen as a series
  53        of instances of TYPE_TARGET_TYPE (T) laid out sequentially in
  54        memory.
  55
  56        Row-major languages like C lay out multi-dimensional arrays so
  57        that incrementing the rightmost index in a subscripting
  58        expression results in the smallest change in the address of the
  59        element referred to.  Column-major languages like Fortran lay
  60        them out so that incrementing the leftmost index results in the
  61        smallest change.
  62
  63        This means that, in column-major languages, working our way
  64        from type to target type corresponds to working through indices
  65        from right to left, not left to right.  */
  66     TYPE_CODE_ARRAY,
  67
  68     TYPE_CODE_STRUCT,           /* C struct or Pascal record */
  69     TYPE_CODE_UNION,            /* C union or Pascal variant part */
  70     TYPE_CODE_ENUM,             /* Enumeration type */
  71     TYPE_CODE_FLAGS,            /* Bit flags type */
  72     TYPE_CODE_FUNC,             /* Function type */
  73     TYPE_CODE_INT,              /* Integer type */
  74
  75     /* Floating type.  This is *NOT* a complex type.  Beware, there are parts
  76        of GDB which bogusly assume that TYPE_CODE_FLT can mean complex.  */
  77     TYPE_CODE_FLT,
  78
  79     /* Void type.  The length field specifies the length (probably always
  80        one) which is used in pointer arithmetic involving pointers to
  81        this type, but actually dereferencing such a pointer is invalid;
  82        a void type has no length and no actual representation in memory
  83        or registers.  A pointer to a void type is a generic pointer.  */
  84     TYPE_CODE_VOID,
  85
  86     TYPE_CODE_SET,              /* Pascal sets */
  87     TYPE_CODE_RANGE,            /* Range (integers within spec'd bounds) */
  88
  89     /* A string type which is like an array of character but prints
  90        differently (at least for (the deleted) CHILL).  It does not
  91        contain a length field as Pascal strings (for many Pascals,
  92        anyway) do; if we want to deal with such strings, we should use
  93        a new type code.  */
  94     TYPE_CODE_STRING,
  95
  96     /* String of bits; like TYPE_CODE_SET but prints differently (at
  97        least for (the deleted) CHILL).  */
  98     TYPE_CODE_BITSTRING,
  99
 100     /* Unknown type.  The length field is valid if we were able to
 101        deduce that much about the type, or 0 if we don't even know that.  */
 102     TYPE_CODE_ERROR,
 103
 104     /* C++ */
 105     TYPE_CODE_METHOD,           /* Method type */
 106
 107     /* Pointer-to-member-function type.  This describes how to access a
 108        particular member function of a class (possibly a virtual
 109        member function).  The representation may vary between different
 110        C++ ABIs.  */
 111     TYPE_CODE_METHODPTR,
 112
 113     /* Pointer-to-member type.  This is the offset within a class to some
 114        particular data member.  The only currently supported representation
 115        uses an unbiased offset, with -1 representing NULL; this is used
 116        by the Itanium C++ ABI (used by GCC on all platforms).  */
 117     TYPE_CODE_MEMBERPTR,
 118
 119     TYPE_CODE_REF,              /* C++ Reference types */
 120
 121     TYPE_CODE_CHAR,             /* *real* character type */
 122
 123     /* Boolean type.  0 is false, 1 is true, and other values are non-boolean
 124        (e.g. FORTRAN "logical" used as unsigned int).  */
 125     TYPE_CODE_BOOL,
 126
 127     /* Fortran */
 128     TYPE_CODE_COMPLEX,          /* Complex float */
 129
 130     TYPE_CODE_TYPEDEF,
 131     TYPE_CODE_TEMPLATE,         /* C++ template */
 132     TYPE_CODE_TEMPLATE_ARG,     /* C++ template arg */
 133
 134     TYPE_CODE_NAMESPACE,        /* C++ namespace.  */
 135
 136     TYPE_CODE_DECFLOAT          /* Decimal floating point.  */
 137   };
 138
 139 /* For now allow source to use TYPE_CODE_CLASS for C++ classes, as an
 140    alias for TYPE_CODE_STRUCT.  This is for DWARF, which has a distinct
 141    "class" attribute.  Perhaps we should actually have a separate TYPE_CODE
 142    so that we can print "class" or "struct" depending on what the debug
 143    info said.  It's not clear we should bother.  */
 144
 145 #define TYPE_CODE_CLASS TYPE_CODE_STRUCT
 146
 147 /* Some constants representing each bit field in the main_type.  See
 148    the bit-field-specific macros, below, for documentation of each
 149    constant in this enum.  These enum values are only used with
 150    init_type.  Note that the values are chosen not to conflict with
 151    type_instance_flag_value; this lets init_type error-check its
 152    input.  */
 153
 154 enum type_flag_value
 155 {
 156   TYPE_FLAG_UNSIGNED = (1 << 6),
 157   TYPE_FLAG_NOSIGN = (1 << 7),
 158   TYPE_FLAG_STUB = (1 << 8),
 159   TYPE_FLAG_TARGET_STUB = (1 << 9),
 160   TYPE_FLAG_STATIC = (1 << 10),
 161   TYPE_FLAG_PROTOTYPED = (1 << 11),
 162   TYPE_FLAG_INCOMPLETE = (1 << 12),
 163   TYPE_FLAG_VARARGS = (1 << 13),
 164   TYPE_FLAG_VECTOR = (1 << 14),
 165   TYPE_FLAG_FIXED_INSTANCE = (1 << 15),
 166   TYPE_FLAG_STUB_SUPPORTED = (1 << 16),
 167   TYPE_FLAG_NOTTEXT = (1 << 17),
 168
 169   /* Used for error-checking.  */
 170   TYPE_FLAG_MIN = TYPE_FLAG_UNSIGNED
 171 };
 172
 173 /* Some bits for the type's instance_flags word.  See the macros below
 174    for documentation on each bit.  Note that if you add a value here,
 175    you must update the enum type_flag_value as well.  */
 176 enum type_instance_flag_value
 177 {
 178   TYPE_INSTANCE_FLAG_CONST = (1 << 0),
 179   TYPE_INSTANCE_FLAG_VOLATILE = (1 << 1),
 180   TYPE_INSTANCE_FLAG_CODE_SPACE = (1 << 2),
 181   TYPE_INSTANCE_FLAG_DATA_SPACE = (1 << 3),
 182   TYPE_INSTANCE_FLAG_ADDRESS_CLASS_1 = (1 << 4),
 183   TYPE_INSTANCE_FLAG_ADDRESS_CLASS_2 = (1 << 5)
 184 };
 185
 186 /* Unsigned integer type.  If this is not set for a TYPE_CODE_INT, the
 187    type is signed (unless TYPE_FLAG_NOSIGN (below) is set). */
 188
 189 #define TYPE_UNSIGNED(t)        (TYPE_MAIN_TYPE (t)->flag_unsigned)
 190
 191 /* No sign for this type.  In C++, "char", "signed char", and "unsigned
 192    char" are distinct types; so we need an extra flag to indicate the
 193    absence of a sign! */
 194
 195 #define TYPE_NOSIGN(t)          (TYPE_MAIN_TYPE (t)->flag_nosign)
 196
 197 /* This appears in a type's flags word if it is a stub type (e.g., if
 198    someone referenced a type that wasn't defined in a source file
 199    via (struct sir_not_appearing_in_this_film *)).  */
 200
 201 #define TYPE_STUB(t)            (TYPE_MAIN_TYPE (t)->flag_stub)
 202
 203 /* The target type of this type is a stub type, and this type needs to
 204    be updated if it gets un-stubbed in check_typedef.
 205    Used for arrays and ranges, in which TYPE_LENGTH of the array/range
 206    gets set based on the TYPE_LENGTH of the target type.
 207    Also, set for TYPE_CODE_TYPEDEF. */
 208
 209 #define TYPE_TARGET_STUB(t)     (TYPE_MAIN_TYPE (t)->flag_target_stub)
 210
 211 /* Static type.  If this is set, the corresponding type had
 212  * a static modifier.
 213  * Note: This may be unnecessary, since static data members
 214  * are indicated by other means (bitpos == -1)
 215  */
 216
 217 #define TYPE_STATIC(t)          (TYPE_MAIN_TYPE (t)->flag_static)
 218
 219 /* This is a function type which appears to have a prototype.  We need this
 220    for function calls in order to tell us if it's necessary to coerce the args,
 221    or to just do the standard conversions.  This is used with a short field. */
 222
 223 #define TYPE_PROTOTYPED(t)      (TYPE_MAIN_TYPE (t)->flag_prototyped)
 224
 225 /* This flag is used to indicate that processing for this type
 226    is incomplete.
 227
 228    (Mostly intended for HP platforms, where class methods, for
 229    instance, can be encountered before their classes in the debug
 230    info; the incomplete type has to be marked so that the class and
 231    the method can be assigned correct types.) */
 232
 233 #define TYPE_INCOMPLETE(t)      (TYPE_MAIN_TYPE (t)->flag_incomplete)
 234
 235 /* FIXME drow/2002-06-03:  Only used for methods, but applies as well
 236    to functions.  */
 237
 238 #define TYPE_VARARGS(t)         (TYPE_MAIN_TYPE (t)->flag_varargs)
 239
 240 /* Identify a vector type.  Gcc is handling this by adding an extra
 241    attribute to the array type.  We slurp that in as a new flag of a
 242    type.  This is used only in dwarf2read.c.  */
 243 #define TYPE_VECTOR(t)          (TYPE_MAIN_TYPE (t)->flag_vector)
 244
 245 /* The debugging formats (especially STABS) do not contain enough information
 246    to represent all Ada types---especially those whose size depends on
 247    dynamic quantities.  Therefore, the GNAT Ada compiler includes
 248    extra information in the form of additional type definitions
 249    connected by naming conventions.  This flag indicates that the
 250    type is an ordinary (unencoded) GDB type that has been created from
 251    the necessary run-time information, and does not need further
 252    interpretation. Optionally marks ordinary, fixed-size GDB type. */
 253
 254 #define TYPE_FIXED_INSTANCE(t) (TYPE_MAIN_TYPE (t)->flag_fixed_instance)
 255
 256 /* This debug target supports TYPE_STUB(t).  In the unsupported case we have to
 257    rely on NFIELDS to be zero etc., see TYPE_IS_OPAQUE ().
 258    TYPE_STUB(t) with !TYPE_STUB_SUPPORTED(t) may exist if we only guessed
 259    the TYPE_STUB(t) value (see dwarfread.c).  */
 260
 261 #define TYPE_STUB_SUPPORTED(t)   (TYPE_MAIN_TYPE (t)->flag_stub_supported)
 262
 263 /* Not textual.  By default, GDB treats all single byte integers as
 264    characters (or elements of strings) unless this flag is set.  */
 265
 266 #define TYPE_NOTTEXT(t)         (TYPE_MAIN_TYPE (t)->flag_nottext)
 267
 268 /* Constant type.  If this is set, the corresponding type has a
 269  * const modifier.
 270  */
 271
 272 #define TYPE_CONST(t) (TYPE_INSTANCE_FLAGS (t) & TYPE_INSTANCE_FLAG_CONST)
 273
 274 /* Volatile type.  If this is set, the corresponding type has a
 275  * volatile modifier.
 276  */
 277
 278 #define TYPE_VOLATILE(t) (TYPE_INSTANCE_FLAGS (t) & TYPE_INSTANCE_FLAG_VOLATILE)
 279
 280 /* Instruction-space delimited type.  This is for Harvard architectures
 281    which have separate instruction and data address spaces (and perhaps
 282    others).
 283
 284    GDB usually defines a flat address space that is a superset of the
 285    architecture's two (or more) address spaces, but this is an extension
 286    of the architecture's model.
 287
 288    If TYPE_FLAG_INST is set, an object of the corresponding type
 289    resides in instruction memory, even if its address (in the extended
 290    flat address space) does not reflect this.
 291
 292    Similarly, if TYPE_FLAG_DATA is set, then an object of the
 293    corresponding type resides in the data memory space, even if
 294    this is not indicated by its (flat address space) address.
 295
 296    If neither flag is set, the default space for functions / methods
 297    is instruction space, and for data objects is data memory.  */
 298
 299 #define TYPE_CODE_SPACE(t) \
 300   (TYPE_INSTANCE_FLAGS (t) & TYPE_INSTANCE_FLAG_CODE_SPACE)
 301
 302 #define TYPE_DATA_SPACE(t) \
 303   (TYPE_INSTANCE_FLAGS (t) & TYPE_INSTANCE_FLAG_DATA_SPACE)
 304
 305 /* Address class flags.  Some environments provide for pointers whose
 306    size is different from that of a normal pointer or address types
 307    where the bits are interpreted differently than normal addresses.  The
 308    TYPE_FLAG_ADDRESS_CLASS_n flags may be used in target specific
 309    ways to represent these different types of address classes.  */
 310 #define TYPE_ADDRESS_CLASS_1(t) (TYPE_INSTANCE_FLAGS(t) \
 311                                  & TYPE_INSTANCE_FLAG_ADDRESS_CLASS_1)
 312 #define TYPE_ADDRESS_CLASS_2(t) (TYPE_INSTANCE_FLAGS(t) \
 313                                  & TYPE_INSTANCE_FLAG_ADDRESS_CLASS_2)
 314 #define TYPE_INSTANCE_FLAG_ADDRESS_CLASS_ALL \
 315   (TYPE_INSTANCE_FLAG_ADDRESS_CLASS_1 | TYPE_INSTANCE_FLAG_ADDRESS_CLASS_2)
 316 #define TYPE_ADDRESS_CLASS_ALL(t) (TYPE_INSTANCE_FLAGS(t) \
 317                                    & TYPE_INSTANCE_FLAG_ADDRESS_CLASS_ALL)
 318
 319 /* Determine which field of the union main_type.fields[x].loc is used.  */
 320
 321 enum field_loc_kind
 322   {
 323     FIELD_LOC_KIND_BITPOS,      /* bitpos */
 324     FIELD_LOC_KIND_PHYSADDR,    /* physaddr */
 325     FIELD_LOC_KIND_PHYSNAME,    /* physname */
 326     FIELD_LOC_KIND_DWARF_BLOCK  /* dwarf_block */
 327   };
 328
 329 /* This structure is space-critical.
 330    Its layout has been tweaked to reduce the space used.  */
 331
 332 struct main_type
 333 {
 334   /* Code for kind of type */
 335
 336   ENUM_BITFIELD(type_code) code : 8;
 337
 338   /* Flags about this type.  These fields appear at this location
 339      because they packs nicely here.  See the TYPE_* macros for
 340      documentation about these fields.  */
 341
 342   unsigned int flag_unsigned : 1;
 343   unsigned int flag_nosign : 1;
 344   unsigned int flag_stub : 1;
 345   unsigned int flag_target_stub : 1;
 346   unsigned int flag_static : 1;
 347   unsigned int flag_prototyped : 1;
 348   unsigned int flag_incomplete : 1;
 349   unsigned int flag_varargs : 1;
 350   unsigned int flag_vector : 1;
 351   unsigned int flag_stub_supported : 1;
 352   unsigned int flag_nottext : 1;
 353   unsigned int flag_fixed_instance : 1;
 354
 355   /* Number of fields described for this type.  This field appears at
 356      this location because it packs nicely here.  */
 357
 358   short nfields;
 359
 360   /* Field number of the virtual function table pointer in
 361      VPTR_BASETYPE.  If -1, we were unable to find the virtual
 362      function table pointer in initial symbol reading, and
 363      get_vptr_fieldno should be called to find it if possible.
 364      get_vptr_fieldno will update this field if possible.
 365      Otherwise the value is left at -1.
 366
 367      Unused if this type does not have virtual functions.
 368
 369      This field appears at this location because it packs nicely here.  */
 370
 371   short vptr_fieldno;
 372
 373   /* Name of this type, or NULL if none.
 374
 375      This is used for printing only, except by poorly designed C++ code.
 376      For looking up a name, look for a symbol in the VAR_DOMAIN.  */
 377
 378   char *name;
 379
 380   /* Tag name for this type, or NULL if none.  This means that the
 381      name of the type consists of a keyword followed by the tag name.
 382      Which keyword is determined by the type code ("struct" for
 383      TYPE_CODE_STRUCT, etc.).  As far as I know C/C++ are the only languages
 384      with this feature.
 385
 386      This is used for printing only, except by poorly designed C++ code.
 387      For looking up a name, look for a symbol in the STRUCT_DOMAIN.
 388      One more legitimate use is that if TYPE_FLAG_STUB is set, this is
 389      the name to use to look for definitions in other files.  */
 390
 391   char *tag_name;
 392
 393   /* Every type is now associated with a particular objfile, and the
 394      type is allocated on the objfile_obstack for that objfile.  One problem
 395      however, is that there are times when gdb allocates new types while
 396      it is not in the process of reading symbols from a particular objfile.
 397      Fortunately, these happen when the type being created is a derived
 398      type of an existing type, such as in lookup_pointer_type().  So
 399      we can just allocate the new type using the same objfile as the
 400      existing type, but to do this we need a backpointer to the objfile
 401      from the existing type.  Yes this is somewhat ugly, but without
 402      major overhaul of the internal type system, it can't be avoided
 403      for now. */
 404
 405   struct objfile *objfile;
 406
 407   /* For a pointer type, describes the type of object pointed to.
 408      For an array type, describes the type of the elements.
 409      For a function or method type, describes the type of the return value.
 410      For a range type, describes the type of the full range.
 411      For a complex type, describes the type of each coordinate.
 412      Unused otherwise.  */
 413
 414   struct type *target_type;
 415
 416   /* For structure and union types, a description of each field.
 417      For set and pascal array types, there is one "field",
 418      whose type is the domain type of the set or array.
 419      For range types, there are two "fields",
 420      the minimum and maximum values (both inclusive).
 421      For enum types, each possible value is described by one "field".
 422      For a function or method type, a "field" for each parameter.
 423      For C++ classes, there is one field for each base class (if it is
 424      a derived class) plus one field for each class data member.  Member
 425      functions are recorded elsewhere.
 426
 427      Using a pointer to a separate array of fields
 428      allows all types to have the same size, which is useful
 429      because we can allocate the space for a type before
 430      we know what to put in it.  */
 431
 432   struct field
 433   {
 434     union field_location
 435     {
 436       /* Position of this field, counting in bits from start of
 437          containing structure.
 438          For gdbarch_bits_big_endian=1 targets, it is the bit offset to the MSB.
 439          For gdbarch_bits_big_endian=0 targets, it is the bit offset to the LSB.
 440          For a range bound or enum value, this is the value itself. */
 441
 442       int bitpos;
 443
 444       /* For a static field, if TYPE_FIELD_STATIC_HAS_ADDR then physaddr
 445          is the location (in the target) of the static field.
 446          Otherwise, physname is the mangled label of the static field. */
 447
 448       CORE_ADDR physaddr;
 449       char *physname;
 450
 451       /* The field location can be computed by evaluating the following DWARF
 452          block.  This can be used in Fortran variable-length arrays, for
 453          instance.  */
 454
 455       struct dwarf2_locexpr_baton *dwarf_block;
 456     }
 457     loc;
 458
 459     /* For a function or member type, this is 1 if the argument is marked
 460        artificial.  Artificial arguments should not be shown to the
 461        user.  For TYPE_CODE_RANGE it is set if the specific bound is not
 462        defined.  */
 463     unsigned int artificial : 1;
 464
 465     /* Discriminant for union field_location.  */
 466     ENUM_BITFIELD(field_loc_kind) loc_kind : 2;
 467
 468     /* Size of this field, in bits, or zero if not packed.
 469        For an unpacked field, the field's type's length
 470        says how many bytes the field occupies.  */
 471
 472     unsigned int bitsize : 29;
 473
 474     /* In a struct or union type, type of this field.
 475        In a function or member type, type of this argument.
 476        In an array type, the domain-type of the array.  */
 477
 478     struct type *type;
 479
 480     /* Name of field, value or argument.
 481        NULL for range bounds, array domains, and member function
 482        arguments.  */
 483
 484     char *name;
 485
 486   } *fields;
 487
 488   /* For types with virtual functions (TYPE_CODE_STRUCT), VPTR_BASETYPE
 489      is the base class which defined the virtual function table pointer.
 490
 491      For types that are pointer to member types (TYPE_CODE_METHODPTR,
 492      TYPE_CODE_MEMBERPTR), VPTR_BASETYPE is the type that this pointer
 493      is a member of.
 494
 495      For method types (TYPE_CODE_METHOD), VPTR_BASETYPE is the aggregate
 496      type that contains the method.
 497
 498      Unused otherwise.  */
 499
 500   struct type *vptr_basetype;
 501
 502   /* Slot to point to additional language-specific fields of this type.  */
 503
 504   union type_specific
 505   {
 506     /* CPLUS_STUFF is for TYPE_CODE_STRUCT.  It is initialized to point to
 507        cplus_struct_default, a default static instance of a struct
 508        cplus_struct_type. */
 509
 510     struct cplus_struct_type *cplus_stuff;
 511
 512     /* FLOATFORMAT is for TYPE_CODE_FLT.  It is a pointer to two
 513        floatformat objects that describe the floating-point value
 514        that resides within the type.  The first is for big endian
 515        targets and the second is for little endian targets.  */
 516
 517     const struct floatformat **floatformat;
 518
 519     /* For TYPE_CODE_FUNC types, the calling convention for targets
 520        supporting multiple ABIs.  Right now this is only fetched from
 521        the Dwarf-2 DW_AT_calling_convention attribute.  */
 522     unsigned calling_convention;
 523   } type_specific;
 524 };
 525
 526 /* A ``struct type'' describes a particular instance of a type, with
 527    some particular qualification.  */
 528 struct type
 529 {
 530   /* Type that is a pointer to this type.
 531      NULL if no such pointer-to type is known yet.
 532      The debugger may add the address of such a type
 533      if it has to construct one later.  */
 534
 535   struct type *pointer_type;
 536
 537   /* C++: also need a reference type.  */
 538
 539   struct type *reference_type;
 540
 541   /* Variant chain.  This points to a type that differs from this one only
 542      in qualifiers and length.  Currently, the possible qualifiers are
 543      const, volatile, code-space, data-space, and address class.  The
 544      length may differ only when one of the address class flags are set.
 545      The variants are linked in a circular ring and share MAIN_TYPE.  */
 546   struct type *chain;
 547
 548   /* Flags specific to this instance of the type, indicating where
 549      on the ring we are.  */
 550   int instance_flags;
 551
 552   /* Length of storage for a value of this type.  This is what
 553      sizeof(type) would return; use it for address arithmetic,
 554      memory reads and writes, etc.  This size includes padding.  For
 555      example, an i386 extended-precision floating point value really
 556      only occupies ten bytes, but most ABI's declare its size to be
 557      12 bytes, to preserve alignment.  A `struct type' representing
 558      such a floating-point type would have a `length' value of 12,
 559      even though the last two bytes are unused.
 560
 561      There's a bit of a host/target mess here, if you're concerned
 562      about machines whose bytes aren't eight bits long, or who don't
 563      have byte-addressed memory.  Various places pass this to memcpy
 564      and such, meaning it must be in units of host bytes.  Various
 565      other places expect they can calculate addresses by adding it
 566      and such, meaning it must be in units of target bytes.  For
 567      some DSP targets, in which HOST_CHAR_BIT will (presumably) be 8
 568      and TARGET_CHAR_BIT will be (say) 32, this is a problem.
 569
 570      One fix would be to make this field in bits (requiring that it
 571      always be a multiple of HOST_CHAR_BIT and TARGET_CHAR_BIT) ---
 572      the other choice would be to make it consistently in units of
 573      HOST_CHAR_BIT.  However, this would still fail to address
 574      machines based on a ternary or decimal representation.  */
 575
 576   unsigned length;
 577
 578   /* Core type, shared by a group of qualified types.  */
 579   struct main_type *main_type;
 580 };
 581
 582 #define NULL_TYPE ((struct type *) 0)
 583
 584 /* C++ language-specific information for TYPE_CODE_STRUCT and TYPE_CODE_UNION
 585    nodes.  */
 586
 587 struct cplus_struct_type
 588   {
 589     /* Number of base classes this type derives from.  The baseclasses are
 590        stored in the first N_BASECLASSES fields (i.e. the `fields' field of
 591        the struct type).  I think only the `type' field of such a field has
 592        any meaning.  */
 593
 594     short n_baseclasses;
 595
 596     /* Number of methods with unique names.  All overloaded methods with
 597        the same name count only once. */
 598
 599     short nfn_fields;
 600
 601     /* Number of methods described for this type, not including the
 602        methods that it derives from.  */
 603
 604     short nfn_fields_total;
 605
 606     /* The "declared_type" field contains a code saying how the
 607        user really declared this type, e.g., "class s", "union s",
 608        "struct s".
 609        The 3 above things come out from the C++ compiler looking like classes,
 610        but we keep track of the real declaration so we can give
 611        the correct information on "ptype". (Note: TEMPLATE may not
 612        belong in this list...)  */
 613
 614 #define DECLARED_TYPE_CLASS 0
 615 #define DECLARED_TYPE_UNION 1
 616 #define DECLARED_TYPE_STRUCT 2
 617 #define DECLARED_TYPE_TEMPLATE 3
 618     short declared_type;        /* One of the above codes */
 619
 620     /* For derived classes, the number of base classes is given by n_baseclasses
 621        and virtual_field_bits is a bit vector containing one bit per base class.
 622        If the base class is virtual, the corresponding bit will be set.
 623        I.E, given:
 624
 625        class A{};
 626        class B{};
 627        class C : public B, public virtual A {};
 628
 629        B is a baseclass of C; A is a virtual baseclass for C.
 630        This is a C++ 2.0 language feature. */
 631
 632     B_TYPE *virtual_field_bits;
 633
 634     /* For classes with private fields, the number of fields is given by
 635        nfields and private_field_bits is a bit vector containing one bit
 636        per field.
 637        If the field is private, the corresponding bit will be set. */
 638
 639     B_TYPE *private_field_bits;
 640
 641     /* For classes with protected fields, the number of fields is given by
 642        nfields and protected_field_bits is a bit vector containing one bit
 643        per field.
 644        If the field is private, the corresponding bit will be set. */
 645
 646     B_TYPE *protected_field_bits;
 647
 648     /* for classes with fields to be ignored, either this is optimized out
 649        or this field has length 0 */
 650
 651     B_TYPE *ignore_field_bits;
 652
 653     /* For classes, structures, and unions, a description of each field,
 654        which consists of an overloaded name, followed by the types of
 655        arguments that the method expects, and then the name after it
 656        has been renamed to make it distinct.
 657
 658        fn_fieldlists points to an array of nfn_fields of these. */
 659
 660     struct fn_fieldlist
 661       {
 662
 663         /* The overloaded name.  */
 664
 665         char *name;
 666
 667         /* The number of methods with this name.  */
 668
 669         int length;
 670
 671         /* The list of methods.  */
 672
 673         struct fn_field
 674           {
 675
 676             /* If is_stub is clear, this is the mangled name which we can
 677                look up to find the address of the method (FIXME: it would
 678                be cleaner to have a pointer to the struct symbol here
 679                instead).  */
 680
 681             /* If is_stub is set, this is the portion of the mangled
 682                name which specifies the arguments.  For example, "ii",
 683                if there are two int arguments, or "" if there are no
 684                arguments.  See gdb_mangle_name for the conversion from this
 685                format to the one used if is_stub is clear.  */
 686
 687             char *physname;
 688
 689             /* The function type for the method.
 690                (This comment used to say "The return value of the method",
 691                but that's wrong. The function type
 692                is expected here, i.e. something with TYPE_CODE_FUNC,
 693                and *not* the return-value type). */
 694
 695             struct type *type;
 696
 697             /* For virtual functions.
 698                First baseclass that defines this virtual function.   */
 699
 700             struct type *fcontext;
 701
 702             /* Attributes. */
 703
 704             unsigned int is_const:1;
 705             unsigned int is_volatile:1;
 706             unsigned int is_private:1;
 707             unsigned int is_protected:1;
 708             unsigned int is_public:1;
 709             unsigned int is_abstract:1;
 710             unsigned int is_static:1;
 711             unsigned int is_final:1;
 712             unsigned int is_synchronized:1;
 713             unsigned int is_native:1;
 714             unsigned int is_artificial:1;
 715
 716             /* A stub method only has some fields valid (but they are enough
 717                to reconstruct the rest of the fields).  */
 718             unsigned int is_stub:1;
 719
 720             /* Unused.  */
 721             unsigned int dummy:4;
 722
 723             /* Index into that baseclass's virtual function table,
 724                minus 2; else if static: VOFFSET_STATIC; else: 0.  */
 725
 726             unsigned int voffset:16;
 727
 728 #define VOFFSET_STATIC 1
 729
 730           }
 731          *fn_fields;
 732
 733       }
 734      *fn_fieldlists;
 735
 736     /* If this "struct type" describes a template, then it
 737      * has arguments. "template_args" points to an array of
 738      * template arg descriptors, of length "ntemplate_args".
 739      * The only real information in each of these template arg descriptors
 740      * is a name. "type" will typically just point to a "struct type" with
 741      * the placeholder TYPE_CODE_TEMPLATE_ARG type.
 742      */
 743     short ntemplate_args;
 744     struct template_arg
 745       {
 746         char *name;
 747         struct type *type;
 748       }
 749      *template_args;
 750
 751     /* Pointer to information about enclosing scope, if this is a
 752      * local type.  If it is not a local type, this is NULL
 753      */
 754     struct local_type_info
 755       {
 756         char *file;
 757         int line;
 758       }
 759      *localtype_ptr;
 760   };
 761
 762 /* Struct used in computing virtual base list */
 763 struct vbase
 764   {
 765     struct type *vbasetype;     /* pointer to virtual base */
 766     struct vbase *next;         /* next in chain */
 767   };
 768
 769 /* Struct used for ranking a function for overload resolution */
 770 struct badness_vector
 771   {
 772     int length;
 773     int *rank;
 774   };
 775
 776 /* The default value of TYPE_CPLUS_SPECIFIC(T) points to the
 777    this shared static structure. */
 778
 779 extern const struct cplus_struct_type cplus_struct_default;
 780
 781 extern void allocate_cplus_struct_type (struct type *);
 782
 783 #define INIT_CPLUS_SPECIFIC(type) \
 784   (TYPE_CPLUS_SPECIFIC(type)=(struct cplus_struct_type*)&cplus_struct_default)
 785 #define ALLOCATE_CPLUS_STRUCT_TYPE(type) allocate_cplus_struct_type (type)
 786 #define HAVE_CPLUS_STRUCT(type) \
 787   (TYPE_CPLUS_SPECIFIC(type) != &cplus_struct_default)
 788
 789 #define TYPE_INSTANCE_FLAGS(thistype) (thistype)->instance_flags
 790 #define TYPE_MAIN_TYPE(thistype) (thistype)->main_type
 791 #define TYPE_NAME(thistype) TYPE_MAIN_TYPE(thistype)->name
 792 #define TYPE_TAG_NAME(type) TYPE_MAIN_TYPE(type)->tag_name
 793 #define TYPE_TARGET_TYPE(thistype) TYPE_MAIN_TYPE(thistype)->target_type
 794 #define TYPE_POINTER_TYPE(thistype) (thistype)->pointer_type
 795 #define TYPE_REFERENCE_TYPE(thistype) (thistype)->reference_type
 796 #define TYPE_CHAIN(thistype) (thistype)->chain
 797 /* Note that if thistype is a TYPEDEF type, you have to call check_typedef.
 798    But check_typedef does set the TYPE_LENGTH of the TYPEDEF type,
 799    so you only have to call check_typedef once.  Since allocate_value
 800    calls check_typedef, TYPE_LENGTH (VALUE_TYPE (X)) is safe.  */
 801 #define TYPE_LENGTH(thistype) (thistype)->length
 802 #define TYPE_OBJFILE(thistype) TYPE_MAIN_TYPE(thistype)->objfile
 803 /* Note that TYPE_CODE can be TYPE_CODE_TYPEDEF, so if you want the real
 804    type, you need to do TYPE_CODE (check_type (this_type)). */
 805 #define TYPE_CODE(thistype) TYPE_MAIN_TYPE(thistype)->code
 806 #define TYPE_NFIELDS(thistype) TYPE_MAIN_TYPE(thistype)->nfields
 807 #define TYPE_FIELDS(thistype) TYPE_MAIN_TYPE(thistype)->fields
 808 #define TYPE_TEMPLATE_ARGS(thistype) TYPE_CPLUS_SPECIFIC(thistype)->template_args
 809
 810 #define TYPE_INDEX_TYPE(type) TYPE_FIELD_TYPE (type, 0)
 811 #define TYPE_LOW_BOUND(range_type) TYPE_FIELD_BITPOS (range_type, 0)
 812 #define TYPE_HIGH_BOUND(range_type) TYPE_FIELD_BITPOS (range_type, 1)
 813
 814 /* Moto-specific stuff for FORTRAN arrays */
 815
 816 #define TYPE_ARRAY_UPPER_BOUND_IS_UNDEFINED(arraytype) \
 817    (TYPE_FIELD_ARTIFICIAL((TYPE_FIELD_TYPE((arraytype),0)),1))
 818 #define TYPE_ARRAY_LOWER_BOUND_IS_UNDEFINED(arraytype) \
 819    (TYPE_FIELD_ARTIFICIAL((TYPE_FIELD_TYPE((arraytype),0)),0))
 820
 821 #define TYPE_ARRAY_UPPER_BOUND_VALUE(arraytype) \
 822    (TYPE_FIELD_BITPOS((TYPE_FIELD_TYPE((arraytype),0)),1))
 823
 824 #define TYPE_ARRAY_LOWER_BOUND_VALUE(arraytype) \
 825    (TYPE_FIELD_BITPOS((TYPE_FIELD_TYPE((arraytype),0)),0))
 826
 827 /* C++ */
 828
 829 #define TYPE_VPTR_BASETYPE(thistype) TYPE_MAIN_TYPE(thistype)->vptr_basetype
 830 #define TYPE_DOMAIN_TYPE(thistype) TYPE_MAIN_TYPE(thistype)->vptr_basetype
 831 #define TYPE_VPTR_FIELDNO(thistype) TYPE_MAIN_TYPE(thistype)->vptr_fieldno
 832 #define TYPE_FN_FIELDS(thistype) TYPE_CPLUS_SPECIFIC(thistype)->fn_fields
 833 #define TYPE_NFN_FIELDS(thistype) TYPE_CPLUS_SPECIFIC(thistype)->nfn_fields
 834 #define TYPE_NFN_FIELDS_TOTAL(thistype) TYPE_CPLUS_SPECIFIC(thistype)->nfn_fields_total
 835 #define TYPE_NTEMPLATE_ARGS(thistype) TYPE_CPLUS_SPECIFIC(thistype)->ntemplate_args
 836 #define TYPE_DECLARED_TYPE(thistype) TYPE_CPLUS_SPECIFIC(thistype)->declared_type
 837 #define TYPE_TYPE_SPECIFIC(thistype) TYPE_MAIN_TYPE(thistype)->type_specific
 838 #define TYPE_CPLUS_SPECIFIC(thistype) TYPE_MAIN_TYPE(thistype)->type_specific.cplus_stuff
 839 #define TYPE_FLOATFORMAT(thistype) TYPE_MAIN_TYPE(thistype)->type_specific.floatformat
 840 #define TYPE_CALLING_CONVENTION(thistype) TYPE_MAIN_TYPE(thistype)->type_specific.calling_convention
 841 #define TYPE_BASECLASS(thistype,index) TYPE_MAIN_TYPE(thistype)->fields[index].type
 842 #define TYPE_N_BASECLASSES(thistype) TYPE_CPLUS_SPECIFIC(thistype)->n_baseclasses
 843 #define TYPE_BASECLASS_NAME(thistype,index) TYPE_MAIN_TYPE(thistype)->fields[index].name
 844 #define TYPE_BASECLASS_BITPOS(thistype,index) TYPE_FIELD_BITPOS(thistype,index)
 845 #define BASETYPE_VIA_PUBLIC(thistype, index) \
 846   ((!TYPE_FIELD_PRIVATE(thistype, index)) && (!TYPE_FIELD_PROTECTED(thistype, index)))
 847
 848 #define BASETYPE_VIA_VIRTUAL(thistype, index) \
 849   (TYPE_CPLUS_SPECIFIC(thistype)->virtual_field_bits == NULL ? 0 \
 850     : B_TST(TYPE_CPLUS_SPECIFIC(thistype)->virtual_field_bits, (index)))
 851
 852 #define FIELD_TYPE(thisfld) ((thisfld).type)
 853 #define FIELD_NAME(thisfld) ((thisfld).name)
 854 #define FIELD_LOC_KIND(thisfld) ((thisfld).loc_kind)
 855 #define FIELD_BITPOS(thisfld) ((thisfld).loc.bitpos)
 856 #define FIELD_STATIC_PHYSNAME(thisfld) ((thisfld).loc.physname)
 857 #define FIELD_STATIC_PHYSADDR(thisfld) ((thisfld).loc.physaddr)
 858 #define FIELD_DWARF_BLOCK(thisfld) ((thisfld).loc.dwarf_block)
 859 #define SET_FIELD_BITPOS(thisfld, bitpos)                       \
 860   (FIELD_LOC_KIND (thisfld) = FIELD_LOC_KIND_BITPOS,            \
 861    FIELD_BITPOS (thisfld) = (bitpos))
 862 #define SET_FIELD_PHYSNAME(thisfld, name)                       \
 863   (FIELD_LOC_KIND (thisfld) = FIELD_LOC_KIND_PHYSNAME,          \
 864    FIELD_STATIC_PHYSNAME (thisfld) = (name))
 865 #define SET_FIELD_PHYSADDR(thisfld, addr)                       \
 866   (FIELD_LOC_KIND (thisfld) = FIELD_LOC_KIND_PHYSADDR,          \
 867    FIELD_STATIC_PHYSADDR (thisfld) = (addr))
 868 #define SET_FIELD_DWARF_BLOCK(thisfld, addr)                    \
 869   (FIELD_LOC_KIND (thisfld) = FIELD_LOC_KIND_DWARF_BLOCK,       \
 870    FIELD_DWARF_BLOCK (thisfld) = (addr))
 871 #define FIELD_ARTIFICIAL(thisfld) ((thisfld).artificial)
 872 #define FIELD_BITSIZE(thisfld) ((thisfld).bitsize)
 873
 874 #define TYPE_FIELD(thistype, n) TYPE_MAIN_TYPE(thistype)->fields[n]
 875 #define TYPE_FIELD_TYPE(thistype, n) FIELD_TYPE(TYPE_FIELD(thistype, n))
 876 #define TYPE_FIELD_NAME(thistype, n) FIELD_NAME(TYPE_FIELD(thistype, n))
 877 #define TYPE_FIELD_LOC_KIND(thistype, n) FIELD_LOC_KIND (TYPE_FIELD (thistype, n))
 878 #define TYPE_FIELD_BITPOS(thistype, n) FIELD_BITPOS (TYPE_FIELD (thistype, n))
 879 #define TYPE_FIELD_STATIC_PHYSNAME(thistype, n) FIELD_STATIC_PHYSNAME (TYPE_FIELD (thistype, n))
 880 #define TYPE_FIELD_STATIC_PHYSADDR(thistype, n) FIELD_STATIC_PHYSADDR (TYPE_FIELD (thistype, n))
 881 #define TYPE_FIELD_DWARF_BLOCK(thistype, n) FIELD_DWARF_BLOCK (TYPE_FIELD (thistype, n))
 882 #define TYPE_FIELD_ARTIFICIAL(thistype, n) FIELD_ARTIFICIAL(TYPE_FIELD(thistype,n))
 883 #define TYPE_FIELD_BITSIZE(thistype, n) FIELD_BITSIZE(TYPE_FIELD(thistype,n))
 884 #define TYPE_FIELD_PACKED(thistype, n) (FIELD_BITSIZE(TYPE_FIELD(thistype,n))!=0)
 885 #define TYPE_TEMPLATE_ARG(thistype, n) TYPE_CPLUS_SPECIFIC(thistype)->template_args[n]
 886
 887 #define TYPE_FIELD_PRIVATE_BITS(thistype) \
 888   TYPE_CPLUS_SPECIFIC(thistype)->private_field_bits
 889 #define TYPE_FIELD_PROTECTED_BITS(thistype) \
 890   TYPE_CPLUS_SPECIFIC(thistype)->protected_field_bits
 891 #define TYPE_FIELD_IGNORE_BITS(thistype) \
 892   TYPE_CPLUS_SPECIFIC(thistype)->ignore_field_bits
 893 #define TYPE_FIELD_VIRTUAL_BITS(thistype) \
 894   TYPE_CPLUS_SPECIFIC(thistype)->virtual_field_bits
 895 #define SET_TYPE_FIELD_PRIVATE(thistype, n) \
 896   B_SET (TYPE_CPLUS_SPECIFIC(thistype)->private_field_bits, (n))
 897 #define SET_TYPE_FIELD_PROTECTED(thistype, n) \
 898   B_SET (TYPE_CPLUS_SPECIFIC(thistype)->protected_field_bits, (n))
 899 #define SET_TYPE_FIELD_IGNORE(thistype, n) \
 900   B_SET (TYPE_CPLUS_SPECIFIC(thistype)->ignore_field_bits, (n))
 901 #define SET_TYPE_FIELD_VIRTUAL(thistype, n) \
 902   B_SET (TYPE_CPLUS_SPECIFIC(thistype)->virtual_field_bits, (n))
 903 #define TYPE_FIELD_PRIVATE(thistype, n) \
 904   (TYPE_CPLUS_SPECIFIC(thistype)->private_field_bits == NULL ? 0 \
 905     : B_TST(TYPE_CPLUS_SPECIFIC(thistype)->private_field_bits, (n)))
 906 #define TYPE_FIELD_PROTECTED(thistype, n) \
 907   (TYPE_CPLUS_SPECIFIC(thistype)->protected_field_bits == NULL ? 0 \
 908     : B_TST(TYPE_CPLUS_SPECIFIC(thistype)->protected_field_bits, (n)))
 909 #define TYPE_FIELD_IGNORE(thistype, n) \
 910   (TYPE_CPLUS_SPECIFIC(thistype)->ignore_field_bits == NULL ? 0 \
 911     : B_TST(TYPE_CPLUS_SPECIFIC(thistype)->ignore_field_bits, (n)))
 912 #define TYPE_FIELD_VIRTUAL(thistype, n) \
 913   (TYPE_CPLUS_SPECIFIC(thistype)->virtual_field_bits == NULL ? 0 \
 914     : B_TST(TYPE_CPLUS_SPECIFIC(thistype)->virtual_field_bits, (n)))
 915
 916 #define TYPE_FN_FIELDLISTS(thistype) TYPE_CPLUS_SPECIFIC(thistype)->fn_fieldlists
 917 #define TYPE_FN_FIELDLIST(thistype, n) TYPE_CPLUS_SPECIFIC(thistype)->fn_fieldlists[n]
 918 #define TYPE_FN_FIELDLIST1(thistype, n) TYPE_CPLUS_SPECIFIC(thistype)->fn_fieldlists[n].fn_fields
 919 #define TYPE_FN_FIELDLIST_NAME(thistype, n) TYPE_CPLUS_SPECIFIC(thistype)->fn_fieldlists[n].name
 920 #define TYPE_FN_FIELDLIST_LENGTH(thistype, n) TYPE_CPLUS_SPECIFIC(thistype)->fn_fieldlists[n].length
 921
 922 #define TYPE_FN_FIELD(thisfn, n) (thisfn)[n]
 923 #define TYPE_FN_FIELD_PHYSNAME(thisfn, n) (thisfn)[n].physname
 924 #define TYPE_FN_FIELD_TYPE(thisfn, n) (thisfn)[n].type
 925 #define TYPE_FN_FIELD_ARGS(thisfn, n) TYPE_FIELDS ((thisfn)[n].type)
 926 #define TYPE_FN_FIELD_CONST(thisfn, n) ((thisfn)[n].is_const)
 927 #define TYPE_FN_FIELD_VOLATILE(thisfn, n) ((thisfn)[n].is_volatile)
 928 #define TYPE_FN_FIELD_PRIVATE(thisfn, n) ((thisfn)[n].is_private)
 929 #define TYPE_FN_FIELD_PROTECTED(thisfn, n) ((thisfn)[n].is_protected)
 930 #define TYPE_FN_FIELD_PUBLIC(thisfn, n) ((thisfn)[n].is_public)
 931 #define TYPE_FN_FIELD_STATIC(thisfn, n) ((thisfn)[n].is_static)
 932 #define TYPE_FN_FIELD_FINAL(thisfn, n) ((thisfn)[n].is_final)
 933 #define TYPE_FN_FIELD_SYNCHRONIZED(thisfn, n) ((thisfn)[n].is_synchronized)
 934 #define TYPE_FN_FIELD_NATIVE(thisfn, n) ((thisfn)[n].is_native)
 935 #define TYPE_FN_FIELD_ARTIFICIAL(thisfn, n) ((thisfn)[n].is_artificial)
 936 #define TYPE_FN_FIELD_ABSTRACT(thisfn, n) ((thisfn)[n].is_abstract)
 937 #define TYPE_FN_FIELD_STUB(thisfn, n) ((thisfn)[n].is_stub)
 938 #define TYPE_FN_FIELD_FCONTEXT(thisfn, n) ((thisfn)[n].fcontext)
 939 #define TYPE_FN_FIELD_VOFFSET(thisfn, n) ((thisfn)[n].voffset-2)
 940 #define TYPE_FN_FIELD_VIRTUAL_P(thisfn, n) ((thisfn)[n].voffset > 1)
 941 #define TYPE_FN_FIELD_STATIC_P(thisfn, n) ((thisfn)[n].voffset == VOFFSET_STATIC)
 942
 943 #define TYPE_LOCALTYPE_PTR(thistype) (TYPE_CPLUS_SPECIFIC(thistype)->localtype_ptr)
 944 #define TYPE_LOCALTYPE_FILE(thistype) (TYPE_CPLUS_SPECIFIC(thistype)->localtype_ptr->file)
 945 #define TYPE_LOCALTYPE_LINE(thistype) (TYPE_CPLUS_SPECIFIC(thistype)->localtype_ptr->line)
 946
 947 #define TYPE_IS_OPAQUE(thistype) (((TYPE_CODE (thistype) == TYPE_CODE_STRUCT) ||        \
 948                                    (TYPE_CODE (thistype) == TYPE_CODE_UNION))        && \
 949                                   (TYPE_NFIELDS (thistype) == 0)                     && \
 950                                   (TYPE_CPLUS_SPECIFIC (thistype) && (TYPE_NFN_FIELDS (thistype) == 0)) && \
 951                                   (TYPE_STUB (thistype) || !TYPE_STUB_SUPPORTED (thistype)))
 952
 953 struct builtin_type
 954 {
 955   /* Address/pointer types.  */
 956
 957   /* `pointer to data' type.  Some target platforms use an implicitly
 958      {sign,zero} -extended 32-bit ABI pointer on a 64-bit ISA.  */
 959   struct type *builtin_data_ptr;
 960
 961   /* `pointer to function (returning void)' type.  Harvard
 962      architectures mean that ABI function and code pointers are not
 963      interconvertible.  Similarly, since ANSI, C standards have
 964      explicitly said that pointers to functions and pointers to data
 965      are not interconvertible --- that is, you can't cast a function
 966      pointer to void * and back, and expect to get the same value.
 967      However, all function pointer types are interconvertible, so void
 968      (*) () can server as a generic function pointer.  */
 969   struct type *builtin_func_ptr;
 970
 971   /* The target CPU's address type.  This is the ISA address size.  */
 972   struct type *builtin_core_addr;
 973
 974
 975   /* Types used for symbols with no debug information.  */
 976   struct type *nodebug_text_symbol;
 977   struct type *nodebug_data_symbol;
 978   struct type *nodebug_unknown_symbol;
 979   struct type *nodebug_tls_symbol;
 980
 981
 982   /* Integral types.  */
 983
 984   /* Implicit size/sign (based on the the architecture's ABI).  */
 985   struct type *builtin_void;
 986   struct type *builtin_char;
 987   struct type *builtin_short;
 988   struct type *builtin_int;
 989   struct type *builtin_long;
 990   struct type *builtin_signed_char;
 991   struct type *builtin_unsigned_char;
 992   struct type *builtin_unsigned_short;
 993   struct type *builtin_unsigned_int;
 994   struct type *builtin_unsigned_long;
 995   struct type *builtin_float;
 996   struct type *builtin_double;
 997   struct type *builtin_long_double;
 998   struct type *builtin_complex;
 999   struct type *builtin_double_complex;
1000   struct type *builtin_string;
1001   struct type *builtin_bool;
1002   struct type *builtin_long_long;
1003   struct type *builtin_unsigned_long_long;
1004   struct type *builtin_decfloat;
1005   struct type *builtin_decdouble;
1006   struct type *builtin_declong;
1007 };
1008
1009 /* Return the type table for the specified architecture.  */
1010 extern const struct builtin_type *builtin_type (struct gdbarch *gdbarch);
1011
1012
1013 /* Explicit sizes - see C9X <intypes.h> for naming scheme.  The "int0"
1014    is for when an architecture needs to describe a register that has
1015    no size.  */
1016 extern struct type *builtin_type_int0;
1017 extern struct type *builtin_type_int8;
1018 extern struct type *builtin_type_uint8;
1019 extern struct type *builtin_type_int16;
1020 extern struct type *builtin_type_uint16;
1021 extern struct type *builtin_type_int32;
1022 extern struct type *builtin_type_uint32;
1023 extern struct type *builtin_type_int64;
1024 extern struct type *builtin_type_uint64;
1025 extern struct type *builtin_type_int128;
1026 extern struct type *builtin_type_uint128;
1027
1028 /* Explicit floating-point formats.  See "floatformat.h".  */
1029 extern const struct floatformat *floatformats_ieee_single[BFD_ENDIAN_UNKNOWN];
1030 extern const struct floatformat *floatformats_ieee_double[BFD_ENDIAN_UNKNOWN];
1031 extern const struct floatformat *floatformats_ieee_double_littlebyte_bigword[BFD_ENDIAN_UNKNOWN];
1032 extern const struct floatformat *floatformats_i387_ext[BFD_ENDIAN_UNKNOWN];
1033 extern const struct floatformat *floatformats_m68881_ext[BFD_ENDIAN_UNKNOWN];
1034 extern const struct floatformat *floatformats_arm_ext[BFD_ENDIAN_UNKNOWN];
1035 extern const struct floatformat *floatformats_ia64_spill[BFD_ENDIAN_UNKNOWN];
1036 extern const struct floatformat *floatformats_ia64_quad[BFD_ENDIAN_UNKNOWN];
1037 extern const struct floatformat *floatformats_vax_f[BFD_ENDIAN_UNKNOWN];
1038 extern const struct floatformat *floatformats_vax_d[BFD_ENDIAN_UNKNOWN];
1039 extern const struct floatformat *floatformats_ibm_long_double[BFD_ENDIAN_UNKNOWN];
1040
1041 extern struct type *builtin_type_ieee_single;
1042 extern struct type *builtin_type_ieee_double;
1043 extern struct type *builtin_type_i387_ext;
1044 extern struct type *builtin_type_m68881_ext;
1045 extern struct type *builtin_type_arm_ext;
1046 extern struct type *builtin_type_ia64_spill;
1047 extern struct type *builtin_type_ia64_quad;
1048
1049 /* Platform-neutral void type.  Never attempt to construct a pointer
1050    or reference type to this, because those cannot be platform-neutral.
1051    You must use builtin_type (...)->builtin_void in those cases.  */
1052 extern struct type *builtin_type_void;
1053
1054 /* Platform-neutral character types.
1055    We use these for the '/c' print format, because c_char is just a
1056    one-byte integral type, which languages less laid back than C
1057    will print as ... well, a one-byte integral type.  */
1058 extern struct type *builtin_type_true_char;
1059 extern struct type *builtin_type_true_unsigned_char;
1060
1061
1062 /* This type represents a type that was unrecognized in symbol
1063    read-in.  */
1064 extern struct type *builtin_type_error;
1065
1066
1067 /* RTTI for C++ */
1068 /* extern struct type *builtin_type_cxx_typeinfo; */
1069
1070 /* Maximum and minimum values of built-in types */
1071
1072 #define MAX_OF_TYPE(t)  \
1073    (TYPE_UNSIGNED(t) ? UMAX_OF_SIZE(TYPE_LENGTH(t)) \
1074     : MAX_OF_SIZE(TYPE_LENGTH(t)))
1075
1076 #define MIN_OF_TYPE(t)  \
1077    (TYPE_UNSIGNED(t) ? UMIN_OF_SIZE(TYPE_LENGTH(t)) \
1078     : MIN_OF_SIZE(TYPE_LENGTH(t)))
1079
1080 /* Allocate space for storing data associated with a particular type.
1081    We ensure that the space is allocated using the same mechanism that
1082    was used to allocate the space for the type structure itself.  I.E.
1083    if the type is on an objfile's objfile_obstack, then the space for data
1084    associated with that type will also be allocated on the objfile_obstack.
1085    If the type is not associated with any particular objfile (such as
1086    builtin types), then the data space will be allocated with xmalloc,
1087    the same as for the type structure. */
1088
1089 #define TYPE_ALLOC(t,size)  \
1090    (TYPE_OBJFILE (t) != NULL  \
1091     ? obstack_alloc (&TYPE_OBJFILE (t) -> objfile_obstack, size) \
1092     : xmalloc (size))
1093
1094 #define TYPE_ZALLOC(t,size)  \
1095    (TYPE_OBJFILE (t) != NULL  \
1096     ? memset (obstack_alloc (&TYPE_OBJFILE (t)->objfile_obstack, size),  \
1097               0, size)  \
1098     : xzalloc (size))
1099
1100 extern struct type *alloc_type (struct objfile *);
1101
1102 extern struct type *init_type (enum type_code, int, int, char *,
1103                                struct objfile *);
1104
1105 /* Helper functions to construct a struct or record type.  An
1106    initially empty type is created using init_composite_type().
1107    Fields are then added using append_struct_type_field().  A union
1108    type has its size set to the largest field.  A struct type has each
1109    field packed against the previous.  */
1110
1111 extern struct type *init_composite_type (char *name, enum type_code code);
1112 extern void append_composite_type_field (struct type *t, char *name,
1113                                          struct type *field);
1114
1115 /* Helper functions to construct a bit flags type.  An initially empty
1116    type is created using init_flag_type().  Flags are then added using
1117    append_flag_type_flag().  */
1118 extern struct type *init_flags_type (char *name, int length);
1119 extern void append_flags_type_flag (struct type *type, int bitpos, char *name);
1120
1121 extern void make_vector_type (struct type *array_type);
1122 extern struct type *init_vector_type (struct type *elt_type, int n);
1123
1124 extern struct type *lookup_reference_type (struct type *);
1125
1126 extern struct type *make_reference_type (struct type *, struct type **);
1127
1128 extern struct type *make_cv_type (int, int, struct type *, struct type **);
1129
1130 extern void replace_type (struct type *, struct type *);
1131
1132 extern int address_space_name_to_int (char *);
1133
1134 extern const char *address_space_int_to_name (int);
1135
1136 extern struct type *make_type_with_address_space (struct type *type,
1137                                                   int space_identifier);
1138
1139 extern struct type *lookup_memberptr_type (struct type *, struct type *);
1140
1141 extern struct type *lookup_methodptr_type (struct type *);
1142
1143 extern void smash_to_method_type (struct type *type, struct type *domain,
1144                                   struct type *to_type, struct field *args,
1145                                   int nargs, int varargs);
1146
1147 extern void smash_to_memberptr_type (struct type *, struct type *,
1148                                      struct type *);
1149
1150 extern struct type *allocate_stub_method (struct type *);
1151
1152 extern char *type_name_no_tag (const struct type *);
1153
1154 extern struct type *lookup_struct_elt_type (struct type *, char *, int);
1155
1156 extern struct type *make_pointer_type (struct type *, struct type **);
1157
1158 extern struct type *lookup_pointer_type (struct type *);
1159
1160 extern struct type *make_function_type (struct type *, struct type **);
1161
1162 extern struct type *lookup_function_type (struct type *);
1163
1164 extern struct type *create_range_type (struct type *, struct type *, int,
1165                                        int);
1166
1167 extern struct type *create_array_type (struct type *, struct type *,
1168                                        struct type *);
1169
1170 extern struct type *create_string_type (struct type *, struct type *);
1171
1172 extern struct type *create_set_type (struct type *, struct type *);
1173
1174 extern struct type *lookup_unsigned_typename (char *);
1175
1176 extern struct type *lookup_signed_typename (char *);
1177
1178 extern struct type *check_typedef (struct type *);
1179
1180 #define CHECK_TYPEDEF(TYPE) (TYPE) = check_typedef (TYPE)
1181
1182 extern void check_stub_method_group (struct type *, int);
1183
1184 extern char *gdb_mangle_name (struct type *, int, int);
1185
1186 extern struct type *lookup_typename (char *, struct block *, int);
1187
1188 extern struct type *lookup_template_type (char *, struct type *,
1189                                           struct block *);
1190
1191 extern int get_vptr_fieldno (struct type *, struct type **);
1192
1193 extern int get_destructor_fn_field (struct type *, int *, int *);
1194
1195 extern int get_discrete_bounds (struct type *, LONGEST *, LONGEST *);
1196
1197 extern int is_ancestor (struct type *, struct type *);
1198
1199 /* Overload resolution */
1200
1201 #define LENGTH_MATCH(bv) ((bv)->rank[0])
1202
1203 /* Badness if parameter list length doesn't match arg list length */
1204 #define LENGTH_MISMATCH_BADNESS      100
1205 /* Dummy badness value for nonexistent parameter positions */
1206 #define TOO_FEW_PARAMS_BADNESS       100
1207 /* Badness if no conversion among types */
1208 #define INCOMPATIBLE_TYPE_BADNESS    100
1209
1210 /* Badness of integral promotion */
1211 #define INTEGER_PROMOTION_BADNESS      1
1212 /* Badness of floating promotion */
1213 #define FLOAT_PROMOTION_BADNESS        1
1214 /* Badness of integral conversion */
1215 #define INTEGER_CONVERSION_BADNESS     2
1216 /* Badness of floating conversion */
1217 #define FLOAT_CONVERSION_BADNESS       2
1218 /* Badness of integer<->floating conversions */
1219 #define INT_FLOAT_CONVERSION_BADNESS   2
1220 /* Badness of converting to a boolean */
1221 #define BOOLEAN_CONVERSION_BADNESS     2
1222 /* Badness of pointer conversion */
1223 #define POINTER_CONVERSION_BADNESS     2
1224 /* Badness of conversion of pointer to void pointer */
1225 #define VOID_PTR_CONVERSION_BADNESS    2
1226 /* Badness of converting derived to base class */
1227 #define BASE_CONVERSION_BADNESS        2
1228 /* Badness of converting from non-reference to reference */
1229 #define REFERENCE_CONVERSION_BADNESS   2
1230
1231 /* Non-standard conversions allowed by the debugger */
1232 /* Converting a pointer to an int is usually OK */
1233 #define NS_POINTER_CONVERSION_BADNESS 10
1234
1235
1236 extern int compare_badness (struct badness_vector *, struct badness_vector *);
1237
1238 extern struct badness_vector *rank_function (struct type **, int,
1239                                              struct type **, int);
1240
1241 extern int rank_one_type (struct type *, struct type *);
1242
1243 extern void recursive_dump_type (struct type *, int);
1244
1245 extern int field_is_static (struct field *);
1246
1247 /* printcmd.c */
1248
1249 extern void print_scalar_formatted (const void *, struct type *, int, int,
1250                                     struct ui_file *);
1251
1252 extern int can_dereference (struct type *);
1253
1254 extern int is_integral_type (struct type *);
1255
1256 extern void maintenance_print_type (char *, int);
1257
1258 extern htab_t create_copied_types_hash (struct objfile *objfile);
1259
1260 extern struct type *copy_type_recursive (struct objfile *objfile,
1261                                          struct type *type,
1262                                          htab_t copied_types);
1263
1264 extern struct type *copy_type (const struct type *type);
1265
1266 #endif /* GDBTYPES_H */