1 /* GDB routines for manipulating the minimal symbol tables.
2 Copyright (C) 1992-2017 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 3 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, see <http://www.gnu.org/licenses/>. */
21 /* This file contains support routines for creating, manipulating, and
22 destroying minimal symbol tables.
24 Minimal symbol tables are used to hold some very basic information about
25 all defined global symbols (text, data, bss, abs, etc). The only two
26 required pieces of information are the symbol's name and the address
27 associated with that symbol.
29 In many cases, even if a file was compiled with no special options for
30 debugging at all, as long as was not stripped it will contain sufficient
31 information to build useful minimal symbol tables using this structure.
33 Even when a file contains enough debugging information to build a full
34 symbol table, these minimal symbols are still useful for quickly mapping
35 between names and addresses, and vice versa. They are also sometimes used
36 to figure out what full symbol table entries need to be read in. */
43 #include "filenames.h"
50 #include "cp-support.h"
52 #include "cli/cli-utils.h"
55 #include "safe-ctype.h"
60 msymbol_is_text (minimal_symbol *msymbol)
62 switch (MSYMBOL_TYPE (msymbol))
65 case mst_text_gnu_ifunc:
66 case mst_solib_trampoline:
74 /* Accumulate the minimal symbols for each objfile in bunches of BUNCH_SIZE.
75 At the end, copy them all into one newly allocated location on an objfile's
76 per-BFD storage obstack. */
78 #define BUNCH_SIZE 127
82 struct msym_bunch *next;
83 struct minimal_symbol contents[BUNCH_SIZE];
89 msymbol_hash_iw (const char *string)
91 unsigned int hash = 0;
93 while (*string && *string != '(')
95 string = skip_spaces (string);
96 if (*string && *string != '(')
98 hash = SYMBOL_HASH_NEXT (hash, *string);
108 msymbol_hash (const char *string)
110 unsigned int hash = 0;
112 for (; *string; ++string)
113 hash = SYMBOL_HASH_NEXT (hash, *string);
117 /* Add the minimal symbol SYM to an objfile's minsym hash table, TABLE. */
119 add_minsym_to_hash_table (struct minimal_symbol *sym,
120 struct minimal_symbol **table)
122 if (sym->hash_next == NULL)
125 = msymbol_hash (MSYMBOL_LINKAGE_NAME (sym)) % MINIMAL_SYMBOL_HASH_SIZE;
127 sym->hash_next = table[hash];
132 /* Add the minimal symbol SYM to an objfile's minsym demangled hash table,
135 add_minsym_to_demangled_hash_table (struct minimal_symbol *sym,
136 struct objfile *objfile)
138 if (sym->demangled_hash_next == NULL)
140 unsigned int hash = search_name_hash (MSYMBOL_LANGUAGE (sym),
141 MSYMBOL_SEARCH_NAME (sym));
143 auto &vec = objfile->per_bfd->demangled_hash_languages;
144 auto it = std::lower_bound (vec.begin (), vec.end (),
145 MSYMBOL_LANGUAGE (sym));
146 if (it == vec.end () || *it != MSYMBOL_LANGUAGE (sym))
147 vec.insert (it, MSYMBOL_LANGUAGE (sym));
149 struct minimal_symbol **table
150 = objfile->per_bfd->msymbol_demangled_hash;
151 unsigned int hash_index = hash % MINIMAL_SYMBOL_HASH_SIZE;
152 sym->demangled_hash_next = table[hash_index];
153 table[hash_index] = sym;
157 /* Worker object for lookup_minimal_symbol. Stores temporary results
158 while walking the symbol tables. */
160 struct found_minimal_symbols
162 /* External symbols are best. */
163 bound_minimal_symbol external_symbol {};
165 /* File-local symbols are next best. */
166 bound_minimal_symbol file_symbol {};
168 /* Symbols for shared library trampolines are next best. */
169 bound_minimal_symbol trampoline_symbol {};
171 /* Called when a symbol name matches. Check if the minsym is a
172 better type than what we had already found, and record it in one
173 of the members fields if so. Returns true if we collected the
174 real symbol, in which case we can stop searching. */
175 bool maybe_collect (const char *sfile, objfile *objf,
176 minimal_symbol *msymbol);
179 /* See declaration above. */
182 found_minimal_symbols::maybe_collect (const char *sfile,
183 struct objfile *objfile,
184 minimal_symbol *msymbol)
186 switch (MSYMBOL_TYPE (msymbol))
192 || filename_cmp (msymbol->filename, sfile) == 0)
194 file_symbol.minsym = msymbol;
195 file_symbol.objfile = objfile;
199 case mst_solib_trampoline:
201 /* If a trampoline symbol is found, we prefer to keep
202 looking for the *real* symbol. If the actual symbol
203 is not found, then we'll use the trampoline
205 if (trampoline_symbol.minsym == NULL)
207 trampoline_symbol.minsym = msymbol;
208 trampoline_symbol.objfile = objfile;
214 external_symbol.minsym = msymbol;
215 external_symbol.objfile = objfile;
216 /* We have the real symbol. No use looking further. */
224 /* Walk the mangled name hash table, and pass each symbol whose name
225 matches LOOKUP_NAME according to NAMECMP to FOUND. */
228 lookup_minimal_symbol_mangled (const char *lookup_name,
230 struct objfile *objfile,
231 struct minimal_symbol **table,
233 int (*namecmp) (const char *, const char *),
234 found_minimal_symbols &found)
236 for (minimal_symbol *msymbol = table[hash];
238 msymbol = msymbol->hash_next)
240 const char *symbol_name = MSYMBOL_LINKAGE_NAME (msymbol);
242 if (namecmp (symbol_name, lookup_name) == 0
243 && found.maybe_collect (sfile, objfile, msymbol))
248 /* Walk the demangled name hash table, and pass each symbol whose name
249 matches LOOKUP_NAME according to MATCHER to FOUND. */
252 lookup_minimal_symbol_demangled (const lookup_name_info &lookup_name,
254 struct objfile *objfile,
255 struct minimal_symbol **table,
257 symbol_name_matcher_ftype *matcher,
258 found_minimal_symbols &found)
260 for (minimal_symbol *msymbol = table[hash];
262 msymbol = msymbol->demangled_hash_next)
264 const char *symbol_name = MSYMBOL_SEARCH_NAME (msymbol);
266 if (matcher (symbol_name, lookup_name, NULL)
267 && found.maybe_collect (sfile, objfile, msymbol))
272 /* Look through all the current minimal symbol tables and find the
273 first minimal symbol that matches NAME. If OBJF is non-NULL, limit
274 the search to that objfile. If SFILE is non-NULL, the only file-scope
275 symbols considered will be from that source file (global symbols are
276 still preferred). Returns a pointer to the minimal symbol that
277 matches, or NULL if no match is found.
279 Note: One instance where there may be duplicate minimal symbols with
280 the same name is when the symbol tables for a shared library and the
281 symbol tables for an executable contain global symbols with the same
282 names (the dynamic linker deals with the duplication).
284 It's also possible to have minimal symbols with different mangled
285 names, but identical demangled names. For example, the GNU C++ v3
286 ABI requires the generation of two (or perhaps three) copies of
287 constructor functions --- "in-charge", "not-in-charge", and
288 "allocate" copies; destructors may be duplicated as well.
289 Obviously, there must be distinct mangled names for each of these,
290 but the demangled names are all the same: S::S or S::~S. */
292 struct bound_minimal_symbol
293 lookup_minimal_symbol (const char *name, const char *sfile,
294 struct objfile *objf)
296 struct objfile *objfile;
297 found_minimal_symbols found;
299 unsigned int mangled_hash = msymbol_hash (name) % MINIMAL_SYMBOL_HASH_SIZE;
302 = (case_sensitivity == case_sensitive_on
307 sfile = lbasename (sfile);
309 lookup_name_info lookup_name (name, symbol_name_match_type::FULL);
311 for (objfile = object_files;
312 objfile != NULL && found.external_symbol.minsym == NULL;
313 objfile = objfile->next)
315 struct minimal_symbol *msymbol;
317 if (objf == NULL || objf == objfile
318 || objf == objfile->separate_debug_objfile_backlink)
320 if (symbol_lookup_debug)
322 fprintf_unfiltered (gdb_stdlog,
323 "lookup_minimal_symbol (%s, %s, %s)\n",
324 name, sfile != NULL ? sfile : "NULL",
325 objfile_debug_name (objfile));
328 /* Do two passes: the first over the ordinary hash table,
329 and the second over the demangled hash table. */
330 lookup_minimal_symbol_mangled (name, sfile, objfile,
331 objfile->per_bfd->msymbol_hash,
332 mangled_hash, mangled_cmp, found);
334 /* If not found, try the demangled hash table. */
335 if (found.external_symbol.minsym == NULL)
337 /* Once for each language in the demangled hash names
338 table (usually just zero or one languages). */
339 for (auto lang : objfile->per_bfd->demangled_hash_languages)
342 = (lookup_name.search_name_hash (lang)
343 % MINIMAL_SYMBOL_HASH_SIZE);
345 symbol_name_matcher_ftype *match
346 = language_get_symbol_name_matcher (language_def (lang),
348 struct minimal_symbol **msymbol_demangled_hash
349 = objfile->per_bfd->msymbol_demangled_hash;
351 lookup_minimal_symbol_demangled (lookup_name, sfile, objfile,
352 msymbol_demangled_hash,
355 if (found.external_symbol.minsym != NULL)
362 /* External symbols are best. */
363 if (found.external_symbol.minsym != NULL)
365 if (symbol_lookup_debug)
367 minimal_symbol *minsym = found.external_symbol.minsym;
369 fprintf_unfiltered (gdb_stdlog,
370 "lookup_minimal_symbol (...) = %s (external)\n",
371 host_address_to_string (minsym));
373 return found.external_symbol;
376 /* File-local symbols are next best. */
377 if (found.file_symbol.minsym != NULL)
379 if (symbol_lookup_debug)
381 minimal_symbol *minsym = found.file_symbol.minsym;
383 fprintf_unfiltered (gdb_stdlog,
384 "lookup_minimal_symbol (...) = %s (file-local)\n",
385 host_address_to_string (minsym));
387 return found.file_symbol;
390 /* Symbols for shared library trampolines are next best. */
391 if (found.trampoline_symbol.minsym != NULL)
393 if (symbol_lookup_debug)
395 minimal_symbol *minsym = found.trampoline_symbol.minsym;
397 fprintf_unfiltered (gdb_stdlog,
398 "lookup_minimal_symbol (...) = %s (trampoline)\n",
399 host_address_to_string (minsym));
402 return found.trampoline_symbol;
406 if (symbol_lookup_debug)
407 fprintf_unfiltered (gdb_stdlog, "lookup_minimal_symbol (...) = NULL\n");
413 struct bound_minimal_symbol
414 lookup_bound_minimal_symbol (const char *name)
416 return lookup_minimal_symbol (name, NULL, NULL);
419 /* See common/symbol.h. */
422 find_minimal_symbol_address (const char *name, CORE_ADDR *addr,
423 struct objfile *objfile)
425 struct bound_minimal_symbol sym
426 = lookup_minimal_symbol (name, NULL, objfile);
428 if (sym.minsym != NULL)
429 *addr = BMSYMBOL_VALUE_ADDRESS (sym);
431 return sym.minsym == NULL;
437 iterate_over_minimal_symbols (struct objfile *objf,
438 const lookup_name_info &lookup_name,
439 void (*callback) (struct minimal_symbol *,
444 /* The first pass is over the ordinary hash table. */
446 const char *name = lookup_name.name ().c_str ();
447 unsigned int hash = msymbol_hash (name) % MINIMAL_SYMBOL_HASH_SIZE;
449 = (case_sensitivity == case_sensitive_on
453 for (minimal_symbol *iter = objf->per_bfd->msymbol_hash[hash];
455 iter = iter->hash_next)
457 if (mangled_cmp (MSYMBOL_LINKAGE_NAME (iter), name) == 0)
458 (*callback) (iter, user_data);
462 /* The second pass is over the demangled table. Once for each
463 language in the demangled hash names table (usually just zero or
465 for (auto lang : objf->per_bfd->demangled_hash_languages)
467 const language_defn *lang_def = language_def (lang);
468 symbol_name_matcher_ftype *name_match
469 = language_get_symbol_name_matcher (lang_def, lookup_name);
472 = lookup_name.search_name_hash (lang) % MINIMAL_SYMBOL_HASH_SIZE;
473 for (minimal_symbol *iter = objf->per_bfd->msymbol_demangled_hash[hash];
475 iter = iter->demangled_hash_next)
476 if (name_match (MSYMBOL_SEARCH_NAME (iter), lookup_name, NULL))
477 (*callback) (iter, user_data);
483 struct bound_minimal_symbol
484 lookup_minimal_symbol_text (const char *name, struct objfile *objf)
486 struct objfile *objfile;
487 struct minimal_symbol *msymbol;
488 struct bound_minimal_symbol found_symbol = { NULL, NULL };
489 struct bound_minimal_symbol found_file_symbol = { NULL, NULL };
491 unsigned int hash = msymbol_hash (name) % MINIMAL_SYMBOL_HASH_SIZE;
493 for (objfile = object_files;
494 objfile != NULL && found_symbol.minsym == NULL;
495 objfile = objfile->next)
497 if (objf == NULL || objf == objfile
498 || objf == objfile->separate_debug_objfile_backlink)
500 for (msymbol = objfile->per_bfd->msymbol_hash[hash];
501 msymbol != NULL && found_symbol.minsym == NULL;
502 msymbol = msymbol->hash_next)
504 if (strcmp (MSYMBOL_LINKAGE_NAME (msymbol), name) == 0 &&
505 (MSYMBOL_TYPE (msymbol) == mst_text
506 || MSYMBOL_TYPE (msymbol) == mst_text_gnu_ifunc
507 || MSYMBOL_TYPE (msymbol) == mst_file_text))
509 switch (MSYMBOL_TYPE (msymbol))
512 found_file_symbol.minsym = msymbol;
513 found_file_symbol.objfile = objfile;
516 found_symbol.minsym = msymbol;
517 found_symbol.objfile = objfile;
524 /* External symbols are best. */
525 if (found_symbol.minsym)
528 /* File-local symbols are next best. */
529 return found_file_symbol;
534 struct minimal_symbol *
535 lookup_minimal_symbol_by_pc_name (CORE_ADDR pc, const char *name,
536 struct objfile *objf)
538 struct objfile *objfile;
539 struct minimal_symbol *msymbol;
541 unsigned int hash = msymbol_hash (name) % MINIMAL_SYMBOL_HASH_SIZE;
543 for (objfile = object_files;
545 objfile = objfile->next)
547 if (objf == NULL || objf == objfile
548 || objf == objfile->separate_debug_objfile_backlink)
550 for (msymbol = objfile->per_bfd->msymbol_hash[hash];
552 msymbol = msymbol->hash_next)
554 if (MSYMBOL_VALUE_ADDRESS (objfile, msymbol) == pc
555 && strcmp (MSYMBOL_LINKAGE_NAME (msymbol), name) == 0)
566 struct bound_minimal_symbol
567 lookup_minimal_symbol_solib_trampoline (const char *name,
568 struct objfile *objf)
570 struct objfile *objfile;
571 struct minimal_symbol *msymbol;
572 struct bound_minimal_symbol found_symbol = { NULL, NULL };
574 unsigned int hash = msymbol_hash (name) % MINIMAL_SYMBOL_HASH_SIZE;
576 for (objfile = object_files;
578 objfile = objfile->next)
580 if (objf == NULL || objf == objfile
581 || objf == objfile->separate_debug_objfile_backlink)
583 for (msymbol = objfile->per_bfd->msymbol_hash[hash];
585 msymbol = msymbol->hash_next)
587 if (strcmp (MSYMBOL_LINKAGE_NAME (msymbol), name) == 0 &&
588 MSYMBOL_TYPE (msymbol) == mst_solib_trampoline)
590 found_symbol.objfile = objfile;
591 found_symbol.minsym = msymbol;
601 /* A helper function that makes *PC section-relative. This searches
602 the sections of OBJFILE and if *PC is in a section, it subtracts
603 the section offset and returns true. Otherwise it returns
607 frob_address (struct objfile *objfile, CORE_ADDR *pc)
609 struct obj_section *iter;
611 ALL_OBJFILE_OSECTIONS (objfile, iter)
613 if (*pc >= obj_section_addr (iter) && *pc < obj_section_endaddr (iter))
615 *pc -= obj_section_offset (iter);
623 /* Search through the minimal symbol table for each objfile and find
624 the symbol whose address is the largest address that is still less
625 than or equal to PC, and matches SECTION (which is not NULL).
626 Returns a pointer to the minimal symbol if such a symbol is found,
627 or NULL if PC is not in a suitable range.
628 Note that we need to look through ALL the minimal symbol tables
629 before deciding on the symbol that comes closest to the specified PC.
630 This is because objfiles can overlap, for example objfile A has .text
631 at 0x100 and .data at 0x40000 and objfile B has .text at 0x234 and
634 If WANT_TRAMPOLINE is set, prefer mst_solib_trampoline symbols when
635 there are text and trampoline symbols at the same address.
636 Otherwise prefer mst_text symbols. */
638 static struct bound_minimal_symbol
639 lookup_minimal_symbol_by_pc_section_1 (CORE_ADDR pc_in,
640 struct obj_section *section,
646 struct objfile *objfile;
647 struct minimal_symbol *msymbol;
648 struct minimal_symbol *best_symbol = NULL;
649 struct objfile *best_objfile = NULL;
650 struct bound_minimal_symbol result;
651 enum minimal_symbol_type want_type, other_type;
653 want_type = want_trampoline ? mst_solib_trampoline : mst_text;
654 other_type = want_trampoline ? mst_text : mst_solib_trampoline;
656 /* We can not require the symbol found to be in section, because
657 e.g. IRIX 6.5 mdebug relies on this code returning an absolute
658 symbol - but find_pc_section won't return an absolute section and
659 hence the code below would skip over absolute symbols. We can
660 still take advantage of the call to find_pc_section, though - the
661 object file still must match. In case we have separate debug
662 files, search both the file and its separate debug file. There's
663 no telling which one will have the minimal symbols. */
665 gdb_assert (section != NULL);
667 for (objfile = section->objfile;
669 objfile = objfile_separate_debug_iterate (section->objfile, objfile))
671 CORE_ADDR pc = pc_in;
673 /* If this objfile has a minimal symbol table, go search it using
674 a binary search. Note that a minimal symbol table always consists
675 of at least two symbols, a "real" symbol and the terminating
676 "null symbol". If there are no real symbols, then there is no
677 minimal symbol table at all. */
679 if (objfile->per_bfd->minimal_symbol_count > 0)
681 int best_zero_sized = -1;
683 msymbol = objfile->per_bfd->msymbols;
685 hi = objfile->per_bfd->minimal_symbol_count - 1;
687 /* This code assumes that the minimal symbols are sorted by
688 ascending address values. If the pc value is greater than or
689 equal to the first symbol's address, then some symbol in this
690 minimal symbol table is a suitable candidate for being the
691 "best" symbol. This includes the last real symbol, for cases
692 where the pc value is larger than any address in this vector.
694 By iterating until the address associated with the current
695 hi index (the endpoint of the test interval) is less than
696 or equal to the desired pc value, we accomplish two things:
697 (1) the case where the pc value is larger than any minimal
698 symbol address is trivially solved, (2) the address associated
699 with the hi index is always the one we want when the interation
700 terminates. In essence, we are iterating the test interval
701 down until the pc value is pushed out of it from the high end.
703 Warning: this code is trickier than it would appear at first. */
705 if (frob_address (objfile, &pc)
706 && pc >= MSYMBOL_VALUE_RAW_ADDRESS (&msymbol[lo]))
708 while (MSYMBOL_VALUE_RAW_ADDRESS (&msymbol[hi]) > pc)
710 /* pc is still strictly less than highest address. */
711 /* Note "new" will always be >= lo. */
712 newobj = (lo + hi) / 2;
713 if ((MSYMBOL_VALUE_RAW_ADDRESS (&msymbol[newobj]) >= pc)
724 /* If we have multiple symbols at the same address, we want
725 hi to point to the last one. That way we can find the
726 right symbol if it has an index greater than hi. */
727 while (hi < objfile->per_bfd->minimal_symbol_count - 1
728 && (MSYMBOL_VALUE_RAW_ADDRESS (&msymbol[hi])
729 == MSYMBOL_VALUE_RAW_ADDRESS (&msymbol[hi + 1])))
732 /* Skip various undesirable symbols. */
735 /* Skip any absolute symbols. This is apparently
736 what adb and dbx do, and is needed for the CM-5.
737 There are two known possible problems: (1) on
738 ELF, apparently end, edata, etc. are absolute.
739 Not sure ignoring them here is a big deal, but if
740 we want to use them, the fix would go in
741 elfread.c. (2) I think shared library entry
742 points on the NeXT are absolute. If we want
743 special handling for this it probably should be
744 triggered by a special mst_abs_or_lib or some
747 if (MSYMBOL_TYPE (&msymbol[hi]) == mst_abs)
753 /* If SECTION was specified, skip any symbol from
756 /* Some types of debug info, such as COFF,
757 don't fill the bfd_section member, so don't
758 throw away symbols on those platforms. */
759 && MSYMBOL_OBJ_SECTION (objfile, &msymbol[hi]) != NULL
760 && (!matching_obj_sections
761 (MSYMBOL_OBJ_SECTION (objfile, &msymbol[hi]),
768 /* If we are looking for a trampoline and this is a
769 text symbol, or the other way around, check the
770 preceding symbol too. If they are otherwise
771 identical prefer that one. */
773 && MSYMBOL_TYPE (&msymbol[hi]) == other_type
774 && MSYMBOL_TYPE (&msymbol[hi - 1]) == want_type
775 && (MSYMBOL_SIZE (&msymbol[hi])
776 == MSYMBOL_SIZE (&msymbol[hi - 1]))
777 && (MSYMBOL_VALUE_RAW_ADDRESS (&msymbol[hi])
778 == MSYMBOL_VALUE_RAW_ADDRESS (&msymbol[hi - 1]))
779 && (MSYMBOL_OBJ_SECTION (objfile, &msymbol[hi])
780 == MSYMBOL_OBJ_SECTION (objfile, &msymbol[hi - 1])))
786 /* If the minimal symbol has a zero size, save it
787 but keep scanning backwards looking for one with
788 a non-zero size. A zero size may mean that the
789 symbol isn't an object or function (e.g. a
790 label), or it may just mean that the size was not
792 if (MSYMBOL_SIZE (&msymbol[hi]) == 0)
794 if (best_zero_sized == -1)
795 best_zero_sized = hi;
800 /* If we are past the end of the current symbol, try
801 the previous symbol if it has a larger overlapping
802 size. This happens on i686-pc-linux-gnu with glibc;
803 the nocancel variants of system calls are inside
804 the cancellable variants, but both have sizes. */
806 && MSYMBOL_SIZE (&msymbol[hi]) != 0
807 && pc >= (MSYMBOL_VALUE_RAW_ADDRESS (&msymbol[hi])
808 + MSYMBOL_SIZE (&msymbol[hi]))
809 && pc < (MSYMBOL_VALUE_RAW_ADDRESS (&msymbol[hi - 1])
810 + MSYMBOL_SIZE (&msymbol[hi - 1])))
816 /* Otherwise, this symbol must be as good as we're going
821 /* If HI has a zero size, and best_zero_sized is set,
822 then we had two or more zero-sized symbols; prefer
823 the first one we found (which may have a higher
824 address). Also, if we ran off the end, be sure
826 if (best_zero_sized != -1
827 && (hi < 0 || MSYMBOL_SIZE (&msymbol[hi]) == 0))
828 hi = best_zero_sized;
830 /* If the minimal symbol has a non-zero size, and this
831 PC appears to be outside the symbol's contents, then
832 refuse to use this symbol. If we found a zero-sized
833 symbol with an address greater than this symbol's,
834 use that instead. We assume that if symbols have
835 specified sizes, they do not overlap. */
838 && MSYMBOL_SIZE (&msymbol[hi]) != 0
839 && pc >= (MSYMBOL_VALUE_RAW_ADDRESS (&msymbol[hi])
840 + MSYMBOL_SIZE (&msymbol[hi])))
842 if (best_zero_sized != -1)
843 hi = best_zero_sized;
845 /* Go on to the next object file. */
849 /* The minimal symbol indexed by hi now is the best one in this
850 objfile's minimal symbol table. See if it is the best one
854 && ((best_symbol == NULL) ||
855 (MSYMBOL_VALUE_RAW_ADDRESS (best_symbol) <
856 MSYMBOL_VALUE_RAW_ADDRESS (&msymbol[hi]))))
858 best_symbol = &msymbol[hi];
859 best_objfile = objfile;
865 result.minsym = best_symbol;
866 result.objfile = best_objfile;
870 struct bound_minimal_symbol
871 lookup_minimal_symbol_by_pc_section (CORE_ADDR pc, struct obj_section *section)
875 /* NOTE: cagney/2004-01-27: This was using find_pc_mapped_section to
876 force the section but that (well unless you're doing overlay
877 debugging) always returns NULL making the call somewhat useless. */
878 section = find_pc_section (pc);
881 struct bound_minimal_symbol result;
883 memset (&result, 0, sizeof (result));
887 return lookup_minimal_symbol_by_pc_section_1 (pc, section, 0);
892 struct bound_minimal_symbol
893 lookup_minimal_symbol_by_pc (CORE_ADDR pc)
895 struct obj_section *section = find_pc_section (pc);
899 struct bound_minimal_symbol result;
901 memset (&result, 0, sizeof (result));
904 return lookup_minimal_symbol_by_pc_section_1 (pc, section, 0);
907 /* Return non-zero iff PC is in an STT_GNU_IFUNC function resolver. */
910 in_gnu_ifunc_stub (CORE_ADDR pc)
912 struct bound_minimal_symbol msymbol = lookup_minimal_symbol_by_pc (pc);
914 return msymbol.minsym && MSYMBOL_TYPE (msymbol.minsym) == mst_text_gnu_ifunc;
917 /* See elf_gnu_ifunc_resolve_addr for its real implementation. */
920 stub_gnu_ifunc_resolve_addr (struct gdbarch *gdbarch, CORE_ADDR pc)
922 error (_("GDB cannot resolve STT_GNU_IFUNC symbol at address %s without "
923 "the ELF support compiled in."),
924 paddress (gdbarch, pc));
927 /* See elf_gnu_ifunc_resolve_name for its real implementation. */
930 stub_gnu_ifunc_resolve_name (const char *function_name,
931 CORE_ADDR *function_address_p)
933 error (_("GDB cannot resolve STT_GNU_IFUNC symbol \"%s\" without "
934 "the ELF support compiled in."),
938 /* See elf_gnu_ifunc_resolver_stop for its real implementation. */
941 stub_gnu_ifunc_resolver_stop (struct breakpoint *b)
943 internal_error (__FILE__, __LINE__,
944 _("elf_gnu_ifunc_resolver_stop cannot be reached."));
947 /* See elf_gnu_ifunc_resolver_return_stop for its real implementation. */
950 stub_gnu_ifunc_resolver_return_stop (struct breakpoint *b)
952 internal_error (__FILE__, __LINE__,
953 _("elf_gnu_ifunc_resolver_return_stop cannot be reached."));
956 /* See elf_gnu_ifunc_fns for its real implementation. */
958 static const struct gnu_ifunc_fns stub_gnu_ifunc_fns =
960 stub_gnu_ifunc_resolve_addr,
961 stub_gnu_ifunc_resolve_name,
962 stub_gnu_ifunc_resolver_stop,
963 stub_gnu_ifunc_resolver_return_stop,
966 /* A placeholder for &elf_gnu_ifunc_fns. */
968 const struct gnu_ifunc_fns *gnu_ifunc_fns_p = &stub_gnu_ifunc_fns;
972 struct bound_minimal_symbol
973 lookup_minimal_symbol_and_objfile (const char *name)
975 struct bound_minimal_symbol result;
976 struct objfile *objfile;
977 unsigned int hash = msymbol_hash (name) % MINIMAL_SYMBOL_HASH_SIZE;
979 ALL_OBJFILES (objfile)
981 struct minimal_symbol *msym;
983 for (msym = objfile->per_bfd->msymbol_hash[hash];
985 msym = msym->hash_next)
987 if (strcmp (MSYMBOL_LINKAGE_NAME (msym), name) == 0)
989 result.minsym = msym;
990 result.objfile = objfile;
996 memset (&result, 0, sizeof (result));
1001 /* Return leading symbol character for a BFD. If BFD is NULL,
1002 return the leading symbol character from the main objfile. */
1005 get_symbol_leading_char (bfd *abfd)
1008 return bfd_get_symbol_leading_char (abfd);
1009 if (symfile_objfile != NULL && symfile_objfile->obfd != NULL)
1010 return bfd_get_symbol_leading_char (symfile_objfile->obfd);
1014 /* See minsyms.h. */
1016 minimal_symbol_reader::minimal_symbol_reader (struct objfile *obj)
1018 m_msym_bunch (NULL),
1019 /* Note that presetting m_msym_bunch_index to BUNCH_SIZE causes the
1020 first call to save a minimal symbol to allocate the memory for
1022 m_msym_bunch_index (BUNCH_SIZE),
1027 /* Discard the currently collected minimal symbols, if any. If we wish
1028 to save them for later use, we must have already copied them somewhere
1029 else before calling this function.
1031 FIXME: We could allocate the minimal symbol bunches on their own
1032 obstack and then simply blow the obstack away when we are done with
1033 it. Is it worth the extra trouble though? */
1035 minimal_symbol_reader::~minimal_symbol_reader ()
1037 struct msym_bunch *next;
1039 while (m_msym_bunch != NULL)
1041 next = m_msym_bunch->next;
1042 xfree (m_msym_bunch);
1043 m_msym_bunch = next;
1047 /* See minsyms.h. */
1050 minimal_symbol_reader::record (const char *name, CORE_ADDR address,
1051 enum minimal_symbol_type ms_type)
1058 case mst_text_gnu_ifunc:
1060 case mst_solib_trampoline:
1061 section = SECT_OFF_TEXT (m_objfile);
1065 section = SECT_OFF_DATA (m_objfile);
1069 section = SECT_OFF_BSS (m_objfile);
1075 record_with_info (name, address, ms_type, section);
1078 /* See minsyms.h. */
1080 struct minimal_symbol *
1081 minimal_symbol_reader::record_full (const char *name, int name_len,
1082 bool copy_name, CORE_ADDR address,
1083 enum minimal_symbol_type ms_type,
1086 struct msym_bunch *newobj;
1087 struct minimal_symbol *msymbol;
1089 /* Don't put gcc_compiled, __gnu_compiled_cplus, and friends into
1090 the minimal symbols, because if there is also another symbol
1091 at the same address (e.g. the first function of the file),
1092 lookup_minimal_symbol_by_pc would have no way of getting the
1094 if (ms_type == mst_file_text && name[0] == 'g'
1095 && (strcmp (name, GCC_COMPILED_FLAG_SYMBOL) == 0
1096 || strcmp (name, GCC2_COMPILED_FLAG_SYMBOL) == 0))
1099 /* It's safe to strip the leading char here once, since the name
1100 is also stored stripped in the minimal symbol table. */
1101 if (name[0] == get_symbol_leading_char (m_objfile->obfd))
1107 if (ms_type == mst_file_text && startswith (name, "__gnu_compiled"))
1110 if (m_msym_bunch_index == BUNCH_SIZE)
1112 newobj = XCNEW (struct msym_bunch);
1113 m_msym_bunch_index = 0;
1114 newobj->next = m_msym_bunch;
1115 m_msym_bunch = newobj;
1117 msymbol = &m_msym_bunch->contents[m_msym_bunch_index];
1118 MSYMBOL_SET_LANGUAGE (msymbol, language_auto,
1119 &m_objfile->per_bfd->storage_obstack);
1120 MSYMBOL_SET_NAMES (msymbol, name, name_len, copy_name, m_objfile);
1122 SET_MSYMBOL_VALUE_ADDRESS (msymbol, address);
1123 MSYMBOL_SECTION (msymbol) = section;
1125 MSYMBOL_TYPE (msymbol) = ms_type;
1126 MSYMBOL_TARGET_FLAG_1 (msymbol) = 0;
1127 MSYMBOL_TARGET_FLAG_2 (msymbol) = 0;
1128 /* Do not use the SET_MSYMBOL_SIZE macro to initialize the size,
1129 as it would also set the has_size flag. */
1132 /* The hash pointers must be cleared! If they're not,
1133 add_minsym_to_hash_table will NOT add this msymbol to the hash table. */
1134 msymbol->hash_next = NULL;
1135 msymbol->demangled_hash_next = NULL;
1137 /* If we already read minimal symbols for this objfile, then don't
1138 ever allocate a new one. */
1139 if (!m_objfile->per_bfd->minsyms_read)
1141 m_msym_bunch_index++;
1142 m_objfile->per_bfd->n_minsyms++;
1148 /* Compare two minimal symbols by address and return a signed result based
1149 on unsigned comparisons, so that we sort into unsigned numeric order.
1150 Within groups with the same address, sort by name. */
1153 compare_minimal_symbols (const void *fn1p, const void *fn2p)
1155 const struct minimal_symbol *fn1;
1156 const struct minimal_symbol *fn2;
1158 fn1 = (const struct minimal_symbol *) fn1p;
1159 fn2 = (const struct minimal_symbol *) fn2p;
1161 if (MSYMBOL_VALUE_RAW_ADDRESS (fn1) < MSYMBOL_VALUE_RAW_ADDRESS (fn2))
1163 return (-1); /* addr 1 is less than addr 2. */
1165 else if (MSYMBOL_VALUE_RAW_ADDRESS (fn1) > MSYMBOL_VALUE_RAW_ADDRESS (fn2))
1167 return (1); /* addr 1 is greater than addr 2. */
1170 /* addrs are equal: sort by name */
1172 const char *name1 = MSYMBOL_LINKAGE_NAME (fn1);
1173 const char *name2 = MSYMBOL_LINKAGE_NAME (fn2);
1175 if (name1 && name2) /* both have names */
1176 return strcmp (name1, name2);
1178 return 1; /* fn1 has no name, so it is "less". */
1179 else if (name1) /* fn2 has no name, so it is "less". */
1182 return (0); /* Neither has a name, so they're equal. */
1186 /* Compact duplicate entries out of a minimal symbol table by walking
1187 through the table and compacting out entries with duplicate addresses
1188 and matching names. Return the number of entries remaining.
1190 On entry, the table resides between msymbol[0] and msymbol[mcount].
1191 On exit, it resides between msymbol[0] and msymbol[result_count].
1193 When files contain multiple sources of symbol information, it is
1194 possible for the minimal symbol table to contain many duplicate entries.
1195 As an example, SVR4 systems use ELF formatted object files, which
1196 usually contain at least two different types of symbol tables (a
1197 standard ELF one and a smaller dynamic linking table), as well as
1198 DWARF debugging information for files compiled with -g.
1200 Without compacting, the minimal symbol table for gdb itself contains
1201 over a 1000 duplicates, about a third of the total table size. Aside
1202 from the potential trap of not noticing that two successive entries
1203 identify the same location, this duplication impacts the time required
1204 to linearly scan the table, which is done in a number of places. So we
1205 just do one linear scan here and toss out the duplicates.
1207 Note that we are not concerned here about recovering the space that
1208 is potentially freed up, because the strings themselves are allocated
1209 on the storage_obstack, and will get automatically freed when the symbol
1210 table is freed. The caller can free up the unused minimal symbols at
1211 the end of the compacted region if their allocation strategy allows it.
1213 Also note we only go up to the next to last entry within the loop
1214 and then copy the last entry explicitly after the loop terminates.
1216 Since the different sources of information for each symbol may
1217 have different levels of "completeness", we may have duplicates
1218 that have one entry with type "mst_unknown" and the other with a
1219 known type. So if the one we are leaving alone has type mst_unknown,
1220 overwrite its type with the type from the one we are compacting out. */
1223 compact_minimal_symbols (struct minimal_symbol *msymbol, int mcount,
1224 struct objfile *objfile)
1226 struct minimal_symbol *copyfrom;
1227 struct minimal_symbol *copyto;
1231 copyfrom = copyto = msymbol;
1232 while (copyfrom < msymbol + mcount - 1)
1234 if (MSYMBOL_VALUE_RAW_ADDRESS (copyfrom)
1235 == MSYMBOL_VALUE_RAW_ADDRESS ((copyfrom + 1))
1236 && MSYMBOL_SECTION (copyfrom) == MSYMBOL_SECTION (copyfrom + 1)
1237 && strcmp (MSYMBOL_LINKAGE_NAME (copyfrom),
1238 MSYMBOL_LINKAGE_NAME ((copyfrom + 1))) == 0)
1240 if (MSYMBOL_TYPE ((copyfrom + 1)) == mst_unknown)
1242 MSYMBOL_TYPE ((copyfrom + 1)) = MSYMBOL_TYPE (copyfrom);
1247 *copyto++ = *copyfrom++;
1249 *copyto++ = *copyfrom++;
1250 mcount = copyto - msymbol;
1255 /* Build (or rebuild) the minimal symbol hash tables. This is necessary
1256 after compacting or sorting the table since the entries move around
1257 thus causing the internal minimal_symbol pointers to become jumbled. */
1260 build_minimal_symbol_hash_tables (struct objfile *objfile)
1263 struct minimal_symbol *msym;
1265 /* Clear the hash tables. */
1266 for (i = 0; i < MINIMAL_SYMBOL_HASH_SIZE; i++)
1268 objfile->per_bfd->msymbol_hash[i] = 0;
1269 objfile->per_bfd->msymbol_demangled_hash[i] = 0;
1272 /* Now, (re)insert the actual entries. */
1273 for ((i = objfile->per_bfd->minimal_symbol_count,
1274 msym = objfile->per_bfd->msymbols);
1278 msym->hash_next = 0;
1279 add_minsym_to_hash_table (msym, objfile->per_bfd->msymbol_hash);
1281 msym->demangled_hash_next = 0;
1282 if (MSYMBOL_SEARCH_NAME (msym) != MSYMBOL_LINKAGE_NAME (msym))
1283 add_minsym_to_demangled_hash_table (msym, objfile);
1287 /* Add the minimal symbols in the existing bunches to the objfile's official
1288 minimal symbol table. In most cases there is no minimal symbol table yet
1289 for this objfile, and the existing bunches are used to create one. Once
1290 in a while (for shared libraries for example), we add symbols (e.g. common
1291 symbols) to an existing objfile.
1293 Because of the way minimal symbols are collected, we generally have no way
1294 of knowing what source language applies to any particular minimal symbol.
1295 Specifically, we have no way of knowing if the minimal symbol comes from a
1296 C++ compilation unit or not. So for the sake of supporting cached
1297 demangled C++ names, we have no choice but to try and demangle each new one
1298 that comes in. If the demangling succeeds, then we assume it is a C++
1299 symbol and set the symbol's language and demangled name fields
1300 appropriately. Note that in order to avoid unnecessary demanglings, and
1301 allocating obstack space that subsequently can't be freed for the demangled
1302 names, we mark all newly added symbols with language_auto. After
1303 compaction of the minimal symbols, we go back and scan the entire minimal
1304 symbol table looking for these new symbols. For each new symbol we attempt
1305 to demangle it, and if successful, record it as a language_cplus symbol
1306 and cache the demangled form on the symbol obstack. Symbols which don't
1307 demangle are marked as language_unknown symbols, which inhibits future
1308 attempts to demangle them if we later add more minimal symbols. */
1311 minimal_symbol_reader::install ()
1315 struct msym_bunch *bunch;
1316 struct minimal_symbol *msymbols;
1319 if (m_objfile->per_bfd->minsyms_read)
1322 if (m_msym_count > 0)
1324 if (symtab_create_debug)
1326 fprintf_unfiltered (gdb_stdlog,
1327 "Installing %d minimal symbols of objfile %s.\n",
1328 m_msym_count, objfile_name (m_objfile));
1331 /* Allocate enough space in the obstack, into which we will gather the
1332 bunches of new and existing minimal symbols, sort them, and then
1333 compact out the duplicate entries. Once we have a final table,
1334 we will give back the excess space. */
1336 alloc_count = m_msym_count + m_objfile->per_bfd->minimal_symbol_count + 1;
1337 obstack_blank (&m_objfile->per_bfd->storage_obstack,
1338 alloc_count * sizeof (struct minimal_symbol));
1339 msymbols = (struct minimal_symbol *)
1340 obstack_base (&m_objfile->per_bfd->storage_obstack);
1342 /* Copy in the existing minimal symbols, if there are any. */
1344 if (m_objfile->per_bfd->minimal_symbol_count)
1345 memcpy ((char *) msymbols, (char *) m_objfile->per_bfd->msymbols,
1346 m_objfile->per_bfd->minimal_symbol_count * sizeof (struct minimal_symbol));
1348 /* Walk through the list of minimal symbol bunches, adding each symbol
1349 to the new contiguous array of symbols. Note that we start with the
1350 current, possibly partially filled bunch (thus we use the current
1351 msym_bunch_index for the first bunch we copy over), and thereafter
1352 each bunch is full. */
1354 mcount = m_objfile->per_bfd->minimal_symbol_count;
1356 for (bunch = m_msym_bunch; bunch != NULL; bunch = bunch->next)
1358 for (bindex = 0; bindex < m_msym_bunch_index; bindex++, mcount++)
1359 msymbols[mcount] = bunch->contents[bindex];
1360 m_msym_bunch_index = BUNCH_SIZE;
1363 /* Sort the minimal symbols by address. */
1365 qsort (msymbols, mcount, sizeof (struct minimal_symbol),
1366 compare_minimal_symbols);
1368 /* Compact out any duplicates, and free up whatever space we are
1371 mcount = compact_minimal_symbols (msymbols, mcount, m_objfile);
1373 obstack_blank_fast (&m_objfile->per_bfd->storage_obstack,
1374 (mcount + 1 - alloc_count) * sizeof (struct minimal_symbol));
1375 msymbols = (struct minimal_symbol *)
1376 obstack_finish (&m_objfile->per_bfd->storage_obstack);
1378 /* We also terminate the minimal symbol table with a "null symbol",
1379 which is *not* included in the size of the table. This makes it
1380 easier to find the end of the table when we are handed a pointer
1381 to some symbol in the middle of it. Zero out the fields in the
1382 "null symbol" allocated at the end of the array. Note that the
1383 symbol count does *not* include this null symbol, which is why it
1384 is indexed by mcount and not mcount-1. */
1386 memset (&msymbols[mcount], 0, sizeof (struct minimal_symbol));
1388 /* Attach the minimal symbol table to the specified objfile.
1389 The strings themselves are also located in the storage_obstack
1392 m_objfile->per_bfd->minimal_symbol_count = mcount;
1393 m_objfile->per_bfd->msymbols = msymbols;
1395 /* Now build the hash tables; we can't do this incrementally
1396 at an earlier point since we weren't finished with the obstack
1397 yet. (And if the msymbol obstack gets moved, all the internal
1398 pointers to other msymbols need to be adjusted.) */
1399 build_minimal_symbol_hash_tables (m_objfile);
1403 /* See minsyms.h. */
1406 terminate_minimal_symbol_table (struct objfile *objfile)
1408 if (! objfile->per_bfd->msymbols)
1409 objfile->per_bfd->msymbols
1410 = ((struct minimal_symbol *)
1411 obstack_alloc (&objfile->per_bfd->storage_obstack,
1412 sizeof (struct minimal_symbol)));
1415 struct minimal_symbol *m
1416 = &objfile->per_bfd->msymbols[objfile->per_bfd->minimal_symbol_count];
1418 memset (m, 0, sizeof (*m));
1419 /* Don't rely on these enumeration values being 0's. */
1420 MSYMBOL_TYPE (m) = mst_unknown;
1421 MSYMBOL_SET_LANGUAGE (m, language_unknown,
1422 &objfile->per_bfd->storage_obstack);
1426 /* Check if PC is in a shared library trampoline code stub.
1427 Return minimal symbol for the trampoline entry or NULL if PC is not
1428 in a trampoline code stub. */
1430 static struct minimal_symbol *
1431 lookup_solib_trampoline_symbol_by_pc (CORE_ADDR pc)
1433 struct obj_section *section = find_pc_section (pc);
1434 struct bound_minimal_symbol msymbol;
1436 if (section == NULL)
1438 msymbol = lookup_minimal_symbol_by_pc_section_1 (pc, section, 1);
1440 if (msymbol.minsym != NULL
1441 && MSYMBOL_TYPE (msymbol.minsym) == mst_solib_trampoline)
1442 return msymbol.minsym;
1446 /* If PC is in a shared library trampoline code stub, return the
1447 address of the `real' function belonging to the stub.
1448 Return 0 if PC is not in a trampoline code stub or if the real
1449 function is not found in the minimal symbol table.
1451 We may fail to find the right function if a function with the
1452 same name is defined in more than one shared library, but this
1453 is considered bad programming style. We could return 0 if we find
1454 a duplicate function in case this matters someday. */
1457 find_solib_trampoline_target (struct frame_info *frame, CORE_ADDR pc)
1459 struct objfile *objfile;
1460 struct minimal_symbol *msymbol;
1461 struct minimal_symbol *tsymbol = lookup_solib_trampoline_symbol_by_pc (pc);
1463 if (tsymbol != NULL)
1465 ALL_MSYMBOLS (objfile, msymbol)
1467 if ((MSYMBOL_TYPE (msymbol) == mst_text
1468 || MSYMBOL_TYPE (msymbol) == mst_text_gnu_ifunc)
1469 && strcmp (MSYMBOL_LINKAGE_NAME (msymbol),
1470 MSYMBOL_LINKAGE_NAME (tsymbol)) == 0)
1471 return MSYMBOL_VALUE_ADDRESS (objfile, msymbol);
1473 /* Also handle minimal symbols pointing to function descriptors. */
1474 if (MSYMBOL_TYPE (msymbol) == mst_data
1475 && strcmp (MSYMBOL_LINKAGE_NAME (msymbol),
1476 MSYMBOL_LINKAGE_NAME (tsymbol)) == 0)
1480 func = gdbarch_convert_from_func_ptr_addr
1481 (get_objfile_arch (objfile),
1482 MSYMBOL_VALUE_ADDRESS (objfile, msymbol),
1485 /* Ignore data symbols that are not function descriptors. */
1486 if (func != MSYMBOL_VALUE_ADDRESS (objfile, msymbol))
1494 /* See minsyms.h. */
1497 minimal_symbol_upper_bound (struct bound_minimal_symbol minsym)
1501 struct obj_section *obj_section;
1503 struct minimal_symbol *msymbol;
1505 gdb_assert (minsym.minsym != NULL);
1507 /* If the minimal symbol has a size, use it. Otherwise use the
1508 lesser of the next minimal symbol in the same section, or the end
1509 of the section, as the end of the function. */
1511 if (MSYMBOL_SIZE (minsym.minsym) != 0)
1512 return BMSYMBOL_VALUE_ADDRESS (minsym) + MSYMBOL_SIZE (minsym.minsym);
1514 /* Step over other symbols at this same address, and symbols in
1515 other sections, to find the next symbol in this section with a
1516 different address. */
1518 msymbol = minsym.minsym;
1519 section = MSYMBOL_SECTION (msymbol);
1520 for (i = 1; MSYMBOL_LINKAGE_NAME (msymbol + i) != NULL; i++)
1522 if ((MSYMBOL_VALUE_RAW_ADDRESS (msymbol + i)
1523 != MSYMBOL_VALUE_RAW_ADDRESS (msymbol))
1524 && MSYMBOL_SECTION (msymbol + i) == section)
1528 obj_section = MSYMBOL_OBJ_SECTION (minsym.objfile, minsym.minsym);
1529 if (MSYMBOL_LINKAGE_NAME (msymbol + i) != NULL
1530 && (MSYMBOL_VALUE_ADDRESS (minsym.objfile, msymbol + i)
1531 < obj_section_endaddr (obj_section)))
1532 result = MSYMBOL_VALUE_ADDRESS (minsym.objfile, msymbol + i);
1534 /* We got the start address from the last msymbol in the objfile.
1535 So the end address is the end of the section. */
1536 result = obj_section_endaddr (obj_section);