1 /* GDB routines for manipulating the minimal symbol tables.
2 Copyright 1992, 1993, 1994 Free Software Foundation, Inc.
3 Contributed by Cygnus Support, using pieces from other GDB modules.
5 This file is part of GDB.
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.
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.
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. */
22 /* This file contains support routines for creating, manipulating, and
23 destroying minimal symbol tables.
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.
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.
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. */
47 #include "gdb-stabs.h"
49 /* Accumulate the minimal symbols for each objfile in bunches of BUNCH_SIZE.
50 At the end, copy them all into one newly allocated location on an objfile's
53 #define BUNCH_SIZE 127
57 struct msym_bunch *next;
58 struct minimal_symbol contents[BUNCH_SIZE];
61 /* Bunch currently being filled up.
62 The next field points to chain of filled bunches. */
64 static struct msym_bunch *msym_bunch;
66 /* Number of slots filled in current bunch. */
68 static int msym_bunch_index;
70 /* Total number of minimal symbols recorded so far for the objfile. */
72 static int msym_count;
74 /* Prototypes for local functions. */
77 compare_minimal_symbols PARAMS ((const void *, const void *));
80 compact_minimal_symbols PARAMS ((struct minimal_symbol *, int));
82 /* Look through all the current minimal symbol tables and find the first
83 minimal symbol that matches NAME. If OBJF is non-NULL, it specifies a
84 particular objfile and the search is limited to that objfile. Returns
85 a pointer to the minimal symbol that matches, or NULL if no match is found.
87 Note: One instance where there may be duplicate minimal symbols with
88 the same name is when the symbol tables for a shared library and the
89 symbol tables for an executable contain global symbols with the same
90 names (the dynamic linker deals with the duplication). */
92 struct minimal_symbol *
93 lookup_minimal_symbol (name, objf)
94 register const char *name;
97 struct objfile *objfile;
98 struct minimal_symbol *msymbol;
99 struct minimal_symbol *found_symbol = NULL;
100 struct minimal_symbol *found_file_symbol = NULL;
101 struct minimal_symbol *trampoline_symbol = NULL;
103 for (objfile = object_files;
104 objfile != NULL && found_symbol == NULL;
105 objfile = objfile -> next)
107 if (objf == NULL || objf == objfile)
109 for (msymbol = objfile -> msymbols;
110 msymbol != NULL && SYMBOL_NAME (msymbol) != NULL &&
111 found_symbol == NULL;
114 if (SYMBOL_MATCHES_NAME (msymbol, name))
116 switch (MSYMBOL_TYPE (msymbol))
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;
127 case mst_solib_trampoline:
129 /* If a trampoline symbol is found, we prefer to
130 keep looking for the *real* symbol. If the
131 actual symbol is not found, then we'll use the
133 if (trampoline_symbol == NULL)
134 trampoline_symbol = msymbol;
139 found_symbol = msymbol;
146 /* External symbols are best. */
150 /* File-local symbols are next best. */
151 if (found_file_symbol)
152 return found_file_symbol;
154 /* Symbols for shared library trampolines are next best. */
155 if (trampoline_symbol)
156 return trampoline_symbol;
162 /* Search through the minimal symbol table for each objfile and find the
163 symbol whose address is the largest address that is still less than or
164 equal to PC. Returns a pointer to the minimal symbol if such a symbol
165 is found, or NULL if PC is not in a suitable range. Note that we need
166 to look through ALL the minimal symbol tables before deciding on the
167 symbol that comes closest to the specified PC. This is because objfiles
168 can overlap, for example objfile A has .text at 0x100 and .data at 0x40000
169 and objfile B has .text at 0x234 and .data at 0x40048. */
171 struct minimal_symbol *
172 lookup_minimal_symbol_by_pc (pc)
173 register CORE_ADDR pc;
178 register struct objfile *objfile;
179 register struct minimal_symbol *msymbol;
180 register struct minimal_symbol *best_symbol = NULL;
182 for (objfile = object_files;
184 objfile = objfile -> next)
186 /* If this objfile has a minimal symbol table, go search it using
187 a binary search. Note that a minimal symbol table always consists
188 of at least two symbols, a "real" symbol and the terminating
189 "null symbol". If there are no real symbols, then there is no
190 minimal symbol table at all. */
192 if ((msymbol = objfile -> msymbols) != NULL)
195 hi = objfile -> minimal_symbol_count - 1;
197 /* This code assumes that the minimal symbols are sorted by
198 ascending address values. If the pc value is greater than or
199 equal to the first symbol's address, then some symbol in this
200 minimal symbol table is a suitable candidate for being the
201 "best" symbol. This includes the last real symbol, for cases
202 where the pc value is larger than any address in this vector.
204 By iterating until the address associated with the current
205 hi index (the endpoint of the test interval) is less than
206 or equal to the desired pc value, we accomplish two things:
207 (1) the case where the pc value is larger than any minimal
208 symbol address is trivially solved, (2) the address associated
209 with the hi index is always the one we want when the interation
210 terminates. In essence, we are iterating the test interval
211 down until the pc value is pushed out of it from the high end.
213 Warning: this code is trickier than it would appear at first. */
215 /* Should also requires that pc is <= end of objfile. FIXME! */
216 if (pc >= SYMBOL_VALUE_ADDRESS (&msymbol[lo]))
218 while (SYMBOL_VALUE_ADDRESS (&msymbol[hi]) > pc)
220 /* pc is still strictly less than highest address */
221 /* Note "new" will always be >= lo */
223 if ((SYMBOL_VALUE_ADDRESS (&msymbol[new]) >= pc) ||
233 /* The minimal symbol indexed by hi now is the best one in this
234 objfile's minimal symbol table. See if it is the best one
237 /* Skip any absolute symbols. This is apparently what adb
238 and dbx do, and is needed for the CM-5. There are two
239 known possible problems: (1) on ELF, apparently end, edata,
240 etc. are absolute. Not sure ignoring them here is a big
241 deal, but if we want to use them, the fix would go in
242 elfread.c. (2) I think shared library entry points on the
243 NeXT are absolute. If we want special handling for this
244 it probably should be triggered by a special
245 mst_abs_or_lib or some such. */
247 && msymbol[hi].type == mst_abs)
251 && ((best_symbol == NULL) ||
252 (SYMBOL_VALUE_ADDRESS (best_symbol) <
253 SYMBOL_VALUE_ADDRESS (&msymbol[hi]))))
255 best_symbol = &msymbol[hi];
260 return (best_symbol);
263 /* Prepare to start collecting minimal symbols. Note that presetting
264 msym_bunch_index to BUNCH_SIZE causes the first call to save a minimal
265 symbol to allocate the memory for the first bunch. */
268 init_minimal_symbol_collection ()
272 msym_bunch_index = BUNCH_SIZE;
276 prim_record_minimal_symbol (name, address, ms_type, objfile)
279 enum minimal_symbol_type ms_type;
280 struct objfile *objfile;
288 case mst_solib_trampoline:
289 section = SECT_OFF_TEXT;
293 section = SECT_OFF_DATA;
297 section = SECT_OFF_BSS;
303 prim_record_minimal_symbol_and_info (name, address, ms_type,
304 NULL, section, objfile);
308 prim_record_minimal_symbol_and_info (name, address, ms_type, info, section,
312 enum minimal_symbol_type ms_type;
315 struct objfile *objfile;
317 register struct msym_bunch *new;
318 register struct minimal_symbol *msymbol;
320 if (ms_type == mst_file_text)
322 /* Don't put gcc_compiled, __gnu_compiled_cplus, and friends into
323 the minimal symbols, because if there is also another symbol
324 at the same address (e.g. the first function of the file),
325 lookup_minimal_symbol_by_pc would have no way of getting the
328 && (strcmp (name, GCC_COMPILED_FLAG_SYMBOL) == 0
329 || strcmp (name, GCC2_COMPILED_FLAG_SYMBOL) == 0))
333 const char *tempstring = name;
334 if (tempstring[0] == bfd_get_symbol_leading_char (objfile->obfd))
336 if (STREQN (tempstring, "__gnu_compiled", 14))
341 if (msym_bunch_index == BUNCH_SIZE)
343 new = (struct msym_bunch *) xmalloc (sizeof (struct msym_bunch));
344 msym_bunch_index = 0;
345 new -> next = msym_bunch;
348 msymbol = &msym_bunch -> contents[msym_bunch_index];
349 SYMBOL_NAME (msymbol) = (char *) name;
350 SYMBOL_INIT_LANGUAGE_SPECIFIC (msymbol, language_unknown);
351 SYMBOL_VALUE_ADDRESS (msymbol) = address;
352 SYMBOL_SECTION (msymbol) = section;
354 MSYMBOL_TYPE (msymbol) = ms_type;
355 /* FIXME: This info, if it remains, needs its own field. */
356 MSYMBOL_INFO (msymbol) = info; /* FIXME! */
361 /* Compare two minimal symbols by address and return a signed result based
362 on unsigned comparisons, so that we sort into unsigned numeric order. */
365 compare_minimal_symbols (fn1p, fn2p)
369 register const struct minimal_symbol *fn1;
370 register const struct minimal_symbol *fn2;
372 fn1 = (const struct minimal_symbol *) fn1p;
373 fn2 = (const struct minimal_symbol *) fn2p;
375 if (SYMBOL_VALUE_ADDRESS (fn1) < SYMBOL_VALUE_ADDRESS (fn2))
379 else if (SYMBOL_VALUE_ADDRESS (fn1) > SYMBOL_VALUE_ADDRESS (fn2))
389 /* Discard the currently collected minimal symbols, if any. If we wish
390 to save them for later use, we must have already copied them somewhere
391 else before calling this function.
393 FIXME: We could allocate the minimal symbol bunches on their own
394 obstack and then simply blow the obstack away when we are done with
395 it. Is it worth the extra trouble though? */
399 discard_minimal_symbols (foo)
402 register struct msym_bunch *next;
404 while (msym_bunch != NULL)
406 next = msym_bunch -> next;
407 free ((PTR)msym_bunch);
412 /* Compact duplicate entries out of a minimal symbol table by walking
413 through the table and compacting out entries with duplicate addresses
414 and matching names. Return the number of entries remaining.
416 On entry, the table resides between msymbol[0] and msymbol[mcount].
417 On exit, it resides between msymbol[0] and msymbol[result_count].
419 When files contain multiple sources of symbol information, it is
420 possible for the minimal symbol table to contain many duplicate entries.
421 As an example, SVR4 systems use ELF formatted object files, which
422 usually contain at least two different types of symbol tables (a
423 standard ELF one and a smaller dynamic linking table), as well as
424 DWARF debugging information for files compiled with -g.
426 Without compacting, the minimal symbol table for gdb itself contains
427 over a 1000 duplicates, about a third of the total table size. Aside
428 from the potential trap of not noticing that two successive entries
429 identify the same location, this duplication impacts the time required
430 to linearly scan the table, which is done in a number of places. So we
431 just do one linear scan here and toss out the duplicates.
433 Note that we are not concerned here about recovering the space that
434 is potentially freed up, because the strings themselves are allocated
435 on the symbol_obstack, and will get automatically freed when the symbol
436 table is freed. The caller can free up the unused minimal symbols at
437 the end of the compacted region if their allocation strategy allows it.
439 Also note we only go up to the next to last entry within the loop
440 and then copy the last entry explicitly after the loop terminates.
442 Since the different sources of information for each symbol may
443 have different levels of "completeness", we may have duplicates
444 that have one entry with type "mst_unknown" and the other with a
445 known type. So if the one we are leaving alone has type mst_unknown,
446 overwrite its type with the type from the one we are compacting out. */
449 compact_minimal_symbols (msymbol, mcount)
450 struct minimal_symbol *msymbol;
453 struct minimal_symbol *copyfrom;
454 struct minimal_symbol *copyto;
458 copyfrom = copyto = msymbol;
459 while (copyfrom < msymbol + mcount - 1)
461 if (SYMBOL_VALUE_ADDRESS (copyfrom) ==
462 SYMBOL_VALUE_ADDRESS ((copyfrom + 1)) &&
463 (STREQ (SYMBOL_NAME (copyfrom), SYMBOL_NAME ((copyfrom + 1)))))
465 if (MSYMBOL_TYPE((copyfrom + 1)) == mst_unknown)
467 MSYMBOL_TYPE ((copyfrom + 1)) = MSYMBOL_TYPE (copyfrom);
473 *copyto++ = *copyfrom++;
476 *copyto++ = *copyfrom++;
477 mcount = copyto - msymbol;
482 /* Add the minimal symbols in the existing bunches to the objfile's official
483 minimal symbol table. In most cases there is no minimal symbol table yet
484 for this objfile, and the existing bunches are used to create one. Once
485 in a while (for shared libraries for example), we add symbols (e.g. common
486 symbols) to an existing objfile.
488 Because of the way minimal symbols are collected, we generally have no way
489 of knowing what source language applies to any particular minimal symbol.
490 Specifically, we have no way of knowing if the minimal symbol comes from a
491 C++ compilation unit or not. So for the sake of supporting cached
492 demangled C++ names, we have no choice but to try and demangle each new one
493 that comes in. If the demangling succeeds, then we assume it is a C++
494 symbol and set the symbol's language and demangled name fields
495 appropriately. Note that in order to avoid unnecessary demanglings, and
496 allocating obstack space that subsequently can't be freed for the demangled
497 names, we mark all newly added symbols with language_auto. After
498 compaction of the minimal symbols, we go back and scan the entire minimal
499 symbol table looking for these new symbols. For each new symbol we attempt
500 to demangle it, and if successful, record it as a language_cplus symbol
501 and cache the demangled form on the symbol obstack. Symbols which don't
502 demangle are marked as language_unknown symbols, which inhibits future
503 attempts to demangle them if we later add more minimal symbols. */
506 install_minimal_symbols (objfile)
507 struct objfile *objfile;
511 register struct msym_bunch *bunch;
512 register struct minimal_symbol *msymbols;
514 register char leading_char;
518 /* Allocate enough space in the obstack, into which we will gather the
519 bunches of new and existing minimal symbols, sort them, and then
520 compact out the duplicate entries. Once we have a final table,
521 we will give back the excess space. */
523 alloc_count = msym_count + objfile->minimal_symbol_count + 1;
524 obstack_blank (&objfile->symbol_obstack,
525 alloc_count * sizeof (struct minimal_symbol));
526 msymbols = (struct minimal_symbol *)
527 obstack_base (&objfile->symbol_obstack);
529 /* Copy in the existing minimal symbols, if there are any. */
531 if (objfile->minimal_symbol_count)
532 memcpy ((char *)msymbols, (char *)objfile->msymbols,
533 objfile->minimal_symbol_count * sizeof (struct minimal_symbol));
535 /* Walk through the list of minimal symbol bunches, adding each symbol
536 to the new contiguous array of symbols. Note that we start with the
537 current, possibly partially filled bunch (thus we use the current
538 msym_bunch_index for the first bunch we copy over), and thereafter
539 each bunch is full. */
541 mcount = objfile->minimal_symbol_count;
542 leading_char = bfd_get_symbol_leading_char (objfile->obfd);
544 for (bunch = msym_bunch; bunch != NULL; bunch = bunch -> next)
546 for (bindex = 0; bindex < msym_bunch_index; bindex++, mcount++)
548 msymbols[mcount] = bunch -> contents[bindex];
549 SYMBOL_LANGUAGE (&msymbols[mcount]) = language_auto;
550 if (SYMBOL_NAME (&msymbols[mcount])[0] == leading_char)
552 SYMBOL_NAME(&msymbols[mcount])++;
555 msym_bunch_index = BUNCH_SIZE;
558 /* Sort the minimal symbols by address. */
560 qsort (msymbols, mcount, sizeof (struct minimal_symbol),
561 compare_minimal_symbols);
563 /* Compact out any duplicates, and free up whatever space we are
566 mcount = compact_minimal_symbols (msymbols, mcount);
568 obstack_blank (&objfile->symbol_obstack,
569 (mcount + 1 - alloc_count) * sizeof (struct minimal_symbol));
570 msymbols = (struct minimal_symbol *)
571 obstack_finish (&objfile->symbol_obstack);
573 /* We also terminate the minimal symbol table with a "null symbol",
574 which is *not* included in the size of the table. This makes it
575 easier to find the end of the table when we are handed a pointer
576 to some symbol in the middle of it. Zero out the fields in the
577 "null symbol" allocated at the end of the array. Note that the
578 symbol count does *not* include this null symbol, which is why it
579 is indexed by mcount and not mcount-1. */
581 SYMBOL_NAME (&msymbols[mcount]) = NULL;
582 SYMBOL_VALUE_ADDRESS (&msymbols[mcount]) = 0;
583 MSYMBOL_INFO (&msymbols[mcount]) = NULL;
584 MSYMBOL_TYPE (&msymbols[mcount]) = mst_unknown;
585 SYMBOL_INIT_LANGUAGE_SPECIFIC (&msymbols[mcount], language_unknown);
587 /* Attach the minimal symbol table to the specified objfile.
588 The strings themselves are also located in the symbol_obstack
591 objfile -> minimal_symbol_count = mcount;
592 objfile -> msymbols = msymbols;
594 /* Now walk through all the minimal symbols, selecting the newly added
595 ones and attempting to cache their C++ demangled names. */
597 for ( ; mcount-- > 0 ; msymbols++)
599 SYMBOL_INIT_DEMANGLED_NAME (msymbols, &objfile->symbol_obstack);
604 /* Check if PC is in a shared library trampoline code stub.
605 Return minimal symbol for the trampoline entry or NULL if PC is not
606 in a trampoline code stub. */
608 struct minimal_symbol *
609 lookup_solib_trampoline_symbol_by_pc (pc)
612 struct minimal_symbol *msymbol = lookup_minimal_symbol_by_pc (pc);
614 if (msymbol != NULL && MSYMBOL_TYPE (msymbol) == mst_solib_trampoline)
619 /* If PC is in a shared library trampoline code stub, return the
620 address of the `real' function belonging to the stub.
621 Return 0 if PC is not in a trampoline code stub or if the real
622 function is not found in the minimal symbol table.
624 We may fail to find the right function if a function with the
625 same name is defined in more than one shared library, but this
626 is considered bad programming style. We could return 0 if we find
627 a duplicate function in case this matters someday. */
630 find_solib_trampoline_target (pc)
633 struct objfile *objfile;
634 struct minimal_symbol *msymbol;
635 struct minimal_symbol *tsymbol = lookup_solib_trampoline_symbol_by_pc (pc);
639 ALL_MSYMBOLS (objfile, msymbol)
641 if (MSYMBOL_TYPE (msymbol) == mst_text
642 && STREQ (SYMBOL_NAME (msymbol), SYMBOL_NAME (tsymbol)))
643 return SYMBOL_VALUE_ADDRESS (msymbol);