home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / gnu / gdb-4.9 / gdb / symtab.h < prev    next >
Encoding:
C/C++ Source or Header  |  1993-05-12  |  33.0 KB  |  1,095 lines

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