gdb/minsyms.c

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