HPPA merge.
[deliverable/binutils-gdb.git] / gdb / objfiles.c
index 1bba838c40cce26765c25786bceb072710852b49..9b30c0fb4dc657874a57da494b00339419da6e99 100644 (file)
@@ -21,76 +21,174 @@ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
 /* This file contains support routines for creating, manipulating, and
    destroying objfile structures. */
 
-#include <stdio.h>
 #include "defs.h"
 #include "bfd.h"               /* Binary File Description */
 #include "symtab.h"
 #include "symfile.h"
+#include "objfiles.h"
 
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <fcntl.h>
 #include <obstack.h>
 
-/* Externally visible variables that are owned by this module. */
+/* Prototypes for local functions */
+
+#if !defined(NO_MMALLOC) && defined(HAVE_MMAP)
+
+static int
+open_existing_mapped_file PARAMS ((char *, long, int));
+
+static int
+open_mapped_file PARAMS ((char *filename, long mtime, int mapped));
+
+static CORE_ADDR
+map_to_address PARAMS ((void));
+
+#endif  /* !defined(NO_MMALLOC) && defined(HAVE_MMAP) */
+
+/* Message to be printed before the error message, when an error occurs.  */
+
+extern char *error_pre_print;
+
+/* Externally visible variables that are owned by this module.
+   See declarations in objfile.h for more info. */
 
 struct objfile *object_files;          /* Linked list of all objfiles */
+struct objfile *current_objfile;       /* For symbol file being read in */
+struct objfile *symfile_objfile;       /* Main symbol table loaded from */
 
-/* Allocate a new objfile struct, fill it in as best we can, and return it.
-   It is also linked into the list of all known object files. */
+int mapped_symbol_files;               /* Try to use mapped symbol files */
+
+/* Given a pointer to an initialized bfd (ABFD) and a flag that indicates
+   whether or not an objfile is to be mapped (MAPPED), allocate a new objfile
+   struct, fill it in as best we can, link it into the list of all known
+   objfiles, and return a pointer to the new objfile struct. */
 
 struct objfile *
-allocate_objfile (abfd, filename, dumpable)
+allocate_objfile (abfd, mapped)
      bfd *abfd;
