gdb/symtab.h

   1 /* Symbol table definitions for GDB.
   2    Copyright 1986, 89, 91, 92, 93, 94, 95, 96, 1998
   3              Free Software Foundation, Inc.
   4
   5 This file is part of GDB.
   6
   7 This program is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 2 of the License, or
  10 (at your option) any later version.
  11
  12 This program is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with this program; if not, write to the Free Software
  19 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  20
  21 #if !defined (SYMTAB_H)
  22 #define SYMTAB_H 1
  23
  24 /* Some definitions and declarations to go with use of obstacks.  */
  25
  26 #include "obstack.h"
  27 #define obstack_chunk_alloc xmalloc
  28 #define obstack_chunk_free free
  29 #include "bcache.h"
  30
  31 #include "gnu-regex.h"
  32
  33 /* Don't do this; it means that if some .o's are compiled with GNU C
  34    and some are not (easy to do accidentally the way we configure
  35    things; also it is a pain to have to "make clean" every time you
  36    want to switch compilers), then GDB dies a horrible death.  */
  37 /* GNU C supports enums that are bitfields.  Some compilers don't. */
  38 #if 0 && defined(__GNUC__) && !defined(BYTE_BITFIELD)
  39 #define BYTE_BITFIELD   :8;
  40 #else
  41 #define BYTE_BITFIELD   /*nothing*/
  42 #endif
  43
  44 /* Define a structure for the information that is common to all symbol types,
  45    including minimal symbols, partial symbols, and full symbols.  In a
  46    multilanguage environment, some language specific information may need to
  47    be recorded along with each symbol.
  48
  49    These fields are ordered to encourage good packing, since we frequently
  50    have tens or hundreds of thousands of these.  */
  51
  52 struct general_symbol_info
  53 {
  54   /* Name of the symbol.  This is a required field.  Storage for the name is
  55      allocated on the psymbol_obstack or symbol_obstack for the associated
  56      objfile. */
  57
  58   char *name;
  59
  60   /* Value of the symbol.  Which member of this union to use, and what
  61      it means, depends on what kind of symbol this is and its
  62      SYMBOL_CLASS.  See comments there for more details.  All of these
  63      are in host byte order (though what they point to might be in
  64      target byte order, e.g. LOC_CONST_BYTES).  */
  65
  66   union
  67     {
  68       /* The fact that this is a long not a LONGEST mainly limits the
  69          range of a LOC_CONST.  Since LOC_CONST_BYTES exists, I'm not
  70          sure that is a big deal.  */
  71       long ivalue;
  72
  73       struct block *block;
  74
  75       char *bytes;
  76
  77       CORE_ADDR address;
  78
  79       /* for opaque typedef struct chain */
  80
  81       struct symbol *chain;
  82     }
  83   value;
  84
  85   /* Since one and only one language can apply, wrap the language specific
  86      information inside a union. */
  87
  88   union
  89     {
  90       struct cplus_specific      /* For C++ */
  91                                 /* start-sanitize-java */
  92                                 /*  and Java */
  93                                 /* end-sanitize-java */
  94         {
  95           char *demangled_name;
  96         } cplus_specific;
  97       struct chill_specific      /* For Chill */
  98         {
  99           char *demangled_name;
 100         } chill_specific;
 101     } language_specific;
 102
 103   /* Record the source code language that applies to this symbol.
 104      This is used to select one of the fields from the language specific
 105      union above. */
 106
 107   enum language language BYTE_BITFIELD;
 108
 109   /* Which section is this symbol in?  This is an index into
 110      section_offsets for this objfile.  Negative means that the symbol
 111      does not get relocated relative to a section.
 112      Disclaimer: currently this is just used for xcoff, so don't
 113      expect all symbol-reading code to set it correctly (the ELF code
 114      also tries to set it correctly).  */
 115
 116   short section;
 117
 118   /* The bfd section associated with this symbol. */
 119
 120   asection *bfd_section;
 121 };
 122
 123 extern CORE_ADDR symbol_overlayed_address PARAMS((CORE_ADDR, asection *));
 124
 125 #define SYMBOL_NAME(symbol)             (symbol)->ginfo.name
 126 #define SYMBOL_VALUE(symbol)            (symbol)->ginfo.value.ivalue
 127 #define SYMBOL_VALUE_ADDRESS(symbol)    (symbol)->ginfo.value.address
 128 #define SYMBOL_VALUE_BYTES(symbol)      (symbol)->ginfo.value.bytes
 129 #define SYMBOL_BLOCK_VALUE(symbol)      (symbol)->ginfo.value.block
 130 #define SYMBOL_VALUE_CHAIN(symbol)      (symbol)->ginfo.value.chain
 131 #define SYMBOL_LANGUAGE(symbol)         (symbol)->ginfo.language
 132 #define SYMBOL_SECTION(symbol)          (symbol)->ginfo.section
 133 #define SYMBOL_BFD_SECTION(symbol)      (symbol)->ginfo.bfd_section
 134
 135 #define SYMBOL_CPLUS_DEMANGLED_NAME(symbol)     \
 136   (symbol)->ginfo.language_specific.cplus_specific.demangled_name
 137
 138 /* Macro that initializes the language dependent portion of a symbol
 139    depending upon the language for the symbol. */
 140
 141 #define SYMBOL_INIT_LANGUAGE_SPECIFIC(symbol,language)                  \
 142   do {                                                                  \
 143     SYMBOL_LANGUAGE (symbol) = language;                                \
 144     if (SYMBOL_LANGUAGE (symbol) == language_cplus                      \
 145         /* start-sanitize-java */                                       \
 146         || SYMBOL_LANGUAGE (symbol) == language_java                    \
 147         /* end-sanitize-java */                                         \
 148         )                                                               \
 149       {                                                                 \
 150         SYMBOL_CPLUS_DEMANGLED_NAME (symbol) = NULL;                    \
 151       }                                                                 \
 152     else if (SYMBOL_LANGUAGE (symbol) == language_chill)                \
 153       {                                                                 \
 154         SYMBOL_CHILL_DEMANGLED_NAME (symbol) = NULL;                    \
 155       }                                                                 \
 156     else                                                                \
 157       {                                                                 \
 158         memset (&(symbol)->ginfo.language_specific, 0,                  \
 159                 sizeof ((symbol)->ginfo.language_specific));            \
 160       }                                                                 \
 161   } while (0)
 162
 163 /* Macro that attempts to initialize the demangled name for a symbol,
 164    based on the language of that symbol.  If the language is set to
 165    language_auto, it will attempt to find any demangling algorithm
 166    that works and then set the language appropriately.  If no demangling
 167    of any kind is found, the language is set back to language_unknown,
 168    so we can avoid doing this work again the next time we encounter
 169    the symbol.  Any required space to store the name is obtained from the
 170    specified obstack. */
 171
 172 #define SYMBOL_INIT_DEMANGLED_NAME(symbol,obstack)                      \
 173   do {                                                                  \
 174     char *demangled = NULL;                                             \
 175     if (SYMBOL_LANGUAGE (symbol) == language_cplus                      \
 176         || SYMBOL_LANGUAGE (symbol) == language_auto)                   \
 177       {                                                                 \
 178         demangled =                                                     \
 179           cplus_demangle (SYMBOL_NAME (symbol), DMGL_PARAMS | DMGL_ANSI);\
 180         if (demangled != NULL)                                          \
 181           {                                                             \
 182             SYMBOL_LANGUAGE (symbol) = language_cplus;                  \
 183             SYMBOL_CPLUS_DEMANGLED_NAME (symbol) =                      \
 184               obsavestring (demangled, strlen (demangled), (obstack));  \
 185             free (demangled);                                           \
 186           }                                                             \
 187         else                                                            \
 188           {                                                             \
 189             SYMBOL_CPLUS_DEMANGLED_NAME (symbol) = NULL;                \
 190           }                                                             \
 191       }                                                                 \
 192   /* start-sanitize-java */                                             \
 193     if (SYMBOL_LANGUAGE (symbol) == language_java)                      \
 194       {                                                                 \
 195         demangled =                                                     \
 196           cplus_demangle (SYMBOL_NAME (symbol),                         \
 197                           DMGL_PARAMS | DMGL_ANSI | DMGL_JAVA);         \
 198         if (demangled != NULL)                                          \
 199           {                                                             \
 200             SYMBOL_LANGUAGE (symbol) = language_java;                   \
 201             SYMBOL_CPLUS_DEMANGLED_NAME (symbol) =                      \
 202               obsavestring (demangled, strlen (demangled), (obstack));  \
 203             free (demangled);                                           \
 204           }                                                             \
 205         else                                                            \
 206           {                                                             \
 207             SYMBOL_CPLUS_DEMANGLED_NAME (symbol) = NULL;                \
 208           }                                                             \
 209       }                                                                 \
 210   /* end-sanitize-java */                                               \
 211     if (demangled == NULL                                               \
 212         && (SYMBOL_LANGUAGE (symbol) == language_chill                  \
 213             || SYMBOL_LANGUAGE (symbol) == language_auto))              \
 214       {                                                                 \
 215         demangled =                                                     \
 216           chill_demangle (SYMBOL_NAME (symbol));                        \
 217         if (demangled != NULL)                                          \
 218           {                                                             \
 219             SYMBOL_LANGUAGE (symbol) = language_chill;                  \
 220             SYMBOL_CHILL_DEMANGLED_NAME (symbol) =                      \
 221               obsavestring (demangled, strlen (demangled), (obstack));  \
 222             free (demangled);                                           \
 223           }                                                             \
 224         else                                                            \
 225           {                                                             \
 226             SYMBOL_CHILL_DEMANGLED_NAME (symbol) = NULL;                \
 227           }                                                             \
 228       }                                                                 \
 229     if (SYMBOL_LANGUAGE (symbol) == language_auto)                      \
 230       {                                                                 \
 231         SYMBOL_LANGUAGE (symbol) = language_unknown;                    \
 232       }                                                                 \
 233   } while (0)
 234
 235 /* Macro that returns the demangled name for a symbol based on the language
 236    for that symbol.  If no demangled name exists, returns NULL. */
 237
 238 #define SYMBOL_DEMANGLED_NAME(symbol)                                   \
 239   (SYMBOL_LANGUAGE (symbol) == language_cplus                           \
 240    /* start-sanitize-java */                                            \
 241    || SYMBOL_LANGUAGE (symbol) == language_java                         \
 242    /* end-sanitize-java */                                              \
 243    ? SYMBOL_CPLUS_DEMANGLED_NAME (symbol)                               \
 244    : (SYMBOL_LANGUAGE (symbol) == language_chill                        \
 245       ? SYMBOL_CHILL_DEMANGLED_NAME (symbol)                            \
 246       : NULL))
 247
 248 #define SYMBOL_CHILL_DEMANGLED_NAME(symbol)                             \
 249   (symbol)->ginfo.language_specific.chill_specific.demangled_name
 250
 251 /* Macro that returns the "natural source name" of a symbol.  In C++ this is
 252    the "demangled" form of the name if demangle is on and the "mangled" form
 253    of the name if demangle is off.  In other languages this is just the
 254    symbol name.  The result should never be NULL. */
 255
 256 #define SYMBOL_SOURCE_NAME(symbol)                                      \
 257   (demangle && SYMBOL_DEMANGLED_NAME (symbol) != NULL                   \
 258    ? SYMBOL_DEMANGLED_NAME (symbol)                                     \
 259    : SYMBOL_NAME (symbol))
 260
 261 /* Macro that returns the "natural assembly name" of a symbol.  In C++ this is
 262    the "mangled" form of the name if demangle is off, or if demangle is on and
 263    asm_demangle is off.  Otherwise if asm_demangle is on it is the "demangled"
 264    form.  In other languages this is just the symbol name.  The result should
 265    never be NULL. */
 266
 267 #define SYMBOL_LINKAGE_NAME(symbol)                                     \
 268   (demangle && asm_demangle && SYMBOL_DEMANGLED_NAME (symbol) != NULL   \
 269    ? SYMBOL_DEMANGLED_NAME (symbol)                                     \
 270    : SYMBOL_NAME (symbol))
 271
 272 /* Macro that tests a symbol for a match against a specified name string.
 273    First test the unencoded name, then looks for and test a C++ encoded
 274    name if it exists.  Note that whitespace is ignored while attempting to
 275    match a C++ encoded name, so that "foo::bar(int,long)" is the same as
 276    "foo :: bar (int, long)".
 277    Evaluates to zero if the match fails, or nonzero if it succeeds. */
 278
 279 #define SYMBOL_MATCHES_NAME(symbol, name)                               \
 280   (STREQ (SYMBOL_NAME (symbol), (name))                                 \
 281    || (SYMBOL_DEMANGLED_NAME (symbol) != NULL                           \
 282        && strcmp_iw (SYMBOL_DEMANGLED_NAME (symbol), (name)) == 0))
 283
 284 /* Macro that tests a symbol for an re-match against the last compiled regular
 285    expression.  First test the unencoded name, then look for and test a C++
 286    encoded name if it exists.
 287    Evaluates to zero if the match fails, or nonzero if it succeeds. */
 288
 289 #define SYMBOL_MATCHES_REGEXP(symbol)                                   \
 290   (re_exec (SYMBOL_NAME (symbol)) != 0                                  \
 291    || (SYMBOL_DEMANGLED_NAME (symbol) != NULL                           \
 292        && re_exec (SYMBOL_DEMANGLED_NAME (symbol)) != 0))
 293
 294 /* Define a simple structure used to hold some very basic information about
 295    all defined global symbols (text, data, bss, abs, etc).  The only required
 296    information is the general_symbol_info.
 297
 298    In many cases, even if a file was compiled with no special options for
 299    debugging at all, as long as was not stripped it will contain sufficient
 300    information to build a useful minimal symbol table using this structure.
 301    Even when a file contains enough debugging information to build a full
 302    symbol table, these minimal symbols are still useful for quickly mapping
 303    between names and addresses, and vice versa.  They are also sometimes
 304    used to figure out what full symbol table entries need to be read in. */
 305
 306 struct minimal_symbol
 307 {
 308
 309   /* The general symbol info required for all types of symbols.
 310
 311      The SYMBOL_VALUE_ADDRESS contains the address that this symbol
 312      corresponds to.  */
 313
 314   struct general_symbol_info ginfo;
 315
 316   /* The info field is available for caching machine-specific information
 317      so it doesn't have to rederive the info constantly (over a serial line).
 318      It is initialized to zero and stays that way until target-dependent code
 319      sets it.  Storage for any data pointed to by this field should be allo-
 320      cated on the symbol_obstack for the associated objfile.
 321      The type would be "void *" except for reasons of compatibility with older
 322      compilers.  This field is optional.
 323
 324      Currently, the AMD 29000 tdep.c uses it to remember things it has decoded
 325      from the instructions in the function header, and the MIPS-16 code uses
 326      it to identify 16-bit procedures.  */
 327
 328   char *info;
 329
 330 #ifdef SOFUN_ADDRESS_MAYBE_MISSING
 331   /* Which source file is this symbol in?  Only relevant for mst_file_*.  */
 332   char *filename;
 333 #endif
 334
 335   /* Classification types for this symbol.  These should be taken as "advisory
 336      only", since if gdb can't easily figure out a classification it simply
 337      selects mst_unknown.  It may also have to guess when it can't figure out
 338      which is a better match between two types (mst_data versus mst_bss) for
 339      example.  Since the minimal symbol info is sometimes derived from the
 340      BFD library's view of a file, we need to live with what information bfd
 341      supplies. */
 342
 343   enum minimal_symbol_type
 344     {
 345       mst_unknown = 0,          /* Unknown type, the default */
 346       mst_text,                 /* Generally executable instructions */
 347       mst_data,                 /* Generally initialized data */
 348       mst_bss,                  /* Generally uninitialized data */
 349       mst_abs,                  /* Generally absolute (nonrelocatable) */
 350       /* GDB uses mst_solib_trampoline for the start address of a shared
 351          library trampoline entry.  Breakpoints for shared library functions
 352          are put there if the shared library is not yet loaded.
 353          After the shared library is loaded, lookup_minimal_symbol will
 354          prefer the minimal symbol from the shared library (usually
 355          a mst_text symbol) over the mst_solib_trampoline symbol, and the
 356          breakpoints will be moved to their true address in the shared
 357          library via breakpoint_re_set.  */
 358       mst_solib_trampoline,     /* Shared library trampoline code */
 359       /* For the mst_file* types, the names are only guaranteed to be unique
 360          within a given .o file.  */
 361       mst_file_text,            /* Static version of mst_text */
 362       mst_file_data,            /* Static version of mst_data */
 363       mst_file_bss              /* Static version of mst_bss */
 364     } type BYTE_BITFIELD;
 365 };
 366
 367 #define MSYMBOL_INFO(msymbol)           (msymbol)->info
 368 #define MSYMBOL_TYPE(msymbol)           (msymbol)->type
 369
 370 \f
 371 /* All of the name-scope contours of the program
 372    are represented by `struct block' objects.
 373    All of these objects are pointed to by the blockvector.
 374
 375    Each block represents one name scope.
 376    Each lexical context has its own block.
 377
 378    The blockvector begins with some special blocks.
 379    The GLOBAL_BLOCK contains all the symbols defined in this compilation
 380    whose scope is the entire program linked together.
 381    The STATIC_BLOCK contains all the symbols whose scope is the
 382    entire compilation excluding other separate compilations.
 383    Blocks starting with the FIRST_LOCAL_BLOCK are not special.
 384
 385    Each block records a range of core addresses for the code that
 386    is in the scope of the block.  The STATIC_BLOCK and GLOBAL_BLOCK
 387    give, for the range of code, the entire range of code produced
 388    by the compilation that the symbol segment belongs to.
 389
 390    The blocks appear in the blockvector
 391    in order of increasing starting-address,
 392    and, within that, in order of decreasing ending-address.
 393
 394    This implies that within the body of one function
 395    the blocks appear in the order of a depth-first tree walk.  */
 396
 397 struct blockvector
 398 {
 399   /* Number of blocks in the list.  */
 400   int nblocks;
 401   /* The blocks themselves.  */
 402   struct block *block[1];
 403 };
 404
 405 #define BLOCKVECTOR_NBLOCKS(blocklist) (blocklist)->nblocks
 406 #define BLOCKVECTOR_BLOCK(blocklist,n) (blocklist)->block[n]
 407
 408 /* Special block numbers */
 409
 410 #define GLOBAL_BLOCK            0
 411 #define STATIC_BLOCK            1
 412 #define FIRST_LOCAL_BLOCK       2
 413
 414 struct block
 415 {
 416
 417   /* Addresses in the executable code that are in this block.  */
 418
 419   CORE_ADDR startaddr;
 420   CORE_ADDR endaddr;
 421
 422   /* The symbol that names this block, if the block is the body of a
 423      function; otherwise, zero.  */
 424
 425   struct symbol *function;
 426
 427   /* The `struct block' for the containing block, or 0 if none.
 428
 429      The superblock of a top-level local block (i.e. a function in the
 430      case of C) is the STATIC_BLOCK.  The superblock of the
 431      STATIC_BLOCK is the GLOBAL_BLOCK.  */
 432
 433   struct block *superblock;
 434
 435   /* Version of GCC used to compile the function corresponding
 436      to this block, or 0 if not compiled with GCC.  When possible,
 437      GCC should be compatible with the native compiler, or if that
 438      is not feasible, the differences should be fixed during symbol
 439      reading.  As of 16 Apr 93, this flag is never used to distinguish
 440      between gcc2 and the native compiler.
 441
 442      If there is no function corresponding to this block, this meaning
 443      of this flag is undefined.  */
 444
 445   unsigned char gcc_compile_flag;
 446
 447   /* Number of local symbols.  */
 448
 449   int nsyms;
 450
 451   /* The symbols.  If some of them are arguments, then they must be
 452      in the order in which we would like to print them.  */
 453
 454   struct symbol *sym[1];
 455 };
 456
 457 #define BLOCK_START(bl)         (bl)->startaddr
 458 #define BLOCK_END(bl)           (bl)->endaddr
 459 #define BLOCK_NSYMS(bl)         (bl)->nsyms
 460 #define BLOCK_SYM(bl, n)        (bl)->sym[n]
 461 #define BLOCK_FUNCTION(bl)      (bl)->function
 462 #define BLOCK_SUPERBLOCK(bl)    (bl)->superblock
 463 #define BLOCK_GCC_COMPILED(bl)  (bl)->gcc_compile_flag
 464
 465 /* Nonzero if symbols of block BL should be sorted alphabetically.
 466    Don't sort a block which corresponds to a function.  If we did the
 467    sorting would have to preserve the order of the symbols for the
 468    arguments.  */
 469
 470 #define BLOCK_SHOULD_SORT(bl) ((bl)->nsyms >= 40 && BLOCK_FUNCTION (bl) == NULL)
 471
 472 \f
 473 /* Represent one symbol name; a variable, constant, function or typedef.  */
 474
 475 /* Different name spaces for symbols.  Looking up a symbol specifies a
 476    namespace and ignores symbol definitions in other name spaces. */
 477
 478 typedef enum
 479 {
 480   /* UNDEF_NAMESPACE is used when a namespace has not been discovered or
 481      none of the following apply.  This usually indicates an error either
 482      in the symbol information or in gdb's handling of symbols. */
 483
 484   UNDEF_NAMESPACE,
 485
 486   /* VAR_NAMESPACE is the usual namespace.  In C, this contains variables,
 487      function names, typedef names and enum type values. */
 488
 489   VAR_NAMESPACE,
 490
 491   /* STRUCT_NAMESPACE is used in C to hold struct, union and enum type names.
 492      Thus, if `struct foo' is used in a C program, it produces a symbol named
 493      `foo' in the STRUCT_NAMESPACE. */
 494
 495   STRUCT_NAMESPACE,
 496
 497   /* LABEL_NAMESPACE may be used for names of labels (for gotos);
 498      currently it is not used and labels are not recorded at all.  */
 499
 500   LABEL_NAMESPACE,
 501
 502   /* Searching namespaces. These overlap with VAR_NAMESPACE, providing
 503      some granularity with the search_symbols function. */
 504
 505   /* Everything in VAR_NAMESPACE minus FUNCTIONS_-, TYPES_-, and
 506      METHODS_NAMESPACE */
 507   VARIABLES_NAMESPACE,
 508
 509   /* All functions -- for some reason not methods, though. */
 510   FUNCTIONS_NAMESPACE,
 511
 512   /* All defined types */
 513   TYPES_NAMESPACE,
 514
 515   /* All class methods -- why is this separated out? */
 516   METHODS_NAMESPACE
 517
 518 } namespace_enum;
 519
 520 /* An address-class says where to find the value of a symbol.  */
 521
 522 enum address_class
 523 {
 524   /* Not used; catches errors */
 525
 526   LOC_UNDEF,
 527
 528   /* Value is constant int SYMBOL_VALUE, host byteorder */
 529
 530   LOC_CONST,
 531
 532   /* Value is at fixed address SYMBOL_VALUE_ADDRESS */
 533
 534   LOC_STATIC,
 535
 536   /* Value is in register.  SYMBOL_VALUE is the register number.  */
 537
 538   LOC_REGISTER,
 539
 540   /* It's an argument; the value is at SYMBOL_VALUE offset in arglist.  */
 541
 542   LOC_ARG,
 543
 544   /* Value address is at SYMBOL_VALUE offset in arglist.  */
 545
 546   LOC_REF_ARG,
 547
 548   /* Value is in register number SYMBOL_VALUE.  Just like LOC_REGISTER
 549      except this is an argument.  Probably the cleaner way to handle
 550      this would be to separate address_class (which would include
 551      separate ARG and LOCAL to deal with FRAME_ARGS_ADDRESS versus
 552      FRAME_LOCALS_ADDRESS), and an is_argument flag.
 553
 554      For some symbol formats (stabs, for some compilers at least),
 555      the compiler generates two symbols, an argument and a register.
 556      In some cases we combine them to a single LOC_REGPARM in symbol
 557      reading, but currently not for all cases (e.g. it's passed on the
 558      stack and then loaded into a register).  */
 559
 560   LOC_REGPARM,
 561
 562   /* Value is in specified register.  Just like LOC_REGPARM except the
 563      register holds the address of the argument instead of the argument
 564      itself. This is currently used for the passing of structs and unions
 565      on sparc and hppa.  It is also used for call by reference where the
 566      address is in a register, at least by mipsread.c.  */
 567
 568   LOC_REGPARM_ADDR,
 569
 570   /* Value is a local variable at SYMBOL_VALUE offset in stack frame.  */
 571
 572   LOC_LOCAL,
 573
 574   /* Value not used; definition in SYMBOL_TYPE.  Symbols in the namespace
 575      STRUCT_NAMESPACE all have this class.  */
 576
 577   LOC_TYPEDEF,
 578
 579   /* Value is address SYMBOL_VALUE_ADDRESS in the code */
 580
 581   LOC_LABEL,
 582
 583   /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
 584      In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
 585      of the block.  Function names have this class. */
 586
 587   LOC_BLOCK,
 588
 589   /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
 590      target byte order.  */
 591
 592   LOC_CONST_BYTES,
 593
 594   /* Value is arg at SYMBOL_VALUE offset in stack frame. Differs from
 595      LOC_LOCAL in that symbol is an argument; differs from LOC_ARG in
 596      that we find it in the frame (FRAME_LOCALS_ADDRESS), not in the
 597      arglist (FRAME_ARGS_ADDRESS).  Added for i960, which passes args
 598      in regs then copies to frame.  */
 599
 600   LOC_LOCAL_ARG,
 601
 602   /* Value is at SYMBOL_VALUE offset from the current value of
 603      register number SYMBOL_BASEREG.  This exists mainly for the same
 604      things that LOC_LOCAL and LOC_ARG do; but we need to do this
 605      instead because on 88k DWARF gives us the offset from the
 606      frame/stack pointer, rather than the offset from the "canonical
 607      frame address" used by COFF, stabs, etc., and we don't know how
 608      to convert between these until we start examining prologues.
 609
 610      Note that LOC_BASEREG is much less general than a DWARF expression.
 611      We don't need the generality (at least not yet), and storing a general
 612      DWARF expression would presumably take up more space than the existing
 613      scheme.  */
 614
 615   LOC_BASEREG,
 616
 617   /* Same as LOC_BASEREG but it is an argument.  */
 618
 619   LOC_BASEREG_ARG,
 620
 621   /* Value is at fixed address, but the address of the variable has
 622      to be determined from the minimal symbol table whenever the
 623      variable is referenced.
 624      This happens if debugging information for a global symbol is
 625      emitted and the corresponding minimal symbol is defined
 626      in another object file or runtime common storage.
 627      The linker might even remove the minimal symbol if the global
 628      symbol is never referenced, in which case the symbol remains
 629      unresolved.  */
 630
 631   LOC_UNRESOLVED,
 632
 633   /* The variable does not actually exist in the program.
 634      The value is ignored.  */
 635
 636   LOC_OPTIMIZED_OUT
 637 };
 638
 639 /* Linked list of symbol's live ranges. */
 640
 641 struct range_list
 642 {
 643   CORE_ADDR start;
 644   CORE_ADDR end;
 645   struct range_list *next;
 646 };
 647
 648 /* Linked list of aliases for a particular main/primary symbol.  */
 649 struct alias_list
 650   {
 651     struct symbol *sym;
 652     struct alias_list *next;
 653   };
 654
 655 struct symbol
 656 {
 657
 658   /* The general symbol info required for all types of symbols. */
 659
 660   struct general_symbol_info ginfo;
 661
 662   /* Data type of value */
 663
 664   struct type *type;
 665
 666   /* Name space code.  */
 667
 668 #ifdef __MFC4__
 669   /* FIXME: don't conflict with C++'s namespace */
 670   /* would be safer to do a global change for all namespace identifiers. */
 671   #define namespace _namespace
 672 #endif
 673   namespace_enum namespace BYTE_BITFIELD;
 674
 675   /* Address class */
 676
 677   enum address_class aclass BYTE_BITFIELD;
 678
 679   /* Line number of definition.  FIXME:  Should we really make the assumption
 680      that nobody will try to debug files longer than 64K lines?  What about
 681      machine generated programs? */
 682
 683   unsigned short line;
 684
 685   /* Some symbols require an additional value to be recorded on a per-
 686      symbol basis.  Stash those values here. */
 687
 688   union
 689     {
 690       /* Used by LOC_BASEREG and LOC_BASEREG_ARG.  */
 691       short basereg;
 692     }
 693   aux_value;
 694
 695
 696   /* Link to a list of aliases for this symbol.
 697      Only a "primary/main symbol may have aliases.  */
 698   struct alias_list *aliases;
 699
 700   /* List of ranges where this symbol is active.  This is only
 701      used by alias symbols at the current time.  */
 702   struct range_list *ranges;
 703 };
 704
 705
 706 #define SYMBOL_NAMESPACE(symbol)        (symbol)->namespace
 707 #define SYMBOL_CLASS(symbol)            (symbol)->aclass
 708 #define SYMBOL_TYPE(symbol)             (symbol)->type
 709 #define SYMBOL_LINE(symbol)             (symbol)->line
 710 #define SYMBOL_BASEREG(symbol)          (symbol)->aux_value.basereg
 711 #define SYMBOL_ALIASES(symbol)          (symbol)->aliases
 712 #define SYMBOL_RANGES(symbol)           (symbol)->ranges
 713 \f
 714 /* A partial_symbol records the name, namespace, and address class of
 715    symbols whose types we have not parsed yet.  For functions, it also
 716    contains their memory address, so we can find them from a PC value.
 717    Each partial_symbol sits in a partial_symtab, all of which are chained
 718    on a  partial symtab list and which points to the corresponding
 719    normal symtab once the partial_symtab has been referenced.  */
 720
 721 struct partial_symbol
 722 {
 723
 724   /* The general symbol info required for all types of symbols. */
 725
 726   struct general_symbol_info ginfo;
 727
 728   /* Name space code.  */
 729
 730   namespace_enum namespace BYTE_BITFIELD;
 731
 732   /* Address class (for info_symbols) */
 733
 734   enum address_class aclass BYTE_BITFIELD;
 735
 736 };
 737
 738 #define PSYMBOL_NAMESPACE(psymbol)      (psymbol)->namespace
 739 #define PSYMBOL_CLASS(psymbol)          (psymbol)->aclass
 740
 741 \f
 742 /* Source-file information.  This describes the relation between source files,
 743    ine numbers and addresses in the program text.  */
 744
 745 struct sourcevector
 746 {
 747   int length;                   /* Number of source files described */
 748   struct source *source[1];     /* Descriptions of the files */
 749 };
 750
 751 /* Each item represents a line-->pc (or the reverse) mapping.  This is
 752    somewhat more wasteful of space than one might wish, but since only
 753    the files which are actually debugged are read in to core, we don't
 754    waste much space.  */
 755
 756 struct linetable_entry
 757 {
 758   int line;
 759   CORE_ADDR pc;
 760 };
 761
 762 /* The order of entries in the linetable is significant.  They should
 763    be sorted by increasing values of the pc field.  If there is more than
 764    one entry for a given pc, then I'm not sure what should happen (and
 765    I not sure whether we currently handle it the best way).
 766
 767    Example: a C for statement generally looks like this
 768
 769         10      0x100   - for the init/test part of a for stmt.
 770         20      0x200
 771         30      0x300
 772         10      0x400   - for the increment part of a for stmt.
 773
 774    */
 775
 776 struct linetable
 777 {
 778   int nitems;
 779
 780   /* Actually NITEMS elements.  If you don't like this use of the
 781      `struct hack', you can shove it up your ANSI (seriously, if the
 782      committee tells us how to do it, we can probably go along).  */
 783   struct linetable_entry item[1];
 784 };
 785
 786 /* All the information on one source file.  */
 787
 788 struct source
 789 {
 790   char *name;                   /* Name of file */
 791   struct linetable contents;
 792 };
 793
 794 /* How to relocate the symbols from each section in a symbol file.
 795    Each struct contains an array of offsets.
 796    The ordering and meaning of the offsets is file-type-dependent;
 797    typically it is indexed by section numbers or symbol types or
 798    something like that.
 799
 800    To give us flexibility in changing the internal representation
 801    of these offsets, the ANOFFSET macro must be used to insert and
 802    extract offset values in the struct.  */
 803
 804 struct section_offsets
 805   {
 806     CORE_ADDR offsets[1];               /* As many as needed. */
 807   };
 808
 809 #define ANOFFSET(secoff, whichone)      (secoff->offsets[whichone])
 810
 811 /* The maximum possible size of a section_offsets table.  */
 812
 813 #define SIZEOF_SECTION_OFFSETS \
 814   (sizeof (struct section_offsets) \
 815    + sizeof (((struct section_offsets *) 0)->offsets) * (SECT_OFF_MAX-1))
 816
 817
 818 /* Each source file or header is represented by a struct symtab.
 819    These objects are chained through the `next' field.  */
 820
 821 struct symtab
 822   {
 823
 824     /* Chain of all existing symtabs.  */
 825
 826     struct symtab *next;
 827
 828     /* List of all symbol scope blocks for this symtab.  May be shared
 829        between different symtabs (and normally is for all the symtabs
 830        in a given compilation unit).  */
 831
 832     struct blockvector *blockvector;
 833
 834     /* Table mapping core addresses to line numbers for this file.
 835        Can be NULL if none.  Never shared between different symtabs.  */
 836
 837     struct linetable *linetable;
 838
 839     /* Section in objfile->section_offsets for the blockvector and
 840        the linetable.  Probably always SECT_OFF_TEXT.  */
 841
 842     int block_line_section;
 843
 844     /* If several symtabs share a blockvector, exactly one of them
 845        should be designed the primary, so that the blockvector
 846        is relocated exactly once by objfile_relocate.  */
 847
 848     int primary;
 849
 850     /* Name of this source file.  */
 851
 852     char *filename;
 853
 854     /* Directory in which it was compiled, or NULL if we don't know.  */
 855
 856     char *dirname;
 857
 858     /* This component says how to free the data we point to:
 859        free_contents => do a tree walk and free each object.
 860        free_nothing => do nothing; some other symtab will free
 861          the data this one uses.
 862       free_linetable => free just the linetable.  FIXME: Is this redundant
 863       with the primary field?  */
 864
 865     enum free_code
 866       {
 867         free_nothing, free_contents, free_linetable
 868         }
 869     free_code;
 870
 871     /* Pointer to one block of storage to be freed, if nonzero.  */
 872     /* This is IN ADDITION to the action indicated by free_code.  */
 873
 874     char *free_ptr;
 875
 876     /* Total number of lines found in source file.  */
 877
 878     int nlines;
 879
 880     /* line_charpos[N] is the position of the (N-1)th line of the
 881        source file.  "position" means something we can lseek() to; it
 882        is not guaranteed to be useful any other way.  */
 883
 884     int *line_charpos;
 885
 886     /* Language of this source file.  */
 887
 888     enum language language;
 889
 890     /* String that identifies the format of the debugging information, such
 891        as "stabs", "dwarf 1", "dwarf 2", "coff", etc.  This is mostly useful
 892        for automated testing of gdb but may also be information that is
 893        useful to the user. */
 894
 895     char *debugformat;
 896
 897     /* String of version information.  May be zero.  */
 898
 899     char *version;
 900
 901     /* Full name of file as found by searching the source path.
 902        NULL if not yet known.  */
 903
 904     char *fullname;
 905
 906     /* Object file from which this symbol information was read.  */
 907
 908     struct objfile *objfile;
 909
 910   };
 911
 912 #define BLOCKVECTOR(symtab)     (symtab)->blockvector
 913 #define LINETABLE(symtab)       (symtab)->linetable
 914
 915 \f
 916 /* Each source file that has not been fully read in is represented by
 917    a partial_symtab.  This contains the information on where in the
 918    executable the debugging symbols for a specific file are, and a
 919    list of names of global symbols which are located in this file.
 920    They are all chained on partial symtab lists.
 921
 922    Even after the source file has been read into a symtab, the
 923    partial_symtab remains around.  They are allocated on an obstack,
 924    psymbol_obstack.  FIXME, this is bad for dynamic linking or VxWorks-
 925    style execution of a bunch of .o's.  */
 926
 927 struct partial_symtab
 928 {
 929
 930   /* Chain of all existing partial symtabs.  */
 931
 932   struct partial_symtab *next;
 933
 934   /* Name of the source file which this partial_symtab defines */
 935
 936   char *filename;
 937
 938   /* Information about the object file from which symbols should be read.  */
 939
 940   struct objfile *objfile;
 941
 942   /* Set of relocation offsets to apply to each section.  */
 943
 944   struct section_offsets *section_offsets;
 945
 946   /* Range of text addresses covered by this file; texthigh is the
 947      beginning of the next section. */
 948
 949   CORE_ADDR textlow;
 950   CORE_ADDR texthigh;
 951
 952   /* Array of pointers to all of the partial_symtab's which this one
 953      depends on.  Since this array can only be set to previous or
 954      the current (?) psymtab, this dependency tree is guaranteed not
 955      to have any loops.  "depends on" means that symbols must be read
 956      for the dependencies before being read for this psymtab; this is
 957      for type references in stabs, where if foo.c includes foo.h, declarations
 958      in foo.h may use type numbers defined in foo.c.  For other debugging
 959      formats there may be no need to use dependencies.  */
 960
 961   struct partial_symtab **dependencies;
 962
 963   int number_of_dependencies;
 964
 965   /* Global symbol list.  This list will be sorted after readin to
 966      improve access.  Binary search will be the usual method of
 967      finding a symbol within it. globals_offset is an integer offset
 968      within global_psymbols[].  */
 969
 970   int globals_offset;
 971   int n_global_syms;
 972
 973   /* Static symbol list.  This list will *not* be sorted after readin;
 974      to find a symbol in it, exhaustive search must be used.  This is
 975      reasonable because searches through this list will eventually
 976      lead to either the read in of a files symbols for real (assumed
 977      to take a *lot* of time; check) or an error (and we don't care
 978      how long errors take).  This is an offset and size within
 979      static_psymbols[].  */
 980
 981   int statics_offset;
 982   int n_static_syms;
 983
 984   /* Pointer to symtab eventually allocated for this source file, 0 if
 985      !readin or if we haven't looked for the symtab after it was readin.  */
 986
 987   struct symtab *symtab;
 988
 989   /* Pointer to function which will read in the symtab corresponding to
 990      this psymtab.  */
 991
 992   void (*read_symtab) PARAMS ((struct partial_symtab *));
 993
 994   /* Information that lets read_symtab() locate the part of the symbol table
 995      that this psymtab corresponds to.  This information is private to the
 996      format-dependent symbol reading routines.  For further detail examine
 997      the various symbol reading modules.  Should really be (void *) but is
 998      (char *) as with other such gdb variables.  (FIXME) */
 999
1000   char *read_symtab_private;
1001
1002   /* Non-zero if the symtab corresponding to this psymtab has been readin */
1003
1004   unsigned char readin;
1005 };
1006
1007 /* A fast way to get from a psymtab to its symtab (after the first time).  */
1008 #define PSYMTAB_TO_SYMTAB(pst)  \
1009     ((pst) -> symtab != NULL ? (pst) -> symtab : psymtab_to_symtab (pst))
1010
1011 \f
1012 /* The virtual function table is now an array of structures which have the
1013    form { int16 offset, delta; void *pfn; }.
1014
1015    In normal virtual function tables, OFFSET is unused.
1016    DELTA is the amount which is added to the apparent object's base
1017    address in order to point to the actual object to which the
1018    virtual function should be applied.
1019    PFN is a pointer to the virtual function.
1020
1021    Note that this macro is g++ specific (FIXME). */
1022
1023 #define VTBL_FNADDR_OFFSET 2
1024
1025 /* Macro that yields non-zero value iff NAME is the prefix for C++ operator
1026    names.  If you leave out the parenthesis here you will lose!
1027    Currently 'o' 'p' CPLUS_MARKER is used for both the symbol in the
1028    symbol-file and the names in gdb's symbol table.
1029    Note that this macro is g++ specific (FIXME). */
1030
1031 #define OPNAME_PREFIX_P(NAME) \
1032   ((NAME)[0] == 'o' && (NAME)[1] == 'p' && is_cplus_marker ((NAME)[2]))
1033
1034 /* Macro that yields non-zero value iff NAME is the prefix for C++ vtbl
1035    names.  Note that this macro is g++ specific (FIXME).
1036    '_vt$' is the old cfront-style vtables; '_VT$' is the new
1037    style, using thunks (where '$' is really CPLUS_MARKER). */
1038
1039 #define VTBL_PREFIX_P(NAME) \
1040   ((NAME)[0] == '_' \
1041    && (((NAME)[1] == 'V' && (NAME)[2] == 'T') \
1042        || ((NAME)[1] == 'v' && (NAME)[2] == 't')) \
1043    && is_cplus_marker ((NAME)[3]))
1044
1045 /* Macro that yields non-zero value iff NAME is the prefix for C++ destructor
1046    names.  Note that this macro is g++ specific (FIXME).  */
1047
1048 #define DESTRUCTOR_PREFIX_P(NAME) \
1049   ((NAME)[0] == '_' && is_cplus_marker ((NAME)[1]) && (NAME)[2] == '_')
1050
1051 \f
1052 /* External variables and functions for the objects described above. */
1053
1054 /* This symtab variable specifies the current file for printing source lines */
1055
1056 extern struct symtab *current_source_symtab;
1057
1058 /* This is the next line to print for listing source lines.  */
1059
1060 extern int current_source_line;
1061
1062 /* See the comment in symfile.c about how current_objfile is used. */
1063
1064 extern struct objfile *current_objfile;
1065
1066 /* True if we are nested inside psymtab_to_symtab. */
1067
1068 extern int currently_reading_symtab;
1069
1070 /* From utils.c.  */
1071 extern int demangle;
1072 extern int asm_demangle;
1073
1074 /* symtab.c lookup functions */
1075
1076 /* lookup a symbol table by source file name */
1077
1078 extern struct symtab *
1079 lookup_symtab PARAMS ((char *));
1080
1081 /* lookup a symbol by name (optional block, optional symtab) */
1082
1083 extern struct symbol *
1084 lookup_symbol PARAMS ((const char *, const struct block *,
1085                        const namespace_enum, int *, struct symtab **));
1086
1087 /* lookup a symbol by name, within a specified block */
1088
1089 extern struct symbol *
1090 lookup_block_symbol PARAMS ((const struct block *, const char *,
1091                              const namespace_enum));
1092
1093 /* lookup a [struct, union, enum] by name, within a specified block */
1094
1095 extern struct type *
1096 lookup_struct PARAMS ((char *, struct block *));
1097
1098 extern struct type *
1099 lookup_union PARAMS ((char *, struct block *));
1100
1101 extern struct type *
1102 lookup_enum PARAMS ((char *, struct block *));
1103
1104 /* lookup the function corresponding to the block */
1105
1106 extern struct symbol *
1107 block_function PARAMS ((struct block *));
1108
1109 /* from blockframe.c: */
1110
1111 /* lookup the function symbol corresponding to the address */
1112
1113 extern struct symbol *
1114 find_pc_function PARAMS ((CORE_ADDR));
1115
1116 /* lookup the function corresponding to the address and section */
1117
1118 extern struct symbol *
1119 find_pc_sect_function PARAMS ((CORE_ADDR, asection *));
1120
1121 /* lookup function from address, return name, start addr and end addr */
1122
1123 extern int
1124 find_pc_partial_function PARAMS ((CORE_ADDR, char **,
1125                                              CORE_ADDR *, CORE_ADDR *));
1126
1127 extern void
1128 clear_pc_function_cache PARAMS ((void));
1129
1130 extern int
1131 find_pc_sect_partial_function PARAMS ((CORE_ADDR, asection *,
1132                                        char **, CORE_ADDR *, CORE_ADDR *));
1133
1134 /* from symtab.c: */
1135
1136 /* lookup partial symbol table by filename */
1137
1138 extern struct partial_symtab *
1139 lookup_partial_symtab PARAMS ((char *));
1140
1141 /* lookup partial symbol table by address */
1142
1143 extern struct partial_symtab *
1144 find_pc_psymtab PARAMS ((CORE_ADDR));
1145
1146 /* lookup partial symbol table by address and section */
1147
1148 extern struct partial_symtab *
1149 find_pc_sect_psymtab PARAMS ((CORE_ADDR, asection *));
1150
1151 /* lookup full symbol table by address */
1152
1153 extern struct symtab *
1154 find_pc_symtab PARAMS ((CORE_ADDR));
1155
1156 /* lookup full symbol table by address and section */
1157
1158 extern struct symtab *
1159 find_pc_sect_symtab PARAMS ((CORE_ADDR, asection *));
1160
1161 /* lookup partial symbol by address */
1162
1163 extern struct partial_symbol *
1164 find_pc_psymbol PARAMS ((struct partial_symtab *, CORE_ADDR));
1165
1166 /* lookup partial symbol by address and section */
1167
1168 extern struct partial_symbol *
1169 find_pc_sect_psymbol PARAMS ((struct partial_symtab *, CORE_ADDR, asection *));
1170
1171 extern int
1172 find_pc_line_pc_range PARAMS ((CORE_ADDR, CORE_ADDR *, CORE_ADDR *));
1173
1174 extern int
1175 contained_in PARAMS ((struct block *, struct block *));
1176
1177 extern void
1178 reread_symbols PARAMS ((void));
1179
1180 /* Macro for name of symbol to indicate a file compiled with gcc. */
1181 #ifndef GCC_COMPILED_FLAG_SYMBOL
1182 #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled."
1183 #endif
1184
1185 /* Macro for name of symbol to indicate a file compiled with gcc2. */
1186 #ifndef GCC2_COMPILED_FLAG_SYMBOL
1187 #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled."
1188 #endif
1189
1190 /* Functions for dealing with the minimal symbol table, really a misc
1191    address<->symbol mapping for things we don't have debug symbols for.  */
1192
1193 extern void prim_record_minimal_symbol PARAMS ((const char *, CORE_ADDR,
1194                                                 enum minimal_symbol_type,
1195                                                 struct objfile *));
1196
1197 extern struct minimal_symbol *prim_record_minimal_symbol_and_info
1198   PARAMS ((const char *, CORE_ADDR,
1199            enum minimal_symbol_type,
1200            char *info, int section,
1201            asection *bfd_section,
1202            struct objfile *));
1203
1204 #ifdef SOFUN_ADDRESS_MAYBE_MISSING
1205 extern CORE_ADDR find_stab_function_addr PARAMS ((char *,
1206                                                   struct partial_symtab *,
1207                                                   struct objfile *));
1208 #endif
1209
1210 extern struct minimal_symbol *
1211 lookup_minimal_symbol PARAMS ((const char *, const char *, struct objfile *));
1212
1213 extern struct minimal_symbol *
1214 lookup_minimal_symbol_text PARAMS ((const char *, const char *, struct objfile *));
1215
1216 struct minimal_symbol *
1217 lookup_minimal_symbol_solib_trampoline PARAMS ((const char *,
1218                                                 const char *,
1219                                                 struct objfile *));
1220
1221 extern struct minimal_symbol *
1222 lookup_minimal_symbol_by_pc PARAMS ((CORE_ADDR));
1223
1224 extern struct minimal_symbol *
1225 lookup_minimal_symbol_by_pc_section PARAMS ((CORE_ADDR, asection *));
1226
1227 extern struct minimal_symbol *
1228 lookup_solib_trampoline_symbol_by_pc PARAMS ((CORE_ADDR));
1229
1230 extern CORE_ADDR
1231 find_solib_trampoline_target PARAMS ((CORE_ADDR));
1232
1233 extern void
1234 init_minimal_symbol_collection PARAMS ((void));
1235
1236 extern void
1237 discard_minimal_symbols PARAMS ((int));
1238
1239 extern void
1240 install_minimal_symbols PARAMS ((struct objfile *));
1241
1242 /* Sort all the minimal symbols in OBJFILE.  */
1243
1244 extern void msymbols_sort PARAMS ((struct objfile *objfile));
1245
1246 struct symtab_and_line
1247 {
1248   struct symtab *symtab;
1249   asection      *section;
1250   /* Line number.  Line numbers start at 1 and proceed through symtab->nlines.
1251      0 is never a valid line number; it is used to indicate that line number
1252      information is not available.  */
1253   int line;
1254
1255   CORE_ADDR pc;
1256   CORE_ADDR end;
1257 };
1258
1259 #define INIT_SAL(sal) { \
1260   (sal)->symtab  = 0;   \
1261   (sal)->section = 0;   \
1262   (sal)->line    = 0;   \
1263   (sal)->pc      = 0;   \
1264   (sal)->end     = 0;   \
1265 }
1266
1267 struct symtabs_and_lines
1268 {
1269   struct symtab_and_line *sals;
1270   int nelts;
1271 };
1272
1273 /* Given a pc value, return line number it is in.  Second arg nonzero means
1274    if pc is on the boundary use the previous statement's line number.  */
1275
1276 extern struct symtab_and_line
1277 find_pc_line PARAMS ((CORE_ADDR, int));
1278
1279 /* Same function, but specify a section as well as an address */
1280
1281 extern struct symtab_and_line
1282 find_pc_sect_line PARAMS ((CORE_ADDR, asection *, int));
1283
1284 /* Given an address, return the nearest symbol at or below it in memory.
1285    Optionally return the symtab it's from through 2nd arg, and the
1286    address in inferior memory of the symbol through 3rd arg.  */
1287
1288 extern struct symbol *
1289 find_addr_symbol PARAMS ((CORE_ADDR, struct symtab **, CORE_ADDR *));
1290
1291 /* Given a symtab and line number, return the pc there.  */
1292
1293 extern int
1294 find_line_pc PARAMS ((struct symtab *, int, CORE_ADDR *));
1295
1296 extern int
1297 find_line_pc_range PARAMS ((struct symtab_and_line,
1298                             CORE_ADDR *, CORE_ADDR *));
1299
1300 extern void
1301 resolve_sal_pc PARAMS ((struct symtab_and_line *));
1302
1303 /* Given a string, return the line specified by it.  For commands like "list"
1304    and "breakpoint".  */
1305
1306 extern struct symtabs_and_lines
1307 decode_line_spec PARAMS ((char *, int));
1308
1309 extern struct symtabs_and_lines
1310 decode_line_spec_1 PARAMS ((char *, int));
1311
1312 extern struct symtabs_and_lines
1313 decode_line_1 PARAMS ((char **, int, struct symtab *, int, char ***));
1314
1315 #if MAINTENANCE_CMDS
1316
1317 /* Symmisc.c */
1318
1319 void
1320 maintenance_print_symbols PARAMS ((char *, int));
1321
1322 void
1323 maintenance_print_psymbols PARAMS ((char *, int));
1324
1325 void
1326 maintenance_print_msymbols PARAMS ((char *, int));
1327
1328 void
1329 maintenance_print_objfiles PARAMS ((char *, int));
1330
1331 void
1332 maintenance_check_symtabs PARAMS ((char *, int));
1333
1334 /* maint.c */
1335
1336 void
1337 maintenance_print_statistics PARAMS ((char *, int));
1338
1339 #endif
1340
1341 extern void
1342 free_symtab PARAMS ((struct symtab *));
1343
1344 /* Symbol-reading stuff in symfile.c and solib.c.  */
1345
1346 extern struct symtab *
1347 psymtab_to_symtab PARAMS ((struct partial_symtab *));
1348
1349 extern void
1350 clear_solib PARAMS ((void));
1351
1352 extern struct objfile *
1353 symbol_file_add PARAMS ((char *, int, CORE_ADDR, int, int, int));
1354
1355 /* source.c */
1356
1357 extern int
1358 identify_source_line PARAMS ((struct symtab *, int, int, CORE_ADDR));
1359
1360 extern void
1361 print_source_lines PARAMS ((struct symtab *, int, int, int));
1362
1363 extern void
1364 forget_cached_source_info PARAMS ((void));
1365
1366 extern void
1367 select_source_symtab PARAMS ((struct symtab *));
1368
1369 extern char **make_symbol_completion_list PARAMS ((char *, char *));
1370
1371 extern void _initialize_source PARAMS ((void));
1372
1373 /* symtab.c */
1374
1375 extern struct partial_symtab *
1376 find_main_psymtab PARAMS ((void));
1377
1378 /* blockframe.c */
1379
1380 extern struct blockvector *
1381 blockvector_for_pc PARAMS ((CORE_ADDR, int *));
1382
1383 extern struct blockvector *
1384 blockvector_for_pc_sect PARAMS ((CORE_ADDR, asection *, int *,
1385                                  struct symtab *));
1386
1387 /* symfile.c */
1388
1389 extern void
1390 clear_symtab_users PARAMS ((void));
1391
1392 extern enum language
1393 deduce_language_from_filename PARAMS ((char *));
1394
1395 /* symtab.c */
1396
1397 extern int
1398 in_prologue PARAMS ((CORE_ADDR pc, CORE_ADDR func_start));
1399
1400 extern struct symbol *
1401 fixup_symbol_section PARAMS ((struct symbol  *, struct objfile *));
1402
1403 /* Symbol searching */
1404
1405 /* When using search_symbols, a list of the following structs is returned.
1406    Callers must free the search list using free_symbol_search! */
1407 struct symbol_search
1408 {
1409   /* The block in which the match was found. Could be, for example,
1410      STATIC_BLOCK or GLOBAL_BLOCK. */
1411   int block;
1412
1413   /* Information describing what was found.
1414
1415      If symtab abd symbol are NOT NULL, then information was found
1416      for this match. */
1417   struct symtab *symtab;
1418   struct symbol *symbol;
1419
1420   /* If msymbol is non-null, then a match was made on something for
1421      which only minimal_symbols exist. */
1422   struct minimal_symbol *msymbol;
1423
1424   /* A link to the next match, or NULL for the end. */
1425   struct symbol_search *next;
1426 };
1427
1428 extern void search_symbols PARAMS ((char *, namespace_enum, int, char **, struct symbol_search **));
1429 extern void free_search_symbols PARAMS ((struct symbol_search *));
1430
1431 #endif /* !defined(SYMTAB_H) */