gdb/minsyms.c

   1 /* GDB routines for manipulating the minimal symbol tables.
   2    Copyright 1992, 93, 94, 96, 97, 1998 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., 59 Temple Place - Suite 330,
  20    Boston, MA 02111-1307, USA.  */
  21
  22
  23 /* This file contains support routines for creating, manipulating, and
  24    destroying minimal symbol tables.
  25
  26    Minimal symbol tables are used to hold some very basic information about
  27    all defined global symbols (text, data, bss, abs, etc).  The only two
  28    required pieces of information are the symbol's name and the address
  29    associated with that symbol.
  30
  31    In many cases, even if a file was compiled with no special options for
  32    debugging at all, as long as was not stripped it will contain sufficient
  33    information to build useful minimal symbol tables using this structure.
  34
  35    Even when a file contains enough debugging information to build a full
  36    symbol table, these minimal symbols are still useful for quickly mapping
  37    between names and addresses, and vice versa.  They are also sometimes used
  38    to figure out what full symbol table entries need to be read in. */
  39
  40
  41 #include "defs.h"
  42 #include "gdb_string.h"
  43 #include "symtab.h"
  44 #include "bfd.h"
  45 #include "symfile.h"
  46 #include "objfiles.h"
  47 #include "demangle.h"
  48 #include "gdb-stabs.h"
  49
  50 /* Accumulate the minimal symbols for each objfile in bunches of BUNCH_SIZE.
  51    At the end, copy them all into one newly allocated location on an objfile's
  52    symbol obstack.  */
  53
  54 #define BUNCH_SIZE 127
  55
  56 struct msym_bunch
  57   {
  58     struct msym_bunch *next;
  59     struct minimal_symbol contents[BUNCH_SIZE];
  60   };
  61
  62 /* Bunch currently being filled up.
  63    The next field points to chain of filled bunches.  */
  64
  65 static struct msym_bunch *msym_bunch;
  66
  67 /* Number of slots filled in current bunch.  */
  68
  69 static int msym_bunch_index;
  70
  71 /* Total number of minimal symbols recorded so far for the objfile.  */
  72
  73 static int msym_count;
  74
  75 /* Prototypes for local functions. */
  76
  77 static int
  78 compare_minimal_symbols PARAMS ((const void *, const void *));
  79
  80 static int
  81 compact_minimal_symbols PARAMS ((struct minimal_symbol *, int));
  82
  83 /* Look through all the current minimal symbol tables and find the
  84    first minimal symbol that matches NAME.  If OBJF is non-NULL, limit
  85    the search to that objfile.  If SFILE is non-NULL, limit the search
  86    to that source file.  Returns a pointer to the minimal symbol that
  87    matches, or NULL if no match is found.
  88
  89    Note:  One instance where there may be duplicate minimal symbols with
  90    the same name is when the symbol tables for a shared library and the
  91    symbol tables for an executable contain global symbols with the same
  92    names (the dynamic linker deals with the duplication). */
  93
  94 struct minimal_symbol *
  95 lookup_minimal_symbol (name, sfile, objf)
  96      register const char *name;
  97      const char *sfile;
  98      struct objfile *objf;
  99 {
 100   struct objfile *objfile;
 101   struct minimal_symbol *msymbol;
 102   struct minimal_symbol *found_symbol = NULL;
 103   struct minimal_symbol *found_file_symbol = NULL;
 104   struct minimal_symbol *trampoline_symbol = NULL;
 105
 106 #ifdef SOFUN_ADDRESS_MAYBE_MISSING
 107   if (sfile != NULL)
 108     {
 109       char *p = strrchr (sfile, '/');
 110       if (p != NULL)
 111         sfile = p + 1;
 112     }
 113 #endif
 114
 115   for (objfile = object_files;
 116        objfile != NULL && found_symbol == NULL;
 117        objfile = objfile->next)
 118     {
 119       if (objf == NULL || objf == objfile)
 120         {
 121           for (msymbol = objfile->msymbols;
 122                msymbol != NULL && SYMBOL_NAME (msymbol) != NULL &&
 123                found_symbol == NULL;
 124                msymbol++)
 125             {
 126               if (SYMBOL_MATCHES_NAME (msymbol, name))
 127                 {
 128                   switch (MSYMBOL_TYPE (msymbol))
 129                     {
 130                     case mst_file_text:
 131                     case mst_file_data:
 132                     case mst_file_bss:
 133 #ifdef SOFUN_ADDRESS_MAYBE_MISSING
 134                       if (sfile == NULL || STREQ (msymbol->filename, sfile))
 135                         found_file_symbol = msymbol;
 136 #else
 137                       /* We have neither the ability nor the need to
 138                          deal with the SFILE parameter.  If we find
 139                          more than one symbol, just return the latest
 140                          one (the user can't expect useful behavior in
 141                          that case).  */
 142                       found_file_symbol = msymbol;
 143 #endif
 144                       break;
 145
 146                     case mst_solib_trampoline:
 147
 148                       /* If a trampoline symbol is found, we prefer to
 149                          keep looking for the *real* symbol. If the
 150                          actual symbol is not found, then we'll use the
 151                          trampoline entry. */
 152                       if (trampoline_symbol == NULL)
 153                         trampoline_symbol = msymbol;
 154                       break;
 155
 156                     case mst_unknown:
 157                     default:
 158                       found_symbol = msymbol;
 159                       break;
 160                     }
 161                 }
 162             }
 163         }
 164     }
 165   /* External symbols are best.  */
 166   if (found_symbol)
 167     return found_symbol;
 168
 169   /* File-local symbols are next best.  */
 170   if (found_file_symbol)
 171     return found_file_symbol;
 172
 173   /* Symbols for shared library trampolines are next best.  */
 174   if (trampoline_symbol)
 175     return trampoline_symbol;
 176
 177   return NULL;
 178 }
 179
 180 /* Look through all the current minimal symbol tables and find the
 181    first minimal symbol that matches NAME and of text type.
 182    If OBJF is non-NULL, limit
 183    the search to that objfile.  If SFILE is non-NULL, limit the search
 184    to that source file.  Returns a pointer to the minimal symbol that
 185    matches, or NULL if no match is found.
 186  */
 187
 188 struct minimal_symbol *
 189 lookup_minimal_symbol_text (name, sfile, objf)
 190      register const char *name;
 191      const char *sfile;
 192      struct objfile *objf;
 193 {
 194   struct objfile *objfile;
 195   struct minimal_symbol *msymbol;
 196   struct minimal_symbol *found_symbol = NULL;
 197   struct minimal_symbol *found_file_symbol = NULL;
 198
 199 #ifdef SOFUN_ADDRESS_MAYBE_MISSING
 200   if (sfile != NULL)
 201     {
 202       char *p = strrchr (sfile, '/');
 203       if (p != NULL)
 204         sfile = p + 1;
 205     }
 206 #endif
 207
 208   for (objfile = object_files;
 209        objfile != NULL && found_symbol == NULL;
 210        objfile = objfile->next)
 211     {
 212       if (objf == NULL || objf == objfile)
 213         {
 214           for (msymbol = objfile->msymbols;
 215                msymbol != NULL && SYMBOL_NAME (msymbol) != NULL &&
 216                found_symbol == NULL;
 217                msymbol++)
 218             {
 219               if (SYMBOL_MATCHES_NAME (msymbol, name) &&
 220                   (MSYMBOL_TYPE (msymbol) == mst_text ||
 221                    MSYMBOL_TYPE (msymbol) == mst_file_text))
 222                 {
 223                   switch (MSYMBOL_TYPE (msymbol))
 224                     {
 225                     case mst_file_text:
 226 #ifdef SOFUN_ADDRESS_MAYBE_MISSING
 227                       if (sfile == NULL || STREQ (msymbol->filename, sfile))
 228                         found_file_symbol = msymbol;
 229 #else
 230                       /* We have neither the ability nor the need to
 231                          deal with the SFILE parameter.  If we find
 232                          more than one symbol, just return the latest
 233                          one (the user can't expect useful behavior in
 234                          that case).  */
 235                       found_file_symbol = msymbol;
 236 #endif
 237                       break;
 238                     default:
 239                       found_symbol = msymbol;
 240                       break;
 241                     }
 242                 }
 243             }
 244         }
 245     }
 246   /* External symbols are best.  */
 247   if (found_symbol)
 248     return found_symbol;
 249
 250   /* File-local symbols are next best.  */
 251   if (found_file_symbol)
 252     return found_file_symbol;
 253
 254   return NULL;
 255 }
 256
 257 /* Look through all the current minimal symbol tables and find the
 258    first minimal symbol that matches NAME and of solib trampoline type.
 259    If OBJF is non-NULL, limit
 260    the search to that objfile.  If SFILE is non-NULL, limit the search
 261    to that source file.  Returns a pointer to the minimal symbol that
 262    matches, or NULL if no match is found.
 263  */
 264
 265 struct minimal_symbol *
 266 lookup_minimal_symbol_solib_trampoline (name, sfile, objf)
 267      register const char *name;
 268      const char *sfile;
 269      struct objfile *objf;
 270 {
 271   struct objfile *objfile;
 272   struct minimal_symbol *msymbol;
 273   struct minimal_symbol *found_symbol = NULL;
 274
 275 #ifdef SOFUN_ADDRESS_MAYBE_MISSING
 276   if (sfile != NULL)
 277     {
 278       char *p = strrchr (sfile, '/');
 279       if (p != NULL)
 280         sfile = p + 1;
 281     }
 282 #endif
 283
 284   for (objfile = object_files;
 285        objfile != NULL && found_symbol == NULL;
 286        objfile = objfile->next)
 287     {
 288       if (objf == NULL || objf == objfile)
 289         {
 290           for (msymbol = objfile->msymbols;
 291                msymbol != NULL && SYMBOL_NAME (msymbol) != NULL &&
 292                found_symbol == NULL;
 293                msymbol++)
 294             {
 295               if (SYMBOL_MATCHES_NAME (msymbol, name) &&
 296                   MSYMBOL_TYPE (msymbol) == mst_solib_trampoline)
 297                 return msymbol;
 298             }
 299         }
 300     }
 301
 302   return NULL;
 303 }
 304
 305
 306 /* Search through the minimal symbol table for each objfile and find
 307    the symbol whose address is the largest address that is still less
 308    than or equal to PC, and matches SECTION (if non-null).  Returns a
 309    pointer to the minimal symbol if such a symbol is found, or NULL if
 310    PC is not in a suitable range.  Note that we need to look through
 311    ALL the minimal symbol tables before deciding on the symbol that
 312    comes closest to the specified PC.  This is because objfiles can
 313    overlap, for example objfile A has .text at 0x100 and .data at
 314    0x40000 and objfile B has .text at 0x234 and .data at 0x40048.  */
 315
 316 struct minimal_symbol *
 317 lookup_minimal_symbol_by_pc_section (pc, section)
 318      CORE_ADDR pc;
 319      asection *section;
 320 {
 321   int lo;
 322   int hi;
 323   int new;
 324   struct objfile *objfile;
 325   struct minimal_symbol *msymbol;
 326   struct minimal_symbol *best_symbol = NULL;
 327
 328   /* pc has to be in a known section. This ensures that anything beyond
 329      the end of the last segment doesn't appear to be part of the last
 330      function in the last segment.  */
 331   if (find_pc_section (pc) == NULL)
 332     return NULL;
 333
 334   for (objfile = object_files;
 335        objfile != NULL;
 336        objfile = objfile->next)
 337     {
 338       /* If this objfile has a minimal symbol table, go search it using
 339          a binary search.  Note that a minimal symbol table always consists
 340          of at least two symbols, a "real" symbol and the terminating
 341          "null symbol".  If there are no real symbols, then there is no
 342          minimal symbol table at all. */
 343
 344       if ((msymbol = objfile->msymbols) != NULL)
 345         {
 346           lo = 0;
 347           hi = objfile->minimal_symbol_count - 1;
 348
 349           /* This code assumes that the minimal symbols are sorted by
 350              ascending address values.  If the pc value is greater than or
 351              equal to the first symbol's address, then some symbol in this
 352              minimal symbol table is a suitable candidate for being the
 353              "best" symbol.  This includes the last real symbol, for cases
 354              where the pc value is larger than any address in this vector.
 355
 356              By iterating until the address associated with the current
 357              hi index (the endpoint of the test interval) is less than
 358              or equal to the desired pc value, we accomplish two things:
 359              (1) the case where the pc value is larger than any minimal
 360              symbol address is trivially solved, (2) the address associated
 361              with the hi index is always the one we want when the interation
 362              terminates.  In essence, we are iterating the test interval
 363              down until the pc value is pushed out of it from the high end.
 364
 365              Warning: this code is trickier than it would appear at first. */
 366
 367           /* Should also require that pc is <= end of objfile.  FIXME! */
 368           if (pc >= SYMBOL_VALUE_ADDRESS (&msymbol[lo]))
 369             {
 370               while (SYMBOL_VALUE_ADDRESS (&msymbol[hi]) > pc)
 371                 {
 372                   /* pc is still strictly less than highest address */
 373                   /* Note "new" will always be >= lo */
 374                   new = (lo + hi) / 2;
 375                   if ((SYMBOL_VALUE_ADDRESS (&msymbol[new]) >= pc) ||
 376                       (lo == new))
 377                     {
 378                       hi = new;
 379                     }
 380                   else
 381                     {
 382                       lo = new;
 383                     }
 384                 }
 385
 386               /* If we have multiple symbols at the same address, we want
 387                  hi to point to the last one.  That way we can find the
 388                  right symbol if it has an index greater than hi.  */
 389               while (hi < objfile->minimal_symbol_count - 1
 390                      && (SYMBOL_VALUE_ADDRESS (&msymbol[hi])
 391                          == SYMBOL_VALUE_ADDRESS (&msymbol[hi + 1])))
 392                 hi++;
 393
 394               /* The minimal symbol indexed by hi now is the best one in this
 395                  objfile's minimal symbol table.  See if it is the best one
 396                  overall. */
 397
 398               /* Skip any absolute symbols.  This is apparently what adb
 399                  and dbx do, and is needed for the CM-5.  There are two
 400                  known possible problems: (1) on ELF, apparently end, edata,
 401                  etc. are absolute.  Not sure ignoring them here is a big
 402                  deal, but if we want to use them, the fix would go in
 403                  elfread.c.  (2) I think shared library entry points on the
 404                  NeXT are absolute.  If we want special handling for this
 405                  it probably should be triggered by a special
 406                  mst_abs_or_lib or some such.  */
 407               while (hi >= 0
 408                      && msymbol[hi].type == mst_abs)
 409                 --hi;
 410
 411               /* If "section" specified, skip any symbol from wrong section */
 412               /* This is the new code that distinguishes it from the old function */
 413               if (section)
 414                 while (hi >= 0
 415                        && SYMBOL_BFD_SECTION (&msymbol[hi]) != section)
 416                   --hi;
 417
 418               if (hi >= 0
 419                   && ((best_symbol == NULL) ||
 420                       (SYMBOL_VALUE_ADDRESS (best_symbol) <
 421                        SYMBOL_VALUE_ADDRESS (&msymbol[hi]))))
 422                 {
 423                   best_symbol = &msymbol[hi];
 424                 }
 425             }
 426         }
 427     }
 428   return (best_symbol);
 429 }
 430
 431 /* Backward compatibility: search through the minimal symbol table
 432    for a matching PC (no section given) */
 433
 434 struct minimal_symbol *
 435 lookup_minimal_symbol_by_pc (pc)
 436      CORE_ADDR pc;
 437 {
 438   return lookup_minimal_symbol_by_pc_section (pc, find_pc_mapped_section (pc));
 439 }
 440
 441 #ifdef SOFUN_ADDRESS_MAYBE_MISSING
 442 CORE_ADDR
 443 find_stab_function_addr (namestring, filename, objfile)
 444      char *namestring;
 445      char *filename;
 446      struct objfile *objfile;
 447 {
 448   struct minimal_symbol *msym;
 449   char *p;
 450   int n;
 451
 452   p = strchr (namestring, ':');
 453   if (p == NULL)
 454     p = namestring;
 455   n = p - namestring;
 456   p = alloca (n + 2);
 457   strncpy (p, namestring, n);
 458   p[n] = 0;
 459
 460   msym = lookup_minimal_symbol (p, filename, objfile);
 461   if (msym == NULL)
 462     {
 463       /* Sun Fortran appends an underscore to the minimal symbol name,
 464          try again with an appended underscore if the minimal symbol
 465          was not found.  */
 466       p[n] = '_';
 467       p[n + 1] = 0;
 468       msym = lookup_minimal_symbol (p, filename, objfile);
 469     }
 470
 471   if (msym == NULL && filename != NULL)
 472     {
 473       /* Try again without the filename. */
 474       p[n] = 0;
 475       msym = lookup_minimal_symbol (p, 0, objfile);
 476     }
 477   if (msym == NULL && filename != NULL)
 478     {
 479       /* And try again for Sun Fortran, but without the filename. */
 480       p[n] = '_';
 481       p[n + 1] = 0;
 482       msym = lookup_minimal_symbol (p, 0, objfile);
 483     }
 484
 485   return msym == NULL ? 0 : SYMBOL_VALUE_ADDRESS (msym);
 486 }
 487 #endif /* SOFUN_ADDRESS_MAYBE_MISSING */
 488 \f
 489
 490 /* Return leading symbol character for a BFD. If BFD is NULL,
 491    return the leading symbol character from the main objfile.  */
 492
 493 static int get_symbol_leading_char PARAMS ((bfd *));
 494
 495 static int
 496 get_symbol_leading_char (abfd)
 497      bfd *abfd;
 498 {
 499   if (abfd != NULL)
 500     return bfd_get_symbol_leading_char (abfd);
 501   if (symfile_objfile != NULL && symfile_objfile->obfd != NULL)
 502     return bfd_get_symbol_leading_char (symfile_objfile->obfd);
 503   return 0;
 504 }
 505
 506 /* Prepare to start collecting minimal symbols.  Note that presetting
 507    msym_bunch_index to BUNCH_SIZE causes the first call to save a minimal
 508    symbol to allocate the memory for the first bunch. */
 509
 510 void
 511 init_minimal_symbol_collection ()
 512 {
 513   msym_count = 0;
 514   msym_bunch = NULL;
 515   msym_bunch_index = BUNCH_SIZE;
 516 }
 517
 518 void
 519 prim_record_minimal_symbol (name, address, ms_type, objfile)
 520      const char *name;
 521      CORE_ADDR address;
 522      enum minimal_symbol_type ms_type;
 523      struct objfile *objfile;
 524 {
 525   int section;
 526
 527   switch (ms_type)
 528     {
 529     case mst_text:
 530     case mst_file_text:
 531     case mst_solib_trampoline:
 532       section = SECT_OFF_TEXT;
 533       break;
 534     case mst_data:
 535     case mst_file_data:
 536       section = SECT_OFF_DATA;
 537       break;
 538     case mst_bss:
 539     case mst_file_bss:
 540       section = SECT_OFF_BSS;
 541       break;
 542     default:
 543       section = -1;
 544     }
 545
 546   prim_record_minimal_symbol_and_info (name, address, ms_type,
 547                                        NULL, section, NULL, objfile);
 548 }
 549
 550 /* Record a minimal symbol in the msym bunches.  Returns the symbol
 551    newly created.  */
 552
 553 struct minimal_symbol *
 554 prim_record_minimal_symbol_and_info (name, address, ms_type, info, section,
 555                                      bfd_section, objfile)
 556      const char *name;
 557      CORE_ADDR address;
 558      enum minimal_symbol_type ms_type;
 559      char *info;
 560      int section;
 561      asection *bfd_section;
 562      struct objfile *objfile;
 563 {
 564   register struct msym_bunch *new;
 565   register struct minimal_symbol *msymbol;
 566
 567   if (ms_type == mst_file_text)
 568     {
 569       /* Don't put gcc_compiled, __gnu_compiled_cplus, and friends into
 570          the minimal symbols, because if there is also another symbol
 571          at the same address (e.g. the first function of the file),
 572          lookup_minimal_symbol_by_pc would have no way of getting the
 573          right one.  */
 574       if (name[0] == 'g'
 575           && (strcmp (name, GCC_COMPILED_FLAG_SYMBOL) == 0
 576               || strcmp (name, GCC2_COMPILED_FLAG_SYMBOL) == 0))
 577         return (NULL);
 578
 579       {
 580         const char *tempstring = name;
 581         if (tempstring[0] == get_symbol_leading_char (objfile->obfd))
 582           ++tempstring;
 583         if (STREQN (tempstring, "__gnu_compiled", 14))
 584           return (NULL);
 585       }
 586     }
 587
 588   if (msym_bunch_index == BUNCH_SIZE)
 589     {
 590       new = (struct msym_bunch *) xmalloc (sizeof (struct msym_bunch));
 591       msym_bunch_index = 0;
 592       new->next = msym_bunch;
 593       msym_bunch = new;
 594     }
 595   msymbol = &msym_bunch->contents[msym_bunch_index];
 596   SYMBOL_NAME (msymbol) = obsavestring ((char *) name, strlen (name),
 597                                         &objfile->symbol_obstack);
 598   SYMBOL_INIT_LANGUAGE_SPECIFIC (msymbol, language_unknown);
 599   SYMBOL_VALUE_ADDRESS (msymbol) = address;
 600   SYMBOL_SECTION (msymbol) = section;
 601   SYMBOL_BFD_SECTION (msymbol) = bfd_section;
 602
 603   MSYMBOL_TYPE (msymbol) = ms_type;
 604   /* FIXME:  This info, if it remains, needs its own field.  */
 605   MSYMBOL_INFO (msymbol) = info;        /* FIXME! */
 606   msym_bunch_index++;
 607   msym_count++;
 608   OBJSTAT (objfile, n_minsyms++);
 609   return msymbol;
 610 }
 611
 612 /* Compare two minimal symbols by address and return a signed result based
 613    on unsigned comparisons, so that we sort into unsigned numeric order.
 614    Within groups with the same address, sort by name.  */
 615
 616 static int
 617 compare_minimal_symbols (fn1p, fn2p)
 618      const PTR fn1p;
 619      const PTR fn2p;
 620 {
 621   register const struct minimal_symbol *fn1;
 622   register const struct minimal_symbol *fn2;
 623
 624   fn1 = (const struct minimal_symbol *) fn1p;
 625   fn2 = (const struct minimal_symbol *) fn2p;
 626
 627   if (SYMBOL_VALUE_ADDRESS (fn1) < SYMBOL_VALUE_ADDRESS (fn2))
 628     {
 629       return (-1);              /* addr 1 is less than addr 2 */
 630     }
 631   else if (SYMBOL_VALUE_ADDRESS (fn1) > SYMBOL_VALUE_ADDRESS (fn2))
 632     {
 633       return (1);               /* addr 1 is greater than addr 2 */
 634     }
 635   else
 636     /* addrs are equal: sort by name */
 637     {
 638       char *name1 = SYMBOL_NAME (fn1);
 639       char *name2 = SYMBOL_NAME (fn2);
 640
 641       if (name1 && name2)       /* both have names */
 642         return strcmp (name1, name2);
 643       else if (name2)
 644         return 1;               /* fn1 has no name, so it is "less" */
 645       else if (name1)           /* fn2 has no name, so it is "less" */
 646         return -1;
 647       else
 648         return (0);             /* neither has a name, so they're equal. */
 649     }
 650 }
 651
 652 /* Discard the currently collected minimal symbols, if any.  If we wish
 653    to save them for later use, we must have already copied them somewhere
 654    else before calling this function.
 655
 656    FIXME:  We could allocate the minimal symbol bunches on their own
 657    obstack and then simply blow the obstack away when we are done with
 658    it.  Is it worth the extra trouble though? */
 659
 660 /* ARGSUSED */
 661 void
 662 discard_minimal_symbols (foo)
 663      int foo;
 664 {
 665   register struct msym_bunch *next;
 666
 667   while (msym_bunch != NULL)
 668     {
 669       next = msym_bunch->next;
 670       free ((PTR) msym_bunch);
 671       msym_bunch = next;
 672     }
 673 }
 674
 675 /* Compact duplicate entries out of a minimal symbol table by walking
 676    through the table and compacting out entries with duplicate addresses
 677    and matching names.  Return the number of entries remaining.
 678
 679    On entry, the table resides between msymbol[0] and msymbol[mcount].
 680    On exit, it resides between msymbol[0] and msymbol[result_count].
 681
 682    When files contain multiple sources of symbol information, it is
 683    possible for the minimal symbol table to contain many duplicate entries.
 684    As an example, SVR4 systems use ELF formatted object files, which
 685    usually contain at least two different types of symbol tables (a
 686    standard ELF one and a smaller dynamic linking table), as well as
 687    DWARF debugging information for files compiled with -g.
 688
 689    Without compacting, the minimal symbol table for gdb itself contains
 690    over a 1000 duplicates, about a third of the total table size.  Aside
 691    from the potential trap of not noticing that two successive entries
 692    identify the same location, this duplication impacts the time required
 693    to linearly scan the table, which is done in a number of places.  So we
 694    just do one linear scan here and toss out the duplicates.
 695
 696    Note that we are not concerned here about recovering the space that
 697    is potentially freed up, because the strings themselves are allocated
 698    on the symbol_obstack, and will get automatically freed when the symbol
 699    table is freed.  The caller can free up the unused minimal symbols at
 700    the end of the compacted region if their allocation strategy allows it.
 701
 702    Also note we only go up to the next to last entry within the loop
 703    and then copy the last entry explicitly after the loop terminates.
 704
 705    Since the different sources of information for each symbol may
 706    have different levels of "completeness", we may have duplicates
 707    that have one entry with type "mst_unknown" and the other with a
 708    known type.  So if the one we are leaving alone has type mst_unknown,
 709    overwrite its type with the type from the one we are compacting out.  */
 710
 711 static int
 712 compact_minimal_symbols (msymbol, mcount)
 713      struct minimal_symbol *msymbol;
 714      int mcount;
 715 {
 716   struct minimal_symbol *copyfrom;
 717   struct minimal_symbol *copyto;
 718
 719   if (mcount > 0)
 720     {
 721       copyfrom = copyto = msymbol;
 722       while (copyfrom < msymbol + mcount - 1)
 723         {
 724           if (SYMBOL_VALUE_ADDRESS (copyfrom) ==
 725               SYMBOL_VALUE_ADDRESS ((copyfrom + 1)) &&
 726               (STREQ (SYMBOL_NAME (copyfrom), SYMBOL_NAME ((copyfrom + 1)))))
 727             {
 728               if (MSYMBOL_TYPE ((copyfrom + 1)) == mst_unknown)
 729                 {
 730                   MSYMBOL_TYPE ((copyfrom + 1)) = MSYMBOL_TYPE (copyfrom);
 731                 }
 732               copyfrom++;
 733             }
 734           else
 735             {
 736               *copyto++ = *copyfrom++;
 737             }
 738         }
 739       *copyto++ = *copyfrom++;
 740       mcount = copyto - msymbol;
 741     }
 742   return (mcount);
 743 }
 744
 745 /* Add the minimal symbols in the existing bunches to the objfile's official
 746    minimal symbol table.  In most cases there is no minimal symbol table yet
 747    for this objfile, and the existing bunches are used to create one.  Once
 748    in a while (for shared libraries for example), we add symbols (e.g. common
 749    symbols) to an existing objfile.
 750
 751    Because of the way minimal symbols are collected, we generally have no way
 752    of knowing what source language applies to any particular minimal symbol.
 753    Specifically, we have no way of knowing if the minimal symbol comes from a
 754    C++ compilation unit or not.  So for the sake of supporting cached
 755    demangled C++ names, we have no choice but to try and demangle each new one
 756    that comes in.  If the demangling succeeds, then we assume it is a C++
 757    symbol and set the symbol's language and demangled name fields
 758    appropriately.  Note that in order to avoid unnecessary demanglings, and
 759    allocating obstack space that subsequently can't be freed for the demangled
 760    names, we mark all newly added symbols with language_auto.  After
 761    compaction of the minimal symbols, we go back and scan the entire minimal
 762    symbol table looking for these new symbols.  For each new symbol we attempt
 763    to demangle it, and if successful, record it as a language_cplus symbol
 764    and cache the demangled form on the symbol obstack.  Symbols which don't
 765    demangle are marked as language_unknown symbols, which inhibits future
 766    attempts to demangle them if we later add more minimal symbols. */
 767
 768 void
 769 install_minimal_symbols (objfile)
 770      struct objfile *objfile;
 771 {
 772   register int bindex;
 773   register int mcount;
 774   register struct msym_bunch *bunch;
 775   register struct minimal_symbol *msymbols;
 776   int alloc_count;
 777   register char leading_char;
 778
 779   if (msym_count > 0)
 780     {
 781       /* Allocate enough space in the obstack, into which we will gather the
 782          bunches of new and existing minimal symbols, sort them, and then
 783          compact out the duplicate entries.  Once we have a final table,
 784          we will give back the excess space.  */
 785
 786       alloc_count = msym_count + objfile->minimal_symbol_count + 1;
 787       obstack_blank (&objfile->symbol_obstack,
 788                      alloc_count * sizeof (struct minimal_symbol));
 789       msymbols = (struct minimal_symbol *)
 790         obstack_base (&objfile->symbol_obstack);
 791
 792       /* Copy in the existing minimal symbols, if there are any.  */
 793
 794       if (objfile->minimal_symbol_count)
 795         memcpy ((char *) msymbols, (char *) objfile->msymbols,
 796             objfile->minimal_symbol_count * sizeof (struct minimal_symbol));
 797
 798       /* Walk through the list of minimal symbol bunches, adding each symbol
 799          to the new contiguous array of symbols.  Note that we start with the
 800          current, possibly partially filled bunch (thus we use the current
 801          msym_bunch_index for the first bunch we copy over), and thereafter
 802          each bunch is full. */
 803
 804       mcount = objfile->minimal_symbol_count;
 805       leading_char = get_symbol_leading_char (objfile->obfd);
 806
 807       for (bunch = msym_bunch; bunch != NULL; bunch = bunch->next)
 808         {
 809           for (bindex = 0; bindex < msym_bunch_index; bindex++, mcount++)
 810             {
 811               msymbols[mcount] = bunch->contents[bindex];
 812               SYMBOL_LANGUAGE (&msymbols[mcount]) = language_auto;
 813               if (SYMBOL_NAME (&msymbols[mcount])[0] == leading_char)
 814                 {
 815                   SYMBOL_NAME (&msymbols[mcount])++;
 816                 }
 817             }
 818           msym_bunch_index = BUNCH_SIZE;
 819         }
 820
 821       /* Sort the minimal symbols by address.  */
 822
 823       qsort (msymbols, mcount, sizeof (struct minimal_symbol),
 824              compare_minimal_symbols);
 825
 826       /* Compact out any duplicates, and free up whatever space we are
 827          no longer using.  */
 828
 829       mcount = compact_minimal_symbols (msymbols, mcount);
 830
 831       obstack_blank (&objfile->symbol_obstack,
 832                (mcount + 1 - alloc_count) * sizeof (struct minimal_symbol));
 833       msymbols = (struct minimal_symbol *)
 834         obstack_finish (&objfile->symbol_obstack);
 835
 836       /* We also terminate the minimal symbol table with a "null symbol",
 837          which is *not* included in the size of the table.  This makes it
 838          easier to find the end of the table when we are handed a pointer
 839          to some symbol in the middle of it.  Zero out the fields in the
 840          "null symbol" allocated at the end of the array.  Note that the
 841          symbol count does *not* include this null symbol, which is why it
 842          is indexed by mcount and not mcount-1. */
 843
 844       SYMBOL_NAME (&msymbols[mcount]) = NULL;
 845       SYMBOL_VALUE_ADDRESS (&msymbols[mcount]) = 0;
 846       MSYMBOL_INFO (&msymbols[mcount]) = NULL;
 847       MSYMBOL_TYPE (&msymbols[mcount]) = mst_unknown;
 848       SYMBOL_INIT_LANGUAGE_SPECIFIC (&msymbols[mcount], language_unknown);
 849
 850       /* Attach the minimal symbol table to the specified objfile.
 851          The strings themselves are also located in the symbol_obstack
 852          of this objfile.  */
 853
 854       objfile->minimal_symbol_count = mcount;
 855       objfile->msymbols = msymbols;
 856
 857       /* Now walk through all the minimal symbols, selecting the newly added
 858          ones and attempting to cache their C++ demangled names. */
 859
 860       for (; mcount-- > 0; msymbols++)
 861         {
 862           SYMBOL_INIT_DEMANGLED_NAME (msymbols, &objfile->symbol_obstack);
 863         }
 864     }
 865 }
 866
 867 /* Sort all the minimal symbols in OBJFILE.  */
 868
 869 void
 870 msymbols_sort (objfile)
 871      struct objfile *objfile;
 872 {
 873   qsort (objfile->msymbols, objfile->minimal_symbol_count,
 874          sizeof (struct minimal_symbol), compare_minimal_symbols);
 875 }
 876
 877 /* Check if PC is in a shared library trampoline code stub.
 878    Return minimal symbol for the trampoline entry or NULL if PC is not
 879    in a trampoline code stub.  */
 880
 881 struct minimal_symbol *
 882 lookup_solib_trampoline_symbol_by_pc (pc)
 883      CORE_ADDR pc;
 884 {
 885   struct minimal_symbol *msymbol = lookup_minimal_symbol_by_pc (pc);
 886
 887   if (msymbol != NULL && MSYMBOL_TYPE (msymbol) == mst_solib_trampoline)
 888     return msymbol;
 889   return NULL;
 890 }
 891
 892 /* If PC is in a shared library trampoline code stub, return the
 893    address of the `real' function belonging to the stub.
 894    Return 0 if PC is not in a trampoline code stub or if the real
 895    function is not found in the minimal symbol table.
 896
 897    We may fail to find the right function if a function with the
 898    same name is defined in more than one shared library, but this
 899    is considered bad programming style. We could return 0 if we find
 900    a duplicate function in case this matters someday.  */
 901
 902 CORE_ADDR
 903 find_solib_trampoline_target (pc)
 904      CORE_ADDR pc;
 905 {
 906   struct objfile *objfile;
 907   struct minimal_symbol *msymbol;
 908   struct minimal_symbol *tsymbol = lookup_solib_trampoline_symbol_by_pc (pc);
 909
 910   if (tsymbol != NULL)
 911     {
 912       ALL_MSYMBOLS (objfile, msymbol)
 913       {
 914         if (MSYMBOL_TYPE (msymbol) == mst_text
 915             && STREQ (SYMBOL_NAME (msymbol), SYMBOL_NAME (tsymbol)))
 916           return SYMBOL_VALUE_ADDRESS (msymbol);
 917       }
 918     }
 919   return 0;
 920 }