* symfile.c (reread_symbols): When re-reading symbols, do all the
[binutils-gdb.git] / gdb / symtab.h
index f04407d8d9e3ae723276a2a5e522b17e210c36cf..b21516894bf7511c76a6bf6658ce81fcc682ffe4 100644 (file)
@@ -27,7 +27,9 @@ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
 #define obstack_chunk_free free
 
 /* Define a structure for the information that is common to all symbol types,
-   including minimal symbols, partial symbols, and full symbols. */
+   including minimal symbols, partial symbols, and full symbols.  In a
+   multilanguage environment, some language specific information may need to
+   be recorded along with each symbol. */
 
 struct general_symbol_info
 {
@@ -59,39 +61,33 @@ struct general_symbol_info
     }
   value;
 
-  /* In a multilanguage environment, some language specific information may
-     need to be recorded along with each symbol. */
+  /* Record the source code language that applies to this symbol.
+     This is used to select one of the fields from the language specific
+     union below. */
 
-  struct language_dependent_info
-    {
-
-      /* Record the language that this information applies to. */
+  enum language language;
 
-      enum language language;
+  /* Since one and only one language can apply, wrap the language specific
+     information inside a union. */
 
-      /* Since one and only one language can apply, wrap the information inside
-        a union. */
-
-      union lang_specific
+  union
+    {
+      struct cplus_specific      /* For C++ */
+       {
+         char *demangled_name;
+       } cplus_specific;
+      struct chill_specific      /* For Chill */
        {
-         /* For C++ */
-         struct cplus_specific
-           {
-             char *demangled_name;
-           } cplus_specific;
-         /* For Chill */
-         struct chill_specific
-           {
-             char *demangled_name;
-           } chill_specific;
-       } lang_u;
-    } lang_specific;
+         char *demangled_name;
+       } chill_specific;
+    } language_specific;
 
   /* Which section is this symbol in?  This is an index into
      section_offsets for this objfile.  Negative means that the symbol
-     does not get relocated relative to a section.  */
-  /* Disclaimer: currently this is just used for xcoff, so don't expect
+     does not get relocated relative to a section.
+     Disclaimer: currently this is just used for xcoff, so don't expect
      all symbol-reading code to set it correctly.  */
+
   int section;
 };
 
@@ -101,11 +97,11 @@ struct general_symbol_info
 #define SYMBOL_VALUE_BYTES(symbol)     (symbol)->ginfo.value.bytes
 #define SYMBOL_BLOCK_VALUE(symbol)     (symbol)->ginfo.value.block
 #define SYMBOL_VALUE_CHAIN(symbol)     (symbol)->ginfo.value.chain
-#define SYMBOL_LANGUAGE(symbol)                (symbol)->ginfo.lang_specific.language
+#define SYMBOL_LANGUAGE(symbol)                (symbol)->ginfo.language
 #define SYMBOL_SECTION(symbol)         (symbol)->ginfo.section
 
 #define SYMBOL_CPLUS_DEMANGLED_NAME(symbol)    \
-  (symbol)->ginfo.lang_specific.lang_u.cplus_specific.demangled_name
+  (symbol)->ginfo.language_specific.cplus_specific.demangled_name
 
 
 extern int demangle;   /* We reference it, so go ahead and declare it. */
@@ -126,8 +122,8 @@ extern int demangle;        /* We reference it, so go ahead and declare it. */
       }                                                                        \
     else                                                               \
       {                                                                        \
-       memset (&(symbol)->ginfo.lang_specific.lang_u, 0,               \
-               sizeof ((symbol)->ginfo.lang_specific.lang_u));         \
+       memset (&(symbol)->ginfo.language_specific, 0,                  \
+               sizeof ((symbol)->ginfo.language_specific));            \
       }                                                                        \
   } while (0)
 
@@ -195,7 +191,7 @@ extern int demangle;        /* We reference it, so go ahead and declare it. */
       : NULL))
 
 #define SYMBOL_CHILL_DEMANGLED_NAME(symbol)                            \
-  (symbol)->ginfo.lang_specific.lang_u.chill_specific.demangled_name
+  (symbol)->ginfo.language_specific.chill_specific.demangled_name
 
 /* Macro that returns the "natural source name" of a symbol.  In C++ this is
    the "demangled" form of the name if demangle is on and the "mangled" form
@@ -218,6 +214,10 @@ extern int demangle;       /* We reference it, so go ahead and declare it. */
    ? SYMBOL_DEMANGLED_NAME (symbol)                                    \
    : SYMBOL_NAME (symbol))
 
+/* From utils.c.  */
+extern int demangle;
+extern int asm_demangle;
+
 /* Macro that tests a symbol for a match against a specified name string.
    First test the unencoded name, then looks for and test a C++ encoded
    name if it exists.  Note that whitespace is ignored while attempting to
@@ -287,7 +287,12 @@ struct minimal_symbol
       mst_text,                        /* Generally executable instructions */
       mst_data,                        /* Generally initialized data */
       mst_bss,                 /* Generally uninitialized data */
