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     } type;
 292
 293 };
 294
 295 #define MSYMBOL_INFO(msymbol)           (msymbol)->info
 296 #define MSYMBOL_TYPE(msymbol)           (msymbol)->type
 297
 298 \f
 299 /* All of the name-scope contours of the program
 300    are represented by `struct block' objects.
 301    All of these objects are pointed to by the blockvector.
 302
 303    Each block represents one name scope.
 304    Each lexical context has its own block.
 305
 306    The blockvector begins with some special blocks.
 307    The GLOBAL_BLOCK contains all the symbols defined in this compilation
 308    whose scope is the entire program linked together.
 309    The STATIC_BLOCK contains all the symbols whose scope is the
 310    entire compilation excluding other separate compilations.
 311    Blocks starting with the FIRST_LOCAL_BLOCK are not special.
 312
 313    Each block records a range of core addresses for the code that
 314    is in the scope of the block.  The STATIC_BLOCK and GLOBAL_BLOCK
 315    give, for the range of code, the entire range of code produced
 316    by the compilation that the symbol segment belongs to.
 317
 318    The blocks appear in the blockvector
 319    in order of increasing starting-address,
 320    and, within that, in order of decreasing ending-address.
 321
 322    This implies that within the body of one function
 323    the blocks appear in the order of a depth-first tree walk.  */
 324
 325 struct blockvector
 326 {
 327   /* Number of blocks in the list.  */
 328   int nblocks;
 329   /* The blocks themselves.  */
 330   struct block *block[1];
 331 };
 332
 333 #define BLOCKVECTOR_NBLOCKS(blocklist) (blocklist)->nblocks
 334 #define BLOCKVECTOR_BLOCK(blocklist,n) (blocklist)->block[n]
 335
 336 /* Special block numbers */
 337
 338 #define GLOBAL_BLOCK            0
 339 #define STATIC_BLOCK            1
 340 #define FIRST_LOCAL_BLOCK       2
 341
 342 struct block
 343 {
 344
 345   /* Addresses in the executable code that are in this block.  */
 346
 347   CORE_ADDR startaddr;
 348   CORE_ADDR endaddr;
 349
 350   /* The symbol that names this block, if the block is the body of a
 351      function; otherwise, zero.  */
 352
 353   struct symbol *function;
 354
 355   /* The `struct block' for the containing block, or 0 if none.
 356
 357      The superblock of a top-level local block (i.e. a function in the
 358      case of C) is the STATIC_BLOCK.  The superblock of the
 359      STATIC_BLOCK is the GLOBAL_BLOCK.  */
 360
 361   struct block *superblock;
 362
 363   /* Version of GCC used to compile the function corresponding
 364      to this block, or 0 if not compiled with GCC.  When possible,
 365      GCC should be compatible with the native compiler, or if that
 366      is not feasible, the differences should be fixed during symbol
 367      reading.  As of 16 Apr 93, this flag is never used to distinguish
 368      between gcc2 and the native compiler.
 369
 370      If there is no function corresponding to this block, this meaning
 371      of this flag is undefined.  */
 372
 373   unsigned char gcc_compile_flag;
 374
 375   /* Number of local symbols.  */
 376
 377   int nsyms;
 378
 379   /* The symbols.  If some of them are arguments, then they must be
 380      in the order in which we would like to print them.  */
 381
 382   struct symbol *sym[1];
 383 };
 384
 385 #define BLOCK_START(bl)         (bl)->startaddr
 386 #define BLOCK_END(bl)           (bl)->endaddr
 387 #define BLOCK_NSYMS(bl)         (bl)->nsyms
 388 #define BLOCK_SYM(bl, n)        (bl)->sym[n]
 389 #define BLOCK_FUNCTION(bl)      (bl)->function
 390 #define BLOCK_SUPERBLOCK(bl)    (bl)->superblock
 391 #define BLOCK_GCC_COMPILED(bl)  (bl)->gcc_compile_flag
 392
 393 /* Nonzero if symbols of block BL should be sorted alphabetically.
 394    Don't sort a block which corresponds to a function.  If we did the
 395    sorting would have to preserve the order of the symbols for the
 396    arguments.  */
 397
 398 #define BLOCK_SHOULD_SORT(bl) ((bl)->nsyms >= 40 && BLOCK_FUNCTION (bl) == NULL)
 399
 400 \f
 401 /* Represent one symbol name; a variable, constant, function or typedef.  */
 402
 403 /* Different name spaces for symbols.  Looking up a symbol specifies a
 404    namespace and ignores symbol definitions in other name spaces. */
 405
 406 enum namespace
 407 {
 408   /* UNDEF_NAMESPACE is used when a namespace has not been discovered or
 409      none of the following apply.  This usually indicates an error either
 410      in the symbol information or in gdb's handling of symbols. */
 411
 412   UNDEF_NAMESPACE,
 413
 414   /* VAR_NAMESPACE is the usual namespace.  In C, this contains variables,
 415      function names, typedef names and enum type values. */
 416
 417   VAR_NAMESPACE,
 418
 419   /* STRUCT_NAMESPACE is used in C to hold struct, union and enum type names.
 420      Thus, if `struct foo' is used in a C program, it produces a symbol named
 421      `foo' in the STRUCT_NAMESPACE. */
 422
 423   STRUCT_NAMESPACE,
 424
 425   /* LABEL_NAMESPACE may be used for names of labels (for gotos);
 426      currently it is not used and labels are not recorded at all.  */
 427
 428   LABEL_NAMESPACE
 429 };
 430
 431 /* An address-class says where to find the value of a symbol.  */
 432
 433 enum address_class
 434 {
 435   /* Not used; catches errors */
 436
 437   LOC_UNDEF,
 438
 439   /* Value is constant int SYMBOL_VALUE, host byteorder */
 440
 441   LOC_CONST,
 442
 443   /* Value is at fixed address SYMBOL_VALUE_ADDRESS */
 444
 445   LOC_STATIC,
 446
 447   /* Value is in register.  SYMBOL_VALUE is the register number.  */
 448
 449   LOC_REGISTER,
 450
 451   /* It's an argument; the value is at SYMBOL_VALUE offset in arglist.  */
 452
 453   LOC_ARG,
 454
 455   /* Value address is at SYMBOL_VALUE offset in arglist.  */
 456
 457   LOC_REF_ARG,
 458
 459   /* Value is in register number SYMBOL_VALUE.  Just like LOC_REGISTER
 460      except this is an argument.  Probably the cleaner way to handle
 461      this would be to separate address_class (which would include
 462      separate ARG and LOCAL to deal with FRAME_ARGS_ADDRESS versus
 463      FRAME_LOCALS_ADDRESS), and an is_argument flag.
 464
 465      For some symbol formats (stabs, for some compilers at least),
 466      the compiler generates two symbols, an argument and a register.
 467      In some cases we combine them to a single LOC_REGPARM in symbol
 468      reading, but currently not for all cases (e.g. it's passed on the
 469      stack and then loaded into a register).  */
 470
 471   LOC_REGPARM,
 472
 473   /* Value is in specified register.  Just like LOC_REGPARM except the
 474      register holds the address of the argument instead of the argument
 475      itself. This is currently used for the passing of structs and unions
 476      on sparc and hppa.  It is also used for call by reference where the
 477      address is in a register, at least by mipsread.c.  */
 478
 479   LOC_REGPARM_ADDR,
 480
 481   /* Value is a local variable at SYMBOL_VALUE offset in stack frame.  */
 482
 483   LOC_LOCAL,
 484
 485   /* Value not used; definition in SYMBOL_TYPE.  Symbols in the namespace
 486      STRUCT_NAMESPACE all have this class.  */
 487
 488   LOC_TYPEDEF,
 489
 490   /* Value is address SYMBOL_VALUE_ADDRESS in the code */
 491
 492   LOC_LABEL,
 493
 494   /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
 495      In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
 496      of the block.  Function names have this class. */
 497
 498   LOC_BLOCK,
 499
 500   /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
 501      target byte order.  */
 502
 503   LOC_CONST_BYTES,
 504
 505   /* Value is arg at SYMBOL_VALUE offset in stack frame. Differs from
 506      LOC_LOCAL in that symbol is an argument; differs from LOC_ARG in
 507      that we find it in the frame (FRAME_LOCALS_ADDRESS), not in the
 508      arglist (FRAME_ARGS_ADDRESS).  Added for i960, which passes args
 509      in regs then copies to frame.  */
 510
 511   LOC_LOCAL_ARG,
 512
 513   /* The variable does not actually exist in the program.
 514      The value is ignored.  */
 515
 516   LOC_OPTIMIZED_OUT
 517 };
 518
 519 struct symbol
 520 {
 521
 522   /* The general symbol info required for all types of symbols. */
 523
 524   struct general_symbol_info ginfo;
 525
 526   /* Name space code.  */
 527
 528   enum namespace namespace;
 529
 530   /* Address class */
 531
 532   enum address_class class;
 533
 534   /* Data type of value */
 535
 536   struct type *type;
 537
 538   /* Line number of definition.  FIXME:  Should we really make the assumption
 539      that nobody will try to debug files longer than 64K lines?  What about
 540      machine generated programs? */
 541
 542   unsigned short line;
 543
 544   /* Some symbols require an additional value to be recorded on a per-
 545      symbol basis.  Stash those values here. */
 546
 547   union
 548     {
 549       /* for OP_BASEREG in DWARF location specs */
 550       struct
 551         {
 552           short regno_valid;    /* 0 == regno invalid; !0 == regno valid */
 553           short regno;          /* base register number {0, 1, 2, ...} */
 554         } basereg;
 555     }
 556   aux_value;
 557
 558 };
 559
 560 #define SYMBOL_NAMESPACE(symbol)        (symbol)->namespace
 561 #define SYMBOL_CLASS(symbol)            (symbol)->class
 562 #define SYMBOL_TYPE(symbol)             (symbol)->type
 563 #define SYMBOL_LINE(symbol)             (symbol)->line
 564 #define SYMBOL_BASEREG(symbol)          (symbol)->aux_value.basereg.regno
 565
 566 /* This currently fails because some symbols are not being initialized
 567    to zero on allocation, and no code is currently setting this value.
 568    Basereg handling will probably change significantly in the next release.
 569    FIXME -fnf */
 570
 571 #if 0
 572 #define SYMBOL_BASEREG_VALID(symbol) (symbol)->aux_value.basereg.regno_valid
 573 #else
 574 #define SYMBOL_BASEREG_VALID(symbol) 0
 575 #endif
 576
 577 \f
 578 /* A partial_symbol records the name, namespace, and address class of
 579    symbols whose types we have not parsed yet.  For functions, it also
 580    contains their memory address, so we can find them from a PC value.
 581    Each partial_symbol sits in a partial_symtab, all of which are chained
 582    on a  partial symtab list and which points to the corresponding
 583    normal symtab once the partial_symtab has been referenced.  */
 584
 585 struct partial_symbol
 586 {
 587
 588   /* The general symbol info required for all types of symbols. */
 589
 590   struct general_symbol_info ginfo;
 591
 592   /* Name space code.  */
 593
 594   enum namespace namespace;
 595
 596   /* Address class (for info_symbols) */
 597
 598   enum address_class class;
 599
 600 };
 601
 602 #define PSYMBOL_NAMESPACE(psymbol)      (psymbol)->namespace
 603 #define PSYMBOL_CLASS(psymbol)          (psymbol)->class
 604
 605 \f
 606 /* Source-file information.  This describes the relation between source files,
 607    ine numbers and addresses in the program text.  */
 608
 609 struct sourcevector
 610 {
 611   int length;                   /* Number of source files described */
 612   struct source *source[1];     /* Descriptions of the files */
 613 };
 614
 615 /* Each item represents a line-->pc (or the reverse) mapping.  This is
 616    somewhat more wasteful of space than one might wish, but since only
 617    the files which are actually debugged are read in to core, we don't
 618    waste much space.  */
 619
 620 struct linetable_entry
 621 {
 622   int line;
 623   CORE_ADDR pc;
 624 };
 625
 626 /* The order of entries in the linetable is significant.
 627
 628    It should generally be in ascending line number order.  Line table
 629    entries for a function at lines 10-40 should come before entries
 630    for a function at lines 50-70.
 631
 632    A for statement looks like this
 633
 634         10      0x100   - for the init/test part of a for stmt.
 635         20      0x200
 636         30      0x300
 637         10      0x400   - for the increment part of a for stmt.
 638
 639    FIXME: this description is incomplete.  coffread.c is said to get
 640    the linetable order wrong (would arrange_linenos from xcoffread.c
 641    work for normal COFF too?).  */
 642
 643 struct linetable
 644 {
 645   int nitems;
 646   struct linetable_entry item[1];
 647 };
 648
 649 /* All the information on one source file.  */
 650
 651 struct source
 652 {
 653   char *name;                   /* Name of file */
 654   struct linetable contents;
 655 };
 656
 657 /* How to relocate the symbols from each section in a symbol file.
 658    Each struct contains an array of offsets.
 659    The ordering and meaning of the offsets is file-type-dependent;
 660    typically it is indexed by section numbers or symbol types or
 661    something like that.
 662
 663    To give us flexibility in changing the internal representation
 664    of these offsets, the ANOFFSET macro must be used to insert and
 665    extract offset values in the struct.  */
 666
 667 struct section_offsets
 668   {
 669     CORE_ADDR offsets[1];               /* As many as needed. */
 670   };
 671
 672 #define ANOFFSET(secoff, whichone)      (secoff->offsets[whichone])
 673
 674 /* Each source file is represented by a struct symtab.
 675    These objects are chained through the `next' field.  */
 676
 677 struct symtab
 678   {
 679
 680     /* Chain of all existing symtabs.  */
 681
 682     struct symtab *next;
 683
 684     /* List of all symbol scope blocks for this symtab.  */
 685
 686     struct blockvector *blockvector;
 687
 688     /* Table mapping core addresses to line numbers for this file.
 689        Can be NULL if none.  */
 690
 691     struct linetable *linetable;
 692
 693     /* Section in objfile->section_offsets for the blockvector and
 694        the linetable.  */
 695
 696     int block_line_section;
 697
 698     /* If several symtabs share a blockvector, exactly one of them
 699        should be designed the primary, so that the blockvector
 700        is relocated exactly once by objfile_relocate.  */
 701
 702     int primary;
 703
 704     /* Name of this source file.  */
 705
 706     char *filename;
 707
 708     /* Directory in which it was compiled, or NULL if we don't know.  */
 709
 710     char *dirname;
 711
 712     /* This component says how to free the data we point to:
 713        free_contents => do a tree walk and free each object.
 714        free_nothing => do nothing; some other symtab will free
 715          the data this one uses.
 716       free_linetable => free just the linetable.  */
 717
 718     enum free_code
 719       {
 720         free_nothing, free_contents, free_linetable
 721         }
 722     free_code;
 723
 724     /* Pointer to one block of storage to be freed, if nonzero.  */
 725     /* This is IN ADDITION to the action indicated by free_code.  */
 726
 727     char *free_ptr;
 728
 729     /* Total number of lines found in source file.  */
 730
 731     int nlines;
 732
 733     /* line_charpos[N] is the position of the (N-1)th line of the
 734        source file.  "position" means something we can lseek() to; it
 735        is not guaranteed to be useful any other way.  */
 736
 737     int *line_charpos;
 738
 739     /* Language of this source file.  */
 740
 741     enum language language;
 742
 743     /* String of version information.  May be zero.  */
 744
 745     char *version;
 746
 747     /* Full name of file as found by searching the source path.
 748        NULL if not yet known.  */
 749
 750     char *fullname;
 751
 752     /* Object file from which this symbol information was read.  */
 753
 754     struct objfile *objfile;
 755
 756     /* Anything extra for this symtab.  This is for target machines
 757        with special debugging info of some sort (which cannot just
 758        be represented in a normal symtab).  */
 759
 760 #if defined (EXTRA_SYMTAB_INFO)
 761     EXTRA_SYMTAB_INFO
 762 #endif
 763
 764   };
 765
 766 #define BLOCKVECTOR(symtab)     (symtab)->blockvector
 767 #define LINETABLE(symtab)       (symtab)->linetable
 768
 769 \f
 770 /* Each source file that has not been fully read in is represented by
 771    a partial_symtab.  This contains the information on where in the
 772    executable the debugging symbols for a specific file are, and a
 773    list of names of global symbols which are located in this file.
 774    They are all chained on partial symtab lists.
 775
 776    Even after the source file has been read into a symtab, the
 777    partial_symtab remains around.  They are allocated on an obstack,
 778    psymbol_obstack.  FIXME, this is bad for dynamic linking or VxWorks-
 779    style execution of a bunch of .o's.  */
 780
 781 struct partial_symtab
 782 {
 783
 784   /* Chain of all existing partial symtabs.  */
 785
 786   struct partial_symtab *next;
 787
 788   /* Name of the source file which this partial_symtab defines */
 789
 790   char *filename;
 791
 792   /* Information about the object file from which symbols should be read.  */
 793
 794   struct objfile *objfile;
 795
 796   /* Set of relocation offsets to apply to each section.  */
 797
 798   struct section_offsets *section_offsets;
 799
 800   /* Range of text addresses covered by this file; texthigh is the
 801      beginning of the next section. */
 802
 803   CORE_ADDR textlow;
 804   CORE_ADDR texthigh;
 805
 806   /* Array of pointers to all of the partial_symtab's which this one
 807      depends on.  Since this array can only be set to previous or
 808      the current (?) psymtab, this dependency tree is guaranteed not
 809      to have any loops.  "depends on" means that symbols must be read
 810      for the dependencies before being read for this psymtab; this is
 811      for type references in stabs, where if foo.c includes foo.h, declarations
 812      in foo.h may use type numbers defined in foo.c.  For other debugging
 813      formats there may be no need to use dependencies.  */
 814
 815   struct partial_symtab **dependencies;
 816
 817   int number_of_dependencies;
 818
 819   /* Global symbol list.  This list will be sorted after readin to
 820      improve access.  Binary search will be the usual method of
 821      finding a symbol within it. globals_offset is an integer offset
 822      within global_psymbols[].  */
 823
 824   int globals_offset;
 825   int n_global_syms;
 826
 827   /* Static symbol list.  This list will *not* be sorted after readin;
 828      to find a symbol in it, exhaustive search must be used.  This is
 829      reasonable because searches through this list will eventually
 830      lead to either the read in of a files symbols for real (assumed
 831      to take a *lot* of time; check) or an error (and we don't care
 832      how long errors take).  This is an offset and size within
 833      static_psymbols[].  */
 834
 835   int statics_offset;
 836   int n_static_syms;
 837
 838   /* Pointer to symtab eventually allocated for this source file, 0 if
 839      !readin or if we haven't looked for the symtab after it was readin.  */
 840
 841   struct symtab *symtab;
 842
 843   /* Pointer to function which will read in the symtab corresponding to
 844      this psymtab.  */
 845
 846   void (*read_symtab) PARAMS ((struct partial_symtab *));
 847
 848   /* Information that lets read_symtab() locate the part of the symbol table
 849      that this psymtab corresponds to.  This information is private to the
 850      format-dependent symbol reading routines.  For further detail examine
 851      the various symbol reading modules.  Should really be (void *) but is
 852      (char *) as with other such gdb variables.  (FIXME) */
 853
 854   char *read_symtab_private;
 855
 856   /* Non-zero if the symtab corresponding to this psymtab has been readin */
 857
 858   unsigned char readin;
 859 };
 860
 861 /* A fast way to get from a psymtab to its symtab (after the first time).  */
 862 #define PSYMTAB_TO_SYMTAB(pst)  \
 863     ((pst) -> symtab != NULL ? (pst) -> symtab : psymtab_to_symtab (pst))
 864
 865 \f
 866 /* The virtual function table is now an array of structures which have the
 867    form { int16 offset, delta; void *pfn; }.
 868
 869    In normal virtual function tables, OFFSET is unused.
 870    DELTA is the amount which is added to the apparent object's base
 871    address in order to point to the actual object to which the
 872    virtual function should be applied.
 873    PFN is a pointer to the virtual function.
 874
 875    Note that this macro is g++ specific (FIXME). */
 876
 877 #define VTBL_FNADDR_OFFSET 2
 878
 879 /* Macro that yields non-zero value iff NAME is the prefix for C++ operator
 880    names.  If you leave out the parenthesis here you will lose!
 881    Currently 'o' 'p' CPLUS_MARKER is used for both the symbol in the
 882    symbol-file and the names in gdb's symbol table.
 883    Note that this macro is g++ specific (FIXME). */
 884
 885 #define OPNAME_PREFIX_P(NAME) \
 886   ((NAME)[0] == 'o' && (NAME)[1] == 'p' && (NAME)[2] == CPLUS_MARKER)
 887
 888 /* Macro that yields non-zero value iff NAME is the prefix for C++ vtbl
 889    names.  Note that this macro is g++ specific (FIXME).  */
 890
 891 #define VTBL_PREFIX_P(NAME) \
 892   ((NAME)[3] == CPLUS_MARKER && !strncmp ((NAME), "_vt", 3))
 893
 894 /* Macro that yields non-zero value iff NAME is the prefix for C++ destructor
 895    names.  Note that this macro is g++ specific (FIXME).  */
 896
 897 #define DESTRUCTOR_PREFIX_P(NAME) \
 898   ((NAME)[0] == '_' && (NAME)[1] == CPLUS_MARKER && (NAME)[2] == '_')
 899
 900 \f
 901 /* External variables and functions for the objects described above. */
 902
 903 /* This symtab variable specifies the current file for printing source lines */
 904
 905 extern struct symtab *current_source_symtab;
 906
 907 /* This is the next line to print for listing source lines.  */
 908
 909 extern int current_source_line;
 910
 911 /* See the comment in symfile.c about how current_objfile is used. */
 912
 913 extern struct objfile *current_objfile;
 914
 915 extern struct symtab *
 916 lookup_symtab PARAMS ((char *));
 917
 918 extern struct symbol *
 919 lookup_symbol PARAMS ((const char *, const struct block *,
 920                        const enum namespace, int *, struct symtab **));
 921
 922 extern struct symbol *
 923 lookup_block_symbol PARAMS ((const struct block *, const char *,
 924                              const enum namespace));
 925
 926 extern struct type *
 927 lookup_struct PARAMS ((char *, struct block *));
 928
 929 extern struct type *
 930 lookup_union PARAMS ((char *, struct block *));
 931
 932 extern struct type *
 933 lookup_enum PARAMS ((char *, struct block *));
 934
 935 extern struct symbol *
 936 block_function PARAMS ((struct block *));
 937
 938 extern struct symbol *
 939 find_pc_function PARAMS ((CORE_ADDR));
 940
 941 extern int find_pc_partial_function
 942   PARAMS ((CORE_ADDR, char **, CORE_ADDR *, CORE_ADDR *));
 943
 944 extern void
 945 clear_pc_function_cache PARAMS ((void));
 946
 947 extern struct partial_symtab *
 948 lookup_partial_symtab PARAMS ((char *));
 949
 950 extern struct partial_symtab *
 951 find_pc_psymtab PARAMS ((CORE_ADDR));
 952
 953 extern struct symtab *
 954 find_pc_symtab PARAMS ((CORE_ADDR));
 955
 956 extern struct partial_symbol *
 957 find_pc_psymbol PARAMS ((struct partial_symtab *, CORE_ADDR));
 958
 959 extern int
 960 find_pc_line_pc_range PARAMS ((CORE_ADDR, CORE_ADDR *, CORE_ADDR *));
 961
 962 extern int
 963 contained_in PARAMS ((struct block *, struct block *));
 964
 965 extern void
 966 reread_symbols PARAMS ((void));
 967
 968 /* Functions for dealing with the minimal symbol table, really a misc
 969    address<->symbol mapping for things we don't have debug symbols for.  */
 970
 971 extern void
 972 prim_record_minimal_symbol PARAMS ((const char *, CORE_ADDR,
 973                                     enum minimal_symbol_type));
 974
 975 extern void
 976 prim_record_minimal_symbol_and_info PARAMS ((const char *, CORE_ADDR,
 977                                              enum minimal_symbol_type,
 978                                              char *info, int section));
 979
 980 extern struct minimal_symbol *
 981 lookup_minimal_symbol PARAMS ((const char *, struct objfile *));
 982
 983 extern struct minimal_symbol *
 984 lookup_minimal_symbol_by_pc PARAMS ((CORE_ADDR));
 985
 986 extern void
 987 init_minimal_symbol_collection PARAMS ((void));
 988
 989 extern void
 990 discard_minimal_symbols PARAMS ((int));
 991
 992 extern void
 993 install_minimal_symbols PARAMS ((struct objfile *));
 994
 995 struct symtab_and_line
 996 {
 997   struct symtab *symtab;
 998
 999   /* Line number.  Line numbers start at 1 and proceed through symtab->nlines.
1000      0 is never a valid line number; it is used to indicate that line number
1001      information is not available.  */
1002   int line;
1003
1004   CORE_ADDR pc;
1005   CORE_ADDR end;
1006 };
1007
1008 struct symtabs_and_lines
1009 {
1010   struct symtab_and_line *sals;
1011   int nelts;
1012 };
1013
1014 /* Given a pc value, return line number it is in.  Second arg nonzero means
1015    if pc is on the boundary use the previous statement's line number.  */
1016
1017 extern struct symtab_and_line
1018 find_pc_line PARAMS ((CORE_ADDR, int));
1019
1020 /* Given a symtab and line number, return the pc there.  */
1021
1022 extern CORE_ADDR
1023 find_line_pc PARAMS ((struct symtab *, int));
1024
1025 extern int
1026 find_line_pc_range PARAMS ((struct symtab *, int, CORE_ADDR *, CORE_ADDR *));
1027
1028 extern void
1029 resolve_sal_pc PARAMS ((struct symtab_and_line *));
1030
1031 /* Given a string, return the line specified by it.  For commands like "list"
1032    and "breakpoint".  */
1033
1034 extern struct symtabs_and_lines
1035 decode_line_spec PARAMS ((char *, int));
1036
1037 extern struct symtabs_and_lines
1038 decode_line_spec_1 PARAMS ((char *, int));
1039
1040 extern struct symtabs_and_lines
1041 decode_line_1 PARAMS ((char **, int, struct symtab *, int, char ***));
1042
1043 /* Symmisc.c */
1044
1045 #if MAINTENANCE_CMDS
1046
1047 void
1048 maintenance_print_symbols PARAMS ((char *, int));
1049
1050 void
1051 maintenance_print_psymbols PARAMS ((char *, int));
1052
1053 void
1054 maintenance_print_msymbols PARAMS ((char *, int));
1055
1056 void
1057 maintenance_print_objfiles PARAMS ((char *, int));
1058
1059 #endif
1060
1061 extern void
1062 free_symtab PARAMS ((struct symtab *));
1063
1064 /* Symbol-reading stuff in symfile.c and solib.c.  */
1065
1066 extern struct symtab *
1067 psymtab_to_symtab PARAMS ((struct partial_symtab *));
1068
1069 extern void
1070 clear_solib PARAMS ((void));
1071
1072 extern struct objfile *
1073 symbol_file_add PARAMS ((char *, int, CORE_ADDR, int, int, int));
1074
1075 /* source.c */
1076
1077 extern int frame_file_full_name; /* in stack.c */
1078
1079 extern int
1080 identify_source_line PARAMS ((struct symtab *, int, int, CORE_ADDR));
1081
1082 extern void
1083 print_source_lines PARAMS ((struct symtab *, int, int, int));
1084
1085 extern void
1086 forget_cached_source_info PARAMS ((void));
1087
1088 extern void
1089 select_source_symtab PARAMS ((struct symtab *));
1090
1091 extern char **make_symbol_completion_list PARAMS ((char *, char *));
1092
1093 /* symtab.c */
1094
1095 extern void
1096 clear_symtab_users_once PARAMS ((void));
1097
1098 extern struct partial_symtab *
1099 find_main_psymtab PARAMS ((void));
1100
1101 /* blockframe.c */
1102
1103 extern struct blockvector *
1104 blockvector_for_pc PARAMS ((CORE_ADDR, int *));
1105
1106 /* symfile.c */
1107
1108 extern enum language
1109 deduce_language_from_filename PARAMS ((char *));
1110
1111 #endif /* !defined(SYMTAB_H) */