-     char *filename;
-    int dumpable;
+     int mapped;
 {
-  struct objfile *objfile;
+  struct objfile *objfile = NULL;
+  int fd;
+  void *md;
+  CORE_ADDR mapto;
+
+  mapped |= mapped_symbol_files;
+
+#if !defined(NO_MMALLOC) && defined(HAVE_MMAP)
+
+  /* If we can support mapped symbol files, try to open/reopen the mapped file
+     that corresponds to the file from which we wish to read symbols.  If the
+     objfile is to be mapped, we must malloc the structure itself using the
+     mmap version, and arrange that all memory allocation for the objfile uses
+     the mmap routines.  If we are reusing an existing mapped file, from which
+     we get our objfile pointer, we have to make sure that we update the
+     pointers to the alloc/free functions in the obstack, in case these
+     functions have moved within the current gdb. */
+
+  fd = open_mapped_file (bfd_get_filename (abfd), bfd_get_mtime (abfd),
+                        mapped);
+  if (fd >= 0)
+    {
+      if (((mapto = map_to_address ()) == 0) ||
+         ((md = mmalloc_attach (fd, (void *) mapto)) == NULL))
+       {
+         (void) close (fd);
+       }
+      else if ((objfile = (struct objfile *) mmalloc_getkey (md, 0)) != NULL)
+       {
+         /* Update memory corruption handler function addresses. */
+         init_malloc (md);
+         objfile -> md = md;
+         objfile -> mmfd = fd;
+         /* Update pointers to functions to *our* copies */
+         obstack_chunkfun (&objfile -> psymbol_obstack, xmmalloc);
+         obstack_freefun (&objfile -> psymbol_obstack, mfree);
+         obstack_chunkfun (&objfile -> symbol_obstack, xmmalloc);
+         obstack_freefun (&objfile -> symbol_obstack, mfree);
+         obstack_chunkfun (&objfile -> type_obstack, xmmalloc);
+         obstack_freefun (&objfile -> type_obstack, mfree);
+         /* If already in objfile list, unlink it. */
+         unlink_objfile (objfile);
+         /* Forget things specific to a particular gdb, may have changed. */
+         objfile -> sf = NULL;
+       }
+      else
+       {
+         /* Set up to detect internal memory corruption.  MUST be done before
+            the first malloc.  See comments in init_malloc() and mmcheck(). */
+         init_malloc (md);
+         objfile = (struct objfile *) xmmalloc (md, sizeof (struct objfile));
+         (void) memset (objfile, 0, sizeof (struct objfile));
+         objfile -> md = md;
+         objfile -> mmfd = fd;
+         objfile -> flags |= OBJF_MAPPED;
+         mmalloc_setkey (objfile -> md, 0, objfile);
+         obstack_full_begin (&objfile -> psymbol_obstack, 0, 0,
+                             xmmalloc, mfree, objfile -> md,
+                             OBSTACK_MMALLOC_LIKE);
+         obstack_full_begin (&objfile -> symbol_obstack, 0, 0,
+                             xmmalloc, mfree, objfile -> md,
+                             OBSTACK_MMALLOC_LIKE);
+         obstack_full_begin (&objfile -> type_obstack, 0, 0,
+                             xmmalloc, mfree, objfile -> md,
+                             OBSTACK_MMALLOC_LIKE);
+       }
+    }
+
+  if (mapped && (objfile == NULL))
+    {
+      warning ("symbol table for '%s' will not be mapped",
+              bfd_get_filename (abfd));
+    }
 
-  /* First, if the objfile is to be dumpable, we must malloc the structure
-     itself using the mmap version, and arrange that all memory allocation
-     for the objfile uses the mmap routines.  Otherwise, just use the
-     old sbrk'd malloc routines. */
+#else  /* defined(NO_MMALLOC) || !defined(HAVE_MMAP) */
 
-  if (dumpable)
+  if (mapped)
     {
-      objfile = (struct objfile *) mmap_xmalloc (sizeof (struct objfile));
-      (void) memset (objfile, 0, sizeof (struct objfile));
-      objfile -> malloc = mmap_malloc;
-      objfile -> realloc = mmap_realloc;
-      objfile -> xmalloc = mmap_xmalloc;
-      objfile -> xrealloc = mmap_xrealloc;
-      objfile -> free = mmap_free;
-      objfile -> flags |= OBJF_DUMPABLE;
+      warning ("this version of gdb does not support mapped symbol tables.");
+
+      /* Turn off the global flag so we don't try to do mapped symbol tables
+        any more, which shuts up gdb unless the user specifically gives the
+        "mapped" keyword again. */
+
+      mapped_symbol_files = 0;
     }
-  else
+
+#endif /* !defined(NO_MMALLOC) && defined(HAVE_MMAP) */
+
+  /* If we don't support mapped symbol files, didn't ask for the file to be
+     mapped, or failed to open the mapped file for some reason, then revert
+     back to an unmapped objfile. */
+
+  if (objfile == NULL)
     {
       objfile = (struct objfile *) xmalloc (sizeof (struct objfile));
       (void) memset (objfile, 0, sizeof (struct objfile));
-      objfile -> malloc = xmalloc;
-      objfile -> realloc = xrealloc;
-      objfile -> xmalloc = xmalloc;
-      objfile -> xrealloc = xrealloc;
-      objfile -> free = free;
-    }
+      objfile -> md = NULL;
+      obstack_full_begin (&objfile -> psymbol_obstack, 0, 0, xmalloc, free,
+                         (void *) 0, 0);
+      obstack_full_begin (&objfile -> symbol_obstack, 0, 0, xmalloc, free,
+                         (void *) 0, 0);
+      obstack_full_begin (&objfile -> type_obstack, 0, 0, xmalloc, free,
+                         (void *) 0, 0);
 
-  /* Now, malloc a fresh copy of the filename string using the malloc
-     specified as appropriate for the objfile. */
+    }
 
-  objfile -> name = (*objfile -> xmalloc) (strlen (filename) + 1);
-  strcpy (objfile -> name, filename);
+  /* Update the per-objfile information that comes from the bfd, ensuring
+     that any data that is reference is saved in the per-objfile data
+     region. */
 
   objfile -> obfd = abfd;