-      mst_abs                  /* Generally absolute (nonrelocatable) */
+      mst_abs,                 /* Generally absolute (nonrelocatable) */
+      /* For the mst_file* types, the names are only guaranteed to be unique
+        within a given .o file.  */
+      mst_file_text,           /* Static version of mst_text */
+      mst_file_data,           /* Static version of mst_data */
+      mst_file_bss             /* Static version of mst_bss */
     } type;
 
 };
@@ -376,7 +381,8 @@ struct block
 
   int nsyms;
 
-  /* The symbols.  */
+  /* The symbols.  If some of them are arguments, then they must be
+     in the order in which we would like to print them.  */
 
   struct symbol *sym[1];
 };
@@ -389,9 +395,12 @@ struct block
 #define BLOCK_SUPERBLOCK(bl)   (bl)->superblock
 #define BLOCK_GCC_COMPILED(bl) (bl)->gcc_compile_flag
 
-/* Nonzero if symbols of block BL should be sorted alphabetically.  */
+/* Nonzero if symbols of block BL should be sorted alphabetically.
+   Don't sort a block which corresponds to a function.  If we did the
+   sorting would have to preserve the order of the symbols for the
+   arguments.  */
 
-#define BLOCK_SHOULD_SORT(bl) ((bl)->nsyms >= 40)
+#define BLOCK_SHOULD_SORT(bl) ((bl)->nsyms >= 40 && BLOCK_FUNCTION (bl) == NULL)
 
 \f
 /* Represent one symbol name; a variable, constant, function or typedef.  */
@@ -461,15 +470,16 @@ enum address_class
      For some symbol formats (stabs, for some compilers at least),
      the compiler generates two symbols, an argument and a register.
      In some cases we combine them to a single LOC_REGPARM in symbol
-     reading, but I'm not sure whether we do for all cases (I'm thinking
-     of when it's passed on the stack and then loaded into a register).  */
+     reading, but currently not for all cases (e.g. it's passed on the
+     stack and then loaded into a register).  */
 
   LOC_REGPARM,
 
   /* Value is in specified register.  Just like LOC_REGPARM except the
      register holds the address of the argument instead of the argument
      itself. This is currently used for the passing of structs and unions
-     on sparc and hppa.  */
+     on sparc and hppa.  It is also used for call by reference where the
+     address is in a register, at least by mipsread.c.  */
 
   LOC_REGPARM_ADDR,
 
@@ -505,6 +515,25 @@ enum address_class
 
   LOC_LOCAL_ARG,
 
+  /* Value is at SYMBOL_VALUE offset from the current value of
+     register number SYMBOL_BASEREG.  This exists mainly for the same
+     things that LOC_LOCAL and LOC_ARG do; but we need to do this
+     instead because on 88k DWARF gives us the offset from the
+     frame/stack pointer, rather than the offset from the "canonical
+     frame address" used by COFF, stabs, etc., and we don't know how
+     to convert between these until we start examining prologues.
+
+     Note that LOC_BASEREG is much less general than a DWARF expression.
+     We don't need the generality (at least not yet), and storing a general
+     DWARF expression would presumably take up more space than the existing
+     scheme.  */
+
+  LOC_BASEREG,
+
+  /* Same as LOC_BASEREG but it is an argument.  */
+
+  LOC_BASEREG_ARG,
+
   /* The variable does not actually exist in the program.
      The value is ignored.  */
 
@@ -541,12 +570,8 @@ struct symbol
 
   union
     {
-      /* for OP_BASEREG in DWARF location specs */
-      struct
-       {
-         short regno_valid;    /* 0 == regno invalid; !0 == regno valid */
-         short regno;          /* base register number {0, 1, 2, ...} */
-       } basereg;
+      /* Used by LOC_BASEREG and LOC_BASEREG_ARG.  */
+      short basereg;
     }
   aux_value;
 
@@ -556,19 +581,7 @@ struct symbol
 #define SYMBOL_CLASS(symbol)           (symbol)->class
 #define SYMBOL_TYPE(symbol)            (symbol)->type
 #define SYMBOL_LINE(symbol)            (symbol)->line
