gdb/minsyms.c

   1 /* GDB routines for manipulating the minimal symbol tables.
   2    Copyright 1992 Free Software Foundation, Inc.
   3    Contributed by Cygnus Support, using pieces from other GDB modules.
   4
   5 This file is part of GDB.
   6
   7 This program is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 2 of the License, or
  10 (at your option) any later version.
  11
  12 This program is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with this program; if not, write to the Free Software
  19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
  20
  21
  22 /* This file contains support routines for creating, manipulating, and
  23    destroying minimal symbol tables.
  24
  25    Minimal symbol tables are used to hold some very basic information about
  26    all defined global symbols (text, data, bss, abs, etc).  The only two
  27    required pieces of information are the symbol's name and the address
  28    associated with that symbol.
  29
  30    In many cases, even if a file was compiled with no special options for
  31    debugging at all, as long as was not stripped it will contain sufficient
  32    information to build useful minimal symbol tables using this structure.
  33
  34    Even when a file contains enough debugging information to build a full
  35    symbol table, these minimal symbols are still useful for quickly mapping
  36    between names and addresses, and vice versa.  They are also sometimes used
  37    to figure out what full symbol table entries need to be read in. */
  38
  39
  40 #include "defs.h"
  41 #include "symtab.h"
  42 #include "bfd.h"
  43 #include "symfile.h"
  44 #include "objfiles.h"
  45 #include "demangle.h"
  46
  47 /* Accumulate the minimal symbols for each objfile in bunches of BUNCH_SIZE.
  48    At the end, copy them all into one newly allocated location on an objfile's
  49    symbol obstack.  */
  50
  51 #define BUNCH_SIZE 127
  52
  53 struct msym_bunch
  54 {
  55   struct msym_bunch *next;
  56   struct minimal_symbol contents[BUNCH_SIZE];
  57 };
  58
  59 /* Bunch currently being filled up.
  60    The next field points to chain of filled bunches.  */
  61
  62 static struct msym_bunch *msym_bunch;
  63
  64 /* Number of slots filled in current bunch.  */
  65
  66 static int msym_bunch_index;
  67
  68 /* Total number of minimal symbols recorded so far for the objfile.  */
  69
  70 static int msym_count;
  71
  72 /* Prototypes for local functions. */
  73
  74 static int
  75 compare_minimal_symbols PARAMS ((const void *, const void *));
  76
  77 static int
  78 compact_minimal_symbols PARAMS ((struct minimal_symbol *, int));
  79
  80 /* Look through all the current minimal symbol tables and find the first
  81    minimal symbol that matches NAME.  If OBJF is non-NULL, it specifies a
  82    particular objfile and the search is limited to that objfile.  Returns
  83    a pointer to the minimal symbol that matches, or NULL if no match is found.
  84
  85    Note:  One instance where there may be duplicate minimal symbols with
  86    the same name is when the symbol tables for a shared library and the
  87    symbol tables for an executable contain global symbols with the same
  88    names (the dynamic linker deals with the duplication). */
  89
  90 struct minimal_symbol *
  91 lookup_minimal_symbol (name, objf)
  92      register const char *name;
  93      struct objfile *objf;
  94 {
  95   struct objfile *objfile;
  96   struct minimal_symbol *msymbol;
  97   struct minimal_symbol *found_symbol = NULL;
  98   struct minimal_symbol *found_file_symbol = NULL;
  99 #ifdef IBM6000_TARGET
 100   struct minimal_symbol *trampoline_symbol = NULL;
 101 #endif
 102
 103   for (objfile = object_files;
 104        objfile != NULL && found_symbol == NULL;
 105        objfile = objfile -> next)
 106     {
 107       if (objf == NULL || objf == objfile)
 108         {
 109           for (msymbol = objfile -> msymbols;
 110                msymbol != NULL && SYMBOL_NAME (msymbol) != NULL &&
 111                found_symbol == NULL;
 112                msymbol++)
 113             {
 114               if (SYMBOL_MATCHES_NAME (msymbol, name))
 115                 {
 116                   switch (MSYMBOL_TYPE (msymbol))
 117                     {
 118                     case mst_file_text:
 119                     case mst_file_data:
 120                     case mst_file_bss:
 121                       /* It is file-local.  If we find more than one, just
 122                          return the latest one (the user can't expect
 123                          useful behavior in that case).  */
 124                       found_file_symbol = msymbol;
 125                       break;
 126
 127                     case mst_unknown:
 128 #ifdef IBM6000_TARGET
 129                       /* I *think* all platforms using shared
 130                          libraries (and trampoline code) will suffer
 131                          this problem. Consider a case where there are
 132                          5 shared libraries, each referencing `foo'
 133                          with a trampoline entry. When someone wants
 134                          to put a breakpoint on `foo' and the only
 135                          info we have is minimal symbol vector, we
 136                          want to use the real `foo', rather than one
 137                          of those trampoline entries. MGO */
 138
 139                       /* If a trampoline symbol is found, we prefer to
 140                          keep looking for the *real* symbol. If the
 141                          actual symbol not found, then we'll use the
 142                          trampoline entry. Sorry for the machine
 143                          dependent code here, but I hope this will
 144                          benefit other platforms as well. For
 145                          trampoline entries, we used mst_unknown
 146                          earlier. Perhaps we should define a
 147                          `mst_trampoline' type?? */
 148
 149                       if (trampoline_symbol == NULL)
 150                         trampoline_symbol = msymbol;
 151                       break;
 152 #else
 153                       /* FALLTHROUGH */
 154 #endif
 155                     default:
 156                       found_symbol = msymbol;
 157                       break;
 158                     }
 159                 }
 160             }
 161         }
 162     }
 163   /* External symbols are best.  */
 164   if (found_symbol)
 165     return found_symbol;
 166
 167   /* File-local symbols are next best.  */
 168   if (found_file_symbol)
 169     return found_file_symbol;
 170
 171   /* Symbols for IBM shared library trampolines are next best.  */
 172 #ifdef IBM6000_TARGET
 173   if (trampoline_symbol)
 174     return trampoline_symbol;
 175 #endif
 176
 177   return NULL;
 178 }
 179
 180
 181 /* Search through the minimal symbol table for each objfile and find the
 182    symbol whose address is the largest address that is still less than or
 183    equal to PC.  Returns a pointer to the minimal symbol if such a symbol
 184    is found, or NULL if PC is not in a suitable range.  Note that we need
 185    to look through ALL the minimal symbol tables before deciding on the
 186    symbol that comes closest to the specified PC.  This is because objfiles
 187    can overlap, for example objfile A has .text at 0x100 and .data at 0x40000
 188    and objfile B has .text at 0x234 and .data at 0x40048.  */
 189
 190 struct minimal_symbol *
 191 lookup_minimal_symbol_by_pc (pc)
 192      register CORE_ADDR pc;
 193 {
 194   register int lo;
 195   register int hi;
 196   register int new;
 197   register struct objfile *objfile;
 198   register struct minimal_symbol *msymbol;
 199   register struct minimal_symbol *best_symbol = NULL;
 200
 201   for (objfile = object_files;
 202        objfile != NULL;
 203        objfile = objfile -> next)
 204     {
 205       /* If this objfile has a minimal symbol table, go search it using
 206          a binary search.  Note that a minimal symbol table always consists
 207          of at least two symbols, a "real" symbol and the terminating
 208          "null symbol".  If there are no real symbols, then there is no
 209          minimal symbol table at all. */
 210
 211       if ((msymbol = objfile -> msymbols) != NULL)
 212         {
 213           lo = 0;
 214           hi = objfile -> minimal_symbol_count - 1;
 215
 216           /* This code assumes that the minimal symbols are sorted by
 217              ascending address values.  If the pc value is greater than or
 218              equal to the first symbol's address, then some symbol in this
 219              minimal symbol table is a suitable candidate for being the
 220              "best" symbol.  This includes the last real symbol, for cases
 221              where the pc value is larger than any address in this vector.
 222
 223              By iterating until the address associated with the current
 224              hi index (the endpoint of the test interval) is less than
 225              or equal to the desired pc value, we accomplish two things:
 226              (1) the case where the pc value is larger than any minimal
 227              symbol address is trivially solved, (2) the address associated
 228              with the hi index is always the one we want when the interation
 229              terminates.  In essence, we are iterating the test interval
 230              down until the pc value is pushed out of it from the high end.
 231
 232              Warning: this code is trickier than it would appear at first. */
 233
 234           /* Should also requires that pc is <= end of objfile.  FIXME! */
 235           if (pc >= SYMBOL_VALUE_ADDRESS (&msymbol[lo]))
 236             {
 237               while (SYMBOL_VALUE_ADDRESS (&msymbol[hi]) > pc)
 238                 {
 239                   /* pc is still strictly less than highest address */
 240                   /* Note "new" will always be >= lo */
 241                   new = (lo + hi) / 2;
 242                   if ((SYMBOL_VALUE_ADDRESS (&msymbol[new]) >= pc) ||
 243                       (lo == new))
 244                     {
 245                       hi = new;
 246                     }
 247                   else
 248                     {
 249                       lo = new;
 250                     }
 251                 }
 252               /* The minimal symbol indexed by hi now is the best one in this
 253                  objfile's minimal symbol table.  See if it is the best one
 254                  overall. */
 255
 256               /* Skip any absolute symbols.  This is apparently what adb
 257                  and dbx do, and is needed for the CM-5.  There are two
 258                  known possible problems: (1) on ELF, apparently end, edata,
 259                  etc. are absolute.  Not sure ignoring them here is a big
 260                  deal, but if we want to use them, the fix would go in
 261                  elfread.c.  (2) I think shared library entry points on the
 262                  NeXT are absolute.  If we want special handling for this
 263                  it probably should be triggered by a special
 264                  mst_abs_or_lib or some such.  */
 265               while (hi >= 0
 266                      && msymbol[hi].type == mst_abs)
 267                 --hi;
 268
 269               if (hi >= 0
 270                   && ((best_symbol == NULL) ||
 271                       (SYMBOL_VALUE_ADDRESS (best_symbol) <
 272                        SYMBOL_VALUE_ADDRESS (&msymbol[hi]))))
 273                 {
 274                   best_symbol = &msymbol[hi];
 275                 }
 276             }
 277         }
 278     }
 279   return (best_symbol);
 280 }
 281
 282 /* Prepare to start collecting minimal symbols.  Note that presetting
 283    msym_bunch_index to BUNCH_SIZE causes the first call to save a minimal
 284    symbol to allocate the memory for the first bunch. */
 285
 286 void
 287 init_minimal_symbol_collection ()
 288 {
 289   msym_count = 0;
 290   msym_bunch = NULL;
 291   msym_bunch_index = BUNCH_SIZE;
 292 }
 293
 294 void
 295 prim_record_minimal_symbol (name, address, ms_type, objfile)
 296      const char *name;
 297      CORE_ADDR address;
 298      enum minimal_symbol_type ms_type;
 299      struct objfile *objfile;
 300 {
 301   prim_record_minimal_symbol (name, address, ms_type, NULL, -1, objfile);
 302 }
 303
 304 void
 305 prim_record_minimal_symbol_and_info (name, address, ms_type, info, section,
 306                                      objfile)
 307      const char *name;
 308      CORE_ADDR address;
 309      enum minimal_symbol_type ms_type;
 310      char *info;
 311      int section;
 312      struct objfile *objfile;
 313 {
 314   register struct msym_bunch *new;
 315   register struct minimal_symbol *msymbol;
 316
 317   if (ms_type == mst_file_text)
 318     {
 319       /* Don't put gcc_compiled, __gnu_compiled_cplus, and friends into
 320          the minimal symbols, because if there is also another symbol
 321          at the same address (e.g. the first function of the file),
 322          lookup_minimal_symbol_by_pc would have no way of getting the
 323          right one.  */
 324       if (name[0] == 'g'
 325           && (strcmp (name, GCC_COMPILED_FLAG_SYMBOL) == 0
 326               || strcmp (name, GCC2_COMPILED_FLAG_SYMBOL) == 0))
 327         return;
 328
 329       {
 330         char *tempstring = name;
 331         if (tempstring[0] == bfd_get_symbol_leading_char (objfile->obfd))
 332           ++tempstring;
 333         if (STREQN (tempstring, "__gnu_compiled", 14))
 334           return;
 335       }
 336     }
 337
 338   if (msym_bunch_index == BUNCH_SIZE)
 339     {
 340       new = (struct msym_bunch *) xmalloc (sizeof (struct msym_bunch));
 341       msym_bunch_index = 0;
 342       new -> next = msym_bunch;
 343       msym_bunch = new;
 344     }
 345   msymbol = &msym_bunch -> contents[msym_bunch_index];
 346   SYMBOL_NAME (msymbol) = (char *) name;
 347   SYMBOL_INIT_LANGUAGE_SPECIFIC (msymbol, language_unknown);
 348   SYMBOL_VALUE_ADDRESS (msymbol) = address;
 349   SYMBOL_SECTION (msymbol) = section;
 350   MSYMBOL_TYPE (msymbol) = ms_type;
 351   /* FIXME:  This info, if it remains, needs its own field.  */
 352   MSYMBOL_INFO (msymbol) = info; /* FIXME! */
 353   msym_bunch_index++;
 354   msym_count++;
 355 }
 356
 357 /* Compare two minimal symbols by address and return a signed result based
 358    on unsigned comparisons, so that we sort into unsigned numeric order.  */
 359
 360 static int
 361 compare_minimal_symbols (fn1p, fn2p)
 362      const PTR fn1p;
 363      const PTR fn2p;
 364 {
 365   register const struct minimal_symbol *fn1;
 366   register const struct minimal_symbol *fn2;
 367
 368   fn1 = (const struct minimal_symbol *) fn1p;
 369   fn2 = (const struct minimal_symbol *) fn2p;
 370
 371   if (SYMBOL_VALUE_ADDRESS (fn1) < SYMBOL_VALUE_ADDRESS (fn2))
 372     {
 373       return (-1);
 374     }
 375   else if (SYMBOL_VALUE_ADDRESS (fn1) > SYMBOL_VALUE_ADDRESS (fn2))
 376     {
 377       return (1);
 378     }
 379   else
 380     {
 381       return (0);
 382     }
 383 }
 384
 385 /* Discard the currently collected minimal symbols, if any.  If we wish
 386    to save them for later use, we must have already copied them somewhere
 387    else before calling this function.
 388
 389    FIXME:  We could allocate the minimal symbol bunches on their own
 390    obstack and then simply blow the obstack away when we are done with
 391    it.  Is it worth the extra trouble though? */
 392
 393 /* ARGSUSED */
 394 void
 395 discard_minimal_symbols (foo)
 396      int foo;
 397 {
 398   register struct msym_bunch *next;
 399
 400   while (msym_bunch != NULL)
 401     {
 402       next = msym_bunch -> next;
 403       free ((PTR)msym_bunch);
 404       msym_bunch = next;
 405     }
 406 }
 407
 408 /* Compact duplicate entries out of a minimal symbol table by walking
 409    through the table and compacting out entries with duplicate addresses
 410    and matching names.  Return the number of entries remaining.
 411
 412    On entry, the table resides between msymbol[0] and msymbol[mcount].
 413    On exit, it resides between msymbol[0] and msymbol[result_count].
 414
 415    When files contain multiple sources of symbol information, it is
 416    possible for the minimal symbol table to contain many duplicate entries.
 417    As an example, SVR4 systems use ELF formatted object files, which
 418    usually contain at least two different types of symbol tables (a
 419    standard ELF one and a smaller dynamic linking table), as well as
 420    DWARF debugging information for files compiled with -g.
 421
 422    Without compacting, the minimal symbol table for gdb itself contains
 423    over a 1000 duplicates, about a third of the total table size.  Aside
 424    from the potential trap of not noticing that two successive entries
 425    identify the same location, this duplication impacts the time required
 426    to linearly scan the table, which is done in a number of places.  So we
 427    just do one linear scan here and toss out the duplicates.
 428
 429    Note that we are not concerned here about recovering the space that
 430    is potentially freed up, because the strings themselves are allocated
 431    on the symbol_obstack, and will get automatically freed when the symbol
 432    table is freed.  The caller can free up the unused minimal symbols at
 433    the end of the compacted region if their allocation strategy allows it.
 434
 435    Also note we only go up to the next to last entry within the loop
 436    and then copy the last entry explicitly after the loop terminates.
 437
 438    Since the different sources of information for each symbol may
 439    have different levels of "completeness", we may have duplicates
 440    that have one entry with type "mst_unknown" and the other with a
 441    known type.  So if the one we are leaving alone has type mst_unknown,
 442    overwrite its type with the type from the one we are compacting out.  */
 443
 444 static int
 445 compact_minimal_symbols (msymbol, mcount)
 446      struct minimal_symbol *msymbol;
 447      int mcount;
 448 {
 449   struct minimal_symbol *copyfrom;
 450   struct minimal_symbol *copyto;
 451
 452   if (mcount > 0)
 453     {
 454       copyfrom = copyto = msymbol;
 455       while (copyfrom < msymbol + mcount - 1)
 456         {
 457           if (SYMBOL_VALUE_ADDRESS (copyfrom) ==
 458               SYMBOL_VALUE_ADDRESS ((copyfrom + 1)) &&
 459               (STREQ (SYMBOL_NAME (copyfrom), SYMBOL_NAME ((copyfrom + 1)))))
 460             {
 461               if (MSYMBOL_TYPE((copyfrom + 1)) == mst_unknown)
 462                 {
 463                   MSYMBOL_TYPE ((copyfrom + 1)) = MSYMBOL_TYPE (copyfrom);
 464                 }
 465               copyfrom++;
 466             }
 467           else
 468             {
 469               *copyto++ = *copyfrom++;
 470             }
 471         }
 472       *copyto++ = *copyfrom++;
 473       mcount = copyto - msymbol;
 474     }
 475   return (mcount);
 476 }
 477
 478 /* Add the minimal symbols in the existing bunches to the objfile's official
 479    minimal symbol table.  In most cases there is no minimal symbol table yet
 480    for this objfile, and the existing bunches are used to create one.  Once
 481    in a while (for shared libraries for example), we add symbols (e.g. common
 482    symbols) to an existing objfile.
 483
 484    Because of the way minimal symbols are collected, we generally have no way
 485    of knowing what source language applies to any particular minimal symbol.
 486    Specifically, we have no way of knowing if the minimal symbol comes from a
 487    C++ compilation unit or not.  So for the sake of supporting cached
 488    demangled C++ names, we have no choice but to try and demangle each new one
 489    that comes in.  If the demangling succeeds, then we assume it is a C++
 490    symbol and set the symbol's language and demangled name fields
 491    appropriately.  Note that in order to avoid unnecessary demanglings, and
 492    allocating obstack space that subsequently can't be freed for the demangled
 493    names, we mark all newly added symbols with language_auto.  After
 494    compaction of the minimal symbols, we go back and scan the entire minimal
 495    symbol table looking for these new symbols.  For each new symbol we attempt
 496    to demangle it, and if successful, record it as a language_cplus symbol
 497    and cache the demangled form on the symbol obstack.  Symbols which don't
 498    demangle are marked as language_unknown symbols, which inhibits future
 499    attempts to demangle them if we later add more minimal symbols. */
 500
 501 void
 502 install_minimal_symbols (objfile)
 503      struct objfile *objfile;
 504 {
 505   register int bindex;
 506   register int mcount;
 507   register struct msym_bunch *bunch;
 508   register struct minimal_symbol *msymbols;
 509   int alloc_count;
 510   register char leading_char;
 511
 512   if (msym_count > 0)
 513     {
 514       /* Allocate enough space in the obstack, into which we will gather the
 515          bunches of new and existing minimal symbols, sort them, and then
 516          compact out the duplicate entries.  Once we have a final table,
 517          we will give back the excess space.  */
 518
 519       alloc_count = msym_count + objfile->minimal_symbol_count + 1;
 520       obstack_blank (&objfile->symbol_obstack,
 521                      alloc_count * sizeof (struct minimal_symbol));
 522       msymbols = (struct minimal_symbol *)
 523                  obstack_base (&objfile->symbol_obstack);
 524
 525       /* Copy in the existing minimal symbols, if there are any.  */
 526
 527       if (objfile->minimal_symbol_count)
 528         memcpy ((char *)msymbols, (char *)objfile->msymbols,
 529                 objfile->minimal_symbol_count * sizeof (struct minimal_symbol));
 530
 531       /* Walk through the list of minimal symbol bunches, adding each symbol
 532          to the new contiguous array of symbols.  Note that we start with the
 533          current, possibly partially filled bunch (thus we use the current
 534          msym_bunch_index for the first bunch we copy over), and thereafter
 535          each bunch is full. */
 536
 537       mcount = objfile->minimal_symbol_count;
 538       leading_char = bfd_get_symbol_leading_char (objfile->obfd);
 539
 540       for (bunch = msym_bunch; bunch != NULL; bunch = bunch -> next)
 541         {
 542           for (bindex = 0; bindex < msym_bunch_index; bindex++, mcount++)
 543             {
 544               msymbols[mcount] = bunch -> contents[bindex];
 545               SYMBOL_LANGUAGE (&msymbols[mcount]) = language_auto;
 546               if (SYMBOL_NAME (&msymbols[mcount])[0] == leading_char)
 547                 {
 548                   SYMBOL_NAME(&msymbols[mcount])++;
 549                 }
 550             }
 551           msym_bunch_index = BUNCH_SIZE;
 552         }
 553
 554       /* Sort the minimal symbols by address.  */
 555
 556       qsort (msymbols, mcount, sizeof (struct minimal_symbol),
 557              compare_minimal_symbols);
 558
 559       /* Compact out any duplicates, and free up whatever space we are
 560          no longer using.  */
 561
 562       mcount = compact_minimal_symbols (msymbols, mcount);
 563
 564       obstack_blank (&objfile->symbol_obstack,
 565         (mcount + 1 - alloc_count) * sizeof (struct minimal_symbol));
 566       msymbols = (struct minimal_symbol *)
 567         obstack_finish (&objfile->symbol_obstack);
 568
 569       /* We also terminate the minimal symbol table with a "null symbol",
 570          which is *not* included in the size of the table.  This makes it
 571          easier to find the end of the table when we are handed a pointer
 572          to some symbol in the middle of it.  Zero out the fields in the
 573          "null symbol" allocated at the end of the array.  Note that the
 574          symbol count does *not* include this null symbol, which is why it
 575          is indexed by mcount and not mcount-1. */
 576
 577       SYMBOL_NAME (&msymbols[mcount]) = NULL;
 578       SYMBOL_VALUE_ADDRESS (&msymbols[mcount]) = 0;
 579       MSYMBOL_INFO (&msymbols[mcount]) = NULL;
 580       MSYMBOL_TYPE (&msymbols[mcount]) = mst_unknown;
 581       SYMBOL_INIT_LANGUAGE_SPECIFIC (&msymbols[mcount], language_unknown);
 582
 583       /* Attach the minimal symbol table to the specified objfile.
 584          The strings themselves are also located in the symbol_obstack
 585          of this objfile.  */
 586
 587       objfile -> minimal_symbol_count = mcount;
 588       objfile -> msymbols = msymbols;
 589
 590       /* Now walk through all the minimal symbols, selecting the newly added
 591          ones and attempting to cache their C++ demangled names. */
 592
 593       for ( ; mcount-- > 0 ; msymbols++)
 594         {
 595           SYMBOL_INIT_DEMANGLED_NAME (msymbols, &objfile->symbol_obstack);
 596         }
 597     }
 598 }
 599