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