1 /* GDB routines for manipulating the minimal symbol tables.
2 Copyright (C) 1992-2018 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_function (struct objfile *objfile, minimal_symbol *minsym,
61 CORE_ADDR *func_address_p)
63 CORE_ADDR msym_addr = MSYMBOL_VALUE_ADDRESS (objfile, minsym);
67 case mst_slot_got_plt:
74 struct gdbarch *gdbarch = get_objfile_arch (objfile);
75 CORE_ADDR pc = gdbarch_convert_from_func_ptr_addr (gdbarch, msym_addr,
79 if (func_address_p != NULL)
86 if (func_address_p != NULL)
87 *func_address_p = msym_addr;
92 /* Accumulate the minimal symbols for each objfile in bunches of BUNCH_SIZE.
93 At the end, copy them all into one newly allocated location on an objfile's
94 per-BFD storage obstack. */
96 #define BUNCH_SIZE 127
100 struct msym_bunch *next;
101 struct minimal_symbol contents[BUNCH_SIZE];
107 msymbol_hash_iw (const char *string)
109 unsigned int hash = 0;
111 while (*string && *string != '(')
113 string = skip_spaces (string);
114 if (*string && *string != '(')
116 hash = SYMBOL_HASH_NEXT (hash, *string);
126 msymbol_hash (const char *string)
128 unsigned int hash = 0;
130 for (; *string; ++string)
131 hash = SYMBOL_HASH_NEXT (hash, *string);
135 /* Add the minimal symbol SYM to an objfile's minsym hash table, TABLE. */
137 add_minsym_to_hash_table (struct minimal_symbol *sym,
138 struct minimal_symbol **table)
140 if (sym->hash_next == NULL)
143 = msymbol_hash (MSYMBOL_LINKAGE_NAME (sym)) % MINIMAL_SYMBOL_HASH_SIZE;
145 sym->hash_next = table[hash];
150 /* Add the minimal symbol SYM to an objfile's minsym demangled hash table,
153 add_minsym_to_demangled_hash_table (struct minimal_symbol *sym,
154 struct objfile *objfile)
156 if (sym->demangled_hash_next == NULL)
158 unsigned int hash = search_name_hash (MSYMBOL_LANGUAGE (sym),
159 MSYMBOL_SEARCH_NAME (sym));
161 auto &vec = objfile->per_bfd->demangled_hash_languages;
162 auto it = std::lower_bound (vec.begin (), vec.end (),
163 MSYMBOL_LANGUAGE (sym));
164 if (it == vec.end () || *it != MSYMBOL_LANGUAGE (sym))
165 vec.insert (it, MSYMBOL_LANGUAGE (sym));
167 struct minimal_symbol **table
168 = objfile->per_bfd->msymbol_demangled_hash;
169 unsigned int hash_index = hash % MINIMAL_SYMBOL_HASH_SIZE;
170 sym->demangled_hash_next = table[hash_index];
171 table[hash_index] = sym;
175 /* Worker object for lookup_minimal_symbol. Stores temporary results
176 while walking the symbol tables. */
178 struct found_minimal_symbols
180 /* External symbols are best. */
181 bound_minimal_symbol external_symbol {};
183 /* File-local symbols are next best. */
184 bound_minimal_symbol file_symbol {};
186 /* Symbols for shared library trampolines are next best. */
187 bound_minimal_symbol trampoline_symbol {};
189 /* Called when a symbol name matches. Check if the minsym is a
190 better type than what we had already found, and record it in one
191 of the members fields if so. Returns true if we collected the
192 real symbol, in which case we can stop searching. */
193 bool maybe_collect (const char *sfile, objfile *objf,
194 minimal_symbol *msymbol);
197 /* See declaration above. */
200 found_minimal_symbols::maybe_collect (const char *sfile,
201 struct objfile *objfile,
202 minimal_symbol *msymbol)
204 switch (MSYMBOL_TYPE (msymbol))
210 || filename_cmp (msymbol->filename, sfile) == 0)
212 file_symbol.minsym = msymbol;
213 file_symbol.objfile = objfile;
217 case mst_solib_trampoline:
219 /* If a trampoline symbol is found, we prefer to keep
220 looking for the *real* symbol. If the actual symbol
221 is not found, then we'll use the trampoline
223 if (trampoline_symbol.minsym == NULL)
225 trampoline_symbol.minsym = msymbol;
226 trampoline_symbol.objfile = objfile;
232 external_symbol.minsym = msymbol;
233 external_symbol.objfile = objfile;
234 /* We have the real symbol. No use looking further. */
242 /* Walk the mangled name hash table, and pass each symbol whose name
243 matches LOOKUP_NAME according to NAMECMP to FOUND. */
246 lookup_minimal_symbol_mangled (const char *lookup_name,
248 struct objfile *objfile,
249 struct minimal_symbol **table,
251 int (*namecmp) (const char *, const char *),
252 found_minimal_symbols &found)
254 for (minimal_symbol *msymbol = table[hash];
256 msymbol = msymbol->hash_next)
258 const char *symbol_name = MSYMBOL_LINKAGE_NAME (msymbol);
260 if (namecmp (symbol_name, lookup_name) == 0
261 && found.maybe_collect (sfile, objfile, msymbol))
266 /* Walk the demangled name hash table, and pass each symbol whose name
267 matches LOOKUP_NAME according to MATCHER to FOUND. */
270 lookup_minimal_symbol_demangled (const lookup_name_info &lookup_name,
272 struct objfile *objfile,
273 struct minimal_symbol **table,
275 symbol_name_matcher_ftype *matcher,
276 found_minimal_symbols &found)
278 for (minimal_symbol *msymbol = table[hash];
280 msymbol = msymbol->demangled_hash_next)
282 const char *symbol_name = MSYMBOL_SEARCH_NAME (msymbol);
284 if (matcher (symbol_name, lookup_name, NULL)
285 && found.maybe_collect (sfile, objfile, msymbol))
290 /* Look through all the current minimal symbol tables and find the
291 first minimal symbol that matches NAME. If OBJF is non-NULL, limit
292 the search to that objfile. If SFILE is non-NULL, the only file-scope
293 symbols considered will be from that source file (global symbols are
294 still preferred). Returns a pointer to the minimal symbol that
295 matches, or NULL if no match is found.
297 Note: One instance where there may be duplicate minimal symbols with
298 the same name is when the symbol tables for a shared library and the
299 symbol tables for an executable contain global symbols with the same
300 names (the dynamic linker deals with the duplication).
302 It's also possible to have minimal symbols with different mangled
303 names, but identical demangled names. For example, the GNU C++ v3
304 ABI requires the generation of two (or perhaps three) copies of
305 constructor functions --- "in-charge", "not-in-charge", and
306 "allocate" copies; destructors may be duplicated as well.
307 Obviously, there must be distinct mangled names for each of these,
308 but the demangled names are all the same: S::S or S::~S. */
310 struct bound_minimal_symbol
311 lookup_minimal_symbol (const char *name, const char *sfile,
312 struct objfile *objf)
314 struct objfile *objfile;
315 found_minimal_symbols found;
317 unsigned int mangled_hash = msymbol_hash (name) % MINIMAL_SYMBOL_HASH_SIZE;
320 = (case_sensitivity == case_sensitive_on
325 sfile = lbasename (sfile);
327 lookup_name_info lookup_name (name, symbol_name_match_type::FULL);
329 for (objfile = object_files;
330 objfile != NULL && found.external_symbol.minsym == NULL;
331 objfile = objfile->next)
333 if (objf == NULL || objf == objfile
334 || objf == objfile->separate_debug_objfile_backlink)
336 if (symbol_lookup_debug)
338 fprintf_unfiltered (gdb_stdlog,
339 "lookup_minimal_symbol (%s, %s, %s)\n",
340 name, sfile != NULL ? sfile : "NULL",
341 objfile_debug_name (objfile));
344 /* Do two passes: the first over the ordinary hash table,
345 and the second over the demangled hash table. */
346 lookup_minimal_symbol_mangled (name, sfile, objfile,
347 objfile->per_bfd->msymbol_hash,
348 mangled_hash, mangled_cmp, found);
350 /* If not found, try the demangled hash table. */
351 if (found.external_symbol.minsym == NULL)
353 /* Once for each language in the demangled hash names
354 table (usually just zero or one languages). */
355 for (auto lang : objfile->per_bfd->demangled_hash_languages)
358 = (lookup_name.search_name_hash (lang)
359 % MINIMAL_SYMBOL_HASH_SIZE);
361 symbol_name_matcher_ftype *match
362 = get_symbol_name_matcher (language_def (lang),
364 struct minimal_symbol **msymbol_demangled_hash
365 = objfile->per_bfd->msymbol_demangled_hash;
367 lookup_minimal_symbol_demangled (lookup_name, sfile, objfile,
368 msymbol_demangled_hash,
371 if (found.external_symbol.minsym != NULL)
378 /* External symbols are best. */
379 if (found.external_symbol.minsym != NULL)
381 if (symbol_lookup_debug)
383 minimal_symbol *minsym = found.external_symbol.minsym;
385 fprintf_unfiltered (gdb_stdlog,
386 "lookup_minimal_symbol (...) = %s (external)\n",
387 host_address_to_string (minsym));
389 return found.external_symbol;
392 /* File-local symbols are next best. */
393 if (found.file_symbol.minsym != NULL)
395 if (symbol_lookup_debug)
397 minimal_symbol *minsym = found.file_symbol.minsym;
399 fprintf_unfiltered (gdb_stdlog,
400 "lookup_minimal_symbol (...) = %s (file-local)\n",
401 host_address_to_string (minsym));
403 return found.file_symbol;
406 /* Symbols for shared library trampolines are next best. */
407 if (found.trampoline_symbol.minsym != NULL)
409 if (symbol_lookup_debug)
411 minimal_symbol *minsym = found.trampoline_symbol.minsym;
413 fprintf_unfiltered (gdb_stdlog,
414 "lookup_minimal_symbol (...) = %s (trampoline)\n",
415 host_address_to_string (minsym));
418 return found.trampoline_symbol;
422 if (symbol_lookup_debug)
423 fprintf_unfiltered (gdb_stdlog, "lookup_minimal_symbol (...) = NULL\n");
429 struct bound_minimal_symbol
430 lookup_bound_minimal_symbol (const char *name)
432 return lookup_minimal_symbol (name, NULL, NULL);
435 /* See common/symbol.h. */
438 find_minimal_symbol_address (const char *name, CORE_ADDR *addr,
439 struct objfile *objfile)
441 struct bound_minimal_symbol sym
442 = lookup_minimal_symbol (name, NULL, objfile);
444 if (sym.minsym != NULL)
445 *addr = BMSYMBOL_VALUE_ADDRESS (sym);
447 return sym.minsym == NULL;
450 /* Get the lookup name form best suitable for linkage name
454 linkage_name_str (const lookup_name_info &lookup_name)
456 /* Unlike most languages (including C++), Ada uses the
457 encoded/linkage name as the search name recorded in symbols. So
458 if debugging in Ada mode, prefer the Ada-encoded name. This also
459 makes Ada's verbatim match syntax ("<...>") work, because
460 "lookup_name.name()" includes the "<>"s, while
461 "lookup_name.ada().lookup_name()" is the encoded name with "<>"s
463 if (current_language->la_language == language_ada)
464 return lookup_name.ada ().lookup_name ().c_str ();
466 return lookup_name.name ().c_str ();
472 iterate_over_minimal_symbols
473 (struct objfile *objf, const lookup_name_info &lookup_name,
474 gdb::function_view<void (struct minimal_symbol *)> callback)
476 /* The first pass is over the ordinary hash table. */
478 const char *name = linkage_name_str (lookup_name);
479 unsigned int hash = msymbol_hash (name) % MINIMAL_SYMBOL_HASH_SIZE;
481 = (case_sensitivity == case_sensitive_on
485 for (minimal_symbol *iter = objf->per_bfd->msymbol_hash[hash];
487 iter = iter->hash_next)
489 if (mangled_cmp (MSYMBOL_LINKAGE_NAME (iter), name) == 0)
494 /* The second pass is over the demangled table. Once for each
495 language in the demangled hash names table (usually just zero or
497 for (auto lang : objf->per_bfd->demangled_hash_languages)
499 const language_defn *lang_def = language_def (lang);
500 symbol_name_matcher_ftype *name_match
501 = get_symbol_name_matcher (lang_def, lookup_name);
504 = lookup_name.search_name_hash (lang) % MINIMAL_SYMBOL_HASH_SIZE;
505 for (minimal_symbol *iter = objf->per_bfd->msymbol_demangled_hash[hash];
507 iter = iter->demangled_hash_next)
508 if (name_match (MSYMBOL_SEARCH_NAME (iter), lookup_name, NULL))
515 struct bound_minimal_symbol
516 lookup_minimal_symbol_text (const char *name, struct objfile *objf)
518 struct objfile *objfile;
519 struct minimal_symbol *msymbol;
520 struct bound_minimal_symbol found_symbol = { NULL, NULL };
521 struct bound_minimal_symbol found_file_symbol = { NULL, NULL };
523 unsigned int hash = msymbol_hash (name) % MINIMAL_SYMBOL_HASH_SIZE;
525 for (objfile = object_files;
526 objfile != NULL && found_symbol.minsym == NULL;
527 objfile = objfile->next)
529 if (objf == NULL || objf == objfile
530 || objf == objfile->separate_debug_objfile_backlink)
532 for (msymbol = objfile->per_bfd->msymbol_hash[hash];
533 msymbol != NULL && found_symbol.minsym == NULL;
534 msymbol = msymbol->hash_next)
536 if (strcmp (MSYMBOL_LINKAGE_NAME (msymbol), name) == 0 &&
537 (MSYMBOL_TYPE (msymbol) == mst_text
538 || MSYMBOL_TYPE (msymbol) == mst_text_gnu_ifunc
539 || MSYMBOL_TYPE (msymbol) == mst_file_text))
541 switch (MSYMBOL_TYPE (msymbol))
544 found_file_symbol.minsym = msymbol;
545 found_file_symbol.objfile = objfile;
548 found_symbol.minsym = msymbol;
549 found_symbol.objfile = objfile;
556 /* External symbols are best. */
557 if (found_symbol.minsym)
560 /* File-local symbols are next best. */
561 return found_file_symbol;
566 struct minimal_symbol *
567 lookup_minimal_symbol_by_pc_name (CORE_ADDR pc, const char *name,
568 struct objfile *objf)
570 struct objfile *objfile;
571 struct minimal_symbol *msymbol;
573 unsigned int hash = msymbol_hash (name) % MINIMAL_SYMBOL_HASH_SIZE;
575 for (objfile = object_files;
577 objfile = objfile->next)
579 if (objf == NULL || objf == objfile
580 || objf == objfile->separate_debug_objfile_backlink)
582 for (msymbol = objfile->per_bfd->msymbol_hash[hash];
584 msymbol = msymbol->hash_next)
586 if (MSYMBOL_VALUE_ADDRESS (objfile, msymbol) == pc
587 && strcmp (MSYMBOL_LINKAGE_NAME (msymbol), name) == 0)
598 struct bound_minimal_symbol
599 lookup_minimal_symbol_solib_trampoline (const char *name,
600 struct objfile *objf)
602 struct objfile *objfile;
603 struct minimal_symbol *msymbol;
604 struct bound_minimal_symbol found_symbol = { NULL, NULL };
606 unsigned int hash = msymbol_hash (name) % MINIMAL_SYMBOL_HASH_SIZE;
608 for (objfile = object_files;
610 objfile = objfile->next)
612 if (objf == NULL || objf == objfile
613 || objf == objfile->separate_debug_objfile_backlink)
615 for (msymbol = objfile->per_bfd->msymbol_hash[hash];
617 msymbol = msymbol->hash_next)
619 if (strcmp (MSYMBOL_LINKAGE_NAME (msymbol), name) == 0 &&
620 MSYMBOL_TYPE (msymbol) == mst_solib_trampoline)
622 found_symbol.objfile = objfile;
623 found_symbol.minsym = msymbol;
633 /* A helper function that makes *PC section-relative. This searches
634 the sections of OBJFILE and if *PC is in a section, it subtracts
635 the section offset and returns true. Otherwise it returns
639 frob_address (struct objfile *objfile, CORE_ADDR *pc)
641 struct obj_section *iter;
643 ALL_OBJFILE_OSECTIONS (objfile, iter)
645 if (*pc >= obj_section_addr (iter) && *pc < obj_section_endaddr (iter))
647 *pc -= obj_section_offset (iter);
655 /* Search through the minimal symbol table for each objfile and find
656 the symbol whose address is the largest address that is still less
657 than or equal to PC, and matches SECTION (which is not NULL).
658 Returns a pointer to the minimal symbol if such a symbol is found,
659 or NULL if PC is not in a suitable range.
660 Note that we need to look through ALL the minimal symbol tables
661 before deciding on the symbol that comes closest to the specified PC.
662 This is because objfiles can overlap, for example objfile A has .text
663 at 0x100 and .data at 0x40000 and objfile B has .text at 0x234 and
666 If WANT_TRAMPOLINE is set, prefer mst_solib_trampoline symbols when
667 there are text and trampoline symbols at the same address.
668 Otherwise prefer mst_text symbols. */
670 static struct bound_minimal_symbol
671 lookup_minimal_symbol_by_pc_section_1 (CORE_ADDR pc_in,
672 struct obj_section *section,
678 struct objfile *objfile;
679 struct minimal_symbol *msymbol;
680 struct minimal_symbol *best_symbol = NULL;
681 struct objfile *best_objfile = NULL;
682 struct bound_minimal_symbol result;
683 enum minimal_symbol_type want_type, other_type;
685 want_type = want_trampoline ? mst_solib_trampoline : mst_text;
686 other_type = want_trampoline ? mst_text : mst_solib_trampoline;
688 /* We can not require the symbol found to be in section, because
689 e.g. IRIX 6.5 mdebug relies on this code returning an absolute
690 symbol - but find_pc_section won't return an absolute section and
691 hence the code below would skip over absolute symbols. We can
692 still take advantage of the call to find_pc_section, though - the
693 object file still must match. In case we have separate debug
694 files, search both the file and its separate debug file. There's
695 no telling which one will have the minimal symbols. */
697 gdb_assert (section != NULL);
699 for (objfile = section->objfile;
701 objfile = objfile_separate_debug_iterate (section->objfile, objfile))
703 CORE_ADDR pc = pc_in;
705 /* If this objfile has a minimal symbol table, go search it using
706 a binary search. Note that a minimal symbol table always consists
707 of at least two symbols, a "real" symbol and the terminating
708 "null symbol". If there are no real symbols, then there is no
709 minimal symbol table at all. */
711 if (objfile->per_bfd->minimal_symbol_count > 0)
713 int best_zero_sized = -1;
715 msymbol = objfile->per_bfd->msymbols;
717 hi = objfile->per_bfd->minimal_symbol_count - 1;
719 /* This code assumes that the minimal symbols are sorted by
720 ascending address values. If the pc value is greater than or
721 equal to the first symbol's address, then some symbol in this
722 minimal symbol table is a suitable candidate for being the
723 "best" symbol. This includes the last real symbol, for cases
724 where the pc value is larger than any address in this vector.
726 By iterating until the address associated with the current
727 hi index (the endpoint of the test interval) is less than
728 or equal to the desired pc value, we accomplish two things:
729 (1) the case where the pc value is larger than any minimal
730 symbol address is trivially solved, (2) the address associated
731 with the hi index is always the one we want when the interation
732 terminates. In essence, we are iterating the test interval
733 down until the pc value is pushed out of it from the high end.
735 Warning: this code is trickier than it would appear at first. */
737 if (frob_address (objfile, &pc)
738 && pc >= MSYMBOL_VALUE_RAW_ADDRESS (&msymbol[lo]))
740 while (MSYMBOL_VALUE_RAW_ADDRESS (&msymbol[hi]) > pc)
742 /* pc is still strictly less than highest address. */
743 /* Note "new" will always be >= lo. */
744 newobj = (lo + hi) / 2;
745 if ((MSYMBOL_VALUE_RAW_ADDRESS (&msymbol[newobj]) >= pc)
756 /* If we have multiple symbols at the same address, we want
757 hi to point to the last one. That way we can find the
758 right symbol if it has an index greater than hi. */
759 while (hi < objfile->per_bfd->minimal_symbol_count - 1
760 && (MSYMBOL_VALUE_RAW_ADDRESS (&msymbol[hi])
761 == MSYMBOL_VALUE_RAW_ADDRESS (&msymbol[hi + 1])))
764 /* Skip various undesirable symbols. */
767 /* Skip any absolute symbols. This is apparently
768 what adb and dbx do, and is needed for the CM-5.
769 There are two known possible problems: (1) on
770 ELF, apparently end, edata, etc. are absolute.
771 Not sure ignoring them here is a big deal, but if
772 we want to use them, the fix would go in
773 elfread.c. (2) I think shared library entry
774 points on the NeXT are absolute. If we want
775 special handling for this it probably should be
776 triggered by a special mst_abs_or_lib or some
779 if (MSYMBOL_TYPE (&msymbol[hi]) == mst_abs)
785 /* If SECTION was specified, skip any symbol from
788 /* Some types of debug info, such as COFF,
789 don't fill the bfd_section member, so don't
790 throw away symbols on those platforms. */
791 && MSYMBOL_OBJ_SECTION (objfile, &msymbol[hi]) != NULL
792 && (!matching_obj_sections
793 (MSYMBOL_OBJ_SECTION (objfile, &msymbol[hi]),
800 /* If we are looking for a trampoline and this is a
801 text symbol, or the other way around, check the
802 preceding symbol too. If they are otherwise
803 identical prefer that one. */
805 && MSYMBOL_TYPE (&msymbol[hi]) == other_type
806 && MSYMBOL_TYPE (&msymbol[hi - 1]) == want_type
807 && (MSYMBOL_SIZE (&msymbol[hi])
808 == MSYMBOL_SIZE (&msymbol[hi - 1]))
809 && (MSYMBOL_VALUE_RAW_ADDRESS (&msymbol[hi])
810 == MSYMBOL_VALUE_RAW_ADDRESS (&msymbol[hi - 1]))
811 && (MSYMBOL_OBJ_SECTION (objfile, &msymbol[hi])
812 == MSYMBOL_OBJ_SECTION (objfile, &msymbol[hi - 1])))
818 /* If the minimal symbol has a zero size, save it
819 but keep scanning backwards looking for one with
820 a non-zero size. A zero size may mean that the
821 symbol isn't an object or function (e.g. a
822 label), or it may just mean that the size was not
824 if (MSYMBOL_SIZE (&msymbol[hi]) == 0)
826 if (best_zero_sized == -1)
827 best_zero_sized = hi;
832 /* If we are past the end of the current symbol, try
833 the previous symbol if it has a larger overlapping
834 size. This happens on i686-pc-linux-gnu with glibc;
835 the nocancel variants of system calls are inside
836 the cancellable variants, but both have sizes. */
838 && MSYMBOL_SIZE (&msymbol[hi]) != 0
839 && pc >= (MSYMBOL_VALUE_RAW_ADDRESS (&msymbol[hi])
840 + MSYMBOL_SIZE (&msymbol[hi]))
841 && pc < (MSYMBOL_VALUE_RAW_ADDRESS (&msymbol[hi - 1])
842 + MSYMBOL_SIZE (&msymbol[hi - 1])))
848 /* Otherwise, this symbol must be as good as we're going
853 /* If HI has a zero size, and best_zero_sized is set,
854 then we had two or more zero-sized symbols; prefer
855 the first one we found (which may have a higher
856 address). Also, if we ran off the end, be sure
858 if (best_zero_sized != -1
859 && (hi < 0 || MSYMBOL_SIZE (&msymbol[hi]) == 0))
860 hi = best_zero_sized;
862 /* If the minimal symbol has a non-zero size, and this
863 PC appears to be outside the symbol's contents, then
864 refuse to use this symbol. If we found a zero-sized
865 symbol with an address greater than this symbol's,
866 use that instead. We assume that if symbols have
867 specified sizes, they do not overlap. */
870 && MSYMBOL_SIZE (&msymbol[hi]) != 0
871 && pc >= (MSYMBOL_VALUE_RAW_ADDRESS (&msymbol[hi])
872 + MSYMBOL_SIZE (&msymbol[hi])))
874 if (best_zero_sized != -1)
875 hi = best_zero_sized;
877 /* Go on to the next object file. */
881 /* The minimal symbol indexed by hi now is the best one in this
882 objfile's minimal symbol table. See if it is the best one
886 && ((best_symbol == NULL) ||
887 (MSYMBOL_VALUE_RAW_ADDRESS (best_symbol) <
888 MSYMBOL_VALUE_RAW_ADDRESS (&msymbol[hi]))))
890 best_symbol = &msymbol[hi];
891 best_objfile = objfile;
897 result.minsym = best_symbol;
898 result.objfile = best_objfile;
902 struct bound_minimal_symbol
903 lookup_minimal_symbol_by_pc_section (CORE_ADDR pc, struct obj_section *section)
907 /* NOTE: cagney/2004-01-27: This was using find_pc_mapped_section to
908 force the section but that (well unless you're doing overlay
909 debugging) always returns NULL making the call somewhat useless. */
910 section = find_pc_section (pc);
913 struct bound_minimal_symbol result;
915 memset (&result, 0, sizeof (result));
919 return lookup_minimal_symbol_by_pc_section_1 (pc, section, 0);
924 struct bound_minimal_symbol
925 lookup_minimal_symbol_by_pc (CORE_ADDR pc)
927 struct obj_section *section = find_pc_section (pc);
931 struct bound_minimal_symbol result;
933 memset (&result, 0, sizeof (result));
936 return lookup_minimal_symbol_by_pc_section_1 (pc, section, 0);
939 /* Return non-zero iff PC is in an STT_GNU_IFUNC function resolver. */
942 in_gnu_ifunc_stub (CORE_ADDR pc)
944 struct bound_minimal_symbol msymbol = lookup_minimal_symbol_by_pc (pc);
946 return msymbol.minsym && MSYMBOL_TYPE (msymbol.minsym) == mst_text_gnu_ifunc;
949 /* See elf_gnu_ifunc_resolve_addr for its real implementation. */
952 stub_gnu_ifunc_resolve_addr (struct gdbarch *gdbarch, CORE_ADDR pc)
954 error (_("GDB cannot resolve STT_GNU_IFUNC symbol at address %s without "
955 "the ELF support compiled in."),
956 paddress (gdbarch, pc));
959 /* See elf_gnu_ifunc_resolve_name for its real implementation. */
962 stub_gnu_ifunc_resolve_name (const char *function_name,
963 CORE_ADDR *function_address_p)
965 error (_("GDB cannot resolve STT_GNU_IFUNC symbol \"%s\" without "
966 "the ELF support compiled in."),
970 /* See elf_gnu_ifunc_resolver_stop for its real implementation. */
973 stub_gnu_ifunc_resolver_stop (struct breakpoint *b)
975 internal_error (__FILE__, __LINE__,
976 _("elf_gnu_ifunc_resolver_stop cannot be reached."));
979 /* See elf_gnu_ifunc_resolver_return_stop for its real implementation. */
982 stub_gnu_ifunc_resolver_return_stop (struct breakpoint *b)
984 internal_error (__FILE__, __LINE__,
985 _("elf_gnu_ifunc_resolver_return_stop cannot be reached."));
988 /* See elf_gnu_ifunc_fns for its real implementation. */
990 static const struct gnu_ifunc_fns stub_gnu_ifunc_fns =
992 stub_gnu_ifunc_resolve_addr,
993 stub_gnu_ifunc_resolve_name,
994 stub_gnu_ifunc_resolver_stop,
995 stub_gnu_ifunc_resolver_return_stop,
998 /* A placeholder for &elf_gnu_ifunc_fns. */
1000 const struct gnu_ifunc_fns *gnu_ifunc_fns_p = &stub_gnu_ifunc_fns;
1002 /* See minsyms.h. */
1004 struct bound_minimal_symbol
1005 lookup_minimal_symbol_and_objfile (const char *name)
1007 struct bound_minimal_symbol result;
1008 struct objfile *objfile;
1010 ALL_OBJFILES (objfile)
1012 result = lookup_minimal_symbol (name, NULL, objfile);
1013 if (result.minsym != NULL)
1017 memset (&result, 0, sizeof (result));
1022 /* Return leading symbol character for a BFD. If BFD is NULL,
1023 return the leading symbol character from the main objfile. */
1026 get_symbol_leading_char (bfd *abfd)
1029 return bfd_get_symbol_leading_char (abfd);
1030 if (symfile_objfile != NULL && symfile_objfile->obfd != NULL)
1031 return bfd_get_symbol_leading_char (symfile_objfile->obfd);
1035 /* See minsyms.h. */
1037 minimal_symbol_reader::minimal_symbol_reader (struct objfile *obj)
1039 m_msym_bunch (NULL),
1040 /* Note that presetting m_msym_bunch_index to BUNCH_SIZE causes the
1041 first call to save a minimal symbol to allocate the memory for
1043 m_msym_bunch_index (BUNCH_SIZE),
1048 /* Discard the currently collected minimal symbols, if any. If we wish
1049 to save them for later use, we must have already copied them somewhere
1050 else before calling this function.
1052 FIXME: We could allocate the minimal symbol bunches on their own
1053 obstack and then simply blow the obstack away when we are done with
1054 it. Is it worth the extra trouble though? */
1056 minimal_symbol_reader::~minimal_symbol_reader ()
1058 struct msym_bunch *next;
1060 while (m_msym_bunch != NULL)
1062 next = m_msym_bunch->next;
1063 xfree (m_msym_bunch);
1064 m_msym_bunch = next;
1068 /* See minsyms.h. */
1071 minimal_symbol_reader::record (const char *name, CORE_ADDR address,
1072 enum minimal_symbol_type ms_type)
1079 case mst_text_gnu_ifunc:
1081 case mst_solib_trampoline:
1082 section = SECT_OFF_TEXT (m_objfile);
1086 section = SECT_OFF_DATA (m_objfile);
1090 section = SECT_OFF_BSS (m_objfile);
1096 record_with_info (name, address, ms_type, section);
1099 /* See minsyms.h. */
1101 struct minimal_symbol *
1102 minimal_symbol_reader::record_full (const char *name, int name_len,
1103 bool copy_name, CORE_ADDR address,
1104 enum minimal_symbol_type ms_type,
1107 struct msym_bunch *newobj;
1108 struct minimal_symbol *msymbol;
1110 /* Don't put gcc_compiled, __gnu_compiled_cplus, and friends into
1111 the minimal symbols, because if there is also another symbol
1112 at the same address (e.g. the first function of the file),
1113 lookup_minimal_symbol_by_pc would have no way of getting the
1115 if (ms_type == mst_file_text && name[0] == 'g'
1116 && (strcmp (name, GCC_COMPILED_FLAG_SYMBOL) == 0
1117 || strcmp (name, GCC2_COMPILED_FLAG_SYMBOL) == 0))
1120 /* It's safe to strip the leading char here once, since the name
1121 is also stored stripped in the minimal symbol table. */
1122 if (name[0] == get_symbol_leading_char (m_objfile->obfd))
1128 if (ms_type == mst_file_text && startswith (name, "__gnu_compiled"))
1131 if (m_msym_bunch_index == BUNCH_SIZE)
1133 newobj = XCNEW (struct msym_bunch);
1134 m_msym_bunch_index = 0;
1135 newobj->next = m_msym_bunch;
1136 m_msym_bunch = newobj;
1138 msymbol = &m_msym_bunch->contents[m_msym_bunch_index];
1139 MSYMBOL_SET_LANGUAGE (msymbol, language_auto,
1140 &m_objfile->per_bfd->storage_obstack);
1141 MSYMBOL_SET_NAMES (msymbol, name, name_len, copy_name, m_objfile);
1143 SET_MSYMBOL_VALUE_ADDRESS (msymbol, address);
1144 MSYMBOL_SECTION (msymbol) = section;
1146 MSYMBOL_TYPE (msymbol) = ms_type;
1147 MSYMBOL_TARGET_FLAG_1 (msymbol) = 0;
1148 MSYMBOL_TARGET_FLAG_2 (msymbol) = 0;
1149 /* Do not use the SET_MSYMBOL_SIZE macro to initialize the size,
1150 as it would also set the has_size flag. */
1153 /* The hash pointers must be cleared! If they're not,
1154 add_minsym_to_hash_table will NOT add this msymbol to the hash table. */
1155 msymbol->hash_next = NULL;
1156 msymbol->demangled_hash_next = NULL;
1158 /* If we already read minimal symbols for this objfile, then don't
1159 ever allocate a new one. */
1160 if (!m_objfile->per_bfd->minsyms_read)
1162 m_msym_bunch_index++;
1163 m_objfile->per_bfd->n_minsyms++;
1169 /* Compare two minimal symbols by address and return a signed result based
1170 on unsigned comparisons, so that we sort into unsigned numeric order.
1171 Within groups with the same address, sort by name. */
1174 compare_minimal_symbols (const void *fn1p, const void *fn2p)
1176 const struct minimal_symbol *fn1;
1177 const struct minimal_symbol *fn2;
1179 fn1 = (const struct minimal_symbol *) fn1p;
1180 fn2 = (const struct minimal_symbol *) fn2p;
1182 if (MSYMBOL_VALUE_RAW_ADDRESS (fn1) < MSYMBOL_VALUE_RAW_ADDRESS (fn2))
1184 return (-1); /* addr 1 is less than addr 2. */
1186 else if (MSYMBOL_VALUE_RAW_ADDRESS (fn1) > MSYMBOL_VALUE_RAW_ADDRESS (fn2))
1188 return (1); /* addr 1 is greater than addr 2. */
1191 /* addrs are equal: sort by name */
1193 const char *name1 = MSYMBOL_LINKAGE_NAME (fn1);
1194 const char *name2 = MSYMBOL_LINKAGE_NAME (fn2);
1196 if (name1 && name2) /* both have names */
1197 return strcmp (name1, name2);
1199 return 1; /* fn1 has no name, so it is "less". */
1200 else if (name1) /* fn2 has no name, so it is "less". */
1203 return (0); /* Neither has a name, so they're equal. */
1207 /* Compact duplicate entries out of a minimal symbol table by walking
1208 through the table and compacting out entries with duplicate addresses
1209 and matching names. Return the number of entries remaining.
1211 On entry, the table resides between msymbol[0] and msymbol[mcount].
1212 On exit, it resides between msymbol[0] and msymbol[result_count].
1214 When files contain multiple sources of symbol information, it is
1215 possible for the minimal symbol table to contain many duplicate entries.
1216 As an example, SVR4 systems use ELF formatted object files, which
1217 usually contain at least two different types of symbol tables (a
1218 standard ELF one and a smaller dynamic linking table), as well as
1219 DWARF debugging information for files compiled with -g.
1221 Without compacting, the minimal symbol table for gdb itself contains
1222 over a 1000 duplicates, about a third of the total table size. Aside
1223 from the potential trap of not noticing that two successive entries
1224 identify the same location, this duplication impacts the time required
1225 to linearly scan the table, which is done in a number of places. So we
1226 just do one linear scan here and toss out the duplicates.
1228 Note that we are not concerned here about recovering the space that
1229 is potentially freed up, because the strings themselves are allocated
1230 on the storage_obstack, and will get automatically freed when the symbol
1231 table is freed. The caller can free up the unused minimal symbols at
1232 the end of the compacted region if their allocation strategy allows it.
1234 Also note we only go up to the next to last entry within the loop
1235 and then copy the last entry explicitly after the loop terminates.
1237 Since the different sources of information for each symbol may
1238 have different levels of "completeness", we may have duplicates
1239 that have one entry with type "mst_unknown" and the other with a
1240 known type. So if the one we are leaving alone has type mst_unknown,
1241 overwrite its type with the type from the one we are compacting out. */
1244 compact_minimal_symbols (struct minimal_symbol *msymbol, int mcount,
1245 struct objfile *objfile)
1247 struct minimal_symbol *copyfrom;
1248 struct minimal_symbol *copyto;
1252 copyfrom = copyto = msymbol;
1253 while (copyfrom < msymbol + mcount - 1)
1255 if (MSYMBOL_VALUE_RAW_ADDRESS (copyfrom)
1256 == MSYMBOL_VALUE_RAW_ADDRESS ((copyfrom + 1))
1257 && MSYMBOL_SECTION (copyfrom) == MSYMBOL_SECTION (copyfrom + 1)
1258 && strcmp (MSYMBOL_LINKAGE_NAME (copyfrom),
1259 MSYMBOL_LINKAGE_NAME ((copyfrom + 1))) == 0)
1261 if (MSYMBOL_TYPE ((copyfrom + 1)) == mst_unknown)
1263 MSYMBOL_TYPE ((copyfrom + 1)) = MSYMBOL_TYPE (copyfrom);
1268 *copyto++ = *copyfrom++;
1270 *copyto++ = *copyfrom++;
1271 mcount = copyto - msymbol;
1276 /* Build (or rebuild) the minimal symbol hash tables. This is necessary
1277 after compacting or sorting the table since the entries move around
1278 thus causing the internal minimal_symbol pointers to become jumbled. */
1281 build_minimal_symbol_hash_tables (struct objfile *objfile)
1284 struct minimal_symbol *msym;
1286 /* Clear the hash tables. */
1287 for (i = 0; i < MINIMAL_SYMBOL_HASH_SIZE; i++)
1289 objfile->per_bfd->msymbol_hash[i] = 0;
1290 objfile->per_bfd->msymbol_demangled_hash[i] = 0;
1293 /* Now, (re)insert the actual entries. */
1294 for ((i = objfile->per_bfd->minimal_symbol_count,
1295 msym = objfile->per_bfd->msymbols);
1299 msym->hash_next = 0;
1300 add_minsym_to_hash_table (msym, objfile->per_bfd->msymbol_hash);
1302 msym->demangled_hash_next = 0;
1303 if (MSYMBOL_SEARCH_NAME (msym) != MSYMBOL_LINKAGE_NAME (msym))
1304 add_minsym_to_demangled_hash_table (msym, objfile);
1308 /* Add the minimal symbols in the existing bunches to the objfile's official
1309 minimal symbol table. In most cases there is no minimal symbol table yet
1310 for this objfile, and the existing bunches are used to create one. Once
1311 in a while (for shared libraries for example), we add symbols (e.g. common
1312 symbols) to an existing objfile.
1314 Because of the way minimal symbols are collected, we generally have no way
1315 of knowing what source language applies to any particular minimal symbol.
1316 Specifically, we have no way of knowing if the minimal symbol comes from a
1317 C++ compilation unit or not. So for the sake of supporting cached
1318 demangled C++ names, we have no choice but to try and demangle each new one
1319 that comes in. If the demangling succeeds, then we assume it is a C++
1320 symbol and set the symbol's language and demangled name fields
1321 appropriately. Note that in order to avoid unnecessary demanglings, and
1322 allocating obstack space that subsequently can't be freed for the demangled
1323 names, we mark all newly added symbols with language_auto. After
1324 compaction of the minimal symbols, we go back and scan the entire minimal
1325 symbol table looking for these new symbols. For each new symbol we attempt
1326 to demangle it, and if successful, record it as a language_cplus symbol
1327 and cache the demangled form on the symbol obstack. Symbols which don't
1328 demangle are marked as language_unknown symbols, which inhibits future
1329 attempts to demangle them if we later add more minimal symbols. */
1332 minimal_symbol_reader::install ()
1336 struct msym_bunch *bunch;
1337 struct minimal_symbol *msymbols;
1340 if (m_objfile->per_bfd->minsyms_read)
1343 if (m_msym_count > 0)
1345 if (symtab_create_debug)
1347 fprintf_unfiltered (gdb_stdlog,
1348 "Installing %d minimal symbols of objfile %s.\n",
1349 m_msym_count, objfile_name (m_objfile));
1352 /* Allocate enough space in the obstack, into which we will gather the
1353 bunches of new and existing minimal symbols, sort them, and then
1354 compact out the duplicate entries. Once we have a final table,
1355 we will give back the excess space. */
1357 alloc_count = m_msym_count + m_objfile->per_bfd->minimal_symbol_count + 1;
1358 obstack_blank (&m_objfile->per_bfd->storage_obstack,
1359 alloc_count * sizeof (struct minimal_symbol));
1360 msymbols = (struct minimal_symbol *)
1361 obstack_base (&m_objfile->per_bfd->storage_obstack);
1363 /* Copy in the existing minimal symbols, if there are any. */
1365 if (m_objfile->per_bfd->minimal_symbol_count)
1366 memcpy ((char *) msymbols, (char *) m_objfile->per_bfd->msymbols,
1367 m_objfile->per_bfd->minimal_symbol_count * sizeof (struct minimal_symbol));
1369 /* Walk through the list of minimal symbol bunches, adding each symbol
1370 to the new contiguous array of symbols. Note that we start with the
1371 current, possibly partially filled bunch (thus we use the current
1372 msym_bunch_index for the first bunch we copy over), and thereafter
1373 each bunch is full. */
1375 mcount = m_objfile->per_bfd->minimal_symbol_count;
1377 for (bunch = m_msym_bunch; bunch != NULL; bunch = bunch->next)
1379 for (bindex = 0; bindex < m_msym_bunch_index; bindex++, mcount++)
1380 msymbols[mcount] = bunch->contents[bindex];
1381 m_msym_bunch_index = BUNCH_SIZE;
1384 /* Sort the minimal symbols by address. */
1386 qsort (msymbols, mcount, sizeof (struct minimal_symbol),
1387 compare_minimal_symbols);
1389 /* Compact out any duplicates, and free up whatever space we are
1392 mcount = compact_minimal_symbols (msymbols, mcount, m_objfile);
1394 obstack_blank_fast (&m_objfile->per_bfd->storage_obstack,
1395 (mcount + 1 - alloc_count) * sizeof (struct minimal_symbol));
1396 msymbols = (struct minimal_symbol *)
1397 obstack_finish (&m_objfile->per_bfd->storage_obstack);
1399 /* We also terminate the minimal symbol table with a "null symbol",
1400 which is *not* included in the size of the table. This makes it
1401 easier to find the end of the table when we are handed a pointer
1402 to some symbol in the middle of it. Zero out the fields in the
1403 "null symbol" allocated at the end of the array. Note that the
1404 symbol count does *not* include this null symbol, which is why it
1405 is indexed by mcount and not mcount-1. */
1407 memset (&msymbols[mcount], 0, sizeof (struct minimal_symbol));
1409 /* Attach the minimal symbol table to the specified objfile.
1410 The strings themselves are also located in the storage_obstack
1413 m_objfile->per_bfd->minimal_symbol_count = mcount;
1414 m_objfile->per_bfd->msymbols = msymbols;
1416 /* Now build the hash tables; we can't do this incrementally
1417 at an earlier point since we weren't finished with the obstack
1418 yet. (And if the msymbol obstack gets moved, all the internal
1419 pointers to other msymbols need to be adjusted.) */
1420 build_minimal_symbol_hash_tables (m_objfile);
1424 /* See minsyms.h. */
1427 terminate_minimal_symbol_table (struct objfile *objfile)
1429 if (! objfile->per_bfd->msymbols)
1430 objfile->per_bfd->msymbols
1431 = ((struct minimal_symbol *)
1432 obstack_alloc (&objfile->per_bfd->storage_obstack,
1433 sizeof (struct minimal_symbol)));
1436 struct minimal_symbol *m
1437 = &objfile->per_bfd->msymbols[objfile->per_bfd->minimal_symbol_count];
1439 memset (m, 0, sizeof (*m));
1440 /* Don't rely on these enumeration values being 0's. */
1441 MSYMBOL_TYPE (m) = mst_unknown;
1442 MSYMBOL_SET_LANGUAGE (m, language_unknown,
1443 &objfile->per_bfd->storage_obstack);
1447 /* Check if PC is in a shared library trampoline code stub.
1448 Return minimal symbol for the trampoline entry or NULL if PC is not
1449 in a trampoline code stub. */
1451 static struct minimal_symbol *
1452 lookup_solib_trampoline_symbol_by_pc (CORE_ADDR pc)
1454 struct obj_section *section = find_pc_section (pc);
1455 struct bound_minimal_symbol msymbol;
1457 if (section == NULL)
1459 msymbol = lookup_minimal_symbol_by_pc_section_1 (pc, section, 1);
1461 if (msymbol.minsym != NULL
1462 && MSYMBOL_TYPE (msymbol.minsym) == mst_solib_trampoline)
1463 return msymbol.minsym;
1467 /* If PC is in a shared library trampoline code stub, return the
1468 address of the `real' function belonging to the stub.
1469 Return 0 if PC is not in a trampoline code stub or if the real
1470 function is not found in the minimal symbol table.
1472 We may fail to find the right function if a function with the
1473 same name is defined in more than one shared library, but this
1474 is considered bad programming style. We could return 0 if we find
1475 a duplicate function in case this matters someday. */
1478 find_solib_trampoline_target (struct frame_info *frame, CORE_ADDR pc)
1480 struct objfile *objfile;
1481 struct minimal_symbol *msymbol;
1482 struct minimal_symbol *tsymbol = lookup_solib_trampoline_symbol_by_pc (pc);
1484 if (tsymbol != NULL)
1486 ALL_MSYMBOLS (objfile, msymbol)
1488 if ((MSYMBOL_TYPE (msymbol) == mst_text
1489 || MSYMBOL_TYPE (msymbol) == mst_text_gnu_ifunc)
1490 && strcmp (MSYMBOL_LINKAGE_NAME (msymbol),
1491 MSYMBOL_LINKAGE_NAME (tsymbol)) == 0)
1492 return MSYMBOL_VALUE_ADDRESS (objfile, msymbol);
1494 /* Also handle minimal symbols pointing to function descriptors. */
1495 if (MSYMBOL_TYPE (msymbol) == mst_data
1496 && strcmp (MSYMBOL_LINKAGE_NAME (msymbol),
1497 MSYMBOL_LINKAGE_NAME (tsymbol)) == 0)
1501 func = gdbarch_convert_from_func_ptr_addr
1502 (get_objfile_arch (objfile),
1503 MSYMBOL_VALUE_ADDRESS (objfile, msymbol),
1506 /* Ignore data symbols that are not function descriptors. */
1507 if (func != MSYMBOL_VALUE_ADDRESS (objfile, msymbol))
1515 /* See minsyms.h. */
1518 minimal_symbol_upper_bound (struct bound_minimal_symbol minsym)
1522 struct obj_section *obj_section;
1524 struct minimal_symbol *msymbol;
1526 gdb_assert (minsym.minsym != NULL);
1528 /* If the minimal symbol has a size, use it. Otherwise use the
1529 lesser of the next minimal symbol in the same section, or the end
1530 of the section, as the end of the function. */
1532 if (MSYMBOL_SIZE (minsym.minsym) != 0)
1533 return BMSYMBOL_VALUE_ADDRESS (minsym) + MSYMBOL_SIZE (minsym.minsym);
1535 /* Step over other symbols at this same address, and symbols in
1536 other sections, to find the next symbol in this section with a
1537 different address. */
1539 msymbol = minsym.minsym;
1540 section = MSYMBOL_SECTION (msymbol);
1541 for (i = 1; MSYMBOL_LINKAGE_NAME (msymbol + i) != NULL; i++)
1543 if ((MSYMBOL_VALUE_RAW_ADDRESS (msymbol + i)
1544 != MSYMBOL_VALUE_RAW_ADDRESS (msymbol))
1545 && MSYMBOL_SECTION (msymbol + i) == section)
1549 obj_section = MSYMBOL_OBJ_SECTION (minsym.objfile, minsym.minsym);
1550 if (MSYMBOL_LINKAGE_NAME (msymbol + i) != NULL
1551 && (MSYMBOL_VALUE_ADDRESS (minsym.objfile, msymbol + i)
1552 < obj_section_endaddr (obj_section)))
1553 result = MSYMBOL_VALUE_ADDRESS (minsym.objfile, msymbol + i);
1555 /* We got the start address from the last msymbol in the objfile.
1556 So the end address is the end of the section. */
1557 result = obj_section_endaddr (obj_section);