-#define SYMBOL_BASEREG(symbol)         (symbol)->aux_value.basereg.regno
-
-/* This currently fails because some symbols are not being initialized
-   to zero on allocation, and no code is currently setting this value.
-   Basereg handling will probably change significantly in the next release.
-   FIXME -fnf */
-
-#if 0
-#define SYMBOL_BASEREG_VALID(symbol) (symbol)->aux_value.basereg.regno_valid
-#else
-#define SYMBOL_BASEREG_VALID(symbol) 0
-#endif
-
+#define SYMBOL_BASEREG(symbol)         (symbol)->aux_value.basereg
 \f
 /* A partial_symbol records the name, namespace, and address class of
    symbols whose types we have not parsed yet.  For functions, it also
@@ -618,9 +631,27 @@ struct linetable_entry
   CORE_ADDR pc;
 };
 
+/* The order of entries in the linetable is significant.  They should
+   be sorted by increasing values of the pc field.  If there is more than
+   one entry for a given pc, then I'm not sure what should happen (and
+   I not sure whether we currently handle it the best way).
+
+   Example: a C for statement generally looks like this
+
+       10      0x100   - for the init/test part of a for stmt.
+       20      0x200
+       30      0x300
+       10      0x400   - for the increment part of a for stmt.
+
+   */
+
 struct linetable
 {
   int nitems;
+
+  /* Actually NITEMS elements.  If you don't like this use of the
+     `struct hack', you can shove it up your ANSI (seriously, if the
+     committee tells us how to do it, we can probably go along).  */
   struct linetable_entry item[1];
 };
 
@@ -708,7 +739,9 @@ struct symtab
 
     int nlines;
 
-    /* Array mapping line number to character position.  */
+    /* line_charpos[N] is the position of the (N-1)th line of the
+       source file.  "position" means something we can lseek() to; it
+       is not guaranteed to be useful any other way.  */
 
     int *line_charpos;
 
@@ -782,7 +815,11 @@ struct partial_symtab
   /* Array of pointers to all of the partial_symtab's which this one
      depends on.  Since this array can only be set to previous or
      the current (?) psymtab, this dependency tree is guaranteed not
-     to have any loops. */
+     to have any loops.  "depends on" means that symbols must be read
+     for the dependencies before being read for this psymtab; this is
+     for type references in stabs, where if foo.c includes foo.h, declarations
+     in foo.h may use type numbers defined in foo.c.  For other debugging
+     formats there may be no need to use dependencies.  */
 
   struct partial_symtab **dependencies;
 
@@ -910,8 +947,8 @@ block_function PARAMS ((struct block *));
 extern struct symbol *
 find_pc_function PARAMS ((CORE_ADDR));
 
-extern int
-find_pc_partial_function PARAMS ((CORE_ADDR, char **, CORE_ADDR *));
+extern int find_pc_partial_function
+  PARAMS ((CORE_ADDR, char **, CORE_ADDR *, CORE_ADDR *));
 
 extern void
 clear_pc_function_cache PARAMS ((void));
@@ -955,6 +992,8 @@ lookup_minimal_symbol PARAMS ((const char *, struct objfile *));
 extern struct minimal_symbol *
 lookup_minimal_symbol_by_pc PARAMS ((CORE_ADDR));
 
+extern struct minimal_symbol *lookup_next_minimal_symbol PARAMS ((CORE_ADDR));
+
 extern void
 init_minimal_symbol_collection PARAMS ((void));
 
@@ -967,7 +1006,12 @@ install_minimal_symbols PARAMS ((struct objfile *));
 struct symtab_and_line
 {
   struct symtab *symtab;
+
+  /* Line number.  Line numbers start at 1 and proceed through symtab->nlines.
+     0 is never a valid line number; it is used to indicate that line number
+     information is not available.  */
   int line;
+
   CORE_ADDR pc;
   CORE_ADDR end;
 };
@@ -1005,7 +1049,7 @@ extern struct symtabs_and_lines
 decode_line_spec_1 PARAMS ((char *, int));
 
 extern struct symtabs_and_lines
-decode_line_1 PARAMS ((char **, int, struct symtab *, int));
+decode_line_1 PARAMS ((char **, int, struct symtab *, int, char ***));
 
 /* Symmisc.c */
 
@@ -1041,8 +1085,10 @@ symbol_file_add PARAMS ((char *, int, CORE_ADDR, int, int, int));
 
 /* source.c */
 
+extern int frame_file_full_name; /* in stack.c */
+
 extern int
-identify_source_line PARAMS ((struct symtab *, int, int));
+identify_source_line PARAMS ((struct symtab *, int, int, CORE_ADDR));
 
 extern void
 print_source_lines PARAMS ((struct symtab *, int, int, int));
@@ -1053,14 +1099,10 @@ forget_cached_source_info PARAMS ((void));
 extern void
 select_source_symtab PARAMS ((struct symtab *));
 
-extern char **
-make_symbol_completion_list PARAMS ((char *));
+extern char **make_symbol_completion_list PARAMS ((char *, char *));
 
 /* symtab.c */
 
-extern void
-clear_symtab_users_once PARAMS ((void));
-
 extern struct partial_symtab *
 find_main_psymtab PARAMS ((void));
 
@@ -1071,6 +1113,9 @@ blockvector_for_pc PARAMS ((CORE_ADDR, int *));
 
 /* symfile.c */
 
+extern void
+clear_symtab_users PARAMS ((void));
+
 extern enum language
 deduce_language_from_filename PARAMS ((char *));