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