gdb/doc: Add documentation for tfile description section lines.
[deliverable/binutils-gdb.git] / gdb / psympriv.h
index 5691eafe2970ca1c8921c7658cdc2fff5cf6f7c1..915208e0d2aec121e5d630c7105179b3b62f6e15 100644 (file)
@@ -1,6 +1,6 @@
 /* Private partial symbol table definitions.
 
-   Copyright (C) 2009, 2010 Free Software Foundation, Inc.
+   Copyright (C) 2009-2016 Free Software Foundation, Inc.
 
    This file is part of GDB.
 
@@ -28,32 +28,43 @@ struct psymbol_allocation_list;
    symbols whose types we have not parsed yet.  For functions, it also
    contains their memory address, so we can find them from a PC value.
    Each partial_symbol sits in a partial_symtab, all of which are chained
-   on a  partial symtab list and which points to the corresponding 
+   on a  partial symtab list and which points to the corresponding
    normal symtab once the partial_symtab has been referenced.  */
 
 /* This structure is space critical.  See space comments at the top of
-   symtab.h. */
+   symtab.h.  */
 
 struct partial_symbol
 {
-
-  /* The general symbol info required for all types of symbols. */
+  /* The general symbol info required for all types of symbols.  */
 
   struct general_symbol_info ginfo;
 
   /* Name space code.  */
 
-  ENUM_BITFIELD(domain_enum_tag) domain : 6;
-
-  /* Address class (for info_symbols) */
+  ENUM_BITFIELD(domain_enum_tag) domain : SYMBOL_DOMAIN_BITS;
 
-  ENUM_BITFIELD(address_class) aclass : 6;
+  /* Address class (for info_symbols).  Note that we don't allow
+     synthetic "aclass" values here at present, simply because there's
+     no need.  */
 
+  ENUM_BITFIELD(address_class) aclass : SYMBOL_ACLASS_BITS;
 };
 
 #define PSYMBOL_DOMAIN(psymbol)        (psymbol)->domain
 #define PSYMBOL_CLASS(psymbol)         (psymbol)->aclass
 
+/* A convenience enum to give names to some constants used when
+   searching psymtabs.  This is internal to psymtab and should not be
+   used elsewhere.  */
+
+enum psymtab_search_status
+  {
+    PST_NOT_SEARCHED,
+    PST_SEARCHED_AND_FOUND,
+    PST_SEARCHED_AND_NOT_FOUND
+  };
+
 /* Each source file that has not been fully read in is represented by
    a partial_symtab.  This contains the information on where in the
    executable the debugging symbols for a specific file are, and a
@@ -66,12 +77,13 @@ struct partial_symbol
 
 struct partial_symtab
 {
-
   /* Chain of all existing partial symtabs.  */
 
   struct partial_symtab *next;
 
-  /* Name of the source file which this partial_symtab defines */
+  /* Name of the source file which this partial_symtab defines,
+     or if the psymtab is anonymous then a descriptive name for
+     debugging purposes, or "".  It must not be NULL.  */
 
   const char *filename;
 
@@ -83,19 +95,41 @@ struct partial_symtab
 
   const char *dirname;
 
-  /* Information about the object file from which symbols should be read.  */
+  /* Range of text addresses covered by this file; texthigh is the
+     beginning of the next section.  Do not use if PSYMTABS_ADDRMAP_SUPPORTED
+     is set.  */
+
+  CORE_ADDR textlow;
+  CORE_ADDR texthigh;
 
-  struct objfile *objfile;
+  /* If NULL, this is an ordinary partial symbol table.
 
-  /* Set of relocation offsets to apply to each section.  */
+     If non-NULL, this holds a single includer of this partial symbol
+     table, and this partial symbol table is a shared one.
 
-  struct section_offsets *section_offsets;
+     A shared psymtab is one that is referenced by multiple other
+     psymtabs, and which conceptually has its contents directly
+     included in those.
 
-  /* Range of text addresses covered by this file; texthigh is the
-     beginning of the next section. */
+     Shared psymtabs have special semantics.  When a search finds a
+     symbol in a shared table, we instead return one of the non-shared
+     tables that include this one.
 