-
+  if (objfile -> name != NULL)
+    {
+      mfree (objfile -> md, objfile -> name);
+    }
+  objfile -> name = mstrsave (objfile -> md, bfd_get_filename (abfd));
   objfile -> mtime = bfd_get_mtime (abfd);
 
-  /* Set up the various obstacks to use the memory allocation/free
-     functions that are appropriate for this objfile. */
-
-  obstack_full_begin (&objfile -> psymbol_obstack, 0, 0,
-                     objfile -> xmalloc, objfile -> free);
-  obstack_full_begin (&objfile -> symbol_obstack, 0, 0,
-                     objfile -> xmalloc, objfile -> free);
-  obstack_full_begin (&objfile -> type_obstack, 0, 0,
-                     objfile -> xmalloc, objfile -> free);
-
   /* Push this file onto the head of the linked list of other such files. */
 
   objfile -> next = object_files;
@@ -99,48 +197,84 @@ allocate_objfile (abfd, filename, dumpable)
   return (objfile);
 }
 
+/* Unlink OBJFILE from the list of known objfiles, if it is found in the
+   list.
+
+   It is not a bug, or error, to call this function if OBJFILE is not known
+   to be in the current list.  This is done in the case of mapped objfiles,
+   for example, just to ensure that the mapped objfile doesn't appear twice
+   in the list.  Since the list is threaded, linking in a mapped objfile
+   twice would create a circular list.
+
+   If OBJFILE turns out to be in the list, we zap it's NEXT pointer after
+   unlinking it, just to ensure that we have completely severed any linkages
+   between the OBJFILE and the list. */
+
+void
+unlink_objfile (objfile)
+     struct objfile *objfile;
+{
+  struct objfile** objpp;
+
+  for (objpp = &object_files; *objpp != NULL; objpp = &((*objpp) -> next))
+    {
+      if (*objpp == objfile) 
+       {
+         *objpp = (*objpp) -> next;
+         objfile -> next = NULL;
+         break;
+       }
+    }
+}
+
 
 /* Destroy an objfile and all the symtabs and psymtabs under it.  Note
    that as much as possible is allocated on the symbol_obstack and
-   psymbol_obstack, so that the memory can be efficiently freed. */
+   psymbol_obstack, so that the memory can be efficiently freed.
+
+   Things which we do NOT free because they are not in malloc'd memory
+   or not in memory specific to the objfile include:
+
+       objfile -> sf
+
+   FIXME:  If the objfile is using reusable symbol information (via mmalloc),
+   then we need to take into account the fact that more than one process
+   may be using the symbol information at the same time (when mmalloc is
+   extended to support cooperative locking).  When more than one process
+   is using the mapped symbol info, we need to be more careful about when
+   we free objects in the reusable area. */
 
 void
 free_objfile (objfile)
      struct objfile *objfile;
 {
   struct objfile *ofp;
+  int mmfd;
+
+  /* First do any symbol file specific actions required when we are
+     finished with a particular symbol file.  Note that if the objfile
+     is using reusable symbol information (via mmalloc) then each of
+     these routines is responsible for doing the correct thing, either
+     freeing things which are valid only during this particular gdb
+     execution, or leaving them to be reused during the next one. */
 
-  if (objfile -> name)
+  if (objfile -> sf != NULL)
     {
-      (*objfile -> free) (objfile -> name);
-    }
-  if (objfile -> obfd)
-    {
-      bfd_close (objfile -> obfd);
+      (*objfile -> sf -> sym_finish) (objfile);
     }
 
-  /* Remove it from the chain of all objfiles.  */
+  /* We always close the bfd. */
 
-  if (object_files == objfile)
-    {
-      object_files = objfile -> next;
-    }
-  else
+  if (objfile -> obfd != NULL)
     {
-      for (ofp = object_files; ofp; ofp = ofp -> next)
-       {
-         if (ofp -> next == objfile)
-           {
-             ofp -> next = objfile -> next;
-           }
-       }
+      char *name = bfd_get_filename (objfile->obfd);
+      bfd_close (objfile -> obfd);
+      free (name);
     }
 
-  obstack_free (&objfile -> psymbol_obstack, 0);
-  obstack_free (&objfile -> symbol_obstack, 0);
-  obstack_free (&objfile -> type_obstack, 0);
+  /* Remove it from the chain of all objfiles. */
 
-#if 0  /* FIXME!! */
+  unlink_objfile (objfile);
 
   /* Before the symbol table code was redone to make it easier to
      selectively load and remove information particular to a specific
@@ -155,12 +289,45 @@ free_objfile (objfile)
 #endif
   clear_pc_function_cache ();
 
-#endif
+  /* The last thing we do is free the objfile struct itself for the
+     non-reusable case, or detach from the mapped file for the reusable
+     case.  Note that the mmalloc_detach or the mfree is the last thing
+     we can do with this objfile. */
+
+#if !defined(NO_MMALLOC) && defined(HAVE_MMAP)
+
+  if (objfile -> flags & OBJF_MAPPED)
+    {
+      /* Remember the fd so we can close it.  We can't close it before
+        doing the detach, and after the detach the objfile is gone. */
+      mmfd = objfile -> mmfd;
+      mmalloc_detach (objfile -> md);
+      objfile = NULL;
+      (void) close (mmfd);
+    }
 
-  /* The last thing we do is free the objfile struct itself, using the
-     free() that is appropriate for the objfile. */
+#endif /* !defined(NO_MMALLOC) && defined(HAVE_MMAP) */
 
-  (*objfile -> free) (objfile);
+  /* If we still have an objfile, then either we don't support reusable
+     objfiles or this one was not reusable.  So free it normally. */
+
+  if (objfile != NULL)
+    {
+      if (objfile -> name != NULL)
+       {
+         mfree (objfile -> md, objfile -> name);
+       }
+      if (objfile->global_psymbols.list)
+       mfree (objfile->md, objfile->global_psymbols.list);
+      if (objfile->static_psymbols.list)
+       mfree (objfile->md, objfile->static_psymbols.list);
+      /* Free the obstacks for non-reusable objfiles */
+      obstack_free (&objfile -> psymbol_obstack, 0);
+      obstack_free (&objfile -> symbol_obstack, 0);
+      obstack_free (&objfile -> type_obstack, 0);
+      mfree (objfile -> md, objfile);
+      objfile = NULL;
+    }
 }
 
 
