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   struct obj_section *pc_section;
 407
 408   /* pc has to be in a known section. This ensures that anything beyond
 409      the end of the last segment doesn't appear to be part of the last
 410      function in the last segment.  */
 411   pc_section = find_pc_section (pc);
 412   if (pc_section == NULL)
 413     return NULL;
 414
 415   /* If no section was specified, then just make sure that the PC is in
 416      the same section as the minimal symbol we find.  */
 417   if (section == NULL)
 418     section = pc_section->the_bfd_section;
 419
 420   /* FIXME drow/2003-07-19: Should we also check that PC is in SECTION
 421      if we were passed a non-NULL SECTION argument?  */
 422
 423   for (objfile = object_files;
 424        objfile != NULL;
 425        objfile = objfile->next)
 426     {
 427       /* If this objfile has a minimal symbol table, go search it using
 428          a binary search.  Note that a minimal symbol table always consists
 429          of at least two symbols, a "real" symbol and the terminating
 430          "null symbol".  If there are no real symbols, then there is no
 431          minimal symbol table at all. */
 432
 433       if (objfile->minimal_symbol_count > 0)
 434         {
 435           msymbol = objfile->msymbols;
 436           lo = 0;
 437           hi = objfile->minimal_symbol_count - 1;
 438
 439           /* This code assumes that the minimal symbols are sorted by
 440              ascending address values.  If the pc value is greater than or
 441              equal to the first symbol's address, then some symbol in this
 442              minimal symbol table is a suitable candidate for being the
 443              "best" symbol.  This includes the last real symbol, for cases
 444              where the pc value is larger than any address in this vector.
 445
 446              By iterating until the address associated with the current
 447              hi index (the endpoint of the test interval) is less than
 448              or equal to the desired pc value, we accomplish two things:
 449              (1) the case where the pc value is larger than any minimal
 450              symbol address is trivially solved, (2) the address associated
 451              with the hi index is always the one we want when the interation
 452              terminates.  In essence, we are iterating the test interval
 453              down until the pc value is pushed out of it from the high end.
 454
 455              Warning: this code is trickier than it would appear at first. */
 456
 457           /* Should also require that pc is <= end of objfile.  FIXME! */
 458           if (pc >= SYMBOL_VALUE_ADDRESS (&msymbol[lo]))
 459             {
 460               while (SYMBOL_VALUE_ADDRESS (&msymbol[hi]) > pc)
 461                 {
 462                   /* pc is still strictly less than highest address */
 463                   /* Note "new" will always be >= lo */
 464                   new = (lo + hi) / 2;
 465                   if ((SYMBOL_VALUE_ADDRESS (&msymbol[new]) >= pc) ||
 466                       (lo == new))
 467                     {
 468                       hi = new;
 469                     }
 470                   else
 471                     {
 472                       lo = new;
 473                     }
 474                 }
 475
 476               /* If we have multiple symbols at the same address, we want
 477                  hi to point to the last one.  That way we can find the
 478                  right symbol if it has an index greater than hi.  */
 479               while (hi < objfile->minimal_symbol_count - 1
 480                      && (SYMBOL_VALUE_ADDRESS (&msymbol[hi])
 481                          == SYMBOL_VALUE_ADDRESS (&msymbol[hi + 1])))
 482                 hi++;
 483
 484               /* The minimal symbol indexed by hi now is the best one in this
 485                  objfile's minimal symbol table.  See if it is the best one
 486                  overall. */
 487
 488               /* Skip any absolute symbols.  This is apparently what adb
 489                  and dbx do, and is needed for the CM-5.  There are two
 490                  known possible problems: (1) on ELF, apparently end, edata,
 491                  etc. are absolute.  Not sure ignoring them here is a big
 492                  deal, but if we want to use them, the fix would go in
 493                  elfread.c.  (2) I think shared library entry points on the
 494                  NeXT are absolute.  If we want special handling for this
 495                  it probably should be triggered by a special
 496                  mst_abs_or_lib or some such.  */
 497               while (hi >= 0
 498                      && msymbol[hi].type == mst_abs)
 499                 --hi;
 500
 501               /* If "section" specified, skip any symbol from wrong section */
 502               /* This is the new code that distinguishes it from the old function */
 503               if (section)
 504                 while (hi >= 0
 505                        /* Some types of debug info, such as COFF,
 506                           don't fill the bfd_section member, so don't
 507                           throw away symbols on those platforms.  */
 508                        && SYMBOL_BFD_SECTION (&msymbol[hi]) != NULL
 509                        && SYMBOL_BFD_SECTION (&msymbol[hi]) != section)
 510                   --hi;
 511
 512               if (hi >= 0
 513                   && ((best_symbol == NULL) ||
 514                       (SYMBOL_VALUE_ADDRESS (best_symbol) <
 515                        SYMBOL_VALUE_ADDRESS (&msymbol[hi]))))
 516                 {
 517                   best_symbol = &msymbol[hi];
 518                 }
 519             }
 520         }
 521     }
 522   return (best_symbol);
 523 }
 524
 525 /* Backward compatibility: search through the minimal symbol table
 526    for a matching PC (no section given) */
 527
 528 struct minimal_symbol *
 529 lookup_minimal_symbol_by_pc (CORE_ADDR pc)
 530 {
 531   return lookup_minimal_symbol_by_pc_section (pc, find_pc_mapped_section (pc));
 532 }
 533 \f
 534
 535 /* Return leading symbol character for a BFD. If BFD is NULL,
 536    return the leading symbol character from the main objfile.  */
 537
 538 static int get_symbol_leading_char (bfd *);
 539
 540 static int
 541 get_symbol_leading_char (bfd *abfd)
 542 {
 543   if (abfd != NULL)
 544     return bfd_get_symbol_leading_char (abfd);
 545   if (symfile_objfile != NULL && symfile_objfile->obfd != NULL)
 546     return bfd_get_symbol_leading_char (symfile_objfile->obfd);
 547   return 0;
 548 }
 549
 550 /* Prepare to start collecting minimal symbols.  Note that presetting
 551    msym_bunch_index to BUNCH_SIZE causes the first call to save a minimal
 552    symbol to allocate the memory for the first bunch. */
 553
 554 void
 555 init_minimal_symbol_collection (void)
 556 {
 557   msym_count = 0;
 558   msym_bunch = NULL;
 559   msym_bunch_index = BUNCH_SIZE;
 560 }
 561
 562 void
 563 prim_record_minimal_symbol (const char *name, CORE_ADDR address,
 564                             enum minimal_symbol_type ms_type,
 565                             struct objfile *objfile)
 566 {
 567   int section;
 568
 569   switch (ms_type)
 570     {
 571     case mst_text:
 572     case mst_file_text:
 573     case mst_solib_trampoline:
 574       section = SECT_OFF_TEXT (objfile);
 575       break;
 576     case mst_data:
 577     case mst_file_data:
 578       section = SECT_OFF_DATA (objfile);
 579       break;
 580     case mst_bss:
 581     case mst_file_bss:
 582       section = SECT_OFF_BSS (objfile);
 583       break;
 584     default:
 585       section = -1;
 586     }
 587
 588   prim_record_minimal_symbol_and_info (name, address, ms_type,
 589                                        NULL, section, NULL, objfile);
 590 }
 591
 592 /* Record a minimal symbol in the msym bunches.  Returns the symbol
 593    newly created.  */
 594
 595 struct minimal_symbol *
 596 prim_record_minimal_symbol_and_info (const char *name, CORE_ADDR address,
 597                                      enum minimal_symbol_type ms_type,
 598                                      char *info, int section,
 599                                      asection *bfd_section,
 600                                      struct objfile *objfile)
 601 {
 602   struct msym_bunch *new;
 603   struct minimal_symbol *msymbol;
 604
 605   if (ms_type == mst_file_text)
 606     {
 607       /* Don't put gcc_compiled, __gnu_compiled_cplus, and friends into
 608          the minimal symbols, because if there is also another symbol
 609          at the same address (e.g. the first function of the file),
 610          lookup_minimal_symbol_by_pc would have no way of getting the
 611          right one.  */
 612       if (name[0] == 'g'
 613           && (strcmp (name, GCC_COMPILED_FLAG_SYMBOL) == 0
 614               || strcmp (name, GCC2_COMPILED_FLAG_SYMBOL) == 0))
 615         return (NULL);
 616
 617       {
 618         const char *tempstring = name;
 619         if (tempstring[0] == get_symbol_leading_char (objfile->obfd))
 620           ++tempstring;
 621         if (STREQN (tempstring, "__gnu_compiled", 14))
 622           return (NULL);
 623       }
 624     }
 625
 626   if (msym_bunch_index == BUNCH_SIZE)
 627     {
 628       new = (struct msym_bunch *) xmalloc (sizeof (struct msym_bunch));
 629       msym_bunch_index = 0;
 630       new->next = msym_bunch;
 631       msym_bunch = new;
 632     }
 633   msymbol = &msym_bunch->contents[msym_bunch_index];
 634   SYMBOL_INIT_LANGUAGE_SPECIFIC (msymbol, language_unknown);
 635   SYMBOL_LANGUAGE (msymbol) = language_auto;
 636   SYMBOL_SET_NAMES (msymbol, (char *)name, strlen (name), objfile);
 637
 638   SYMBOL_VALUE_ADDRESS (msymbol) = address;
 639   SYMBOL_SECTION (msymbol) = section;
 640   SYMBOL_BFD_SECTION (msymbol) = bfd_section;
 641
 642   MSYMBOL_TYPE (msymbol) = ms_type;
 643   /* FIXME:  This info, if it remains, needs its own field.  */
 644   MSYMBOL_INFO (msymbol) = info;        /* FIXME! */
 645
 646   /* The hash pointers must be cleared! If they're not,
 647      add_minsym_to_hash_table will NOT add this msymbol to the hash table. */
 648   msymbol->hash_next = NULL;
 649   msymbol->demangled_hash_next = NULL;
 650
 651   msym_bunch_index++;
 652   msym_count++;
 653   OBJSTAT (objfile, n_minsyms++);
 654   return msymbol;
 655 }
 656
 657 /* Compare two minimal symbols by address and return a signed result based
 658    on unsigned comparisons, so that we sort into unsigned numeric order.
 659    Within groups with the same address, sort by name.  */
 660
 661 static int
 662 compare_minimal_symbols (const void *fn1p, const void *fn2p)
 663 {
 664   const struct minimal_symbol *fn1;
 665   const struct minimal_symbol *fn2;
 666
 667   fn1 = (const struct minimal_symbol *) fn1p;
 668   fn2 = (const struct minimal_symbol *) fn2p;
 669
 670   if (SYMBOL_VALUE_ADDRESS (fn1) < SYMBOL_VALUE_ADDRESS (fn2))
 671     {
 672       return (-1);              /* addr 1 is less than addr 2 */
 673     }
 674   else if (SYMBOL_VALUE_ADDRESS (fn1) > SYMBOL_VALUE_ADDRESS (fn2))
 675     {
 676       return (1);               /* addr 1 is greater than addr 2 */
 677     }
 678   else
 679     /* addrs are equal: sort by name */
 680     {
 681       char *name1 = SYMBOL_LINKAGE_NAME (fn1);
 682       char *name2 = SYMBOL_LINKAGE_NAME (fn2);
 683
 684       if (name1 && name2)       /* both have names */
 685         return strcmp (name1, name2);
 686       else if (name2)
 687         return 1;               /* fn1 has no name, so it is "less" */
 688       else if (name1)           /* fn2 has no name, so it is "less" */
 689         return -1;
 690       else
 691         return (0);             /* neither has a name, so they're equal. */
 692     }
 693 }
 694
 695 /* Discard the currently collected minimal symbols, if any.  If we wish
 696    to save them for later use, we must have already copied them somewhere
 697    else before calling this function.
 698
 699    FIXME:  We could allocate the minimal symbol bunches on their own
 700    obstack and then simply blow the obstack away when we are done with
 701    it.  Is it worth the extra trouble though? */
 702
 703 static void
 704 do_discard_minimal_symbols_cleanup (void *arg)
 705 {
 706   struct msym_bunch *next;
 707
 708   while (msym_bunch != NULL)
 709     {
 710       next = msym_bunch->next;
 711       xfree (msym_bunch);
 712       msym_bunch = next;
 713     }
 714 }
 715
 716 struct cleanup *
 717 make_cleanup_discard_minimal_symbols (void)
 718 {
 719   return make_cleanup (do_discard_minimal_symbols_cleanup, 0);
 720 }
 721
 722
 723
 724 /* Compact duplicate entries out of a minimal symbol table by walking
 725    through the table and compacting out entries with duplicate addresses
 726    and matching names.  Return the number of entries remaining.
 727
 728    On entry, the table resides between msymbol[0] and msymbol[mcount].
 729    On exit, it resides between msymbol[0] and msymbol[result_count].
 730
 731    When files contain multiple sources of symbol information, it is
 732    possible for the minimal symbol table to contain many duplicate entries.
 733    As an example, SVR4 systems use ELF formatted object files, which
 734    usually contain at least two different types of symbol tables (a
 735    standard ELF one and a smaller dynamic linking table), as well as
 736    DWARF debugging information for files compiled with -g.
 737
 738    Without compacting, the minimal symbol table for gdb itself contains
 739    over a 1000 duplicates, about a third of the total table size.  Aside
 740    from the potential trap of not noticing that two successive entries
 741    identify the same location, this duplication impacts the time required
 742    to linearly scan the table, which is done in a number of places.  So we
 743    just do one linear scan here and toss out the duplicates.
 744
 745    Note that we are not concerned here about recovering the space that
 746    is potentially freed up, because the strings themselves are allocated
 747    on the symbol_obstack, and will get automatically freed when the symbol
 748    table is freed.  The caller can free up the unused minimal symbols at
 749    the end of the compacted region if their allocation strategy allows it.
 750
 751    Also note we only go up to the next to last entry within the loop
 752    and then copy the last entry explicitly after the loop terminates.
 753
 754    Since the different sources of information for each symbol may
 755    have different levels of "completeness", we may have duplicates
 756    that have one entry with type "mst_unknown" and the other with a
 757    known type.  So if the one we are leaving alone has type mst_unknown,
 758    overwrite its type with the type from the one we are compacting out.  */
 759
 760 static int
 761 compact_minimal_symbols (struct minimal_symbol *msymbol, int mcount,
 762                          struct objfile *objfile)
 763 {
 764   struct minimal_symbol *copyfrom;
 765   struct minimal_symbol *copyto;
 766
 767   if (mcount > 0)
 768     {
 769       copyfrom = copyto = msymbol;
 770       while (copyfrom < msymbol + mcount - 1)
 771         {
 772           if (SYMBOL_VALUE_ADDRESS (copyfrom) ==
 773               SYMBOL_VALUE_ADDRESS ((copyfrom + 1)) &&
 774               (STREQ (SYMBOL_LINKAGE_NAME (copyfrom),
 775                       SYMBOL_LINKAGE_NAME ((copyfrom + 1)))))
 776             {
 777               if (MSYMBOL_TYPE ((copyfrom + 1)) == mst_unknown)
 778                 {
 779                   MSYMBOL_TYPE ((copyfrom + 1)) = MSYMBOL_TYPE (copyfrom);
 780                 }
 781               copyfrom++;
 782             }
 783           else
 784             *copyto++ = *copyfrom++;
 785         }
 786       *copyto++ = *copyfrom++;
 787       mcount = copyto - msymbol;
 788     }
 789   return (mcount);
 790 }
 791
 792 /* Build (or rebuild) the minimal symbol hash tables.  This is necessary
 793    after compacting or sorting the table since the entries move around
 794    thus causing the internal minimal_symbol pointers to become jumbled. */
 795
 796 static void
 797 build_minimal_symbol_hash_tables (struct objfile *objfile)
 798 {
 799   int i;
 800   struct minimal_symbol *msym;
 801
 802   /* Clear the hash tables. */
 803   for (i = 0; i < MINIMAL_SYMBOL_HASH_SIZE; i++)
 804     {
 805       objfile->msymbol_hash[i] = 0;
 806       objfile->msymbol_demangled_hash[i] = 0;
 807     }
 808
 809   /* Now, (re)insert the actual entries. */
 810   for (i = objfile->minimal_symbol_count, msym = objfile->msymbols;
 811        i > 0;
 812        i--, msym++)
 813     {
 814       msym->hash_next = 0;
 815       add_minsym_to_hash_table (msym, objfile->msymbol_hash);
 816
 817       msym->demangled_hash_next = 0;
 818       if (SYMBOL_DEMANGLED_NAME (msym) != NULL)
 819         add_minsym_to_demangled_hash_table (msym,
 820                                             objfile->msymbol_demangled_hash);
 821     }
 822 }
 823
 824 /* Add the minimal symbols in the existing bunches to the objfile's official
 825    minimal symbol table.  In most cases there is no minimal symbol table yet
 826    for this objfile, and the existing bunches are used to create one.  Once
 827    in a while (for shared libraries for example), we add symbols (e.g. common
 828    symbols) to an existing objfile.
 829
 830    Because of the way minimal symbols are collected, we generally have no way
 831    of knowing what source language applies to any particular minimal symbol.
 832    Specifically, we have no way of knowing if the minimal symbol comes from a
 833    C++ compilation unit or not.  So for the sake of supporting cached
 834    demangled C++ names, we have no choice but to try and demangle each new one
 835    that comes in.  If the demangling succeeds, then we assume it is a C++
 836    symbol and set the symbol's language and demangled name fields
 837    appropriately.  Note that in order to avoid unnecessary demanglings, and
 838    allocating obstack space that subsequently can't be freed for the demangled
 839    names, we mark all newly added symbols with language_auto.  After
 840    compaction of the minimal symbols, we go back and scan the entire minimal
 841    symbol table looking for these new symbols.  For each new symbol we attempt
 842    to demangle it, and if successful, record it as a language_cplus symbol
 843    and cache the demangled form on the symbol obstack.  Symbols which don't
 844    demangle are marked as language_unknown symbols, which inhibits future
 845    attempts to demangle them if we later add more minimal symbols. */
 846
 847 void
 848 install_minimal_symbols (struct objfile *objfile)
 849 {
 850   int bindex;
 851   int mcount;
 852   struct msym_bunch *bunch;
 853   struct minimal_symbol *msymbols;
 854   int alloc_count;
 855   char leading_char;
 856
 857   if (msym_count > 0)
 858     {
 859       /* Allocate enough space in the obstack, into which we will gather the
 860          bunches of new and existing minimal symbols, sort them, and then
 861          compact out the duplicate entries.  Once we have a final table,
 862          we will give back the excess space.  */
 863
 864       alloc_count = msym_count + objfile->minimal_symbol_count + 1;
 865       obstack_blank (&objfile->symbol_obstack,
 866                      alloc_count * sizeof (struct minimal_symbol));
 867       msymbols = (struct minimal_symbol *)
 868         obstack_base (&objfile->symbol_obstack);
 869
 870       /* Copy in the existing minimal symbols, if there are any.  */
 871
 872       if (objfile->minimal_symbol_count)
 873         memcpy ((char *) msymbols, (char *) objfile->msymbols,
 874             objfile->minimal_symbol_count * sizeof (struct minimal_symbol));
 875
 876       /* Walk through the list of minimal symbol bunches, adding each symbol
 877          to the new contiguous array of symbols.  Note that we start with the
 878          current, possibly partially filled bunch (thus we use the current
 879          msym_bunch_index for the first bunch we copy over), and thereafter
 880          each bunch is full. */
 881
 882       mcount = objfile->minimal_symbol_count;
 883       leading_char = get_symbol_leading_char (objfile->obfd);
 884
 885       for (bunch = msym_bunch; bunch != NULL; bunch = bunch->next)
 886         {
 887           for (bindex = 0; bindex < msym_bunch_index; bindex++, mcount++)
 888             {
 889               msymbols[mcount] = bunch->contents[bindex];
 890               if (SYMBOL_LINKAGE_NAME (&msymbols[mcount])[0] == leading_char)
 891                 {
 892                   SYMBOL_LINKAGE_NAME (&msymbols[mcount])++;
 893                 }
 894             }
 895           msym_bunch_index = BUNCH_SIZE;
 896         }
 897
 898       /* Sort the minimal symbols by address.  */
 899
 900       qsort (msymbols, mcount, sizeof (struct minimal_symbol),
 901              compare_minimal_symbols);
 902
 903       /* Compact out any duplicates, and free up whatever space we are
 904          no longer using.  */
 905
 906       mcount = compact_minimal_symbols (msymbols, mcount, objfile);
 907
 908       obstack_blank (&objfile->symbol_obstack,
 909                (mcount + 1 - alloc_count) * sizeof (struct minimal_symbol));
 910       msymbols = (struct minimal_symbol *)
 911         obstack_finish (&objfile->symbol_obstack);
 912
 913       /* We also terminate the minimal symbol table with a "null symbol",
 914          which is *not* included in the size of the table.  This makes it
 915          easier to find the end of the table when we are handed a pointer
 916          to some symbol in the middle of it.  Zero out the fields in the
 917          "null symbol" allocated at the end of the array.  Note that the
 918          symbol count does *not* include this null symbol, which is why it
 919          is indexed by mcount and not mcount-1. */
 920
 921       SYMBOL_LINKAGE_NAME (&msymbols[mcount]) = NULL;
 922       SYMBOL_VALUE_ADDRESS (&msymbols[mcount]) = 0;
 923       MSYMBOL_INFO (&msymbols[mcount]) = NULL;
 924       MSYMBOL_TYPE (&msymbols[mcount]) = mst_unknown;
 925       SYMBOL_INIT_LANGUAGE_SPECIFIC (&msymbols[mcount], language_unknown);
 926
 927       /* Attach the minimal symbol table to the specified objfile.
 928          The strings themselves are also located in the symbol_obstack
 929          of this objfile.  */
 930
 931       objfile->minimal_symbol_count = mcount;
 932       objfile->msymbols = msymbols;
 933
 934       /* Try to guess the appropriate C++ ABI by looking at the names
 935          of the minimal symbols in the table.  */
 936       {
 937         int i;
 938
 939         for (i = 0; i < mcount; i++)
 940           {
 941             /* If a symbol's name starts with _Z and was successfully
 942                demangled, then we can assume we've found a GNU v3 symbol.
 943                For now we set the C++ ABI globally; if the user is
 944                mixing ABIs then the user will need to "set cp-abi"
 945                manually.  */
 946             const char *name = SYMBOL_LINKAGE_NAME (&objfile->msymbols[i]);
 947             if (name[0] == '_' && name[1] == 'Z'
 948                 && SYMBOL_DEMANGLED_NAME (&objfile->msymbols[i]) != NULL)
 949               {
 950                 set_cp_abi_as_auto_default ("gnu-v3");
 951                 break;
 952               }
 953           }
 954       }
 955
 956       /* Now build the hash tables; we can't do this incrementally
 957          at an earlier point since we weren't finished with the obstack
 958          yet.  (And if the msymbol obstack gets moved, all the internal
 959          pointers to other msymbols need to be adjusted.) */
 960       build_minimal_symbol_hash_tables (objfile);
 961     }
 962 }
 963
 964 /* Sort all the minimal symbols in OBJFILE.  */
 965
 966 void
 967 msymbols_sort (struct objfile *objfile)
 968 {
 969   qsort (objfile->msymbols, objfile->minimal_symbol_count,
 970          sizeof (struct minimal_symbol), compare_minimal_symbols);
 971   build_minimal_symbol_hash_tables (objfile);
 972 }
 973
 974 /* Check if PC is in a shared library trampoline code stub.
 975    Return minimal symbol for the trampoline entry or NULL if PC is not
 976    in a trampoline code stub.  */
 977
 978 struct minimal_symbol *
 979 lookup_solib_trampoline_symbol_by_pc (CORE_ADDR pc)
 980 {
 981   struct minimal_symbol *msymbol = lookup_minimal_symbol_by_pc (pc);
 982
 983   if (msymbol != NULL && MSYMBOL_TYPE (msymbol) == mst_solib_trampoline)
 984     return msymbol;
 985   return NULL;
 986 }
 987
 988 /* If PC is in a shared library trampoline code stub, return the
 989    address of the `real' function belonging to the stub.
 990    Return 0 if PC is not in a trampoline code stub or if the real
 991    function is not found in the minimal symbol table.
 992
 993    We may fail to find the right function if a function with the
 994    same name is defined in more than one shared library, but this
 995    is considered bad programming style. We could return 0 if we find
 996    a duplicate function in case this matters someday.  */
 997
 998 CORE_ADDR
 999 find_solib_trampoline_target (CORE_ADDR pc)
1000 {
1001   struct objfile *objfile;
1002   struct minimal_symbol *msymbol;
1003   struct minimal_symbol *tsymbol = lookup_solib_trampoline_symbol_by_pc (pc);
1004
1005   if (tsymbol != NULL)
1006     {
1007       ALL_MSYMBOLS (objfile, msymbol)
1008       {
1009         if (MSYMBOL_TYPE (msymbol) == mst_text
1010             && STREQ (SYMBOL_LINKAGE_NAME (msymbol),
1011                       SYMBOL_LINKAGE_NAME (tsymbol)))
1012           return SYMBOL_VALUE_ADDRESS (msymbol);
1013       }
1014     }
1015   return 0;
1016 }