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