gdb/minsyms.c

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