2012-04-20 Sergio Durigan Junior <sergiodj@redhat.com>
[deliverable/binutils-gdb.git] / gdb / objfiles.h
index 683f7c37cc52e2b2df60e644f2934cff5ed02a3a..d5c807f2c38cc9807480f16afe5f124fe4676176 100644 (file)
@@ -1,8 +1,6 @@
 /* Definitions for symbol file management in GDB.
 
-   Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
-   2002, 2003, 2004, 2007, 2008, 2009, 2010, 2011
-   Free Software Foundation, Inc.
+   Copyright (C) 1992-2004, 2007-2012 Free Software Foundation, Inc.
 
    This file is part of GDB.
 
@@ -23,7 +21,7 @@
 #define OBJFILES_H
 
 #include "gdb_obstack.h"       /* For obstack internals.  */
-#include "symfile.h"           /* For struct psymbol_allocation_list */
+#include "symfile.h"           /* For struct psymbol_allocation_list */
 #include "progspace.h"
 
 struct bcache;
@@ -49,7 +47,7 @@ struct objfile_data;
    the debugging information, where these values are the starting
    address (inclusive) and ending address (exclusive) of the
    instruction space in the executable which correspond to the
-   "startup file", I.E. crt0.o in most cases.  This file is assumed to
+   "startup file", i.e. crt0.o in most cases.  This file is assumed to
    be a startup file and frames with pc's inside it are treated as
    nonexistent.  Setting these variables is necessary so that
    backtraces do not fly off the bottom of the stack.
@@ -57,7 +55,7 @@ struct objfile_data;
    NOTE: cagney/2003-09-09: It turns out that this "traditional"
    method doesn't work.  Corinna writes: ``It turns out that the call
    to test for "inside entry file" destroys a meaningful backtrace
-   under some conditions.  E. g. the backtrace tests in the asm-source
+   under some conditions.  E.g. the backtrace tests in the asm-source
    testcase are broken for some targets.  In this test the functions
    are all implemented as part of one file and the testcase is not
    necessarily linked with a start file (depending on the target).
@@ -118,7 +116,7 @@ struct obj_section
     /* Objfile this section is part of.  */
     struct objfile *objfile;
 
-    /* True if this "overlay section" is mapped into an "overlay region". */
+    /* True if this "overlay section" is mapped into an "overlay region".  */
     int ovly_mapped;
   };
 
@@ -128,20 +126,20 @@ struct obj_section
 
 /* The memory address of section S (vma + offset).  */
 #define obj_section_addr(s)                                            \
