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           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           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_specify_allocation_with_arg (&objfile -> psymbol_obstack,
 130                                                0, 0, xmmalloc, mfree,
 131                                                objfile -> md);
 132           obstack_specify_allocation_with_arg (&objfile -> symbol_obstack,
 133                                                0, 0, xmmalloc, mfree,
 134                                                objfile -> md);
 135           obstack_specify_allocation_with_arg (&objfile -> type_obstack,
 136                                                0, 0, xmmalloc, mfree,
 137                                                objfile -> md);
 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       memset (objfile, 0, sizeof (struct objfile));
 170       objfile -> md = NULL;
 171       obstack_specify_allocation (&objfile -> psymbol_obstack, 0, 0, xmalloc,
 172                                   free);
 173       obstack_specify_allocation (&objfile -> symbol_obstack, 0, 0, xmalloc,
 174                                   free);
 175       obstack_specify_allocation (&objfile -> type_obstack, 0, 0, xmalloc,
 176                                   free);
 177     }
 178
 179   /* Update the per-objfile information that comes from the bfd, ensuring
 180      that any data that is reference is saved in the per-objfile data
 181      region. */
 182
 183   objfile -> obfd = abfd;
 184   if (objfile -> name != NULL)
 185     {
 186       mfree (objfile -> md, objfile -> name);
 187     }
 188   objfile -> name = mstrsave (objfile -> md, bfd_get_filename (abfd));
 189   objfile -> mtime = bfd_get_mtime (abfd);
 190
 191   /* Push this file onto the head of the linked list of other such files. */
 192
 193   objfile -> next = object_files;
 194   object_files = objfile;
 195
 196   return (objfile);
 197 }
 198
 199 /* Unlink OBJFILE from the list of known objfiles, if it is found in the
 200    list.
 201
 202    It is not a bug, or error, to call this function if OBJFILE is not known
 203    to be in the current list.  This is done in the case of mapped objfiles,
 204    for example, just to ensure that the mapped objfile doesn't appear twice
 205    in the list.  Since the list is threaded, linking in a mapped objfile
 206    twice would create a circular list.
 207
 208    If OBJFILE turns out to be in the list, we zap it's NEXT pointer after
 209    unlinking it, just to ensure that we have completely severed any linkages
 210    between the OBJFILE and the list. */
 211
 212 void
 213 unlink_objfile (objfile)
 214      struct objfile *objfile;
 215 {
 216   struct objfile** objpp;
 217
 218   for (objpp = &object_files; *objpp != NULL; objpp = &((*objpp) -> next))
 219     {
 220       if (*objpp == objfile)
 221         {
 222           *objpp = (*objpp) -> next;
 223           objfile -> next = NULL;
 224           break;
 225         }
 226     }
 227 }
 228
 229
 230 /* Destroy an objfile and all the symtabs and psymtabs under it.  Note
 231    that as much as possible is allocated on the symbol_obstack and
 232    psymbol_obstack, so that the memory can be efficiently freed.
 233
 234    Things which we do NOT free because they are not in malloc'd memory
 235    or not in memory specific to the objfile include:
 236
 237         objfile -> sf
 238
 239    FIXME:  If the objfile is using reusable symbol information (via mmalloc),
 240    then we need to take into account the fact that more than one process
 241    may be using the symbol information at the same time (when mmalloc is
 242    extended to support cooperative locking).  When more than one process
 243    is using the mapped symbol info, we need to be more careful about when
 244    we free objects in the reusable area. */
 245
 246 void
 247 free_objfile (objfile)
 248      struct objfile *objfile;
 249 {
 250   int mmfd;
 251
 252   /* First do any symbol file specific actions required when we are
 253      finished with a particular symbol file.  Note that if the objfile
 254      is using reusable symbol information (via mmalloc) then each of
 255      these routines is responsible for doing the correct thing, either
 256      freeing things which are valid only during this particular gdb
 257      execution, or leaving them to be reused during the next one. */
 258
 259   if (objfile -> sf != NULL)
 260     {
 261       (*objfile -> sf -> sym_finish) (objfile);
 262     }
 263
 264   /* We always close the bfd. */
 265
 266   if (objfile -> obfd != NULL)
 267     {
 268       char *name = bfd_get_filename (objfile->obfd);
 269       bfd_close (objfile -> obfd);
 270       free (name);
 271     }
 272
 273   /* Remove it from the chain of all objfiles. */
 274
 275   unlink_objfile (objfile);
 276
 277   /* Before the symbol table code was redone to make it easier to
 278      selectively load and remove information particular to a specific
 279      linkage unit, gdb used to do these things whenever the monolithic
 280      symbol table was blown away.  How much still needs to be done
 281      is unknown, but we play it safe for now and keep each action until
 282      it is shown to be no longer needed. */
 283
 284   clear_symtab_users_once ();
 285 #if defined (CLEAR_SOLIB)
 286   CLEAR_SOLIB ();
 287 #endif
 288   clear_pc_function_cache ();
 289
 290   /* The last thing we do is free the objfile struct itself for the
 291      non-reusable case, or detach from the mapped file for the reusable
 292      case.  Note that the mmalloc_detach or the mfree is the last thing
 293      we can do with this objfile. */
 294
 295 #if !defined(NO_MMALLOC) && defined(HAVE_MMAP)
 296
 297   if (objfile -> flags & OBJF_MAPPED)
 298     {
 299       /* Remember the fd so we can close it.  We can't close it before
 300          doing the detach, and after the detach the objfile is gone. */
 301       mmfd = objfile -> mmfd;
 302       mmalloc_detach (objfile -> md);
 303       objfile = NULL;
 304       close (mmfd);
 305     }
 306
 307 #endif  /* !defined(NO_MMALLOC) && defined(HAVE_MMAP) */
 308
 309   /* If we still have an objfile, then either we don't support reusable
 310      objfiles or this one was not reusable.  So free it normally. */
 311
 312   if (objfile != NULL)
 313     {
 314       if (objfile -> name != NULL)
 315         {
 316           mfree (objfile -> md, objfile -> name);
 317         }
 318       if (objfile->global_psymbols.list)
 319         mfree (objfile->md, objfile->global_psymbols.list);
 320       if (objfile->static_psymbols.list)
 321         mfree (objfile->md, objfile->static_psymbols.list);
 322       /* Free the obstacks for non-reusable objfiles */
 323       obstack_free (&objfile -> psymbol_obstack, 0);
 324       obstack_free (&objfile -> symbol_obstack, 0);
 325       obstack_free (&objfile -> type_obstack, 0);
 326       mfree (objfile -> md, objfile);
 327       objfile = NULL;
 328     }
 329 }
 330
 331
 332 /* Free all the object files at once.  */
 333
 334 void
 335 free_all_objfiles ()
 336 {
 337   struct objfile *objfile, *temp;
 338
 339   ALL_OBJFILES_SAFE (objfile, temp)
 340     {
 341       free_objfile (objfile);
 342     }
 343 }
 344
 345 /* Many places in gdb want to test just to see if we have any partial
 346    symbols available.  This function returns zero if none are currently
 347    available, nonzero otherwise. */
 348
 349 int
 350 have_partial_symbols ()
 351 {
 352   struct objfile *ofp;
 353
 354   ALL_OBJFILES (ofp)
 355     {
 356       if (ofp -> psymtabs != NULL)
 357         {
 358           return 1;
 359         }
 360     }
 361   return 0;
 362 }
 363
 364 /* Many places in gdb want to test just to see if we have any full
 365    symbols available.  This function returns zero if none are currently
 366    available, nonzero otherwise. */
 367
 368 int
 369 have_full_symbols ()
 370 {
 371   struct objfile *ofp;
 372
 373   ALL_OBJFILES (ofp)
 374     {
 375       if (ofp -> symtabs != NULL)
 376         {
 377           return 1;
 378         }
 379     }
 380   return 0;
 381 }
 382
 383 /* Many places in gdb want to test just to see if we have any minimal
 384    symbols available.  This function returns zero if none are currently
 385    available, nonzero otherwise. */
 386
 387 int
 388 have_minimal_symbols ()
 389 {
 390   struct objfile *ofp;
 391
 392   ALL_OBJFILES (ofp)
 393     {
 394       if (ofp -> msymbols != NULL)
 395         {
 396           return 1;
 397         }
 398     }
 399   return 0;
 400 }
 401
 402 #if !defined(NO_MMALLOC) && defined(HAVE_MMAP)
 403
 404 /* Given the name of a mapped symbol file in SYMSFILENAME, and the timestamp
 405    of the corresponding symbol file in MTIME, try to open an existing file
 406    with the name SYMSFILENAME and verify it is more recent than the base
 407    file by checking it's timestamp against MTIME.
 408
 409    If SYMSFILENAME does not exist (or can't be stat'd), simply returns -1.
 410
 411    If SYMSFILENAME does exist, but is out of date, we check to see if the
 412    user has specified creation of a mapped file.  If so, we don't issue
 413    any warning message because we will be creating a new mapped file anyway,
 414    overwriting the old one.  If not, then we issue a warning message so that
 415    the user will know why we aren't using this existing mapped symbol file.
 416    In either case, we return -1.
 417
 418    If SYMSFILENAME does exist and is not out of date, but can't be opened for
 419    some reason, then prints an appropriate system error message and returns -1.
 420
 421    Otherwise, returns the open file descriptor.  */
 422
 423 static int
 424 open_existing_mapped_file (symsfilename, mtime, mapped)
 425      char *symsfilename;
 426      long mtime;
 427      int mapped;
 428 {
 429   int fd = -1;
 430   struct stat sbuf;
 431
 432   if (stat (symsfilename, &sbuf) == 0)
 433     {
 434       if (sbuf.st_mtime < mtime)
 435         {
 436           if (!mapped)
 437             {
 438               warning ("mapped symbol file `%s' is out of date, ignored it",
 439                        symsfilename);
 440             }
 441         }
 442       else if ((fd = open (symsfilename, O_RDWR)) < 0)
 443         {
 444           if (error_pre_print)
 445             {
 446               printf (error_pre_print);
 447             }
 448           print_sys_errmsg (symsfilename, errno);
 449         }
 450     }
 451   return (fd);
 452 }
 453
 454 /* Look for a mapped symbol file that corresponds to FILENAME and is more
 455    recent than MTIME.  If MAPPED is nonzero, the user has asked that gdb
 456    use a mapped symbol file for this file, so create a new one if one does
 457    not currently exist.
 458
 459    If found, then return an open file descriptor for the file, otherwise
 460    return -1.
 461
 462    This routine is responsible for implementing the policy that generates
 463    the name of the mapped symbol file from the name of a file containing
 464    symbols that gdb would like to read.  Currently this policy is to append
 465    ".syms" to the name of the file.
 466
 467    This routine is also responsible for implementing the policy that
 468    determines where the mapped symbol file is found (the search path).
 469    This policy is that when reading an existing mapped file, a file of
 470    the correct name in the current directory takes precedence over a
 471    file of the correct name in the same directory as the symbol file.
 472    When creating a new mapped file, it is always created in the current
 473    directory.  This helps to minimize the chances of a user unknowingly
 474    creating big mapped files in places like /bin and /usr/local/bin, and
 475    allows a local copy to override a manually installed global copy (in
 476    /bin for example).  */
 477
 478 static int
 479 open_mapped_file (filename, mtime, mapped)
 480      char *filename;
 481      long mtime;
 482      int mapped;
 483 {
 484   int fd;
 485   char *symsfilename;
 486
 487   /* First try to open an existing file in the current directory, and
 488      then try the directory where the symbol file is located. */
 489
 490   symsfilename = concat ("./", basename (filename), ".syms", (char *) NULL);
 491   if ((fd = open_existing_mapped_file (symsfilename, mtime, mapped)) < 0)
 492     {
 493       free (symsfilename);
 494       symsfilename = concat (filename, ".syms", (char *) NULL);
 495       fd = open_existing_mapped_file (symsfilename, mtime, mapped);
 496     }
 497
 498   /* If we don't have an open file by now, then either the file does not
 499      already exist, or the base file has changed since it was created.  In
 500      either case, if the user has specified use of a mapped file, then
 501      create a new mapped file, truncating any existing one.  If we can't
 502      create one, print a system error message saying why we can't.
 503
 504      By default the file is rw for everyone, with the user's umask taking
 505      care of turning off the permissions the user wants off. */
 506
 507   if ((fd < 0) && mapped)
 508     {
 509       free (symsfilename);
 510       symsfilename = concat ("./", basename (filename), ".syms",
 511                              (char *) NULL);
 512       if ((fd = open (symsfilename, O_RDWR | O_CREAT | O_TRUNC, 0666)) < 0)
 513         {
 514           if (error_pre_print)
 515             {
 516               printf (error_pre_print);
 517             }
 518           print_sys_errmsg (symsfilename, errno);
 519         }
 520     }
 521
 522   free (symsfilename);
 523   return (fd);
 524 }
 525
 526 /* Return the base address at which we would like the next objfile's
 527    mapped data to start.
 528
 529    For now, we use the kludge that the configuration specifies a base
 530    address to which it is safe to map the first mmalloc heap, and an
 531    increment to add to this address for each successive heap.  There are
 532    a lot of issues to deal with here to make this work reasonably, including:
 533
 534      Avoid memory collisions with existing mapped address spaces
 535
 536      Reclaim address spaces when their mmalloc heaps are unmapped
 537
 538      When mmalloc heaps are shared between processes they have to be
 539      mapped at the same addresses in each
 540
 541      Once created, a mmalloc heap that is to be mapped back in must be
 542      mapped at the original address.  I.E. each objfile will expect to
 543      be remapped at it's original address.  This becomes a problem if
 544      the desired address is already in use.
 545
 546      etc, etc, etc.
 547
 548  */
 549
 550
 551 static CORE_ADDR
 552 map_to_address ()
 553 {
 554
 555 #if defined(MMAP_BASE_ADDRESS) && defined (MMAP_INCREMENT)
 556
 557   static CORE_ADDR next = MMAP_BASE_ADDRESS;
 558   CORE_ADDR mapto = next;
 559
 560   next += MMAP_INCREMENT;
 561   return (mapto);
 562
 563 #else
 564
 565   return (0);
 566
 567 #endif
 568
 569 }
 570
 571 #endif  /* !defined(NO_MMALLOC) && defined(HAVE_MMAP) */