@@ -185,17 +352,15 @@ int
 have_partial_symbols ()
 {
   struct objfile *ofp;
-  int havethem = 0;
 
-  for (ofp = object_files; ofp; ofp = ofp -> next)
+  ALL_OBJFILES (ofp)
     {
       if (ofp -> psymtabs != NULL)
        {
-         havethem++;
-         break;
+         return 1;
        }
     }
-  return (havethem);
+  return 0;
 }
 
 /* Many places in gdb want to test just to see if we have any full
@@ -206,17 +371,15 @@ int
 have_full_symbols ()
 {
   struct objfile *ofp;
-  int havethem = 0;
 
-  for (ofp = object_files; ofp; ofp = ofp -> next)
+  ALL_OBJFILES (ofp)
     {
       if (ofp -> symtabs != NULL)
        {
-         havethem++;
-         break;
+         return 1;
        }
     }
-  return (havethem);
+  return 0;
 }
 
 /* Many places in gdb want to test just to see if we have any minimal
@@ -227,114 +390,184 @@ int
 have_minimal_symbols ()
 {
   struct objfile *ofp;
-  int havethem = 0;
 
-  for (ofp = object_files; ofp; ofp = ofp -> next)
+  ALL_OBJFILES (ofp)
     {
       if (ofp -> msymbols != NULL)
        {
-         havethem++;
-         break;
+         return 1;
        }
     }
-  return (havethem);
+  return 0;
 }
 
-/* Call the function specified by FUNC for each currently available objfile,
-   for as long as this function continues to return NULL.  If the function
-   ever returns non-NULL, then the iteration over the objfiles is terminated,
-   and the result is returned to the caller.  The function called has full
-   control over the form and content of the information returned via the
-   non-NULL result, which may be as simple as a pointer to the objfile that
-   the iteration terminated on, or as complex as a pointer to a private
-   structure containing multiple results. */
-
-PTR
-iterate_over_objfiles (func, arg1, arg2, arg3)
-     PTR (*func) PARAMS ((struct objfile *, PTR, PTR, PTR));
-     PTR arg1;
-     PTR arg2;
-     PTR arg3;
-{
-  register struct objfile *objfile;
-  PTR result = NULL;
+#if !defined(NO_MMALLOC) && defined(HAVE_MMAP)
 
-  for (objfile = object_files;
-       objfile != NULL && result == NULL;
-       objfile = objfile -> next)
-    {
-      result = (*func)(objfile, arg1, arg2, arg3);
-    }
-  return (result);
-}
+/* Given the name of a mapped symbol file in SYMSFILENAME, and the timestamp
+   of the corresponding symbol file in MTIME, try to open an existing file
+   with the name SYMSFILENAME and verify it is more recent than the base
+   file by checking it's timestamp against MTIME.
+
+   If SYMSFILENAME does not exist (or can't be stat'd), simply returns -1.
 
-/* Call the function specified by FUNC for each currently available symbol
-   table, for as long as this function continues to return NULL.  If the
-   function ever returns non-NULL, then the iteration over the symbol tables
-   is terminated, and the result is returned to the caller.  The function
-   called has full control over the form and content of the information
-   returned via the non-NULL result, which may be as simple as a pointer
-   to the symtab that the iteration terminated on, or as complex as a
-   pointer to a private structure containing multiple results. */
-
-PTR 
-iterate_over_symtabs (func, arg1, arg2, arg3)
-     PTR (*func) PARAMS ((struct objfile *, struct symtab *, PTR, PTR, PTR));
-     PTR arg1;
-     PTR arg2;
-     PTR arg3;
+   If SYMSFILENAME does exist, but is out of date, we check to see if the
+   user has specified creation of a mapped file.  If so, we don't issue
+   any warning message because we will be creating a new mapped file anyway,
+   overwriting the old one.  If not, then we issue a warning message so that
+   the user will know why we aren't using this existing mapped symbol file.
+   In either case, we return -1.
+
+   If SYMSFILENAME does exist and is not out of date, but can't be opened for
+   some reason, then prints an appropriate system error message and returns -1.
+
+   Otherwise, returns the open file descriptor.  */
+
+static int
+open_existing_mapped_file (symsfilename, mtime, mapped)
+     char *symsfilename;
+     long mtime;
+     int mapped;
 {
-  register struct objfile *objfile;
-  register struct symtab *symtab;
-  PTR result = NULL;
+  int fd = -1;
+  struct stat sbuf;
 
-  for (objfile = object_files;
-       objfile != NULL && result == NULL;
-       objfile = objfile -> next)
+  if (stat (symsfilename, &sbuf) == 0)
     {
-      for (symtab = objfile -> symtabs;
-          symtab != NULL && result == NULL;
-          symtab = symtab -> next)
+      if (sbuf.st_mtime < mtime)
        {
-         result = (*func)(objfile, symtab, arg1, arg2, arg3);
+         if (!mapped)
+           {
+             warning ("mapped symbol file `%s' is out of date", symsfilename);
+           }
+       }
+      else if ((fd = open (symsfilename, O_RDWR)) < 0)
+       {
+         if (error_pre_print)
+           {
+             printf (error_pre_print);
+           }
+         print_sys_errmsg (symsfilename, errno);
        }
     }
-  return (result);
+  return (fd);
 }
 
