gdb/objfiles.c

   1 /* GDB routines for manipulating objfiles.
   2    Copyright 1992 Free Software Foundation, Inc.
   3    Contributed by Cygnus Support, using pieces from other GDB modules.
   4
   5 This file is part of GDB.
   6
   7 This program is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 2 of the License, or
  10 (at your option) any later version.
  11
  12 This program is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with this program; if not, write to the Free Software
  19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
  20
  21 /* This file contains support routines for creating, manipulating, and
  22    destroying objfile structures. */
  23
  24 #include "defs.h"
  25 #include "bfd.h"                /* Binary File Description */
  26 #include "symtab.h"
  27 #include "symfile.h"
  28 #include "objfiles.h"
  29
  30 #include <sys/types.h>
  31 #include <sys/stat.h>
  32 #include <fcntl.h>
  33 #include <obstack.h>
  34
  35 /* Prototypes for local functions */
  36
  37 #if !defined(NO_MMALLOC) && defined(HAVE_MMAP)
  38
  39 static int
  40 open_existing_mapped_file PARAMS ((char *, long, int));
  41
  42 static int
  43 open_mapped_file PARAMS ((char *filename, long mtime, int mapped));
  44
  45 static CORE_ADDR
  46 map_to_address PARAMS ((void));
  47
  48 #endif  /* !defined(NO_MMALLOC) && defined(HAVE_MMAP) */
  49
  50 /* Message to be printed before the error message, when an error occurs.  */
  51
  52 extern char *error_pre_print;
  53
  54 /* Externally visible variables that are owned by this module.
  55    See declarations in objfile.h for more info. */
  56
  57 struct objfile *object_files;           /* Linked list of all objfiles */
  58 struct objfile *current_objfile;        /* For symbol file being read in */
  59 struct objfile *symfile_objfile;        /* Main symbol table loaded from */
  60
  61 int mapped_symbol_files;                /* Try to use mapped symbol files */
  62
  63 /* Given a pointer to an initialized bfd (ABFD) and a flag that indicates
  64    whether or not an objfile is to be mapped (MAPPED), allocate a new objfile
  65    struct, fill it in as best we can, link it into the list of all known
  66    objfiles, and return a pointer to the new objfile struct. */
  67
  68 struct objfile *
  69 allocate_objfile (abfd, mapped)
  70      bfd *abfd;
  71      int mapped;
  72 {
  73   struct objfile *objfile = NULL;
  74   int fd;
  75   void *md;
  76   CORE_ADDR mapto;
  77
  78   mapped |= mapped_symbol_files;
  79
  80 #if !defined(NO_MMALLOC) && defined(HAVE_MMAP)
  81
  82   /* If we can support mapped symbol files, try to open/reopen the mapped file
  83      that corresponds to the file from which we wish to read symbols.  If the
  84      objfile is to be mapped, we must malloc the structure itself using the
  85      mmap version, and arrange that all memory allocation for the objfile uses
  86      the mmap routines.  If we are reusing an existing mapped file, from which
  87      we get our objfile pointer, we have to make sure that we update the
  88      pointers to the alloc/free functions in the obstack, in case these
  89      functions have moved within the current gdb. */
  90
  91   fd = open_mapped_file (bfd_get_filename (abfd), bfd_get_mtime (abfd),
  92                          mapped);
  93   if (fd >= 0)
  94     {
  95       if (((mapto = map_to_address ()) == 0) ||
  96           ((md = mmalloc_attach (fd, (void *) mapto)) == NULL))
  97         {
  98           (void) close (fd);
  99         }
 100       else if ((objfile = (struct objfile *) mmalloc_getkey (md, 0)) != NULL)
 101         {
 102           /* Update memory corruption handler function addresses. */
 103           init_malloc (md);
 104           objfile -> md = md;
 105           objfile -> mmfd = fd;
 106           /* Update pointers to functions to *our* copies */
 107           obstack_chunkfun (&objfile -> psymbol_obstack, xmmalloc);
 108           obstack_freefun (&objfile -> psymbol_obstack, mfree);
 109           obstack_chunkfun (&objfile -> symbol_obstack, xmmalloc);
 110           obstack_freefun (&objfile -> symbol_obstack, mfree);
 111           obstack_chunkfun (&objfile -> type_obstack, xmmalloc);
 112           obstack_freefun (&objfile -> type_obstack, mfree);
 113           /* If already in objfile list, unlink it. */
 114           unlink_objfile (objfile);
 115           /* Forget things specific to a particular gdb, may have changed. */
 116           objfile -> sf = NULL;
 117         }
 118       else
 119         {
 120           /* Set up to detect internal memory corruption.  MUST be done before
 121              the first malloc.  See comments in init_malloc() and mmcheck(). */
 122           init_malloc (md);
 123           objfile = (struct objfile *) xmmalloc (md, sizeof (struct objfile));
 124           (void) memset (objfile, 0, sizeof (struct objfile));
 125           objfile -> md = md;
 126           objfile -> mmfd = fd;
 127           objfile -> flags |= OBJF_MAPPED;
 128           mmalloc_setkey (objfile -> md, 0, objfile);
 129           obstack_full_begin (&objfile -> psymbol_obstack, 0, 0,
 130                               xmmalloc, mfree, objfile -> md,
 131                               OBSTACK_MMALLOC_LIKE);
 132           obstack_full_begin (&objfile -> symbol_obstack, 0, 0,
 133                               xmmalloc, mfree, objfile -> md,
 134                               OBSTACK_MMALLOC_LIKE);
 135           obstack_full_begin (&objfile -> type_obstack, 0, 0,
 136                               xmmalloc, mfree, objfile -> md,
 137                               OBSTACK_MMALLOC_LIKE);
 138         }
 139     }
 140
 141   if (mapped && (objfile == NULL))
 142     {
 143       warning ("symbol table for '%s' will not be mapped",
 144                bfd_get_filename (abfd));
 145     }
 146
 147 #else   /* defined(NO_MMALLOC) || !defined(HAVE_MMAP) */
 148
 149   if (mapped)
 150     {
 151       warning ("this version of gdb does not support mapped symbol tables.");
 152
 153       /* Turn off the global flag so we don't try to do mapped symbol tables
 154          any more, which shuts up gdb unless the user specifically gives the
 155          "mapped" keyword again. */
 156
 157       mapped_symbol_files = 0;
 158     }
 159
 160 #endif  /* !defined(NO_MMALLOC) && defined(HAVE_MMAP) */
 161
 162   /* If we don't support mapped symbol files, didn't ask for the file to be
 163      mapped, or failed to open the mapped file for some reason, then revert
 164      back to an unmapped objfile. */
 165
 166   if (objfile == NULL)
 167     {
 168       objfile = (struct objfile *) xmalloc (sizeof (struct objfile));
 169       (void) memset (objfile, 0, sizeof (struct objfile));
 170       objfile -> md = NULL;
 171       obstack_full_begin (&objfile -> psymbol_obstack, 0, 0, xmalloc, free,
 172                           (void *) 0, 0);
 173       obstack_full_begin (&objfile -> symbol_obstack, 0, 0, xmalloc, free,
 174                           (void *) 0, 0);
 175       obstack_full_begin (&objfile -> type_obstack, 0, 0, xmalloc, free,
 176                           (void *) 0, 0);
 177
 178     }
 179
 180   /* Update the per-objfile information that comes from the bfd, ensuring
 181      that any data that is reference is saved in the per-objfile data
 182      region. */
 183
 184   objfile -> obfd = abfd;
 185   if (objfile -> name != NULL)
 186     {
 187       mfree (objfile -> md, objfile -> name);
 188     }
 189   objfile -> name = mstrsave (objfile -> md, bfd_get_filename (abfd));
 190   objfile -> mtime = bfd_get_mtime (abfd);
 191
 192   /* Push this file onto the head of the linked list of other such files. */
 193
 194   objfile -> next = object_files;
 195   object_files = objfile;
 196
 197   return (objfile);
 198 }
 199
 200 /* Unlink OBJFILE from the list of known objfiles, if it is found in the
 201    list.
 202
 203    It is not a bug, or error, to call this function if OBJFILE is not known
 204    to be in the current list.  This is done in the case of mapped objfiles,
 205    for example, just to ensure that the mapped objfile doesn't appear twice
 206    in the list.  Since the list is threaded, linking in a mapped objfile
 207    twice would create a circular list.
 208
 209    If OBJFILE turns out to be in the list, we zap it's NEXT pointer after
 210    unlinking it, just to ensure that we have completely severed any linkages
 211    between the OBJFILE and the list. */
 212
 213 void
 214 unlink_objfile (objfile)
 215      struct objfile *objfile;
 216 {
 217   struct objfile** objpp;
 218
 219   for (objpp = &object_files; *objpp != NULL; objpp = &((*objpp) -> next))
 220     {
 221       if (*objpp == objfile)
 222         {
 223           *objpp = (*objpp) -> next;
 224           objfile -> next = NULL;
 225           break;
 226         }
 227     }
 228 }
 229
 230
 231 /* Destroy an objfile and all the symtabs and psymtabs under it.  Note
 232    that as much as possible is allocated on the symbol_obstack and
 233    psymbol_obstack, so that the memory can be efficiently freed.
 234
 235    Things which we do NOT free because they are not in malloc'd memory
 236    or not in memory specific to the objfile include:
 237
 238         objfile -> sf
 239
 240    FIXME:  If the objfile is using reusable symbol information (via mmalloc),
 241    then we need to take into account the fact that more than one process
 242    may be using the symbol information at the same time (when mmalloc is
 243    extended to support cooperative locking).  When more than one process
 244    is using the mapped symbol info, we need to be more careful about when
 245    we free objects in the reusable area. */
 246
 247 void
 248 free_objfile (objfile)
 249      struct objfile *objfile;
 250 {
 251   struct objfile *ofp;
 252   int mmfd;
 253
 254   /* First do any symbol file specific actions required when we are
 255      finished with a particular symbol file.  Note that if the objfile
 256      is using reusable symbol information (via mmalloc) then each of
 257      these routines is responsible for doing the correct thing, either
 258      freeing things which are valid only during this particular gdb
 259      execution, or leaving them to be reused during the next one. */
 260
 261   if (objfile -> sf != NULL)
 262     {
 263       (*objfile -> sf -> sym_finish) (objfile);
 264     }
 265
 266   /* We always close the bfd. */
 267
 268   if (objfile -> obfd != NULL)
 269     {
 270       char *name = bfd_get_filename (objfile->obfd);
 271       bfd_close (objfile -> obfd);
 272       free (name);
 273     }
 274
 275   /* Remove it from the chain of all objfiles. */
 276
 277   unlink_objfile (objfile);
 278
 279   /* Before the symbol table code was redone to make it easier to
 280      selectively load and remove information particular to a specific
 281      linkage unit, gdb used to do these things whenever the monolithic
 282      symbol table was blown away.  How much still needs to be done
 283      is unknown, but we play it safe for now and keep each action until
 284      it is shown to be no longer needed. */
 285
 286   clear_symtab_users_once ();
 287 #if defined (CLEAR_SOLIB)
 288   CLEAR_SOLIB ();
 289 #endif
 290   clear_pc_function_cache ();
 291
 292   /* The last thing we do is free the objfile struct itself for the
 293      non-reusable case, or detach from the mapped file for the reusable
 294      case.  Note that the mmalloc_detach or the mfree is the last thing
 295      we can do with this objfile. */
 296
 297 #if !defined(NO_MMALLOC) && defined(HAVE_MMAP)
 298
 299   if (objfile -> flags & OBJF_MAPPED)
 300     {
 301       /* Remember the fd so we can close it.  We can't close it before
 302          doing the detach, and after the detach the objfile is gone. */
 303       mmfd = objfile -> mmfd;
 304       mmalloc_detach (objfile -> md);
 305       objfile = NULL;
 306       (void) close (mmfd);
 307     }
 308
 309 #endif  /* !defined(NO_MMALLOC) && defined(HAVE_MMAP) */
 310
 311   /* If we still have an objfile, then either we don't support reusable
 312      objfiles or this one was not reusable.  So free it normally. */
 313
 314   if (objfile != NULL)
 315     {
 316       if (objfile -> name != NULL)
 317         {
 318           mfree (objfile -> md, objfile -> name);
 319         }
 320       if (objfile->global_psymbols.list)
 321         mfree (objfile->md, objfile->global_psymbols.list);
 322       if (objfile->static_psymbols.list)
 323         mfree (objfile->md, objfile->static_psymbols.list);
 324       /* Free the obstacks for non-reusable objfiles */
 325       obstack_free (&objfile -> psymbol_obstack, 0);
 326       obstack_free (&objfile -> symbol_obstack, 0);
 327       obstack_free (&objfile -> type_obstack, 0);
 328       mfree (objfile -> md, objfile);
 329       objfile = NULL;
 330     }
 331 }
 332
 333
 334 /* Free all the object files at once.  */
 335
 336 void
 337 free_all_objfiles ()
 338 {
 339   struct objfile *objfile, *temp;
 340
 341   ALL_OBJFILES_SAFE (objfile, temp)
 342     {
 343       free_objfile (objfile);
 344     }
 345 }
 346
 347 /* Many places in gdb want to test just to see if we have any partial
 348    symbols available.  This function returns zero if none are currently
 349    available, nonzero otherwise. */
 350
 351 int
 352 have_partial_symbols ()
 353 {
 354   struct objfile *ofp;
 355
 356   ALL_OBJFILES (ofp)
 357     {
 358       if (ofp -> psymtabs != NULL)
 359         {
 360           return 1;
 361         }
 362     }
 363   return 0;
 364 }
 365
 366 /* Many places in gdb want to test just to see if we have any full
 367    symbols available.  This function returns zero if none are currently
 368    available, nonzero otherwise. */
 369
 370 int
 371 have_full_symbols ()
 372 {
 373   struct objfile *ofp;
 374
 375   ALL_OBJFILES (ofp)
 376     {
 377       if (ofp -> symtabs != NULL)
 378         {
 379           return 1;
 380         }
 381     }
 382   return 0;
 383 }
 384
 385 /* Many places in gdb want to test just to see if we have any minimal
 386    symbols available.  This function returns zero if none are currently
 387    available, nonzero otherwise. */
 388
 389 int
 390 have_minimal_symbols ()
 391 {
 392   struct objfile *ofp;
 393
 394   ALL_OBJFILES (ofp)
 395     {
 396       if (ofp -> msymbols != NULL)
 397         {
 398           return 1;
 399         }
 400     }
 401   return 0;
 402 }
 403
 404 #if !defined(NO_MMALLOC) && defined(HAVE_MMAP)
 405
 406 /* Given the name of a mapped symbol file in SYMSFILENAME, and the timestamp
 407    of the corresponding symbol file in MTIME, try to open an existing file
 408    with the name SYMSFILENAME and verify it is more recent than the base
 409    file by checking it's timestamp against MTIME.
 410
 411    If SYMSFILENAME does not exist (or can't be stat'd), simply returns -1.
 412
 413    If SYMSFILENAME does exist, but is out of date, we check to see if the
 414    user has specified creation of a mapped file.  If so, we don't issue
 415    any warning message because we will be creating a new mapped file anyway,
 416    overwriting the old one.  If not, then we issue a warning message so that
 417    the user will know why we aren't using this existing mapped symbol file.
 418    In either case, we return -1.
 419
 420    If SYMSFILENAME does exist and is not out of date, but can't be opened for
 421    some reason, then prints an appropriate system error message and returns -1.
 422
 423    Otherwise, returns the open file descriptor.  */
 424
 425 static int
 426 open_existing_mapped_file (symsfilename, mtime, mapped)
 427      char *symsfilename;
 428      long mtime;
 429      int mapped;
 430 {
 431   int fd = -1;
 432   struct stat sbuf;
 433
 434   if (stat (symsfilename, &sbuf) == 0)
 435     {
 436       if (sbuf.st_mtime < mtime)
 437         {
 438           if (!mapped)
 439             {
 440               warning ("mapped symbol file `%s' is out of date", symsfilename);
 441             }
 442         }
 443       else if ((fd = open (symsfilename, O_RDWR)) < 0)
 444         {
 445           if (error_pre_print)
 446             {
 447               printf (error_pre_print);
 448             }
 449           print_sys_errmsg (symsfilename, errno);
 450         }
 451     }
 452   return (fd);
 453 }
 454
 455 /* Look for a mapped symbol file that corresponds to FILENAME and is more
 456    recent than MTIME.  If MAPPED is nonzero, the user has asked that gdb
 457    use a mapped symbol file for this file, so create a new one if one does
 458    not currently exist.
 459
 460    If found, then return an open file descriptor for the file, otherwise
 461    return -1.
 462
 463    This routine is responsible for implementing the policy that generates
 464    the name of the mapped symbol file from the name of a file containing
 465    symbols that gdb would like to read.  Currently this policy is to append
 466    ".syms" to the name of the file.
 467
 468    This routine is also responsible for implementing the policy that
 469    determines where the mapped symbol file is found (the search path).
 470    This policy is that when reading an existing mapped file, a file of
 471    the correct name in the current directory takes precedence over a
 472    file of the correct name in the same directory as the symbol file.
 473    When creating a new mapped file, it is always created in the current
 474    directory.  This helps to minimize the chances of a user unknowingly
 475    creating big mapped files in places like /bin and /usr/local/bin, and
 476    allows a local copy to override a manually installed global copy (in
 477    /bin for example).  */
 478
 479 static int
 480 open_mapped_file (filename, mtime, mapped)
 481      char *filename;
 482      long mtime;
 483      int mapped;
 484 {
 485   int fd;
 486   char *symsfilename;
 487
 488   /* First try to open an existing file in the current directory, and
 489      then try the directory where the symbol file is located. */
 490
 491   symsfilename = concat ("./", basename (filename), ".syms", (char *) NULL);
 492   if ((fd = open_existing_mapped_file (symsfilename, mtime, mapped)) < 0)
 493     {
 494       free (symsfilename);
 495       symsfilename = concat (filename, ".syms", (char *) NULL);
 496       fd = open_existing_mapped_file (symsfilename, mtime, mapped);
 497     }
 498
 499   /* If we don't have an open file by now, then either the file does not
 500      already exist, or the base file has changed since it was created.  In
 501      either case, if the user has specified use of a mapped file, then
 502      create a new mapped file, truncating any existing one.  If we can't
 503      create one, print a system error message saying why we can't.
 504
 505      By default the file is rw for everyone, with the user's umask taking
 506      care of turning off the permissions the user wants off. */
 507
 508   if ((fd < 0) && mapped)
 509     {
 510       free (symsfilename);
 511       symsfilename = concat ("./", basename (filename), ".syms",
 512                              (char *) NULL);
 513       if ((fd = open (symsfilename, O_RDWR | O_CREAT | O_TRUNC, 0666)) < 0)
 514         {
 515           if (error_pre_print)
 516             {
 517               printf (error_pre_print);
 518             }
 519           print_sys_errmsg (symsfilename, errno);
 520         }
 521     }
 522
 523   free (symsfilename);
 524   return (fd);
 525 }
 526
 527 /* Return the base address at which we would like the next objfile's
 528    mapped data to start.
 529
 530    For now, we use the kludge that the configuration specifies a base
 531    address to which it is safe to map the first mmalloc heap, and an
 532    increment to add to this address for each successive heap.  There are
 533    a lot of issues to deal with here to make this work reasonably, including:
 534
 535      Avoid memory collisions with existing mapped address spaces
 536
 537      Reclaim address spaces when their mmalloc heaps are unmapped
 538
 539      When mmalloc heaps are shared between processes they have to be
 540      mapped at the same addresses in each
 541
 542      Once created, a mmalloc heap that is to be mapped back in must be
 543      mapped at the original address.  I.E. each objfile will expect to
 544      be remapped at it's original address.  This becomes a problem if
 545      the desired address is already in use.
 546
 547      etc, etc, etc.
 548
 549  */
 550
 551
 552 static CORE_ADDR
 553 map_to_address ()
 554 {
 555
 556 #if defined(MMAP_BASE_ADDRESS) && defined (MMAP_INCREMENT)
 557
 558   static CORE_ADDR next = MMAP_BASE_ADDRESS;
 559   CORE_ADDR mapto = next;
 560
 561   next += MMAP_INCREMENT;
 562   return (mapto);
 563
 564 #else
 565
 566   return (0);
 567
 568 #endif
 569
 570 }
 571
 572 #endif  /* !defined(NO_MMALLOC) && defined(HAVE_MMAP) */
 573