gdb/symtab.h

   1 /* Symbol table definitions for GDB.
   2    Copyright (C) 1986, 1989, 1991, 1992 Free Software Foundation, Inc.
   3
   4 This file is part of GDB.
   5
   6 This program is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2 of the License, or
   9 (at your option) any later version.
  10
  11 This program is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with this program; if not, write to the Free Software
  18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
  19
  20 #if !defined (SYMTAB_H)
  21 #define SYMTAB_H 1
  22
  23 /* Some definitions and declarations to go with use of obstacks.  */
  24
  25 #include "obstack.h"
  26 #define obstack_chunk_alloc xmalloc
  27 #define obstack_chunk_free free
  28
  29 /* Define a structure for the information that is common to all symbol types,
  30    including minimal symbols, partial symbols, and full symbols.  In a
  31    multilanguage environment, some language specific information may need to
  32    be recorded along with each symbol. */
  33
  34 struct general_symbol_info
  35 {
  36   /* Name of the symbol.  This is a required field.  Storage for the name is
  37      allocated on the psymbol_obstack or symbol_obstack for the associated
  38      objfile. */
  39
  40   char *name;
  41
  42   /* Value of the symbol.  Which member of this union to use, and what
  43      it means, depends on what kind of symbol this is and its
  44      SYMBOL_CLASS.  See comments there for more details.  All of these
  45      are in host byte order (though what they point to might be in
  46      target byte order, e.g. LOC_CONST_BYTES).  */
  47
  48   union
  49     {
  50       long value;
  51
  52       struct block *block;
  53
  54       char *bytes;
  55
  56       CORE_ADDR address;
  57
  58       /* for opaque typedef struct chain */
  59
  60       struct symbol *chain;
  61     }
  62   value;
  63
  64   /* Record the source code language that applies to this symbol.
  65      This is used to select one of the fields from the language specific
  66      union below. */
  67
  68   enum language language;
  69
  70   /* Since one and only one language can apply, wrap the language specific
  71      information inside a union. */
  72
  73   union
  74     {
  75       struct cplus_specific      /* For C++ */
  76         {
  77           char *demangled_name;
  78         } cplus_specific;
  79       struct chill_specific      /* For Chill */
  80         {
  81           char *demangled_name;
  82         } chill_specific;
  83     } language_specific;
  84
  85   /* Which section is this symbol in?  This is an index into
  86      section_offsets for this objfile.  Negative means that the symbol
  87      does not get relocated relative to a section.
  88      Disclaimer: currently this is just used for xcoff, so don't expect
  89      all symbol-reading code to set it correctly.  */
  90
  91   int section;
  92 };
  93
  94 #define SYMBOL_NAME(symbol)             (symbol)->ginfo.name
  95 #define SYMBOL_VALUE(symbol)            (symbol)->ginfo.value.value
  96 #define SYMBOL_VALUE_ADDRESS(symbol)    (symbol)->ginfo.value.address
  97 #define SYMBOL_VALUE_BYTES(symbol)      (symbol)->ginfo.value.bytes
  98 #define SYMBOL_BLOCK_VALUE(symbol)      (symbol)->ginfo.value.block
  99 #define SYMBOL_VALUE_CHAIN(symbol)      (symbol)->ginfo.value.chain
 100 #define SYMBOL_LANGUAGE(symbol)         (symbol)->ginfo.language
 101 #define SYMBOL_SECTION(symbol)          (symbol)->ginfo.section
 102
 103 #define SYMBOL_CPLUS_DEMANGLED_NAME(symbol)     \
 104   (symbol)->ginfo.language_specific.cplus_specific.demangled_name
 105
 106
 107 extern int demangle;    /* We reference it, so go ahead and declare it. */
 108
 109 /* Macro that initializes the language dependent portion of a symbol
 110    depending upon the language for the symbol. */
 111
 112 #define SYMBOL_INIT_LANGUAGE_SPECIFIC(symbol,language)                  \
 113   do {                                                                  \
 114     SYMBOL_LANGUAGE (symbol) = language;                                \
 115     if (SYMBOL_LANGUAGE (symbol) == language_cplus)                     \
 116       {                                                                 \
 117         SYMBOL_CPLUS_DEMANGLED_NAME (symbol) = NULL;                    \
 118       }                                                                 \
 119     else if (SYMBOL_LANGUAGE (symbol) == language_chill)                \
 120       {                                                                 \
 121         SYMBOL_CHILL_DEMANGLED_NAME (symbol) = NULL;                    \
 122       }                                                                 \
 123     else                                                                \
 124       {                                                                 \
 125         memset (&(symbol)->ginfo.language_specific, 0,                  \
 126                 sizeof ((symbol)->ginfo.language_specific));            \
 127       }                                                                 \
 128   } while (0)
 129
 130 /* Macro that attempts to initialize the demangled name for a symbol,
 131    based on the language of that symbol.  If the language is set to
 132    language_auto, it will attempt to find any demangling algorithm
 133    that works and then set the language appropriately.  If no demangling
 134    of any kind is found, the language is set back to language_unknown,
 135    so we can avoid doing this work again the next time we encounter
 136    the symbol.  Any required space to store the name is obtained from the
 137    specified obstack. */
 138
 139 #define SYMBOL_INIT_DEMANGLED_NAME(symbol,obstack)                      \
 140   do {                                                                  \
 141     char *demangled = NULL;                                             \
 142     if (SYMBOL_LANGUAGE (symbol) == language_cplus                      \
 143         || SYMBOL_LANGUAGE (symbol) == language_auto)                   \
 144       {                                                                 \
 145         demangled =                                                     \
 146           cplus_demangle (SYMBOL_NAME (symbol), DMGL_PARAMS | DMGL_ANSI);\
 147         if (demangled != NULL)                                          \
 148           {                                                             \
 149             SYMBOL_LANGUAGE (symbol) = language_cplus;                  \
 150             SYMBOL_CPLUS_DEMANGLED_NAME (symbol) =                      \
 151               obsavestring (demangled, strlen (demangled), (obstack));  \
 152             free (demangled);                                           \
 153           }                                                             \
 154         else                                                            \
 155           {                                                             \
 156             SYMBOL_CPLUS_DEMANGLED_NAME (symbol) = NULL;                \
 157           }                                                             \
 158       }                                                                 \
 159     if (demangled == NULL                                               \
 160         && (SYMBOL_LANGUAGE (symbol) == language_chill                  \
 161             || SYMBOL_LANGUAGE (symbol) == language_auto))              \
 162       {                                                                 \
 163         demangled =                                                     \
 164           chill_demangle (SYMBOL_NAME (symbol));                        \
 165         if (demangled != NULL)                                          \
 166           {                                                             \
 167             SYMBOL_LANGUAGE (symbol) = language_chill;                  \
 168             SYMBOL_CHILL_DEMANGLED_NAME (symbol) =                      \
 169               obsavestring (demangled, strlen (demangled), (obstack));  \
 170             free (demangled);                                           \
 171           }                                                             \
 172         else                                                            \
 173           {                                                             \
 174             SYMBOL_CHILL_DEMANGLED_NAME (symbol) = NULL;                \
 175           }                                                             \
 176       }                                                                 \
 177     if (SYMBOL_LANGUAGE (symbol) == language_auto)                      \
 178       {                                                                 \
 179         SYMBOL_LANGUAGE (symbol) = language_unknown;                    \
 180       }                                                                 \
 181   } while (0)
 182
 183 /* Macro that returns the demangled name for a symbol based on the language
 184    for that symbol.  If no demangled name exists, returns NULL. */
 185
 186 #define SYMBOL_DEMANGLED_NAME(symbol)                                   \
 187   (SYMBOL_LANGUAGE (symbol) == language_cplus                           \
 188    ? SYMBOL_CPLUS_DEMANGLED_NAME (symbol)                               \
 189    : (SYMBOL_LANGUAGE (symbol) == language_chill                        \
 190       ? SYMBOL_CHILL_DEMANGLED_NAME (symbol)                            \
 191       : NULL))
 192
 193 #define SYMBOL_CHILL_DEMANGLED_NAME(symbol)                             \
 194   (symbol)->ginfo.language_specific.chill_specific.demangled_name
 195
 196 /* Macro that returns the "natural source name" of a symbol.  In C++ this is
 197    the "demangled" form of the name if demangle is on and the "mangled" form
 198    of the name if demangle is off.  In other languages this is just the
 199    symbol name.  The result should never be NULL. */
 200
 201 #define SYMBOL_SOURCE_NAME(symbol)                                      \
 202   (demangle && SYMBOL_DEMANGLED_NAME (symbol) != NULL                   \
 203    ? SYMBOL_DEMANGLED_NAME (symbol)                                     \
 204    : SYMBOL_NAME (symbol))
 205
 206 /* Macro that returns the "natural assembly name" of a symbol.  In C++ this is
 207    the "mangled" form of the name if demangle is off, or if demangle is on and
 208    asm_demangle is off.  Otherwise if asm_demangle is on it is the "demangled"
 209    form.  In other languages this is just the symbol name.  The result should
 210    never be NULL. */
 211
 212 #define SYMBOL_LINKAGE_NAME(symbol)                                     \
 213   (demangle && asm_demangle && SYMBOL_DEMANGLED_NAME (symbol) != NULL   \
 214    ? SYMBOL_DEMANGLED_NAME (symbol)                                     \
 215    : SYMBOL_NAME (symbol))
 216
 217 /* From utils.c.  */
 218 extern int demangle;
 219 extern int asm_demangle;
 220
 221 /* Macro that tests a symbol for a match against a specified name string.
 222    First test the unencoded name, then looks for and test a C++ encoded
 223    name if it exists.  Note that whitespace is ignored while attempting to
 224    match a C++ encoded name, so that "foo::bar(int,long)" is the same as
 225    "foo :: bar (int, long)".
 226    Evaluates to zero if the match fails, or nonzero if it succeeds. */
 227
 228 #define SYMBOL_MATCHES_NAME(symbol, name)                               \
 229   (STREQ (SYMBOL_NAME (symbol), (name))                                 \
 230    || (SYMBOL_DEMANGLED_NAME (symbol) != NULL                           \
 231        && strcmp_iw (SYMBOL_DEMANGLED_NAME (symbol), (name)) == 0))
 232
 233 /* Macro that tests a symbol for an re-match against the last compiled regular
 234    expression.  First test the unencoded name, then look for and test a C++
 235    encoded name if it exists.
 236    Evaluates to zero if the match fails, or nonzero if it succeeds. */
 237
 238 #define SYMBOL_MATCHES_REGEXP(symbol)                                   \
 239   (re_exec (SYMBOL_NAME (symbol)) != 0                                  \
 240    || (SYMBOL_DEMANGLED_NAME (symbol) != NULL                           \
 241        && re_exec (SYMBOL_DEMANGLED_NAME (symbol)) != 0))
 242
 243 /* Define a simple structure used to hold some very basic information about
 244    all defined global symbols (text, data, bss, abs, etc).  The only required
 245    information is the general_symbol_info.
 246
 247    In many cases, even if a file was compiled with no special options for
 248    debugging at all, as long as was not stripped it will contain sufficient
 249    information to build a useful minimal symbol table using this structure.
 250    Even when a file contains enough debugging information to build a full
 251    symbol table, these minimal symbols are still useful for quickly mapping
 252    between names and addresses, and vice versa.  They are also sometimes
 253    used to figure out what full symbol table entries need to be read in. */
 254
 255 struct minimal_symbol
 256 {
 257
 258   /* The general symbol info required for all types of symbols.
 259
 260      The SYMBOL_VALUE_ADDRESS contains the address that this symbol
 261      corresponds to.  */
 262
 263   struct general_symbol_info ginfo;
 264
 265   /* The info field is available for caching machine-specific information that
 266      The AMD 29000 tdep.c uses it to remember things it has decoded from the
 267      instructions in the function header, so it doesn't have to rederive the
 268      info constantly (over a serial line).  It is initialized to zero and
 269      stays that way until target-dependent code sets it.  Storage for any data
 270      pointed to by this field should be allocated on the symbol_obstack for
 271      the associated objfile.  The type would be "void *" except for reasons
 272      of compatibility with older compilers.  This field is optional. */
 273
 274   char *info;
 275
 276   /* Classification types for this symbol.  These should be taken as "advisory
 277      only", since if gdb can't easily figure out a classification it simply
 278      selects mst_unknown.  It may also have to guess when it can't figure out
 279      which is a better match between two types (mst_data versus mst_bss) for
 280      example.  Since the minimal symbol info is sometimes derived from the
 281      BFD library's view of a file, we need to live with what information bfd
 282      supplies. */
 283
 284   enum minimal_symbol_type
 285     {
 286       mst_unknown = 0,          /* Unknown type, the default */
 287       mst_text,                 /* Generally executable instructions */
 288       mst_data,                 /* Generally initialized data */
 289       mst_bss,                  /* Generally uninitialized data */
 290       mst_abs,                  /* Generally absolute (nonrelocatable) */
 291       /* For the mst_file* types, the names are only guaranteed to be unique
 292          within a given .o file.  */
 293       mst_file_text,            /* Static version of mst_text */
 294       mst_file_data,            /* Static version of mst_data */
 295       mst_file_bss              /* Static version of mst_bss */
 296     } type;
 297
 298 };
 299
 300 #define MSYMBOL_INFO(msymbol)           (msymbol)->info
 301 #define MSYMBOL_TYPE(msymbol)           (msymbol)->type
 302
 303 \f
 304 /* All of the name-scope contours of the program
 305    are represented by `struct block' objects.
 306    All of these objects are pointed to by the blockvector.
 307
 308    Each block represents one name scope.
 309    Each lexical context has its own block.
 310
 311    The blockvector begins with some special blocks.
 312    The GLOBAL_BLOCK contains all the symbols defined in this compilation
 313    whose scope is the entire program linked together.
 314    The STATIC_BLOCK contains all the symbols whose scope is the
 315    entire compilation excluding other separate compilations.
 316    Blocks starting with the FIRST_LOCAL_BLOCK are not special.
 317
 318    Each block records a range of core addresses for the code that
 319    is in the scope of the block.  The STATIC_BLOCK and GLOBAL_BLOCK
 320    give, for the range of code, the entire range of code produced
 321    by the compilation that the symbol segment belongs to.
 322
 323    The blocks appear in the blockvector
 324    in order of increasing starting-address,
 325    and, within that, in order of decreasing ending-address.
 326
 327    This implies that within the body of one function
 328    the blocks appear in the order of a depth-first tree walk.  */
 329
 330 struct blockvector
 331 {
 332   /* Number of blocks in the list.  */
 333   int nblocks;
 334   /* The blocks themselves.  */
 335   struct block *block[1];
 336 };
 337
 338 #define BLOCKVECTOR_NBLOCKS(blocklist) (blocklist)->nblocks
 339 #define BLOCKVECTOR_BLOCK(blocklist,n) (blocklist)->block[n]
 340
 341 /* Special block numbers */
 342
 343 #define GLOBAL_BLOCK            0
 344 #define STATIC_BLOCK            1
 345 #define FIRST_LOCAL_BLOCK       2
 346
 347 struct block
 348 {
 349
 350   /* Addresses in the executable code that are in this block.  */
 351
 352   CORE_ADDR startaddr;
 353   CORE_ADDR endaddr;
 354
 355   /* The symbol that names this block, if the block is the body of a
 356      function; otherwise, zero.  */
 357
 358   struct symbol *function;
 359
 360   /* The `struct block' for the containing block, or 0 if none.
 361
 362      The superblock of a top-level local block (i.e. a function in the
 363      case of C) is the STATIC_BLOCK.  The superblock of the
 364      STATIC_BLOCK is the GLOBAL_BLOCK.  */
 365
 366   struct block *superblock;
 367
 368   /* Version of GCC used to compile the function corresponding
 369      to this block, or 0 if not compiled with GCC.  When possible,
 370      GCC should be compatible with the native compiler, or if that
 371      is not feasible, the differences should be fixed during symbol
 372      reading.  As of 16 Apr 93, this flag is never used to distinguish
 373      between gcc2 and the native compiler.
 374
 375      If there is no function corresponding to this block, this meaning
 376      of this flag is undefined.  */
 377
 378   unsigned char gcc_compile_flag;
 379
 380   /* Number of local symbols.  */
 381
 382   int nsyms;
 383
 384   /* The symbols.  If some of them are arguments, then they must be
 385      in the order in which we would like to print them.  */
 386
 387   struct symbol *sym[1];
 388 };
 389
 390 #define BLOCK_START(bl)         (bl)->startaddr
 391 #define BLOCK_END(bl)           (bl)->endaddr
 392 #define BLOCK_NSYMS(bl)         (bl)->nsyms
 393 #define BLOCK_SYM(bl, n)        (bl)->sym[n]
 394 #define BLOCK_FUNCTION(bl)      (bl)->function
 395 #define BLOCK_SUPERBLOCK(bl)    (bl)->superblock
 396 #define BLOCK_GCC_COMPILED(bl)  (bl)->gcc_compile_flag
 397
 398 /* Nonzero if symbols of block BL should be sorted alphabetically.
 399    Don't sort a block which corresponds to a function.  If we did the
 400    sorting would have to preserve the order of the symbols for the
 401    arguments.  */
 402
 403 #define BLOCK_SHOULD_SORT(bl) ((bl)->nsyms >= 40 && BLOCK_FUNCTION (bl) == NULL)
 404
 405 \f
 406 /* Represent one symbol name; a variable, constant, function or typedef.  */
 407
 408 /* Different name spaces for symbols.  Looking up a symbol specifies a
 409    namespace and ignores symbol definitions in other name spaces. */
 410
 411 enum namespace
 412 {
 413   /* UNDEF_NAMESPACE is used when a namespace has not been discovered or
 414      none of the following apply.  This usually indicates an error either
 415      in the symbol information or in gdb's handling of symbols. */
 416
 417   UNDEF_NAMESPACE,
 418
 419   /* VAR_NAMESPACE is the usual namespace.  In C, this contains variables,
 420      function names, typedef names and enum type values. */
 421
 422   VAR_NAMESPACE,
 423
 424   /* STRUCT_NAMESPACE is used in C to hold struct, union and enum type names.
 425      Thus, if `struct foo' is used in a C program, it produces a symbol named
 426      `foo' in the STRUCT_NAMESPACE. */
 427
 428   STRUCT_NAMESPACE,
 429
 430   /* LABEL_NAMESPACE may be used for names of labels (for gotos);
 431      currently it is not used and labels are not recorded at all.  */
 432
 433   LABEL_NAMESPACE
 434 };
 435
 436 /* An address-class says where to find the value of a symbol.  */
 437
 438 enum address_class
 439 {
 440   /* Not used; catches errors */
 441
 442   LOC_UNDEF,
 443
 444   /* Value is constant int SYMBOL_VALUE, host byteorder */
 445
 446   LOC_CONST,
 447
 448   /* Value is at fixed address SYMBOL_VALUE_ADDRESS */
 449
 450   LOC_STATIC,
 451
 452   /* Value is in register.  SYMBOL_VALUE is the register number.  */
 453
 454   LOC_REGISTER,
 455
 456   /* It's an argument; the value is at SYMBOL_VALUE offset in arglist.  */
 457
 458   LOC_ARG,
 459
 460   /* Value address is at SYMBOL_VALUE offset in arglist.  */
 461
 462   LOC_REF_ARG,
 463
 464   /* Value is in register number SYMBOL_VALUE.  Just like LOC_REGISTER
 465      except this is an argument.  Probably the cleaner way to handle
 466      this would be to separate address_class (which would include
 467      separate ARG and LOCAL to deal with FRAME_ARGS_ADDRESS versus
 468      FRAME_LOCALS_ADDRESS), and an is_argument flag.
 469
 470      For some symbol formats (stabs, for some compilers at least),
 471      the compiler generates two symbols, an argument and a register.
 472      In some cases we combine them to a single LOC_REGPARM in symbol
 473      reading, but currently not for all cases (e.g. it's passed on the
 474      stack and then loaded into a register).  */
 475
 476   LOC_REGPARM,
 477
 478   /* Value is in specified register.  Just like LOC_REGPARM except the
 479      register holds the address of the argument instead of the argument
 480      itself. This is currently used for the passing of structs and unions
 481      on sparc and hppa.  It is also used for call by reference where the
 482      address is in a register, at least by mipsread.c.  */
 483
 484   LOC_REGPARM_ADDR,
 485
 486   /* Value is a local variable at SYMBOL_VALUE offset in stack frame.  */
 487
 488   LOC_LOCAL,
 489
 490   /* Value not used; definition in SYMBOL_TYPE.  Symbols in the namespace
 491      STRUCT_NAMESPACE all have this class.  */
 492
 493   LOC_TYPEDEF,
 494
 495   /* Value is address SYMBOL_VALUE_ADDRESS in the code */
 496
 497   LOC_LABEL,
 498
 499   /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
 500      In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
 501      of the block.  Function names have this class. */
 502
 503   LOC_BLOCK,
 504
 505   /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
 506      target byte order.  */
 507
 508   LOC_CONST_BYTES,
 509
 510   /* Value is arg at SYMBOL_VALUE offset in stack frame. Differs from
 511      LOC_LOCAL in that symbol is an argument; differs from LOC_ARG in
 512      that we find it in the frame (FRAME_LOCALS_ADDRESS), not in the
 513      arglist (FRAME_ARGS_ADDRESS).  Added for i960, which passes args
 514      in regs then copies to frame.  */
 515
 516   LOC_LOCAL_ARG,
 517
 518   /* The variable does not actually exist in the program.
 519      The value is ignored.  */
 520
 521   LOC_OPTIMIZED_OUT
 522 };
 523
 524 struct symbol
 525 {
 526
 527   /* The general symbol info required for all types of symbols. */
 528
 529   struct general_symbol_info ginfo;
 530
 531   /* Name space code.  */
 532
 533   enum namespace namespace;
 534
 535   /* Address class */
 536
 537   enum address_class class;
 538
 539   /* Data type of value */
 540
 541   struct type *type;
 542
 543   /* Line number of definition.  FIXME:  Should we really make the assumption
 544      that nobody will try to debug files longer than 64K lines?  What about
 545      machine generated programs? */
 546
 547   unsigned short line;
 548
 549   /* Some symbols require an additional value to be recorded on a per-
 550      symbol basis.  Stash those values here. */
 551
 552   union
 553     {
 554       /* for OP_BASEREG in DWARF location specs */
 555       struct
 556         {
 557           short regno_valid;    /* 0 == regno invalid; !0 == regno valid */
 558           short regno;          /* base register number {0, 1, 2, ...} */
 559         } basereg;
 560     }
 561   aux_value;
 562
 563 };
 564
 565 #define SYMBOL_NAMESPACE(symbol)        (symbol)->namespace
 566 #define SYMBOL_CLASS(symbol)            (symbol)->class
 567 #define SYMBOL_TYPE(symbol)             (symbol)->type
 568 #define SYMBOL_LINE(symbol)             (symbol)->line
 569 #define SYMBOL_BASEREG(symbol)          (symbol)->aux_value.basereg.regno
 570
 571 /* If we want to do baseregs using this approach we should have a
 572    LOC_BASEREG (and LOC_BASEREG_ARG) rather than changing the meaning
 573    of LOC_LOCAL, LOC_ARG, etc. based on SYMBOL_BASEREG_VALID.  But
 574    this approach provides just a small fraction of the expressiveness
 575    of a DWARF location, so it does less than we might want.  On the
 576    other hand, it may do more than we need; FRAME_LOCALS_ADDRESS,
 577    LOC_REGPARM_ADDR, and similar things seem to handle most of the
 578    cases which actually come up.  */
 579
 580 #if 0
 581 /* This currently fails because some symbols are not being initialized
 582    to zero on allocation, and no code is currently setting this value.  */
 583 #define SYMBOL_BASEREG_VALID(symbol) (symbol)->aux_value.basereg.regno_valid
 584 #else
 585 #define SYMBOL_BASEREG_VALID(symbol) 0
 586 #endif
 587
 588 \f
 589 /* A partial_symbol records the name, namespace, and address class of
 590    symbols whose types we have not parsed yet.  For functions, it also
 591    contains their memory address, so we can find them from a PC value.
 592    Each partial_symbol sits in a partial_symtab, all of which are chained
 593    on a  partial symtab list and which points to the corresponding
 594    normal symtab once the partial_symtab has been referenced.  */
 595
 596 struct partial_symbol
 597 {
 598
 599   /* The general symbol info required for all types of symbols. */
 600
 601   struct general_symbol_info ginfo;
 602
 603   /* Name space code.  */
 604
 605   enum namespace namespace;
 606
 607   /* Address class (for info_symbols) */
 608
 609   enum address_class class;
 610
 611 };
 612
 613 #define PSYMBOL_NAMESPACE(psymbol)      (psymbol)->namespace
 614 #define PSYMBOL_CLASS(psymbol)          (psymbol)->class
 615
 616 \f
 617 /* Source-file information.  This describes the relation between source files,
 618    ine numbers and addresses in the program text.  */
 619
 620 struct sourcevector
 621 {
 622   int length;                   /* Number of source files described */
 623   struct source *source[1];     /* Descriptions of the files */
 624 };
 625
 626 /* Each item represents a line-->pc (or the reverse) mapping.  This is
 627    somewhat more wasteful of space than one might wish, but since only
 628    the files which are actually debugged are read in to core, we don't
 629    waste much space.  */
 630
 631 struct linetable_entry
 632 {
 633   int line;
 634   CORE_ADDR pc;
 635 };
 636
 637 /* The order of entries in the linetable is significant.
 638
 639    It should generally be in ascending line number order.  Line table
 640    entries for a function at lines 10-40 should come before entries
 641    for a function at lines 50-70.
 642
 643    A for statement looks like this
 644
 645         10      0x100   - for the init/test part of a for stmt.
 646         20      0x200
 647         30      0x300
 648         10      0x400   - for the increment part of a for stmt.
 649
 650    FIXME: this description is incomplete.  coffread.c is said to get
 651    the linetable order wrong (would arrange_linenos from xcoffread.c
 652    work for normal COFF too?).  */
 653
 654 struct linetable
 655 {
 656   int nitems;
 657   struct linetable_entry item[1];
 658 };
 659
 660 /* All the information on one source file.  */
 661
 662 struct source
 663 {
 664   char *name;                   /* Name of file */
 665   struct linetable contents;
 666 };
 667
 668 /* How to relocate the symbols from each section in a symbol file.
 669    Each struct contains an array of offsets.
 670    The ordering and meaning of the offsets is file-type-dependent;
 671    typically it is indexed by section numbers or symbol types or
 672    something like that.
 673
 674    To give us flexibility in changing the internal representation
 675    of these offsets, the ANOFFSET macro must be used to insert and
 676    extract offset values in the struct.  */
 677
 678 struct section_offsets
 679   {
 680     CORE_ADDR offsets[1];               /* As many as needed. */
 681   };
 682
 683 #define ANOFFSET(secoff, whichone)      (secoff->offsets[whichone])
 684
 685 /* Each source file is represented by a struct symtab.
 686    These objects are chained through the `next' field.  */
 687
 688 struct symtab
 689   {
 690
 691     /* Chain of all existing symtabs.  */
 692
 693     struct symtab *next;
 694
 695     /* List of all symbol scope blocks for this symtab.  */
 696
 697     struct blockvector *blockvector;
 698
 699     /* Table mapping core addresses to line numbers for this file.
 700        Can be NULL if none.  */
 701
 702     struct linetable *linetable;
 703
 704     /* Section in objfile->section_offsets for the blockvector and
 705        the linetable.  */
 706
 707     int block_line_section;
 708
 709     /* If several symtabs share a blockvector, exactly one of them
 710        should be designed the primary, so that the blockvector
 711        is relocated exactly once by objfile_relocate.  */
 712
 713     int primary;
 714
 715     /* Name of this source file.  */
 716
 717     char *filename;
 718
 719     /* Directory in which it was compiled, or NULL if we don't know.  */
 720
 721     char *dirname;
 722
 723     /* This component says how to free the data we point to:
 724        free_contents => do a tree walk and free each object.
 725        free_nothing => do nothing; some other symtab will free
 726          the data this one uses.
 727       free_linetable => free just the linetable.  */
 728
 729     enum free_code
 730       {
 731         free_nothing, free_contents, free_linetable
 732         }
 733     free_code;
 734
 735     /* Pointer to one block of storage to be freed, if nonzero.  */
 736     /* This is IN ADDITION to the action indicated by free_code.  */
 737
 738     char *free_ptr;
 739
 740     /* Total number of lines found in source file.  */
 741
 742     int nlines;
 743
 744     /* line_charpos[N] is the position of the (N-1)th line of the
 745        source file.  "position" means something we can lseek() to; it
 746        is not guaranteed to be useful any other way.  */
 747
 748     int *line_charpos;
 749
 750     /* Language of this source file.  */
 751
 752     enum language language;
 753
 754     /* String of version information.  May be zero.  */
 755
 756     char *version;
 757
 758     /* Full name of file as found by searching the source path.
 759        NULL if not yet known.  */
 760
 761     char *fullname;
 762
 763     /* Object file from which this symbol information was read.  */
 764
 765     struct objfile *objfile;
 766
 767     /* Anything extra for this symtab.  This is for target machines
 768        with special debugging info of some sort (which cannot just
 769        be represented in a normal symtab).  */
 770
 771 #if defined (EXTRA_SYMTAB_INFO)
 772     EXTRA_SYMTAB_INFO
 773 #endif
 774
 775   };
 776
 777 #define BLOCKVECTOR(symtab)     (symtab)->blockvector
 778 #define LINETABLE(symtab)       (symtab)->linetable
 779
 780 \f
 781 /* Each source file that has not been fully read in is represented by
 782    a partial_symtab.  This contains the information on where in the
 783    executable the debugging symbols for a specific file are, and a
 784    list of names of global symbols which are located in this file.
 785    They are all chained on partial symtab lists.
 786
 787    Even after the source file has been read into a symtab, the
 788    partial_symtab remains around.  They are allocated on an obstack,
 789    psymbol_obstack.  FIXME, this is bad for dynamic linking or VxWorks-
 790    style execution of a bunch of .o's.  */
 791
 792 struct partial_symtab
 793 {
 794
 795   /* Chain of all existing partial symtabs.  */
 796
 797   struct partial_symtab *next;
 798
 799   /* Name of the source file which this partial_symtab defines */
 800
 801   char *filename;
 802
 803   /* Information about the object file from which symbols should be read.  */
 804
 805   struct objfile *objfile;
 806
 807   /* Set of relocation offsets to apply to each section.  */
 808
 809   struct section_offsets *section_offsets;
 810
 811   /* Range of text addresses covered by this file; texthigh is the
 812      beginning of the next section. */
 813
 814   CORE_ADDR textlow;
 815   CORE_ADDR texthigh;
 816
 817   /* Array of pointers to all of the partial_symtab's which this one
 818      depends on.  Since this array can only be set to previous or
 819      the current (?) psymtab, this dependency tree is guaranteed not
 820      to have any loops.  "depends on" means that symbols must be read
 821      for the dependencies before being read for this psymtab; this is
 822      for type references in stabs, where if foo.c includes foo.h, declarations
 823      in foo.h may use type numbers defined in foo.c.  For other debugging
 824      formats there may be no need to use dependencies.  */
 825
 826   struct partial_symtab **dependencies;
 827
 828   int number_of_dependencies;
 829
 830   /* Global symbol list.  This list will be sorted after readin to
 831      improve access.  Binary search will be the usual method of
 832      finding a symbol within it. globals_offset is an integer offset
 833      within global_psymbols[].  */
 834
 835   int globals_offset;
 836   int n_global_syms;
 837
 838   /* Static symbol list.  This list will *not* be sorted after readin;
 839      to find a symbol in it, exhaustive search must be used.  This is
 840      reasonable because searches through this list will eventually
 841      lead to either the read in of a files symbols for real (assumed
 842      to take a *lot* of time; check) or an error (and we don't care
 843      how long errors take).  This is an offset and size within
 844      static_psymbols[].  */
 845
 846   int statics_offset;
 847   int n_static_syms;
 848
 849   /* Pointer to symtab eventually allocated for this source file, 0 if
 850      !readin or if we haven't looked for the symtab after it was readin.  */
 851
 852   struct symtab *symtab;
 853
 854   /* Pointer to function which will read in the symtab corresponding to
 855      this psymtab.  */
 856
 857   void (*read_symtab) PARAMS ((struct partial_symtab *));
 858
 859   /* Information that lets read_symtab() locate the part of the symbol table
 860      that this psymtab corresponds to.  This information is private to the
 861      format-dependent symbol reading routines.  For further detail examine
 862      the various symbol reading modules.  Should really be (void *) but is
 863      (char *) as with other such gdb variables.  (FIXME) */
 864
 865   char *read_symtab_private;
 866
 867   /* Non-zero if the symtab corresponding to this psymtab has been readin */
 868
 869   unsigned char readin;
 870 };
 871
 872 /* A fast way to get from a psymtab to its symtab (after the first time).  */
 873 #define PSYMTAB_TO_SYMTAB(pst)  \
 874     ((pst) -> symtab != NULL ? (pst) -> symtab : psymtab_to_symtab (pst))
 875
 876 \f
 877 /* The virtual function table is now an array of structures which have the
 878    form { int16 offset, delta; void *pfn; }.
 879
 880    In normal virtual function tables, OFFSET is unused.
 881    DELTA is the amount which is added to the apparent object's base
 882    address in order to point to the actual object to which the
 883    virtual function should be applied.
 884    PFN is a pointer to the virtual function.
 885
 886    Note that this macro is g++ specific (FIXME). */
 887
 888 #define VTBL_FNADDR_OFFSET 2
 889
 890 /* Macro that yields non-zero value iff NAME is the prefix for C++ operator
 891    names.  If you leave out the parenthesis here you will lose!
 892    Currently 'o' 'p' CPLUS_MARKER is used for both the symbol in the
 893    symbol-file and the names in gdb's symbol table.
 894    Note that this macro is g++ specific (FIXME). */
 895
 896 #define OPNAME_PREFIX_P(NAME) \
 897   ((NAME)[0] == 'o' && (NAME)[1] == 'p' && (NAME)[2] == CPLUS_MARKER)
 898
 899 /* Macro that yields non-zero value iff NAME is the prefix for C++ vtbl
 900    names.  Note that this macro is g++ specific (FIXME).  */
 901
 902 #define VTBL_PREFIX_P(NAME) \
 903   ((NAME)[3] == CPLUS_MARKER && !strncmp ((NAME), "_vt", 3))
 904
 905 /* Macro that yields non-zero value iff NAME is the prefix for C++ destructor
 906    names.  Note that this macro is g++ specific (FIXME).  */
 907
 908 #define DESTRUCTOR_PREFIX_P(NAME) \
 909   ((NAME)[0] == '_' && (NAME)[1] == CPLUS_MARKER && (NAME)[2] == '_')
 910
 911 \f
 912 /* External variables and functions for the objects described above. */
 913
 914 /* This symtab variable specifies the current file for printing source lines */
 915
 916 extern struct symtab *current_source_symtab;
 917
 918 /* This is the next line to print for listing source lines.  */
 919
 920 extern int current_source_line;
 921
 922 /* See the comment in symfile.c about how current_objfile is used. */
 923
 924 extern struct objfile *current_objfile;
 925
 926 extern struct symtab *
 927 lookup_symtab PARAMS ((char *));
 928
 929 extern struct symbol *
 930 lookup_symbol PARAMS ((const char *, const struct block *,
 931                        const enum namespace, int *, struct symtab **));
 932
 933 extern struct symbol *
 934 lookup_block_symbol PARAMS ((const struct block *, const char *,
 935                              const enum namespace));
 936
 937 extern struct type *
 938 lookup_struct PARAMS ((char *, struct block *));
 939
 940 extern struct type *
 941 lookup_union PARAMS ((char *, struct block *));
 942
 943 extern struct type *
 944 lookup_enum PARAMS ((char *, struct block *));
 945
 946 extern struct symbol *
 947 block_function PARAMS ((struct block *));
 948
 949 extern struct symbol *
 950 find_pc_function PARAMS ((CORE_ADDR));
 951
 952 extern int find_pc_partial_function
 953   PARAMS ((CORE_ADDR, char **, CORE_ADDR *, CORE_ADDR *));
 954
 955 extern void
 956 clear_pc_function_cache PARAMS ((void));
 957
 958 extern struct partial_symtab *
 959 lookup_partial_symtab PARAMS ((char *));
 960
 961 extern struct partial_symtab *
 962 find_pc_psymtab PARAMS ((CORE_ADDR));
 963
 964 extern struct symtab *
 965 find_pc_symtab PARAMS ((CORE_ADDR));
 966
 967 extern struct partial_symbol *
 968 find_pc_psymbol PARAMS ((struct partial_symtab *, CORE_ADDR));
 969
 970 extern int
 971 find_pc_line_pc_range PARAMS ((CORE_ADDR, CORE_ADDR *, CORE_ADDR *));
 972
 973 extern int
 974 contained_in PARAMS ((struct block *, struct block *));
 975
 976 extern void
 977 reread_symbols PARAMS ((void));
 978
 979 /* Functions for dealing with the minimal symbol table, really a misc
 980    address<->symbol mapping for things we don't have debug symbols for.  */
 981
 982 extern void
 983 prim_record_minimal_symbol PARAMS ((const char *, CORE_ADDR,
 984                                     enum minimal_symbol_type));
 985
 986 extern void
 987 prim_record_minimal_symbol_and_info PARAMS ((const char *, CORE_ADDR,
 988                                              enum minimal_symbol_type,
 989                                              char *info, int section));
 990
 991 extern struct minimal_symbol *
 992 lookup_minimal_symbol PARAMS ((const char *, struct objfile *));
 993
 994 extern struct minimal_symbol *
 995 lookup_minimal_symbol_by_pc PARAMS ((CORE_ADDR));
 996
 997 extern void
 998 init_minimal_symbol_collection PARAMS ((void));
 999
