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