-  CORE_ADDR textlow;
-  CORE_ADDR texthigh;
+     A shared psymtabs can be referred to by other shared ones.
+
+     The psymtabs that refer to a shared psymtab will list the shared
+     psymtab in their 'dependencies' array.
+
+     In DWARF terms, a shared psymtab is a DW_TAG_partial_unit; but
+     of course using a name based on that would be too confusing, so
+     "shared" was chosen instead.
+
+     Only a single user is needed because, when expanding a shared
+     psymtab, we only need to expand its "canonical" non-shared user.
+     The choice of which one should be canonical is left to the
+     debuginfo reader; it can be arbitrary.  */
+
+  struct partial_symtab *user;
 
   /* 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
@@ -112,7 +146,7 @@ struct partial_symtab
 
   /* Global symbol list.  This list will be sorted after readin to
      improve access.  Binary search will be the usual method of
-     finding a symbol within it. globals_offset is an integer offset
+     finding a symbol within it.  globals_offset is an integer offset
      within global_psymbols[].  */
 
   int globals_offset;
@@ -135,15 +169,29 @@ struct partial_symtab
 
   unsigned char readin;
 
-  /* Pointer to symtab eventually allocated for this source file, 0 if
+  /* True iff objfile->psymtabs_addrmap is properly populated for this
+     partial_symtab.  For discontiguous overlapping psymtabs is the only usable
+     info in PSYMTABS_ADDRMAP.  */
+
+  unsigned char psymtabs_addrmap_supported;
+
+  /* True if the name of this partial symtab is not a source file name.  */
+
+  unsigned char anonymous;
+
+  /* A flag that is temporarily used when searching psymtabs.  */
+
+  ENUM_BITFIELD (psymtab_search_status) searched_flag : 2;
+
+  /* Pointer to compunit eventually allocated for this source file, 0 if
      !readin or if we haven't looked for the symtab after it was readin.  */
 
-  struct symtab *symtab;
+  struct compunit_symtab *compunit_symtab;
 
   /* Pointer to function which will read in the symtab corresponding to
      this psymtab.  */
 
-  void (*read_symtab) (struct partial_symtab *);
+  void (*read_symtab) (struct partial_symtab *, struct objfile *);
 
   /* Information that lets read_symtab() locate the part of the symbol table
      that this psymtab corresponds to.  This information is private to the
@@ -153,39 +201,35 @@ struct partial_symtab
   void *read_symtab_private;
 };
 
-extern void sort_pst_symbols (struct partial_symtab *);
-
 /* Add any kind of symbol to a psymbol_allocation_list.  */
 
-extern const
-struct partial_symbol *add_psymbol_to_list (const char *, int, int, domain_enum,
-                                           enum address_class,
-                                           struct psymbol_allocation_list *,
-                                           long, CORE_ADDR,
-                                           enum language, struct objfile *);
+extern void add_psymbol_to_list (const char *, int,
+                                int, domain_enum,
+                                enum address_class,
+                                struct psymbol_allocation_list *,
+                                CORE_ADDR,
+                                enum language, struct objfile *);
 
 extern void init_psymbol_list (struct objfile *, int);
 
 extern struct partial_symtab *start_psymtab_common (struct objfile *,
-                                                   struct section_offsets *,
                                                    const char *, CORE_ADDR,
                                                    struct partial_symbol **,
                                                    struct partial_symbol **);
 
+extern void end_psymtab_common (struct objfile *, struct partial_symtab *);
+
 extern struct partial_symtab *allocate_psymtab (const char *,
-                                               struct objfile *);
+                                               struct objfile *)
+  ATTRIBUTE_NONNULL (1);
 
-extern void discard_psymtab (struct partial_symtab *);
+extern void discard_psymtab (struct objfile *, struct partial_symtab *);
+
+extern struct cleanup *make_cleanup_discard_psymtabs (struct objfile *);
 
 /* Traverse all psymtabs in one objfile.  */
 
 #define        ALL_OBJFILE_PSYMTABS(objfile, p) \
     for ((p) = (objfile) -> psymtabs; (p) != NULL; (p) = (p) -> next)
 
-/* Traverse all psymtabs in all objfiles.  */
-
-#define        ALL_PSYMTABS(objfile, p) \
-  ALL_OBJFILES (objfile)        \
-    ALL_OBJFILE_PSYMTABS (objfile, p)
-
 #endif /* PSYMPRIV_H */
This page took 0.038044 seconds and 4 git commands to generate.