1000 extern void
1001 discard_minimal_symbols PARAMS ((int));
1002
1003 extern void
1004 install_minimal_symbols PARAMS ((struct objfile *));
1005
1006 struct symtab_and_line
1007 {
1008   struct symtab *symtab;
1009
1010   /* Line number.  Line numbers start at 1 and proceed through symtab->nlines.
1011      0 is never a valid line number; it is used to indicate that line number
1012      information is not available.  */
1013   int line;
1014
1015   CORE_ADDR pc;
1016   CORE_ADDR end;
1017 };
1018
1019 struct symtabs_and_lines
1020 {
1021   struct symtab_and_line *sals;
1022   int nelts;
1023 };
1024
1025 /* Given a pc value, return line number it is in.  Second arg nonzero means
1026    if pc is on the boundary use the previous statement's line number.  */
1027
1028 extern struct symtab_and_line
1029 find_pc_line PARAMS ((CORE_ADDR, int));
1030
1031 /* Given a symtab and line number, return the pc there.  */
1032
1033 extern CORE_ADDR
1034 find_line_pc PARAMS ((struct symtab *, int));
1035
1036 extern int
1037 find_line_pc_range PARAMS ((struct symtab *, int, CORE_ADDR *, CORE_ADDR *));
1038
1039 extern void
1040 resolve_sal_pc PARAMS ((struct symtab_and_line *));
1041
1042 /* Given a string, return the line specified by it.  For commands like "list"
1043    and "breakpoint".  */
1044
1045 extern struct symtabs_and_lines
1046 decode_line_spec PARAMS ((char *, int));
1047
1048 extern struct symtabs_and_lines
1049 decode_line_spec_1 PARAMS ((char *, int));
1050
1051 extern struct symtabs_and_lines
1052 decode_line_1 PARAMS ((char **, int, struct symtab *, int, char ***));
1053
1054 /* Symmisc.c */
1055
1056 #if MAINTENANCE_CMDS
1057
1058 void
1059 maintenance_print_symbols PARAMS ((char *, int));
1060
1061 void
1062 maintenance_print_psymbols PARAMS ((char *, int));
1063
1064 void
1065 maintenance_print_msymbols PARAMS ((char *, int));
1066
1067 void
1068 maintenance_print_objfiles PARAMS ((char *, int));
1069
1070 #endif
1071
1072 extern void
1073 free_symtab PARAMS ((struct symtab *));
1074
1075 /* Symbol-reading stuff in symfile.c and solib.c.  */
1076
1077 extern struct symtab *
1078 psymtab_to_symtab PARAMS ((struct partial_symtab *));
1079
1080 extern void
1081 clear_solib PARAMS ((void));
1082
1083 extern struct objfile *
1084 symbol_file_add PARAMS ((char *, int, CORE_ADDR, int, int, int));
1085
1086 /* source.c */
1087
1088 extern int frame_file_full_name; /* in stack.c */
1089
1090 extern int
1091 identify_source_line PARAMS ((struct symtab *, int, int, CORE_ADDR));
1092
1093 extern void
1094 print_source_lines PARAMS ((struct symtab *, int, int, int));
1095
1096 extern void
1097 forget_cached_source_info PARAMS ((void));
1098
1099 extern void
1100 select_source_symtab PARAMS ((struct symtab *));
1101
1102 extern char **make_symbol_completion_list PARAMS ((char *, char *));
1103
1104 /* symtab.c */
1105
1106 extern struct partial_symtab *
1107 find_main_psymtab PARAMS ((void));
1108
1109 /* blockframe.c */
1110
1111 extern struct blockvector *
1112 blockvector_for_pc PARAMS ((CORE_ADDR, int *));
1113
1114 /* symfile.c */
1115
1116 extern void
1117 clear_symtab_users PARAMS ((void));
1118
1119 extern enum language
1120 deduce_language_from_filename PARAMS ((char *));
1121
1122 #endif /* !defined(SYMTAB_H) */