-  (bfd_get_section_vma ((s)->objfile->abfd, s->the_bfd_section)                \
+  (bfd_get_section_vma ((s)->objfile->obfd, s->the_bfd_section)                \
    + obj_section_offset (s))
 
 /* The one-passed-the-end memory address of section S
    (vma + size + offset).  */
 #define obj_section_endaddr(s)                                         \
-  (bfd_get_section_vma ((s)->objfile->abfd, s->the_bfd_section)                \
+  (bfd_get_section_vma ((s)->objfile->obfd, s->the_bfd_section)                \
    + bfd_get_section_size ((s)->the_bfd_section)                       \
    + obj_section_offset (s))
 
 /* The "objstats" structure provides a place for gdb to record some
    interesting information about its internal state at runtime, on a
    per objfile basis, such as information about the number of symbols
-   read, size of string table (if any), etc. */
+   read, size of string table (if any), etc.  */
 
 struct objstats
   {
@@ -173,19 +171,9 @@ struct objfile
   {
 
     /* All struct objfile's are chained together by their next pointers.
-       The global variable "object_files" points to the first link in this
-       chain.
-
-       FIXME:  There is a problem here if the objfile is reusable, and if
-       multiple users are to be supported.  The problem is that the objfile
-       list is linked through a member of the objfile struct itself, which
-       is only valid for one gdb process.  The list implementation needs to
-       be changed to something like:
-
-       struct list {struct list *next; struct objfile *objfile};
-
-       where the list structure is completely maintained separately within
-       each gdb process. */
+       The program space field "objfiles"  (frequently referenced via
+       the macro "object_files") points to the first link in this
+       chain.  */
 
     struct objfile *next;
 
@@ -194,7 +182,10 @@ struct objfile
 
     char *name;
 
-    /* Some flag bits for this objfile. */
+    CORE_ADDR addr_low;
+
+    /* Some flag bits for this objfile.
+       The values are defined by OBJF_*.  */
 
     unsigned short flags;
 
@@ -204,13 +195,13 @@ struct objfile
 
     /* Each objfile points to a linked list of symtabs derived from this file,
        one symtab structure for each compilation unit (source file).  Each link
-       in the symtab list contains a backpointer to this objfile. */
+       in the symtab list contains a backpointer to this objfile.  */
 
     struct symtab *symtabs;
 
     /* Each objfile points to a linked list of partial symtabs derived from
        this file, one partial symtab structure for each compilation unit
-       (source file). */
+       (source file).  */
 
     struct partial_symtab *psymtabs;
 
@@ -221,7 +212,7 @@ struct objfile
 
     struct addrmap *psymtabs_addrmap;
 
-    /* List of freed partial symtabs, available for re-use */
+    /* List of freed partial symtabs, available for re-use */
 
     struct partial_symtab *free_psymtabs;
 
@@ -242,17 +233,22 @@ struct objfile
 
     long mtime;
 
+    /* Cached 32-bit CRC as computed by gnu_debuglink_crc32.  CRC32 is valid
+       iff CRC32_P.  */
+    unsigned long crc32;
+    int crc32_p;
+
     /* Obstack to hold objects that should be freed when we load a new symbol
-       table from this object file. */
+       table from this object file.  */
 
     struct obstack objfile_obstack; 
 
     /* A byte cache where we can stash arbitrary "chunks" of bytes that
-       will not change. */
+       will not change.  */
 
-    struct psymbol_bcache *psymbol_cache; /* Byte cache for partial syms */
-    struct bcache *macro_cache;          /* Byte cache for macros */
-    struct bcache *filename_cache;      /* Byte cache for file names.  */
+    struct psymbol_bcache *psymbol_cache; /* Byte cache for partial syms */
+    struct bcache *macro_cache;           /* Byte cache for macros.  */
+    struct bcache *filename_cache;       /* Byte cache for file names.  */
 
     /* Hash table for mapping symbol names to demangled names.  Each
        entry in the hash table is actually two consecutive strings,
@@ -262,7 +258,7 @@ struct objfile
     struct htab *demangled_names_hash;
 
     /* Vectors of all partial symbols read in from file.  The actual data
-       is stored in the objfile_obstack. */
+       is stored in the objfile_obstack.  */
 
     struct psymbol_allocation_list global_psymbols;
     struct psymbol_allocation_list static_psymbols;
@@ -275,7 +271,7 @@ struct objfile
        of it.  There is also a count of the number of symbols, which does
        not include the terminating null symbol.  The array itself, as well
        as all the data that it points to, should be allocated on the
-       objfile_obstack for this file. */
+       objfile_obstack for this file.  */
 
     struct minimal_symbol *msymbols;
     int minimal_symbol_count;
@@ -290,20 +286,20 @@ struct objfile
     struct minimal_symbol *msymbol_demangled_hash[MINIMAL_SYMBOL_HASH_SIZE];
 
     /* Structure which keeps track of functions that manipulate objfile's
-       of the same type as this objfile.  I.E. the function to read partial
+       of the same type as this objfile.  I.e. the function to read partial
        symbols for example.  Note that this structure is in statically
        allocated memory, and is shared by all objfiles that use the
-       object module reader of this type. */
+       object module reader of this type.  */
 
     const struct sym_fns *sf;
 
     /* The per-objfile information about the entry point, the scope (file/func)
-       containing the entry point, and the scope of the user's main() func. */
+       containing the entry point, and the scope of the user's main() func.  */
 
     struct entry_info ei;
 
     /* Information about stabs.  Will be filled in with a dbx_symfile_info
-       struct by those readers that need it. */
+       struct by those readers that need it.  */
     /* NOTE: cagney/2004-10-23: This has been replaced by per-objfile
        data points implemented using "data" and "num_data" below.  For
        an example of how to use this replacement, see "objfile_data"
@@ -331,23 +327,23 @@ struct objfile
     unsigned num_data;
 
     /* Set of relocation offsets to apply to each section.
-       Currently on the objfile_obstack (which makes no sense, but I'm
-       not sure it's harming anything).
+       The table is indexed by the_bfd_section->index, thus it is generally
+       as large as the number of sections in the binary.
+       The table is stored on the objfile_obstack.
 
        These offsets indicate that all symbols (including partial and
        minimal symbols) which have been read have been relocated by this
-       much.  Symbols which are yet to be read need to be relocated by
-       it.  */
+       much.  Symbols which are yet to be read need to be relocated by it.  */
 
     struct section_offsets *section_offsets;
     int num_sections;
 
-    /* Indexes in the section_offsets array. These are initialized by the
+    /* Indexes in the section_offsets array.  These are initialized by the
        *_symfile_offsets() family of functions (som_symfile_offsets,
-       xcoff_symfile_offsets, default_symfile_offsets). In theory they
+       xcoff_symfile_offsets, default_symfile_offsets).  In theory they
        should correspond to the section indexes used by bfd for the
-       current objfile. The exception to this for the time being is the
-       SOM version. */
+       current objfile.  The exception to this for the time being is the
+       SOM version.  */
 
     int sect_index_text;
     int sect_index_data;
@@ -358,12 +354,11 @@ struct objfile
        among other things, is used to map pc addresses into sections.
        SECTIONS points to the first entry in the table, and
        SECTIONS_END points to the first location past the last entry
-       in the table.  Currently the table is stored on the
-       objfile_obstack (which makes no sense, but I'm not sure it's
-       harming anything).  */
+       in the table.  The table is stored on the objfile_obstack.
+       There is no particular order to the sections in this table, and it
+       only contains sections we care about (e.g. non-empty, SEC_ALLOC).  */
 
-    struct obj_section
-     *sections, *sections_end;
+    struct obj_section *sections, *sections_end;
 
     /* GDB allows to have debug symbols in separate object files.  This is
        used by .gnu_debuglink, ELF build id note and Mach-O OSO.
@@ -377,22 +372,15 @@ struct objfile
     struct objfile *separate_debug_objfile;
 
     /* If this is a separate debug object, this is used as a link to the
-       actual executable objfile. */
+       actual executable objfile.  */
     struct objfile *separate_debug_objfile_backlink;
 
     /* If this is a separate debug object, this is a link to the next one
        for the same executable objfile.  */
     struct objfile *separate_debug_objfile_link;
 
-    /* Place to stash various statistics about this objfile */
-      OBJSTATS;
-
-    /* A symtab that the C++ code uses to stash special symbols
-       associated to namespaces.  */
-
-    /* FIXME/carlton-2003-06-27: Delete this in a few years once
-       "possible namespace symbols" go away.  */
-    struct symtab *cp_namespace_symtab;
+    /* Place to stash various statistics about this objfile.  */
+    OBJSTATS;
 
     /* A linked list of symbols created when reading template types or
        function templates.  These symbols are not stored in any symbol
@@ -401,7 +389,7 @@ struct objfile
     struct symbol *template_symbols;
   };
 
-/* Defines for the objfile flag word. */
+/* Defines for the objfile flag word.  */
 
 /* When an object file has its functions reordered (currently Irix-5.2
    shared libraries exhibit this behaviour), we will need an expensive
@@ -412,7 +400,7 @@ struct objfile
 #define OBJF_REORDERED (1 << 0)        /* Functions are reordered */
 
 /* Distinguish between an objfile for a shared library and a "vanilla"
-   objfile. (If not set, the objfile may still actually be a solib.
+   objfile.  (If not set, the objfile may still actually be a solib.
    This can happen if the user created the objfile by using the
    add-symbol-file command.  GDB doesn't in that situation actually
    check whether the file is a solib.  Rather, the target's
@@ -421,7 +409,7 @@ struct objfile
 
 #define OBJF_SHARED     (1 << 1)       /* From a shared library */
 
-/* User requested that this objfile be read in it's entirety. */
+/* User requested that this objfile be read in it's entirety.  */
 
 #define OBJF_READNOW   (1 << 2)        /* Immediate full read */
 
@@ -430,30 +418,25 @@ struct objfile
    for run_command to remove old objfile entries which are no longer
    valid (i.e., are associated with an old inferior), but to preserve
    ones that the user explicitly loaded via the add-symbol-file
-   command. */
+   command.  */
 
 #define OBJF_USERLOADED        (1 << 3)        /* User loaded */
 
+/* Set if we have tried to read partial symtabs for this objfile.
+   This is used to allow lazy reading of partial symtabs.  */
+
+#define OBJF_PSYMTABS_READ (1 << 4)
+
+/* Set if this is the main symbol file
+   (as opposed to symbol file for dynamically loaded code).  */
+
+#define OBJF_MAINLINE (1 << 5)
+
 /* The object file that contains the runtime common minimal symbols
-   for SunOS4. Note that this objfile has no associated BFD.  */
+   for SunOS4.  Note that this objfile has no associated BFD.  */
 
 extern struct objfile *rt_common_objfile;
 
-/* When we need to allocate a new type, we need to know which objfile_obstack
-   to allocate the type on, since there is one for each objfile.  The places
-   where types are allocated are deeply buried in function call hierarchies
-   which know nothing about objfiles, so rather than trying to pass a
-   particular objfile down to them, we just do an end run around them and
-   set current_objfile to be whatever objfile we expect to be using at the
-   time types are being allocated.  For instance, when we start reading
-   symbols for a particular objfile, we set current_objfile to point to that
-   objfile, and when we are done, we set it back to NULL, to ensure that we
-   never put a type someplace other than where we are expecting to put it.
-   FIXME:  Maybe we should review the entire type handling system and
-   see if there is a better way to avoid this problem. */
-
-extern struct objfile *current_objfile;
-
 /* Declarations for functions defined in objfiles.c */
 
 extern struct objfile *allocate_objfile (bfd *, int);
@@ -466,7 +449,7 @@ extern int entry_point_address_query (CORE_ADDR *entry_p);
 
 extern CORE_ADDR entry_point_address (void);
 
-extern int build_objfile_section_table (struct objfile *);
+extern void build_objfile_section_table (struct objfile *);
 
 extern void terminate_minimal_symbol_table (struct objfile *objfile);
 
@@ -505,8 +488,8 @@ extern void objfiles_changed (void);
 
 /* This operation deletes all objfile entries that represent solibs that
    weren't explicitly loaded by the user, via e.g., the add-symbol-file
-   command.
- */
+   command.  */
+
 extern void objfile_purge_solibs (void);
 
 /* Functions for dealing with the minimal symbol table, really a misc
@@ -636,8 +619,7 @@ extern int gdb_bfd_close_or_warn (struct bfd *abfd);
       loop's loop expression, advance OBJFILE, but iff the inner loop
       reached its end.  If not, there was a "break;", so leave OBJFILE
       as is; the outer loop's conditional will break immediately as
-      well (as OSECT will be different from OBJFILE->sections_end).
-*/
+      well (as OSECT will be different from OBJFILE->sections_end).  */
 
 #define ALL_OBJSECTIONS(objfile, osect)                                        \
   for ((objfile) = current_program_space->objfiles,                    \
@@ -671,8 +653,8 @@ extern int gdb_bfd_close_or_warn (struct bfd *abfd);
       : objfile->sect_index_text)
 
 /* Sometimes the .bss section is missing from the objfile, so we don't
-   want to die here. Let the users of SECT_OFF_BSS deal with an
-   uninitialized section index. */
+   want to die here.  Let the users of SECT_OFF_BSS deal with an
+   uninitialized section index.  */
 #define SECT_OFF_BSS(objfile) (objfile)->sect_index_bss
 
 /* Answer whether there is more than one object file loaded.  */
This page took 0.048634 seconds and 4 git commands to generate.