-/* Call the function specified by FUNC for each currently available partial
-   symbol table, for as long as this function continues to return NULL.  If
-   the function ever returns non-NULL, then the iteration over the partial
-   symbol tables is terminated, and the result is returned to the caller.
-
-   The function called has full control over the form and content of the
-   information returned via the non-NULL result, which may be as simple as a
-   pointer to the partial symbol table that the iteration terminated on, or
-   as complex as a pointer to a private structure containing multiple
-   results. */
-
-PTR 
-iterate_over_psymtabs (func, arg1, arg2, arg3)
-     PTR (*func) PARAMS ((struct objfile *, struct partial_symtab *,
-                         PTR, PTR, PTR));
-     PTR arg1;
-     PTR arg2;
-     PTR arg3;
+/* Look for a mapped symbol file that corresponds to FILENAME and is more
+   recent than MTIME.  If MAPPED is nonzero, the user has asked that gdb
+   use a mapped symbol file for this file, so create a new one if one does
+   not currently exist.
+
+   If found, then return an open file descriptor for the file, otherwise
+   return -1.
+
+   This routine is responsible for implementing the policy that generates
+   the name of the mapped symbol file from the name of a file containing
+   symbols that gdb would like to read.  Currently this policy is to append
+   ".syms" to the name of the file.
+
+   This routine is also responsible for implementing the policy that
+   determines where the mapped symbol file is found (the search path).
+   This policy is that when reading an existing mapped file, a file of
+   the correct name in the current directory takes precedence over a
+   file of the correct name in the same directory as the symbol file.
+   When creating a new mapped file, it is always created in the current
+   directory.  This helps to minimize the chances of a user unknowingly
+   creating big mapped files in places like /bin and /usr/local/bin, and
+   allows a local copy to override a manually installed global copy (in
+   /bin for example).  */
+
+static int
+open_mapped_file (filename, mtime, mapped)
+     char *filename;
+     long mtime;
+     int mapped;
 {
-  register struct objfile *objfile;
-  register struct partial_symtab *psymtab;
-  PTR result = NULL;
+  int fd;
+  char *symsfilename;
+
+  /* First try to open an existing file in the current directory, and
+     then try the directory where the symbol file is located. */
 
-  for (objfile = object_files;
-       objfile != NULL && result == NULL;
-       objfile = objfile -> next)
+  symsfilename = concat ("./", basename (filename), ".syms", (char *) NULL);
+  if ((fd = open_existing_mapped_file (symsfilename, mtime, mapped)) < 0)
     {
-      for (psymtab = objfile -> psymtabs;
-          psymtab != NULL && result == NULL;
-          psymtab = psymtab -> next)
+      free (symsfilename);
+      symsfilename = concat (filename, ".syms", (char *) NULL);
+      fd = open_existing_mapped_file (symsfilename, mtime, mapped);
+    }
+
+  /* If we don't have an open file by now, then either the file does not
+     already exist, or the base file has changed since it was created.  In
+     either case, if the user has specified use of a mapped file, then
+     create a new mapped file, truncating any existing one.  If we can't
+     create one, print a system error message saying why we can't.
+
+     By default the file is rw for everyone, with the user's umask taking
+     care of turning off the permissions the user wants off. */
+
+  if ((fd < 0) && mapped)
+    {
+      free (symsfilename);
+      symsfilename = concat ("./", basename (filename), ".syms",
+                            (char *) NULL);
+      if ((fd = open (symsfilename, O_RDWR | O_CREAT | O_TRUNC, 0666)) < 0)
        {
-         result = (*func)(objfile, psymtab, arg1, arg2, arg3);
+         if (error_pre_print)
+           {
+             printf (error_pre_print);
+           }
+         print_sys_errmsg (symsfilename, errno);
        }
     }
-  return (result);
+
+  free (symsfilename);
+  return (fd);
+}
+
+/* Return the base address at which we would like the next objfile's
+   mapped data to start.
+
+   For now, we use the kludge that the configuration specifies a base
+   address to which it is safe to map the first mmalloc heap, and an
+   increment to add to this address for each successive heap.  There are
+   a lot of issues to deal with here to make this work reasonably, including:
+
+     Avoid memory collisions with existing mapped address spaces
+
+     Reclaim address spaces when their mmalloc heaps are unmapped
+
+     When mmalloc heaps are shared between processes they have to be
+     mapped at the same addresses in each
+
+     Once created, a mmalloc heap that is to be mapped back in must be
+     mapped at the original address.  I.E. each objfile will expect to
+     be remapped at it's original address.  This becomes a problem if
+     the desired address is already in use.
+
+     etc, etc, etc.
+
+ */
+
+
+static CORE_ADDR
+map_to_address ()
+{
+
+#if defined(MMAP_BASE_ADDRESS) && defined (MMAP_INCREMENT)
+
+  static CORE_ADDR next = MMAP_BASE_ADDRESS;
+  CORE_ADDR mapto = next;
+
+  next += MMAP_INCREMENT;
+  return (mapto);
+
+#else
+
+  return (0);
+
+#endif
+
 }
+
+#endif /* !defined(NO_MMALLOC) && defined(HAVE_MMAP) */
+
This page took 0.0316959999999999 seconds and 4 git commands to generate.