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