1 /* Symbol table lookup for the GNU debugger, GDB.
3 Copyright (C) 1986-2021 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"
45 #include "cli/cli-cmds.h"
48 #include "typeprint.h"
50 #include "gdb_obstack.h"
52 #include "dictionary.h"
54 #include <sys/types.h>
59 #include "cp-support.h"
60 #include "observable.h"
63 #include "macroscope.h"
65 #include "parser-defs.h"
66 #include "completer.h"
67 #include "progspace-and-thread.h"
68 #include "gdbsupport/gdb_optional.h"
69 #include "filename-seen-cache.h"
70 #include "arch-utils.h"
72 #include "gdbsupport/gdb_string_view.h"
73 #include "gdbsupport/pathstuff.h"
74 #include "gdbsupport/common-utils.h"
76 /* Forward declarations for local functions. */
78 static void rbreak_command (const char *, int);
80 static int find_line_common (struct linetable
*, int, int *, int);
82 static struct block_symbol
83 lookup_symbol_aux (const char *name
,
84 symbol_name_match_type match_type
,
85 const struct block
*block
,
86 const domain_enum domain
,
87 enum language language
,
88 struct field_of_this_result
*);
91 struct block_symbol
lookup_local_symbol (const char *name
,
92 symbol_name_match_type match_type
,
93 const struct block
*block
,
94 const domain_enum domain
,
95 enum language language
);
97 static struct block_symbol
98 lookup_symbol_in_objfile (struct objfile
*objfile
,
99 enum block_enum block_index
,
100 const char *name
, const domain_enum domain
);
102 /* Type of the data stored on the program space. */
106 main_info () = default;
110 xfree (name_of_main
);
113 /* Name of "main". */
115 char *name_of_main
= nullptr;
117 /* Language of "main". */
119 enum language language_of_main
= language_unknown
;
122 /* Program space key for finding name and language of "main". */
124 static const program_space_key
<main_info
> main_progspace_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 /* Clear out SLOT. */
190 symbol_cache_clear_slot (struct symbol_cache_slot
*slot
)
192 if (slot
->state
== SYMBOL_SLOT_NOT_FOUND
)
193 xfree (slot
->value
.not_found
.name
);
194 slot
->state
= SYMBOL_SLOT_UNUSED
;
197 /* Symbols don't specify global vs static block.
198 So keep them in separate caches. */
200 struct block_symbol_cache
204 unsigned int collisions
;
206 /* SYMBOLS is a variable length array of this size.
207 One can imagine that in general one cache (global/static) should be a
208 fraction of the size of the other, but there's no data at the moment
209 on which to decide. */
212 struct symbol_cache_slot symbols
[1];
215 /* Clear all slots of BSC and free BSC. */
218 destroy_block_symbol_cache (struct block_symbol_cache
*bsc
)
222 for (unsigned int i
= 0; i
< bsc
->size
; i
++)
223 symbol_cache_clear_slot (&bsc
->symbols
[i
]);
230 Searching for symbols in the static and global blocks over multiple objfiles
231 again and again can be slow, as can searching very big objfiles. This is a
232 simple cache to improve symbol lookup performance, which is critical to
233 overall gdb performance.
235 Symbols are hashed on the name, its domain, and block.
236 They are also hashed on their objfile for objfile-specific lookups. */
240 symbol_cache () = default;
244 destroy_block_symbol_cache (global_symbols
);
245 destroy_block_symbol_cache (static_symbols
);
248 struct block_symbol_cache
*global_symbols
= nullptr;
249 struct block_symbol_cache
*static_symbols
= nullptr;
252 /* Program space key for finding its symbol cache. */
254 static const program_space_key
<symbol_cache
> symbol_cache_key
;
256 /* When non-zero, print debugging messages related to symtab creation. */
257 unsigned int symtab_create_debug
= 0;
259 /* When non-zero, print debugging messages related to symbol lookup. */
260 unsigned int symbol_lookup_debug
= 0;
262 /* The size of the cache is staged here. */
263 static unsigned int new_symbol_cache_size
= DEFAULT_SYMBOL_CACHE_SIZE
;
265 /* The current value of the symbol cache size.
266 This is saved so that if the user enters a value too big we can restore
267 the original value from here. */
268 static unsigned int symbol_cache_size
= DEFAULT_SYMBOL_CACHE_SIZE
;
270 /* True if a file may be known by two different basenames.
271 This is the uncommon case, and significantly slows down gdb.
272 Default set to "off" to not slow down the common case. */
273 bool basenames_may_differ
= false;
275 /* Allow the user to configure the debugger behavior with respect
276 to multiple-choice menus when more than one symbol matches during
279 const char multiple_symbols_ask
[] = "ask";
280 const char multiple_symbols_all
[] = "all";
281 const char multiple_symbols_cancel
[] = "cancel";
282 static const char *const multiple_symbols_modes
[] =
284 multiple_symbols_ask
,
285 multiple_symbols_all
,
286 multiple_symbols_cancel
,
289 static const char *multiple_symbols_mode
= multiple_symbols_all
;
291 /* Read-only accessor to AUTO_SELECT_MODE. */
294 multiple_symbols_select_mode (void)
296 return multiple_symbols_mode
;
299 /* Return the name of a domain_enum. */
302 domain_name (domain_enum e
)
306 case UNDEF_DOMAIN
: return "UNDEF_DOMAIN";
307 case VAR_DOMAIN
: return "VAR_DOMAIN";
308 case STRUCT_DOMAIN
: return "STRUCT_DOMAIN";
309 case MODULE_DOMAIN
: return "MODULE_DOMAIN";
310 case LABEL_DOMAIN
: return "LABEL_DOMAIN";
311 case COMMON_BLOCK_DOMAIN
: return "COMMON_BLOCK_DOMAIN";
312 default: gdb_assert_not_reached ("bad domain_enum");
316 /* Return the name of a search_domain . */
319 search_domain_name (enum search_domain e
)
323 case VARIABLES_DOMAIN
: return "VARIABLES_DOMAIN";
324 case FUNCTIONS_DOMAIN
: return "FUNCTIONS_DOMAIN";
325 case TYPES_DOMAIN
: return "TYPES_DOMAIN";
326 case MODULES_DOMAIN
: return "MODULES_DOMAIN";
327 case ALL_DOMAIN
: return "ALL_DOMAIN";
328 default: gdb_assert_not_reached ("bad search_domain");
335 compunit_primary_filetab (const struct compunit_symtab
*cust
)
337 gdb_assert (COMPUNIT_FILETABS (cust
) != NULL
);
339 /* The primary file symtab is the first one in the list. */
340 return COMPUNIT_FILETABS (cust
);
346 compunit_language (const struct compunit_symtab
*cust
)
348 struct symtab
*symtab
= compunit_primary_filetab (cust
);
350 /* The language of the compunit symtab is the language of its primary
352 return SYMTAB_LANGUAGE (symtab
);
358 minimal_symbol::data_p () const
360 return type
== mst_data
363 || type
== mst_file_data
364 || type
== mst_file_bss
;
370 minimal_symbol::text_p () const
372 return type
== mst_text
373 || type
== mst_text_gnu_ifunc
374 || type
== mst_data_gnu_ifunc
375 || type
== mst_slot_got_plt
376 || type
== mst_solib_trampoline
377 || type
== mst_file_text
;
380 /* See whether FILENAME matches SEARCH_NAME using the rule that we
381 advertise to the user. (The manual's description of linespecs
382 describes what we advertise). Returns true if they match, false
386 compare_filenames_for_search (const char *filename
, const char *search_name
)
388 int len
= strlen (filename
);
389 size_t search_len
= strlen (search_name
);
391 if (len
< search_len
)
394 /* The tail of FILENAME must match. */
395 if (FILENAME_CMP (filename
+ len
- search_len
, search_name
) != 0)
398 /* Either the names must completely match, or the character
399 preceding the trailing SEARCH_NAME segment of FILENAME must be a
402 The check !IS_ABSOLUTE_PATH ensures SEARCH_NAME "/dir/file.c"
403 cannot match FILENAME "/path//dir/file.c" - as user has requested
404 absolute path. The sama applies for "c:\file.c" possibly
405 incorrectly hypothetically matching "d:\dir\c:\file.c".
407 The HAS_DRIVE_SPEC purpose is to make FILENAME "c:file.c"
408 compatible with SEARCH_NAME "file.c". In such case a compiler had
409 to put the "c:file.c" name into debug info. Such compatibility
410 works only on GDB built for DOS host. */
411 return (len
== search_len
412 || (!IS_ABSOLUTE_PATH (search_name
)
413 && IS_DIR_SEPARATOR (filename
[len
- search_len
- 1]))
414 || (HAS_DRIVE_SPEC (filename
)
415 && STRIP_DRIVE_SPEC (filename
) == &filename
[len
- search_len
]));
418 /* Same as compare_filenames_for_search, but for glob-style patterns.
419 Heads up on the order of the arguments. They match the order of
420 compare_filenames_for_search, but it's the opposite of the order of
421 arguments to gdb_filename_fnmatch. */
424 compare_glob_filenames_for_search (const char *filename
,
425 const char *search_name
)
427 /* We rely on the property of glob-style patterns with FNM_FILE_NAME that
428 all /s have to be explicitly specified. */
429 int file_path_elements
= count_path_elements (filename
);
430 int search_path_elements
= count_path_elements (search_name
);
432 if (search_path_elements
> file_path_elements
)
435 if (IS_ABSOLUTE_PATH (search_name
))
437 return (search_path_elements
== file_path_elements
438 && gdb_filename_fnmatch (search_name
, filename
,
439 FNM_FILE_NAME
| FNM_NOESCAPE
) == 0);
443 const char *file_to_compare
444 = strip_leading_path_elements (filename
,
445 file_path_elements
- search_path_elements
);
447 return gdb_filename_fnmatch (search_name
, file_to_compare
,
448 FNM_FILE_NAME
| FNM_NOESCAPE
) == 0;
452 /* Check for a symtab of a specific name by searching some symtabs.
453 This is a helper function for callbacks of iterate_over_symtabs.
455 If NAME is not absolute, then REAL_PATH is NULL
456 If NAME is absolute, then REAL_PATH is the gdb_realpath form of NAME.
458 The return value, NAME, REAL_PATH and CALLBACK are identical to the
459 `map_symtabs_matching_filename' method of quick_symbol_functions.
461 FIRST and AFTER_LAST indicate the range of compunit symtabs to search.
462 Each symtab within the specified compunit symtab is also searched.
463 AFTER_LAST is one past the last compunit symtab to search; NULL means to
464 search until the end of the list. */
467 iterate_over_some_symtabs (const char *name
,
468 const char *real_path
,
469 struct compunit_symtab
*first
,
470 struct compunit_symtab
*after_last
,
471 gdb::function_view
<bool (symtab
*)> callback
)
473 struct compunit_symtab
*cust
;
474 const char* base_name
= lbasename (name
);
476 for (cust
= first
; cust
!= NULL
&& cust
!= after_last
; cust
= cust
->next
)
478 for (symtab
*s
: compunit_filetabs (cust
))
480 if (compare_filenames_for_search (s
->filename
, name
))
487 /* Before we invoke realpath, which can get expensive when many
488 files are involved, do a quick comparison of the basenames. */
489 if (! basenames_may_differ
490 && FILENAME_CMP (base_name
, lbasename (s
->filename
)) != 0)
493 if (compare_filenames_for_search (symtab_to_fullname (s
), name
))
500 /* If the user gave us an absolute path, try to find the file in
501 this symtab and use its absolute path. */
502 if (real_path
!= NULL
)
504 const char *fullname
= symtab_to_fullname (s
);
506 gdb_assert (IS_ABSOLUTE_PATH (real_path
));
507 gdb_assert (IS_ABSOLUTE_PATH (name
));
508 gdb::unique_xmalloc_ptr
<char> fullname_real_path
509 = gdb_realpath (fullname
);
510 fullname
= fullname_real_path
.get ();
511 if (FILENAME_CMP (real_path
, fullname
) == 0)
524 /* Check for a symtab of a specific name; first in symtabs, then in
525 psymtabs. *If* there is no '/' in the name, a match after a '/'
526 in the symtab filename will also work.
528 Calls CALLBACK with each symtab that is found. If CALLBACK returns
529 true, the search stops. */
532 iterate_over_symtabs (const char *name
,
533 gdb::function_view
<bool (symtab
*)> callback
)
535 gdb::unique_xmalloc_ptr
<char> real_path
;
537 /* Here we are interested in canonicalizing an absolute path, not
538 absolutizing a relative path. */
539 if (IS_ABSOLUTE_PATH (name
))
541 real_path
= gdb_realpath (name
);
542 gdb_assert (IS_ABSOLUTE_PATH (real_path
.get ()));
545 for (objfile
*objfile
: current_program_space
->objfiles ())
547 if (iterate_over_some_symtabs (name
, real_path
.get (),
548 objfile
->compunit_symtabs
, NULL
,
553 /* Same search rules as above apply here, but now we look thru the
556 for (objfile
*objfile
: current_program_space
->objfiles ())
558 if (objfile
->map_symtabs_matching_filename (name
, real_path
.get (),
564 /* A wrapper for iterate_over_symtabs that returns the first matching
568 lookup_symtab (const char *name
)
570 struct symtab
*result
= NULL
;
572 iterate_over_symtabs (name
, [&] (symtab
*symtab
)
582 /* Mangle a GDB method stub type. This actually reassembles the pieces of the
583 full method name, which consist of the class name (from T), the unadorned
584 method name from METHOD_ID, and the signature for the specific overload,
585 specified by SIGNATURE_ID. Note that this function is g++ specific. */
588 gdb_mangle_name (struct type
*type
, int method_id
, int signature_id
)
590 int mangled_name_len
;
592 struct fn_field
*f
= TYPE_FN_FIELDLIST1 (type
, method_id
);
593 struct fn_field
*method
= &f
[signature_id
];
594 const char *field_name
= TYPE_FN_FIELDLIST_NAME (type
, method_id
);
595 const char *physname
= TYPE_FN_FIELD_PHYSNAME (f
, signature_id
);
596 const char *newname
= type
->name ();
598 /* Does the form of physname indicate that it is the full mangled name
599 of a constructor (not just the args)? */
600 int is_full_physname_constructor
;
603 int is_destructor
= is_destructor_name (physname
);
604 /* Need a new type prefix. */
605 const char *const_prefix
= method
->is_const
? "C" : "";
606 const char *volatile_prefix
= method
->is_volatile
? "V" : "";
608 int len
= (newname
== NULL
? 0 : strlen (newname
));
610 /* Nothing to do if physname already contains a fully mangled v3 abi name
611 or an operator name. */
612 if ((physname
[0] == '_' && physname
[1] == 'Z')
613 || is_operator_name (field_name
))
614 return xstrdup (physname
);
616 is_full_physname_constructor
= is_constructor_name (physname
);
618 is_constructor
= is_full_physname_constructor
619 || (newname
&& strcmp (field_name
, newname
) == 0);
622 is_destructor
= (startswith (physname
, "__dt"));
624 if (is_destructor
|| is_full_physname_constructor
)
626 mangled_name
= (char *) xmalloc (strlen (physname
) + 1);
627 strcpy (mangled_name
, physname
);
633 xsnprintf (buf
, sizeof (buf
), "__%s%s", const_prefix
, volatile_prefix
);
635 else if (physname
[0] == 't' || physname
[0] == 'Q')
637 /* The physname for template and qualified methods already includes
639 xsnprintf (buf
, sizeof (buf
), "__%s%s", const_prefix
, volatile_prefix
);
645 xsnprintf (buf
, sizeof (buf
), "__%s%s%d", const_prefix
,
646 volatile_prefix
, len
);
648 mangled_name_len
= ((is_constructor
? 0 : strlen (field_name
))
649 + strlen (buf
) + len
+ strlen (physname
) + 1);
651 mangled_name
= (char *) xmalloc (mangled_name_len
);
653 mangled_name
[0] = '\0';
655 strcpy (mangled_name
, field_name
);
657 strcat (mangled_name
, buf
);
658 /* If the class doesn't have a name, i.e. newname NULL, then we just
659 mangle it using 0 for the length of the class. Thus it gets mangled
660 as something starting with `::' rather than `classname::'. */
662 strcat (mangled_name
, newname
);
664 strcat (mangled_name
, physname
);
665 return (mangled_name
);
671 general_symbol_info::set_demangled_name (const char *name
,
672 struct obstack
*obstack
)
674 if (language () == language_ada
)
679 language_specific
.obstack
= obstack
;
684 language_specific
.demangled_name
= name
;
688 language_specific
.demangled_name
= name
;
692 /* Initialize the language dependent portion of a symbol
693 depending upon the language for the symbol. */
696 general_symbol_info::set_language (enum language language
,
697 struct obstack
*obstack
)
699 m_language
= language
;
700 if (language
== language_cplus
701 || language
== language_d
702 || language
== language_go
703 || language
== language_objc
704 || language
== language_fortran
)
706 set_demangled_name (NULL
, obstack
);
708 else if (language
== language_ada
)
710 gdb_assert (ada_mangled
== 0);
711 language_specific
.obstack
= obstack
;
715 memset (&language_specific
, 0, sizeof (language_specific
));
719 /* Functions to initialize a symbol's mangled name. */
721 /* Objects of this type are stored in the demangled name hash table. */
722 struct demangled_name_entry
724 demangled_name_entry (gdb::string_view mangled_name
)
725 : mangled (mangled_name
) {}
727 gdb::string_view mangled
;
728 enum language language
;
729 gdb::unique_xmalloc_ptr
<char> demangled
;
732 /* Hash function for the demangled name hash. */
735 hash_demangled_name_entry (const void *data
)
737 const struct demangled_name_entry
*e
738 = (const struct demangled_name_entry
*) data
;
740 return fast_hash (e
->mangled
.data (), e
->mangled
.length ());
743 /* Equality function for the demangled name hash. */
746 eq_demangled_name_entry (const void *a
, const void *b
)
748 const struct demangled_name_entry
*da
749 = (const struct demangled_name_entry
*) a
;
750 const struct demangled_name_entry
*db
751 = (const struct demangled_name_entry
*) b
;
753 return da
->mangled
== db
->mangled
;
757 free_demangled_name_entry (void *data
)
759 struct demangled_name_entry
*e
760 = (struct demangled_name_entry
*) data
;
762 e
->~demangled_name_entry();
765 /* Create the hash table used for demangled names. Each hash entry is
766 a pair of strings; one for the mangled name and one for the demangled
767 name. The entry is hashed via just the mangled name. */
770 create_demangled_names_hash (struct objfile_per_bfd_storage
*per_bfd
)
772 /* Choose 256 as the starting size of the hash table, somewhat arbitrarily.
773 The hash table code will round this up to the next prime number.
774 Choosing a much larger table size wastes memory, and saves only about
775 1% in symbol reading. However, if the minsym count is already
776 initialized (e.g. because symbol name setting was deferred to
777 a background thread) we can initialize the hashtable with a count
778 based on that, because we will almost certainly have at least that
779 many entries. If we have a nonzero number but less than 256,
780 we still stay with 256 to have some space for psymbols, etc. */
782 /* htab will expand the table when it is 3/4th full, so we account for that
783 here. +2 to round up. */
784 int minsym_based_count
= (per_bfd
->minimal_symbol_count
+ 2) / 3 * 4;
785 int count
= std::max (per_bfd
->minimal_symbol_count
, minsym_based_count
);
787 per_bfd
->demangled_names_hash
.reset (htab_create_alloc
788 (count
, hash_demangled_name_entry
, eq_demangled_name_entry
,
789 free_demangled_name_entry
, xcalloc
, xfree
));
795 symbol_find_demangled_name (struct general_symbol_info
*gsymbol
,
798 char *demangled
= NULL
;
801 if (gsymbol
->language () == language_unknown
)
802 gsymbol
->m_language
= language_auto
;
804 if (gsymbol
->language () != language_auto
)
806 const struct language_defn
*lang
= language_def (gsymbol
->language ());
808 lang
->sniff_from_mangled_name (mangled
, &demangled
);
812 for (i
= language_unknown
; i
< nr_languages
; ++i
)
814 enum language l
= (enum language
) i
;
815 const struct language_defn
*lang
= language_def (l
);
817 if (lang
->sniff_from_mangled_name (mangled
, &demangled
))
819 gsymbol
->m_language
= l
;
827 /* Set both the mangled and demangled (if any) names for GSYMBOL based
828 on LINKAGE_NAME and LEN. Ordinarily, NAME is copied onto the
829 objfile's obstack; but if COPY_NAME is 0 and if NAME is
830 NUL-terminated, then this function assumes that NAME is already
831 correctly saved (either permanently or with a lifetime tied to the
832 objfile), and it will not be copied.
834 The hash table corresponding to OBJFILE is used, and the memory
835 comes from the per-BFD storage_obstack. LINKAGE_NAME is copied,
836 so the pointer can be discarded after calling this function. */
839 general_symbol_info::compute_and_set_names (gdb::string_view linkage_name
,
841 objfile_per_bfd_storage
*per_bfd
,
842 gdb::optional
<hashval_t
> hash
)
844 struct demangled_name_entry
**slot
;
846 if (language () == language_ada
)
848 /* In Ada, we do the symbol lookups using the mangled name, so
849 we can save some space by not storing the demangled name. */
851 m_name
= linkage_name
.data ();
853 m_name
= obstack_strndup (&per_bfd
->storage_obstack
,
854 linkage_name
.data (),
855 linkage_name
.length ());
856 set_demangled_name (NULL
, &per_bfd
->storage_obstack
);
861 if (per_bfd
->demangled_names_hash
== NULL
)
862 create_demangled_names_hash (per_bfd
);
864 struct demangled_name_entry
entry (linkage_name
);
865 if (!hash
.has_value ())
866 hash
= hash_demangled_name_entry (&entry
);
867 slot
= ((struct demangled_name_entry
**)
868 htab_find_slot_with_hash (per_bfd
->demangled_names_hash
.get (),
869 &entry
, *hash
, INSERT
));
871 /* The const_cast is safe because the only reason it is already
872 initialized is if we purposefully set it from a background
873 thread to avoid doing the work here. However, it is still
874 allocated from the heap and needs to be freed by us, just
875 like if we called symbol_find_demangled_name here. If this is
876 nullptr, we call symbol_find_demangled_name below, but we put
877 this smart pointer here to be sure that we don't leak this name. */
878 gdb::unique_xmalloc_ptr
<char> demangled_name
879 (const_cast<char *> (language_specific
.demangled_name
));
881 /* If this name is not in the hash table, add it. */
883 /* A C version of the symbol may have already snuck into the table.
884 This happens to, e.g., main.init (__go_init_main). Cope. */
885 || (language () == language_go
&& (*slot
)->demangled
== nullptr))
887 /* A 0-terminated copy of the linkage name. Callers must set COPY_NAME
888 to true if the string might not be nullterminated. We have to make
889 this copy because demangling needs a nullterminated string. */
890 gdb::string_view linkage_name_copy
;
893 char *alloc_name
= (char *) alloca (linkage_name
.length () + 1);
894 memcpy (alloc_name
, linkage_name
.data (), linkage_name
.length ());
895 alloc_name
[linkage_name
.length ()] = '\0';
897 linkage_name_copy
= gdb::string_view (alloc_name
,
898 linkage_name
.length ());
901 linkage_name_copy
= linkage_name
;
903 if (demangled_name
.get () == nullptr)
905 (symbol_find_demangled_name (this, linkage_name_copy
.data ()));
907 /* Suppose we have demangled_name==NULL, copy_name==0, and
908 linkage_name_copy==linkage_name. In this case, we already have the
909 mangled name saved, and we don't have a demangled name. So,
910 you might think we could save a little space by not recording
911 this in the hash table at all.
913 It turns out that it is actually important to still save such
914 an entry in the hash table, because storing this name gives
915 us better bcache hit rates for partial symbols. */
919 = ((struct demangled_name_entry
*)
920 obstack_alloc (&per_bfd
->storage_obstack
,
921 sizeof (demangled_name_entry
)));
922 new (*slot
) demangled_name_entry (linkage_name
);
926 /* If we must copy the mangled name, put it directly after
927 the struct so we can have a single allocation. */
929 = ((struct demangled_name_entry
*)
930 obstack_alloc (&per_bfd
->storage_obstack
,
931 sizeof (demangled_name_entry
)
932 + linkage_name
.length () + 1));
933 char *mangled_ptr
= reinterpret_cast<char *> (*slot
+ 1);
934 memcpy (mangled_ptr
, linkage_name
.data (), linkage_name
.length ());
935 mangled_ptr
[linkage_name
.length ()] = '\0';
936 new (*slot
) demangled_name_entry
937 (gdb::string_view (mangled_ptr
, linkage_name
.length ()));
939 (*slot
)->demangled
= std::move (demangled_name
);
940 (*slot
)->language
= language ();
942 else if (language () == language_unknown
|| language () == language_auto
)
943 m_language
= (*slot
)->language
;
945 m_name
= (*slot
)->mangled
.data ();
946 set_demangled_name ((*slot
)->demangled
.get (), &per_bfd
->storage_obstack
);
952 general_symbol_info::natural_name () const
960 case language_fortran
:
962 if (language_specific
.demangled_name
!= nullptr)
963 return language_specific
.demangled_name
;
966 return ada_decode_symbol (this);
970 return linkage_name ();
976 general_symbol_info::demangled_name () const
978 const char *dem_name
= NULL
;
986 case language_fortran
:
988 dem_name
= language_specific
.demangled_name
;
991 dem_name
= ada_decode_symbol (this);
1002 general_symbol_info::search_name () const
1004 if (language () == language_ada
)
1005 return linkage_name ();
1007 return natural_name ();
1012 struct obj_section
*
1013 general_symbol_info::obj_section (const struct objfile
*objfile
) const
1015 if (section_index () >= 0)
1016 return &objfile
->sections
[section_index ()];
1023 symbol_matches_search_name (const struct general_symbol_info
*gsymbol
,
1024 const lookup_name_info
&name
)
1026 symbol_name_matcher_ftype
*name_match
1027 = language_def (gsymbol
->language ())->get_symbol_name_matcher (name
);
1028 return name_match (gsymbol
->search_name (), name
, NULL
);
1033 /* Return true if the two sections are the same, or if they could
1034 plausibly be copies of each other, one in an original object
1035 file and another in a separated debug file. */
1038 matching_obj_sections (struct obj_section
*obj_first
,
1039 struct obj_section
*obj_second
)
1041 asection
*first
= obj_first
? obj_first
->the_bfd_section
: NULL
;
1042 asection
*second
= obj_second
? obj_second
->the_bfd_section
: NULL
;
1044 /* If they're the same section, then they match. */
1045 if (first
== second
)
1048 /* If either is NULL, give up. */
1049 if (first
== NULL
|| second
== NULL
)
1052 /* This doesn't apply to absolute symbols. */
1053 if (first
->owner
== NULL
|| second
->owner
== NULL
)
1056 /* If they're in the same object file, they must be different sections. */
1057 if (first
->owner
== second
->owner
)
1060 /* Check whether the two sections are potentially corresponding. They must
1061 have the same size, address, and name. We can't compare section indexes,
1062 which would be more reliable, because some sections may have been
1064 if (bfd_section_size (first
) != bfd_section_size (second
))
1067 /* In-memory addresses may start at a different offset, relativize them. */
1068 if (bfd_section_vma (first
) - bfd_get_start_address (first
->owner
)
1069 != bfd_section_vma (second
) - bfd_get_start_address (second
->owner
))
1072 if (bfd_section_name (first
) == NULL
1073 || bfd_section_name (second
) == NULL
1074 || strcmp (bfd_section_name (first
), bfd_section_name (second
)) != 0)
1077 /* Otherwise check that they are in corresponding objfiles. */
1079 struct objfile
*obj
= NULL
;
1080 for (objfile
*objfile
: current_program_space
->objfiles ())
1081 if (objfile
->obfd
== first
->owner
)
1086 gdb_assert (obj
!= NULL
);
1088 if (obj
->separate_debug_objfile
!= NULL
1089 && obj
->separate_debug_objfile
->obfd
== second
->owner
)
1091 if (obj
->separate_debug_objfile_backlink
!= NULL
1092 && obj
->separate_debug_objfile_backlink
->obfd
== second
->owner
)
1101 expand_symtab_containing_pc (CORE_ADDR pc
, struct obj_section
*section
)
1103 struct bound_minimal_symbol msymbol
;
1105 /* If we know that this is not a text address, return failure. This is
1106 necessary because we loop based on texthigh and textlow, which do
1107 not include the data ranges. */
1108 msymbol
= lookup_minimal_symbol_by_pc_section (pc
, section
);
1109 if (msymbol
.minsym
&& msymbol
.minsym
->data_p ())
1112 for (objfile
*objfile
: current_program_space
->objfiles ())
1114 struct compunit_symtab
*cust
1115 = objfile
->find_pc_sect_compunit_symtab (msymbol
, pc
, section
, 0);
1121 /* Hash function for the symbol cache. */
1124 hash_symbol_entry (const struct objfile
*objfile_context
,
1125 const char *name
, domain_enum domain
)
1127 unsigned int hash
= (uintptr_t) objfile_context
;
1130 hash
+= htab_hash_string (name
);
1132 /* Because of symbol_matches_domain we need VAR_DOMAIN and STRUCT_DOMAIN
1133 to map to the same slot. */
1134 if (domain
== STRUCT_DOMAIN
)
1135 hash
+= VAR_DOMAIN
* 7;
1142 /* Equality function for the symbol cache. */
1145 eq_symbol_entry (const struct symbol_cache_slot
*slot
,
1146 const struct objfile
*objfile_context
,
1147 const char *name
, domain_enum domain
)
1149 const char *slot_name
;
1150 domain_enum slot_domain
;
1152 if (slot
->state
== SYMBOL_SLOT_UNUSED
)
1155 if (slot
->objfile_context
!= objfile_context
)
1158 if (slot
->state
== SYMBOL_SLOT_NOT_FOUND
)
1160 slot_name
= slot
->value
.not_found
.name
;
1161 slot_domain
= slot
->value
.not_found
.domain
;
1165 slot_name
= slot
->value
.found
.symbol
->search_name ();
1166 slot_domain
= SYMBOL_DOMAIN (slot
->value
.found
.symbol
);
1169 /* NULL names match. */
1170 if (slot_name
== NULL
&& name
== NULL
)
1172 /* But there's no point in calling symbol_matches_domain in the
1173 SYMBOL_SLOT_FOUND case. */
1174 if (slot_domain
!= domain
)
1177 else if (slot_name
!= NULL
&& name
!= NULL
)
1179 /* It's important that we use the same comparison that was done
1180 the first time through. If the slot records a found symbol,
1181 then this means using the symbol name comparison function of
1182 the symbol's language with symbol->search_name (). See
1183 dictionary.c. It also means using symbol_matches_domain for
1184 found symbols. See block.c.
1186 If the slot records a not-found symbol, then require a precise match.
1187 We could still be lax with whitespace like strcmp_iw though. */
1189 if (slot
->state
== SYMBOL_SLOT_NOT_FOUND
)
1191 if (strcmp (slot_name
, name
) != 0)
1193 if (slot_domain
!= domain
)
1198 struct symbol
*sym
= slot
->value
.found
.symbol
;
1199 lookup_name_info
lookup_name (name
, symbol_name_match_type::FULL
);
1201 if (!SYMBOL_MATCHES_SEARCH_NAME (sym
, lookup_name
))
1204 if (!symbol_matches_domain (sym
->language (), slot_domain
, domain
))
1210 /* Only one name is NULL. */
1217 /* Given a cache of size SIZE, return the size of the struct (with variable
1218 length array) in bytes. */
1221 symbol_cache_byte_size (unsigned int size
)
1223 return (sizeof (struct block_symbol_cache
)
1224 + ((size
- 1) * sizeof (struct symbol_cache_slot
)));
1230 resize_symbol_cache (struct symbol_cache
*cache
, unsigned int new_size
)
1232 /* If there's no change in size, don't do anything.
1233 All caches have the same size, so we can just compare with the size
1234 of the global symbols cache. */
1235 if ((cache
->global_symbols
!= NULL
1236 && cache
->global_symbols
->size
== new_size
)
1237 || (cache
->global_symbols
== NULL
1241 destroy_block_symbol_cache (cache
->global_symbols
);
1242 destroy_block_symbol_cache (cache
->static_symbols
);
1246 cache
->global_symbols
= NULL
;
1247 cache
->static_symbols
= NULL
;
1251 size_t total_size
= symbol_cache_byte_size (new_size
);
1253 cache
->global_symbols
1254 = (struct block_symbol_cache
*) xcalloc (1, total_size
);
1255 cache
->static_symbols
1256 = (struct block_symbol_cache
*) xcalloc (1, total_size
);
1257 cache
->global_symbols
->size
= new_size
;
1258 cache
->static_symbols
->size
= new_size
;
1262 /* Return the symbol cache of PSPACE.
1263 Create one if it doesn't exist yet. */
1265 static struct symbol_cache
*
1266 get_symbol_cache (struct program_space
*pspace
)
1268 struct symbol_cache
*cache
= symbol_cache_key
.get (pspace
);
1272 cache
= symbol_cache_key
.emplace (pspace
);
1273 resize_symbol_cache (cache
, symbol_cache_size
);
1279 /* Set the size of the symbol cache in all program spaces. */
1282 set_symbol_cache_size (unsigned int new_size
)
1284 for (struct program_space
*pspace
: program_spaces
)
1286 struct symbol_cache
*cache
= symbol_cache_key
.get (pspace
);
1288 /* The pspace could have been created but not have a cache yet. */
1290 resize_symbol_cache (cache
, new_size
);
1294 /* Called when symbol-cache-size is set. */
1297 set_symbol_cache_size_handler (const char *args
, int from_tty
,
1298 struct cmd_list_element
*c
)
1300 if (new_symbol_cache_size
> MAX_SYMBOL_CACHE_SIZE
)
1302 /* Restore the previous value.
1303 This is the value the "show" command prints. */
1304 new_symbol_cache_size
= symbol_cache_size
;
1306 error (_("Symbol cache size is too large, max is %u."),
1307 MAX_SYMBOL_CACHE_SIZE
);
1309 symbol_cache_size
= new_symbol_cache_size
;
1311 set_symbol_cache_size (symbol_cache_size
);
1314 /* Lookup symbol NAME,DOMAIN in BLOCK in the symbol cache of PSPACE.
1315 OBJFILE_CONTEXT is the current objfile, which may be NULL.
1316 The result is the symbol if found, SYMBOL_LOOKUP_FAILED if a previous lookup
1317 failed (and thus this one will too), or NULL if the symbol is not present
1319 *BSC_PTR and *SLOT_PTR are set to the cache and slot of the symbol, which
1320 can be used to save the result of a full lookup attempt. */
1322 static struct block_symbol
1323 symbol_cache_lookup (struct symbol_cache
*cache
,
1324 struct objfile
*objfile_context
, enum block_enum block
,
1325 const char *name
, domain_enum domain
,
1326 struct block_symbol_cache
**bsc_ptr
,
1327 struct symbol_cache_slot
**slot_ptr
)
1329 struct block_symbol_cache
*bsc
;
1331 struct symbol_cache_slot
*slot
;
1333 if (block
== GLOBAL_BLOCK
)
1334 bsc
= cache
->global_symbols
;
1336 bsc
= cache
->static_symbols
;
1344 hash
= hash_symbol_entry (objfile_context
, name
, domain
);
1345 slot
= bsc
->symbols
+ hash
% bsc
->size
;
1350 if (eq_symbol_entry (slot
, objfile_context
, name
, domain
))
1352 if (symbol_lookup_debug
)
1353 fprintf_unfiltered (gdb_stdlog
,
1354 "%s block symbol cache hit%s for %s, %s\n",
1355 block
== GLOBAL_BLOCK
? "Global" : "Static",
1356 slot
->state
== SYMBOL_SLOT_NOT_FOUND
1357 ? " (not found)" : "",
1358 name
, domain_name (domain
));
1360 if (slot
->state
== SYMBOL_SLOT_NOT_FOUND
)
1361 return SYMBOL_LOOKUP_FAILED
;
1362 return slot
->value
.found
;
1365 /* Symbol is not present in the cache. */
1367 if (symbol_lookup_debug
)
1369 fprintf_unfiltered (gdb_stdlog
,
1370 "%s block symbol cache miss for %s, %s\n",
1371 block
== GLOBAL_BLOCK
? "Global" : "Static",
1372 name
, domain_name (domain
));
1378 /* Mark SYMBOL as found in SLOT.
1379 OBJFILE_CONTEXT is the current objfile when the lookup was done, or NULL
1380 if it's not needed to distinguish lookups (STATIC_BLOCK). It is *not*
1381 necessarily the objfile the symbol was found in. */
1384 symbol_cache_mark_found (struct block_symbol_cache
*bsc
,
1385 struct symbol_cache_slot
*slot
,
1386 struct objfile
*objfile_context
,
1387 struct symbol
*symbol
,
1388 const struct block
*block
)
1392 if (slot
->state
!= SYMBOL_SLOT_UNUSED
)
1395 symbol_cache_clear_slot (slot
);
1397 slot
->state
= SYMBOL_SLOT_FOUND
;
1398 slot
->objfile_context
= objfile_context
;
1399 slot
->value
.found
.symbol
= symbol
;
1400 slot
->value
.found
.block
= block
;
1403 /* Mark symbol NAME, DOMAIN as not found in SLOT.
1404 OBJFILE_CONTEXT is the current objfile when the lookup was done, or NULL
1405 if it's not needed to distinguish lookups (STATIC_BLOCK). */
1408 symbol_cache_mark_not_found (struct block_symbol_cache
*bsc
,
1409 struct symbol_cache_slot
*slot
,
1410 struct objfile
*objfile_context
,
1411 const char *name
, domain_enum domain
)
1415 if (slot
->state
!= SYMBOL_SLOT_UNUSED
)
1418 symbol_cache_clear_slot (slot
);
1420 slot
->state
= SYMBOL_SLOT_NOT_FOUND
;
1421 slot
->objfile_context
= objfile_context
;
1422 slot
->value
.not_found
.name
= xstrdup (name
);
1423 slot
->value
.not_found
.domain
= domain
;
1426 /* Flush the symbol cache of PSPACE. */
1429 symbol_cache_flush (struct program_space
*pspace
)
1431 struct symbol_cache
*cache
= symbol_cache_key
.get (pspace
);
1436 if (cache
->global_symbols
== NULL
)
1438 gdb_assert (symbol_cache_size
== 0);
1439 gdb_assert (cache
->static_symbols
== NULL
);
1443 /* If the cache is untouched since the last flush, early exit.
1444 This is important for performance during the startup of a program linked
1445 with 100s (or 1000s) of shared libraries. */
1446 if (cache
->global_symbols
->misses
== 0
1447 && cache
->static_symbols
->misses
== 0)
1450 gdb_assert (cache
->global_symbols
->size
== symbol_cache_size
);
1451 gdb_assert (cache
->static_symbols
->size
== symbol_cache_size
);
1453 for (pass
= 0; pass
< 2; ++pass
)
1455 struct block_symbol_cache
*bsc
1456 = pass
== 0 ? cache
->global_symbols
: cache
->static_symbols
;
1459 for (i
= 0; i
< bsc
->size
; ++i
)
1460 symbol_cache_clear_slot (&bsc
->symbols
[i
]);
1463 cache
->global_symbols
->hits
= 0;
1464 cache
->global_symbols
->misses
= 0;
1465 cache
->global_symbols
->collisions
= 0;
1466 cache
->static_symbols
->hits
= 0;
1467 cache
->static_symbols
->misses
= 0;
1468 cache
->static_symbols
->collisions
= 0;
1474 symbol_cache_dump (const struct symbol_cache
*cache
)
1478 if (cache
->global_symbols
== NULL
)
1480 printf_filtered (" <disabled>\n");
1484 for (pass
= 0; pass
< 2; ++pass
)
1486 const struct block_symbol_cache
*bsc
1487 = pass
== 0 ? cache
->global_symbols
: cache
->static_symbols
;
1491 printf_filtered ("Global symbols:\n");
1493 printf_filtered ("Static symbols:\n");
1495 for (i
= 0; i
< bsc
->size
; ++i
)
1497 const struct symbol_cache_slot
*slot
= &bsc
->symbols
[i
];
1501 switch (slot
->state
)
1503 case SYMBOL_SLOT_UNUSED
:
1505 case SYMBOL_SLOT_NOT_FOUND
:
1506 printf_filtered (" [%4u] = %s, %s %s (not found)\n", i
,
1507 host_address_to_string (slot
->objfile_context
),
1508 slot
->value
.not_found
.name
,
1509 domain_name (slot
->value
.not_found
.domain
));
1511 case SYMBOL_SLOT_FOUND
:
1513 struct symbol
*found
= slot
->value
.found
.symbol
;
1514 const struct objfile
*context
= slot
->objfile_context
;
1516 printf_filtered (" [%4u] = %s, %s %s\n", i
,
1517 host_address_to_string (context
),
1518 found
->print_name (),
1519 domain_name (SYMBOL_DOMAIN (found
)));
1527 /* The "mt print symbol-cache" command. */
1530 maintenance_print_symbol_cache (const char *args
, int from_tty
)
1532 for (struct program_space
*pspace
: program_spaces
)
1534 struct symbol_cache
*cache
;
1536 printf_filtered (_("Symbol cache for pspace %d\n%s:\n"),
1538 pspace
->symfile_object_file
!= NULL
1539 ? objfile_name (pspace
->symfile_object_file
)
1540 : "(no object file)");
1542 /* If the cache hasn't been created yet, avoid creating one. */
1543 cache
= symbol_cache_key
.get (pspace
);
1545 printf_filtered (" <empty>\n");
1547 symbol_cache_dump (cache
);
1551 /* The "mt flush-symbol-cache" command. */
1554 maintenance_flush_symbol_cache (const char *args
, int from_tty
)
1556 for (struct program_space
*pspace
: program_spaces
)
1558 symbol_cache_flush (pspace
);
1562 /* Print usage statistics of CACHE. */
1565 symbol_cache_stats (struct symbol_cache
*cache
)
1569 if (cache
->global_symbols
== NULL
)
1571 printf_filtered (" <disabled>\n");
1575 for (pass
= 0; pass
< 2; ++pass
)
1577 const struct block_symbol_cache
*bsc
1578 = pass
== 0 ? cache
->global_symbols
: cache
->static_symbols
;
1583 printf_filtered ("Global block cache stats:\n");
1585 printf_filtered ("Static block cache stats:\n");
1587 printf_filtered (" size: %u\n", bsc
->size
);
1588 printf_filtered (" hits: %u\n", bsc
->hits
);
1589 printf_filtered (" misses: %u\n", bsc
->misses
);
1590 printf_filtered (" collisions: %u\n", bsc
->collisions
);
1594 /* The "mt print symbol-cache-statistics" command. */
1597 maintenance_print_symbol_cache_statistics (const char *args
, int from_tty
)
1599 for (struct program_space
*pspace
: program_spaces
)
1601 struct symbol_cache
*cache
;
1603 printf_filtered (_("Symbol cache statistics for pspace %d\n%s:\n"),
1605 pspace
->symfile_object_file
!= NULL
1606 ? objfile_name (pspace
->symfile_object_file
)
1607 : "(no object file)");
1609 /* If the cache hasn't been created yet, avoid creating one. */
1610 cache
= symbol_cache_key
.get (pspace
);
1612 printf_filtered (" empty, no stats available\n");
1614 symbol_cache_stats (cache
);
1618 /* This module's 'new_objfile' observer. */
1621 symtab_new_objfile_observer (struct objfile
*objfile
)
1623 /* Ideally we'd use OBJFILE->pspace, but OBJFILE may be NULL. */
1624 symbol_cache_flush (current_program_space
);
1627 /* This module's 'free_objfile' observer. */
1630 symtab_free_objfile_observer (struct objfile
*objfile
)
1632 symbol_cache_flush (objfile
->pspace
);
1635 /* Debug symbols usually don't have section information. We need to dig that
1636 out of the minimal symbols and stash that in the debug symbol. */
1639 fixup_section (struct general_symbol_info
*ginfo
,
1640 CORE_ADDR addr
, struct objfile
*objfile
)
1642 struct minimal_symbol
*msym
;
1644 /* First, check whether a minimal symbol with the same name exists
1645 and points to the same address. The address check is required
1646 e.g. on PowerPC64, where the minimal symbol for a function will
1647 point to the function descriptor, while the debug symbol will
1648 point to the actual function code. */
1649 msym
= lookup_minimal_symbol_by_pc_name (addr
, ginfo
->linkage_name (),
1652 ginfo
->set_section_index (msym
->section_index ());
1655 /* Static, function-local variables do appear in the linker
1656 (minimal) symbols, but are frequently given names that won't
1657 be found via lookup_minimal_symbol(). E.g., it has been
1658 observed in frv-uclinux (ELF) executables that a static,
1659 function-local variable named "foo" might appear in the
1660 linker symbols as "foo.6" or "foo.3". Thus, there is no
1661 point in attempting to extend the lookup-by-name mechanism to
1662 handle this case due to the fact that there can be multiple
1665 So, instead, search the section table when lookup by name has
1666 failed. The ``addr'' and ``endaddr'' fields may have already
1667 been relocated. If so, the relocation offset needs to be
1668 subtracted from these values when performing the comparison.
1669 We unconditionally subtract it, because, when no relocation
1670 has been performed, the value will simply be zero.
1672 The address of the symbol whose section we're fixing up HAS
1673 NOT BEEN adjusted (relocated) yet. It can't have been since
1674 the section isn't yet known and knowing the section is
1675 necessary in order to add the correct relocation value. In
1676 other words, we wouldn't even be in this function (attempting
1677 to compute the section) if it were already known.
1679 Note that it is possible to search the minimal symbols
1680 (subtracting the relocation value if necessary) to find the
1681 matching minimal symbol, but this is overkill and much less
1682 efficient. It is not necessary to find the matching minimal
1683 symbol, only its section.
1685 Note that this technique (of doing a section table search)
1686 can fail when unrelocated section addresses overlap. For
1687 this reason, we still attempt a lookup by name prior to doing
1688 a search of the section table. */
1690 struct obj_section
*s
;
1693 ALL_OBJFILE_OSECTIONS (objfile
, s
)
1695 int idx
= s
- objfile
->sections
;
1696 CORE_ADDR offset
= objfile
->section_offsets
[idx
];
1701 if (s
->addr () - offset
<= addr
&& addr
< s
->endaddr () - offset
)
1703 ginfo
->set_section_index (idx
);
1708 /* If we didn't find the section, assume it is in the first
1709 section. If there is no allocated section, then it hardly
1710 matters what we pick, so just pick zero. */
1712 ginfo
->set_section_index (0);
1714 ginfo
->set_section_index (fallback
);
1719 fixup_symbol_section (struct symbol
*sym
, struct objfile
*objfile
)
1726 if (!SYMBOL_OBJFILE_OWNED (sym
))
1729 /* We either have an OBJFILE, or we can get at it from the sym's
1730 symtab. Anything else is a bug. */
1731 gdb_assert (objfile
|| symbol_symtab (sym
));
1733 if (objfile
== NULL
)
1734 objfile
= symbol_objfile (sym
);
1736 if (sym
->obj_section (objfile
) != nullptr)
1739 /* We should have an objfile by now. */
1740 gdb_assert (objfile
);
1742 switch (SYMBOL_CLASS (sym
))
1746 addr
= SYMBOL_VALUE_ADDRESS (sym
);
1749 addr
= BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
));
1753 /* Nothing else will be listed in the minsyms -- no use looking
1758 fixup_section (sym
, addr
, objfile
);
1765 demangle_for_lookup_info::demangle_for_lookup_info
1766 (const lookup_name_info
&lookup_name
, language lang
)
1768 demangle_result_storage storage
;
1770 if (lookup_name
.ignore_parameters () && lang
== language_cplus
)
1772 gdb::unique_xmalloc_ptr
<char> without_params
1773 = cp_remove_params_if_any (lookup_name
.c_str (),
1774 lookup_name
.completion_mode ());
1776 if (without_params
!= NULL
)
1778 if (lookup_name
.match_type () != symbol_name_match_type::SEARCH_NAME
)
1779 m_demangled_name
= demangle_for_lookup (without_params
.get (),
1785 if (lookup_name
.match_type () == symbol_name_match_type::SEARCH_NAME
)
1786 m_demangled_name
= lookup_name
.c_str ();
1788 m_demangled_name
= demangle_for_lookup (lookup_name
.c_str (),
1794 const lookup_name_info
&
1795 lookup_name_info::match_any ()
1797 /* Lookup any symbol that "" would complete. I.e., this matches all
1799 static const lookup_name_info
lookup_name ("", symbol_name_match_type::FULL
,
1805 /* Compute the demangled form of NAME as used by the various symbol
1806 lookup functions. The result can either be the input NAME
1807 directly, or a pointer to a buffer owned by the STORAGE object.
1809 For Ada, this function just returns NAME, unmodified.
1810 Normally, Ada symbol lookups are performed using the encoded name
1811 rather than the demangled name, and so it might seem to make sense
1812 for this function to return an encoded version of NAME.
1813 Unfortunately, we cannot do this, because this function is used in
1814 circumstances where it is not appropriate to try to encode NAME.
1815 For instance, when displaying the frame info, we demangle the name
1816 of each parameter, and then perform a symbol lookup inside our
1817 function using that demangled name. In Ada, certain functions
1818 have internally-generated parameters whose name contain uppercase
1819 characters. Encoding those name would result in those uppercase
1820 characters to become lowercase, and thus cause the symbol lookup
1824 demangle_for_lookup (const char *name
, enum language lang
,
1825 demangle_result_storage
&storage
)
1827 /* If we are using C++, D, or Go, demangle the name before doing a
1828 lookup, so we can always binary search. */
1829 if (lang
== language_cplus
)
1831 char *demangled_name
= gdb_demangle (name
, DMGL_ANSI
| DMGL_PARAMS
);
1832 if (demangled_name
!= NULL
)
1833 return storage
.set_malloc_ptr (demangled_name
);
1835 /* If we were given a non-mangled name, canonicalize it
1836 according to the language (so far only for C++). */
1837 gdb::unique_xmalloc_ptr
<char> canon
= cp_canonicalize_string (name
);
1838 if (canon
!= nullptr)
1839 return storage
.set_malloc_ptr (std::move (canon
));
1841 else if (lang
== language_d
)
1843 char *demangled_name
= d_demangle (name
, 0);
1844 if (demangled_name
!= NULL
)
1845 return storage
.set_malloc_ptr (demangled_name
);
1847 else if (lang
== language_go
)
1849 char *demangled_name
1850 = language_def (language_go
)->demangle_symbol (name
, 0);
1851 if (demangled_name
!= NULL
)
1852 return storage
.set_malloc_ptr (demangled_name
);
1861 search_name_hash (enum language language
, const char *search_name
)
1863 return language_def (language
)->search_name_hash (search_name
);
1868 This function (or rather its subordinates) have a bunch of loops and
1869 it would seem to be attractive to put in some QUIT's (though I'm not really
1870 sure whether it can run long enough to be really important). But there
1871 are a few calls for which it would appear to be bad news to quit
1872 out of here: e.g., find_proc_desc in alpha-mdebug-tdep.c. (Note
1873 that there is C++ code below which can error(), but that probably
1874 doesn't affect these calls since they are looking for a known
1875 variable and thus can probably assume it will never hit the C++
1879 lookup_symbol_in_language (const char *name
, const struct block
*block
,
1880 const domain_enum domain
, enum language lang
,
1881 struct field_of_this_result
*is_a_field_of_this
)
1883 demangle_result_storage storage
;
1884 const char *modified_name
= demangle_for_lookup (name
, lang
, storage
);
1886 return lookup_symbol_aux (modified_name
,
1887 symbol_name_match_type::FULL
,
1888 block
, domain
, lang
,
1889 is_a_field_of_this
);
1895 lookup_symbol (const char *name
, const struct block
*block
,
1897 struct field_of_this_result
*is_a_field_of_this
)
1899 return lookup_symbol_in_language (name
, block
, domain
,
1900 current_language
->la_language
,
1901 is_a_field_of_this
);
1907 lookup_symbol_search_name (const char *search_name
, const struct block
*block
,
1910 return lookup_symbol_aux (search_name
, symbol_name_match_type::SEARCH_NAME
,
1911 block
, domain
, language_asm
, NULL
);
1917 lookup_language_this (const struct language_defn
*lang
,
1918 const struct block
*block
)
1920 if (lang
->name_of_this () == NULL
|| block
== NULL
)
1923 if (symbol_lookup_debug
> 1)
1925 struct objfile
*objfile
= block_objfile (block
);
1927 fprintf_unfiltered (gdb_stdlog
,
1928 "lookup_language_this (%s, %s (objfile %s))",
1929 lang
->name (), host_address_to_string (block
),
1930 objfile_debug_name (objfile
));
1937 sym
= block_lookup_symbol (block
, lang
->name_of_this (),
1938 symbol_name_match_type::SEARCH_NAME
,
1942 if (symbol_lookup_debug
> 1)
1944 fprintf_unfiltered (gdb_stdlog
, " = %s (%s, block %s)\n",
1946 host_address_to_string (sym
),
1947 host_address_to_string (block
));
1949 return (struct block_symbol
) {sym
, block
};
1951 if (BLOCK_FUNCTION (block
))
1953 block
= BLOCK_SUPERBLOCK (block
);
1956 if (symbol_lookup_debug
> 1)
1957 fprintf_unfiltered (gdb_stdlog
, " = NULL\n");
1961 /* Given TYPE, a structure/union,
1962 return 1 if the component named NAME from the ultimate target
1963 structure/union is defined, otherwise, return 0. */
1966 check_field (struct type
*type
, const char *name
,
1967 struct field_of_this_result
*is_a_field_of_this
)
1971 /* The type may be a stub. */
1972 type
= check_typedef (type
);
1974 for (i
= type
->num_fields () - 1; i
>= TYPE_N_BASECLASSES (type
); i
--)
1976 const char *t_field_name
= type
->field (i
).name ();
1978 if (t_field_name
&& (strcmp_iw (t_field_name
, name
) == 0))
1980 is_a_field_of_this
->type
= type
;
1981 is_a_field_of_this
->field
= &type
->field (i
);
1986 /* C++: If it was not found as a data field, then try to return it
1987 as a pointer to a method. */
1989 for (i
= TYPE_NFN_FIELDS (type
) - 1; i
>= 0; --i
)
1991 if (strcmp_iw (TYPE_FN_FIELDLIST_NAME (type
, i
), name
) == 0)
1993 is_a_field_of_this
->type
= type
;
1994 is_a_field_of_this
->fn_field
= &TYPE_FN_FIELDLIST (type
, i
);
1999 for (i
= TYPE_N_BASECLASSES (type
) - 1; i
>= 0; i
--)
2000 if (check_field (TYPE_BASECLASS (type
, i
), name
, is_a_field_of_this
))
2006 /* Behave like lookup_symbol except that NAME is the natural name
2007 (e.g., demangled name) of the symbol that we're looking for. */
2009 static struct block_symbol
2010 lookup_symbol_aux (const char *name
, symbol_name_match_type match_type
,
2011 const struct block
*block
,
2012 const domain_enum domain
, enum language language
,
2013 struct field_of_this_result
*is_a_field_of_this
)
2015 struct block_symbol result
;
2016 const struct language_defn
*langdef
;
2018 if (symbol_lookup_debug
)
2020 struct objfile
*objfile
= (block
== nullptr
2021 ? nullptr : block_objfile (block
));
2023 fprintf_unfiltered (gdb_stdlog
,
2024 "lookup_symbol_aux (%s, %s (objfile %s), %s, %s)\n",
2025 name
, host_address_to_string (block
),
2027 ? objfile_debug_name (objfile
) : "NULL",
2028 domain_name (domain
), language_str (language
));
2031 /* Make sure we do something sensible with is_a_field_of_this, since
2032 the callers that set this parameter to some non-null value will
2033 certainly use it later. If we don't set it, the contents of
2034 is_a_field_of_this are undefined. */
2035 if (is_a_field_of_this
!= NULL
)
2036 memset (is_a_field_of_this
, 0, sizeof (*is_a_field_of_this
));
2038 /* Search specified block and its superiors. Don't search
2039 STATIC_BLOCK or GLOBAL_BLOCK. */
2041 result
= lookup_local_symbol (name
, match_type
, block
, domain
, language
);
2042 if (result
.symbol
!= NULL
)
2044 if (symbol_lookup_debug
)
2046 fprintf_unfiltered (gdb_stdlog
, "lookup_symbol_aux (...) = %s\n",
2047 host_address_to_string (result
.symbol
));
2052 /* If requested to do so by the caller and if appropriate for LANGUAGE,
2053 check to see if NAME is a field of `this'. */
2055 langdef
= language_def (language
);
2057 /* Don't do this check if we are searching for a struct. It will
2058 not be found by check_field, but will be found by other
2060 if (is_a_field_of_this
!= NULL
&& domain
!= STRUCT_DOMAIN
)
2062 result
= lookup_language_this (langdef
, block
);
2066 struct type
*t
= result
.symbol
->type
;
2068 /* I'm not really sure that type of this can ever
2069 be typedefed; just be safe. */
2070 t
= check_typedef (t
);
2071 if (t
->is_pointer_or_reference ())
2072 t
= TYPE_TARGET_TYPE (t
);
2074 if (t
->code () != TYPE_CODE_STRUCT
2075 && t
->code () != TYPE_CODE_UNION
)
2076 error (_("Internal error: `%s' is not an aggregate"),
2077 langdef
->name_of_this ());
2079 if (check_field (t
, name
, is_a_field_of_this
))
2081 if (symbol_lookup_debug
)
2083 fprintf_unfiltered (gdb_stdlog
,
2084 "lookup_symbol_aux (...) = NULL\n");
2091 /* Now do whatever is appropriate for LANGUAGE to look
2092 up static and global variables. */
2094 result
= langdef
->lookup_symbol_nonlocal (name
, block
, domain
);
2095 if (result
.symbol
!= NULL
)
2097 if (symbol_lookup_debug
)
2099 fprintf_unfiltered (gdb_stdlog
, "lookup_symbol_aux (...) = %s\n",
2100 host_address_to_string (result
.symbol
));
2105 /* Now search all static file-level symbols. Not strictly correct,
2106 but more useful than an error. */
2108 result
= lookup_static_symbol (name
, domain
);
2109 if (symbol_lookup_debug
)
2111 fprintf_unfiltered (gdb_stdlog
, "lookup_symbol_aux (...) = %s\n",
2112 result
.symbol
!= NULL
2113 ? host_address_to_string (result
.symbol
)
2119 /* Check to see if the symbol is defined in BLOCK or its superiors.
2120 Don't search STATIC_BLOCK or GLOBAL_BLOCK. */
2122 static struct block_symbol
2123 lookup_local_symbol (const char *name
,
2124 symbol_name_match_type match_type
,
2125 const struct block
*block
,
2126 const domain_enum domain
,
2127 enum language language
)
2130 const struct block
*static_block
= block_static_block (block
);
2131 const char *scope
= block_scope (block
);
2133 /* Check if either no block is specified or it's a global block. */
2135 if (static_block
== NULL
)
2138 while (block
!= static_block
)
2140 sym
= lookup_symbol_in_block (name
, match_type
, block
, domain
);
2142 return (struct block_symbol
) {sym
, block
};
2144 if (language
== language_cplus
|| language
== language_fortran
)
2146 struct block_symbol blocksym
2147 = cp_lookup_symbol_imports_or_template (scope
, name
, block
,
2150 if (blocksym
.symbol
!= NULL
)
2154 if (BLOCK_FUNCTION (block
) != NULL
&& block_inlined_p (block
))
2156 block
= BLOCK_SUPERBLOCK (block
);
2159 /* We've reached the end of the function without finding a result. */
2167 lookup_symbol_in_block (const char *name
, symbol_name_match_type match_type
,
2168 const struct block
*block
,
2169 const domain_enum domain
)
2173 if (symbol_lookup_debug
> 1)
2175 struct objfile
*objfile
= (block
== nullptr
2176 ? nullptr : block_objfile (block
));
2178 fprintf_unfiltered (gdb_stdlog
,
2179 "lookup_symbol_in_block (%s, %s (objfile %s), %s)",
2180 name
, host_address_to_string (block
),
2181 objfile_debug_name (objfile
),
2182 domain_name (domain
));
2185 sym
= block_lookup_symbol (block
, name
, match_type
, domain
);
2188 if (symbol_lookup_debug
> 1)
2190 fprintf_unfiltered (gdb_stdlog
, " = %s\n",
2191 host_address_to_string (sym
));
2193 return fixup_symbol_section (sym
, NULL
);
2196 if (symbol_lookup_debug
> 1)
2197 fprintf_unfiltered (gdb_stdlog
, " = NULL\n");
2204 lookup_global_symbol_from_objfile (struct objfile
*main_objfile
,
2205 enum block_enum block_index
,
2207 const domain_enum domain
)
2209 gdb_assert (block_index
== GLOBAL_BLOCK
|| block_index
== STATIC_BLOCK
);
2211 for (objfile
*objfile
: main_objfile
->separate_debug_objfiles ())
2213 struct block_symbol result
2214 = lookup_symbol_in_objfile (objfile
, block_index
, name
, domain
);
2216 if (result
.symbol
!= nullptr)
2223 /* Check to see if the symbol is defined in one of the OBJFILE's
2224 symtabs. BLOCK_INDEX should be either GLOBAL_BLOCK or STATIC_BLOCK,
2225 depending on whether or not we want to search global symbols or
2228 static struct block_symbol
2229 lookup_symbol_in_objfile_symtabs (struct objfile
*objfile
,
2230 enum block_enum block_index
, const char *name
,
2231 const domain_enum domain
)
2233 gdb_assert (block_index
== GLOBAL_BLOCK
|| block_index
== STATIC_BLOCK
);
2235 if (symbol_lookup_debug
> 1)
2237 fprintf_unfiltered (gdb_stdlog
,
2238 "lookup_symbol_in_objfile_symtabs (%s, %s, %s, %s)",
2239 objfile_debug_name (objfile
),
2240 block_index
== GLOBAL_BLOCK
2241 ? "GLOBAL_BLOCK" : "STATIC_BLOCK",
2242 name
, domain_name (domain
));
2245 struct block_symbol other
;
2246 other
.symbol
= NULL
;
2247 for (compunit_symtab
*cust
: objfile
->compunits ())
2249 const struct blockvector
*bv
;
2250 const struct block
*block
;
2251 struct block_symbol result
;
2253 bv
= COMPUNIT_BLOCKVECTOR (cust
);
2254 block
= BLOCKVECTOR_BLOCK (bv
, block_index
);
2255 result
.symbol
= block_lookup_symbol_primary (block
, name
, domain
);
2256 result
.block
= block
;
2257 if (result
.symbol
== NULL
)
2259 if (best_symbol (result
.symbol
, domain
))
2264 if (symbol_matches_domain (result
.symbol
->language (),
2265 SYMBOL_DOMAIN (result
.symbol
), domain
))
2267 struct symbol
*better
2268 = better_symbol (other
.symbol
, result
.symbol
, domain
);
2269 if (better
!= other
.symbol
)
2271 other
.symbol
= better
;
2272 other
.block
= block
;
2277 if (other
.symbol
!= NULL
)
2279 if (symbol_lookup_debug
> 1)
2281 fprintf_unfiltered (gdb_stdlog
, " = %s (block %s)\n",
2282 host_address_to_string (other
.symbol
),
2283 host_address_to_string (other
.block
));
2285 other
.symbol
= fixup_symbol_section (other
.symbol
, objfile
);
2289 if (symbol_lookup_debug
> 1)
2290 fprintf_unfiltered (gdb_stdlog
, " = NULL\n");
2294 /* Wrapper around lookup_symbol_in_objfile_symtabs for search_symbols.
2295 Look up LINKAGE_NAME in DOMAIN in the global and static blocks of OBJFILE
2296 and all associated separate debug objfiles.
2298 Normally we only look in OBJFILE, and not any separate debug objfiles
2299 because the outer loop will cause them to be searched too. This case is
2300 different. Here we're called from search_symbols where it will only
2301 call us for the objfile that contains a matching minsym. */
2303 static struct block_symbol
2304 lookup_symbol_in_objfile_from_linkage_name (struct objfile
*objfile
,
2305 const char *linkage_name
,
2308 enum language lang
= current_language
->la_language
;
2309 struct objfile
*main_objfile
;
2311 demangle_result_storage storage
;
2312 const char *modified_name
= demangle_for_lookup (linkage_name
, lang
, storage
);
2314 if (objfile
->separate_debug_objfile_backlink
)
2315 main_objfile
= objfile
->separate_debug_objfile_backlink
;
2317 main_objfile
= objfile
;
2319 for (::objfile
*cur_objfile
: main_objfile
->separate_debug_objfiles ())
2321 struct block_symbol result
;
2323 result
= lookup_symbol_in_objfile_symtabs (cur_objfile
, GLOBAL_BLOCK
,
2324 modified_name
, domain
);
2325 if (result
.symbol
== NULL
)
2326 result
= lookup_symbol_in_objfile_symtabs (cur_objfile
, STATIC_BLOCK
,
2327 modified_name
, domain
);
2328 if (result
.symbol
!= NULL
)
2335 /* A helper function that throws an exception when a symbol was found
2336 in a psymtab but not in a symtab. */
2338 static void ATTRIBUTE_NORETURN
2339 error_in_psymtab_expansion (enum block_enum block_index
, const char *name
,
2340 struct compunit_symtab
*cust
)
2343 Internal: %s symbol `%s' found in %s psymtab but not in symtab.\n\
2344 %s may be an inlined function, or may be a template function\n \
2345 (if a template, try specifying an instantiation: %s<type>)."),
2346 block_index
== GLOBAL_BLOCK
? "global" : "static",
2348 symtab_to_filename_for_display (compunit_primary_filetab (cust
)),
2352 /* A helper function for various lookup routines that interfaces with
2353 the "quick" symbol table functions. */
2355 static struct block_symbol
2356 lookup_symbol_via_quick_fns (struct objfile
*objfile
,
2357 enum block_enum block_index
, const char *name
,
2358 const domain_enum domain
)
2360 struct compunit_symtab
*cust
;
2361 const struct blockvector
*bv
;
2362 const struct block
*block
;
2363 struct block_symbol result
;
2365 if (symbol_lookup_debug
> 1)
2367 fprintf_unfiltered (gdb_stdlog
,
2368 "lookup_symbol_via_quick_fns (%s, %s, %s, %s)\n",
2369 objfile_debug_name (objfile
),
2370 block_index
== GLOBAL_BLOCK
2371 ? "GLOBAL_BLOCK" : "STATIC_BLOCK",
2372 name
, domain_name (domain
));
2375 cust
= objfile
->lookup_symbol (block_index
, name
, domain
);
2378 if (symbol_lookup_debug
> 1)
2380 fprintf_unfiltered (gdb_stdlog
,
2381 "lookup_symbol_via_quick_fns (...) = NULL\n");
2386 bv
= COMPUNIT_BLOCKVECTOR (cust
);
2387 block
= BLOCKVECTOR_BLOCK (bv
, block_index
);
2388 result
.symbol
= block_lookup_symbol (block
, name
,
2389 symbol_name_match_type::FULL
, domain
);
2390 if (result
.symbol
== NULL
)
2391 error_in_psymtab_expansion (block_index
, name
, cust
);
2393 if (symbol_lookup_debug
> 1)
2395 fprintf_unfiltered (gdb_stdlog
,
2396 "lookup_symbol_via_quick_fns (...) = %s (block %s)\n",
2397 host_address_to_string (result
.symbol
),
2398 host_address_to_string (block
));
2401 result
.symbol
= fixup_symbol_section (result
.symbol
, objfile
);
2402 result
.block
= block
;
2406 /* See language.h. */
2409 language_defn::lookup_symbol_nonlocal (const char *name
,
2410 const struct block
*block
,
2411 const domain_enum domain
) const
2413 struct block_symbol result
;
2415 /* NOTE: dje/2014-10-26: The lookup in all objfiles search could skip
2416 the current objfile. Searching the current objfile first is useful
2417 for both matching user expectations as well as performance. */
2419 result
= lookup_symbol_in_static_block (name
, block
, domain
);
2420 if (result
.symbol
!= NULL
)
2423 /* If we didn't find a definition for a builtin type in the static block,
2424 search for it now. This is actually the right thing to do and can be
2425 a massive performance win. E.g., when debugging a program with lots of
2426 shared libraries we could search all of them only to find out the
2427 builtin type isn't defined in any of them. This is common for types
2429 if (domain
== VAR_DOMAIN
)
2431 struct gdbarch
*gdbarch
;
2434 gdbarch
= target_gdbarch ();
2436 gdbarch
= block_gdbarch (block
);
2437 result
.symbol
= language_lookup_primitive_type_as_symbol (this,
2439 result
.block
= NULL
;
2440 if (result
.symbol
!= NULL
)
2444 return lookup_global_symbol (name
, block
, domain
);
2450 lookup_symbol_in_static_block (const char *name
,
2451 const struct block
*block
,
2452 const domain_enum domain
)
2454 const struct block
*static_block
= block_static_block (block
);
2457 if (static_block
== NULL
)
2460 if (symbol_lookup_debug
)
2462 struct objfile
*objfile
= (block
== nullptr
2463 ? nullptr : block_objfile (block
));
2465 fprintf_unfiltered (gdb_stdlog
,
2466 "lookup_symbol_in_static_block (%s, %s (objfile %s),"
2469 host_address_to_string (block
),
2470 objfile_debug_name (objfile
),
2471 domain_name (domain
));
2474 sym
= lookup_symbol_in_block (name
,
2475 symbol_name_match_type::FULL
,
2476 static_block
, domain
);
2477 if (symbol_lookup_debug
)
2479 fprintf_unfiltered (gdb_stdlog
,
2480 "lookup_symbol_in_static_block (...) = %s\n",
2481 sym
!= NULL
? host_address_to_string (sym
) : "NULL");
2483 return (struct block_symbol
) {sym
, static_block
};
2486 /* Perform the standard symbol lookup of NAME in OBJFILE:
2487 1) First search expanded symtabs, and if not found
2488 2) Search the "quick" symtabs (partial or .gdb_index).
2489 BLOCK_INDEX is one of GLOBAL_BLOCK or STATIC_BLOCK. */
2491 static struct block_symbol
2492 lookup_symbol_in_objfile (struct objfile
*objfile
, enum block_enum block_index
,
2493 const char *name
, const domain_enum domain
)
2495 struct block_symbol result
;
2497 gdb_assert (block_index
== GLOBAL_BLOCK
|| block_index
== STATIC_BLOCK
);
2499 if (symbol_lookup_debug
)
2501 fprintf_unfiltered (gdb_stdlog
,
2502 "lookup_symbol_in_objfile (%s, %s, %s, %s)\n",
2503 objfile_debug_name (objfile
),
2504 block_index
== GLOBAL_BLOCK
2505 ? "GLOBAL_BLOCK" : "STATIC_BLOCK",
2506 name
, domain_name (domain
));
2509 result
= lookup_symbol_in_objfile_symtabs (objfile
, block_index
,
2511 if (result
.symbol
!= NULL
)
2513 if (symbol_lookup_debug
)
2515 fprintf_unfiltered (gdb_stdlog
,
2516 "lookup_symbol_in_objfile (...) = %s"
2518 host_address_to_string (result
.symbol
));
2523 result
= lookup_symbol_via_quick_fns (objfile
, block_index
,
2525 if (symbol_lookup_debug
)
2527 fprintf_unfiltered (gdb_stdlog
,
2528 "lookup_symbol_in_objfile (...) = %s%s\n",
2529 result
.symbol
!= NULL
2530 ? host_address_to_string (result
.symbol
)
2532 result
.symbol
!= NULL
? " (via quick fns)" : "");
2537 /* Find the language for partial symbol with NAME. */
2539 static enum language
2540 find_quick_global_symbol_language (const char *name
, const domain_enum domain
)
2542 for (objfile
*objfile
: current_program_space
->objfiles ())
2544 bool symbol_found_p
;
2546 = objfile
->lookup_global_symbol_language (name
, domain
, &symbol_found_p
);
2551 return language_unknown
;
2554 /* Private data to be used with lookup_symbol_global_iterator_cb. */
2556 struct global_or_static_sym_lookup_data
2558 /* The name of the symbol we are searching for. */
2561 /* The domain to use for our search. */
2564 /* The block index in which to search. */
2565 enum block_enum block_index
;
2567 /* The field where the callback should store the symbol if found.
2568 It should be initialized to {NULL, NULL} before the search is started. */
2569 struct block_symbol result
;
2572 /* A callback function for gdbarch_iterate_over_objfiles_in_search_order.
2573 It searches by name for a symbol in the block given by BLOCK_INDEX of the
2574 given OBJFILE. The arguments for the search are passed via CB_DATA, which
2575 in reality is a pointer to struct global_or_static_sym_lookup_data. */
2578 lookup_symbol_global_or_static_iterator_cb (struct objfile
*objfile
,
2581 struct global_or_static_sym_lookup_data
*data
=
2582 (struct global_or_static_sym_lookup_data
*) cb_data
;
2584 gdb_assert (data
->result
.symbol
== NULL
2585 && data
->result
.block
== NULL
);
2587 data
->result
= lookup_symbol_in_objfile (objfile
, data
->block_index
,
2588 data
->name
, data
->domain
);
2590 /* If we found a match, tell the iterator to stop. Otherwise,
2592 return (data
->result
.symbol
!= NULL
);
2595 /* This function contains the common code of lookup_{global,static}_symbol.
2596 OBJFILE is only used if BLOCK_INDEX is GLOBAL_SCOPE, in which case it is
2597 the objfile to start the lookup in. */
2599 static struct block_symbol
2600 lookup_global_or_static_symbol (const char *name
,
2601 enum block_enum block_index
,
2602 struct objfile
*objfile
,
2603 const domain_enum domain
)
2605 struct symbol_cache
*cache
= get_symbol_cache (current_program_space
);
2606 struct block_symbol result
;
2607 struct global_or_static_sym_lookup_data lookup_data
;
2608 struct block_symbol_cache
*bsc
;
2609 struct symbol_cache_slot
*slot
;
2611 gdb_assert (block_index
== GLOBAL_BLOCK
|| block_index
== STATIC_BLOCK
);
2612 gdb_assert (objfile
== nullptr || block_index
== GLOBAL_BLOCK
);
2614 /* First see if we can find the symbol in the cache.
2615 This works because we use the current objfile to qualify the lookup. */
2616 result
= symbol_cache_lookup (cache
, objfile
, block_index
, name
, domain
,
2618 if (result
.symbol
!= NULL
)
2620 if (SYMBOL_LOOKUP_FAILED_P (result
))
2625 /* Do a global search (of global blocks, heh). */
2626 if (result
.symbol
== NULL
)
2628 memset (&lookup_data
, 0, sizeof (lookup_data
));
2629 lookup_data
.name
= name
;
2630 lookup_data
.block_index
= block_index
;
2631 lookup_data
.domain
= domain
;
2632 gdbarch_iterate_over_objfiles_in_search_order
2633 (objfile
!= NULL
? objfile
->arch () : target_gdbarch (),
2634 lookup_symbol_global_or_static_iterator_cb
, &lookup_data
, objfile
);
2635 result
= lookup_data
.result
;
2638 if (result
.symbol
!= NULL
)
2639 symbol_cache_mark_found (bsc
, slot
, objfile
, result
.symbol
, result
.block
);
2641 symbol_cache_mark_not_found (bsc
, slot
, objfile
, name
, domain
);
2649 lookup_static_symbol (const char *name
, const domain_enum domain
)
2651 return lookup_global_or_static_symbol (name
, STATIC_BLOCK
, nullptr, domain
);
2657 lookup_global_symbol (const char *name
,
2658 const struct block
*block
,
2659 const domain_enum domain
)
2661 /* If a block was passed in, we want to search the corresponding
2662 global block first. This yields "more expected" behavior, and is
2663 needed to support 'FILENAME'::VARIABLE lookups. */
2664 const struct block
*global_block
= block_global_block (block
);
2666 if (global_block
!= nullptr)
2668 sym
= lookup_symbol_in_block (name
,
2669 symbol_name_match_type::FULL
,
2670 global_block
, domain
);
2671 if (sym
!= NULL
&& best_symbol (sym
, domain
))
2672 return { sym
, global_block
};
2675 struct objfile
*objfile
= nullptr;
2676 if (block
!= nullptr)
2678 objfile
= block_objfile (block
);
2679 if (objfile
->separate_debug_objfile_backlink
!= nullptr)
2680 objfile
= objfile
->separate_debug_objfile_backlink
;
2684 = lookup_global_or_static_symbol (name
, GLOBAL_BLOCK
, objfile
, domain
);
2685 if (better_symbol (sym
, bs
.symbol
, domain
) == sym
)
2686 return { sym
, global_block
};
2692 symbol_matches_domain (enum language symbol_language
,
2693 domain_enum symbol_domain
,
2696 /* For C++ "struct foo { ... }" also defines a typedef for "foo".
2697 Similarly, any Ada type declaration implicitly defines a typedef. */
2698 if (symbol_language
== language_cplus
2699 || symbol_language
== language_d
2700 || symbol_language
== language_ada
2701 || symbol_language
== language_rust
)
2703 if ((domain
== VAR_DOMAIN
|| domain
== STRUCT_DOMAIN
)
2704 && symbol_domain
== STRUCT_DOMAIN
)
2707 /* For all other languages, strict match is required. */
2708 return (symbol_domain
== domain
);
2714 lookup_transparent_type (const char *name
)
2716 return current_language
->lookup_transparent_type (name
);
2719 /* A helper for basic_lookup_transparent_type that interfaces with the
2720 "quick" symbol table functions. */
2722 static struct type
*
2723 basic_lookup_transparent_type_quick (struct objfile
*objfile
,
2724 enum block_enum block_index
,
2727 struct compunit_symtab
*cust
;
2728 const struct blockvector
*bv
;
2729 const struct block
*block
;
2732 cust
= objfile
->lookup_symbol (block_index
, name
, STRUCT_DOMAIN
);
2736 bv
= COMPUNIT_BLOCKVECTOR (cust
);
2737 block
= BLOCKVECTOR_BLOCK (bv
, block_index
);
2738 sym
= block_find_symbol (block
, name
, STRUCT_DOMAIN
,
2739 block_find_non_opaque_type
, NULL
);
2741 error_in_psymtab_expansion (block_index
, name
, cust
);
2742 gdb_assert (!TYPE_IS_OPAQUE (SYMBOL_TYPE (sym
)));
2743 return SYMBOL_TYPE (sym
);
2746 /* Subroutine of basic_lookup_transparent_type to simplify it.
2747 Look up the non-opaque definition of NAME in BLOCK_INDEX of OBJFILE.
2748 BLOCK_INDEX is either GLOBAL_BLOCK or STATIC_BLOCK. */
2750 static struct type
*
2751 basic_lookup_transparent_type_1 (struct objfile
*objfile
,
2752 enum block_enum block_index
,
2755 const struct blockvector
*bv
;
2756 const struct block
*block
;
2757 const struct symbol
*sym
;
2759 for (compunit_symtab
*cust
: objfile
->compunits ())
2761 bv
= COMPUNIT_BLOCKVECTOR (cust
);
2762 block
= BLOCKVECTOR_BLOCK (bv
, block_index
);
2763 sym
= block_find_symbol (block
, name
, STRUCT_DOMAIN
,
2764 block_find_non_opaque_type
, NULL
);
2767 gdb_assert (!TYPE_IS_OPAQUE (SYMBOL_TYPE (sym
)));
2768 return SYMBOL_TYPE (sym
);
2775 /* The standard implementation of lookup_transparent_type. This code
2776 was modeled on lookup_symbol -- the parts not relevant to looking
2777 up types were just left out. In particular it's assumed here that
2778 types are available in STRUCT_DOMAIN and only in file-static or
2782 basic_lookup_transparent_type (const char *name
)
2786 /* Now search all the global symbols. Do the symtab's first, then
2787 check the psymtab's. If a psymtab indicates the existence
2788 of the desired name as a global, then do psymtab-to-symtab
2789 conversion on the fly and return the found symbol. */
2791 for (objfile
*objfile
: current_program_space
->objfiles ())
2793 t
= basic_lookup_transparent_type_1 (objfile
, GLOBAL_BLOCK
, name
);
2798 for (objfile
*objfile
: current_program_space
->objfiles ())
2800 t
= basic_lookup_transparent_type_quick (objfile
, GLOBAL_BLOCK
, name
);
2805 /* Now search the static file-level symbols.
2806 Not strictly correct, but more useful than an error.
2807 Do the symtab's first, then
2808 check the psymtab's. If a psymtab indicates the existence
2809 of the desired name as a file-level static, then do psymtab-to-symtab
2810 conversion on the fly and return the found symbol. */
2812 for (objfile
*objfile
: current_program_space
->objfiles ())
2814 t
= basic_lookup_transparent_type_1 (objfile
, STATIC_BLOCK
, name
);
2819 for (objfile
*objfile
: current_program_space
->objfiles ())
2821 t
= basic_lookup_transparent_type_quick (objfile
, STATIC_BLOCK
, name
);
2826 return (struct type
*) 0;
2832 iterate_over_symbols (const struct block
*block
,
2833 const lookup_name_info
&name
,
2834 const domain_enum domain
,
2835 gdb::function_view
<symbol_found_callback_ftype
> callback
)
2837 struct block_iterator iter
;
2840 ALL_BLOCK_SYMBOLS_WITH_NAME (block
, name
, iter
, sym
)
2842 if (symbol_matches_domain (sym
->language (), SYMBOL_DOMAIN (sym
), domain
))
2844 struct block_symbol block_sym
= {sym
, block
};
2846 if (!callback (&block_sym
))
2856 iterate_over_symbols_terminated
2857 (const struct block
*block
,
2858 const lookup_name_info
&name
,
2859 const domain_enum domain
,
2860 gdb::function_view
<symbol_found_callback_ftype
> callback
)
2862 if (!iterate_over_symbols (block
, name
, domain
, callback
))
2864 struct block_symbol block_sym
= {nullptr, block
};
2865 return callback (&block_sym
);
2868 /* Find the compunit symtab associated with PC and SECTION.
2869 This will read in debug info as necessary. */
2871 struct compunit_symtab
*
2872 find_pc_sect_compunit_symtab (CORE_ADDR pc
, struct obj_section
*section
)
2874 struct compunit_symtab
*best_cust
= NULL
;
2875 CORE_ADDR best_cust_range
= 0;
2876 struct bound_minimal_symbol msymbol
;
2878 /* If we know that this is not a text address, return failure. This is
2879 necessary because we loop based on the block's high and low code
2880 addresses, which do not include the data ranges, and because
2881 we call find_pc_sect_psymtab which has a similar restriction based
2882 on the partial_symtab's texthigh and textlow. */
2883 msymbol
= lookup_minimal_symbol_by_pc_section (pc
, section
);
2884 if (msymbol
.minsym
&& msymbol
.minsym
->data_p ())
2887 /* Search all symtabs for the one whose file contains our address, and which
2888 is the smallest of all the ones containing the address. This is designed
2889 to deal with a case like symtab a is at 0x1000-0x2000 and 0x3000-0x4000
2890 and symtab b is at 0x2000-0x3000. So the GLOBAL_BLOCK for a is from
2891 0x1000-0x4000, but for address 0x2345 we want to return symtab b.
2893 This happens for native ecoff format, where code from included files
2894 gets its own symtab. The symtab for the included file should have
2895 been read in already via the dependency mechanism.
2896 It might be swifter to create several symtabs with the same name
2897 like xcoff does (I'm not sure).
2899 It also happens for objfiles that have their functions reordered.
2900 For these, the symtab we are looking for is not necessarily read in. */
2902 for (objfile
*obj_file
: current_program_space
->objfiles ())
2904 for (compunit_symtab
*cust
: obj_file
->compunits ())
2906 const struct blockvector
*bv
= COMPUNIT_BLOCKVECTOR (cust
);
2907 const struct block
*global_block
2908 = BLOCKVECTOR_BLOCK (bv
, GLOBAL_BLOCK
);
2909 CORE_ADDR start
= BLOCK_START (global_block
);
2910 CORE_ADDR end
= BLOCK_END (global_block
);
2911 bool in_range_p
= start
<= pc
&& pc
< end
;
2915 if (BLOCKVECTOR_MAP (bv
))
2917 if (addrmap_find (BLOCKVECTOR_MAP (bv
), pc
) == nullptr)
2923 CORE_ADDR range
= end
- start
;
2924 if (best_cust
!= nullptr
2925 && range
>= best_cust_range
)
2926 /* Cust doesn't have a smaller range than best_cust, skip it. */
2929 /* For an objfile that has its functions reordered,
2930 find_pc_psymtab will find the proper partial symbol table
2931 and we simply return its corresponding symtab. */
2932 /* In order to better support objfiles that contain both
2933 stabs and coff debugging info, we continue on if a psymtab
2935 if ((obj_file
->flags
& OBJF_REORDERED
) != 0)
2937 struct compunit_symtab
*result
;
2940 = obj_file
->find_pc_sect_compunit_symtab (msymbol
,
2950 struct symbol
*sym
= NULL
;
2951 struct block_iterator iter
;
2953 for (int b_index
= GLOBAL_BLOCK
;
2954 b_index
<= STATIC_BLOCK
&& sym
== NULL
;
2957 const struct block
*b
= BLOCKVECTOR_BLOCK (bv
, b_index
);
2958 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
2960 fixup_symbol_section (sym
, obj_file
);
2961 if (matching_obj_sections (sym
->obj_section (obj_file
),
2967 continue; /* No symbol in this symtab matches
2971 /* Cust is best found sofar, save it. */
2973 best_cust_range
= range
;
2977 if (best_cust
!= NULL
)
2980 /* Not found in symtabs, search the "quick" symtabs (e.g. psymtabs). */
2982 for (objfile
*objf
: current_program_space
->objfiles ())
2984 struct compunit_symtab
*result
2985 = objf
->find_pc_sect_compunit_symtab (msymbol
, pc
, section
, 1);
2993 /* Find the compunit symtab associated with PC.
2994 This will read in debug info as necessary.
2995 Backward compatibility, no section. */
2997 struct compunit_symtab
*
2998 find_pc_compunit_symtab (CORE_ADDR pc
)
3000 return find_pc_sect_compunit_symtab (pc
, find_pc_mapped_section (pc
));
3006 find_symbol_at_address (CORE_ADDR address
)
3008 /* A helper function to search a given symtab for a symbol matching
3010 auto search_symtab
= [] (compunit_symtab
*symtab
, CORE_ADDR addr
) -> symbol
*
3012 const struct blockvector
*bv
= COMPUNIT_BLOCKVECTOR (symtab
);
3014 for (int i
= GLOBAL_BLOCK
; i
<= STATIC_BLOCK
; ++i
)
3016 const struct block
*b
= BLOCKVECTOR_BLOCK (bv
, i
);
3017 struct block_iterator iter
;
3020 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
3022 if (SYMBOL_CLASS (sym
) == LOC_STATIC
3023 && SYMBOL_VALUE_ADDRESS (sym
) == addr
)
3030 for (objfile
*objfile
: current_program_space
->objfiles ())
3032 /* If this objfile was read with -readnow, then we need to
3033 search the symtabs directly. */
3034 if ((objfile
->flags
& OBJF_READNOW
) != 0)
3036 for (compunit_symtab
*symtab
: objfile
->compunits ())
3038 struct symbol
*sym
= search_symtab (symtab
, address
);
3045 struct compunit_symtab
*symtab
3046 = objfile
->find_compunit_symtab_by_address (address
);
3049 struct symbol
*sym
= search_symtab (symtab
, address
);
3061 /* Find the source file and line number for a given PC value and SECTION.
3062 Return a structure containing a symtab pointer, a line number,
3063 and a pc range for the entire source line.
3064 The value's .pc field is NOT the specified pc.
3065 NOTCURRENT nonzero means, if specified pc is on a line boundary,
3066 use the line that ends there. Otherwise, in that case, the line
3067 that begins there is used. */
3069 /* The big complication here is that a line may start in one file, and end just
3070 before the start of another file. This usually occurs when you #include
3071 code in the middle of a subroutine. To properly find the end of a line's PC
3072 range, we must search all symtabs associated with this compilation unit, and
3073 find the one whose first PC is closer than that of the next line in this
3076 struct symtab_and_line
3077 find_pc_sect_line (CORE_ADDR pc
, struct obj_section
*section
, int notcurrent
)
3079 struct compunit_symtab
*cust
;
3080 struct linetable
*l
;
3082 struct linetable_entry
*item
;
3083 const struct blockvector
*bv
;
3084 struct bound_minimal_symbol msymbol
;
3086 /* Info on best line seen so far, and where it starts, and its file. */
3088 struct linetable_entry
*best
= NULL
;
3089 CORE_ADDR best_end
= 0;
3090 struct symtab
*best_symtab
= 0;
3092 /* Store here the first line number
3093 of a file which contains the line at the smallest pc after PC.
3094 If we don't find a line whose range contains PC,
3095 we will use a line one less than this,
3096 with a range from the start of that file to the first line's pc. */
3097 struct linetable_entry
*alt
= NULL
;
3099 /* Info on best line seen in this file. */
3101 struct linetable_entry
*prev
;
3103 /* If this pc is not from the current frame,
3104 it is the address of the end of a call instruction.
3105 Quite likely that is the start of the following statement.
3106 But what we want is the statement containing the instruction.
3107 Fudge the pc to make sure we get that. */
3109 /* It's tempting to assume that, if we can't find debugging info for
3110 any function enclosing PC, that we shouldn't search for line
3111 number info, either. However, GAS can emit line number info for
3112 assembly files --- very helpful when debugging hand-written
3113 assembly code. In such a case, we'd have no debug info for the
3114 function, but we would have line info. */
3119 /* elz: added this because this function returned the wrong
3120 information if the pc belongs to a stub (import/export)
3121 to call a shlib function. This stub would be anywhere between
3122 two functions in the target, and the line info was erroneously
3123 taken to be the one of the line before the pc. */
3125 /* RT: Further explanation:
3127 * We have stubs (trampolines) inserted between procedures.
3129 * Example: "shr1" exists in a shared library, and a "shr1" stub also
3130 * exists in the main image.
3132 * In the minimal symbol table, we have a bunch of symbols
3133 * sorted by start address. The stubs are marked as "trampoline",
3134 * the others appear as text. E.g.:
3136 * Minimal symbol table for main image
3137 * main: code for main (text symbol)
3138 * shr1: stub (trampoline symbol)
3139 * foo: code for foo (text symbol)
3141 * Minimal symbol table for "shr1" image:
3143 * shr1: code for shr1 (text symbol)
3146 * So the code below is trying to detect if we are in the stub
3147 * ("shr1" stub), and if so, find the real code ("shr1" trampoline),
3148 * and if found, do the symbolization from the real-code address
3149 * rather than the stub address.
3151 * Assumptions being made about the minimal symbol table:
3152 * 1. lookup_minimal_symbol_by_pc() will return a trampoline only
3153 * if we're really in the trampoline.s If we're beyond it (say
3154 * we're in "foo" in the above example), it'll have a closer
3155 * symbol (the "foo" text symbol for example) and will not
3156 * return the trampoline.
3157 * 2. lookup_minimal_symbol_text() will find a real text symbol
3158 * corresponding to the trampoline, and whose address will
3159 * be different than the trampoline address. I put in a sanity
3160 * check for the address being the same, to avoid an
3161 * infinite recursion.
3163 msymbol
= lookup_minimal_symbol_by_pc (pc
);
3164 if (msymbol
.minsym
!= NULL
)
3165 if (MSYMBOL_TYPE (msymbol
.minsym
) == mst_solib_trampoline
)
3167 struct bound_minimal_symbol mfunsym
3168 = lookup_minimal_symbol_text (msymbol
.minsym
->linkage_name (),
3171 if (mfunsym
.minsym
== NULL
)
3172 /* I eliminated this warning since it is coming out
3173 * in the following situation:
3174 * gdb shmain // test program with shared libraries
3175 * (gdb) break shr1 // function in shared lib
3176 * Warning: In stub for ...
3177 * In the above situation, the shared lib is not loaded yet,
3178 * so of course we can't find the real func/line info,
3179 * but the "break" still works, and the warning is annoying.
3180 * So I commented out the warning. RT */
3181 /* warning ("In stub for %s; unable to find real function/line info",
3182 msymbol->linkage_name ()); */
3185 else if (BMSYMBOL_VALUE_ADDRESS (mfunsym
)
3186 == BMSYMBOL_VALUE_ADDRESS (msymbol
))
3187 /* Avoid infinite recursion */
3188 /* See above comment about why warning is commented out. */
3189 /* warning ("In stub for %s; unable to find real function/line info",
3190 msymbol->linkage_name ()); */
3195 /* Detect an obvious case of infinite recursion. If this
3196 should occur, we'd like to know about it, so error out,
3198 if (BMSYMBOL_VALUE_ADDRESS (mfunsym
) == pc
)
3199 internal_error (__FILE__
, __LINE__
,
3200 _("Infinite recursion detected in find_pc_sect_line;"
3201 "please file a bug report"));
3203 return find_pc_line (BMSYMBOL_VALUE_ADDRESS (mfunsym
), 0);
3207 symtab_and_line val
;
3208 val
.pspace
= current_program_space
;
3210 cust
= find_pc_sect_compunit_symtab (pc
, section
);
3213 /* If no symbol information, return previous pc. */
3220 bv
= COMPUNIT_BLOCKVECTOR (cust
);
3222 /* Look at all the symtabs that share this blockvector.
3223 They all have the same apriori range, that we found was right;
3224 but they have different line tables. */
3226 for (symtab
*iter_s
: compunit_filetabs (cust
))
3228 /* Find the best line in this symtab. */
3229 l
= SYMTAB_LINETABLE (iter_s
);
3235 /* I think len can be zero if the symtab lacks line numbers
3236 (e.g. gcc -g1). (Either that or the LINETABLE is NULL;
3237 I'm not sure which, and maybe it depends on the symbol
3243 item
= l
->item
; /* Get first line info. */
3245 /* Is this file's first line closer than the first lines of other files?
3246 If so, record this file, and its first line, as best alternate. */
3247 if (item
->pc
> pc
&& (!alt
|| item
->pc
< alt
->pc
))
3250 auto pc_compare
= [](const CORE_ADDR
& comp_pc
,
3251 const struct linetable_entry
& lhs
)->bool
3253 return comp_pc
< lhs
.pc
;
3256 struct linetable_entry
*first
= item
;
3257 struct linetable_entry
*last
= item
+ len
;
3258 item
= std::upper_bound (first
, last
, pc
, pc_compare
);
3260 prev
= item
- 1; /* Found a matching item. */
3262 /* At this point, prev points at the line whose start addr is <= pc, and
3263 item points at the next line. If we ran off the end of the linetable
3264 (pc >= start of the last line), then prev == item. If pc < start of
3265 the first line, prev will not be set. */
3267 /* Is this file's best line closer than the best in the other files?
3268 If so, record this file, and its best line, as best so far. Don't
3269 save prev if it represents the end of a function (i.e. line number
3270 0) instead of a real line. */
3272 if (prev
&& prev
->line
&& (!best
|| prev
->pc
> best
->pc
))
3275 best_symtab
= iter_s
;
3277 /* If during the binary search we land on a non-statement entry,
3278 scan backward through entries at the same address to see if
3279 there is an entry marked as is-statement. In theory this
3280 duplication should have been removed from the line table
3281 during construction, this is just a double check. If the line
3282 table has had the duplication removed then this should be
3286 struct linetable_entry
*tmp
= best
;
3287 while (tmp
> first
&& (tmp
- 1)->pc
== tmp
->pc
3288 && (tmp
- 1)->line
!= 0 && !tmp
->is_stmt
)
3294 /* Discard BEST_END if it's before the PC of the current BEST. */
3295 if (best_end
<= best
->pc
)
3299 /* If another line (denoted by ITEM) is in the linetable and its
3300 PC is after BEST's PC, but before the current BEST_END, then
3301 use ITEM's PC as the new best_end. */
3302 if (best
&& item
< last
&& item
->pc
> best
->pc
3303 && (best_end
== 0 || best_end
> item
->pc
))
3304 best_end
= item
->pc
;
3309 /* If we didn't find any line number info, just return zeros.
3310 We used to return alt->line - 1 here, but that could be
3311 anywhere; if we don't have line number info for this PC,
3312 don't make some up. */
3315 else if (best
->line
== 0)
3317 /* If our best fit is in a range of PC's for which no line
3318 number info is available (line number is zero) then we didn't
3319 find any valid line information. */
3324 val
.is_stmt
= best
->is_stmt
;
3325 val
.symtab
= best_symtab
;
3326 val
.line
= best
->line
;
3328 if (best_end
&& (!alt
|| best_end
< alt
->pc
))
3333 val
.end
= BLOCK_END (BLOCKVECTOR_BLOCK (bv
, GLOBAL_BLOCK
));
3335 val
.section
= section
;
3339 /* Backward compatibility (no section). */
3341 struct symtab_and_line
3342 find_pc_line (CORE_ADDR pc
, int notcurrent
)
3344 struct obj_section
*section
;
3346 section
= find_pc_overlay (pc
);
3347 if (!pc_in_unmapped_range (pc
, section
))
3348 return find_pc_sect_line (pc
, section
, notcurrent
);
3350 /* If the original PC was an unmapped address then we translate this to a
3351 mapped address in order to lookup the sal. However, as the user
3352 passed us an unmapped address it makes more sense to return a result
3353 that has the pc and end fields translated to unmapped addresses. */
3354 pc
= overlay_mapped_address (pc
, section
);
3355 symtab_and_line sal
= find_pc_sect_line (pc
, section
, notcurrent
);
3356 sal
.pc
= overlay_unmapped_address (sal
.pc
, section
);
3357 sal
.end
= overlay_unmapped_address (sal
.end
, section
);
3364 find_pc_line_symtab (CORE_ADDR pc
)
3366 struct symtab_and_line sal
;
3368 /* This always passes zero for NOTCURRENT to find_pc_line.
3369 There are currently no callers that ever pass non-zero. */
3370 sal
= find_pc_line (pc
, 0);
3374 /* Find line number LINE in any symtab whose name is the same as
3377 If found, return the symtab that contains the linetable in which it was
3378 found, set *INDEX to the index in the linetable of the best entry
3379 found, and set *EXACT_MATCH to true if the value returned is an
3382 If not found, return NULL. */
3385 find_line_symtab (struct symtab
*sym_tab
, int line
,
3386 int *index
, bool *exact_match
)
3388 int exact
= 0; /* Initialized here to avoid a compiler warning. */
3390 /* BEST_INDEX and BEST_LINETABLE identify the smallest linenumber > LINE
3394 struct linetable
*best_linetable
;
3395 struct symtab
*best_symtab
;
3397 /* First try looking it up in the given symtab. */
3398 best_linetable
= SYMTAB_LINETABLE (sym_tab
);
3399 best_symtab
= sym_tab
;
3400 best_index
= find_line_common (best_linetable
, line
, &exact
, 0);
3401 if (best_index
< 0 || !exact
)
3403 /* Didn't find an exact match. So we better keep looking for
3404 another symtab with the same name. In the case of xcoff,
3405 multiple csects for one source file (produced by IBM's FORTRAN
3406 compiler) produce multiple symtabs (this is unavoidable
3407 assuming csects can be at arbitrary places in memory and that
3408 the GLOBAL_BLOCK of a symtab has a begin and end address). */
3410 /* BEST is the smallest linenumber > LINE so far seen,
3411 or 0 if none has been seen so far.
3412 BEST_INDEX and BEST_LINETABLE identify the item for it. */
3415 if (best_index
>= 0)
3416 best
= best_linetable
->item
[best_index
].line
;
3420 for (objfile
*objfile
: current_program_space
->objfiles ())
3421 objfile
->expand_symtabs_with_fullname (symtab_to_fullname (sym_tab
));
3423 for (objfile
*objfile
: current_program_space
->objfiles ())
3425 for (compunit_symtab
*cu
: objfile
->compunits ())
3427 for (symtab
*s
: compunit_filetabs (cu
))
3429 struct linetable
*l
;
3432 if (FILENAME_CMP (sym_tab
->filename
, s
->filename
) != 0)
3434 if (FILENAME_CMP (symtab_to_fullname (sym_tab
),
3435 symtab_to_fullname (s
)) != 0)
3437 l
= SYMTAB_LINETABLE (s
);
3438 ind
= find_line_common (l
, line
, &exact
, 0);
3448 if (best
== 0 || l
->item
[ind
].line
< best
)
3450 best
= l
->item
[ind
].line
;
3465 *index
= best_index
;
3467 *exact_match
= (exact
!= 0);
3472 /* Given SYMTAB, returns all the PCs function in the symtab that
3473 exactly match LINE. Returns an empty vector if there are no exact
3474 matches, but updates BEST_ITEM in this case. */
3476 std::vector
<CORE_ADDR
>
3477 find_pcs_for_symtab_line (struct symtab
*symtab
, int line
,
3478 struct linetable_entry
**best_item
)
3481 std::vector
<CORE_ADDR
> result
;
3483 /* First, collect all the PCs that are at this line. */
3489 idx
= find_line_common (SYMTAB_LINETABLE (symtab
), line
, &was_exact
,
3496 struct linetable_entry
*item
= &SYMTAB_LINETABLE (symtab
)->item
[idx
];
3498 if (*best_item
== NULL
3499 || (item
->line
< (*best_item
)->line
&& item
->is_stmt
))
3505 result
.push_back (SYMTAB_LINETABLE (symtab
)->item
[idx
].pc
);
3513 /* Set the PC value for a given source file and line number and return true.
3514 Returns false for invalid line number (and sets the PC to 0).
3515 The source file is specified with a struct symtab. */
3518 find_line_pc (struct symtab
*symtab
, int line
, CORE_ADDR
*pc
)
3520 struct linetable
*l
;
3527 symtab
= find_line_symtab (symtab
, line
, &ind
, NULL
);
3530 l
= SYMTAB_LINETABLE (symtab
);
3531 *pc
= l
->item
[ind
].pc
;
3538 /* Find the range of pc values in a line.
3539 Store the starting pc of the line into *STARTPTR
3540 and the ending pc (start of next line) into *ENDPTR.
3541 Returns true to indicate success.
3542 Returns false if could not find the specified line. */
3545 find_line_pc_range (struct symtab_and_line sal
, CORE_ADDR
*startptr
,
3548 CORE_ADDR startaddr
;
3549 struct symtab_and_line found_sal
;
3552 if (startaddr
== 0 && !find_line_pc (sal
.symtab
, sal
.line
, &startaddr
))
3555 /* This whole function is based on address. For example, if line 10 has
3556 two parts, one from 0x100 to 0x200 and one from 0x300 to 0x400, then
3557 "info line *0x123" should say the line goes from 0x100 to 0x200
3558 and "info line *0x355" should say the line goes from 0x300 to 0x400.
3559 This also insures that we never give a range like "starts at 0x134
3560 and ends at 0x12c". */
3562 found_sal
= find_pc_sect_line (startaddr
, sal
.section
, 0);
3563 if (found_sal
.line
!= sal
.line
)
3565 /* The specified line (sal) has zero bytes. */
3566 *startptr
= found_sal
.pc
;
3567 *endptr
= found_sal
.pc
;
3571 *startptr
= found_sal
.pc
;
3572 *endptr
= found_sal
.end
;
3577 /* Given a line table and a line number, return the index into the line
3578 table for the pc of the nearest line whose number is >= the specified one.
3579 Return -1 if none is found. The value is >= 0 if it is an index.
3580 START is the index at which to start searching the line table.
3582 Set *EXACT_MATCH nonzero if the value returned is an exact match. */
3585 find_line_common (struct linetable
*l
, int lineno
,
3586 int *exact_match
, int start
)
3591 /* BEST is the smallest linenumber > LINENO so far seen,
3592 or 0 if none has been seen so far.
3593 BEST_INDEX identifies the item for it. */
3595 int best_index
= -1;
3606 for (i
= start
; i
< len
; i
++)
3608 struct linetable_entry
*item
= &(l
->item
[i
]);
3610 /* Ignore non-statements. */
3614 if (item
->line
== lineno
)
3616 /* Return the first (lowest address) entry which matches. */
3621 if (item
->line
> lineno
&& (best
== 0 || item
->line
< best
))
3628 /* If we got here, we didn't get an exact match. */
3633 find_pc_line_pc_range (CORE_ADDR pc
, CORE_ADDR
*startptr
, CORE_ADDR
*endptr
)
3635 struct symtab_and_line sal
;
3637 sal
= find_pc_line (pc
, 0);
3640 return sal
.symtab
!= 0;
3643 /* Helper for find_function_start_sal. Does most of the work, except
3644 setting the sal's symbol. */
3646 static symtab_and_line
3647 find_function_start_sal_1 (CORE_ADDR func_addr
, obj_section
*section
,
3650 symtab_and_line sal
= find_pc_sect_line (func_addr
, section
, 0);
3652 if (funfirstline
&& sal
.symtab
!= NULL
3653 && (COMPUNIT_LOCATIONS_VALID (SYMTAB_COMPUNIT (sal
.symtab
))
3654 || SYMTAB_LANGUAGE (sal
.symtab
) == language_asm
))
3656 struct gdbarch
*gdbarch
= SYMTAB_OBJFILE (sal
.symtab
)->arch ();
3659 if (gdbarch_skip_entrypoint_p (gdbarch
))
3660 sal
.pc
= gdbarch_skip_entrypoint (gdbarch
, sal
.pc
);
3664 /* We always should have a line for the function start address.
3665 If we don't, something is odd. Create a plain SAL referring
3666 just the PC and hope that skip_prologue_sal (if requested)
3667 can find a line number for after the prologue. */
3668 if (sal
.pc
< func_addr
)
3671 sal
.pspace
= current_program_space
;
3673 sal
.section
= section
;
3677 skip_prologue_sal (&sal
);
3685 find_function_start_sal (CORE_ADDR func_addr
, obj_section
*section
,
3689 = find_function_start_sal_1 (func_addr
, section
, funfirstline
);
3691 /* find_function_start_sal_1 does a linetable search, so it finds
3692 the symtab and linenumber, but not a symbol. Fill in the
3693 function symbol too. */
3694 sal
.symbol
= find_pc_sect_containing_function (sal
.pc
, sal
.section
);
3702 find_function_start_sal (symbol
*sym
, bool funfirstline
)
3704 fixup_symbol_section (sym
, NULL
);
3706 = find_function_start_sal_1 (BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
)),
3707 sym
->obj_section (symbol_objfile (sym
)),
3714 /* Given a function start address FUNC_ADDR and SYMTAB, find the first
3715 address for that function that has an entry in SYMTAB's line info
3716 table. If such an entry cannot be found, return FUNC_ADDR
3720 skip_prologue_using_lineinfo (CORE_ADDR func_addr
, struct symtab
*symtab
)
3722 CORE_ADDR func_start
, func_end
;
3723 struct linetable
*l
;
3726 /* Give up if this symbol has no lineinfo table. */
3727 l
= SYMTAB_LINETABLE (symtab
);
3731 /* Get the range for the function's PC values, or give up if we
3732 cannot, for some reason. */
3733 if (!find_pc_partial_function (func_addr
, NULL
, &func_start
, &func_end
))
3736 /* Linetable entries are ordered by PC values, see the commentary in
3737 symtab.h where `struct linetable' is defined. Thus, the first
3738 entry whose PC is in the range [FUNC_START..FUNC_END[ is the
3739 address we are looking for. */
3740 for (i
= 0; i
< l
->nitems
; i
++)
3742 struct linetable_entry
*item
= &(l
->item
[i
]);
3744 /* Don't use line numbers of zero, they mark special entries in
3745 the table. See the commentary on symtab.h before the
3746 definition of struct linetable. */
3747 if (item
->line
> 0 && func_start
<= item
->pc
&& item
->pc
< func_end
)
3754 /* Adjust SAL to the first instruction past the function prologue.
3755 If the PC was explicitly specified, the SAL is not changed.
3756 If the line number was explicitly specified then the SAL can still be
3757 updated, unless the language for SAL is assembler, in which case the SAL
3758 will be left unchanged.
3759 If SAL is already past the prologue, then do nothing. */
3762 skip_prologue_sal (struct symtab_and_line
*sal
)
3765 struct symtab_and_line start_sal
;
3766 CORE_ADDR pc
, saved_pc
;
3767 struct obj_section
*section
;
3769 struct objfile
*objfile
;
3770 struct gdbarch
*gdbarch
;
3771 const struct block
*b
, *function_block
;
3772 int force_skip
, skip
;
3774 /* Do not change the SAL if PC was specified explicitly. */
3775 if (sal
->explicit_pc
)
3778 /* In assembly code, if the user asks for a specific line then we should
3779 not adjust the SAL. The user already has instruction level
3780 visibility in this case, so selecting a line other than one requested
3781 is likely to be the wrong choice. */
3782 if (sal
->symtab
!= nullptr
3783 && sal
->explicit_line
3784 && SYMTAB_LANGUAGE (sal
->symtab
) == language_asm
)
3787 scoped_restore_current_pspace_and_thread restore_pspace_thread
;
3789 switch_to_program_space_and_thread (sal
->pspace
);
3791 sym
= find_pc_sect_function (sal
->pc
, sal
->section
);
3794 fixup_symbol_section (sym
, NULL
);
3796 objfile
= symbol_objfile (sym
);
3797 pc
= BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
));
3798 section
= sym
->obj_section (objfile
);
3799 name
= sym
->linkage_name ();
3803 struct bound_minimal_symbol msymbol
3804 = lookup_minimal_symbol_by_pc_section (sal
->pc
, sal
->section
);
3806 if (msymbol
.minsym
== NULL
)
3809 objfile
= msymbol
.objfile
;
3810 pc
= BMSYMBOL_VALUE_ADDRESS (msymbol
);
3811 section
= msymbol
.minsym
->obj_section (objfile
);
3812 name
= msymbol
.minsym
->linkage_name ();
3815 gdbarch
= objfile
->arch ();
3817 /* Process the prologue in two passes. In the first pass try to skip the
3818 prologue (SKIP is true) and verify there is a real need for it (indicated
3819 by FORCE_SKIP). If no such reason was found run a second pass where the
3820 prologue is not skipped (SKIP is false). */
3825 /* Be conservative - allow direct PC (without skipping prologue) only if we
3826 have proven the CU (Compilation Unit) supports it. sal->SYMTAB does not
3827 have to be set by the caller so we use SYM instead. */
3829 && COMPUNIT_LOCATIONS_VALID (SYMTAB_COMPUNIT (symbol_symtab (sym
))))
3837 /* If the function is in an unmapped overlay, use its unmapped LMA address,
3838 so that gdbarch_skip_prologue has something unique to work on. */
3839 if (section_is_overlay (section
) && !section_is_mapped (section
))
3840 pc
= overlay_unmapped_address (pc
, section
);
3842 /* Skip "first line" of function (which is actually its prologue). */
3843 pc
+= gdbarch_deprecated_function_start_offset (gdbarch
);
3844 if (gdbarch_skip_entrypoint_p (gdbarch
))
3845 pc
= gdbarch_skip_entrypoint (gdbarch
, pc
);
3847 pc
= gdbarch_skip_prologue_noexcept (gdbarch
, pc
);
3849 /* For overlays, map pc back into its mapped VMA range. */
3850 pc
= overlay_mapped_address (pc
, section
);
3852 /* Calculate line number. */
3853 start_sal
= find_pc_sect_line (pc
, section
, 0);
3855 /* Check if gdbarch_skip_prologue left us in mid-line, and the next
3856 line is still part of the same function. */
3857 if (skip
&& start_sal
.pc
!= pc
3858 && (sym
? (BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
)) <= start_sal
.end
3859 && start_sal
.end
< BLOCK_END (SYMBOL_BLOCK_VALUE (sym
)))
3860 : (lookup_minimal_symbol_by_pc_section (start_sal
.end
, section
).minsym
3861 == lookup_minimal_symbol_by_pc_section (pc
, section
).minsym
)))
3863 /* First pc of next line */
3865 /* Recalculate the line number (might not be N+1). */
3866 start_sal
= find_pc_sect_line (pc
, section
, 0);
3869 /* On targets with executable formats that don't have a concept of
3870 constructors (ELF with .init has, PE doesn't), gcc emits a call
3871 to `__main' in `main' between the prologue and before user
3873 if (gdbarch_skip_main_prologue_p (gdbarch
)
3874 && name
&& strcmp_iw (name
, "main") == 0)
3876 pc
= gdbarch_skip_main_prologue (gdbarch
, pc
);
3877 /* Recalculate the line number (might not be N+1). */
3878 start_sal
= find_pc_sect_line (pc
, section
, 0);
3882 while (!force_skip
&& skip
--);
3884 /* If we still don't have a valid source line, try to find the first
3885 PC in the lineinfo table that belongs to the same function. This
3886 happens with COFF debug info, which does not seem to have an
3887 entry in lineinfo table for the code after the prologue which has
3888 no direct relation to source. For example, this was found to be
3889 the case with the DJGPP target using "gcc -gcoff" when the
3890 compiler inserted code after the prologue to make sure the stack
3892 if (!force_skip
&& sym
&& start_sal
.symtab
== NULL
)
3894 pc
= skip_prologue_using_lineinfo (pc
, symbol_symtab (sym
));
3895 /* Recalculate the line number. */
3896 start_sal
= find_pc_sect_line (pc
, section
, 0);
3899 /* If we're already past the prologue, leave SAL unchanged. Otherwise
3900 forward SAL to the end of the prologue. */
3905 sal
->section
= section
;
3906 sal
->symtab
= start_sal
.symtab
;
3907 sal
->line
= start_sal
.line
;
3908 sal
->end
= start_sal
.end
;
3910 /* Check if we are now inside an inlined function. If we can,
3911 use the call site of the function instead. */
3912 b
= block_for_pc_sect (sal
->pc
, sal
->section
);
3913 function_block
= NULL
;
3916 if (BLOCK_FUNCTION (b
) != NULL
&& block_inlined_p (b
))
3918 else if (BLOCK_FUNCTION (b
) != NULL
)
3920 b
= BLOCK_SUPERBLOCK (b
);
3922 if (function_block
!= NULL
3923 && SYMBOL_LINE (BLOCK_FUNCTION (function_block
)) != 0)
3925 sal
->line
= SYMBOL_LINE (BLOCK_FUNCTION (function_block
));
3926 sal
->symtab
= symbol_symtab (BLOCK_FUNCTION (function_block
));
3930 /* Given PC at the function's start address, attempt to find the
3931 prologue end using SAL information. Return zero if the skip fails.
3933 A non-optimized prologue traditionally has one SAL for the function
3934 and a second for the function body. A single line function has
3935 them both pointing at the same line.
3937 An optimized prologue is similar but the prologue may contain
3938 instructions (SALs) from the instruction body. Need to skip those
3939 while not getting into the function body.
3941 The functions end point and an increasing SAL line are used as
3942 indicators of the prologue's endpoint.
3944 This code is based on the function refine_prologue_limit
3948 skip_prologue_using_sal (struct gdbarch
*gdbarch
, CORE_ADDR func_addr
)
3950 struct symtab_and_line prologue_sal
;
3953 const struct block
*bl
;
3955 /* Get an initial range for the function. */
3956 find_pc_partial_function (func_addr
, NULL
, &start_pc
, &end_pc
);
3957 start_pc
+= gdbarch_deprecated_function_start_offset (gdbarch
);
3959 prologue_sal
= find_pc_line (start_pc
, 0);
3960 if (prologue_sal
.line
!= 0)
3962 /* For languages other than assembly, treat two consecutive line
3963 entries at the same address as a zero-instruction prologue.
3964 The GNU assembler emits separate line notes for each instruction
3965 in a multi-instruction macro, but compilers generally will not
3967 if (prologue_sal
.symtab
->language
!= language_asm
)
3969 struct linetable
*linetable
= SYMTAB_LINETABLE (prologue_sal
.symtab
);
3972 /* Skip any earlier lines, and any end-of-sequence marker
3973 from a previous function. */
3974 while (linetable
->item
[idx
].pc
!= prologue_sal
.pc
3975 || linetable
->item
[idx
].line
== 0)
3978 if (idx
+1 < linetable
->nitems
3979 && linetable
->item
[idx
+1].line
!= 0
3980 && linetable
->item
[idx
+1].pc
== start_pc
)
3984 /* If there is only one sal that covers the entire function,
3985 then it is probably a single line function, like
3987 if (prologue_sal
.end
>= end_pc
)
3990 while (prologue_sal
.end
< end_pc
)
3992 struct symtab_and_line sal
;
3994 sal
= find_pc_line (prologue_sal
.end
, 0);
3997 /* Assume that a consecutive SAL for the same (or larger)
3998 line mark the prologue -> body transition. */
3999 if (sal
.line
>= prologue_sal
.line
)
4001 /* Likewise if we are in a different symtab altogether
4002 (e.g. within a file included via #include). */
4003 if (sal
.symtab
!= prologue_sal
.symtab
)
4006 /* The line number is smaller. Check that it's from the
4007 same function, not something inlined. If it's inlined,
4008 then there is no point comparing the line numbers. */
4009 bl
= block_for_pc (prologue_sal
.end
);
4012 if (block_inlined_p (bl
))
4014 if (BLOCK_FUNCTION (bl
))
4019 bl
= BLOCK_SUPERBLOCK (bl
);
4024 /* The case in which compiler's optimizer/scheduler has
4025 moved instructions into the prologue. We look ahead in
4026 the function looking for address ranges whose
4027 corresponding line number is less the first one that we
4028 found for the function. This is more conservative then
4029 refine_prologue_limit which scans a large number of SALs
4030 looking for any in the prologue. */
4035 if (prologue_sal
.end
< end_pc
)
4036 /* Return the end of this line, or zero if we could not find a
4038 return prologue_sal
.end
;
4040 /* Don't return END_PC, which is past the end of the function. */
4041 return prologue_sal
.pc
;
4047 find_function_alias_target (bound_minimal_symbol msymbol
)
4049 CORE_ADDR func_addr
;
4050 if (!msymbol_is_function (msymbol
.objfile
, msymbol
.minsym
, &func_addr
))
4053 symbol
*sym
= find_pc_function (func_addr
);
4055 && SYMBOL_CLASS (sym
) == LOC_BLOCK
4056 && BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
)) == func_addr
)
4063 /* If P is of the form "operator[ \t]+..." where `...' is
4064 some legitimate operator text, return a pointer to the
4065 beginning of the substring of the operator text.
4066 Otherwise, return "". */
4069 operator_chars (const char *p
, const char **end
)
4072 if (!startswith (p
, CP_OPERATOR_STR
))
4074 p
+= CP_OPERATOR_LEN
;
4076 /* Don't get faked out by `operator' being part of a longer
4078 if (isalpha (*p
) || *p
== '_' || *p
== '$' || *p
== '\0')
4081 /* Allow some whitespace between `operator' and the operator symbol. */
4082 while (*p
== ' ' || *p
== '\t')
4085 /* Recognize 'operator TYPENAME'. */
4087 if (isalpha (*p
) || *p
== '_' || *p
== '$')
4089 const char *q
= p
+ 1;
4091 while (isalnum (*q
) || *q
== '_' || *q
== '$')
4100 case '\\': /* regexp quoting */
4103 if (p
[2] == '=') /* 'operator\*=' */
4105 else /* 'operator\*' */
4109 else if (p
[1] == '[')
4112 error (_("mismatched quoting on brackets, "
4113 "try 'operator\\[\\]'"));
4114 else if (p
[2] == '\\' && p
[3] == ']')
4116 *end
= p
+ 4; /* 'operator\[\]' */
4120 error (_("nothing is allowed between '[' and ']'"));
4124 /* Gratuitous quote: skip it and move on. */
4146 if (p
[0] == '-' && p
[1] == '>')
4148 /* Struct pointer member operator 'operator->'. */
4151 *end
= p
+ 3; /* 'operator->*' */
4154 else if (p
[2] == '\\')
4156 *end
= p
+ 4; /* Hopefully 'operator->\*' */
4161 *end
= p
+ 2; /* 'operator->' */
4165 if (p
[1] == '=' || p
[1] == p
[0])
4176 error (_("`operator ()' must be specified "
4177 "without whitespace in `()'"));
4182 error (_("`operator ?:' must be specified "
4183 "without whitespace in `?:'"));
4188 error (_("`operator []' must be specified "
4189 "without whitespace in `[]'"));
4193 error (_("`operator %s' not supported"), p
);
4202 /* See class declaration. */
4204 info_sources_filter::info_sources_filter (match_on match_type
,
4206 : m_match_type (match_type
),
4209 /* Setup the compiled regular expression M_C_REGEXP based on M_REGEXP. */
4210 if (m_regexp
!= nullptr && *m_regexp
!= '\0')
4212 gdb_assert (m_regexp
!= nullptr);
4214 int cflags
= REG_NOSUB
;
4215 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
4216 cflags
|= REG_ICASE
;
4218 m_c_regexp
.emplace (m_regexp
, cflags
, _("Invalid regexp"));
4222 /* See class declaration. */
4225 info_sources_filter::matches (const char *fullname
) const
4227 /* Does it match regexp? */
4228 if (m_c_regexp
.has_value ())
4230 const char *to_match
;
4231 std::string dirname
;
4233 switch (m_match_type
)
4235 case match_on::DIRNAME
:
4236 dirname
= ldirname (fullname
);
4237 to_match
= dirname
.c_str ();
4239 case match_on::BASENAME
:
4240 to_match
= lbasename (fullname
);
4242 case match_on::FULLNAME
:
4243 to_match
= fullname
;
4246 gdb_assert_not_reached ("bad m_match_type");
4249 if (m_c_regexp
->exec (to_match
, 0, NULL
, 0) != 0)
4256 /* Data structure to maintain the state used for printing the results of
4257 the 'info sources' command. */
4259 struct output_source_filename_data
4261 /* Create an object for displaying the results of the 'info sources'
4262 command to UIOUT. FILTER must remain valid and unchanged for the
4263 lifetime of this object as this object retains a reference to FILTER. */
4264 output_source_filename_data (struct ui_out
*uiout
,
4265 const info_sources_filter
&filter
)
4266 : m_filter (filter
),
4270 DISABLE_COPY_AND_ASSIGN (output_source_filename_data
);
4272 /* Reset enough state of this object so we can match against a new set of
4273 files. The existing regular expression is retained though. */
4274 void reset_output ()
4277 m_filename_seen_cache
.clear ();
4280 /* Worker for sources_info, outputs the file name formatted for either
4281 cli or mi (based on the current_uiout). In cli mode displays
4282 FULLNAME with a comma separating this name from any previously
4283 printed name (line breaks are added at the comma). In MI mode
4284 outputs a tuple containing DISP_NAME (the files display name),
4285 FULLNAME, and EXPANDED_P (true when this file is from a fully
4286 expanded symtab, otherwise false). */
4287 void output (const char *disp_name
, const char *fullname
, bool expanded_p
);
4289 /* An overload suitable for use as a callback to
4290 quick_symbol_functions::map_symbol_filenames. */
4291 void operator() (const char *filename
, const char *fullname
)
4293 /* The false here indicates that this file is from an unexpanded
4295 output (filename
, fullname
, false);
4298 /* Return true if at least one filename has been printed (after a call to
4299 output) since either this object was created, or the last call to
4301 bool printed_filename_p () const
4308 /* Flag of whether we're printing the first one. */
4309 bool m_first
= true;
4311 /* Cache of what we've seen so far. */
4312 filename_seen_cache m_filename_seen_cache
;
4314 /* How source filename should be filtered. */
4315 const info_sources_filter
&m_filter
;
4317 /* The object to which output is sent. */
4318 struct ui_out
*m_uiout
;
4321 /* See comment in class declaration above. */
4324 output_source_filename_data::output (const char *disp_name
,
4325 const char *fullname
,
4328 /* Since a single source file can result in several partial symbol
4329 tables, we need to avoid printing it more than once. Note: if
4330 some of the psymtabs are read in and some are not, it gets
4331 printed both under "Source files for which symbols have been
4332 read" and "Source files for which symbols will be read in on
4333 demand". I consider this a reasonable way to deal with the
4334 situation. I'm not sure whether this can also happen for
4335 symtabs; it doesn't hurt to check. */
4337 /* Was NAME already seen? If so, then don't print it again. */
4338 if (m_filename_seen_cache
.seen (fullname
))
4341 /* If the filter rejects this file then don't print it. */
4342 if (!m_filter
.matches (fullname
))
4345 ui_out_emit_tuple
ui_emitter (m_uiout
, nullptr);
4347 /* Print it and reset *FIRST. */
4349 m_uiout
->text (", ");
4353 if (m_uiout
->is_mi_like_p ())
4355 m_uiout
->field_string ("file", disp_name
, file_name_style
.style ());
4356 if (fullname
!= nullptr)
4357 m_uiout
->field_string ("fullname", fullname
,
4358 file_name_style
.style ());
4359 m_uiout
->field_string ("debug-fully-read",
4360 (expanded_p
? "true" : "false"));
4364 if (fullname
== nullptr)
4365 fullname
= disp_name
;
4366 m_uiout
->field_string ("fullname", fullname
,
4367 file_name_style
.style ());
4371 /* For the 'info sources' command, what part of the file names should we be
4372 matching the user supplied regular expression against? */
4374 struct filename_partial_match_opts
4376 /* Only match the directory name part. */
4377 bool dirname
= false;
4379 /* Only match the basename part. */
4380 bool basename
= false;
4383 using isrc_flag_option_def
4384 = gdb::option::flag_option_def
<filename_partial_match_opts
>;
4386 static const gdb::option::option_def info_sources_option_defs
[] = {
4388 isrc_flag_option_def
{
4390 [] (filename_partial_match_opts
*opts
) { return &opts
->dirname
; },
4391 N_("Show only the files having a dirname matching REGEXP."),
4394 isrc_flag_option_def
{
4396 [] (filename_partial_match_opts
*opts
) { return &opts
->basename
; },
4397 N_("Show only the files having a basename matching REGEXP."),
4402 /* Create an option_def_group for the "info sources" options, with
4403 ISRC_OPTS as context. */
4405 static inline gdb::option::option_def_group
4406 make_info_sources_options_def_group (filename_partial_match_opts
*isrc_opts
)
4408 return {{info_sources_option_defs
}, isrc_opts
};
4411 /* Completer for "info sources". */
4414 info_sources_command_completer (cmd_list_element
*ignore
,
4415 completion_tracker
&tracker
,
4416 const char *text
, const char *word
)
4418 const auto group
= make_info_sources_options_def_group (nullptr);
4419 if (gdb::option::complete_options
4420 (tracker
, &text
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, group
))
4427 info_sources_worker (struct ui_out
*uiout
,
4428 bool group_by_objfile
,
4429 const info_sources_filter
&filter
)
4431 output_source_filename_data
data (uiout
, filter
);
4433 ui_out_emit_list
results_emitter (uiout
, "files");
4434 gdb::optional
<ui_out_emit_tuple
> output_tuple
;
4435 gdb::optional
<ui_out_emit_list
> sources_list
;
4437 gdb_assert (group_by_objfile
|| uiout
->is_mi_like_p ());
4439 for (objfile
*objfile
: current_program_space
->objfiles ())
4441 if (group_by_objfile
)
4443 output_tuple
.emplace (uiout
, nullptr);
4444 uiout
->field_string ("filename", objfile_name (objfile
));
4445 uiout
->text (":\n");
4446 bool debug_fully_readin
= !objfile
->has_unexpanded_symtabs ();
4447 if (uiout
->is_mi_like_p ())
4449 const char *debug_info_state
;
4450 if (objfile_has_symbols (objfile
))
4452 if (debug_fully_readin
)
4453 debug_info_state
= "fully-read";
4455 debug_info_state
= "partially-read";
4458 debug_info_state
= "none";
4459 current_uiout
->field_string ("debug-info", debug_info_state
);
4463 if (!debug_fully_readin
)
4464 uiout
->text ("(Full debug information has not yet been read "
4465 "for this file.)\n");
4466 if (!objfile_has_symbols (objfile
))
4467 uiout
->text ("(Objfile has no debug information.)\n");
4470 sources_list
.emplace (uiout
, "sources");
4473 for (compunit_symtab
*cu
: objfile
->compunits ())
4475 for (symtab
*s
: compunit_filetabs (cu
))
4477 const char *file
= symtab_to_filename_for_display (s
);
4478 const char *fullname
= symtab_to_fullname (s
);
4479 data
.output (file
, fullname
, true);
4483 if (group_by_objfile
)
4485 objfile
->map_symbol_filenames (data
, true /* need_fullname */);
4486 if (data
.printed_filename_p ())
4487 uiout
->text ("\n\n");
4488 data
.reset_output ();
4489 sources_list
.reset ();
4490 output_tuple
.reset ();
4494 if (!group_by_objfile
)
4496 data
.reset_output ();
4497 map_symbol_filenames (data
, true /*need_fullname*/);
4501 /* Implement the 'info sources' command. */
4504 info_sources_command (const char *args
, int from_tty
)
4506 if (!have_full_symbols () && !have_partial_symbols ())
4507 error (_("No symbol table is loaded. Use the \"file\" command."));
4509 filename_partial_match_opts match_opts
;
4510 auto group
= make_info_sources_options_def_group (&match_opts
);
4511 gdb::option::process_options
4512 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_ERROR
, group
);
4514 if (match_opts
.dirname
&& match_opts
.basename
)
4515 error (_("You cannot give both -basename and -dirname to 'info sources'."));
4517 const char *regex
= nullptr;
4518 if (args
!= NULL
&& *args
!= '\000')
4521 if ((match_opts
.dirname
|| match_opts
.basename
) && regex
== nullptr)
4522 error (_("Missing REGEXP for 'info sources'."));
4524 info_sources_filter::match_on match_type
;
4525 if (match_opts
.dirname
)
4526 match_type
= info_sources_filter::match_on::DIRNAME
;
4527 else if (match_opts
.basename
)
4528 match_type
= info_sources_filter::match_on::BASENAME
;
4530 match_type
= info_sources_filter::match_on::FULLNAME
;
4532 info_sources_filter
filter (match_type
, regex
);
4533 info_sources_worker (current_uiout
, true, filter
);
4536 /* Compare FILE against all the entries of FILENAMES. If BASENAMES is
4537 true compare only lbasename of FILENAMES. */
4540 file_matches (const char *file
, const std::vector
<const char *> &filenames
,
4543 if (filenames
.empty ())
4546 for (const char *name
: filenames
)
4548 name
= (basenames
? lbasename (name
) : name
);
4549 if (compare_filenames_for_search (file
, name
))
4556 /* Helper function for std::sort on symbol_search objects. Can only sort
4557 symbols, not minimal symbols. */
4560 symbol_search::compare_search_syms (const symbol_search
&sym_a
,
4561 const symbol_search
&sym_b
)
4565 c
= FILENAME_CMP (symbol_symtab (sym_a
.symbol
)->filename
,
4566 symbol_symtab (sym_b
.symbol
)->filename
);
4570 if (sym_a
.block
!= sym_b
.block
)
4571 return sym_a
.block
- sym_b
.block
;
4573 return strcmp (sym_a
.symbol
->print_name (), sym_b
.symbol
->print_name ());
4576 /* Returns true if the type_name of symbol_type of SYM matches TREG.
4577 If SYM has no symbol_type or symbol_name, returns false. */
4580 treg_matches_sym_type_name (const compiled_regex
&treg
,
4581 const struct symbol
*sym
)
4583 struct type
*sym_type
;
4584 std::string printed_sym_type_name
;
4586 if (symbol_lookup_debug
> 1)
4588 fprintf_unfiltered (gdb_stdlog
,
4589 "treg_matches_sym_type_name\n sym %s\n",
4590 sym
->natural_name ());
4593 sym_type
= SYMBOL_TYPE (sym
);
4594 if (sym_type
== NULL
)
4598 scoped_switch_to_sym_language_if_auto
l (sym
);
4600 printed_sym_type_name
= type_to_string (sym_type
);
4604 if (symbol_lookup_debug
> 1)
4606 fprintf_unfiltered (gdb_stdlog
,
4607 " sym_type_name %s\n",
4608 printed_sym_type_name
.c_str ());
4612 if (printed_sym_type_name
.empty ())
4615 return treg
.exec (printed_sym_type_name
.c_str (), 0, NULL
, 0) == 0;
4621 global_symbol_searcher::is_suitable_msymbol
4622 (const enum search_domain kind
, const minimal_symbol
*msymbol
)
4624 switch (MSYMBOL_TYPE (msymbol
))
4630 return kind
== VARIABLES_DOMAIN
;
4633 case mst_solib_trampoline
:
4634 case mst_text_gnu_ifunc
:
4635 return kind
== FUNCTIONS_DOMAIN
;
4644 global_symbol_searcher::expand_symtabs
4645 (objfile
*objfile
, const gdb::optional
<compiled_regex
> &preg
) const
4647 enum search_domain kind
= m_kind
;
4648 bool found_msymbol
= false;
4650 objfile
->expand_symtabs_matching
4651 ([&] (const char *filename
, bool basenames
)
4653 return file_matches (filename
, filenames
, basenames
);
4655 &lookup_name_info::match_any (),
4656 [&] (const char *symname
)
4658 return (!preg
.has_value ()
4659 || preg
->exec (symname
, 0, NULL
, 0) == 0);
4662 SEARCH_GLOBAL_BLOCK
| SEARCH_STATIC_BLOCK
,
4666 /* Here, we search through the minimal symbol tables for functions and
4667 variables that match, and force their symbols to be read. This is in
4668 particular necessary for demangled variable names, which are no longer
4669 put into the partial symbol tables. The symbol will then be found
4670 during the scan of symtabs later.
4672 For functions, find_pc_symtab should succeed if we have debug info for
4673 the function, for variables we have to call
4674 lookup_symbol_in_objfile_from_linkage_name to determine if the
4675 variable has debug info. If the lookup fails, set found_msymbol so
4676 that we will rescan to print any matching symbols without debug info.
4677 We only search the objfile the msymbol came from, we no longer search
4678 all objfiles. In large programs (1000s of shared libs) searching all
4679 objfiles is not worth the pain. */
4680 if (filenames
.empty ()
4681 && (kind
== VARIABLES_DOMAIN
|| kind
== FUNCTIONS_DOMAIN
))
4683 for (minimal_symbol
*msymbol
: objfile
->msymbols ())
4687 if (msymbol
->created_by_gdb
)
4690 if (is_suitable_msymbol (kind
, msymbol
))
4692 if (!preg
.has_value ()
4693 || preg
->exec (msymbol
->natural_name (), 0,
4696 /* An important side-effect of these lookup functions is
4697 to expand the symbol table if msymbol is found, later
4698 in the process we will add matching symbols or
4699 msymbols to the results list, and that requires that
4700 the symbols tables are expanded. */
4701 if (kind
== FUNCTIONS_DOMAIN
4702 ? (find_pc_compunit_symtab
4703 (MSYMBOL_VALUE_ADDRESS (objfile
, msymbol
))
4705 : (lookup_symbol_in_objfile_from_linkage_name
4706 (objfile
, msymbol
->linkage_name (),
4709 found_msymbol
= true;
4715 return found_msymbol
;
4721 global_symbol_searcher::add_matching_symbols
4723 const gdb::optional
<compiled_regex
> &preg
,
4724 const gdb::optional
<compiled_regex
> &treg
,
4725 std::set
<symbol_search
> *result_set
) const
4727 enum search_domain kind
= m_kind
;
4729 /* Add matching symbols (if not already present). */
4730 for (compunit_symtab
*cust
: objfile
->compunits ())
4732 const struct blockvector
*bv
= COMPUNIT_BLOCKVECTOR (cust
);
4734 for (block_enum block
: { GLOBAL_BLOCK
, STATIC_BLOCK
})
4736 struct block_iterator iter
;
4738 const struct block
*b
= BLOCKVECTOR_BLOCK (bv
, block
);
4740 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
4742 struct symtab
*real_symtab
= symbol_symtab (sym
);
4746 /* Check first sole REAL_SYMTAB->FILENAME. It does
4747 not need to be a substring of symtab_to_fullname as
4748 it may contain "./" etc. */
4749 if ((file_matches (real_symtab
->filename
, filenames
, false)
4750 || ((basenames_may_differ
4751 || file_matches (lbasename (real_symtab
->filename
),
4753 && file_matches (symtab_to_fullname (real_symtab
),
4755 && ((!preg
.has_value ()
4756 || preg
->exec (sym
->natural_name (), 0,
4758 && ((kind
== VARIABLES_DOMAIN
4759 && SYMBOL_CLASS (sym
) != LOC_TYPEDEF
4760 && SYMBOL_CLASS (sym
) != LOC_UNRESOLVED
4761 && SYMBOL_CLASS (sym
) != LOC_BLOCK
4762 /* LOC_CONST can be used for more than
4763 just enums, e.g., c++ static const
4764 members. We only want to skip enums
4766 && !(SYMBOL_CLASS (sym
) == LOC_CONST
4767 && (SYMBOL_TYPE (sym
)->code ()
4769 && (!treg
.has_value ()
4770 || treg_matches_sym_type_name (*treg
, sym
)))
4771 || (kind
== FUNCTIONS_DOMAIN
4772 && SYMBOL_CLASS (sym
) == LOC_BLOCK
4773 && (!treg
.has_value ()
4774 || treg_matches_sym_type_name (*treg
,
4776 || (kind
== TYPES_DOMAIN
4777 && SYMBOL_CLASS (sym
) == LOC_TYPEDEF
4778 && SYMBOL_DOMAIN (sym
) != MODULE_DOMAIN
)
4779 || (kind
== MODULES_DOMAIN
4780 && SYMBOL_DOMAIN (sym
) == MODULE_DOMAIN
4781 && SYMBOL_LINE (sym
) != 0))))
4783 if (result_set
->size () < m_max_search_results
)
4785 /* Match, insert if not already in the results. */
4786 symbol_search
ss (block
, sym
);
4787 if (result_set
->find (ss
) == result_set
->end ())
4788 result_set
->insert (ss
);
4803 global_symbol_searcher::add_matching_msymbols
4804 (objfile
*objfile
, const gdb::optional
<compiled_regex
> &preg
,
4805 std::vector
<symbol_search
> *results
) const
4807 enum search_domain kind
= m_kind
;
4809 for (minimal_symbol
*msymbol
: objfile
->msymbols ())
4813 if (msymbol
->created_by_gdb
)
4816 if (is_suitable_msymbol (kind
, msymbol
))
4818 if (!preg
.has_value ()
4819 || preg
->exec (msymbol
->natural_name (), 0,
4822 /* For functions we can do a quick check of whether the
4823 symbol might be found via find_pc_symtab. */
4824 if (kind
!= FUNCTIONS_DOMAIN
4825 || (find_pc_compunit_symtab
4826 (MSYMBOL_VALUE_ADDRESS (objfile
, msymbol
))
4829 if (lookup_symbol_in_objfile_from_linkage_name
4830 (objfile
, msymbol
->linkage_name (),
4831 VAR_DOMAIN
).symbol
== NULL
)
4833 /* Matching msymbol, add it to the results list. */
4834 if (results
->size () < m_max_search_results
)
4835 results
->emplace_back (GLOBAL_BLOCK
, msymbol
, objfile
);
4849 std::vector
<symbol_search
>
4850 global_symbol_searcher::search () const
4852 gdb::optional
<compiled_regex
> preg
;
4853 gdb::optional
<compiled_regex
> treg
;
4855 gdb_assert (m_kind
!= ALL_DOMAIN
);
4857 if (m_symbol_name_regexp
!= NULL
)
4859 const char *symbol_name_regexp
= m_symbol_name_regexp
;
4861 /* Make sure spacing is right for C++ operators.
4862 This is just a courtesy to make the matching less sensitive
4863 to how many spaces the user leaves between 'operator'
4864 and <TYPENAME> or <OPERATOR>. */
4866 const char *opname
= operator_chars (symbol_name_regexp
, &opend
);
4870 int fix
= -1; /* -1 means ok; otherwise number of
4873 if (isalpha (*opname
) || *opname
== '_' || *opname
== '$')
4875 /* There should 1 space between 'operator' and 'TYPENAME'. */
4876 if (opname
[-1] != ' ' || opname
[-2] == ' ')
4881 /* There should 0 spaces between 'operator' and 'OPERATOR'. */
4882 if (opname
[-1] == ' ')
4885 /* If wrong number of spaces, fix it. */
4888 char *tmp
= (char *) alloca (8 + fix
+ strlen (opname
) + 1);
4890 sprintf (tmp
, "operator%.*s%s", fix
, " ", opname
);
4891 symbol_name_regexp
= tmp
;
4895 int cflags
= REG_NOSUB
| (case_sensitivity
== case_sensitive_off
4897 preg
.emplace (symbol_name_regexp
, cflags
,
4898 _("Invalid regexp"));
4901 if (m_symbol_type_regexp
!= NULL
)
4903 int cflags
= REG_NOSUB
| (case_sensitivity
== case_sensitive_off
4905 treg
.emplace (m_symbol_type_regexp
, cflags
,
4906 _("Invalid regexp"));
4909 bool found_msymbol
= false;
4910 std::set
<symbol_search
> result_set
;
4911 for (objfile
*objfile
: current_program_space
->objfiles ())
4913 /* Expand symtabs within objfile that possibly contain matching
4915 found_msymbol
|= expand_symtabs (objfile
, preg
);
4917 /* Find matching symbols within OBJFILE and add them in to the
4918 RESULT_SET set. Use a set here so that we can easily detect
4919 duplicates as we go, and can therefore track how many unique
4920 matches we have found so far. */
4921 if (!add_matching_symbols (objfile
, preg
, treg
, &result_set
))
4925 /* Convert the result set into a sorted result list, as std::set is
4926 defined to be sorted then no explicit call to std::sort is needed. */
4927 std::vector
<symbol_search
> result (result_set
.begin (), result_set
.end ());
4929 /* If there are no debug symbols, then add matching minsyms. But if the
4930 user wants to see symbols matching a type regexp, then never give a
4931 minimal symbol, as we assume that a minimal symbol does not have a
4933 if ((found_msymbol
|| (filenames
.empty () && m_kind
== VARIABLES_DOMAIN
))
4934 && !m_exclude_minsyms
4935 && !treg
.has_value ())
4937 gdb_assert (m_kind
== VARIABLES_DOMAIN
|| m_kind
== FUNCTIONS_DOMAIN
);
4938 for (objfile
*objfile
: current_program_space
->objfiles ())
4939 if (!add_matching_msymbols (objfile
, preg
, &result
))
4949 symbol_to_info_string (struct symbol
*sym
, int block
,
4950 enum search_domain kind
)
4954 gdb_assert (block
== GLOBAL_BLOCK
|| block
== STATIC_BLOCK
);
4956 if (kind
!= TYPES_DOMAIN
&& block
== STATIC_BLOCK
)
4959 /* Typedef that is not a C++ class. */
4960 if (kind
== TYPES_DOMAIN
4961 && SYMBOL_DOMAIN (sym
) != STRUCT_DOMAIN
)
4963 string_file tmp_stream
;
4965 /* FIXME: For C (and C++) we end up with a difference in output here
4966 between how a typedef is printed, and non-typedefs are printed.
4967 The TYPEDEF_PRINT code places a ";" at the end in an attempt to
4968 appear C-like, while TYPE_PRINT doesn't.
4970 For the struct printing case below, things are worse, we force
4971 printing of the ";" in this function, which is going to be wrong
4972 for languages that don't require a ";" between statements. */
4973 if (SYMBOL_TYPE (sym
)->code () == TYPE_CODE_TYPEDEF
)
4974 typedef_print (SYMBOL_TYPE (sym
), sym
, &tmp_stream
);
4976 type_print (SYMBOL_TYPE (sym
), "", &tmp_stream
, -1);
4977 str
+= tmp_stream
.string ();
4979 /* variable, func, or typedef-that-is-c++-class. */
4980 else if (kind
< TYPES_DOMAIN
4981 || (kind
== TYPES_DOMAIN
4982 && SYMBOL_DOMAIN (sym
) == STRUCT_DOMAIN
))
4984 string_file tmp_stream
;
4986 type_print (SYMBOL_TYPE (sym
),
4987 (SYMBOL_CLASS (sym
) == LOC_TYPEDEF
4988 ? "" : sym
->print_name ()),
4991 str
+= tmp_stream
.string ();
4994 /* Printing of modules is currently done here, maybe at some future
4995 point we might want a language specific method to print the module
4996 symbol so that we can customise the output more. */
4997 else if (kind
== MODULES_DOMAIN
)
4998 str
+= sym
->print_name ();
5003 /* Helper function for symbol info commands, for example 'info functions',
5004 'info variables', etc. KIND is the kind of symbol we searched for, and
5005 BLOCK is the type of block the symbols was found in, either GLOBAL_BLOCK
5006 or STATIC_BLOCK. SYM is the symbol we found. If LAST is not NULL,
5007 print file and line number information for the symbol as well. Skip
5008 printing the filename if it matches LAST. */
5011 print_symbol_info (enum search_domain kind
,
5013 int block
, const char *last
)
5015 scoped_switch_to_sym_language_if_auto
l (sym
);
5016 struct symtab
*s
= symbol_symtab (sym
);
5020 const char *s_filename
= symtab_to_filename_for_display (s
);
5022 if (filename_cmp (last
, s_filename
) != 0)
5024 printf_filtered (_("\nFile %ps:\n"),
5025 styled_string (file_name_style
.style (),
5029 if (SYMBOL_LINE (sym
) != 0)
5030 printf_filtered ("%d:\t", SYMBOL_LINE (sym
));
5032 puts_filtered ("\t");
5035 std::string str
= symbol_to_info_string (sym
, block
, kind
);
5036 printf_filtered ("%s\n", str
.c_str ());
5039 /* This help function for symtab_symbol_info() prints information
5040 for non-debugging symbols to gdb_stdout. */
5043 print_msymbol_info (struct bound_minimal_symbol msymbol
)
5045 struct gdbarch
*gdbarch
= msymbol
.objfile
->arch ();
5048 if (gdbarch_addr_bit (gdbarch
) <= 32)
5049 tmp
= hex_string_custom (BMSYMBOL_VALUE_ADDRESS (msymbol
)
5050 & (CORE_ADDR
) 0xffffffff,
5053 tmp
= hex_string_custom (BMSYMBOL_VALUE_ADDRESS (msymbol
),
5056 ui_file_style sym_style
= (msymbol
.minsym
->text_p ()
5057 ? function_name_style
.style ()
5058 : ui_file_style ());
5060 printf_filtered (_("%ps %ps\n"),
5061 styled_string (address_style
.style (), tmp
),
5062 styled_string (sym_style
, msymbol
.minsym
->print_name ()));
5065 /* This is the guts of the commands "info functions", "info types", and
5066 "info variables". It calls search_symbols to find all matches and then
5067 print_[m]symbol_info to print out some useful information about the
5071 symtab_symbol_info (bool quiet
, bool exclude_minsyms
,
5072 const char *regexp
, enum search_domain kind
,
5073 const char *t_regexp
, int from_tty
)
5075 static const char * const classnames
[] =
5076 {"variable", "function", "type", "module"};
5077 const char *last_filename
= "";
5080 gdb_assert (kind
!= ALL_DOMAIN
);
5082 if (regexp
!= nullptr && *regexp
== '\0')
5085 global_symbol_searcher
spec (kind
, regexp
);
5086 spec
.set_symbol_type_regexp (t_regexp
);
5087 spec
.set_exclude_minsyms (exclude_minsyms
);
5088 std::vector
<symbol_search
> symbols
= spec
.search ();
5094 if (t_regexp
!= NULL
)
5096 (_("All %ss matching regular expression \"%s\""
5097 " with type matching regular expression \"%s\":\n"),
5098 classnames
[kind
], regexp
, t_regexp
);
5100 printf_filtered (_("All %ss matching regular expression \"%s\":\n"),
5101 classnames
[kind
], regexp
);
5105 if (t_regexp
!= NULL
)
5107 (_("All defined %ss"
5108 " with type matching regular expression \"%s\" :\n"),
5109 classnames
[kind
], t_regexp
);
5111 printf_filtered (_("All defined %ss:\n"), classnames
[kind
]);
5115 for (const symbol_search
&p
: symbols
)
5119 if (p
.msymbol
.minsym
!= NULL
)
5124 printf_filtered (_("\nNon-debugging symbols:\n"));
5127 print_msymbol_info (p
.msymbol
);
5131 print_symbol_info (kind
,
5136 = symtab_to_filename_for_display (symbol_symtab (p
.symbol
));
5141 /* Structure to hold the values of the options used by the 'info variables'
5142 and 'info functions' commands. These correspond to the -q, -t, and -n
5145 struct info_vars_funcs_options
5148 bool exclude_minsyms
= false;
5149 char *type_regexp
= nullptr;
5151 ~info_vars_funcs_options ()
5153 xfree (type_regexp
);
5157 /* The options used by the 'info variables' and 'info functions'
5160 static const gdb::option::option_def info_vars_funcs_options_defs
[] = {
5161 gdb::option::boolean_option_def
<info_vars_funcs_options
> {
5163 [] (info_vars_funcs_options
*opt
) { return &opt
->quiet
; },
5164 nullptr, /* show_cmd_cb */
5165 nullptr /* set_doc */
5168 gdb::option::boolean_option_def
<info_vars_funcs_options
> {
5170 [] (info_vars_funcs_options
*opt
) { return &opt
->exclude_minsyms
; },
5171 nullptr, /* show_cmd_cb */
5172 nullptr /* set_doc */
5175 gdb::option::string_option_def
<info_vars_funcs_options
> {
5177 [] (info_vars_funcs_options
*opt
) { return &opt
->type_regexp
;
5179 nullptr, /* show_cmd_cb */
5180 nullptr /* set_doc */
5184 /* Returns the option group used by 'info variables' and 'info
5187 static gdb::option::option_def_group
5188 make_info_vars_funcs_options_def_group (info_vars_funcs_options
*opts
)
5190 return {{info_vars_funcs_options_defs
}, opts
};
5193 /* Command completer for 'info variables' and 'info functions'. */
5196 info_vars_funcs_command_completer (struct cmd_list_element
*ignore
,
5197 completion_tracker
&tracker
,
5198 const char *text
, const char * /* word */)
5201 = make_info_vars_funcs_options_def_group (nullptr);
5202 if (gdb::option::complete_options
5203 (tracker
, &text
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, group
))
5206 const char *word
= advance_to_expression_complete_word_point (tracker
, text
);
5207 symbol_completer (ignore
, tracker
, text
, word
);
5210 /* Implement the 'info variables' command. */
5213 info_variables_command (const char *args
, int from_tty
)
5215 info_vars_funcs_options opts
;
5216 auto grp
= make_info_vars_funcs_options_def_group (&opts
);
5217 gdb::option::process_options
5218 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
5219 if (args
!= nullptr && *args
== '\0')
5222 symtab_symbol_info (opts
.quiet
, opts
.exclude_minsyms
, args
, VARIABLES_DOMAIN
,
5223 opts
.type_regexp
, from_tty
);
5226 /* Implement the 'info functions' command. */
5229 info_functions_command (const char *args
, int from_tty
)
5231 info_vars_funcs_options opts
;
5233 auto grp
= make_info_vars_funcs_options_def_group (&opts
);
5234 gdb::option::process_options
5235 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
5236 if (args
!= nullptr && *args
== '\0')
5239 symtab_symbol_info (opts
.quiet
, opts
.exclude_minsyms
, args
,
5240 FUNCTIONS_DOMAIN
, opts
.type_regexp
, from_tty
);
5243 /* Holds the -q option for the 'info types' command. */
5245 struct info_types_options
5250 /* The options used by the 'info types' command. */
5252 static const gdb::option::option_def info_types_options_defs
[] = {
5253 gdb::option::boolean_option_def
<info_types_options
> {
5255 [] (info_types_options
*opt
) { return &opt
->quiet
; },
5256 nullptr, /* show_cmd_cb */
5257 nullptr /* set_doc */
5261 /* Returns the option group used by 'info types'. */
5263 static gdb::option::option_def_group
5264 make_info_types_options_def_group (info_types_options
*opts
)
5266 return {{info_types_options_defs
}, opts
};
5269 /* Implement the 'info types' command. */
5272 info_types_command (const char *args
, int from_tty
)
5274 info_types_options opts
;
5276 auto grp
= make_info_types_options_def_group (&opts
);
5277 gdb::option::process_options
5278 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
5279 if (args
!= nullptr && *args
== '\0')
5281 symtab_symbol_info (opts
.quiet
, false, args
, TYPES_DOMAIN
, NULL
, from_tty
);
5284 /* Command completer for 'info types' command. */
5287 info_types_command_completer (struct cmd_list_element
*ignore
,
5288 completion_tracker
&tracker
,
5289 const char *text
, const char * /* word */)
5292 = make_info_types_options_def_group (nullptr);
5293 if (gdb::option::complete_options
5294 (tracker
, &text
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, group
))
5297 const char *word
= advance_to_expression_complete_word_point (tracker
, text
);
5298 symbol_completer (ignore
, tracker
, text
, word
);
5301 /* Implement the 'info modules' command. */
5304 info_modules_command (const char *args
, int from_tty
)
5306 info_types_options opts
;
5308 auto grp
= make_info_types_options_def_group (&opts
);
5309 gdb::option::process_options
5310 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
5311 if (args
!= nullptr && *args
== '\0')
5313 symtab_symbol_info (opts
.quiet
, true, args
, MODULES_DOMAIN
, NULL
,
5318 rbreak_command (const char *regexp
, int from_tty
)
5321 const char *file_name
= nullptr;
5323 if (regexp
!= nullptr)
5325 const char *colon
= strchr (regexp
, ':');
5327 /* Ignore the colon if it is part of a Windows drive. */
5328 if (HAS_DRIVE_SPEC (regexp
)
5329 && (regexp
[2] == '/' || regexp
[2] == '\\'))
5330 colon
= strchr (STRIP_DRIVE_SPEC (regexp
), ':');
5332 if (colon
&& *(colon
+ 1) != ':')
5337 colon_index
= colon
- regexp
;
5338 local_name
= (char *) alloca (colon_index
+ 1);
5339 memcpy (local_name
, regexp
, colon_index
);
5340 local_name
[colon_index
--] = 0;
5341 while (isspace (local_name
[colon_index
]))
5342 local_name
[colon_index
--] = 0;
5343 file_name
= local_name
;
5344 regexp
= skip_spaces (colon
+ 1);
5348 global_symbol_searcher
spec (FUNCTIONS_DOMAIN
, regexp
);
5349 if (file_name
!= nullptr)
5350 spec
.filenames
.push_back (file_name
);
5351 std::vector
<symbol_search
> symbols
= spec
.search ();
5353 scoped_rbreak_breakpoints finalize
;
5354 for (const symbol_search
&p
: symbols
)
5356 if (p
.msymbol
.minsym
== NULL
)
5358 struct symtab
*symtab
= symbol_symtab (p
.symbol
);
5359 const char *fullname
= symtab_to_fullname (symtab
);
5361 string
= string_printf ("%s:'%s'", fullname
,
5362 p
.symbol
->linkage_name ());
5363 break_command (&string
[0], from_tty
);
5364 print_symbol_info (FUNCTIONS_DOMAIN
, p
.symbol
, p
.block
, NULL
);
5368 string
= string_printf ("'%s'",
5369 p
.msymbol
.minsym
->linkage_name ());
5371 break_command (&string
[0], from_tty
);
5372 printf_filtered ("<function, no debug info> %s;\n",
5373 p
.msymbol
.minsym
->print_name ());
5379 /* Evaluate if SYMNAME matches LOOKUP_NAME. */
5382 compare_symbol_name (const char *symbol_name
, language symbol_language
,
5383 const lookup_name_info
&lookup_name
,
5384 completion_match_result
&match_res
)
5386 const language_defn
*lang
= language_def (symbol_language
);
5388 symbol_name_matcher_ftype
*name_match
5389 = lang
->get_symbol_name_matcher (lookup_name
);
5391 return name_match (symbol_name
, lookup_name
, &match_res
);
5397 completion_list_add_name (completion_tracker
&tracker
,
5398 language symbol_language
,
5399 const char *symname
,
5400 const lookup_name_info
&lookup_name
,
5401 const char *text
, const char *word
)
5403 completion_match_result
&match_res
5404 = tracker
.reset_completion_match_result ();
5406 /* Clip symbols that cannot match. */
5407 if (!compare_symbol_name (symname
, symbol_language
, lookup_name
, match_res
))
5410 /* Refresh SYMNAME from the match string. It's potentially
5411 different depending on language. (E.g., on Ada, the match may be
5412 the encoded symbol name wrapped in "<>"). */
5413 symname
= match_res
.match
.match ();
5414 gdb_assert (symname
!= NULL
);
5416 /* We have a match for a completion, so add SYMNAME to the current list
5417 of matches. Note that the name is moved to freshly malloc'd space. */
5420 gdb::unique_xmalloc_ptr
<char> completion
5421 = make_completion_match_str (symname
, text
, word
);
5423 /* Here we pass the match-for-lcd object to add_completion. Some
5424 languages match the user text against substrings of symbol
5425 names in some cases. E.g., in C++, "b push_ba" completes to
5426 "std::vector::push_back", "std::string::push_back", etc., and
5427 in this case we want the completion lowest common denominator
5428 to be "push_back" instead of "std::". */
5429 tracker
.add_completion (std::move (completion
),
5430 &match_res
.match_for_lcd
, text
, word
);
5436 /* completion_list_add_name wrapper for struct symbol. */
5439 completion_list_add_symbol (completion_tracker
&tracker
,
5441 const lookup_name_info
&lookup_name
,
5442 const char *text
, const char *word
)
5444 if (!completion_list_add_name (tracker
, sym
->language (),
5445 sym
->natural_name (),
5446 lookup_name
, text
, word
))
5449 /* C++ function symbols include the parameters within both the msymbol
5450 name and the symbol name. The problem is that the msymbol name will
5451 describe the parameters in the most basic way, with typedefs stripped
5452 out, while the symbol name will represent the types as they appear in
5453 the program. This means we will see duplicate entries in the
5454 completion tracker. The following converts the symbol name back to
5455 the msymbol name and removes the msymbol name from the completion
5457 if (sym
->language () == language_cplus
5458 && SYMBOL_DOMAIN (sym
) == VAR_DOMAIN
5459 && SYMBOL_CLASS (sym
) == LOC_BLOCK
)
5461 /* The call to canonicalize returns the empty string if the input
5462 string is already in canonical form, thanks to this we don't
5463 remove the symbol we just added above. */
5464 gdb::unique_xmalloc_ptr
<char> str
5465 = cp_canonicalize_string_no_typedefs (sym
->natural_name ());
5467 tracker
.remove_completion (str
.get ());
5471 /* completion_list_add_name wrapper for struct minimal_symbol. */
5474 completion_list_add_msymbol (completion_tracker
&tracker
,
5475 minimal_symbol
*sym
,
5476 const lookup_name_info
&lookup_name
,
5477 const char *text
, const char *word
)
5479 completion_list_add_name (tracker
, sym
->language (),
5480 sym
->natural_name (),
5481 lookup_name
, text
, word
);
5485 /* ObjC: In case we are completing on a selector, look as the msymbol
5486 again and feed all the selectors into the mill. */
5489 completion_list_objc_symbol (completion_tracker
&tracker
,
5490 struct minimal_symbol
*msymbol
,
5491 const lookup_name_info
&lookup_name
,
5492 const char *text
, const char *word
)
5494 static char *tmp
= NULL
;
5495 static unsigned int tmplen
= 0;
5497 const char *method
, *category
, *selector
;
5500 method
= msymbol
->natural_name ();
5502 /* Is it a method? */
5503 if ((method
[0] != '-') && (method
[0] != '+'))
5507 /* Complete on shortened method method. */
5508 completion_list_add_name (tracker
, language_objc
,
5513 while ((strlen (method
) + 1) >= tmplen
)
5519 tmp
= (char *) xrealloc (tmp
, tmplen
);
5521 selector
= strchr (method
, ' ');
5522 if (selector
!= NULL
)
5525 category
= strchr (method
, '(');
5527 if ((category
!= NULL
) && (selector
!= NULL
))
5529 memcpy (tmp
, method
, (category
- method
));
5530 tmp
[category
- method
] = ' ';
5531 memcpy (tmp
+ (category
- method
) + 1, selector
, strlen (selector
) + 1);
5532 completion_list_add_name (tracker
, language_objc
, tmp
,
5533 lookup_name
, text
, word
);
5535 completion_list_add_name (tracker
, language_objc
, tmp
+ 1,
5536 lookup_name
, text
, word
);
5539 if (selector
!= NULL
)
5541 /* Complete on selector only. */
5542 strcpy (tmp
, selector
);
5543 tmp2
= strchr (tmp
, ']');
5547 completion_list_add_name (tracker
, language_objc
, tmp
,
5548 lookup_name
, text
, word
);
5552 /* Break the non-quoted text based on the characters which are in
5553 symbols. FIXME: This should probably be language-specific. */
5556 language_search_unquoted_string (const char *text
, const char *p
)
5558 for (; p
> text
; --p
)
5560 if (isalnum (p
[-1]) || p
[-1] == '_' || p
[-1] == '\0')
5564 if ((current_language
->la_language
== language_objc
))
5566 if (p
[-1] == ':') /* Might be part of a method name. */
5568 else if (p
[-1] == '[' && (p
[-2] == '-' || p
[-2] == '+'))
5569 p
-= 2; /* Beginning of a method name. */
5570 else if (p
[-1] == ' ' || p
[-1] == '(' || p
[-1] == ')')
5571 { /* Might be part of a method name. */
5574 /* Seeing a ' ' or a '(' is not conclusive evidence
5575 that we are in the middle of a method name. However,
5576 finding "-[" or "+[" should be pretty un-ambiguous.
5577 Unfortunately we have to find it now to decide. */
5580 if (isalnum (t
[-1]) || t
[-1] == '_' ||
5581 t
[-1] == ' ' || t
[-1] == ':' ||
5582 t
[-1] == '(' || t
[-1] == ')')
5587 if (t
[-1] == '[' && (t
[-2] == '-' || t
[-2] == '+'))
5588 p
= t
- 2; /* Method name detected. */
5589 /* Else we leave with p unchanged. */
5599 completion_list_add_fields (completion_tracker
&tracker
,
5601 const lookup_name_info
&lookup_name
,
5602 const char *text
, const char *word
)
5604 if (SYMBOL_CLASS (sym
) == LOC_TYPEDEF
)
5606 struct type
*t
= SYMBOL_TYPE (sym
);
5607 enum type_code c
= t
->code ();
5610 if (c
== TYPE_CODE_UNION
|| c
== TYPE_CODE_STRUCT
)
5611 for (j
= TYPE_N_BASECLASSES (t
); j
< t
->num_fields (); j
++)
5612 if (t
->field (j
).name ())
5613 completion_list_add_name (tracker
, sym
->language (),
5614 t
->field (j
).name (),
5615 lookup_name
, text
, word
);
5622 symbol_is_function_or_method (symbol
*sym
)
5624 switch (SYMBOL_TYPE (sym
)->code ())
5626 case TYPE_CODE_FUNC
:
5627 case TYPE_CODE_METHOD
:
5637 symbol_is_function_or_method (minimal_symbol
*msymbol
)
5639 switch (MSYMBOL_TYPE (msymbol
))
5642 case mst_text_gnu_ifunc
:
5643 case mst_solib_trampoline
:
5653 bound_minimal_symbol
5654 find_gnu_ifunc (const symbol
*sym
)
5656 if (SYMBOL_CLASS (sym
) != LOC_BLOCK
)
5659 lookup_name_info
lookup_name (sym
->search_name (),
5660 symbol_name_match_type::SEARCH_NAME
);
5661 struct objfile
*objfile
= symbol_objfile (sym
);
5663 CORE_ADDR address
= BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
));
5664 minimal_symbol
*ifunc
= NULL
;
5666 iterate_over_minimal_symbols (objfile
, lookup_name
,
5667 [&] (minimal_symbol
*minsym
)
5669 if (MSYMBOL_TYPE (minsym
) == mst_text_gnu_ifunc
5670 || MSYMBOL_TYPE (minsym
) == mst_data_gnu_ifunc
)
5672 CORE_ADDR msym_addr
= MSYMBOL_VALUE_ADDRESS (objfile
, minsym
);
5673 if (MSYMBOL_TYPE (minsym
) == mst_data_gnu_ifunc
)
5675 struct gdbarch
*gdbarch
= objfile
->arch ();
5676 msym_addr
= gdbarch_convert_from_func_ptr_addr
5677 (gdbarch
, msym_addr
, current_inferior ()->top_target ());
5679 if (msym_addr
== address
)
5689 return {ifunc
, objfile
};
5693 /* Add matching symbols from SYMTAB to the current completion list. */
5696 add_symtab_completions (struct compunit_symtab
*cust
,
5697 completion_tracker
&tracker
,
5698 complete_symbol_mode mode
,
5699 const lookup_name_info
&lookup_name
,
5700 const char *text
, const char *word
,
5701 enum type_code code
)
5704 const struct block
*b
;
5705 struct block_iterator iter
;
5711 for (i
= GLOBAL_BLOCK
; i
<= STATIC_BLOCK
; i
++)
5714 b
= BLOCKVECTOR_BLOCK (COMPUNIT_BLOCKVECTOR (cust
), i
);
5715 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
5717 if (completion_skip_symbol (mode
, sym
))
5720 if (code
== TYPE_CODE_UNDEF
5721 || (SYMBOL_DOMAIN (sym
) == STRUCT_DOMAIN
5722 && SYMBOL_TYPE (sym
)->code () == code
))
5723 completion_list_add_symbol (tracker
, sym
,
5731 default_collect_symbol_completion_matches_break_on
5732 (completion_tracker
&tracker
, complete_symbol_mode mode
,
5733 symbol_name_match_type name_match_type
,
5734 const char *text
, const char *word
,
5735 const char *break_on
, enum type_code code
)
5737 /* Problem: All of the symbols have to be copied because readline
5738 frees them. I'm not going to worry about this; hopefully there
5739 won't be that many. */
5742 const struct block
*b
;
5743 const struct block
*surrounding_static_block
, *surrounding_global_block
;
5744 struct block_iterator iter
;
5745 /* The symbol we are completing on. Points in same buffer as text. */
5746 const char *sym_text
;
5748 /* Now look for the symbol we are supposed to complete on. */
5749 if (mode
== complete_symbol_mode::LINESPEC
)
5755 const char *quote_pos
= NULL
;
5757 /* First see if this is a quoted string. */
5759 for (p
= text
; *p
!= '\0'; ++p
)
5761 if (quote_found
!= '\0')
5763 if (*p
== quote_found
)
5764 /* Found close quote. */
5766 else if (*p
== '\\' && p
[1] == quote_found
)
5767 /* A backslash followed by the quote character
5768 doesn't end the string. */
5771 else if (*p
== '\'' || *p
== '"')
5777 if (quote_found
== '\'')
5778 /* A string within single quotes can be a symbol, so complete on it. */
5779 sym_text
= quote_pos
+ 1;
5780 else if (quote_found
== '"')
5781 /* A double-quoted string is never a symbol, nor does it make sense
5782 to complete it any other way. */
5788 /* It is not a quoted string. Break it based on the characters
5789 which are in symbols. */
5792 if (isalnum (p
[-1]) || p
[-1] == '_' || p
[-1] == '\0'
5793 || p
[-1] == ':' || strchr (break_on
, p
[-1]) != NULL
)
5802 lookup_name_info
lookup_name (sym_text
, name_match_type
, true);
5804 /* At this point scan through the misc symbol vectors and add each
5805 symbol you find to the list. Eventually we want to ignore
5806 anything that isn't a text symbol (everything else will be
5807 handled by the psymtab code below). */
5809 if (code
== TYPE_CODE_UNDEF
)
5811 for (objfile
*objfile
: current_program_space
->objfiles ())
5813 for (minimal_symbol
*msymbol
: objfile
->msymbols ())
5817 if (completion_skip_symbol (mode
, msymbol
))
5820 completion_list_add_msymbol (tracker
, msymbol
, lookup_name
,
5823 completion_list_objc_symbol (tracker
, msymbol
, lookup_name
,
5829 /* Add completions for all currently loaded symbol tables. */
5830 for (objfile
*objfile
: current_program_space
->objfiles ())
5832 for (compunit_symtab
*cust
: objfile
->compunits ())
5833 add_symtab_completions (cust
, tracker
, mode
, lookup_name
,
5834 sym_text
, word
, code
);
5837 /* Look through the partial symtabs for all symbols which begin by
5838 matching SYM_TEXT. Expand all CUs that you find to the list. */
5839 expand_symtabs_matching (NULL
,
5842 [&] (compunit_symtab
*symtab
) /* expansion notify */
5844 add_symtab_completions (symtab
,
5845 tracker
, mode
, lookup_name
,
5846 sym_text
, word
, code
);
5849 SEARCH_GLOBAL_BLOCK
| SEARCH_STATIC_BLOCK
,
5852 /* Search upwards from currently selected frame (so that we can
5853 complete on local vars). Also catch fields of types defined in
5854 this places which match our text string. Only complete on types
5855 visible from current context. */
5857 b
= get_selected_block (0);
5858 surrounding_static_block
= block_static_block (b
);
5859 surrounding_global_block
= block_global_block (b
);
5860 if (surrounding_static_block
!= NULL
)
5861 while (b
!= surrounding_static_block
)
5865 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
5867 if (code
== TYPE_CODE_UNDEF
)
5869 completion_list_add_symbol (tracker
, sym
, lookup_name
,
5871 completion_list_add_fields (tracker
, sym
, lookup_name
,
5874 else if (SYMBOL_DOMAIN (sym
) == STRUCT_DOMAIN
5875 && SYMBOL_TYPE (sym
)->code () == code
)
5876 completion_list_add_symbol (tracker
, sym
, lookup_name
,
5880 /* Stop when we encounter an enclosing function. Do not stop for
5881 non-inlined functions - the locals of the enclosing function
5882 are in scope for a nested function. */
5883 if (BLOCK_FUNCTION (b
) != NULL
&& block_inlined_p (b
))
5885 b
= BLOCK_SUPERBLOCK (b
);
5888 /* Add fields from the file's types; symbols will be added below. */
5890 if (code
== TYPE_CODE_UNDEF
)
5892 if (surrounding_static_block
!= NULL
)
5893 ALL_BLOCK_SYMBOLS (surrounding_static_block
, iter
, sym
)
5894 completion_list_add_fields (tracker
, sym
, lookup_name
,
5897 if (surrounding_global_block
!= NULL
)
5898 ALL_BLOCK_SYMBOLS (surrounding_global_block
, iter
, sym
)
5899 completion_list_add_fields (tracker
, sym
, lookup_name
,
5903 /* Skip macros if we are completing a struct tag -- arguable but
5904 usually what is expected. */
5905 if (current_language
->macro_expansion () == macro_expansion_c
5906 && code
== TYPE_CODE_UNDEF
)
5908 gdb::unique_xmalloc_ptr
<struct macro_scope
> scope
;
5910 /* This adds a macro's name to the current completion list. */
5911 auto add_macro_name
= [&] (const char *macro_name
,
5912 const macro_definition
*,
5913 macro_source_file
*,
5916 completion_list_add_name (tracker
, language_c
, macro_name
,
5917 lookup_name
, sym_text
, word
);
5920 /* Add any macros visible in the default scope. Note that this
5921 may yield the occasional wrong result, because an expression
5922 might be evaluated in a scope other than the default. For
5923 example, if the user types "break file:line if <TAB>", the
5924 resulting expression will be evaluated at "file:line" -- but
5925 at there does not seem to be a way to detect this at
5927 scope
= default_macro_scope ();
5929 macro_for_each_in_scope (scope
->file
, scope
->line
,
5932 /* User-defined macros are always visible. */
5933 macro_for_each (macro_user_macros
, add_macro_name
);
5937 /* Collect all symbols (regardless of class) which begin by matching
5941 collect_symbol_completion_matches (completion_tracker
&tracker
,
5942 complete_symbol_mode mode
,
5943 symbol_name_match_type name_match_type
,
5944 const char *text
, const char *word
)
5946 current_language
->collect_symbol_completion_matches (tracker
, mode
,
5952 /* Like collect_symbol_completion_matches, but only collect
5953 STRUCT_DOMAIN symbols whose type code is CODE. */
5956 collect_symbol_completion_matches_type (completion_tracker
&tracker
,
5957 const char *text
, const char *word
,
5958 enum type_code code
)
5960 complete_symbol_mode mode
= complete_symbol_mode::EXPRESSION
;
5961 symbol_name_match_type name_match_type
= symbol_name_match_type::EXPRESSION
;
5963 gdb_assert (code
== TYPE_CODE_UNION
5964 || code
== TYPE_CODE_STRUCT
5965 || code
== TYPE_CODE_ENUM
);
5966 current_language
->collect_symbol_completion_matches (tracker
, mode
,
5971 /* Like collect_symbol_completion_matches, but collects a list of
5972 symbols defined in all source files named SRCFILE. */
5975 collect_file_symbol_completion_matches (completion_tracker
&tracker
,
5976 complete_symbol_mode mode
,
5977 symbol_name_match_type name_match_type
,
5978 const char *text
, const char *word
,
5979 const char *srcfile
)
5981 /* The symbol we are completing on. Points in same buffer as text. */
5982 const char *sym_text
;
5984 /* Now look for the symbol we are supposed to complete on.
5985 FIXME: This should be language-specific. */
5986 if (mode
== complete_symbol_mode::LINESPEC
)
5992 const char *quote_pos
= NULL
;
5994 /* First see if this is a quoted string. */
5996 for (p
= text
; *p
!= '\0'; ++p
)
5998 if (quote_found
!= '\0')
6000 if (*p
== quote_found
)
6001 /* Found close quote. */
6003 else if (*p
== '\\' && p
[1] == quote_found
)
6004 /* A backslash followed by the quote character
6005 doesn't end the string. */
6008 else if (*p
== '\'' || *p
== '"')
6014 if (quote_found
== '\'')
6015 /* A string within single quotes can be a symbol, so complete on it. */
6016 sym_text
= quote_pos
+ 1;
6017 else if (quote_found
== '"')
6018 /* A double-quoted string is never a symbol, nor does it make sense
6019 to complete it any other way. */
6025 /* Not a quoted string. */
6026 sym_text
= language_search_unquoted_string (text
, p
);
6030 lookup_name_info
lookup_name (sym_text
, name_match_type
, true);
6032 /* Go through symtabs for SRCFILE and check the externs and statics
6033 for symbols which match. */
6034 iterate_over_symtabs (srcfile
, [&] (symtab
*s
)
6036 add_symtab_completions (SYMTAB_COMPUNIT (s
),
6037 tracker
, mode
, lookup_name
,
6038 sym_text
, word
, TYPE_CODE_UNDEF
);
6043 /* A helper function for make_source_files_completion_list. It adds
6044 another file name to a list of possible completions, growing the
6045 list as necessary. */
6048 add_filename_to_list (const char *fname
, const char *text
, const char *word
,
6049 completion_list
*list
)
6051 list
->emplace_back (make_completion_match_str (fname
, text
, word
));
6055 not_interesting_fname (const char *fname
)
6057 static const char *illegal_aliens
[] = {
6058 "_globals_", /* inserted by coff_symtab_read */
6063 for (i
= 0; illegal_aliens
[i
]; i
++)
6065 if (filename_cmp (fname
, illegal_aliens
[i
]) == 0)
6071 /* An object of this type is passed as the callback argument to
6072 map_partial_symbol_filenames. */
6073 struct add_partial_filename_data
6075 struct filename_seen_cache
*filename_seen_cache
;
6079 completion_list
*list
;
6081 void operator() (const char *filename
, const char *fullname
);
6084 /* A callback for map_partial_symbol_filenames. */
6087 add_partial_filename_data::operator() (const char *filename
,
6088 const char *fullname
)
6090 if (not_interesting_fname (filename
))
6092 if (!filename_seen_cache
->seen (filename
)
6093 && filename_ncmp (filename
, text
, text_len
) == 0)
6095 /* This file matches for a completion; add it to the
6096 current list of matches. */
6097 add_filename_to_list (filename
, text
, word
, list
);
6101 const char *base_name
= lbasename (filename
);
6103 if (base_name
!= filename
6104 && !filename_seen_cache
->seen (base_name
)
6105 && filename_ncmp (base_name
, text
, text_len
) == 0)
6106 add_filename_to_list (base_name
, text
, word
, list
);
6110 /* Return a list of all source files whose names begin with matching
6111 TEXT. The file names are looked up in the symbol tables of this
6115 make_source_files_completion_list (const char *text
, const char *word
)
6117 size_t text_len
= strlen (text
);
6118 completion_list list
;
6119 const char *base_name
;
6120 struct add_partial_filename_data datum
;
6122 if (!have_full_symbols () && !have_partial_symbols ())
6125 filename_seen_cache filenames_seen
;
6127 for (objfile
*objfile
: current_program_space
->objfiles ())
6129 for (compunit_symtab
*cu
: objfile
->compunits ())
6131 for (symtab
*s
: compunit_filetabs (cu
))
6133 if (not_interesting_fname (s
->filename
))
6135 if (!filenames_seen
.seen (s
->filename
)
6136 && filename_ncmp (s
->filename
, text
, text_len
) == 0)
6138 /* This file matches for a completion; add it to the current
6140 add_filename_to_list (s
->filename
, text
, word
, &list
);
6144 /* NOTE: We allow the user to type a base name when the
6145 debug info records leading directories, but not the other
6146 way around. This is what subroutines of breakpoint
6147 command do when they parse file names. */
6148 base_name
= lbasename (s
->filename
);
6149 if (base_name
!= s
->filename
6150 && !filenames_seen
.seen (base_name
)
6151 && filename_ncmp (base_name
, text
, text_len
) == 0)
6152 add_filename_to_list (base_name
, text
, word
, &list
);
6158 datum
.filename_seen_cache
= &filenames_seen
;
6161 datum
.text_len
= text_len
;
6163 map_symbol_filenames (datum
, false /*need_fullname*/);
6170 /* Return the "main_info" object for the current program space. If
6171 the object has not yet been created, create it and fill in some
6174 static struct main_info
*
6175 get_main_info (void)
6177 struct main_info
*info
= main_progspace_key
.get (current_program_space
);
6181 /* It may seem strange to store the main name in the progspace
6182 and also in whatever objfile happens to see a main name in
6183 its debug info. The reason for this is mainly historical:
6184 gdb returned "main" as the name even if no function named
6185 "main" was defined the program; and this approach lets us
6186 keep compatibility. */
6187 info
= main_progspace_key
.emplace (current_program_space
);
6194 set_main_name (const char *name
, enum language lang
)
6196 struct main_info
*info
= get_main_info ();
6198 if (info
->name_of_main
!= NULL
)
6200 xfree (info
->name_of_main
);
6201 info
->name_of_main
= NULL
;
6202 info
->language_of_main
= language_unknown
;
6206 info
->name_of_main
= xstrdup (name
);
6207 info
->language_of_main
= lang
;
6211 /* Deduce the name of the main procedure, and set NAME_OF_MAIN
6215 find_main_name (void)
6217 const char *new_main_name
;
6219 /* First check the objfiles to see whether a debuginfo reader has
6220 picked up the appropriate main name. Historically the main name
6221 was found in a more or less random way; this approach instead
6222 relies on the order of objfile creation -- which still isn't
6223 guaranteed to get the correct answer, but is just probably more
6225 for (objfile
*objfile
: current_program_space
->objfiles ())
6227 if (objfile
->per_bfd
->name_of_main
!= NULL
)
6229 set_main_name (objfile
->per_bfd
->name_of_main
,
6230 objfile
->per_bfd
->language_of_main
);
6235 /* Try to see if the main procedure is in Ada. */
6236 /* FIXME: brobecker/2005-03-07: Another way of doing this would
6237 be to add a new method in the language vector, and call this
6238 method for each language until one of them returns a non-empty
6239 name. This would allow us to remove this hard-coded call to
6240 an Ada function. It is not clear that this is a better approach
6241 at this point, because all methods need to be written in a way
6242 such that false positives never be returned. For instance, it is
6243 important that a method does not return a wrong name for the main
6244 procedure if the main procedure is actually written in a different
6245 language. It is easy to guaranty this with Ada, since we use a
6246 special symbol generated only when the main in Ada to find the name
6247 of the main procedure. It is difficult however to see how this can
6248 be guarantied for languages such as C, for instance. This suggests
6249 that order of call for these methods becomes important, which means
6250 a more complicated approach. */
6251 new_main_name
= ada_main_name ();
6252 if (new_main_name
!= NULL
)
6254 set_main_name (new_main_name
, language_ada
);
6258 new_main_name
= d_main_name ();
6259 if (new_main_name
!= NULL
)
6261 set_main_name (new_main_name
, language_d
);
6265 new_main_name
= go_main_name ();
6266 if (new_main_name
!= NULL
)
6268 set_main_name (new_main_name
, language_go
);
6272 new_main_name
= pascal_main_name ();
6273 if (new_main_name
!= NULL
)
6275 set_main_name (new_main_name
, language_pascal
);
6279 /* The languages above didn't identify the name of the main procedure.
6280 Fallback to "main". */
6282 /* Try to find language for main in psymtabs. */
6284 = find_quick_global_symbol_language ("main", VAR_DOMAIN
);
6285 if (lang
!= language_unknown
)
6287 set_main_name ("main", lang
);
6291 set_main_name ("main", language_unknown
);
6299 struct main_info
*info
= get_main_info ();
6301 if (info
->name_of_main
== NULL
)
6304 return info
->name_of_main
;
6307 /* Return the language of the main function. If it is not known,
6308 return language_unknown. */
6311 main_language (void)
6313 struct main_info
*info
= get_main_info ();
6315 if (info
->name_of_main
== NULL
)
6318 return info
->language_of_main
;
6321 /* Handle ``executable_changed'' events for the symtab module. */
6324 symtab_observer_executable_changed (void)
6326 /* NAME_OF_MAIN may no longer be the same, so reset it for now. */
6327 set_main_name (NULL
, language_unknown
);
6330 /* Return 1 if the supplied producer string matches the ARM RealView
6331 compiler (armcc). */
6334 producer_is_realview (const char *producer
)
6336 static const char *const arm_idents
[] = {
6337 "ARM C Compiler, ADS",
6338 "Thumb C Compiler, ADS",
6339 "ARM C++ Compiler, ADS",
6340 "Thumb C++ Compiler, ADS",
6341 "ARM/Thumb C/C++ Compiler, RVCT",
6342 "ARM C/C++ Compiler, RVCT"
6346 if (producer
== NULL
)
6349 for (i
= 0; i
< ARRAY_SIZE (arm_idents
); i
++)
6350 if (startswith (producer
, arm_idents
[i
]))
6358 /* The next index to hand out in response to a registration request. */
6360 static int next_aclass_value
= LOC_FINAL_VALUE
;
6362 /* The maximum number of "aclass" registrations we support. This is
6363 constant for convenience. */
6364 #define MAX_SYMBOL_IMPLS (LOC_FINAL_VALUE + 10)
6366 /* The objects representing the various "aclass" values. The elements
6367 from 0 up to LOC_FINAL_VALUE-1 represent themselves, and subsequent
6368 elements are those registered at gdb initialization time. */
6370 static struct symbol_impl symbol_impl
[MAX_SYMBOL_IMPLS
];
6372 /* The globally visible pointer. This is separate from 'symbol_impl'
6373 so that it can be const. */
6375 const struct symbol_impl
*symbol_impls
= &symbol_impl
[0];
6377 /* Make sure we saved enough room in struct symbol. */
6379 gdb_static_assert (MAX_SYMBOL_IMPLS
<= (1 << SYMBOL_ACLASS_BITS
));
6381 /* Register a computed symbol type. ACLASS must be LOC_COMPUTED. OPS
6382 is the ops vector associated with this index. This returns the new
6383 index, which should be used as the aclass_index field for symbols
6387 register_symbol_computed_impl (enum address_class aclass
,
6388 const struct symbol_computed_ops
*ops
)
6390 int result
= next_aclass_value
++;
6392 gdb_assert (aclass
== LOC_COMPUTED
);
6393 gdb_assert (result
< MAX_SYMBOL_IMPLS
);
6394 symbol_impl
[result
].aclass
= aclass
;
6395 symbol_impl
[result
].ops_computed
= ops
;
6397 /* Sanity check OPS. */
6398 gdb_assert (ops
!= NULL
);
6399 gdb_assert (ops
->tracepoint_var_ref
!= NULL
);
6400 gdb_assert (ops
->describe_location
!= NULL
);
6401 gdb_assert (ops
->get_symbol_read_needs
!= NULL
);
6402 gdb_assert (ops
->read_variable
!= NULL
);
6407 /* Register a function with frame base type. ACLASS must be LOC_BLOCK.
6408 OPS is the ops vector associated with this index. This returns the
6409 new index, which should be used as the aclass_index field for symbols
6413 register_symbol_block_impl (enum address_class aclass
,
6414 const struct symbol_block_ops
*ops
)
6416 int result
= next_aclass_value
++;
6418 gdb_assert (aclass
== LOC_BLOCK
);
6419 gdb_assert (result
< MAX_SYMBOL_IMPLS
);
6420 symbol_impl
[result
].aclass
= aclass
;
6421 symbol_impl
[result
].ops_block
= ops
;
6423 /* Sanity check OPS. */
6424 gdb_assert (ops
!= NULL
);
6425 gdb_assert (ops
->find_frame_base_location
!= NULL
);
6430 /* Register a register symbol type. ACLASS must be LOC_REGISTER or
6431 LOC_REGPARM_ADDR. OPS is the register ops vector associated with
6432 this index. This returns the new index, which should be used as
6433 the aclass_index field for symbols of this type. */
6436 register_symbol_register_impl (enum address_class aclass
,
6437 const struct symbol_register_ops
*ops
)
6439 int result
= next_aclass_value
++;
6441 gdb_assert (aclass
== LOC_REGISTER
|| aclass
== LOC_REGPARM_ADDR
);
6442 gdb_assert (result
< MAX_SYMBOL_IMPLS
);
6443 symbol_impl
[result
].aclass
= aclass
;
6444 symbol_impl
[result
].ops_register
= ops
;
6449 /* Initialize elements of 'symbol_impl' for the constants in enum
6453 initialize_ordinary_address_classes (void)
6457 for (i
= 0; i
< LOC_FINAL_VALUE
; ++i
)
6458 symbol_impl
[i
].aclass
= (enum address_class
) i
;
6466 symbol_objfile (const struct symbol
*symbol
)
6468 gdb_assert (SYMBOL_OBJFILE_OWNED (symbol
));
6469 return SYMTAB_OBJFILE (symbol
->owner
.symtab
);
6475 symbol_arch (const struct symbol
*symbol
)
6477 if (!SYMBOL_OBJFILE_OWNED (symbol
))
6478 return symbol
->owner
.arch
;
6479 return SYMTAB_OBJFILE (symbol
->owner
.symtab
)->arch ();
6485 symbol_symtab (const struct symbol
*symbol
)
6487 gdb_assert (SYMBOL_OBJFILE_OWNED (symbol
));
6488 return symbol
->owner
.symtab
;
6494 symbol_set_symtab (struct symbol
*symbol
, struct symtab
*symtab
)
6496 gdb_assert (SYMBOL_OBJFILE_OWNED (symbol
));
6497 symbol
->owner
.symtab
= symtab
;
6503 get_symbol_address (const struct symbol
*sym
)
6505 gdb_assert (sym
->maybe_copied
);
6506 gdb_assert (SYMBOL_CLASS (sym
) == LOC_STATIC
);
6508 const char *linkage_name
= sym
->linkage_name ();
6510 for (objfile
*objfile
: current_program_space
->objfiles ())
6512 if (objfile
->separate_debug_objfile_backlink
!= nullptr)
6515 bound_minimal_symbol minsym
6516 = lookup_minimal_symbol_linkage (linkage_name
, objfile
);
6517 if (minsym
.minsym
!= nullptr)
6518 return BMSYMBOL_VALUE_ADDRESS (minsym
);
6520 return sym
->value
.address
;
6526 get_msymbol_address (struct objfile
*objf
, const struct minimal_symbol
*minsym
)
6528 gdb_assert (minsym
->maybe_copied
);
6529 gdb_assert ((objf
->flags
& OBJF_MAINLINE
) == 0);
6531 const char *linkage_name
= minsym
->linkage_name ();
6533 for (objfile
*objfile
: current_program_space
->objfiles ())
6535 if (objfile
->separate_debug_objfile_backlink
== nullptr
6536 && (objfile
->flags
& OBJF_MAINLINE
) != 0)
6538 bound_minimal_symbol found
6539 = lookup_minimal_symbol_linkage (linkage_name
, objfile
);
6540 if (found
.minsym
!= nullptr)
6541 return BMSYMBOL_VALUE_ADDRESS (found
);
6544 return (minsym
->value
.address
6545 + objf
->section_offsets
[minsym
->section_index ()]);
6550 /* Hold the sub-commands of 'info module'. */
6552 static struct cmd_list_element
*info_module_cmdlist
= NULL
;
6556 std::vector
<module_symbol_search
>
6557 search_module_symbols (const char *module_regexp
, const char *regexp
,
6558 const char *type_regexp
, search_domain kind
)
6560 std::vector
<module_symbol_search
> results
;
6562 /* Search for all modules matching MODULE_REGEXP. */
6563 global_symbol_searcher
spec1 (MODULES_DOMAIN
, module_regexp
);
6564 spec1
.set_exclude_minsyms (true);
6565 std::vector
<symbol_search
> modules
= spec1
.search ();
6567 /* Now search for all symbols of the required KIND matching the required
6568 regular expressions. We figure out which ones are in which modules
6570 global_symbol_searcher
spec2 (kind
, regexp
);
6571 spec2
.set_symbol_type_regexp (type_regexp
);
6572 spec2
.set_exclude_minsyms (true);
6573 std::vector
<symbol_search
> symbols
= spec2
.search ();
6575 /* Now iterate over all MODULES, checking to see which items from
6576 SYMBOLS are in each module. */
6577 for (const symbol_search
&p
: modules
)
6581 /* This is a module. */
6582 gdb_assert (p
.symbol
!= nullptr);
6584 std::string prefix
= p
.symbol
->print_name ();
6587 for (const symbol_search
&q
: symbols
)
6589 if (q
.symbol
== nullptr)
6592 if (strncmp (q
.symbol
->print_name (), prefix
.c_str (),
6593 prefix
.size ()) != 0)
6596 results
.push_back ({p
, q
});
6603 /* Implement the core of both 'info module functions' and 'info module
6607 info_module_subcommand (bool quiet
, const char *module_regexp
,
6608 const char *regexp
, const char *type_regexp
,
6611 /* Print a header line. Don't build the header line bit by bit as this
6612 prevents internationalisation. */
6615 if (module_regexp
== nullptr)
6617 if (type_regexp
== nullptr)
6619 if (regexp
== nullptr)
6620 printf_filtered ((kind
== VARIABLES_DOMAIN
6621 ? _("All variables in all modules:")
6622 : _("All functions in all modules:")));
6625 ((kind
== VARIABLES_DOMAIN
6626 ? _("All variables matching regular expression"
6627 " \"%s\" in all modules:")
6628 : _("All functions matching regular expression"
6629 " \"%s\" in all modules:")),
6634 if (regexp
== nullptr)
6636 ((kind
== VARIABLES_DOMAIN
6637 ? _("All variables with type matching regular "
6638 "expression \"%s\" in all modules:")
6639 : _("All functions with type matching regular "
6640 "expression \"%s\" in all modules:")),
6644 ((kind
== VARIABLES_DOMAIN
6645 ? _("All variables matching regular expression "
6646 "\"%s\",\n\twith type matching regular "
6647 "expression \"%s\" in all modules:")
6648 : _("All functions matching regular expression "
6649 "\"%s\",\n\twith type matching regular "
6650 "expression \"%s\" in all modules:")),
6651 regexp
, type_regexp
);
6656 if (type_regexp
== nullptr)
6658 if (regexp
== nullptr)
6660 ((kind
== VARIABLES_DOMAIN
6661 ? _("All variables in all modules matching regular "
6662 "expression \"%s\":")
6663 : _("All functions in all modules matching regular "
6664 "expression \"%s\":")),
6668 ((kind
== VARIABLES_DOMAIN
6669 ? _("All variables matching regular expression "
6670 "\"%s\",\n\tin all modules matching regular "
6671 "expression \"%s\":")
6672 : _("All functions matching regular expression "
6673 "\"%s\",\n\tin all modules matching regular "
6674 "expression \"%s\":")),
6675 regexp
, module_regexp
);
6679 if (regexp
== nullptr)
6681 ((kind
== VARIABLES_DOMAIN
6682 ? _("All variables with type matching regular "
6683 "expression \"%s\"\n\tin all modules matching "
6684 "regular expression \"%s\":")
6685 : _("All functions with type matching regular "
6686 "expression \"%s\"\n\tin all modules matching "
6687 "regular expression \"%s\":")),
6688 type_regexp
, module_regexp
);
6691 ((kind
== VARIABLES_DOMAIN
6692 ? _("All variables matching regular expression "
6693 "\"%s\",\n\twith type matching regular expression "
6694 "\"%s\",\n\tin all modules matching regular "
6695 "expression \"%s\":")
6696 : _("All functions matching regular expression "
6697 "\"%s\",\n\twith type matching regular expression "
6698 "\"%s\",\n\tin all modules matching regular "
6699 "expression \"%s\":")),
6700 regexp
, type_regexp
, module_regexp
);
6703 printf_filtered ("\n");
6706 /* Find all symbols of type KIND matching the given regular expressions
6707 along with the symbols for the modules in which those symbols
6709 std::vector
<module_symbol_search
> module_symbols
6710 = search_module_symbols (module_regexp
, regexp
, type_regexp
, kind
);
6712 std::sort (module_symbols
.begin (), module_symbols
.end (),
6713 [] (const module_symbol_search
&a
, const module_symbol_search
&b
)
6715 if (a
.first
< b
.first
)
6717 else if (a
.first
== b
.first
)
6718 return a
.second
< b
.second
;
6723 const char *last_filename
= "";
6724 const symbol
*last_module_symbol
= nullptr;
6725 for (const module_symbol_search
&ms
: module_symbols
)
6727 const symbol_search
&p
= ms
.first
;
6728 const symbol_search
&q
= ms
.second
;
6730 gdb_assert (q
.symbol
!= nullptr);
6732 if (last_module_symbol
!= p
.symbol
)
6734 printf_filtered ("\n");
6735 printf_filtered (_("Module \"%s\":\n"), p
.symbol
->print_name ());
6736 last_module_symbol
= p
.symbol
;
6740 print_symbol_info (FUNCTIONS_DOMAIN
, q
.symbol
, q
.block
,
6743 = symtab_to_filename_for_display (symbol_symtab (q
.symbol
));
6747 /* Hold the option values for the 'info module .....' sub-commands. */
6749 struct info_modules_var_func_options
6752 char *type_regexp
= nullptr;
6753 char *module_regexp
= nullptr;
6755 ~info_modules_var_func_options ()
6757 xfree (type_regexp
);
6758 xfree (module_regexp
);
6762 /* The options used by 'info module variables' and 'info module functions'
6765 static const gdb::option::option_def info_modules_var_func_options_defs
[] = {
6766 gdb::option::boolean_option_def
<info_modules_var_func_options
> {
6768 [] (info_modules_var_func_options
*opt
) { return &opt
->quiet
; },
6769 nullptr, /* show_cmd_cb */
6770 nullptr /* set_doc */
6773 gdb::option::string_option_def
<info_modules_var_func_options
> {
6775 [] (info_modules_var_func_options
*opt
) { return &opt
->type_regexp
; },
6776 nullptr, /* show_cmd_cb */
6777 nullptr /* set_doc */
6780 gdb::option::string_option_def
<info_modules_var_func_options
> {
6782 [] (info_modules_var_func_options
*opt
) { return &opt
->module_regexp
; },
6783 nullptr, /* show_cmd_cb */
6784 nullptr /* set_doc */
6788 /* Return the option group used by the 'info module ...' sub-commands. */
6790 static inline gdb::option::option_def_group
6791 make_info_modules_var_func_options_def_group
6792 (info_modules_var_func_options
*opts
)
6794 return {{info_modules_var_func_options_defs
}, opts
};
6797 /* Implements the 'info module functions' command. */
6800 info_module_functions_command (const char *args
, int from_tty
)
6802 info_modules_var_func_options opts
;
6803 auto grp
= make_info_modules_var_func_options_def_group (&opts
);
6804 gdb::option::process_options
6805 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
6806 if (args
!= nullptr && *args
== '\0')
6809 info_module_subcommand (opts
.quiet
, opts
.module_regexp
, args
,
6810 opts
.type_regexp
, FUNCTIONS_DOMAIN
);
6813 /* Implements the 'info module variables' command. */
6816 info_module_variables_command (const char *args
, int from_tty
)
6818 info_modules_var_func_options opts
;
6819 auto grp
= make_info_modules_var_func_options_def_group (&opts
);
6820 gdb::option::process_options
6821 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
6822 if (args
!= nullptr && *args
== '\0')
6825 info_module_subcommand (opts
.quiet
, opts
.module_regexp
, args
,
6826 opts
.type_regexp
, VARIABLES_DOMAIN
);
6829 /* Command completer for 'info module ...' sub-commands. */
6832 info_module_var_func_command_completer (struct cmd_list_element
*ignore
,
6833 completion_tracker
&tracker
,
6835 const char * /* word */)
6838 const auto group
= make_info_modules_var_func_options_def_group (nullptr);
6839 if (gdb::option::complete_options
6840 (tracker
, &text
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, group
))
6843 const char *word
= advance_to_expression_complete_word_point (tracker
, text
);
6844 symbol_completer (ignore
, tracker
, text
, word
);
6849 void _initialize_symtab ();
6851 _initialize_symtab ()
6853 cmd_list_element
*c
;
6855 initialize_ordinary_address_classes ();
6857 c
= add_info ("variables", info_variables_command
,
6858 info_print_args_help (_("\
6859 All global and static variable names or those matching REGEXPs.\n\
6860 Usage: info variables [-q] [-n] [-t TYPEREGEXP] [NAMEREGEXP]\n\
6861 Prints the global and static variables.\n"),
6862 _("global and static variables"),
6864 set_cmd_completer_handle_brkchars (c
, info_vars_funcs_command_completer
);
6867 c
= add_com ("whereis", class_info
, info_variables_command
,
6868 info_print_args_help (_("\
6869 All global and static variable names, or those matching REGEXPs.\n\
6870 Usage: whereis [-q] [-n] [-t TYPEREGEXP] [NAMEREGEXP]\n\
6871 Prints the global and static variables.\n"),
6872 _("global and static variables"),
6874 set_cmd_completer_handle_brkchars (c
, info_vars_funcs_command_completer
);
6877 c
= add_info ("functions", info_functions_command
,
6878 info_print_args_help (_("\
6879 All function names or those matching REGEXPs.\n\
6880 Usage: info functions [-q] [-n] [-t TYPEREGEXP] [NAMEREGEXP]\n\
6881 Prints the functions.\n"),
6884 set_cmd_completer_handle_brkchars (c
, info_vars_funcs_command_completer
);
6886 c
= add_info ("types", info_types_command
, _("\
6887 All type names, or those matching REGEXP.\n\
6888 Usage: info types [-q] [REGEXP]\n\
6889 Print information about all types matching REGEXP, or all types if no\n\
6890 REGEXP is given. The optional flag -q disables printing of headers."));
6891 set_cmd_completer_handle_brkchars (c
, info_types_command_completer
);
6893 const auto info_sources_opts
6894 = make_info_sources_options_def_group (nullptr);
6896 static std::string info_sources_help
6897 = gdb::option::build_help (_("\
6898 All source files in the program or those matching REGEXP.\n\
6899 Usage: info sources [OPTION]... [REGEXP]\n\
6900 By default, REGEXP is used to match anywhere in the filename.\n\
6906 c
= add_info ("sources", info_sources_command
, info_sources_help
.c_str ());
6907 set_cmd_completer_handle_brkchars (c
, info_sources_command_completer
);
6909 c
= add_info ("modules", info_modules_command
,
6910 _("All module names, or those matching REGEXP."));
6911 set_cmd_completer_handle_brkchars (c
, info_types_command_completer
);
6913 add_basic_prefix_cmd ("module", class_info
, _("\
6914 Print information about modules."),
6915 &info_module_cmdlist
, 0, &infolist
);
6917 c
= add_cmd ("functions", class_info
, info_module_functions_command
, _("\
6918 Display functions arranged by modules.\n\
6919 Usage: info module functions [-q] [-m MODREGEXP] [-t TYPEREGEXP] [REGEXP]\n\
6920 Print a summary of all functions within each Fortran module, grouped by\n\
6921 module and file. For each function the line on which the function is\n\
6922 defined is given along with the type signature and name of the function.\n\
6924 If REGEXP is provided then only functions whose name matches REGEXP are\n\
6925 listed. If MODREGEXP is provided then only functions in modules matching\n\
6926 MODREGEXP are listed. If TYPEREGEXP is given then only functions whose\n\
6927 type signature matches TYPEREGEXP are listed.\n\
6929 The -q flag suppresses printing some header information."),
6930 &info_module_cmdlist
);
6931 set_cmd_completer_handle_brkchars
6932 (c
, info_module_var_func_command_completer
);
6934 c
= add_cmd ("variables", class_info
, info_module_variables_command
, _("\
6935 Display variables arranged by modules.\n\
6936 Usage: info module variables [-q] [-m MODREGEXP] [-t TYPEREGEXP] [REGEXP]\n\
6937 Print a summary of all variables within each Fortran module, grouped by\n\
6938 module and file. For each variable the line on which the variable is\n\
6939 defined is given along with the type and name of the variable.\n\
6941 If REGEXP is provided then only variables whose name matches REGEXP are\n\
6942 listed. If MODREGEXP is provided then only variables in modules matching\n\
6943 MODREGEXP are listed. If TYPEREGEXP is given then only variables whose\n\
6944 type matches TYPEREGEXP are listed.\n\
6946 The -q flag suppresses printing some header information."),
6947 &info_module_cmdlist
);
6948 set_cmd_completer_handle_brkchars
6949 (c
, info_module_var_func_command_completer
);
6951 add_com ("rbreak", class_breakpoint
, rbreak_command
,
6952 _("Set a breakpoint for all functions matching REGEXP."));
6954 add_setshow_enum_cmd ("multiple-symbols", no_class
,
6955 multiple_symbols_modes
, &multiple_symbols_mode
,
6957 Set how the debugger handles ambiguities in expressions."), _("\
6958 Show how the debugger handles ambiguities in expressions."), _("\
6959 Valid values are \"ask\", \"all\", \"cancel\", and the default is \"all\"."),
6960 NULL
, NULL
, &setlist
, &showlist
);
6962 add_setshow_boolean_cmd ("basenames-may-differ", class_obscure
,
6963 &basenames_may_differ
, _("\
6964 Set whether a source file may have multiple base names."), _("\
6965 Show whether a source file may have multiple base names."), _("\
6966 (A \"base name\" is the name of a file with the directory part removed.\n\
6967 Example: The base name of \"/home/user/hello.c\" is \"hello.c\".)\n\
6968 If set, GDB will canonicalize file names (e.g., expand symlinks)\n\
6969 before comparing them. Canonicalization is an expensive operation,\n\
6970 but it allows the same file be known by more than one base name.\n\
6971 If not set (the default), all source files are assumed to have just\n\
6972 one base name, and gdb will do file name comparisons more efficiently."),
6974 &setlist
, &showlist
);
6976 add_setshow_zuinteger_cmd ("symtab-create", no_class
, &symtab_create_debug
,
6977 _("Set debugging of symbol table creation."),
6978 _("Show debugging of symbol table creation."), _("\
6979 When enabled (non-zero), debugging messages are printed when building\n\
6980 symbol tables. A value of 1 (one) normally provides enough information.\n\
6981 A value greater than 1 provides more verbose information."),
6984 &setdebuglist
, &showdebuglist
);
6986 add_setshow_zuinteger_cmd ("symbol-lookup", no_class
, &symbol_lookup_debug
,
6988 Set debugging of symbol lookup."), _("\
6989 Show debugging of symbol lookup."), _("\
6990 When enabled (non-zero), symbol lookups are logged."),
6992 &setdebuglist
, &showdebuglist
);
6994 add_setshow_zuinteger_cmd ("symbol-cache-size", no_class
,
6995 &new_symbol_cache_size
,
6996 _("Set the size of the symbol cache."),
6997 _("Show the size of the symbol cache."), _("\
6998 The size of the symbol cache.\n\
6999 If zero then the symbol cache is disabled."),
7000 set_symbol_cache_size_handler
, NULL
,
7001 &maintenance_set_cmdlist
,
7002 &maintenance_show_cmdlist
);
7004 add_cmd ("symbol-cache", class_maintenance
, maintenance_print_symbol_cache
,
7005 _("Dump the symbol cache for each program space."),
7006 &maintenanceprintlist
);
7008 add_cmd ("symbol-cache-statistics", class_maintenance
,
7009 maintenance_print_symbol_cache_statistics
,
7010 _("Print symbol cache statistics for each program space."),
7011 &maintenanceprintlist
);
7013 cmd_list_element
*maintenance_flush_symbol_cache_cmd
7014 = add_cmd ("symbol-cache", class_maintenance
,
7015 maintenance_flush_symbol_cache
,
7016 _("Flush the symbol cache for each program space."),
7017 &maintenanceflushlist
);
7018 c
= add_alias_cmd ("flush-symbol-cache", maintenance_flush_symbol_cache_cmd
,
7019 class_maintenance
, 0, &maintenancelist
);
7020 deprecate_cmd (c
, "maintenancelist flush symbol-cache");
7022 gdb::observers::executable_changed
.attach (symtab_observer_executable_changed
,
7024 gdb::observers::new_objfile
.attach (symtab_new_objfile_observer
, "symtab");
7025 gdb::observers::free_objfile
.attach (symtab_free_objfile_observer
, "symtab");