1 /* Symbol table lookup for the GNU debugger, GDB.
3 Copyright (C) 1986-2019 Free Software Foundation, Inc.
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/>. */
30 #include "gdb_regex.h"
31 #include "expression.h"
36 #include "filenames.h" /* for FILENAME_CMP */
37 #include "objc-lang.h"
43 #include "cli/cli-utils.h"
44 #include "cli/cli-style.h"
47 #include "typeprint.h"
49 #include "gdb_obstack.h"
51 #include "dictionary.h"
53 #include <sys/types.h>
58 #include "cp-support.h"
59 #include "observable.h"
62 #include "macroscope.h"
64 #include "parser-defs.h"
65 #include "completer.h"
66 #include "progspace-and-thread.h"
67 #include "common/gdb_optional.h"
68 #include "filename-seen-cache.h"
69 #include "arch-utils.h"
71 #include "common/pathstuff.h"
73 /* Forward declarations for local functions. */
75 static void rbreak_command (const char *, int);
77 static int find_line_common (struct linetable *, int, int *, int);
79 static struct block_symbol
80 lookup_symbol_aux (const char *name,
81 symbol_name_match_type match_type,
82 const struct block *block,
83 const domain_enum domain,
84 enum language language,
85 struct field_of_this_result *);
88 struct block_symbol lookup_local_symbol (const char *name,
89 symbol_name_match_type match_type,
90 const struct block *block,
91 const domain_enum domain,
92 enum language language);
94 static struct block_symbol
95 lookup_symbol_in_objfile (struct objfile *objfile, int block_index,
96 const char *name, const domain_enum domain);
98 /* Type of the data stored on the program space. */
102 main_info () = default;
106 xfree (name_of_main);
109 /* Name of "main". */
111 char *name_of_main = nullptr;
113 /* Language of "main". */
115 enum language language_of_main = language_unknown;
118 /* Program space key for finding name and language of "main". */
120 static const program_space_key<main_info> main_progspace_key;
122 /* Program space key for finding its symbol cache. */
124 static const struct program_space_data *symbol_cache_key;
126 /* The default symbol cache size.
127 There is no extra cpu cost for large N (except when flushing the cache,
128 which is rare). The value here is just a first attempt. A better default
129 value may be higher or lower. A prime number can make up for a bad hash
130 computation, so that's why the number is what it is. */
131 #define DEFAULT_SYMBOL_CACHE_SIZE 1021
133 /* The maximum symbol cache size.
134 There's no method to the decision of what value to use here, other than
135 there's no point in allowing a user typo to make gdb consume all memory. */
136 #define MAX_SYMBOL_CACHE_SIZE (1024*1024)
138 /* symbol_cache_lookup returns this if a previous lookup failed to find the
139 symbol in any objfile. */
140 #define SYMBOL_LOOKUP_FAILED \
141 ((struct block_symbol) {(struct symbol *) 1, NULL})
142 #define SYMBOL_LOOKUP_FAILED_P(SIB) (SIB.symbol == (struct symbol *) 1)
144 /* Recording lookups that don't find the symbol is just as important, if not
145 more so, than recording found symbols. */
147 enum symbol_cache_slot_state
150 SYMBOL_SLOT_NOT_FOUND,
154 struct symbol_cache_slot
156 enum symbol_cache_slot_state state;
158 /* The objfile that was current when the symbol was looked up.
159 This is only needed for global blocks, but for simplicity's sake
160 we allocate the space for both. If data shows the extra space used
161 for static blocks is a problem, we can split things up then.
163 Global blocks need cache lookup to include the objfile context because
164 we need to account for gdbarch_iterate_over_objfiles_in_search_order
165 which can traverse objfiles in, effectively, any order, depending on
166 the current objfile, thus affecting which symbol is found. Normally,
167 only the current objfile is searched first, and then the rest are
168 searched in recorded order; but putting cache lookup inside
169 gdbarch_iterate_over_objfiles_in_search_order would be awkward.
170 Instead we just make the current objfile part of the context of
171 cache lookup. This means we can record the same symbol multiple times,
172 each with a different "current objfile" that was in effect when the
173 lookup was saved in the cache, but cache space is pretty cheap. */
174 const struct objfile *objfile_context;
178 struct block_symbol found;
187 /* Symbols don't specify global vs static block.
188 So keep them in separate caches. */
190 struct block_symbol_cache
194 unsigned int collisions;
196 /* SYMBOLS is a variable length array of this size.
197 One can imagine that in general one cache (global/static) should be a
198 fraction of the size of the other, but there's no data at the moment
199 on which to decide. */
202 struct symbol_cache_slot symbols[1];
207 Searching for symbols in the static and global blocks over multiple objfiles
208 again and again can be slow, as can searching very big objfiles. This is a
209 simple cache to improve symbol lookup performance, which is critical to
210 overall gdb performance.
212 Symbols are hashed on the name, its domain, and block.
213 They are also hashed on their objfile for objfile-specific lookups. */
217 struct block_symbol_cache *global_symbols;
218 struct block_symbol_cache *static_symbols;
221 /* When non-zero, print debugging messages related to symtab creation. */
222 unsigned int symtab_create_debug = 0;
224 /* When non-zero, print debugging messages related to symbol lookup. */
225 unsigned int symbol_lookup_debug = 0;
227 /* The size of the cache is staged here. */
228 static unsigned int new_symbol_cache_size = DEFAULT_SYMBOL_CACHE_SIZE;
230 /* The current value of the symbol cache size.
231 This is saved so that if the user enters a value too big we can restore
232 the original value from here. */
233 static unsigned int symbol_cache_size = DEFAULT_SYMBOL_CACHE_SIZE;
235 /* Non-zero if a file may be known by two different basenames.
236 This is the uncommon case, and significantly slows down gdb.
237 Default set to "off" to not slow down the common case. */
238 int basenames_may_differ = 0;
240 /* Allow the user to configure the debugger behavior with respect
241 to multiple-choice menus when more than one symbol matches during
244 const char multiple_symbols_ask[] = "ask";
245 const char multiple_symbols_all[] = "all";
246 const char multiple_symbols_cancel[] = "cancel";
247 static const char *const multiple_symbols_modes[] =
249 multiple_symbols_ask,
250 multiple_symbols_all,
251 multiple_symbols_cancel,
254 static const char *multiple_symbols_mode = multiple_symbols_all;
256 /* Read-only accessor to AUTO_SELECT_MODE. */
259 multiple_symbols_select_mode (void)
261 return multiple_symbols_mode;
264 /* Return the name of a domain_enum. */
267 domain_name (domain_enum e)
271 case UNDEF_DOMAIN: return "UNDEF_DOMAIN";
272 case VAR_DOMAIN: return "VAR_DOMAIN";
273 case STRUCT_DOMAIN: return "STRUCT_DOMAIN";
274 case MODULE_DOMAIN: return "MODULE_DOMAIN";
275 case LABEL_DOMAIN: return "LABEL_DOMAIN";
276 case COMMON_BLOCK_DOMAIN: return "COMMON_BLOCK_DOMAIN";
277 default: gdb_assert_not_reached ("bad domain_enum");
281 /* Return the name of a search_domain . */
284 search_domain_name (enum search_domain e)
288 case VARIABLES_DOMAIN: return "VARIABLES_DOMAIN";
289 case FUNCTIONS_DOMAIN: return "FUNCTIONS_DOMAIN";
290 case TYPES_DOMAIN: return "TYPES_DOMAIN";
291 case ALL_DOMAIN: return "ALL_DOMAIN";
292 default: gdb_assert_not_reached ("bad search_domain");
299 compunit_primary_filetab (const struct compunit_symtab *cust)
301 gdb_assert (COMPUNIT_FILETABS (cust) != NULL);
303 /* The primary file symtab is the first one in the list. */
304 return COMPUNIT_FILETABS (cust);
310 compunit_language (const struct compunit_symtab *cust)
312 struct symtab *symtab = compunit_primary_filetab (cust);
314 /* The language of the compunit symtab is the language of its primary
316 return SYMTAB_LANGUAGE (symtab);
322 minimal_symbol::data_p () const
324 return type == mst_data
327 || type == mst_file_data
328 || type == mst_file_bss;
334 minimal_symbol::text_p () const
336 return type == mst_text
337 || type == mst_text_gnu_ifunc
338 || type == mst_data_gnu_ifunc
339 || type == mst_slot_got_plt
340 || type == mst_solib_trampoline
341 || type == mst_file_text;
344 /* See whether FILENAME matches SEARCH_NAME using the rule that we
345 advertise to the user. (The manual's description of linespecs
346 describes what we advertise). Returns true if they match, false
350 compare_filenames_for_search (const char *filename, const char *search_name)
352 int len = strlen (filename);
353 size_t search_len = strlen (search_name);
355 if (len < search_len)
358 /* The tail of FILENAME must match. */
359 if (FILENAME_CMP (filename + len - search_len, search_name) != 0)
362 /* Either the names must completely match, or the character
363 preceding the trailing SEARCH_NAME segment of FILENAME must be a
366 The check !IS_ABSOLUTE_PATH ensures SEARCH_NAME "/dir/file.c"
367 cannot match FILENAME "/path//dir/file.c" - as user has requested
368 absolute path. The sama applies for "c:\file.c" possibly
369 incorrectly hypothetically matching "d:\dir\c:\file.c".
371 The HAS_DRIVE_SPEC purpose is to make FILENAME "c:file.c"
372 compatible with SEARCH_NAME "file.c". In such case a compiler had
373 to put the "c:file.c" name into debug info. Such compatibility
374 works only on GDB built for DOS host. */
375 return (len == search_len
376 || (!IS_ABSOLUTE_PATH (search_name)
377 && IS_DIR_SEPARATOR (filename[len - search_len - 1]))
378 || (HAS_DRIVE_SPEC (filename)
379 && STRIP_DRIVE_SPEC (filename) == &filename[len - search_len]));
382 /* Same as compare_filenames_for_search, but for glob-style patterns.
383 Heads up on the order of the arguments. They match the order of
384 compare_filenames_for_search, but it's the opposite of the order of
385 arguments to gdb_filename_fnmatch. */
388 compare_glob_filenames_for_search (const char *filename,
389 const char *search_name)
391 /* We rely on the property of glob-style patterns with FNM_FILE_NAME that
392 all /s have to be explicitly specified. */
393 int file_path_elements = count_path_elements (filename);
394 int search_path_elements = count_path_elements (search_name);
396 if (search_path_elements > file_path_elements)
399 if (IS_ABSOLUTE_PATH (search_name))
401 return (search_path_elements == file_path_elements
402 && gdb_filename_fnmatch (search_name, filename,
403 FNM_FILE_NAME | FNM_NOESCAPE) == 0);
407 const char *file_to_compare
408 = strip_leading_path_elements (filename,
409 file_path_elements - search_path_elements);
411 return gdb_filename_fnmatch (search_name, file_to_compare,
412 FNM_FILE_NAME | FNM_NOESCAPE) == 0;
416 /* Check for a symtab of a specific name by searching some symtabs.
417 This is a helper function for callbacks of iterate_over_symtabs.
419 If NAME is not absolute, then REAL_PATH is NULL
420 If NAME is absolute, then REAL_PATH is the gdb_realpath form of NAME.
422 The return value, NAME, REAL_PATH and CALLBACK are identical to the
423 `map_symtabs_matching_filename' method of quick_symbol_functions.
425 FIRST and AFTER_LAST indicate the range of compunit symtabs to search.
426 Each symtab within the specified compunit symtab is also searched.
427 AFTER_LAST is one past the last compunit symtab to search; NULL means to
428 search until the end of the list. */
431 iterate_over_some_symtabs (const char *name,
432 const char *real_path,
433 struct compunit_symtab *first,
434 struct compunit_symtab *after_last,
435 gdb::function_view<bool (symtab *)> callback)
437 struct compunit_symtab *cust;
438 const char* base_name = lbasename (name);
440 for (cust = first; cust != NULL && cust != after_last; cust = cust->next)
442 for (symtab *s : compunit_filetabs (cust))
444 if (compare_filenames_for_search (s->filename, name))
451 /* Before we invoke realpath, which can get expensive when many
452 files are involved, do a quick comparison of the basenames. */
453 if (! basenames_may_differ
454 && FILENAME_CMP (base_name, lbasename (s->filename)) != 0)
457 if (compare_filenames_for_search (symtab_to_fullname (s), name))
464 /* If the user gave us an absolute path, try to find the file in
465 this symtab and use its absolute path. */
466 if (real_path != NULL)
468 const char *fullname = symtab_to_fullname (s);
470 gdb_assert (IS_ABSOLUTE_PATH (real_path));
471 gdb_assert (IS_ABSOLUTE_PATH (name));
472 if (FILENAME_CMP (real_path, fullname) == 0)
485 /* Check for a symtab of a specific name; first in symtabs, then in
486 psymtabs. *If* there is no '/' in the name, a match after a '/'
487 in the symtab filename will also work.
489 Calls CALLBACK with each symtab that is found. If CALLBACK returns
490 true, the search stops. */
493 iterate_over_symtabs (const char *name,
494 gdb::function_view<bool (symtab *)> callback)
496 gdb::unique_xmalloc_ptr<char> real_path;
498 /* Here we are interested in canonicalizing an absolute path, not
499 absolutizing a relative path. */
500 if (IS_ABSOLUTE_PATH (name))
502 real_path = gdb_realpath (name);
503 gdb_assert (IS_ABSOLUTE_PATH (real_path.get ()));
506 for (objfile *objfile : current_program_space->objfiles ())
508 if (iterate_over_some_symtabs (name, real_path.get (),
509 objfile->compunit_symtabs, NULL,
514 /* Same search rules as above apply here, but now we look thru the
517 for (objfile *objfile : current_program_space->objfiles ())
520 && objfile->sf->qf->map_symtabs_matching_filename (objfile,
528 /* A wrapper for iterate_over_symtabs that returns the first matching
532 lookup_symtab (const char *name)
534 struct symtab *result = NULL;
536 iterate_over_symtabs (name, [&] (symtab *symtab)
546 /* Mangle a GDB method stub type. This actually reassembles the pieces of the
547 full method name, which consist of the class name (from T), the unadorned
548 method name from METHOD_ID, and the signature for the specific overload,
549 specified by SIGNATURE_ID. Note that this function is g++ specific. */
552 gdb_mangle_name (struct type *type, int method_id, int signature_id)
554 int mangled_name_len;
556 struct fn_field *f = TYPE_FN_FIELDLIST1 (type, method_id);
557 struct fn_field *method = &f[signature_id];
558 const char *field_name = TYPE_FN_FIELDLIST_NAME (type, method_id);
559 const char *physname = TYPE_FN_FIELD_PHYSNAME (f, signature_id);
560 const char *newname = TYPE_NAME (type);
562 /* Does the form of physname indicate that it is the full mangled name
563 of a constructor (not just the args)? */
564 int is_full_physname_constructor;
567 int is_destructor = is_destructor_name (physname);
568 /* Need a new type prefix. */
569 const char *const_prefix = method->is_const ? "C" : "";
570 const char *volatile_prefix = method->is_volatile ? "V" : "";
572 int len = (newname == NULL ? 0 : strlen (newname));
574 /* Nothing to do if physname already contains a fully mangled v3 abi name
575 or an operator name. */
576 if ((physname[0] == '_' && physname[1] == 'Z')
577 || is_operator_name (field_name))
578 return xstrdup (physname);
580 is_full_physname_constructor = is_constructor_name (physname);
582 is_constructor = is_full_physname_constructor
583 || (newname && strcmp (field_name, newname) == 0);
586 is_destructor = (startswith (physname, "__dt"));
588 if (is_destructor || is_full_physname_constructor)
590 mangled_name = (char *) xmalloc (strlen (physname) + 1);
591 strcpy (mangled_name, physname);
597 xsnprintf (buf, sizeof (buf), "__%s%s", const_prefix, volatile_prefix);
599 else if (physname[0] == 't' || physname[0] == 'Q')
601 /* The physname for template and qualified methods already includes
603 xsnprintf (buf, sizeof (buf), "__%s%s", const_prefix, volatile_prefix);
609 xsnprintf (buf, sizeof (buf), "__%s%s%d", const_prefix,
610 volatile_prefix, len);
612 mangled_name_len = ((is_constructor ? 0 : strlen (field_name))
613 + strlen (buf) + len + strlen (physname) + 1);
615 mangled_name = (char *) xmalloc (mangled_name_len);
617 mangled_name[0] = '\0';
619 strcpy (mangled_name, field_name);
621 strcat (mangled_name, buf);
622 /* If the class doesn't have a name, i.e. newname NULL, then we just
623 mangle it using 0 for the length of the class. Thus it gets mangled
624 as something starting with `::' rather than `classname::'. */
626 strcat (mangled_name, newname);
628 strcat (mangled_name, physname);
629 return (mangled_name);
632 /* Set the demangled name of GSYMBOL to NAME. NAME must be already
633 correctly allocated. */
636 symbol_set_demangled_name (struct general_symbol_info *gsymbol,
638 struct obstack *obstack)
640 if (gsymbol->language == language_ada)
644 gsymbol->ada_mangled = 0;
645 gsymbol->language_specific.obstack = obstack;
649 gsymbol->ada_mangled = 1;
650 gsymbol->language_specific.demangled_name = name;
654 gsymbol->language_specific.demangled_name = name;
657 /* Return the demangled name of GSYMBOL. */
660 symbol_get_demangled_name (const struct general_symbol_info *gsymbol)
662 if (gsymbol->language == language_ada)
664 if (!gsymbol->ada_mangled)
669 return gsymbol->language_specific.demangled_name;
673 /* Initialize the language dependent portion of a symbol
674 depending upon the language for the symbol. */
677 symbol_set_language (struct general_symbol_info *gsymbol,
678 enum language language,
679 struct obstack *obstack)
681 gsymbol->language = language;
682 if (gsymbol->language == language_cplus
683 || gsymbol->language == language_d
684 || gsymbol->language == language_go
685 || gsymbol->language == language_objc
686 || gsymbol->language == language_fortran)
688 symbol_set_demangled_name (gsymbol, NULL, obstack);
690 else if (gsymbol->language == language_ada)
692 gdb_assert (gsymbol->ada_mangled == 0);
693 gsymbol->language_specific.obstack = obstack;
697 memset (&gsymbol->language_specific, 0,
698 sizeof (gsymbol->language_specific));
702 /* Functions to initialize a symbol's mangled name. */
704 /* Objects of this type are stored in the demangled name hash table. */
705 struct demangled_name_entry
711 /* Hash function for the demangled name hash. */
714 hash_demangled_name_entry (const void *data)
716 const struct demangled_name_entry *e
717 = (const struct demangled_name_entry *) data;
719 return htab_hash_string (e->mangled);
722 /* Equality function for the demangled name hash. */
725 eq_demangled_name_entry (const void *a, const void *b)
727 const struct demangled_name_entry *da
728 = (const struct demangled_name_entry *) a;
729 const struct demangled_name_entry *db
730 = (const struct demangled_name_entry *) b;
732 return strcmp (da->mangled, db->mangled) == 0;
735 /* Create the hash table used for demangled names. Each hash entry is
736 a pair of strings; one for the mangled name and one for the demangled
737 name. The entry is hashed via just the mangled name. */
740 create_demangled_names_hash (struct objfile_per_bfd_storage *per_bfd)
742 /* Choose 256 as the starting size of the hash table, somewhat arbitrarily.
743 The hash table code will round this up to the next prime number.
744 Choosing a much larger table size wastes memory, and saves only about
745 1% in symbol reading. */
747 per_bfd->demangled_names_hash.reset (htab_create_alloc
748 (256, hash_demangled_name_entry, eq_demangled_name_entry,
749 NULL, xcalloc, xfree));
752 /* Try to determine the demangled name for a symbol, based on the
753 language of that symbol. If the language is set to language_auto,
754 it will attempt to find any demangling algorithm that works and
755 then set the language appropriately. The returned name is allocated
756 by the demangler and should be xfree'd. */
759 symbol_find_demangled_name (struct general_symbol_info *gsymbol,
762 char *demangled = NULL;
765 if (gsymbol->language == language_unknown)
766 gsymbol->language = language_auto;
768 if (gsymbol->language != language_auto)
770 const struct language_defn *lang = language_def (gsymbol->language);
772 language_sniff_from_mangled_name (lang, mangled, &demangled);
776 for (i = language_unknown; i < nr_languages; ++i)
778 enum language l = (enum language) i;
779 const struct language_defn *lang = language_def (l);
781 if (language_sniff_from_mangled_name (lang, mangled, &demangled))
783 gsymbol->language = l;
791 /* Set both the mangled and demangled (if any) names for GSYMBOL based
792 on LINKAGE_NAME and LEN. Ordinarily, NAME is copied onto the
793 objfile's obstack; but if COPY_NAME is 0 and if NAME is
794 NUL-terminated, then this function assumes that NAME is already
795 correctly saved (either permanently or with a lifetime tied to the
796 objfile), and it will not be copied.
798 The hash table corresponding to OBJFILE is used, and the memory
799 comes from the per-BFD storage_obstack. LINKAGE_NAME is copied,
800 so the pointer can be discarded after calling this function. */
803 symbol_set_names (struct general_symbol_info *gsymbol,
804 const char *linkage_name, int len, int copy_name,
805 struct objfile_per_bfd_storage *per_bfd)
807 struct demangled_name_entry **slot;
808 /* A 0-terminated copy of the linkage name. */
809 const char *linkage_name_copy;
810 struct demangled_name_entry entry;
812 if (gsymbol->language == language_ada)
814 /* In Ada, we do the symbol lookups using the mangled name, so
815 we can save some space by not storing the demangled name. */
817 gsymbol->name = linkage_name;
820 char *name = (char *) obstack_alloc (&per_bfd->storage_obstack,
823 memcpy (name, linkage_name, len);
825 gsymbol->name = name;
827 symbol_set_demangled_name (gsymbol, NULL, &per_bfd->storage_obstack);
832 if (per_bfd->demangled_names_hash == NULL)
833 create_demangled_names_hash (per_bfd);
835 if (linkage_name[len] != '\0')
839 alloc_name = (char *) alloca (len + 1);
840 memcpy (alloc_name, linkage_name, len);
841 alloc_name[len] = '\0';
843 linkage_name_copy = alloc_name;
846 linkage_name_copy = linkage_name;
848 /* Set the symbol language. */
849 char *demangled_name_ptr
850 = symbol_find_demangled_name (gsymbol, linkage_name_copy);
851 gdb::unique_xmalloc_ptr<char> demangled_name (demangled_name_ptr);
853 entry.mangled = linkage_name_copy;
854 slot = ((struct demangled_name_entry **)
855 htab_find_slot (per_bfd->demangled_names_hash.get (),
858 /* If this name is not in the hash table, add it. */
860 /* A C version of the symbol may have already snuck into the table.
861 This happens to, e.g., main.init (__go_init_main). Cope. */
862 || (gsymbol->language == language_go
863 && (*slot)->demangled[0] == '\0'))
865 int demangled_len = demangled_name ? strlen (demangled_name.get ()) : 0;
867 /* Suppose we have demangled_name==NULL, copy_name==0, and
868 linkage_name_copy==linkage_name. In this case, we already have the
869 mangled name saved, and we don't have a demangled name. So,
870 you might think we could save a little space by not recording
871 this in the hash table at all.
873 It turns out that it is actually important to still save such
874 an entry in the hash table, because storing this name gives
875 us better bcache hit rates for partial symbols. */
876 if (!copy_name && linkage_name_copy == linkage_name)
879 = ((struct demangled_name_entry *)
880 obstack_alloc (&per_bfd->storage_obstack,
881 offsetof (struct demangled_name_entry, demangled)
882 + demangled_len + 1));
883 (*slot)->mangled = linkage_name;
889 /* If we must copy the mangled name, put it directly after
890 the demangled name so we can have a single
893 = ((struct demangled_name_entry *)
894 obstack_alloc (&per_bfd->storage_obstack,
895 offsetof (struct demangled_name_entry, demangled)
896 + len + demangled_len + 2));
897 mangled_ptr = &((*slot)->demangled[demangled_len + 1]);
898 strcpy (mangled_ptr, linkage_name_copy);
899 (*slot)->mangled = mangled_ptr;
902 if (demangled_name != NULL)
903 strcpy ((*slot)->demangled, demangled_name.get());
905 (*slot)->demangled[0] = '\0';
908 gsymbol->name = (*slot)->mangled;
909 if ((*slot)->demangled[0] != '\0')
910 symbol_set_demangled_name (gsymbol, (*slot)->demangled,
911 &per_bfd->storage_obstack);
913 symbol_set_demangled_name (gsymbol, NULL, &per_bfd->storage_obstack);
916 /* Return the source code name of a symbol. In languages where
917 demangling is necessary, this is the demangled name. */
920 symbol_natural_name (const struct general_symbol_info *gsymbol)
922 switch (gsymbol->language)
928 case language_fortran:
929 if (symbol_get_demangled_name (gsymbol) != NULL)
930 return symbol_get_demangled_name (gsymbol);
933 return ada_decode_symbol (gsymbol);
937 return gsymbol->name;
940 /* Return the demangled name for a symbol based on the language for
941 that symbol. If no demangled name exists, return NULL. */
944 symbol_demangled_name (const struct general_symbol_info *gsymbol)
946 const char *dem_name = NULL;
948 switch (gsymbol->language)
954 case language_fortran:
955 dem_name = symbol_get_demangled_name (gsymbol);
958 dem_name = ada_decode_symbol (gsymbol);
966 /* Return the search name of a symbol---generally the demangled or
967 linkage name of the symbol, depending on how it will be searched for.
968 If there is no distinct demangled name, then returns the same value
969 (same pointer) as SYMBOL_LINKAGE_NAME. */
972 symbol_search_name (const struct general_symbol_info *gsymbol)
974 if (gsymbol->language == language_ada)
975 return gsymbol->name;
977 return symbol_natural_name (gsymbol);
983 symbol_matches_search_name (const struct general_symbol_info *gsymbol,
984 const lookup_name_info &name)
986 symbol_name_matcher_ftype *name_match
987 = get_symbol_name_matcher (language_def (gsymbol->language), name);
988 return name_match (symbol_search_name (gsymbol), name, NULL);
993 /* Return 1 if the two sections are the same, or if they could
994 plausibly be copies of each other, one in an original object
995 file and another in a separated debug file. */
998 matching_obj_sections (struct obj_section *obj_first,
999 struct obj_section *obj_second)
1001 asection *first = obj_first? obj_first->the_bfd_section : NULL;
1002 asection *second = obj_second? obj_second->the_bfd_section : NULL;
1004 /* If they're the same section, then they match. */
1005 if (first == second)
1008 /* If either is NULL, give up. */
1009 if (first == NULL || second == NULL)
1012 /* This doesn't apply to absolute symbols. */
1013 if (first->owner == NULL || second->owner == NULL)
1016 /* If they're in the same object file, they must be different sections. */
1017 if (first->owner == second->owner)
1020 /* Check whether the two sections are potentially corresponding. They must
1021 have the same size, address, and name. We can't compare section indexes,
1022 which would be more reliable, because some sections may have been
1024 if (bfd_get_section_size (first) != bfd_get_section_size (second))
1027 /* In-memory addresses may start at a different offset, relativize them. */
1028 if (bfd_get_section_vma (first->owner, first)
1029 - bfd_get_start_address (first->owner)
1030 != bfd_get_section_vma (second->owner, second)
1031 - bfd_get_start_address (second->owner))
1034 if (bfd_get_section_name (first->owner, first) == NULL
1035 || bfd_get_section_name (second->owner, second) == NULL
1036 || strcmp (bfd_get_section_name (first->owner, first),
1037 bfd_get_section_name (second->owner, second)) != 0)
1040 /* Otherwise check that they are in corresponding objfiles. */
1042 struct objfile *obj = NULL;
1043 for (objfile *objfile : current_program_space->objfiles ())
1044 if (objfile->obfd == first->owner)
1049 gdb_assert (obj != NULL);
1051 if (obj->separate_debug_objfile != NULL
1052 && obj->separate_debug_objfile->obfd == second->owner)
1054 if (obj->separate_debug_objfile_backlink != NULL
1055 && obj->separate_debug_objfile_backlink->obfd == second->owner)
1064 expand_symtab_containing_pc (CORE_ADDR pc, struct obj_section *section)
1066 struct bound_minimal_symbol msymbol;
1068 /* If we know that this is not a text address, return failure. This is
1069 necessary because we loop based on texthigh and textlow, which do
1070 not include the data ranges. */
1071 msymbol = lookup_minimal_symbol_by_pc_section (pc, section);
1072 if (msymbol.minsym && msymbol.minsym->data_p ())
1075 for (objfile *objfile : current_program_space->objfiles ())
1077 struct compunit_symtab *cust = NULL;
1080 cust = objfile->sf->qf->find_pc_sect_compunit_symtab (objfile, msymbol,
1087 /* Hash function for the symbol cache. */
1090 hash_symbol_entry (const struct objfile *objfile_context,
1091 const char *name, domain_enum domain)
1093 unsigned int hash = (uintptr_t) objfile_context;
1096 hash += htab_hash_string (name);
1098 /* Because of symbol_matches_domain we need VAR_DOMAIN and STRUCT_DOMAIN
1099 to map to the same slot. */
1100 if (domain == STRUCT_DOMAIN)
1101 hash += VAR_DOMAIN * 7;
1108 /* Equality function for the symbol cache. */
1111 eq_symbol_entry (const struct symbol_cache_slot *slot,
1112 const struct objfile *objfile_context,
1113 const char *name, domain_enum domain)
1115 const char *slot_name;
1116 domain_enum slot_domain;
1118 if (slot->state == SYMBOL_SLOT_UNUSED)
1121 if (slot->objfile_context != objfile_context)
1124 if (slot->state == SYMBOL_SLOT_NOT_FOUND)
1126 slot_name = slot->value.not_found.name;
1127 slot_domain = slot->value.not_found.domain;
1131 slot_name = SYMBOL_SEARCH_NAME (slot->value.found.symbol);
1132 slot_domain = SYMBOL_DOMAIN (slot->value.found.symbol);
1135 /* NULL names match. */
1136 if (slot_name == NULL && name == NULL)
1138 /* But there's no point in calling symbol_matches_domain in the
1139 SYMBOL_SLOT_FOUND case. */
1140 if (slot_domain != domain)
1143 else if (slot_name != NULL && name != NULL)
1145 /* It's important that we use the same comparison that was done
1146 the first time through. If the slot records a found symbol,
1147 then this means using the symbol name comparison function of
1148 the symbol's language with SYMBOL_SEARCH_NAME. See
1149 dictionary.c. It also means using symbol_matches_domain for
1150 found symbols. See block.c.
1152 If the slot records a not-found symbol, then require a precise match.
1153 We could still be lax with whitespace like strcmp_iw though. */
1155 if (slot->state == SYMBOL_SLOT_NOT_FOUND)
1157 if (strcmp (slot_name, name) != 0)
1159 if (slot_domain != domain)
1164 struct symbol *sym = slot->value.found.symbol;
1165 lookup_name_info lookup_name (name, symbol_name_match_type::FULL);
1167 if (!SYMBOL_MATCHES_SEARCH_NAME (sym, lookup_name))
1170 if (!symbol_matches_domain (SYMBOL_LANGUAGE (sym),
1171 slot_domain, domain))
1177 /* Only one name is NULL. */
1184 /* Given a cache of size SIZE, return the size of the struct (with variable
1185 length array) in bytes. */
1188 symbol_cache_byte_size (unsigned int size)
1190 return (sizeof (struct block_symbol_cache)
1191 + ((size - 1) * sizeof (struct symbol_cache_slot)));
1197 resize_symbol_cache (struct symbol_cache *cache, unsigned int new_size)
1199 /* If there's no change in size, don't do anything.
1200 All caches have the same size, so we can just compare with the size
1201 of the global symbols cache. */
1202 if ((cache->global_symbols != NULL
1203 && cache->global_symbols->size == new_size)
1204 || (cache->global_symbols == NULL
1208 xfree (cache->global_symbols);
1209 xfree (cache->static_symbols);
1213 cache->global_symbols = NULL;
1214 cache->static_symbols = NULL;
1218 size_t total_size = symbol_cache_byte_size (new_size);
1220 cache->global_symbols
1221 = (struct block_symbol_cache *) xcalloc (1, total_size);
1222 cache->static_symbols
1223 = (struct block_symbol_cache *) xcalloc (1, total_size);
1224 cache->global_symbols->size = new_size;
1225 cache->static_symbols->size = new_size;
1229 /* Make a symbol cache of size SIZE. */
1231 static struct symbol_cache *
1232 make_symbol_cache (unsigned int size)
1234 struct symbol_cache *cache;
1236 cache = XCNEW (struct symbol_cache);
1237 resize_symbol_cache (cache, symbol_cache_size);
1241 /* Free the space used by CACHE. */
1244 free_symbol_cache (struct symbol_cache *cache)
1246 xfree (cache->global_symbols);
1247 xfree (cache->static_symbols);
1251 /* Return the symbol cache of PSPACE.
1252 Create one if it doesn't exist yet. */
1254 static struct symbol_cache *
1255 get_symbol_cache (struct program_space *pspace)
1257 struct symbol_cache *cache
1258 = (struct symbol_cache *) program_space_data (pspace, symbol_cache_key);
1262 cache = make_symbol_cache (symbol_cache_size);
1263 set_program_space_data (pspace, symbol_cache_key, cache);
1269 /* Delete the symbol cache of PSPACE.
1270 Called when PSPACE is destroyed. */
1273 symbol_cache_cleanup (struct program_space *pspace, void *data)
1275 struct symbol_cache *cache = (struct symbol_cache *) data;
1277 free_symbol_cache (cache);
1280 /* Set the size of the symbol cache in all program spaces. */
1283 set_symbol_cache_size (unsigned int new_size)
1285 struct program_space *pspace;
1287 ALL_PSPACES (pspace)
1289 struct symbol_cache *cache
1290 = (struct symbol_cache *) program_space_data (pspace, symbol_cache_key);
1292 /* The pspace could have been created but not have a cache yet. */
1294 resize_symbol_cache (cache, new_size);
1298 /* Called when symbol-cache-size is set. */
1301 set_symbol_cache_size_handler (const char *args, int from_tty,
1302 struct cmd_list_element *c)
1304 if (new_symbol_cache_size > MAX_SYMBOL_CACHE_SIZE)
1306 /* Restore the previous value.
1307 This is the value the "show" command prints. */
1308 new_symbol_cache_size = symbol_cache_size;
1310 error (_("Symbol cache size is too large, max is %u."),
1311 MAX_SYMBOL_CACHE_SIZE);
1313 symbol_cache_size = new_symbol_cache_size;
1315 set_symbol_cache_size (symbol_cache_size);
1318 /* Lookup symbol NAME,DOMAIN in BLOCK in the symbol cache of PSPACE.
1319 OBJFILE_CONTEXT is the current objfile, which may be NULL.
1320 The result is the symbol if found, SYMBOL_LOOKUP_FAILED if a previous lookup
1321 failed (and thus this one will too), or NULL if the symbol is not present
1323 If the symbol is not present in the cache, then *BSC_PTR and *SLOT_PTR are
1324 set to the cache and slot of the symbol to save the result of a full lookup
1327 static struct block_symbol
1328 symbol_cache_lookup (struct symbol_cache *cache,
1329 struct objfile *objfile_context, int block,
1330 const char *name, domain_enum domain,
1331 struct block_symbol_cache **bsc_ptr,
1332 struct symbol_cache_slot **slot_ptr)
1334 struct block_symbol_cache *bsc;
1336 struct symbol_cache_slot *slot;
1338 if (block == GLOBAL_BLOCK)
1339 bsc = cache->global_symbols;
1341 bsc = cache->static_symbols;
1349 hash = hash_symbol_entry (objfile_context, name, domain);
1350 slot = bsc->symbols + hash % bsc->size;
1352 if (eq_symbol_entry (slot, objfile_context, name, domain))
1354 if (symbol_lookup_debug)
1355 fprintf_unfiltered (gdb_stdlog,
1356 "%s block symbol cache hit%s for %s, %s\n",
1357 block == GLOBAL_BLOCK ? "Global" : "Static",
1358 slot->state == SYMBOL_SLOT_NOT_FOUND
1359 ? " (not found)" : "",
1360 name, domain_name (domain));
1362 if (slot->state == SYMBOL_SLOT_NOT_FOUND)
1363 return SYMBOL_LOOKUP_FAILED;
1364 return slot->value.found;
1367 /* Symbol is not present in the cache. */
1372 if (symbol_lookup_debug)
1374 fprintf_unfiltered (gdb_stdlog,
1375 "%s block symbol cache miss for %s, %s\n",
1376 block == GLOBAL_BLOCK ? "Global" : "Static",
1377 name, domain_name (domain));
1383 /* Clear out SLOT. */
1386 symbol_cache_clear_slot (struct symbol_cache_slot *slot)
1388 if (slot->state == SYMBOL_SLOT_NOT_FOUND)
1389 xfree (slot->value.not_found.name);
1390 slot->state = SYMBOL_SLOT_UNUSED;
1393 /* Mark SYMBOL as found in SLOT.
1394 OBJFILE_CONTEXT is the current objfile when the lookup was done, or NULL
1395 if it's not needed to distinguish lookups (STATIC_BLOCK). It is *not*
1396 necessarily the objfile the symbol was found in. */
1399 symbol_cache_mark_found (struct block_symbol_cache *bsc,
1400 struct symbol_cache_slot *slot,
1401 struct objfile *objfile_context,
1402 struct symbol *symbol,
1403 const struct block *block)
1407 if (slot->state != SYMBOL_SLOT_UNUSED)
1410 symbol_cache_clear_slot (slot);
1412 slot->state = SYMBOL_SLOT_FOUND;
1413 slot->objfile_context = objfile_context;
1414 slot->value.found.symbol = symbol;
1415 slot->value.found.block = block;
1418 /* Mark symbol NAME, DOMAIN as not found in SLOT.
1419 OBJFILE_CONTEXT is the current objfile when the lookup was done, or NULL
1420 if it's not needed to distinguish lookups (STATIC_BLOCK). */
1423 symbol_cache_mark_not_found (struct block_symbol_cache *bsc,
1424 struct symbol_cache_slot *slot,
1425 struct objfile *objfile_context,
1426 const char *name, domain_enum domain)
1430 if (slot->state != SYMBOL_SLOT_UNUSED)
1433 symbol_cache_clear_slot (slot);
1435 slot->state = SYMBOL_SLOT_NOT_FOUND;
1436 slot->objfile_context = objfile_context;
1437 slot->value.not_found.name = xstrdup (name);
1438 slot->value.not_found.domain = domain;
1441 /* Flush the symbol cache of PSPACE. */
1444 symbol_cache_flush (struct program_space *pspace)
1446 struct symbol_cache *cache
1447 = (struct symbol_cache *) program_space_data (pspace, symbol_cache_key);
1452 if (cache->global_symbols == NULL)
1454 gdb_assert (symbol_cache_size == 0);
1455 gdb_assert (cache->static_symbols == NULL);
1459 /* If the cache is untouched since the last flush, early exit.
1460 This is important for performance during the startup of a program linked
1461 with 100s (or 1000s) of shared libraries. */
1462 if (cache->global_symbols->misses == 0
1463 && cache->static_symbols->misses == 0)
1466 gdb_assert (cache->global_symbols->size == symbol_cache_size);
1467 gdb_assert (cache->static_symbols->size == symbol_cache_size);
1469 for (pass = 0; pass < 2; ++pass)
1471 struct block_symbol_cache *bsc
1472 = pass == 0 ? cache->global_symbols : cache->static_symbols;
1475 for (i = 0; i < bsc->size; ++i)
1476 symbol_cache_clear_slot (&bsc->symbols[i]);
1479 cache->global_symbols->hits = 0;
1480 cache->global_symbols->misses = 0;
1481 cache->global_symbols->collisions = 0;
1482 cache->static_symbols->hits = 0;
1483 cache->static_symbols->misses = 0;
1484 cache->static_symbols->collisions = 0;
1490 symbol_cache_dump (const struct symbol_cache *cache)
1494 if (cache->global_symbols == NULL)
1496 printf_filtered (" <disabled>\n");
1500 for (pass = 0; pass < 2; ++pass)
1502 const struct block_symbol_cache *bsc
1503 = pass == 0 ? cache->global_symbols : cache->static_symbols;
1507 printf_filtered ("Global symbols:\n");
1509 printf_filtered ("Static symbols:\n");
1511 for (i = 0; i < bsc->size; ++i)
1513 const struct symbol_cache_slot *slot = &bsc->symbols[i];
1517 switch (slot->state)
1519 case SYMBOL_SLOT_UNUSED:
1521 case SYMBOL_SLOT_NOT_FOUND:
1522 printf_filtered (" [%4u] = %s, %s %s (not found)\n", i,
1523 host_address_to_string (slot->objfile_context),
1524 slot->value.not_found.name,
1525 domain_name (slot->value.not_found.domain));
1527 case SYMBOL_SLOT_FOUND:
1529 struct symbol *found = slot->value.found.symbol;
1530 const struct objfile *context = slot->objfile_context;
1532 printf_filtered (" [%4u] = %s, %s %s\n", i,
1533 host_address_to_string (context),
1534 SYMBOL_PRINT_NAME (found),
1535 domain_name (SYMBOL_DOMAIN (found)));
1543 /* The "mt print symbol-cache" command. */
1546 maintenance_print_symbol_cache (const char *args, int from_tty)
1548 struct program_space *pspace;
1550 ALL_PSPACES (pspace)
1552 struct symbol_cache *cache;
1554 printf_filtered (_("Symbol cache for pspace %d\n%s:\n"),
1556 pspace->symfile_object_file != NULL
1557 ? objfile_name (pspace->symfile_object_file)
1558 : "(no object file)");
1560 /* If the cache hasn't been created yet, avoid creating one. */
1562 = (struct symbol_cache *) program_space_data (pspace, symbol_cache_key);
1564 printf_filtered (" <empty>\n");
1566 symbol_cache_dump (cache);
1570 /* The "mt flush-symbol-cache" command. */
1573 maintenance_flush_symbol_cache (const char *args, int from_tty)
1575 struct program_space *pspace;
1577 ALL_PSPACES (pspace)
1579 symbol_cache_flush (pspace);
1583 /* Print usage statistics of CACHE. */
1586 symbol_cache_stats (struct symbol_cache *cache)
1590 if (cache->global_symbols == NULL)
1592 printf_filtered (" <disabled>\n");
1596 for (pass = 0; pass < 2; ++pass)
1598 const struct block_symbol_cache *bsc
1599 = pass == 0 ? cache->global_symbols : cache->static_symbols;
1604 printf_filtered ("Global block cache stats:\n");
1606 printf_filtered ("Static block cache stats:\n");
1608 printf_filtered (" size: %u\n", bsc->size);
1609 printf_filtered (" hits: %u\n", bsc->hits);
1610 printf_filtered (" misses: %u\n", bsc->misses);
1611 printf_filtered (" collisions: %u\n", bsc->collisions);
1615 /* The "mt print symbol-cache-statistics" command. */
1618 maintenance_print_symbol_cache_statistics (const char *args, int from_tty)
1620 struct program_space *pspace;
1622 ALL_PSPACES (pspace)
1624 struct symbol_cache *cache;
1626 printf_filtered (_("Symbol cache statistics for pspace %d\n%s:\n"),
1628 pspace->symfile_object_file != NULL
1629 ? objfile_name (pspace->symfile_object_file)
1630 : "(no object file)");
1632 /* If the cache hasn't been created yet, avoid creating one. */
1634 = (struct symbol_cache *) program_space_data (pspace, symbol_cache_key);
1636 printf_filtered (" empty, no stats available\n");
1638 symbol_cache_stats (cache);
1642 /* This module's 'new_objfile' observer. */
1645 symtab_new_objfile_observer (struct objfile *objfile)
1647 /* Ideally we'd use OBJFILE->pspace, but OBJFILE may be NULL. */
1648 symbol_cache_flush (current_program_space);
1651 /* This module's 'free_objfile' observer. */
1654 symtab_free_objfile_observer (struct objfile *objfile)
1656 symbol_cache_flush (objfile->pspace);
1659 /* Debug symbols usually don't have section information. We need to dig that
1660 out of the minimal symbols and stash that in the debug symbol. */
1663 fixup_section (struct general_symbol_info *ginfo,
1664 CORE_ADDR addr, struct objfile *objfile)
1666 struct minimal_symbol *msym;
1668 /* First, check whether a minimal symbol with the same name exists
1669 and points to the same address. The address check is required
1670 e.g. on PowerPC64, where the minimal symbol for a function will
1671 point to the function descriptor, while the debug symbol will
1672 point to the actual function code. */
1673 msym = lookup_minimal_symbol_by_pc_name (addr, ginfo->name, objfile);
1675 ginfo->section = MSYMBOL_SECTION (msym);
1678 /* Static, function-local variables do appear in the linker
1679 (minimal) symbols, but are frequently given names that won't
1680 be found via lookup_minimal_symbol(). E.g., it has been
1681 observed in frv-uclinux (ELF) executables that a static,
1682 function-local variable named "foo" might appear in the
1683 linker symbols as "foo.6" or "foo.3". Thus, there is no
1684 point in attempting to extend the lookup-by-name mechanism to
1685 handle this case due to the fact that there can be multiple
1688 So, instead, search the section table when lookup by name has
1689 failed. The ``addr'' and ``endaddr'' fields may have already
1690 been relocated. If so, the relocation offset (i.e. the
1691 ANOFFSET value) needs to be subtracted from these values when
1692 performing the comparison. We unconditionally subtract it,
1693 because, when no relocation has been performed, the ANOFFSET
1694 value will simply be zero.
1696 The address of the symbol whose section we're fixing up HAS
1697 NOT BEEN adjusted (relocated) yet. It can't have been since
1698 the section isn't yet known and knowing the section is
1699 necessary in order to add the correct relocation value. In
1700 other words, we wouldn't even be in this function (attempting
1701 to compute the section) if it were already known.
1703 Note that it is possible to search the minimal symbols
1704 (subtracting the relocation value if necessary) to find the
1705 matching minimal symbol, but this is overkill and much less
1706 efficient. It is not necessary to find the matching minimal
1707 symbol, only its section.
1709 Note that this technique (of doing a section table search)
1710 can fail when unrelocated section addresses overlap. For
1711 this reason, we still attempt a lookup by name prior to doing
1712 a search of the section table. */
1714 struct obj_section *s;
1717 ALL_OBJFILE_OSECTIONS (objfile, s)
1719 int idx = s - objfile->sections;
1720 CORE_ADDR offset = ANOFFSET (objfile->section_offsets, idx);
1725 if (obj_section_addr (s) - offset <= addr
1726 && addr < obj_section_endaddr (s) - offset)
1728 ginfo->section = idx;
1733 /* If we didn't find the section, assume it is in the first
1734 section. If there is no allocated section, then it hardly
1735 matters what we pick, so just pick zero. */
1739 ginfo->section = fallback;
1744 fixup_symbol_section (struct symbol *sym, struct objfile *objfile)
1751 if (!SYMBOL_OBJFILE_OWNED (sym))
1754 /* We either have an OBJFILE, or we can get at it from the sym's
1755 symtab. Anything else is a bug. */
1756 gdb_assert (objfile || symbol_symtab (sym));
1758 if (objfile == NULL)
1759 objfile = symbol_objfile (sym);
1761 if (SYMBOL_OBJ_SECTION (objfile, sym))
1764 /* We should have an objfile by now. */
1765 gdb_assert (objfile);
1767 switch (SYMBOL_CLASS (sym))
1771 addr = SYMBOL_VALUE_ADDRESS (sym);
1774 addr = BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym));
1778 /* Nothing else will be listed in the minsyms -- no use looking
1783 fixup_section (&sym->ginfo, addr, objfile);
1790 demangle_for_lookup_info::demangle_for_lookup_info
1791 (const lookup_name_info &lookup_name, language lang)
1793 demangle_result_storage storage;
1795 if (lookup_name.ignore_parameters () && lang == language_cplus)
1797 gdb::unique_xmalloc_ptr<char> without_params
1798 = cp_remove_params_if_any (lookup_name.name ().c_str (),
1799 lookup_name.completion_mode ());
1801 if (without_params != NULL)
1803 if (lookup_name.match_type () != symbol_name_match_type::SEARCH_NAME)
1804 m_demangled_name = demangle_for_lookup (without_params.get (),
1810 if (lookup_name.match_type () == symbol_name_match_type::SEARCH_NAME)
1811 m_demangled_name = lookup_name.name ();
1813 m_demangled_name = demangle_for_lookup (lookup_name.name ().c_str (),
1819 const lookup_name_info &
1820 lookup_name_info::match_any ()
1822 /* Lookup any symbol that "" would complete. I.e., this matches all
1824 static const lookup_name_info lookup_name ({}, symbol_name_match_type::FULL,
1830 /* Compute the demangled form of NAME as used by the various symbol
1831 lookup functions. The result can either be the input NAME
1832 directly, or a pointer to a buffer owned by the STORAGE object.
1834 For Ada, this function just returns NAME, unmodified.
1835 Normally, Ada symbol lookups are performed using the encoded name
1836 rather than the demangled name, and so it might seem to make sense
1837 for this function to return an encoded version of NAME.
1838 Unfortunately, we cannot do this, because this function is used in
1839 circumstances where it is not appropriate to try to encode NAME.
1840 For instance, when displaying the frame info, we demangle the name
1841 of each parameter, and then perform a symbol lookup inside our
1842 function using that demangled name. In Ada, certain functions
1843 have internally-generated parameters whose name contain uppercase
1844 characters. Encoding those name would result in those uppercase
1845 characters to become lowercase, and thus cause the symbol lookup
1849 demangle_for_lookup (const char *name, enum language lang,
1850 demangle_result_storage &storage)
1852 /* If we are using C++, D, or Go, demangle the name before doing a
1853 lookup, so we can always binary search. */
1854 if (lang == language_cplus)
1856 char *demangled_name = gdb_demangle (name, DMGL_ANSI | DMGL_PARAMS);
1857 if (demangled_name != NULL)
1858 return storage.set_malloc_ptr (demangled_name);
1860 /* If we were given a non-mangled name, canonicalize it
1861 according to the language (so far only for C++). */
1862 std::string canon = cp_canonicalize_string (name);
1863 if (!canon.empty ())
1864 return storage.swap_string (canon);
1866 else if (lang == language_d)
1868 char *demangled_name = d_demangle (name, 0);
1869 if (demangled_name != NULL)
1870 return storage.set_malloc_ptr (demangled_name);
1872 else if (lang == language_go)
1874 char *demangled_name = go_demangle (name, 0);
1875 if (demangled_name != NULL)
1876 return storage.set_malloc_ptr (demangled_name);
1885 search_name_hash (enum language language, const char *search_name)
1887 return language_def (language)->la_search_name_hash (search_name);
1892 This function (or rather its subordinates) have a bunch of loops and
1893 it would seem to be attractive to put in some QUIT's (though I'm not really
1894 sure whether it can run long enough to be really important). But there
1895 are a few calls for which it would appear to be bad news to quit
1896 out of here: e.g., find_proc_desc in alpha-mdebug-tdep.c. (Note
1897 that there is C++ code below which can error(), but that probably
1898 doesn't affect these calls since they are looking for a known
1899 variable and thus can probably assume it will never hit the C++
1903 lookup_symbol_in_language (const char *name, const struct block *block,
1904 const domain_enum domain, enum language lang,
1905 struct field_of_this_result *is_a_field_of_this)
1907 demangle_result_storage storage;
1908 const char *modified_name = demangle_for_lookup (name, lang, storage);
1910 return lookup_symbol_aux (modified_name,
1911 symbol_name_match_type::FULL,
1912 block, domain, lang,
1913 is_a_field_of_this);
1919 lookup_symbol (const char *name, const struct block *block,
1921 struct field_of_this_result *is_a_field_of_this)
1923 return lookup_symbol_in_language (name, block, domain,
1924 current_language->la_language,
1925 is_a_field_of_this);
1931 lookup_symbol_search_name (const char *search_name, const struct block *block,
1934 return lookup_symbol_aux (search_name, symbol_name_match_type::SEARCH_NAME,
1935 block, domain, language_asm, NULL);
1941 lookup_language_this (const struct language_defn *lang,
1942 const struct block *block)
1944 if (lang->la_name_of_this == NULL || block == NULL)
1947 if (symbol_lookup_debug > 1)
1949 struct objfile *objfile = lookup_objfile_from_block (block);
1951 fprintf_unfiltered (gdb_stdlog,
1952 "lookup_language_this (%s, %s (objfile %s))",
1953 lang->la_name, host_address_to_string (block),
1954 objfile_debug_name (objfile));
1961 sym = block_lookup_symbol (block, lang->la_name_of_this,
1962 symbol_name_match_type::SEARCH_NAME,
1966 if (symbol_lookup_debug > 1)
1968 fprintf_unfiltered (gdb_stdlog, " = %s (%s, block %s)\n",
1969 SYMBOL_PRINT_NAME (sym),
1970 host_address_to_string (sym),
1971 host_address_to_string (block));
1973 return (struct block_symbol) {sym, block};
1975 if (BLOCK_FUNCTION (block))
1977 block = BLOCK_SUPERBLOCK (block);
1980 if (symbol_lookup_debug > 1)
1981 fprintf_unfiltered (gdb_stdlog, " = NULL\n");
1985 /* Given TYPE, a structure/union,
1986 return 1 if the component named NAME from the ultimate target
1987 structure/union is defined, otherwise, return 0. */
1990 check_field (struct type *type, const char *name,
1991 struct field_of_this_result *is_a_field_of_this)
1995 /* The type may be a stub. */
1996 type = check_typedef (type);
1998 for (i = TYPE_NFIELDS (type) - 1; i >= TYPE_N_BASECLASSES (type); i--)
2000 const char *t_field_name = TYPE_FIELD_NAME (type, i);
2002 if (t_field_name && (strcmp_iw (t_field_name, name) == 0))
2004 is_a_field_of_this->type = type;
2005 is_a_field_of_this->field = &TYPE_FIELD (type, i);
2010 /* C++: If it was not found as a data field, then try to return it
2011 as a pointer to a method. */
2013 for (i = TYPE_NFN_FIELDS (type) - 1; i >= 0; --i)
2015 if (strcmp_iw (TYPE_FN_FIELDLIST_NAME (type, i), name) == 0)
2017 is_a_field_of_this->type = type;
2018 is_a_field_of_this->fn_field = &TYPE_FN_FIELDLIST (type, i);
2023 for (i = TYPE_N_BASECLASSES (type) - 1; i >= 0; i--)
2024 if (check_field (TYPE_BASECLASS (type, i), name, is_a_field_of_this))
2030 /* Behave like lookup_symbol except that NAME is the natural name
2031 (e.g., demangled name) of the symbol that we're looking for. */
2033 static struct block_symbol
2034 lookup_symbol_aux (const char *name, symbol_name_match_type match_type,
2035 const struct block *block,
2036 const domain_enum domain, enum language language,
2037 struct field_of_this_result *is_a_field_of_this)
2039 struct block_symbol result;
2040 const struct language_defn *langdef;
2042 if (symbol_lookup_debug)
2044 struct objfile *objfile = lookup_objfile_from_block (block);
2046 fprintf_unfiltered (gdb_stdlog,
2047 "lookup_symbol_aux (%s, %s (objfile %s), %s, %s)\n",
2048 name, host_address_to_string (block),
2050 ? objfile_debug_name (objfile) : "NULL",
2051 domain_name (domain), language_str (language));
2054 /* Make sure we do something sensible with is_a_field_of_this, since
2055 the callers that set this parameter to some non-null value will
2056 certainly use it later. If we don't set it, the contents of
2057 is_a_field_of_this are undefined. */
2058 if (is_a_field_of_this != NULL)
2059 memset (is_a_field_of_this, 0, sizeof (*is_a_field_of_this));
2061 /* Search specified block and its superiors. Don't search
2062 STATIC_BLOCK or GLOBAL_BLOCK. */
2064 result = lookup_local_symbol (name, match_type, block, domain, language);
2065 if (result.symbol != NULL)
2067 if (symbol_lookup_debug)
2069 fprintf_unfiltered (gdb_stdlog, "lookup_symbol_aux (...) = %s\n",
2070 host_address_to_string (result.symbol));
2075 /* If requested to do so by the caller and if appropriate for LANGUAGE,
2076 check to see if NAME is a field of `this'. */
2078 langdef = language_def (language);
2080 /* Don't do this check if we are searching for a struct. It will
2081 not be found by check_field, but will be found by other
2083 if (is_a_field_of_this != NULL && domain != STRUCT_DOMAIN)
2085 result = lookup_language_this (langdef, block);
2089 struct type *t = result.symbol->type;
2091 /* I'm not really sure that type of this can ever
2092 be typedefed; just be safe. */
2093 t = check_typedef (t);
2094 if (TYPE_CODE (t) == TYPE_CODE_PTR || TYPE_IS_REFERENCE (t))
2095 t = TYPE_TARGET_TYPE (t);
2097 if (TYPE_CODE (t) != TYPE_CODE_STRUCT
2098 && TYPE_CODE (t) != TYPE_CODE_UNION)
2099 error (_("Internal error: `%s' is not an aggregate"),
2100 langdef->la_name_of_this);
2102 if (check_field (t, name, is_a_field_of_this))
2104 if (symbol_lookup_debug)
2106 fprintf_unfiltered (gdb_stdlog,
2107 "lookup_symbol_aux (...) = NULL\n");
2114 /* Now do whatever is appropriate for LANGUAGE to look
2115 up static and global variables. */
2117 result = langdef->la_lookup_symbol_nonlocal (langdef, name, block, domain);
2118 if (result.symbol != NULL)
2120 if (symbol_lookup_debug)
2122 fprintf_unfiltered (gdb_stdlog, "lookup_symbol_aux (...) = %s\n",
2123 host_address_to_string (result.symbol));
2128 /* Now search all static file-level symbols. Not strictly correct,
2129 but more useful than an error. */
2131 result = lookup_static_symbol (name, domain);
2132 if (symbol_lookup_debug)
2134 fprintf_unfiltered (gdb_stdlog, "lookup_symbol_aux (...) = %s\n",
2135 result.symbol != NULL
2136 ? host_address_to_string (result.symbol)
2142 /* Check to see if the symbol is defined in BLOCK or its superiors.
2143 Don't search STATIC_BLOCK or GLOBAL_BLOCK. */
2145 static struct block_symbol
2146 lookup_local_symbol (const char *name,
2147 symbol_name_match_type match_type,
2148 const struct block *block,
2149 const domain_enum domain,
2150 enum language language)
2153 const struct block *static_block = block_static_block (block);
2154 const char *scope = block_scope (block);
2156 /* Check if either no block is specified or it's a global block. */
2158 if (static_block == NULL)
2161 while (block != static_block)
2163 sym = lookup_symbol_in_block (name, match_type, block, domain);
2165 return (struct block_symbol) {sym, block};
2167 if (language == language_cplus || language == language_fortran)
2169 struct block_symbol blocksym
2170 = cp_lookup_symbol_imports_or_template (scope, name, block,
2173 if (blocksym.symbol != NULL)
2177 if (BLOCK_FUNCTION (block) != NULL && block_inlined_p (block))
2179 block = BLOCK_SUPERBLOCK (block);
2182 /* We've reached the end of the function without finding a result. */
2190 lookup_objfile_from_block (const struct block *block)
2195 block = block_global_block (block);
2196 /* Look through all blockvectors. */
2197 for (objfile *obj : current_program_space->objfiles ())
2199 for (compunit_symtab *cust : obj->compunits ())
2200 if (block == BLOCKVECTOR_BLOCK (COMPUNIT_BLOCKVECTOR (cust),
2203 if (obj->separate_debug_objfile_backlink)
2204 obj = obj->separate_debug_objfile_backlink;
2216 lookup_symbol_in_block (const char *name, symbol_name_match_type match_type,
2217 const struct block *block,
2218 const domain_enum domain)
2222 if (symbol_lookup_debug > 1)
2224 struct objfile *objfile = lookup_objfile_from_block (block);
2226 fprintf_unfiltered (gdb_stdlog,
2227 "lookup_symbol_in_block (%s, %s (objfile %s), %s)",
2228 name, host_address_to_string (block),
2229 objfile_debug_name (objfile),
2230 domain_name (domain));
2233 sym = block_lookup_symbol (block, name, match_type, domain);
2236 if (symbol_lookup_debug > 1)
2238 fprintf_unfiltered (gdb_stdlog, " = %s\n",
2239 host_address_to_string (sym));
2241 return fixup_symbol_section (sym, NULL);
2244 if (symbol_lookup_debug > 1)
2245 fprintf_unfiltered (gdb_stdlog, " = NULL\n");
2252 lookup_global_symbol_from_objfile (struct objfile *main_objfile,
2254 const domain_enum domain)
2256 for (objfile *objfile : main_objfile->separate_debug_objfiles ())
2258 struct block_symbol result
2259 = lookup_symbol_in_objfile (objfile, GLOBAL_BLOCK, name, domain);
2261 if (result.symbol != NULL)
2268 /* Check to see if the symbol is defined in one of the OBJFILE's
2269 symtabs. BLOCK_INDEX should be either GLOBAL_BLOCK or STATIC_BLOCK,
2270 depending on whether or not we want to search global symbols or
2273 static struct block_symbol
2274 lookup_symbol_in_objfile_symtabs (struct objfile *objfile, int block_index,
2275 const char *name, const domain_enum domain)
2277 gdb_assert (block_index == GLOBAL_BLOCK || block_index == STATIC_BLOCK);
2279 if (symbol_lookup_debug > 1)
2281 fprintf_unfiltered (gdb_stdlog,
2282 "lookup_symbol_in_objfile_symtabs (%s, %s, %s, %s)",
2283 objfile_debug_name (objfile),
2284 block_index == GLOBAL_BLOCK
2285 ? "GLOBAL_BLOCK" : "STATIC_BLOCK",
2286 name, domain_name (domain));
2289 for (compunit_symtab *cust : objfile->compunits ())
2291 const struct blockvector *bv;
2292 const struct block *block;
2293 struct block_symbol result;
2295 bv = COMPUNIT_BLOCKVECTOR (cust);
2296 block = BLOCKVECTOR_BLOCK (bv, block_index);
2297 result.symbol = block_lookup_symbol_primary (block, name, domain);
2298 result.block = block;
2299 if (result.symbol != NULL)
2301 if (symbol_lookup_debug > 1)
2303 fprintf_unfiltered (gdb_stdlog, " = %s (block %s)\n",
2304 host_address_to_string (result.symbol),
2305 host_address_to_string (block));
2307 result.symbol = fixup_symbol_section (result.symbol, objfile);
2313 if (symbol_lookup_debug > 1)
2314 fprintf_unfiltered (gdb_stdlog, " = NULL\n");
2318 /* Wrapper around lookup_symbol_in_objfile_symtabs for search_symbols.
2319 Look up LINKAGE_NAME in DOMAIN in the global and static blocks of OBJFILE
2320 and all associated separate debug objfiles.
2322 Normally we only look in OBJFILE, and not any separate debug objfiles
2323 because the outer loop will cause them to be searched too. This case is
2324 different. Here we're called from search_symbols where it will only
2325 call us for the objfile that contains a matching minsym. */
2327 static struct block_symbol
2328 lookup_symbol_in_objfile_from_linkage_name (struct objfile *objfile,
2329 const char *linkage_name,
2332 enum language lang = current_language->la_language;
2333 struct objfile *main_objfile;
2335 demangle_result_storage storage;
2336 const char *modified_name = demangle_for_lookup (linkage_name, lang, storage);
2338 if (objfile->separate_debug_objfile_backlink)
2339 main_objfile = objfile->separate_debug_objfile_backlink;
2341 main_objfile = objfile;
2343 for (::objfile *cur_objfile : main_objfile->separate_debug_objfiles ())
2345 struct block_symbol result;
2347 result = lookup_symbol_in_objfile_symtabs (cur_objfile, GLOBAL_BLOCK,
2348 modified_name, domain);
2349 if (result.symbol == NULL)
2350 result = lookup_symbol_in_objfile_symtabs (cur_objfile, STATIC_BLOCK,
2351 modified_name, domain);
2352 if (result.symbol != NULL)
2359 /* A helper function that throws an exception when a symbol was found
2360 in a psymtab but not in a symtab. */
2362 static void ATTRIBUTE_NORETURN
2363 error_in_psymtab_expansion (int block_index, const char *name,
2364 struct compunit_symtab *cust)
2367 Internal: %s symbol `%s' found in %s psymtab but not in symtab.\n\
2368 %s may be an inlined function, or may be a template function\n \
2369 (if a template, try specifying an instantiation: %s<type>)."),
2370 block_index == GLOBAL_BLOCK ? "global" : "static",
2372 symtab_to_filename_for_display (compunit_primary_filetab (cust)),
2376 /* A helper function for various lookup routines that interfaces with
2377 the "quick" symbol table functions. */
2379 static struct block_symbol
2380 lookup_symbol_via_quick_fns (struct objfile *objfile, int block_index,
2381 const char *name, const domain_enum domain)
2383 struct compunit_symtab *cust;
2384 const struct blockvector *bv;
2385 const struct block *block;
2386 struct block_symbol result;
2391 if (symbol_lookup_debug > 1)
2393 fprintf_unfiltered (gdb_stdlog,
2394 "lookup_symbol_via_quick_fns (%s, %s, %s, %s)\n",
2395 objfile_debug_name (objfile),
2396 block_index == GLOBAL_BLOCK
2397 ? "GLOBAL_BLOCK" : "STATIC_BLOCK",
2398 name, domain_name (domain));
2401 cust = objfile->sf->qf->lookup_symbol (objfile, block_index, name, domain);
2404 if (symbol_lookup_debug > 1)
2406 fprintf_unfiltered (gdb_stdlog,
2407 "lookup_symbol_via_quick_fns (...) = NULL\n");
2412 bv = COMPUNIT_BLOCKVECTOR (cust);
2413 block = BLOCKVECTOR_BLOCK (bv, block_index);
2414 result.symbol = block_lookup_symbol (block, name,
2415 symbol_name_match_type::FULL, domain);
2416 if (result.symbol == NULL)
2417 error_in_psymtab_expansion (block_index, name, cust);
2419 if (symbol_lookup_debug > 1)
2421 fprintf_unfiltered (gdb_stdlog,
2422 "lookup_symbol_via_quick_fns (...) = %s (block %s)\n",
2423 host_address_to_string (result.symbol),
2424 host_address_to_string (block));
2427 result.symbol = fixup_symbol_section (result.symbol, objfile);
2428 result.block = block;
2435 basic_lookup_symbol_nonlocal (const struct language_defn *langdef,
2437 const struct block *block,
2438 const domain_enum domain)
2440 struct block_symbol result;
2442 /* NOTE: carlton/2003-05-19: The comments below were written when
2443 this (or what turned into this) was part of lookup_symbol_aux;
2444 I'm much less worried about these questions now, since these
2445 decisions have turned out well, but I leave these comments here
2448 /* NOTE: carlton/2002-12-05: There is a question as to whether or
2449 not it would be appropriate to search the current global block
2450 here as well. (That's what this code used to do before the
2451 is_a_field_of_this check was moved up.) On the one hand, it's
2452 redundant with the lookup in all objfiles search that happens
2453 next. On the other hand, if decode_line_1 is passed an argument
2454 like filename:var, then the user presumably wants 'var' to be
2455 searched for in filename. On the third hand, there shouldn't be
2456 multiple global variables all of which are named 'var', and it's
2457 not like decode_line_1 has ever restricted its search to only
2458 global variables in a single filename. All in all, only
2459 searching the static block here seems best: it's correct and it's
2462 /* NOTE: carlton/2002-12-05: There's also a possible performance
2463 issue here: if you usually search for global symbols in the
2464 current file, then it would be slightly better to search the
2465 current global block before searching all the symtabs. But there
2466 are other factors that have a much greater effect on performance
2467 than that one, so I don't think we should worry about that for
2470 /* NOTE: dje/2014-10-26: The lookup in all objfiles search could skip
2471 the current objfile. Searching the current objfile first is useful
2472 for both matching user expectations as well as performance. */
2474 result = lookup_symbol_in_static_block (name, block, domain);
2475 if (result.symbol != NULL)
2478 /* If we didn't find a definition for a builtin type in the static block,
2479 search for it now. This is actually the right thing to do and can be
2480 a massive performance win. E.g., when debugging a program with lots of
2481 shared libraries we could search all of them only to find out the
2482 builtin type isn't defined in any of them. This is common for types
2484 if (domain == VAR_DOMAIN)
2486 struct gdbarch *gdbarch;
2489 gdbarch = target_gdbarch ();
2491 gdbarch = block_gdbarch (block);
2492 result.symbol = language_lookup_primitive_type_as_symbol (langdef,
2494 result.block = NULL;
2495 if (result.symbol != NULL)
2499 return lookup_global_symbol (name, block, domain);
2505 lookup_symbol_in_static_block (const char *name,
2506 const struct block *block,
2507 const domain_enum domain)
2509 const struct block *static_block = block_static_block (block);
2512 if (static_block == NULL)
2515 if (symbol_lookup_debug)
2517 struct objfile *objfile = lookup_objfile_from_block (static_block);
2519 fprintf_unfiltered (gdb_stdlog,
2520 "lookup_symbol_in_static_block (%s, %s (objfile %s),"
2523 host_address_to_string (block),
2524 objfile_debug_name (objfile),
2525 domain_name (domain));
2528 sym = lookup_symbol_in_block (name,
2529 symbol_name_match_type::FULL,
2530 static_block, domain);
2531 if (symbol_lookup_debug)
2533 fprintf_unfiltered (gdb_stdlog,
2534 "lookup_symbol_in_static_block (...) = %s\n",
2535 sym != NULL ? host_address_to_string (sym) : "NULL");
2537 return (struct block_symbol) {sym, static_block};
2540 /* Perform the standard symbol lookup of NAME in OBJFILE:
2541 1) First search expanded symtabs, and if not found
2542 2) Search the "quick" symtabs (partial or .gdb_index).
2543 BLOCK_INDEX is one of GLOBAL_BLOCK or STATIC_BLOCK. */
2545 static struct block_symbol
2546 lookup_symbol_in_objfile (struct objfile *objfile, int block_index,
2547 const char *name, const domain_enum domain)
2549 struct block_symbol result;
2551 if (symbol_lookup_debug)
2553 fprintf_unfiltered (gdb_stdlog,
2554 "lookup_symbol_in_objfile (%s, %s, %s, %s)\n",
2555 objfile_debug_name (objfile),
2556 block_index == GLOBAL_BLOCK
2557 ? "GLOBAL_BLOCK" : "STATIC_BLOCK",
2558 name, domain_name (domain));
2561 result = lookup_symbol_in_objfile_symtabs (objfile, block_index,
2563 if (result.symbol != NULL)
2565 if (symbol_lookup_debug)
2567 fprintf_unfiltered (gdb_stdlog,
2568 "lookup_symbol_in_objfile (...) = %s"
2570 host_address_to_string (result.symbol));
2575 result = lookup_symbol_via_quick_fns (objfile, block_index,
2577 if (symbol_lookup_debug)
2579 fprintf_unfiltered (gdb_stdlog,
2580 "lookup_symbol_in_objfile (...) = %s%s\n",
2581 result.symbol != NULL
2582 ? host_address_to_string (result.symbol)
2584 result.symbol != NULL ? " (via quick fns)" : "");
2592 lookup_static_symbol (const char *name, const domain_enum domain)
2594 struct symbol_cache *cache = get_symbol_cache (current_program_space);
2595 struct block_symbol result;
2596 struct block_symbol_cache *bsc;
2597 struct symbol_cache_slot *slot;
2599 /* Lookup in STATIC_BLOCK is not current-objfile-dependent, so just pass
2600 NULL for OBJFILE_CONTEXT. */
2601 result = symbol_cache_lookup (cache, NULL, STATIC_BLOCK, name, domain,
2603 if (result.symbol != NULL)
2605 if (SYMBOL_LOOKUP_FAILED_P (result))
2610 for (objfile *objfile : current_program_space->objfiles ())
2612 result = lookup_symbol_in_objfile (objfile, STATIC_BLOCK, name, domain);
2613 if (result.symbol != NULL)
2615 /* Still pass NULL for OBJFILE_CONTEXT here. */
2616 symbol_cache_mark_found (bsc, slot, NULL, result.symbol,
2622 /* Still pass NULL for OBJFILE_CONTEXT here. */
2623 symbol_cache_mark_not_found (bsc, slot, NULL, name, domain);
2627 /* Private data to be used with lookup_symbol_global_iterator_cb. */
2629 struct global_sym_lookup_data
2631 /* The name of the symbol we are searching for. */
2634 /* The domain to use for our search. */
2637 /* The field where the callback should store the symbol if found.
2638 It should be initialized to {NULL, NULL} before the search is started. */
2639 struct block_symbol result;
2642 /* A callback function for gdbarch_iterate_over_objfiles_in_search_order.
2643 It searches by name for a symbol in the GLOBAL_BLOCK of the given
2644 OBJFILE. The arguments for the search are passed via CB_DATA,
2645 which in reality is a pointer to struct global_sym_lookup_data. */
2648 lookup_symbol_global_iterator_cb (struct objfile *objfile,
2651 struct global_sym_lookup_data *data =
2652 (struct global_sym_lookup_data *) cb_data;
2654 gdb_assert (data->result.symbol == NULL
2655 && data->result.block == NULL);
2657 data->result = lookup_symbol_in_objfile (objfile, GLOBAL_BLOCK,
2658 data->name, data->domain);
2660 /* If we found a match, tell the iterator to stop. Otherwise,
2662 return (data->result.symbol != NULL);
2668 lookup_global_symbol (const char *name,
2669 const struct block *block,
2670 const domain_enum domain)
2672 struct symbol_cache *cache = get_symbol_cache (current_program_space);
2673 struct block_symbol result;
2674 struct objfile *objfile;
2675 struct global_sym_lookup_data lookup_data;
2676 struct block_symbol_cache *bsc;
2677 struct symbol_cache_slot *slot;
2679 objfile = lookup_objfile_from_block (block);
2681 /* First see if we can find the symbol in the cache.
2682 This works because we use the current objfile to qualify the lookup. */
2683 result = symbol_cache_lookup (cache, objfile, GLOBAL_BLOCK, name, domain,
2685 if (result.symbol != NULL)
2687 if (SYMBOL_LOOKUP_FAILED_P (result))
2692 /* Call library-specific lookup procedure. */
2693 if (objfile != NULL)
2694 result = solib_global_lookup (objfile, name, domain);
2696 /* If that didn't work go a global search (of global blocks, heh). */
2697 if (result.symbol == NULL)
2699 memset (&lookup_data, 0, sizeof (lookup_data));
2700 lookup_data.name = name;
2701 lookup_data.domain = domain;
2702 gdbarch_iterate_over_objfiles_in_search_order
2703 (objfile != NULL ? get_objfile_arch (objfile) : target_gdbarch (),
2704 lookup_symbol_global_iterator_cb, &lookup_data, objfile);
2705 result = lookup_data.result;
2708 if (result.symbol != NULL)
2709 symbol_cache_mark_found (bsc, slot, objfile, result.symbol, result.block);
2711 symbol_cache_mark_not_found (bsc, slot, objfile, name, domain);
2717 symbol_matches_domain (enum language symbol_language,
2718 domain_enum symbol_domain,
2721 /* For C++ "struct foo { ... }" also defines a typedef for "foo".
2722 Similarly, any Ada type declaration implicitly defines a typedef. */
2723 if (symbol_language == language_cplus
2724 || symbol_language == language_d
2725 || symbol_language == language_ada
2726 || symbol_language == language_rust)
2728 if ((domain == VAR_DOMAIN || domain == STRUCT_DOMAIN)
2729 && symbol_domain == STRUCT_DOMAIN)
2732 /* For all other languages, strict match is required. */
2733 return (symbol_domain == domain);
2739 lookup_transparent_type (const char *name)
2741 return current_language->la_lookup_transparent_type (name);
2744 /* A helper for basic_lookup_transparent_type that interfaces with the
2745 "quick" symbol table functions. */
2747 static struct type *
2748 basic_lookup_transparent_type_quick (struct objfile *objfile, int block_index,
2751 struct compunit_symtab *cust;
2752 const struct blockvector *bv;
2753 const struct block *block;
2758 cust = objfile->sf->qf->lookup_symbol (objfile, block_index, name,
2763 bv = COMPUNIT_BLOCKVECTOR (cust);
2764 block = BLOCKVECTOR_BLOCK (bv, block_index);
2765 sym = block_find_symbol (block, name, STRUCT_DOMAIN,
2766 block_find_non_opaque_type, NULL);
2768 error_in_psymtab_expansion (block_index, name, cust);
2769 gdb_assert (!TYPE_IS_OPAQUE (SYMBOL_TYPE (sym)));
2770 return SYMBOL_TYPE (sym);
2773 /* Subroutine of basic_lookup_transparent_type to simplify it.
2774 Look up the non-opaque definition of NAME in BLOCK_INDEX of OBJFILE.
2775 BLOCK_INDEX is either GLOBAL_BLOCK or STATIC_BLOCK. */
2777 static struct type *
2778 basic_lookup_transparent_type_1 (struct objfile *objfile, int block_index,
2781 const struct blockvector *bv;
2782 const struct block *block;
2783 const struct symbol *sym;
2785 for (compunit_symtab *cust : objfile->compunits ())
2787 bv = COMPUNIT_BLOCKVECTOR (cust);
2788 block = BLOCKVECTOR_BLOCK (bv, block_index);
2789 sym = block_find_symbol (block, name, STRUCT_DOMAIN,
2790 block_find_non_opaque_type, NULL);
2793 gdb_assert (!TYPE_IS_OPAQUE (SYMBOL_TYPE (sym)));
2794 return SYMBOL_TYPE (sym);
2801 /* The standard implementation of lookup_transparent_type. This code
2802 was modeled on lookup_symbol -- the parts not relevant to looking
2803 up types were just left out. In particular it's assumed here that
2804 types are available in STRUCT_DOMAIN and only in file-static or
2808 basic_lookup_transparent_type (const char *name)
2812 /* Now search all the global symbols. Do the symtab's first, then
2813 check the psymtab's. If a psymtab indicates the existence
2814 of the desired name as a global, then do psymtab-to-symtab
2815 conversion on the fly and return the found symbol. */
2817 for (objfile *objfile : current_program_space->objfiles ())
2819 t = basic_lookup_transparent_type_1 (objfile, GLOBAL_BLOCK, name);
2824 for (objfile *objfile : current_program_space->objfiles ())
2826 t = basic_lookup_transparent_type_quick (objfile, GLOBAL_BLOCK, name);
2831 /* Now search the static file-level symbols.
2832 Not strictly correct, but more useful than an error.
2833 Do the symtab's first, then
2834 check the psymtab's. If a psymtab indicates the existence
2835 of the desired name as a file-level static, then do psymtab-to-symtab
2836 conversion on the fly and return the found symbol. */
2838 for (objfile *objfile : current_program_space->objfiles ())
2840 t = basic_lookup_transparent_type_1 (objfile, STATIC_BLOCK, name);
2845 for (objfile *objfile : current_program_space->objfiles ())
2847 t = basic_lookup_transparent_type_quick (objfile, STATIC_BLOCK, name);
2852 return (struct type *) 0;
2855 /* Iterate over the symbols named NAME, matching DOMAIN, in BLOCK.
2857 For each symbol that matches, CALLBACK is called. The symbol is
2858 passed to the callback.
2860 If CALLBACK returns false, the iteration ends. Otherwise, the
2861 search continues. */
2864 iterate_over_symbols (const struct block *block,
2865 const lookup_name_info &name,
2866 const domain_enum domain,
2867 gdb::function_view<symbol_found_callback_ftype> callback)
2869 struct block_iterator iter;
2872 ALL_BLOCK_SYMBOLS_WITH_NAME (block, name, iter, sym)
2874 if (symbol_matches_domain (SYMBOL_LANGUAGE (sym),
2875 SYMBOL_DOMAIN (sym), domain))
2877 struct block_symbol block_sym = {sym, block};
2879 if (!callback (&block_sym))
2885 /* Find the compunit symtab associated with PC and SECTION.
2886 This will read in debug info as necessary. */
2888 struct compunit_symtab *
2889 find_pc_sect_compunit_symtab (CORE_ADDR pc, struct obj_section *section)
2891 struct compunit_symtab *best_cust = NULL;
2892 CORE_ADDR distance = 0;
2893 struct bound_minimal_symbol msymbol;
2895 /* If we know that this is not a text address, return failure. This is
2896 necessary because we loop based on the block's high and low code
2897 addresses, which do not include the data ranges, and because
2898 we call find_pc_sect_psymtab which has a similar restriction based
2899 on the partial_symtab's texthigh and textlow. */
2900 msymbol = lookup_minimal_symbol_by_pc_section (pc, section);
2901 if (msymbol.minsym && msymbol.minsym->data_p ())
2904 /* Search all symtabs for the one whose file contains our address, and which
2905 is the smallest of all the ones containing the address. This is designed
2906 to deal with a case like symtab a is at 0x1000-0x2000 and 0x3000-0x4000
2907 and symtab b is at 0x2000-0x3000. So the GLOBAL_BLOCK for a is from
2908 0x1000-0x4000, but for address 0x2345 we want to return symtab b.
2910 This happens for native ecoff format, where code from included files
2911 gets its own symtab. The symtab for the included file should have
2912 been read in already via the dependency mechanism.
2913 It might be swifter to create several symtabs with the same name
2914 like xcoff does (I'm not sure).
2916 It also happens for objfiles that have their functions reordered.
2917 For these, the symtab we are looking for is not necessarily read in. */
2919 for (objfile *obj_file : current_program_space->objfiles ())
2921 for (compunit_symtab *cust : obj_file->compunits ())
2923 const struct block *b;
2924 const struct blockvector *bv;
2926 bv = COMPUNIT_BLOCKVECTOR (cust);
2927 b = BLOCKVECTOR_BLOCK (bv, GLOBAL_BLOCK);
2929 if (BLOCK_START (b) <= pc
2930 && BLOCK_END (b) > pc
2932 || BLOCK_END (b) - BLOCK_START (b) < distance))
2934 /* For an objfile that has its functions reordered,
2935 find_pc_psymtab will find the proper partial symbol table
2936 and we simply return its corresponding symtab. */
2937 /* In order to better support objfiles that contain both
2938 stabs and coff debugging info, we continue on if a psymtab
2940 if ((obj_file->flags & OBJF_REORDERED) && obj_file->sf)
2942 struct compunit_symtab *result;
2945 = obj_file->sf->qf->find_pc_sect_compunit_symtab (obj_file,
2955 struct block_iterator iter;
2956 struct symbol *sym = NULL;
2958 ALL_BLOCK_SYMBOLS (b, iter, sym)
2960 fixup_symbol_section (sym, obj_file);
2961 if (matching_obj_sections (SYMBOL_OBJ_SECTION (obj_file,
2967 continue; /* No symbol in this symtab matches
2970 distance = BLOCK_END (b) - BLOCK_START (b);
2976 if (best_cust != NULL)
2979 /* Not found in symtabs, search the "quick" symtabs (e.g. psymtabs). */
2981 for (objfile *objf : current_program_space->objfiles ())
2983 struct compunit_symtab *result;
2987 result = objf->sf->qf->find_pc_sect_compunit_symtab (objf,
2998 /* Find the compunit symtab associated with PC.
2999 This will read in debug info as necessary.
3000 Backward compatibility, no section. */
3002 struct compunit_symtab *
3003 find_pc_compunit_symtab (CORE_ADDR pc)
3005 return find_pc_sect_compunit_symtab (pc, find_pc_mapped_section (pc));
3011 find_symbol_at_address (CORE_ADDR address)
3013 for (objfile *objfile : current_program_space->objfiles ())
3015 if (objfile->sf == NULL
3016 || objfile->sf->qf->find_compunit_symtab_by_address == NULL)
3019 struct compunit_symtab *symtab
3020 = objfile->sf->qf->find_compunit_symtab_by_address (objfile, address);
3023 const struct blockvector *bv = COMPUNIT_BLOCKVECTOR (symtab);
3025 for (int i = GLOBAL_BLOCK; i <= STATIC_BLOCK; ++i)
3027 const struct block *b = BLOCKVECTOR_BLOCK (bv, i);
3028 struct block_iterator iter;
3031 ALL_BLOCK_SYMBOLS (b, iter, sym)
3033 if (SYMBOL_CLASS (sym) == LOC_STATIC
3034 && SYMBOL_VALUE_ADDRESS (sym) == address)
3046 /* Find the source file and line number for a given PC value and SECTION.
3047 Return a structure containing a symtab pointer, a line number,
3048 and a pc range for the entire source line.
3049 The value's .pc field is NOT the specified pc.
3050 NOTCURRENT nonzero means, if specified pc is on a line boundary,
3051 use the line that ends there. Otherwise, in that case, the line
3052 that begins there is used. */
3054 /* The big complication here is that a line may start in one file, and end just
3055 before the start of another file. This usually occurs when you #include
3056 code in the middle of a subroutine. To properly find the end of a line's PC
3057 range, we must search all symtabs associated with this compilation unit, and
3058 find the one whose first PC is closer than that of the next line in this
3061 struct symtab_and_line
3062 find_pc_sect_line (CORE_ADDR pc, struct obj_section *section, int notcurrent)
3064 struct compunit_symtab *cust;
3065 struct linetable *l;
3067 struct linetable_entry *item;
3068 const struct blockvector *bv;
3069 struct bound_minimal_symbol msymbol;
3071 /* Info on best line seen so far, and where it starts, and its file. */
3073 struct linetable_entry *best = NULL;
3074 CORE_ADDR best_end = 0;
3075 struct symtab *best_symtab = 0;
3077 /* Store here the first line number
3078 of a file which contains the line at the smallest pc after PC.
3079 If we don't find a line whose range contains PC,
3080 we will use a line one less than this,
3081 with a range from the start of that file to the first line's pc. */
3082 struct linetable_entry *alt = NULL;
3084 /* Info on best line seen in this file. */
3086 struct linetable_entry *prev;
3088 /* If this pc is not from the current frame,
3089 it is the address of the end of a call instruction.
3090 Quite likely that is the start of the following statement.
3091 But what we want is the statement containing the instruction.
3092 Fudge the pc to make sure we get that. */
3094 /* It's tempting to assume that, if we can't find debugging info for
3095 any function enclosing PC, that we shouldn't search for line
3096 number info, either. However, GAS can emit line number info for
3097 assembly files --- very helpful when debugging hand-written
3098 assembly code. In such a case, we'd have no debug info for the
3099 function, but we would have line info. */
3104 /* elz: added this because this function returned the wrong
3105 information if the pc belongs to a stub (import/export)
3106 to call a shlib function. This stub would be anywhere between
3107 two functions in the target, and the line info was erroneously
3108 taken to be the one of the line before the pc. */
3110 /* RT: Further explanation:
3112 * We have stubs (trampolines) inserted between procedures.
3114 * Example: "shr1" exists in a shared library, and a "shr1" stub also
3115 * exists in the main image.
3117 * In the minimal symbol table, we have a bunch of symbols
3118 * sorted by start address. The stubs are marked as "trampoline",
3119 * the others appear as text. E.g.:
3121 * Minimal symbol table for main image
3122 * main: code for main (text symbol)
3123 * shr1: stub (trampoline symbol)
3124 * foo: code for foo (text symbol)
3126 * Minimal symbol table for "shr1" image:
3128 * shr1: code for shr1 (text symbol)
3131 * So the code below is trying to detect if we are in the stub
3132 * ("shr1" stub), and if so, find the real code ("shr1" trampoline),
3133 * and if found, do the symbolization from the real-code address
3134 * rather than the stub address.
3136 * Assumptions being made about the minimal symbol table:
3137 * 1. lookup_minimal_symbol_by_pc() will return a trampoline only
3138 * if we're really in the trampoline.s If we're beyond it (say
3139 * we're in "foo" in the above example), it'll have a closer
3140 * symbol (the "foo" text symbol for example) and will not
3141 * return the trampoline.
3142 * 2. lookup_minimal_symbol_text() will find a real text symbol
3143 * corresponding to the trampoline, and whose address will
3144 * be different than the trampoline address. I put in a sanity
3145 * check for the address being the same, to avoid an
3146 * infinite recursion.
3148 msymbol = lookup_minimal_symbol_by_pc (pc);
3149 if (msymbol.minsym != NULL)
3150 if (MSYMBOL_TYPE (msymbol.minsym) == mst_solib_trampoline)
3152 struct bound_minimal_symbol mfunsym
3153 = lookup_minimal_symbol_text (MSYMBOL_LINKAGE_NAME (msymbol.minsym),
3156 if (mfunsym.minsym == NULL)
3157 /* I eliminated this warning since it is coming out
3158 * in the following situation:
3159 * gdb shmain // test program with shared libraries
3160 * (gdb) break shr1 // function in shared lib
3161 * Warning: In stub for ...
3162 * In the above situation, the shared lib is not loaded yet,
3163 * so of course we can't find the real func/line info,
3164 * but the "break" still works, and the warning is annoying.
3165 * So I commented out the warning. RT */
3166 /* warning ("In stub for %s; unable to find real function/line info",
3167 SYMBOL_LINKAGE_NAME (msymbol)); */
3170 else if (BMSYMBOL_VALUE_ADDRESS (mfunsym)
3171 == BMSYMBOL_VALUE_ADDRESS (msymbol))
3172 /* Avoid infinite recursion */
3173 /* See above comment about why warning is commented out. */
3174 /* warning ("In stub for %s; unable to find real function/line info",
3175 SYMBOL_LINKAGE_NAME (msymbol)); */
3179 return find_pc_line (BMSYMBOL_VALUE_ADDRESS (mfunsym), 0);
3182 symtab_and_line val;
3183 val.pspace = current_program_space;
3185 cust = find_pc_sect_compunit_symtab (pc, section);
3188 /* If no symbol information, return previous pc. */
3195 bv = COMPUNIT_BLOCKVECTOR (cust);
3197 /* Look at all the symtabs that share this blockvector.
3198 They all have the same apriori range, that we found was right;
3199 but they have different line tables. */
3201 for (symtab *iter_s : compunit_filetabs (cust))
3203 /* Find the best line in this symtab. */
3204 l = SYMTAB_LINETABLE (iter_s);
3210 /* I think len can be zero if the symtab lacks line numbers
3211 (e.g. gcc -g1). (Either that or the LINETABLE is NULL;
3212 I'm not sure which, and maybe it depends on the symbol
3218 item = l->item; /* Get first line info. */
3220 /* Is this file's first line closer than the first lines of other files?
3221 If so, record this file, and its first line, as best alternate. */
3222 if (item->pc > pc && (!alt || item->pc < alt->pc))
3225 auto pc_compare = [](const CORE_ADDR & comp_pc,
3226 const struct linetable_entry & lhs)->bool
3228 return comp_pc < lhs.pc;
3231 struct linetable_entry *first = item;
3232 struct linetable_entry *last = item + len;
3233 item = std::upper_bound (first, last, pc, pc_compare);
3235 prev = item - 1; /* Found a matching item. */
3237 /* At this point, prev points at the line whose start addr is <= pc, and
3238 item points at the next line. If we ran off the end of the linetable
3239 (pc >= start of the last line), then prev == item. If pc < start of
3240 the first line, prev will not be set. */
3242 /* Is this file's best line closer than the best in the other files?
3243 If so, record this file, and its best line, as best so far. Don't
3244 save prev if it represents the end of a function (i.e. line number
3245 0) instead of a real line. */
3247 if (prev && prev->line && (!best || prev->pc > best->pc))
3250 best_symtab = iter_s;
3252 /* Discard BEST_END if it's before the PC of the current BEST. */
3253 if (best_end <= best->pc)
3257 /* If another line (denoted by ITEM) is in the linetable and its
3258 PC is after BEST's PC, but before the current BEST_END, then
3259 use ITEM's PC as the new best_end. */
3260 if (best && item < last && item->pc > best->pc
3261 && (best_end == 0 || best_end > item->pc))
3262 best_end = item->pc;
3267 /* If we didn't find any line number info, just return zeros.
3268 We used to return alt->line - 1 here, but that could be
3269 anywhere; if we don't have line number info for this PC,
3270 don't make some up. */
3273 else if (best->line == 0)
3275 /* If our best fit is in a range of PC's for which no line
3276 number info is available (line number is zero) then we didn't
3277 find any valid line information. */
3282 val.symtab = best_symtab;
3283 val.line = best->line;
3285 if (best_end && (!alt || best_end < alt->pc))
3290 val.end = BLOCK_END (BLOCKVECTOR_BLOCK (bv, GLOBAL_BLOCK));
3292 val.section = section;
3296 /* Backward compatibility (no section). */
3298 struct symtab_and_line
3299 find_pc_line (CORE_ADDR pc, int notcurrent)
3301 struct obj_section *section;
3303 section = find_pc_overlay (pc);
3304 if (pc_in_unmapped_range (pc, section))
3305 pc = overlay_mapped_address (pc, section);
3306 return find_pc_sect_line (pc, section, notcurrent);
3312 find_pc_line_symtab (CORE_ADDR pc)
3314 struct symtab_and_line sal;
3316 /* This always passes zero for NOTCURRENT to find_pc_line.
3317 There are currently no callers that ever pass non-zero. */
3318 sal = find_pc_line (pc, 0);
3322 /* Find line number LINE in any symtab whose name is the same as
3325 If found, return the symtab that contains the linetable in which it was
3326 found, set *INDEX to the index in the linetable of the best entry
3327 found, and set *EXACT_MATCH nonzero if the value returned is an
3330 If not found, return NULL. */
3333 find_line_symtab (struct symtab *sym_tab, int line,
3334 int *index, int *exact_match)
3336 int exact = 0; /* Initialized here to avoid a compiler warning. */
3338 /* BEST_INDEX and BEST_LINETABLE identify the smallest linenumber > LINE
3342 struct linetable *best_linetable;
3343 struct symtab *best_symtab;
3345 /* First try looking it up in the given symtab. */
3346 best_linetable = SYMTAB_LINETABLE (sym_tab);
3347 best_symtab = sym_tab;
3348 best_index = find_line_common (best_linetable, line, &exact, 0);
3349 if (best_index < 0 || !exact)
3351 /* Didn't find an exact match. So we better keep looking for
3352 another symtab with the same name. In the case of xcoff,
3353 multiple csects for one source file (produced by IBM's FORTRAN
3354 compiler) produce multiple symtabs (this is unavoidable
3355 assuming csects can be at arbitrary places in memory and that
3356 the GLOBAL_BLOCK of a symtab has a begin and end address). */
3358 /* BEST is the smallest linenumber > LINE so far seen,
3359 or 0 if none has been seen so far.
3360 BEST_INDEX and BEST_LINETABLE identify the item for it. */
3363 if (best_index >= 0)
3364 best = best_linetable->item[best_index].line;
3368 for (objfile *objfile : current_program_space->objfiles ())
3371 objfile->sf->qf->expand_symtabs_with_fullname
3372 (objfile, symtab_to_fullname (sym_tab));
3375 for (objfile *objfile : current_program_space->objfiles ())
3377 for (compunit_symtab *cu : objfile->compunits ())
3379 for (symtab *s : compunit_filetabs (cu))
3381 struct linetable *l;
3384 if (FILENAME_CMP (sym_tab->filename, s->filename) != 0)
3386 if (FILENAME_CMP (symtab_to_fullname (sym_tab),
3387 symtab_to_fullname (s)) != 0)
3389 l = SYMTAB_LINETABLE (s);
3390 ind = find_line_common (l, line, &exact, 0);
3400 if (best == 0 || l->item[ind].line < best)
3402 best = l->item[ind].line;
3417 *index = best_index;
3419 *exact_match = exact;
3424 /* Given SYMTAB, returns all the PCs function in the symtab that
3425 exactly match LINE. Returns an empty vector if there are no exact
3426 matches, but updates BEST_ITEM in this case. */
3428 std::vector<CORE_ADDR>
3429 find_pcs_for_symtab_line (struct symtab *symtab, int line,
3430 struct linetable_entry **best_item)
3433 std::vector<CORE_ADDR> result;
3435 /* First, collect all the PCs that are at this line. */
3441 idx = find_line_common (SYMTAB_LINETABLE (symtab), line, &was_exact,
3448 struct linetable_entry *item = &SYMTAB_LINETABLE (symtab)->item[idx];
3450 if (*best_item == NULL || item->line < (*best_item)->line)
3456 result.push_back (SYMTAB_LINETABLE (symtab)->item[idx].pc);
3464 /* Set the PC value for a given source file and line number and return true.
3465 Returns zero for invalid line number (and sets the PC to 0).
3466 The source file is specified with a struct symtab. */
3469 find_line_pc (struct symtab *symtab, int line, CORE_ADDR *pc)
3471 struct linetable *l;
3478 symtab = find_line_symtab (symtab, line, &ind, NULL);
3481 l = SYMTAB_LINETABLE (symtab);
3482 *pc = l->item[ind].pc;
3489 /* Find the range of pc values in a line.
3490 Store the starting pc of the line into *STARTPTR
3491 and the ending pc (start of next line) into *ENDPTR.
3492 Returns 1 to indicate success.
3493 Returns 0 if could not find the specified line. */
3496 find_line_pc_range (struct symtab_and_line sal, CORE_ADDR *startptr,
3499 CORE_ADDR startaddr;
3500 struct symtab_and_line found_sal;
3503 if (startaddr == 0 && !find_line_pc (sal.symtab, sal.line, &startaddr))
3506 /* This whole function is based on address. For example, if line 10 has
3507 two parts, one from 0x100 to 0x200 and one from 0x300 to 0x400, then
3508 "info line *0x123" should say the line goes from 0x100 to 0x200
3509 and "info line *0x355" should say the line goes from 0x300 to 0x400.
3510 This also insures that we never give a range like "starts at 0x134
3511 and ends at 0x12c". */
3513 found_sal = find_pc_sect_line (startaddr, sal.section, 0);
3514 if (found_sal.line != sal.line)
3516 /* The specified line (sal) has zero bytes. */
3517 *startptr = found_sal.pc;
3518 *endptr = found_sal.pc;
3522 *startptr = found_sal.pc;
3523 *endptr = found_sal.end;
3528 /* Given a line table and a line number, return the index into the line
3529 table for the pc of the nearest line whose number is >= the specified one.
3530 Return -1 if none is found. The value is >= 0 if it is an index.
3531 START is the index at which to start searching the line table.
3533 Set *EXACT_MATCH nonzero if the value returned is an exact match. */
3536 find_line_common (struct linetable *l, int lineno,
3537 int *exact_match, int start)
3542 /* BEST is the smallest linenumber > LINENO so far seen,
3543 or 0 if none has been seen so far.
3544 BEST_INDEX identifies the item for it. */
3546 int best_index = -1;
3557 for (i = start; i < len; i++)
3559 struct linetable_entry *item = &(l->item[i]);
3561 if (item->line == lineno)
3563 /* Return the first (lowest address) entry which matches. */
3568 if (item->line > lineno && (best == 0 || item->line < best))
3575 /* If we got here, we didn't get an exact match. */
3580 find_pc_line_pc_range (CORE_ADDR pc, CORE_ADDR *startptr, CORE_ADDR *endptr)
3582 struct symtab_and_line sal;
3584 sal = find_pc_line (pc, 0);
3587 return sal.symtab != 0;
3590 /* Helper for find_function_start_sal. Does most of the work, except
3591 setting the sal's symbol. */
3593 static symtab_and_line
3594 find_function_start_sal_1 (CORE_ADDR func_addr, obj_section *section,
3597 symtab_and_line sal = find_pc_sect_line (func_addr, section, 0);
3599 if (funfirstline && sal.symtab != NULL
3600 && (COMPUNIT_LOCATIONS_VALID (SYMTAB_COMPUNIT (sal.symtab))
3601 || SYMTAB_LANGUAGE (sal.symtab) == language_asm))
3603 struct gdbarch *gdbarch = get_objfile_arch (SYMTAB_OBJFILE (sal.symtab));
3606 if (gdbarch_skip_entrypoint_p (gdbarch))
3607 sal.pc = gdbarch_skip_entrypoint (gdbarch, sal.pc);
3611 /* We always should have a line for the function start address.
3612 If we don't, something is odd. Create a plain SAL referring
3613 just the PC and hope that skip_prologue_sal (if requested)
3614 can find a line number for after the prologue. */
3615 if (sal.pc < func_addr)
3618 sal.pspace = current_program_space;
3620 sal.section = section;
3624 skip_prologue_sal (&sal);
3632 find_function_start_sal (CORE_ADDR func_addr, obj_section *section,
3636 = find_function_start_sal_1 (func_addr, section, funfirstline);
3638 /* find_function_start_sal_1 does a linetable search, so it finds
3639 the symtab and linenumber, but not a symbol. Fill in the
3640 function symbol too. */
3641 sal.symbol = find_pc_sect_containing_function (sal.pc, sal.section);
3649 find_function_start_sal (symbol *sym, bool funfirstline)
3651 fixup_symbol_section (sym, NULL);
3653 = find_function_start_sal_1 (BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym)),
3654 SYMBOL_OBJ_SECTION (symbol_objfile (sym), sym),
3661 /* Given a function start address FUNC_ADDR and SYMTAB, find the first
3662 address for that function that has an entry in SYMTAB's line info
3663 table. If such an entry cannot be found, return FUNC_ADDR
3667 skip_prologue_using_lineinfo (CORE_ADDR func_addr, struct symtab *symtab)
3669 CORE_ADDR func_start, func_end;
3670 struct linetable *l;
3673 /* Give up if this symbol has no lineinfo table. */
3674 l = SYMTAB_LINETABLE (symtab);
3678 /* Get the range for the function's PC values, or give up if we
3679 cannot, for some reason. */
3680 if (!find_pc_partial_function (func_addr, NULL, &func_start, &func_end))
3683 /* Linetable entries are ordered by PC values, see the commentary in
3684 symtab.h where `struct linetable' is defined. Thus, the first
3685 entry whose PC is in the range [FUNC_START..FUNC_END[ is the
3686 address we are looking for. */
3687 for (i = 0; i < l->nitems; i++)
3689 struct linetable_entry *item = &(l->item[i]);
3691 /* Don't use line numbers of zero, they mark special entries in
3692 the table. See the commentary on symtab.h before the
3693 definition of struct linetable. */
3694 if (item->line > 0 && func_start <= item->pc && item->pc < func_end)
3701 /* Adjust SAL to the first instruction past the function prologue.
3702 If the PC was explicitly specified, the SAL is not changed.
3703 If the line number was explicitly specified, at most the SAL's PC
3704 is updated. If SAL is already past the prologue, then do nothing. */
3707 skip_prologue_sal (struct symtab_and_line *sal)
3710 struct symtab_and_line start_sal;
3711 CORE_ADDR pc, saved_pc;
3712 struct obj_section *section;
3714 struct objfile *objfile;
3715 struct gdbarch *gdbarch;
3716 const struct block *b, *function_block;
3717 int force_skip, skip;
3719 /* Do not change the SAL if PC was specified explicitly. */
3720 if (sal->explicit_pc)
3723 scoped_restore_current_pspace_and_thread restore_pspace_thread;
3725 switch_to_program_space_and_thread (sal->pspace);
3727 sym = find_pc_sect_function (sal->pc, sal->section);
3730 fixup_symbol_section (sym, NULL);
3732 objfile = symbol_objfile (sym);
3733 pc = BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym));
3734 section = SYMBOL_OBJ_SECTION (objfile, sym);
3735 name = SYMBOL_LINKAGE_NAME (sym);
3739 struct bound_minimal_symbol msymbol
3740 = lookup_minimal_symbol_by_pc_section (sal->pc, sal->section);
3742 if (msymbol.minsym == NULL)
3745 objfile = msymbol.objfile;
3746 pc = BMSYMBOL_VALUE_ADDRESS (msymbol);
3747 section = MSYMBOL_OBJ_SECTION (objfile, msymbol.minsym);
3748 name = MSYMBOL_LINKAGE_NAME (msymbol.minsym);
3751 gdbarch = get_objfile_arch (objfile);
3753 /* Process the prologue in two passes. In the first pass try to skip the
3754 prologue (SKIP is true) and verify there is a real need for it (indicated
3755 by FORCE_SKIP). If no such reason was found run a second pass where the
3756 prologue is not skipped (SKIP is false). */
3761 /* Be conservative - allow direct PC (without skipping prologue) only if we
3762 have proven the CU (Compilation Unit) supports it. sal->SYMTAB does not
3763 have to be set by the caller so we use SYM instead. */
3765 && COMPUNIT_LOCATIONS_VALID (SYMTAB_COMPUNIT (symbol_symtab (sym))))
3773 /* If the function is in an unmapped overlay, use its unmapped LMA address,
3774 so that gdbarch_skip_prologue has something unique to work on. */
3775 if (section_is_overlay (section) && !section_is_mapped (section))
3776 pc = overlay_unmapped_address (pc, section);
3778 /* Skip "first line" of function (which is actually its prologue). */
3779 pc += gdbarch_deprecated_function_start_offset (gdbarch);
3780 if (gdbarch_skip_entrypoint_p (gdbarch))
3781 pc = gdbarch_skip_entrypoint (gdbarch, pc);
3783 pc = gdbarch_skip_prologue_noexcept (gdbarch, pc);
3785 /* For overlays, map pc back into its mapped VMA range. */
3786 pc = overlay_mapped_address (pc, section);
3788 /* Calculate line number. */
3789 start_sal = find_pc_sect_line (pc, section, 0);
3791 /* Check if gdbarch_skip_prologue left us in mid-line, and the next
3792 line is still part of the same function. */
3793 if (skip && start_sal.pc != pc
3794 && (sym ? (BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym)) <= start_sal.end
3795 && start_sal.end < BLOCK_END (SYMBOL_BLOCK_VALUE (sym)))
3796 : (lookup_minimal_symbol_by_pc_section (start_sal.end, section).minsym
3797 == lookup_minimal_symbol_by_pc_section (pc, section).minsym)))
3799 /* First pc of next line */
3801 /* Recalculate the line number (might not be N+1). */
3802 start_sal = find_pc_sect_line (pc, section, 0);
3805 /* On targets with executable formats that don't have a concept of
3806 constructors (ELF with .init has, PE doesn't), gcc emits a call
3807 to `__main' in `main' between the prologue and before user
3809 if (gdbarch_skip_main_prologue_p (gdbarch)
3810 && name && strcmp_iw (name, "main") == 0)
3812 pc = gdbarch_skip_main_prologue (gdbarch, pc);
3813 /* Recalculate the line number (might not be N+1). */
3814 start_sal = find_pc_sect_line (pc, section, 0);
3818 while (!force_skip && skip--);
3820 /* If we still don't have a valid source line, try to find the first
3821 PC in the lineinfo table that belongs to the same function. This
3822 happens with COFF debug info, which does not seem to have an
3823 entry in lineinfo table for the code after the prologue which has
3824 no direct relation to source. For example, this was found to be
3825 the case with the DJGPP target using "gcc -gcoff" when the
3826 compiler inserted code after the prologue to make sure the stack
3828 if (!force_skip && sym && start_sal.symtab == NULL)
3830 pc = skip_prologue_using_lineinfo (pc, symbol_symtab (sym));
3831 /* Recalculate the line number. */
3832 start_sal = find_pc_sect_line (pc, section, 0);
3835 /* If we're already past the prologue, leave SAL unchanged. Otherwise
3836 forward SAL to the end of the prologue. */
3841 sal->section = section;
3843 /* Unless the explicit_line flag was set, update the SAL line
3844 and symtab to correspond to the modified PC location. */
3845 if (sal->explicit_line)
3848 sal->symtab = start_sal.symtab;
3849 sal->line = start_sal.line;
3850 sal->end = start_sal.end;
3852 /* Check if we are now inside an inlined function. If we can,
3853 use the call site of the function instead. */
3854 b = block_for_pc_sect (sal->pc, sal->section);
3855 function_block = NULL;
3858 if (BLOCK_FUNCTION (b) != NULL && block_inlined_p (b))
3860 else if (BLOCK_FUNCTION (b) != NULL)
3862 b = BLOCK_SUPERBLOCK (b);
3864 if (function_block != NULL
3865 && SYMBOL_LINE (BLOCK_FUNCTION (function_block)) != 0)
3867 sal->line = SYMBOL_LINE (BLOCK_FUNCTION (function_block));
3868 sal->symtab = symbol_symtab (BLOCK_FUNCTION (function_block));
3872 /* Given PC at the function's start address, attempt to find the
3873 prologue end using SAL information. Return zero if the skip fails.
3875 A non-optimized prologue traditionally has one SAL for the function
3876 and a second for the function body. A single line function has
3877 them both pointing at the same line.
3879 An optimized prologue is similar but the prologue may contain
3880 instructions (SALs) from the instruction body. Need to skip those
3881 while not getting into the function body.
3883 The functions end point and an increasing SAL line are used as
3884 indicators of the prologue's endpoint.
3886 This code is based on the function refine_prologue_limit
3890 skip_prologue_using_sal (struct gdbarch *gdbarch, CORE_ADDR func_addr)
3892 struct symtab_and_line prologue_sal;
3895 const struct block *bl;
3897 /* Get an initial range for the function. */
3898 find_pc_partial_function (func_addr, NULL, &start_pc, &end_pc);
3899 start_pc += gdbarch_deprecated_function_start_offset (gdbarch);
3901 prologue_sal = find_pc_line (start_pc, 0);
3902 if (prologue_sal.line != 0)
3904 /* For languages other than assembly, treat two consecutive line
3905 entries at the same address as a zero-instruction prologue.
3906 The GNU assembler emits separate line notes for each instruction
3907 in a multi-instruction macro, but compilers generally will not
3909 if (prologue_sal.symtab->language != language_asm)
3911 struct linetable *linetable = SYMTAB_LINETABLE (prologue_sal.symtab);
3914 /* Skip any earlier lines, and any end-of-sequence marker
3915 from a previous function. */
3916 while (linetable->item[idx].pc != prologue_sal.pc
3917 || linetable->item[idx].line == 0)
3920 if (idx+1 < linetable->nitems
3921 && linetable->item[idx+1].line != 0
3922 && linetable->item[idx+1].pc == start_pc)
3926 /* If there is only one sal that covers the entire function,
3927 then it is probably a single line function, like
3929 if (prologue_sal.end >= end_pc)
3932 while (prologue_sal.end < end_pc)
3934 struct symtab_and_line sal;
3936 sal = find_pc_line (prologue_sal.end, 0);
3939 /* Assume that a consecutive SAL for the same (or larger)
3940 line mark the prologue -> body transition. */
3941 if (sal.line >= prologue_sal.line)
3943 /* Likewise if we are in a different symtab altogether
3944 (e.g. within a file included via #include). */
3945 if (sal.symtab != prologue_sal.symtab)
3948 /* The line number is smaller. Check that it's from the
3949 same function, not something inlined. If it's inlined,
3950 then there is no point comparing the line numbers. */
3951 bl = block_for_pc (prologue_sal.end);
3954 if (block_inlined_p (bl))
3956 if (BLOCK_FUNCTION (bl))
3961 bl = BLOCK_SUPERBLOCK (bl);
3966 /* The case in which compiler's optimizer/scheduler has
3967 moved instructions into the prologue. We look ahead in
3968 the function looking for address ranges whose
3969 corresponding line number is less the first one that we
3970 found for the function. This is more conservative then
3971 refine_prologue_limit which scans a large number of SALs
3972 looking for any in the prologue. */
3977 if (prologue_sal.end < end_pc)
3978 /* Return the end of this line, or zero if we could not find a
3980 return prologue_sal.end;
3982 /* Don't return END_PC, which is past the end of the function. */
3983 return prologue_sal.pc;
3989 find_function_alias_target (bound_minimal_symbol msymbol)
3991 CORE_ADDR func_addr;
3992 if (!msymbol_is_function (msymbol.objfile, msymbol.minsym, &func_addr))
3995 symbol *sym = find_pc_function (func_addr);
3997 && SYMBOL_CLASS (sym) == LOC_BLOCK
3998 && BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym)) == func_addr)
4005 /* If P is of the form "operator[ \t]+..." where `...' is
4006 some legitimate operator text, return a pointer to the
4007 beginning of the substring of the operator text.
4008 Otherwise, return "". */
4011 operator_chars (const char *p, const char **end)
4014 if (!startswith (p, CP_OPERATOR_STR))
4016 p += CP_OPERATOR_LEN;
4018 /* Don't get faked out by `operator' being part of a longer
4020 if (isalpha (*p) || *p == '_' || *p == '$' || *p == '\0')
4023 /* Allow some whitespace between `operator' and the operator symbol. */
4024 while (*p == ' ' || *p == '\t')
4027 /* Recognize 'operator TYPENAME'. */
4029 if (isalpha (*p) || *p == '_' || *p == '$')
4031 const char *q = p + 1;
4033 while (isalnum (*q) || *q == '_' || *q == '$')
4042 case '\\': /* regexp quoting */
4045 if (p[2] == '=') /* 'operator\*=' */
4047 else /* 'operator\*' */
4051 else if (p[1] == '[')
4054 error (_("mismatched quoting on brackets, "
4055 "try 'operator\\[\\]'"));
4056 else if (p[2] == '\\' && p[3] == ']')
4058 *end = p + 4; /* 'operator\[\]' */
4062 error (_("nothing is allowed between '[' and ']'"));
4066 /* Gratuitous qoute: skip it and move on. */
4088 if (p[0] == '-' && p[1] == '>')
4090 /* Struct pointer member operator 'operator->'. */
4093 *end = p + 3; /* 'operator->*' */
4096 else if (p[2] == '\\')
4098 *end = p + 4; /* Hopefully 'operator->\*' */
4103 *end = p + 2; /* 'operator->' */
4107 if (p[1] == '=' || p[1] == p[0])
4118 error (_("`operator ()' must be specified "
4119 "without whitespace in `()'"));
4124 error (_("`operator ?:' must be specified "
4125 "without whitespace in `?:'"));
4130 error (_("`operator []' must be specified "
4131 "without whitespace in `[]'"));
4135 error (_("`operator %s' not supported"), p);
4144 /* Data structure to maintain printing state for output_source_filename. */
4146 struct output_source_filename_data
4148 /* Cache of what we've seen so far. */
4149 struct filename_seen_cache *filename_seen_cache;
4151 /* Flag of whether we're printing the first one. */
4155 /* Slave routine for sources_info. Force line breaks at ,'s.
4156 NAME is the name to print.
4157 DATA contains the state for printing and watching for duplicates. */
4160 output_source_filename (const char *name,
4161 struct output_source_filename_data *data)
4163 /* Since a single source file can result in several partial symbol
4164 tables, we need to avoid printing it more than once. Note: if
4165 some of the psymtabs are read in and some are not, it gets
4166 printed both under "Source files for which symbols have been
4167 read" and "Source files for which symbols will be read in on
4168 demand". I consider this a reasonable way to deal with the
4169 situation. I'm not sure whether this can also happen for
4170 symtabs; it doesn't hurt to check. */
4172 /* Was NAME already seen? */
4173 if (data->filename_seen_cache->seen (name))
4175 /* Yes; don't print it again. */
4179 /* No; print it and reset *FIRST. */
4181 printf_filtered (", ");
4185 fputs_styled (name, file_name_style.style (), gdb_stdout);
4188 /* A callback for map_partial_symbol_filenames. */
4191 output_partial_symbol_filename (const char *filename, const char *fullname,
4194 output_source_filename (fullname ? fullname : filename,
4195 (struct output_source_filename_data *) data);
4199 info_sources_command (const char *ignore, int from_tty)
4201 struct output_source_filename_data data;
4203 if (!have_full_symbols () && !have_partial_symbols ())
4205 error (_("No symbol table is loaded. Use the \"file\" command."));
4208 filename_seen_cache filenames_seen;
4210 data.filename_seen_cache = &filenames_seen;
4212 printf_filtered ("Source files for which symbols have been read in:\n\n");
4215 for (objfile *objfile : current_program_space->objfiles ())
4217 for (compunit_symtab *cu : objfile->compunits ())
4219 for (symtab *s : compunit_filetabs (cu))
4221 const char *fullname = symtab_to_fullname (s);
4223 output_source_filename (fullname, &data);
4227 printf_filtered ("\n\n");
4229 printf_filtered ("Source files for which symbols "
4230 "will be read in on demand:\n\n");
4232 filenames_seen.clear ();
4234 map_symbol_filenames (output_partial_symbol_filename, &data,
4235 1 /*need_fullname*/);
4236 printf_filtered ("\n");
4239 /* Compare FILE against all the NFILES entries of FILES. If BASENAMES is
4240 non-zero compare only lbasename of FILES. */
4243 file_matches (const char *file, const char *files[], int nfiles, int basenames)
4247 if (file != NULL && nfiles != 0)
4249 for (i = 0; i < nfiles; i++)
4251 if (compare_filenames_for_search (file, (basenames
4252 ? lbasename (files[i])
4257 else if (nfiles == 0)
4262 /* Helper function for sort_search_symbols_remove_dups and qsort. Can only
4263 sort symbols, not minimal symbols. */
4266 symbol_search::compare_search_syms (const symbol_search &sym_a,
4267 const symbol_search &sym_b)
4271 c = FILENAME_CMP (symbol_symtab (sym_a.symbol)->filename,
4272 symbol_symtab (sym_b.symbol)->filename);
4276 if (sym_a.block != sym_b.block)
4277 return sym_a.block - sym_b.block;
4279 return strcmp (SYMBOL_PRINT_NAME (sym_a.symbol),
4280 SYMBOL_PRINT_NAME (sym_b.symbol));
4283 /* Returns true if the type_name of symbol_type of SYM matches TREG.
4284 If SYM has no symbol_type or symbol_name, returns false. */
4287 treg_matches_sym_type_name (const compiled_regex &treg,
4288 const struct symbol *sym)
4290 struct type *sym_type;
4291 std::string printed_sym_type_name;
4293 if (symbol_lookup_debug > 1)
4295 fprintf_unfiltered (gdb_stdlog,
4296 "treg_matches_sym_type_name\n sym %s\n",
4297 SYMBOL_NATURAL_NAME (sym));
4300 sym_type = SYMBOL_TYPE (sym);
4301 if (sym_type == NULL)
4305 scoped_switch_to_sym_language_if_auto l (sym);
4307 printed_sym_type_name = type_to_string (sym_type);
4311 if (symbol_lookup_debug > 1)
4313 fprintf_unfiltered (gdb_stdlog,
4314 " sym_type_name %s\n",
4315 printed_sym_type_name.c_str ());
4319 if (printed_sym_type_name.empty ())
4322 return treg.exec (printed_sym_type_name.c_str (), 0, NULL, 0) == 0;
4326 /* Sort the symbols in RESULT and remove duplicates. */
4329 sort_search_symbols_remove_dups (std::vector<symbol_search> *result)
4331 std::sort (result->begin (), result->end ());
4332 result->erase (std::unique (result->begin (), result->end ()),
4336 /* Search the symbol table for matches to the regular expression REGEXP,
4337 returning the results.
4339 Only symbols of KIND are searched:
4340 VARIABLES_DOMAIN - search all symbols, excluding functions, type names,
4341 and constants (enums).
4342 if T_REGEXP is not NULL, only returns var that have
4343 a type matching regular expression T_REGEXP.
4344 FUNCTIONS_DOMAIN - search all functions
4345 TYPES_DOMAIN - search all type names
4346 ALL_DOMAIN - an internal error for this function
4348 Within each file the results are sorted locally; each symtab's global and
4349 static blocks are separately alphabetized.
4350 Duplicate entries are removed. */
4352 std::vector<symbol_search>
4353 search_symbols (const char *regexp, enum search_domain kind,
4354 const char *t_regexp,
4355 int nfiles, const char *files[])
4357 const struct blockvector *bv;
4358 const struct block *b;
4360 struct block_iterator iter;
4363 static const enum minimal_symbol_type types[]
4364 = {mst_data, mst_text, mst_abs};
4365 static const enum minimal_symbol_type types2[]
4366 = {mst_bss, mst_file_text, mst_abs};
4367 static const enum minimal_symbol_type types3[]
4368 = {mst_file_data, mst_solib_trampoline, mst_abs};
4369 static const enum minimal_symbol_type types4[]
4370 = {mst_file_bss, mst_text_gnu_ifunc, mst_abs};
4371 enum minimal_symbol_type ourtype;
4372 enum minimal_symbol_type ourtype2;
4373 enum minimal_symbol_type ourtype3;
4374 enum minimal_symbol_type ourtype4;
4375 std::vector<symbol_search> result;
4376 gdb::optional<compiled_regex> preg;
4377 gdb::optional<compiled_regex> treg;
4379 gdb_assert (kind <= TYPES_DOMAIN);
4381 ourtype = types[kind];
4382 ourtype2 = types2[kind];
4383 ourtype3 = types3[kind];
4384 ourtype4 = types4[kind];
4388 /* Make sure spacing is right for C++ operators.
4389 This is just a courtesy to make the matching less sensitive
4390 to how many spaces the user leaves between 'operator'
4391 and <TYPENAME> or <OPERATOR>. */
4393 const char *opname = operator_chars (regexp, &opend);
4397 int fix = -1; /* -1 means ok; otherwise number of
4400 if (isalpha (*opname) || *opname == '_' || *opname == '$')
4402 /* There should 1 space between 'operator' and 'TYPENAME'. */
4403 if (opname[-1] != ' ' || opname[-2] == ' ')
4408 /* There should 0 spaces between 'operator' and 'OPERATOR'. */
4409 if (opname[-1] == ' ')
4412 /* If wrong number of spaces, fix it. */
4415 char *tmp = (char *) alloca (8 + fix + strlen (opname) + 1);
4417 sprintf (tmp, "operator%.*s%s", fix, " ", opname);
4422 int cflags = REG_NOSUB | (case_sensitivity == case_sensitive_off
4424 preg.emplace (regexp, cflags, _("Invalid regexp"));
4427 if (t_regexp != NULL)
4429 int cflags = REG_NOSUB | (case_sensitivity == case_sensitive_off
4431 treg.emplace (t_regexp, cflags, _("Invalid regexp"));
4434 /* Search through the partial symtabs *first* for all symbols
4435 matching the regexp. That way we don't have to reproduce all of
4436 the machinery below. */
4437 expand_symtabs_matching ([&] (const char *filename, bool basenames)
4439 return file_matches (filename, files, nfiles,
4442 lookup_name_info::match_any (),
4443 [&] (const char *symname)
4445 return (!preg.has_value ()
4446 || preg->exec (symname,
4452 /* Here, we search through the minimal symbol tables for functions
4453 and variables that match, and force their symbols to be read.
4454 This is in particular necessary for demangled variable names,
4455 which are no longer put into the partial symbol tables.
4456 The symbol will then be found during the scan of symtabs below.
4458 For functions, find_pc_symtab should succeed if we have debug info
4459 for the function, for variables we have to call
4460 lookup_symbol_in_objfile_from_linkage_name to determine if the variable
4462 If the lookup fails, set found_misc so that we will rescan to print
4463 any matching symbols without debug info.
4464 We only search the objfile the msymbol came from, we no longer search
4465 all objfiles. In large programs (1000s of shared libs) searching all
4466 objfiles is not worth the pain. */
4468 if (nfiles == 0 && (kind == VARIABLES_DOMAIN || kind == FUNCTIONS_DOMAIN))
4470 for (objfile *objfile : current_program_space->objfiles ())
4472 for (minimal_symbol *msymbol : objfile->msymbols ())
4476 if (msymbol->created_by_gdb)
4479 if (MSYMBOL_TYPE (msymbol) == ourtype
4480 || MSYMBOL_TYPE (msymbol) == ourtype2
4481 || MSYMBOL_TYPE (msymbol) == ourtype3
4482 || MSYMBOL_TYPE (msymbol) == ourtype4)
4484 if (!preg.has_value ()
4485 || preg->exec (MSYMBOL_NATURAL_NAME (msymbol), 0,
4488 /* Note: An important side-effect of these
4489 lookup functions is to expand the symbol
4490 table if msymbol is found, for the benefit of
4491 the next loop on compunits. */
4492 if (kind == FUNCTIONS_DOMAIN
4493 ? (find_pc_compunit_symtab
4494 (MSYMBOL_VALUE_ADDRESS (objfile, msymbol))
4496 : (lookup_symbol_in_objfile_from_linkage_name
4497 (objfile, MSYMBOL_LINKAGE_NAME (msymbol),
4507 for (objfile *objfile : current_program_space->objfiles ())
4509 for (compunit_symtab *cust : objfile->compunits ())
4511 bv = COMPUNIT_BLOCKVECTOR (cust);
4512 for (i = GLOBAL_BLOCK; i <= STATIC_BLOCK; i++)
4514 b = BLOCKVECTOR_BLOCK (bv, i);
4515 ALL_BLOCK_SYMBOLS (b, iter, sym)
4517 struct symtab *real_symtab = symbol_symtab (sym);
4521 /* Check first sole REAL_SYMTAB->FILENAME. It does
4522 not need to be a substring of symtab_to_fullname as
4523 it may contain "./" etc. */
4524 if ((file_matches (real_symtab->filename, files, nfiles, 0)
4525 || ((basenames_may_differ
4526 || file_matches (lbasename (real_symtab->filename),
4528 && file_matches (symtab_to_fullname (real_symtab),
4530 && ((!preg.has_value ()
4531 || preg->exec (SYMBOL_NATURAL_NAME (sym), 0,
4533 && ((kind == VARIABLES_DOMAIN
4534 && SYMBOL_CLASS (sym) != LOC_TYPEDEF
4535 && SYMBOL_CLASS (sym) != LOC_UNRESOLVED
4536 && SYMBOL_CLASS (sym) != LOC_BLOCK
4537 /* LOC_CONST can be used for more than
4538 just enums, e.g., c++ static const
4539 members. We only want to skip enums
4541 && !(SYMBOL_CLASS (sym) == LOC_CONST
4542 && (TYPE_CODE (SYMBOL_TYPE (sym))
4544 && (!treg.has_value ()
4545 || treg_matches_sym_type_name (*treg, sym)))
4546 || (kind == FUNCTIONS_DOMAIN
4547 && SYMBOL_CLASS (sym) == LOC_BLOCK
4548 && (!treg.has_value ()
4549 || treg_matches_sym_type_name (*treg,
4551 || (kind == TYPES_DOMAIN
4552 && SYMBOL_CLASS (sym) == LOC_TYPEDEF))))
4555 result.emplace_back (i, sym);
4562 if (!result.empty ())
4563 sort_search_symbols_remove_dups (&result);
4565 /* If there are no eyes, avoid all contact. I mean, if there are
4566 no debug symbols, then add matching minsyms. But if the user wants
4567 to see symbols matching a type regexp, then never give a minimal symbol,
4568 as we assume that a minimal symbol does not have a type. */
4570 if ((found_misc || (nfiles == 0 && kind != FUNCTIONS_DOMAIN))
4571 && !treg.has_value ())
4573 for (objfile *objfile : current_program_space->objfiles ())
4575 for (minimal_symbol *msymbol : objfile->msymbols ())
4579 if (msymbol->created_by_gdb)
4582 if (MSYMBOL_TYPE (msymbol) == ourtype
4583 || MSYMBOL_TYPE (msymbol) == ourtype2
4584 || MSYMBOL_TYPE (msymbol) == ourtype3
4585 || MSYMBOL_TYPE (msymbol) == ourtype4)
4587 if (!preg.has_value ()
4588 || preg->exec (MSYMBOL_NATURAL_NAME (msymbol), 0,
4591 /* For functions we can do a quick check of whether the
4592 symbol might be found via find_pc_symtab. */
4593 if (kind != FUNCTIONS_DOMAIN
4594 || (find_pc_compunit_symtab
4595 (MSYMBOL_VALUE_ADDRESS (objfile, msymbol))
4598 if (lookup_symbol_in_objfile_from_linkage_name
4599 (objfile, MSYMBOL_LINKAGE_NAME (msymbol),
4604 result.emplace_back (i, msymbol, objfile);
4616 /* Helper function for symtab_symbol_info, this function uses
4617 the data returned from search_symbols() to print information
4618 regarding the match to gdb_stdout. If LAST is not NULL,
4619 print file and line number information for the symbol as
4620 well. Skip printing the filename if it matches LAST. */
4623 print_symbol_info (enum search_domain kind,
4625 int block, const char *last)
4627 scoped_switch_to_sym_language_if_auto l (sym);
4628 struct symtab *s = symbol_symtab (sym);
4632 const char *s_filename = symtab_to_filename_for_display (s);
4634 if (filename_cmp (last, s_filename) != 0)
4636 fputs_filtered ("\nFile ", gdb_stdout);
4637 fputs_styled (s_filename, file_name_style.style (), gdb_stdout);
4638 fputs_filtered (":\n", gdb_stdout);
4641 if (SYMBOL_LINE (sym) != 0)
4642 printf_filtered ("%d:\t", SYMBOL_LINE (sym));
4644 puts_filtered ("\t");
4647 if (kind != TYPES_DOMAIN && block == STATIC_BLOCK)
4648 printf_filtered ("static ");
4650 /* Typedef that is not a C++ class. */
4651 if (kind == TYPES_DOMAIN
4652 && SYMBOL_DOMAIN (sym) != STRUCT_DOMAIN)
4653 typedef_print (SYMBOL_TYPE (sym), sym, gdb_stdout);
4654 /* variable, func, or typedef-that-is-c++-class. */
4655 else if (kind < TYPES_DOMAIN
4656 || (kind == TYPES_DOMAIN
4657 && SYMBOL_DOMAIN (sym) == STRUCT_DOMAIN))
4659 type_print (SYMBOL_TYPE (sym),
4660 (SYMBOL_CLASS (sym) == LOC_TYPEDEF
4661 ? "" : SYMBOL_PRINT_NAME (sym)),
4664 printf_filtered (";\n");
4668 /* This help function for symtab_symbol_info() prints information
4669 for non-debugging symbols to gdb_stdout. */
4672 print_msymbol_info (struct bound_minimal_symbol msymbol)
4674 struct gdbarch *gdbarch = get_objfile_arch (msymbol.objfile);
4677 if (gdbarch_addr_bit (gdbarch) <= 32)
4678 tmp = hex_string_custom (BMSYMBOL_VALUE_ADDRESS (msymbol)
4679 & (CORE_ADDR) 0xffffffff,
4682 tmp = hex_string_custom (BMSYMBOL_VALUE_ADDRESS (msymbol),
4684 fputs_styled (tmp, address_style.style (), gdb_stdout);
4685 fputs_filtered (" ", gdb_stdout);
4686 if (msymbol.minsym->text_p ())
4687 fputs_styled (MSYMBOL_PRINT_NAME (msymbol.minsym),
4688 function_name_style.style (),
4691 fputs_filtered (MSYMBOL_PRINT_NAME (msymbol.minsym), gdb_stdout);
4692 fputs_filtered ("\n", gdb_stdout);
4695 /* This is the guts of the commands "info functions", "info types", and
4696 "info variables". It calls search_symbols to find all matches and then
4697 print_[m]symbol_info to print out some useful information about the
4701 symtab_symbol_info (bool quiet,
4702 const char *regexp, enum search_domain kind,
4703 const char *t_regexp, int from_tty)
4705 static const char * const classnames[] =
4706 {"variable", "function", "type"};
4707 const char *last_filename = "";
4710 gdb_assert (kind <= TYPES_DOMAIN);
4712 /* Must make sure that if we're interrupted, symbols gets freed. */
4713 std::vector<symbol_search> symbols = search_symbols (regexp, kind,
4720 if (t_regexp != NULL)
4722 (_("All %ss matching regular expression \"%s\""
4723 " with type matching regular expression \"%s\":\n"),
4724 classnames[kind], regexp, t_regexp);
4726 printf_filtered (_("All %ss matching regular expression \"%s\":\n"),
4727 classnames[kind], regexp);
4731 if (t_regexp != NULL)
4733 (_("All defined %ss"
4734 " with type matching regular expression \"%s\" :\n"),
4735 classnames[kind], t_regexp);
4737 printf_filtered (_("All defined %ss:\n"), classnames[kind]);
4741 for (const symbol_search &p : symbols)
4745 if (p.msymbol.minsym != NULL)
4750 printf_filtered (_("\nNon-debugging symbols:\n"));
4753 print_msymbol_info (p.msymbol);
4757 print_symbol_info (kind,
4762 = symtab_to_filename_for_display (symbol_symtab (p.symbol));
4768 info_variables_command (const char *args, int from_tty)
4771 std::string t_regexp;
4775 && extract_info_print_args (&args, &quiet, ®exp, &t_regexp))
4779 report_unrecognized_option_error ("info variables", args);
4781 symtab_symbol_info (quiet,
4782 regexp.empty () ? NULL : regexp.c_str (),
4784 t_regexp.empty () ? NULL : t_regexp.c_str (),
4790 info_functions_command (const char *args, int from_tty)
4793 std::string t_regexp;
4797 && extract_info_print_args (&args, &quiet, ®exp, &t_regexp))
4801 report_unrecognized_option_error ("info functions", args);
4803 symtab_symbol_info (quiet,
4804 regexp.empty () ? NULL : regexp.c_str (),
4806 t_regexp.empty () ? NULL : t_regexp.c_str (),
4812 info_types_command (const char *regexp, int from_tty)
4814 symtab_symbol_info (false, regexp, TYPES_DOMAIN, NULL, from_tty);
4817 /* Breakpoint all functions matching regular expression. */
4820 rbreak_command_wrapper (char *regexp, int from_tty)
4822 rbreak_command (regexp, from_tty);
4826 rbreak_command (const char *regexp, int from_tty)
4829 const char **files = NULL;
4830 const char *file_name;
4835 const char *colon = strchr (regexp, ':');
4837 if (colon && *(colon + 1) != ':')
4842 colon_index = colon - regexp;
4843 local_name = (char *) alloca (colon_index + 1);
4844 memcpy (local_name, regexp, colon_index);
4845 local_name[colon_index--] = 0;
4846 while (isspace (local_name[colon_index]))
4847 local_name[colon_index--] = 0;
4848 file_name = local_name;
4851 regexp = skip_spaces (colon + 1);
4855 std::vector<symbol_search> symbols = search_symbols (regexp,
4860 scoped_rbreak_breakpoints finalize;
4861 for (const symbol_search &p : symbols)
4863 if (p.msymbol.minsym == NULL)
4865 struct symtab *symtab = symbol_symtab (p.symbol);
4866 const char *fullname = symtab_to_fullname (symtab);
4868 string = string_printf ("%s:'%s'", fullname,
4869 SYMBOL_LINKAGE_NAME (p.symbol));
4870 break_command (&string[0], from_tty);
4871 print_symbol_info (FUNCTIONS_DOMAIN, p.symbol, p.block, NULL);
4875 string = string_printf ("'%s'",
4876 MSYMBOL_LINKAGE_NAME (p.msymbol.minsym));
4878 break_command (&string[0], from_tty);
4879 printf_filtered ("<function, no debug info> %s;\n",
4880 MSYMBOL_PRINT_NAME (p.msymbol.minsym));
4886 /* Evaluate if SYMNAME matches LOOKUP_NAME. */
4889 compare_symbol_name (const char *symbol_name, language symbol_language,
4890 const lookup_name_info &lookup_name,
4891 completion_match_result &match_res)
4893 const language_defn *lang = language_def (symbol_language);
4895 symbol_name_matcher_ftype *name_match
4896 = get_symbol_name_matcher (lang, lookup_name);
4898 return name_match (symbol_name, lookup_name, &match_res);
4904 completion_list_add_name (completion_tracker &tracker,
4905 language symbol_language,
4906 const char *symname,
4907 const lookup_name_info &lookup_name,
4908 const char *text, const char *word)
4910 completion_match_result &match_res
4911 = tracker.reset_completion_match_result ();
4913 /* Clip symbols that cannot match. */
4914 if (!compare_symbol_name (symname, symbol_language, lookup_name, match_res))
4917 /* Refresh SYMNAME from the match string. It's potentially
4918 different depending on language. (E.g., on Ada, the match may be
4919 the encoded symbol name wrapped in "<>"). */
4920 symname = match_res.match.match ();
4921 gdb_assert (symname != NULL);
4923 /* We have a match for a completion, so add SYMNAME to the current list
4924 of matches. Note that the name is moved to freshly malloc'd space. */
4927 gdb::unique_xmalloc_ptr<char> completion
4928 = make_completion_match_str (symname, text, word);
4930 /* Here we pass the match-for-lcd object to add_completion. Some
4931 languages match the user text against substrings of symbol
4932 names in some cases. E.g., in C++, "b push_ba" completes to
4933 "std::vector::push_back", "std::string::push_back", etc., and
4934 in this case we want the completion lowest common denominator
4935 to be "push_back" instead of "std::". */
4936 tracker.add_completion (std::move (completion),
4937 &match_res.match_for_lcd, text, word);
4941 /* completion_list_add_name wrapper for struct symbol. */
4944 completion_list_add_symbol (completion_tracker &tracker,
4946 const lookup_name_info &lookup_name,
4947 const char *text, const char *word)
4949 completion_list_add_name (tracker, SYMBOL_LANGUAGE (sym),
4950 SYMBOL_NATURAL_NAME (sym),
4951 lookup_name, text, word);
4954 /* completion_list_add_name wrapper for struct minimal_symbol. */
4957 completion_list_add_msymbol (completion_tracker &tracker,
4958 minimal_symbol *sym,
4959 const lookup_name_info &lookup_name,
4960 const char *text, const char *word)
4962 completion_list_add_name (tracker, MSYMBOL_LANGUAGE (sym),
4963 MSYMBOL_NATURAL_NAME (sym),
4964 lookup_name, text, word);
4968 /* ObjC: In case we are completing on a selector, look as the msymbol
4969 again and feed all the selectors into the mill. */
4972 completion_list_objc_symbol (completion_tracker &tracker,
4973 struct minimal_symbol *msymbol,
4974 const lookup_name_info &lookup_name,
4975 const char *text, const char *word)
4977 static char *tmp = NULL;
4978 static unsigned int tmplen = 0;
4980 const char *method, *category, *selector;
4983 method = MSYMBOL_NATURAL_NAME (msymbol);
4985 /* Is it a method? */
4986 if ((method[0] != '-') && (method[0] != '+'))
4990 /* Complete on shortened method method. */
4991 completion_list_add_name (tracker, language_objc,
4996 while ((strlen (method) + 1) >= tmplen)
5002 tmp = (char *) xrealloc (tmp, tmplen);
5004 selector = strchr (method, ' ');
5005 if (selector != NULL)
5008 category = strchr (method, '(');
5010 if ((category != NULL) && (selector != NULL))
5012 memcpy (tmp, method, (category - method));
5013 tmp[category - method] = ' ';
5014 memcpy (tmp + (category - method) + 1, selector, strlen (selector) + 1);
5015 completion_list_add_name (tracker, language_objc, tmp,
5016 lookup_name, text, word);
5018 completion_list_add_name (tracker, language_objc, tmp + 1,
5019 lookup_name, text, word);
5022 if (selector != NULL)
5024 /* Complete on selector only. */
5025 strcpy (tmp, selector);
5026 tmp2 = strchr (tmp, ']');
5030 completion_list_add_name (tracker, language_objc, tmp,
5031 lookup_name, text, word);
5035 /* Break the non-quoted text based on the characters which are in
5036 symbols. FIXME: This should probably be language-specific. */
5039 language_search_unquoted_string (const char *text, const char *p)
5041 for (; p > text; --p)
5043 if (isalnum (p[-1]) || p[-1] == '_' || p[-1] == '\0')
5047 if ((current_language->la_language == language_objc))
5049 if (p[-1] == ':') /* Might be part of a method name. */
5051 else if (p[-1] == '[' && (p[-2] == '-' || p[-2] == '+'))
5052 p -= 2; /* Beginning of a method name. */
5053 else if (p[-1] == ' ' || p[-1] == '(' || p[-1] == ')')
5054 { /* Might be part of a method name. */
5057 /* Seeing a ' ' or a '(' is not conclusive evidence
5058 that we are in the middle of a method name. However,
5059 finding "-[" or "+[" should be pretty un-ambiguous.
5060 Unfortunately we have to find it now to decide. */
5063 if (isalnum (t[-1]) || t[-1] == '_' ||
5064 t[-1] == ' ' || t[-1] == ':' ||
5065 t[-1] == '(' || t[-1] == ')')
5070 if (t[-1] == '[' && (t[-2] == '-' || t[-2] == '+'))
5071 p = t - 2; /* Method name detected. */
5072 /* Else we leave with p unchanged. */
5082 completion_list_add_fields (completion_tracker &tracker,
5084 const lookup_name_info &lookup_name,
5085 const char *text, const char *word)
5087 if (SYMBOL_CLASS (sym) == LOC_TYPEDEF)
5089 struct type *t = SYMBOL_TYPE (sym);
5090 enum type_code c = TYPE_CODE (t);
5093 if (c == TYPE_CODE_UNION || c == TYPE_CODE_STRUCT)
5094 for (j = TYPE_N_BASECLASSES (t); j < TYPE_NFIELDS (t); j++)
5095 if (TYPE_FIELD_NAME (t, j))
5096 completion_list_add_name (tracker, SYMBOL_LANGUAGE (sym),
5097 TYPE_FIELD_NAME (t, j),
5098 lookup_name, text, word);
5105 symbol_is_function_or_method (symbol *sym)
5107 switch (TYPE_CODE (SYMBOL_TYPE (sym)))
5109 case TYPE_CODE_FUNC:
5110 case TYPE_CODE_METHOD:
5120 symbol_is_function_or_method (minimal_symbol *msymbol)
5122 switch (MSYMBOL_TYPE (msymbol))
5125 case mst_text_gnu_ifunc:
5126 case mst_solib_trampoline:
5136 bound_minimal_symbol
5137 find_gnu_ifunc (const symbol *sym)
5139 if (SYMBOL_CLASS (sym) != LOC_BLOCK)
5142 lookup_name_info lookup_name (SYMBOL_SEARCH_NAME (sym),
5143 symbol_name_match_type::SEARCH_NAME);
5144 struct objfile *objfile = symbol_objfile (sym);
5146 CORE_ADDR address = BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym));
5147 minimal_symbol *ifunc = NULL;
5149 iterate_over_minimal_symbols (objfile, lookup_name,
5150 [&] (minimal_symbol *minsym)
5152 if (MSYMBOL_TYPE (minsym) == mst_text_gnu_ifunc
5153 || MSYMBOL_TYPE (minsym) == mst_data_gnu_ifunc)
5155 CORE_ADDR msym_addr = MSYMBOL_VALUE_ADDRESS (objfile, minsym);
5156 if (MSYMBOL_TYPE (minsym) == mst_data_gnu_ifunc)
5158 struct gdbarch *gdbarch = get_objfile_arch (objfile);
5160 = gdbarch_convert_from_func_ptr_addr (gdbarch,
5162 current_top_target ());
5164 if (msym_addr == address)
5174 return {ifunc, objfile};
5178 /* Add matching symbols from SYMTAB to the current completion list. */
5181 add_symtab_completions (struct compunit_symtab *cust,
5182 completion_tracker &tracker,
5183 complete_symbol_mode mode,
5184 const lookup_name_info &lookup_name,
5185 const char *text, const char *word,
5186 enum type_code code)
5189 const struct block *b;
5190 struct block_iterator iter;
5196 for (i = GLOBAL_BLOCK; i <= STATIC_BLOCK; i++)
5199 b = BLOCKVECTOR_BLOCK (COMPUNIT_BLOCKVECTOR (cust), i);
5200 ALL_BLOCK_SYMBOLS (b, iter, sym)
5202 if (completion_skip_symbol (mode, sym))
5205 if (code == TYPE_CODE_UNDEF
5206 || (SYMBOL_DOMAIN (sym) == STRUCT_DOMAIN
5207 && TYPE_CODE (SYMBOL_TYPE (sym)) == code))
5208 completion_list_add_symbol (tracker, sym,
5216 default_collect_symbol_completion_matches_break_on
5217 (completion_tracker &tracker, complete_symbol_mode mode,
5218 symbol_name_match_type name_match_type,
5219 const char *text, const char *word,
5220 const char *break_on, enum type_code code)
5222 /* Problem: All of the symbols have to be copied because readline
5223 frees them. I'm not going to worry about this; hopefully there
5224 won't be that many. */
5227 const struct block *b;
5228 const struct block *surrounding_static_block, *surrounding_global_block;
5229 struct block_iterator iter;
5230 /* The symbol we are completing on. Points in same buffer as text. */
5231 const char *sym_text;
5233 /* Now look for the symbol we are supposed to complete on. */
5234 if (mode == complete_symbol_mode::LINESPEC)
5240 const char *quote_pos = NULL;
5242 /* First see if this is a quoted string. */
5244 for (p = text; *p != '\0'; ++p)
5246 if (quote_found != '\0')
5248 if (*p == quote_found)
5249 /* Found close quote. */
5251 else if (*p == '\\' && p[1] == quote_found)
5252 /* A backslash followed by the quote character
5253 doesn't end the string. */
5256 else if (*p == '\'' || *p == '"')
5262 if (quote_found == '\'')
5263 /* A string within single quotes can be a symbol, so complete on it. */
5264 sym_text = quote_pos + 1;
5265 else if (quote_found == '"')
5266 /* A double-quoted string is never a symbol, nor does it make sense
5267 to complete it any other way. */
5273 /* It is not a quoted string. Break it based on the characters
5274 which are in symbols. */
5277 if (isalnum (p[-1]) || p[-1] == '_' || p[-1] == '\0'
5278 || p[-1] == ':' || strchr (break_on, p[-1]) != NULL)
5287 lookup_name_info lookup_name (sym_text, name_match_type, true);
5289 /* At this point scan through the misc symbol vectors and add each
5290 symbol you find to the list. Eventually we want to ignore
5291 anything that isn't a text symbol (everything else will be
5292 handled by the psymtab code below). */
5294 if (code == TYPE_CODE_UNDEF)
5296 for (objfile *objfile : current_program_space->objfiles ())
5298 for (minimal_symbol *msymbol : objfile->msymbols ())
5302 if (completion_skip_symbol (mode, msymbol))
5305 completion_list_add_msymbol (tracker, msymbol, lookup_name,
5308 completion_list_objc_symbol (tracker, msymbol, lookup_name,
5314 /* Add completions for all currently loaded symbol tables. */
5315 for (objfile *objfile : current_program_space->objfiles ())
5317 for (compunit_symtab *cust : objfile->compunits ())
5318 add_symtab_completions (cust, tracker, mode, lookup_name,
5319 sym_text, word, code);
5322 /* Look through the partial symtabs for all symbols which begin by
5323 matching SYM_TEXT. Expand all CUs that you find to the list. */
5324 expand_symtabs_matching (NULL,
5327 [&] (compunit_symtab *symtab) /* expansion notify */
5329 add_symtab_completions (symtab,
5330 tracker, mode, lookup_name,
5331 sym_text, word, code);
5335 /* Search upwards from currently selected frame (so that we can
5336 complete on local vars). Also catch fields of types defined in
5337 this places which match our text string. Only complete on types
5338 visible from current context. */
5340 b = get_selected_block (0);
5341 surrounding_static_block = block_static_block (b);
5342 surrounding_global_block = block_global_block (b);
5343 if (surrounding_static_block != NULL)
5344 while (b != surrounding_static_block)
5348 ALL_BLOCK_SYMBOLS (b, iter, sym)
5350 if (code == TYPE_CODE_UNDEF)
5352 completion_list_add_symbol (tracker, sym, lookup_name,
5354 completion_list_add_fields (tracker, sym, lookup_name,
5357 else if (SYMBOL_DOMAIN (sym) == STRUCT_DOMAIN
5358 && TYPE_CODE (SYMBOL_TYPE (sym)) == code)
5359 completion_list_add_symbol (tracker, sym, lookup_name,
5363 /* Stop when we encounter an enclosing function. Do not stop for
5364 non-inlined functions - the locals of the enclosing function
5365 are in scope for a nested function. */
5366 if (BLOCK_FUNCTION (b) != NULL && block_inlined_p (b))
5368 b = BLOCK_SUPERBLOCK (b);
5371 /* Add fields from the file's types; symbols will be added below. */
5373 if (code == TYPE_CODE_UNDEF)
5375 if (surrounding_static_block != NULL)
5376 ALL_BLOCK_SYMBOLS (surrounding_static_block, iter, sym)
5377 completion_list_add_fields (tracker, sym, lookup_name,
5380 if (surrounding_global_block != NULL)
5381 ALL_BLOCK_SYMBOLS (surrounding_global_block, iter, sym)
5382 completion_list_add_fields (tracker, sym, lookup_name,
5386 /* Skip macros if we are completing a struct tag -- arguable but
5387 usually what is expected. */
5388 if (current_language->la_macro_expansion == macro_expansion_c
5389 && code == TYPE_CODE_UNDEF)
5391 gdb::unique_xmalloc_ptr<struct macro_scope> scope;
5393 /* This adds a macro's name to the current completion list. */
5394 auto add_macro_name = [&] (const char *macro_name,
5395 const macro_definition *,
5396 macro_source_file *,
5399 completion_list_add_name (tracker, language_c, macro_name,
5400 lookup_name, sym_text, word);
5403 /* Add any macros visible in the default scope. Note that this
5404 may yield the occasional wrong result, because an expression
5405 might be evaluated in a scope other than the default. For
5406 example, if the user types "break file:line if <TAB>", the
5407 resulting expression will be evaluated at "file:line" -- but
5408 at there does not seem to be a way to detect this at
5410 scope = default_macro_scope ();
5412 macro_for_each_in_scope (scope->file, scope->line,
5415 /* User-defined macros are always visible. */
5416 macro_for_each (macro_user_macros, add_macro_name);
5421 default_collect_symbol_completion_matches (completion_tracker &tracker,
5422 complete_symbol_mode mode,
5423 symbol_name_match_type name_match_type,
5424 const char *text, const char *word,
5425 enum type_code code)
5427 return default_collect_symbol_completion_matches_break_on (tracker, mode,
5433 /* Collect all symbols (regardless of class) which begin by matching
5437 collect_symbol_completion_matches (completion_tracker &tracker,
5438 complete_symbol_mode mode,
5439 symbol_name_match_type name_match_type,
5440 const char *text, const char *word)
5442 current_language->la_collect_symbol_completion_matches (tracker, mode,
5448 /* Like collect_symbol_completion_matches, but only collect
5449 STRUCT_DOMAIN symbols whose type code is CODE. */
5452 collect_symbol_completion_matches_type (completion_tracker &tracker,
5453 const char *text, const char *word,
5454 enum type_code code)
5456 complete_symbol_mode mode = complete_symbol_mode::EXPRESSION;
5457 symbol_name_match_type name_match_type = symbol_name_match_type::EXPRESSION;
5459 gdb_assert (code == TYPE_CODE_UNION
5460 || code == TYPE_CODE_STRUCT
5461 || code == TYPE_CODE_ENUM);
5462 current_language->la_collect_symbol_completion_matches (tracker, mode,
5467 /* Like collect_symbol_completion_matches, but collects a list of
5468 symbols defined in all source files named SRCFILE. */
5471 collect_file_symbol_completion_matches (completion_tracker &tracker,
5472 complete_symbol_mode mode,
5473 symbol_name_match_type name_match_type,
5474 const char *text, const char *word,
5475 const char *srcfile)
5477 /* The symbol we are completing on. Points in same buffer as text. */
5478 const char *sym_text;
5480 /* Now look for the symbol we are supposed to complete on.
5481 FIXME: This should be language-specific. */
5482 if (mode == complete_symbol_mode::LINESPEC)
5488 const char *quote_pos = NULL;
5490 /* First see if this is a quoted string. */
5492 for (p = text; *p != '\0'; ++p)
5494 if (quote_found != '\0')
5496 if (*p == quote_found)
5497 /* Found close quote. */
5499 else if (*p == '\\' && p[1] == quote_found)
5500 /* A backslash followed by the quote character
5501 doesn't end the string. */
5504 else if (*p == '\'' || *p == '"')
5510 if (quote_found == '\'')
5511 /* A string within single quotes can be a symbol, so complete on it. */
5512 sym_text = quote_pos + 1;
5513 else if (quote_found == '"')
5514 /* A double-quoted string is never a symbol, nor does it make sense
5515 to complete it any other way. */
5521 /* Not a quoted string. */
5522 sym_text = language_search_unquoted_string (text, p);
5526 lookup_name_info lookup_name (sym_text, name_match_type, true);
5528 /* Go through symtabs for SRCFILE and check the externs and statics
5529 for symbols which match. */
5530 iterate_over_symtabs (srcfile, [&] (symtab *s)
5532 add_symtab_completions (SYMTAB_COMPUNIT (s),
5533 tracker, mode, lookup_name,
5534 sym_text, word, TYPE_CODE_UNDEF);
5539 /* A helper function for make_source_files_completion_list. It adds
5540 another file name to a list of possible completions, growing the
5541 list as necessary. */
5544 add_filename_to_list (const char *fname, const char *text, const char *word,
5545 completion_list *list)
5547 list->emplace_back (make_completion_match_str (fname, text, word));
5551 not_interesting_fname (const char *fname)
5553 static const char *illegal_aliens[] = {
5554 "_globals_", /* inserted by coff_symtab_read */
5559 for (i = 0; illegal_aliens[i]; i++)
5561 if (filename_cmp (fname, illegal_aliens[i]) == 0)
5567 /* An object of this type is passed as the user_data argument to
5568 map_partial_symbol_filenames. */
5569 struct add_partial_filename_data
5571 struct filename_seen_cache *filename_seen_cache;
5575 completion_list *list;
5578 /* A callback for map_partial_symbol_filenames. */
5581 maybe_add_partial_symtab_filename (const char *filename, const char *fullname,
5584 struct add_partial_filename_data *data
5585 = (struct add_partial_filename_data *) user_data;
5587 if (not_interesting_fname (filename))
5589 if (!data->filename_seen_cache->seen (filename)
5590 && filename_ncmp (filename, data->text, data->text_len) == 0)
5592 /* This file matches for a completion; add it to the
5593 current list of matches. */
5594 add_filename_to_list (filename, data->text, data->word, data->list);
5598 const char *base_name = lbasename (filename);
5600 if (base_name != filename
5601 && !data->filename_seen_cache->seen (base_name)
5602 && filename_ncmp (base_name, data->text, data->text_len) == 0)
5603 add_filename_to_list (base_name, data->text, data->word, data->list);
5607 /* Return a list of all source files whose names begin with matching
5608 TEXT. The file names are looked up in the symbol tables of this
5612 make_source_files_completion_list (const char *text, const char *word)
5614 size_t text_len = strlen (text);
5615 completion_list list;
5616 const char *base_name;
5617 struct add_partial_filename_data datum;
5619 if (!have_full_symbols () && !have_partial_symbols ())
5622 filename_seen_cache filenames_seen;
5624 for (objfile *objfile : current_program_space->objfiles ())
5626 for (compunit_symtab *cu : objfile->compunits ())
5628 for (symtab *s : compunit_filetabs (cu))
5630 if (not_interesting_fname (s->filename))
5632 if (!filenames_seen.seen (s->filename)
5633 && filename_ncmp (s->filename, text, text_len) == 0)
5635 /* This file matches for a completion; add it to the current
5637 add_filename_to_list (s->filename, text, word, &list);
5641 /* NOTE: We allow the user to type a base name when the
5642 debug info records leading directories, but not the other
5643 way around. This is what subroutines of breakpoint
5644 command do when they parse file names. */
5645 base_name = lbasename (s->filename);
5646 if (base_name != s->filename
5647 && !filenames_seen.seen (base_name)
5648 && filename_ncmp (base_name, text, text_len) == 0)
5649 add_filename_to_list (base_name, text, word, &list);
5655 datum.filename_seen_cache = &filenames_seen;
5658 datum.text_len = text_len;
5660 map_symbol_filenames (maybe_add_partial_symtab_filename, &datum,
5661 0 /*need_fullname*/);
5668 /* Return the "main_info" object for the current program space. If
5669 the object has not yet been created, create it and fill in some
5672 static struct main_info *
5673 get_main_info (void)
5675 struct main_info *info = main_progspace_key.get (current_program_space);
5679 /* It may seem strange to store the main name in the progspace
5680 and also in whatever objfile happens to see a main name in
5681 its debug info. The reason for this is mainly historical:
5682 gdb returned "main" as the name even if no function named
5683 "main" was defined the program; and this approach lets us
5684 keep compatibility. */
5685 info = main_progspace_key.emplace (current_program_space);
5692 set_main_name (const char *name, enum language lang)
5694 struct main_info *info = get_main_info ();
5696 if (info->name_of_main != NULL)
5698 xfree (info->name_of_main);
5699 info->name_of_main = NULL;
5700 info->language_of_main = language_unknown;
5704 info->name_of_main = xstrdup (name);
5705 info->language_of_main = lang;
5709 /* Deduce the name of the main procedure, and set NAME_OF_MAIN
5713 find_main_name (void)
5715 const char *new_main_name;
5717 /* First check the objfiles to see whether a debuginfo reader has
5718 picked up the appropriate main name. Historically the main name
5719 was found in a more or less random way; this approach instead
5720 relies on the order of objfile creation -- which still isn't
5721 guaranteed to get the correct answer, but is just probably more
5723 for (objfile *objfile : current_program_space->objfiles ())
5725 if (objfile->per_bfd->name_of_main != NULL)
5727 set_main_name (objfile->per_bfd->name_of_main,
5728 objfile->per_bfd->language_of_main);
5733 /* Try to see if the main procedure is in Ada. */
5734 /* FIXME: brobecker/2005-03-07: Another way of doing this would
5735 be to add a new method in the language vector, and call this
5736 method for each language until one of them returns a non-empty
5737 name. This would allow us to remove this hard-coded call to
5738 an Ada function. It is not clear that this is a better approach
5739 at this point, because all methods need to be written in a way
5740 such that false positives never be returned. For instance, it is
5741 important that a method does not return a wrong name for the main
5742 procedure if the main procedure is actually written in a different
5743 language. It is easy to guaranty this with Ada, since we use a
5744 special symbol generated only when the main in Ada to find the name
5745 of the main procedure. It is difficult however to see how this can
5746 be guarantied for languages such as C, for instance. This suggests
5747 that order of call for these methods becomes important, which means
5748 a more complicated approach. */
5749 new_main_name = ada_main_name ();
5750 if (new_main_name != NULL)
5752 set_main_name (new_main_name, language_ada);
5756 new_main_name = d_main_name ();
5757 if (new_main_name != NULL)
5759 set_main_name (new_main_name, language_d);
5763 new_main_name = go_main_name ();
5764 if (new_main_name != NULL)
5766 set_main_name (new_main_name, language_go);
5770 new_main_name = pascal_main_name ();
5771 if (new_main_name != NULL)
5773 set_main_name (new_main_name, language_pascal);
5777 /* The languages above didn't identify the name of the main procedure.
5778 Fallback to "main". */
5779 set_main_name ("main", language_unknown);
5785 struct main_info *info = get_main_info ();
5787 if (info->name_of_main == NULL)
5790 return info->name_of_main;
5793 /* Return the language of the main function. If it is not known,
5794 return language_unknown. */
5797 main_language (void)
5799 struct main_info *info = get_main_info ();
5801 if (info->name_of_main == NULL)
5804 return info->language_of_main;
5807 /* Handle ``executable_changed'' events for the symtab module. */
5810 symtab_observer_executable_changed (void)
5812 /* NAME_OF_MAIN may no longer be the same, so reset it for now. */
5813 set_main_name (NULL, language_unknown);
5816 /* Return 1 if the supplied producer string matches the ARM RealView
5817 compiler (armcc). */
5820 producer_is_realview (const char *producer)
5822 static const char *const arm_idents[] = {
5823 "ARM C Compiler, ADS",
5824 "Thumb C Compiler, ADS",
5825 "ARM C++ Compiler, ADS",
5826 "Thumb C++ Compiler, ADS",
5827 "ARM/Thumb C/C++ Compiler, RVCT",
5828 "ARM C/C++ Compiler, RVCT"
5832 if (producer == NULL)
5835 for (i = 0; i < ARRAY_SIZE (arm_idents); i++)
5836 if (startswith (producer, arm_idents[i]))
5844 /* The next index to hand out in response to a registration request. */
5846 static int next_aclass_value = LOC_FINAL_VALUE;
5848 /* The maximum number of "aclass" registrations we support. This is
5849 constant for convenience. */
5850 #define MAX_SYMBOL_IMPLS (LOC_FINAL_VALUE + 10)
5852 /* The objects representing the various "aclass" values. The elements
5853 from 0 up to LOC_FINAL_VALUE-1 represent themselves, and subsequent
5854 elements are those registered at gdb initialization time. */
5856 static struct symbol_impl symbol_impl[MAX_SYMBOL_IMPLS];
5858 /* The globally visible pointer. This is separate from 'symbol_impl'
5859 so that it can be const. */
5861 const struct symbol_impl *symbol_impls = &symbol_impl[0];
5863 /* Make sure we saved enough room in struct symbol. */
5865 gdb_static_assert (MAX_SYMBOL_IMPLS <= (1 << SYMBOL_ACLASS_BITS));
5867 /* Register a computed symbol type. ACLASS must be LOC_COMPUTED. OPS
5868 is the ops vector associated with this index. This returns the new
5869 index, which should be used as the aclass_index field for symbols
5873 register_symbol_computed_impl (enum address_class aclass,
5874 const struct symbol_computed_ops *ops)
5876 int result = next_aclass_value++;
5878 gdb_assert (aclass == LOC_COMPUTED);
5879 gdb_assert (result < MAX_SYMBOL_IMPLS);
5880 symbol_impl[result].aclass = aclass;
5881 symbol_impl[result].ops_computed = ops;
5883 /* Sanity check OPS. */
5884 gdb_assert (ops != NULL);
5885 gdb_assert (ops->tracepoint_var_ref != NULL);
5886 gdb_assert (ops->describe_location != NULL);
5887 gdb_assert (ops->get_symbol_read_needs != NULL);
5888 gdb_assert (ops->read_variable != NULL);
5893 /* Register a function with frame base type. ACLASS must be LOC_BLOCK.
5894 OPS is the ops vector associated with this index. This returns the
5895 new index, which should be used as the aclass_index field for symbols
5899 register_symbol_block_impl (enum address_class aclass,
5900 const struct symbol_block_ops *ops)
5902 int result = next_aclass_value++;
5904 gdb_assert (aclass == LOC_BLOCK);
5905 gdb_assert (result < MAX_SYMBOL_IMPLS);
5906 symbol_impl[result].aclass = aclass;
5907 symbol_impl[result].ops_block = ops;
5909 /* Sanity check OPS. */
5910 gdb_assert (ops != NULL);
5911 gdb_assert (ops->find_frame_base_location != NULL);
5916 /* Register a register symbol type. ACLASS must be LOC_REGISTER or
5917 LOC_REGPARM_ADDR. OPS is the register ops vector associated with
5918 this index. This returns the new index, which should be used as
5919 the aclass_index field for symbols of this type. */
5922 register_symbol_register_impl (enum address_class aclass,
5923 const struct symbol_register_ops *ops)
5925 int result = next_aclass_value++;
5927 gdb_assert (aclass == LOC_REGISTER || aclass == LOC_REGPARM_ADDR);
5928 gdb_assert (result < MAX_SYMBOL_IMPLS);
5929 symbol_impl[result].aclass = aclass;
5930 symbol_impl[result].ops_register = ops;
5935 /* Initialize elements of 'symbol_impl' for the constants in enum
5939 initialize_ordinary_address_classes (void)
5943 for (i = 0; i < LOC_FINAL_VALUE; ++i)
5944 symbol_impl[i].aclass = (enum address_class) i;
5949 /* Helper function to initialize the fields of an objfile-owned symbol.
5950 It assumed that *SYM is already all zeroes. */
5953 initialize_objfile_symbol_1 (struct symbol *sym)
5955 SYMBOL_OBJFILE_OWNED (sym) = 1;
5956 SYMBOL_SECTION (sym) = -1;
5959 /* Initialize the symbol SYM, and mark it as being owned by an objfile. */
5962 initialize_objfile_symbol (struct symbol *sym)
5964 memset (sym, 0, sizeof (*sym));
5965 initialize_objfile_symbol_1 (sym);
5968 /* Allocate and initialize a new 'struct symbol' on OBJFILE's
5972 allocate_symbol (struct objfile *objfile)
5974 struct symbol *result;
5976 result = OBSTACK_ZALLOC (&objfile->objfile_obstack, struct symbol);
5977 initialize_objfile_symbol_1 (result);
5982 /* Allocate and initialize a new 'struct template_symbol' on OBJFILE's
5985 struct template_symbol *
5986 allocate_template_symbol (struct objfile *objfile)
5988 struct template_symbol *result;
5990 result = OBSTACK_ZALLOC (&objfile->objfile_obstack, struct template_symbol);
5991 initialize_objfile_symbol_1 (result);
5999 symbol_objfile (const struct symbol *symbol)
6001 gdb_assert (SYMBOL_OBJFILE_OWNED (symbol));
6002 return SYMTAB_OBJFILE (symbol->owner.symtab);
6008 symbol_arch (const struct symbol *symbol)
6010 if (!SYMBOL_OBJFILE_OWNED (symbol))
6011 return symbol->owner.arch;
6012 return get_objfile_arch (SYMTAB_OBJFILE (symbol->owner.symtab));
6018 symbol_symtab (const struct symbol *symbol)
6020 gdb_assert (SYMBOL_OBJFILE_OWNED (symbol));
6021 return symbol->owner.symtab;
6027 symbol_set_symtab (struct symbol *symbol, struct symtab *symtab)
6029 gdb_assert (SYMBOL_OBJFILE_OWNED (symbol));
6030 symbol->owner.symtab = symtab;
6036 _initialize_symtab (void)
6038 initialize_ordinary_address_classes ();
6041 = register_program_space_data_with_cleanup (NULL, symbol_cache_cleanup);
6043 add_info ("variables", info_variables_command,
6044 info_print_args_help (_("\
6045 All global and static variable names or those matching REGEXPs.\n\
6046 Usage: info variables [-q] [-t TYPEREGEXP] [NAMEREGEXP]\n\
6047 Prints the global and static variables.\n"),
6048 _("global and static variables")));
6050 add_com ("whereis", class_info, info_variables_command,
6051 info_print_args_help (_("\
6052 All global and static variable names, or those matching REGEXPs.\n\
6053 Usage: whereis [-q] [-t TYPEREGEXP] [NAMEREGEXP]\n\
6054 Prints the global and static variables.\n"),
6055 _("global and static variables")));
6057 add_info ("functions", info_functions_command,
6058 info_print_args_help (_("\
6059 All function names or those matching REGEXPs.\n\
6060 Usage: info functions [-q] [-t TYPEREGEXP] [NAMEREGEXP]\n\
6061 Prints the functions.\n"),
6064 /* FIXME: This command has at least the following problems:
6065 1. It prints builtin types (in a very strange and confusing fashion).
6066 2. It doesn't print right, e.g. with
6067 typedef struct foo *FOO
6068 type_print prints "FOO" when we want to make it (in this situation)
6069 print "struct foo *".
6070 I also think "ptype" or "whatis" is more likely to be useful (but if
6071 there is much disagreement "info types" can be fixed). */
6072 add_info ("types", info_types_command,
6073 _("All type names, or those matching REGEXP."));
6075 add_info ("sources", info_sources_command,
6076 _("Source files in the program."));
6078 add_com ("rbreak", class_breakpoint, rbreak_command,
6079 _("Set a breakpoint for all functions matching REGEXP."));
6081 add_setshow_enum_cmd ("multiple-symbols", no_class,
6082 multiple_symbols_modes, &multiple_symbols_mode,
6084 Set the debugger behavior when more than one symbol are possible matches\n\
6085 in an expression."), _("\
6086 Show how the debugger handles ambiguities in expressions."), _("\
6087 Valid values are \"ask\", \"all\", \"cancel\", and the default is \"all\"."),
6088 NULL, NULL, &setlist, &showlist);
6090 add_setshow_boolean_cmd ("basenames-may-differ", class_obscure,
6091 &basenames_may_differ, _("\
6092 Set whether a source file may have multiple base names."), _("\
6093 Show whether a source file may have multiple base names."), _("\
6094 (A \"base name\" is the name of a file with the directory part removed.\n\
6095 Example: The base name of \"/home/user/hello.c\" is \"hello.c\".)\n\
6096 If set, GDB will canonicalize file names (e.g., expand symlinks)\n\
6097 before comparing them. Canonicalization is an expensive operation,\n\
6098 but it allows the same file be known by more than one base name.\n\
6099 If not set (the default), all source files are assumed to have just\n\
6100 one base name, and gdb will do file name comparisons more efficiently."),
6102 &setlist, &showlist);
6104 add_setshow_zuinteger_cmd ("symtab-create", no_class, &symtab_create_debug,
6105 _("Set debugging of symbol table creation."),
6106 _("Show debugging of symbol table creation."), _("\
6107 When enabled (non-zero), debugging messages are printed when building\n\
6108 symbol tables. A value of 1 (one) normally provides enough information.\n\
6109 A value greater than 1 provides more verbose information."),
6112 &setdebuglist, &showdebuglist);
6114 add_setshow_zuinteger_cmd ("symbol-lookup", no_class, &symbol_lookup_debug,
6116 Set debugging of symbol lookup."), _("\
6117 Show debugging of symbol lookup."), _("\
6118 When enabled (non-zero), symbol lookups are logged."),
6120 &setdebuglist, &showdebuglist);
6122 add_setshow_zuinteger_cmd ("symbol-cache-size", no_class,
6123 &new_symbol_cache_size,
6124 _("Set the size of the symbol cache."),
6125 _("Show the size of the symbol cache."), _("\
6126 The size of the symbol cache.\n\
6127 If zero then the symbol cache is disabled."),
6128 set_symbol_cache_size_handler, NULL,
6129 &maintenance_set_cmdlist,
6130 &maintenance_show_cmdlist);
6132 add_cmd ("symbol-cache", class_maintenance, maintenance_print_symbol_cache,
6133 _("Dump the symbol cache for each program space."),
6134 &maintenanceprintlist);
6136 add_cmd ("symbol-cache-statistics", class_maintenance,
6137 maintenance_print_symbol_cache_statistics,
6138 _("Print symbol cache statistics for each program space."),
6139 &maintenanceprintlist);
6141 add_cmd ("flush-symbol-cache", class_maintenance,
6142 maintenance_flush_symbol_cache,
6143 _("Flush the symbol cache for each program space."),
6146 gdb::observers::executable_changed.attach (symtab_observer_executable_changed);
6147 gdb::observers::new_objfile.attach (symtab_new_objfile_observer);
6148 gdb::observers::free_objfile.attach (symtab_free_objfile_observer);