1 /* Symbol table lookup for the GNU debugger, GDB.
3 Copyright (C) 1986-2020 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
30 #include "gdb_regex.h"
31 #include "expression.h"
36 #include "filenames.h" /* for FILENAME_CMP */
37 #include "objc-lang.h"
43 #include "cli/cli-utils.h"
44 #include "cli/cli-style.h"
47 #include "typeprint.h"
49 #include "gdb_obstack.h"
51 #include "dictionary.h"
53 #include <sys/types.h>
58 #include "cp-support.h"
59 #include "observable.h"
62 #include "macroscope.h"
64 #include "parser-defs.h"
65 #include "completer.h"
66 #include "progspace-and-thread.h"
67 #include "gdbsupport/gdb_optional.h"
68 #include "filename-seen-cache.h"
69 #include "arch-utils.h"
71 #include "gdbsupport/gdb_string_view.h"
72 #include "gdbsupport/pathstuff.h"
73 #include "gdbsupport/common-utils.h"
75 /* Forward declarations for local functions. */
77 static void rbreak_command (const char *, int);
79 static int find_line_common (struct linetable
*, int, int *, int);
81 static struct block_symbol
82 lookup_symbol_aux (const char *name
,
83 symbol_name_match_type match_type
,
84 const struct block
*block
,
85 const domain_enum domain
,
86 enum language language
,
87 struct field_of_this_result
*);
90 struct block_symbol
lookup_local_symbol (const char *name
,
91 symbol_name_match_type match_type
,
92 const struct block
*block
,
93 const domain_enum domain
,
94 enum language language
);
96 static struct block_symbol
97 lookup_symbol_in_objfile (struct objfile
*objfile
,
98 enum block_enum block_index
,
99 const char *name
, const domain_enum domain
);
101 /* Type of the data stored on the program space. */
105 main_info () = default;
109 xfree (name_of_main
);
112 /* Name of "main". */
114 char *name_of_main
= nullptr;
116 /* Language of "main". */
118 enum language language_of_main
= language_unknown
;
121 /* Program space key for finding name and language of "main". */
123 static const program_space_key
<main_info
> main_progspace_key
;
125 /* The default symbol cache size.
126 There is no extra cpu cost for large N (except when flushing the cache,
127 which is rare). The value here is just a first attempt. A better default
128 value may be higher or lower. A prime number can make up for a bad hash
129 computation, so that's why the number is what it is. */
130 #define DEFAULT_SYMBOL_CACHE_SIZE 1021
132 /* The maximum symbol cache size.
133 There's no method to the decision of what value to use here, other than
134 there's no point in allowing a user typo to make gdb consume all memory. */
135 #define MAX_SYMBOL_CACHE_SIZE (1024*1024)
137 /* symbol_cache_lookup returns this if a previous lookup failed to find the
138 symbol in any objfile. */
139 #define SYMBOL_LOOKUP_FAILED \
140 ((struct block_symbol) {(struct symbol *) 1, NULL})
141 #define SYMBOL_LOOKUP_FAILED_P(SIB) (SIB.symbol == (struct symbol *) 1)
143 /* Recording lookups that don't find the symbol is just as important, if not
144 more so, than recording found symbols. */
146 enum symbol_cache_slot_state
149 SYMBOL_SLOT_NOT_FOUND
,
153 struct symbol_cache_slot
155 enum symbol_cache_slot_state state
;
157 /* The objfile that was current when the symbol was looked up.
158 This is only needed for global blocks, but for simplicity's sake
159 we allocate the space for both. If data shows the extra space used
160 for static blocks is a problem, we can split things up then.
162 Global blocks need cache lookup to include the objfile context because
163 we need to account for gdbarch_iterate_over_objfiles_in_search_order
164 which can traverse objfiles in, effectively, any order, depending on
165 the current objfile, thus affecting which symbol is found. Normally,
166 only the current objfile is searched first, and then the rest are
167 searched in recorded order; but putting cache lookup inside
168 gdbarch_iterate_over_objfiles_in_search_order would be awkward.
169 Instead we just make the current objfile part of the context of
170 cache lookup. This means we can record the same symbol multiple times,
171 each with a different "current objfile" that was in effect when the
172 lookup was saved in the cache, but cache space is pretty cheap. */
173 const struct objfile
*objfile_context
;
177 struct block_symbol found
;
186 /* Clear out SLOT. */
189 symbol_cache_clear_slot (struct symbol_cache_slot
*slot
)
191 if (slot
->state
== SYMBOL_SLOT_NOT_FOUND
)
192 xfree (slot
->value
.not_found
.name
);
193 slot
->state
= SYMBOL_SLOT_UNUSED
;
196 /* Symbols don't specify global vs static block.
197 So keep them in separate caches. */
199 struct block_symbol_cache
203 unsigned int collisions
;
205 /* SYMBOLS is a variable length array of this size.
206 One can imagine that in general one cache (global/static) should be a
207 fraction of the size of the other, but there's no data at the moment
208 on which to decide. */
211 struct symbol_cache_slot symbols
[1];
214 /* Clear all slots of BSC and free BSC. */
217 destroy_block_symbol_cache (struct block_symbol_cache
*bsc
)
221 for (unsigned int i
= 0; i
< bsc
->size
; i
++)
222 symbol_cache_clear_slot (&bsc
->symbols
[i
]);
229 Searching for symbols in the static and global blocks over multiple objfiles
230 again and again can be slow, as can searching very big objfiles. This is a
231 simple cache to improve symbol lookup performance, which is critical to
232 overall gdb performance.
234 Symbols are hashed on the name, its domain, and block.
235 They are also hashed on their objfile for objfile-specific lookups. */
239 symbol_cache () = default;
243 destroy_block_symbol_cache (global_symbols
);
244 destroy_block_symbol_cache (static_symbols
);
247 struct block_symbol_cache
*global_symbols
= nullptr;
248 struct block_symbol_cache
*static_symbols
= nullptr;
251 /* Program space key for finding its symbol cache. */
253 static const program_space_key
<symbol_cache
> symbol_cache_key
;
255 /* When non-zero, print debugging messages related to symtab creation. */
256 unsigned int symtab_create_debug
= 0;
258 /* When non-zero, print debugging messages related to symbol lookup. */
259 unsigned int symbol_lookup_debug
= 0;
261 /* The size of the cache is staged here. */
262 static unsigned int new_symbol_cache_size
= DEFAULT_SYMBOL_CACHE_SIZE
;
264 /* The current value of the symbol cache size.
265 This is saved so that if the user enters a value too big we can restore
266 the original value from here. */
267 static unsigned int symbol_cache_size
= DEFAULT_SYMBOL_CACHE_SIZE
;
269 /* True if a file may be known by two different basenames.
270 This is the uncommon case, and significantly slows down gdb.
271 Default set to "off" to not slow down the common case. */
272 bool basenames_may_differ
= false;
274 /* Allow the user to configure the debugger behavior with respect
275 to multiple-choice menus when more than one symbol matches during
278 const char multiple_symbols_ask
[] = "ask";
279 const char multiple_symbols_all
[] = "all";
280 const char multiple_symbols_cancel
[] = "cancel";
281 static const char *const multiple_symbols_modes
[] =
283 multiple_symbols_ask
,
284 multiple_symbols_all
,
285 multiple_symbols_cancel
,
288 static const char *multiple_symbols_mode
= multiple_symbols_all
;
290 /* Read-only accessor to AUTO_SELECT_MODE. */
293 multiple_symbols_select_mode (void)
295 return multiple_symbols_mode
;
298 /* Return the name of a domain_enum. */
301 domain_name (domain_enum e
)
305 case UNDEF_DOMAIN
: return "UNDEF_DOMAIN";
306 case VAR_DOMAIN
: return "VAR_DOMAIN";
307 case STRUCT_DOMAIN
: return "STRUCT_DOMAIN";
308 case MODULE_DOMAIN
: return "MODULE_DOMAIN";
309 case LABEL_DOMAIN
: return "LABEL_DOMAIN";
310 case COMMON_BLOCK_DOMAIN
: return "COMMON_BLOCK_DOMAIN";
311 default: gdb_assert_not_reached ("bad domain_enum");
315 /* Return the name of a search_domain . */
318 search_domain_name (enum search_domain e
)
322 case VARIABLES_DOMAIN
: return "VARIABLES_DOMAIN";
323 case FUNCTIONS_DOMAIN
: return "FUNCTIONS_DOMAIN";
324 case TYPES_DOMAIN
: return "TYPES_DOMAIN";
325 case MODULES_DOMAIN
: return "MODULES_DOMAIN";
326 case ALL_DOMAIN
: return "ALL_DOMAIN";
327 default: gdb_assert_not_reached ("bad search_domain");
334 compunit_primary_filetab (const struct compunit_symtab
*cust
)
336 gdb_assert (COMPUNIT_FILETABS (cust
) != NULL
);
338 /* The primary file symtab is the first one in the list. */
339 return COMPUNIT_FILETABS (cust
);
345 compunit_language (const struct compunit_symtab
*cust
)
347 struct symtab
*symtab
= compunit_primary_filetab (cust
);
349 /* The language of the compunit symtab is the language of its primary
351 return SYMTAB_LANGUAGE (symtab
);
357 minimal_symbol::data_p () const
359 return type
== mst_data
362 || type
== mst_file_data
363 || type
== mst_file_bss
;
369 minimal_symbol::text_p () const
371 return type
== mst_text
372 || type
== mst_text_gnu_ifunc
373 || type
== mst_data_gnu_ifunc
374 || type
== mst_slot_got_plt
375 || type
== mst_solib_trampoline
376 || type
== mst_file_text
;
379 /* See whether FILENAME matches SEARCH_NAME using the rule that we
380 advertise to the user. (The manual's description of linespecs
381 describes what we advertise). Returns true if they match, false
385 compare_filenames_for_search (const char *filename
, const char *search_name
)
387 int len
= strlen (filename
);
388 size_t search_len
= strlen (search_name
);
390 if (len
< search_len
)
393 /* The tail of FILENAME must match. */
394 if (FILENAME_CMP (filename
+ len
- search_len
, search_name
) != 0)
397 /* Either the names must completely match, or the character
398 preceding the trailing SEARCH_NAME segment of FILENAME must be a
401 The check !IS_ABSOLUTE_PATH ensures SEARCH_NAME "/dir/file.c"
402 cannot match FILENAME "/path//dir/file.c" - as user has requested
403 absolute path. The sama applies for "c:\file.c" possibly
404 incorrectly hypothetically matching "d:\dir\c:\file.c".
406 The HAS_DRIVE_SPEC purpose is to make FILENAME "c:file.c"
407 compatible with SEARCH_NAME "file.c". In such case a compiler had
408 to put the "c:file.c" name into debug info. Such compatibility
409 works only on GDB built for DOS host. */
410 return (len
== search_len
411 || (!IS_ABSOLUTE_PATH (search_name
)
412 && IS_DIR_SEPARATOR (filename
[len
- search_len
- 1]))
413 || (HAS_DRIVE_SPEC (filename
)
414 && STRIP_DRIVE_SPEC (filename
) == &filename
[len
- search_len
]));
417 /* Same as compare_filenames_for_search, but for glob-style patterns.
418 Heads up on the order of the arguments. They match the order of
419 compare_filenames_for_search, but it's the opposite of the order of
420 arguments to gdb_filename_fnmatch. */
423 compare_glob_filenames_for_search (const char *filename
,
424 const char *search_name
)
426 /* We rely on the property of glob-style patterns with FNM_FILE_NAME that
427 all /s have to be explicitly specified. */
428 int file_path_elements
= count_path_elements (filename
);
429 int search_path_elements
= count_path_elements (search_name
);
431 if (search_path_elements
> file_path_elements
)
434 if (IS_ABSOLUTE_PATH (search_name
))
436 return (search_path_elements
== file_path_elements
437 && gdb_filename_fnmatch (search_name
, filename
,
438 FNM_FILE_NAME
| FNM_NOESCAPE
) == 0);
442 const char *file_to_compare
443 = strip_leading_path_elements (filename
,
444 file_path_elements
- search_path_elements
);
446 return gdb_filename_fnmatch (search_name
, file_to_compare
,
447 FNM_FILE_NAME
| FNM_NOESCAPE
) == 0;
451 /* Check for a symtab of a specific name by searching some symtabs.
452 This is a helper function for callbacks of iterate_over_symtabs.
454 If NAME is not absolute, then REAL_PATH is NULL
455 If NAME is absolute, then REAL_PATH is the gdb_realpath form of NAME.
457 The return value, NAME, REAL_PATH and CALLBACK are identical to the
458 `map_symtabs_matching_filename' method of quick_symbol_functions.
460 FIRST and AFTER_LAST indicate the range of compunit symtabs to search.
461 Each symtab within the specified compunit symtab is also searched.
462 AFTER_LAST is one past the last compunit symtab to search; NULL means to
463 search until the end of the list. */
466 iterate_over_some_symtabs (const char *name
,
467 const char *real_path
,
468 struct compunit_symtab
*first
,
469 struct compunit_symtab
*after_last
,
470 gdb::function_view
<bool (symtab
*)> callback
)
472 struct compunit_symtab
*cust
;
473 const char* base_name
= lbasename (name
);
475 for (cust
= first
; cust
!= NULL
&& cust
!= after_last
; cust
= cust
->next
)
477 for (symtab
*s
: compunit_filetabs (cust
))
479 if (compare_filenames_for_search (s
->filename
, name
))
486 /* Before we invoke realpath, which can get expensive when many
487 files are involved, do a quick comparison of the basenames. */
488 if (! basenames_may_differ
489 && FILENAME_CMP (base_name
, lbasename (s
->filename
)) != 0)
492 if (compare_filenames_for_search (symtab_to_fullname (s
), name
))
499 /* If the user gave us an absolute path, try to find the file in
500 this symtab and use its absolute path. */
501 if (real_path
!= NULL
)
503 const char *fullname
= symtab_to_fullname (s
);
505 gdb_assert (IS_ABSOLUTE_PATH (real_path
));
506 gdb_assert (IS_ABSOLUTE_PATH (name
));
507 gdb::unique_xmalloc_ptr
<char> fullname_real_path
508 = gdb_realpath (fullname
);
509 fullname
= fullname_real_path
.get ();
510 if (FILENAME_CMP (real_path
, fullname
) == 0)
523 /* Check for a symtab of a specific name; first in symtabs, then in
524 psymtabs. *If* there is no '/' in the name, a match after a '/'
525 in the symtab filename will also work.
527 Calls CALLBACK with each symtab that is found. If CALLBACK returns
528 true, the search stops. */
531 iterate_over_symtabs (const char *name
,
532 gdb::function_view
<bool (symtab
*)> callback
)
534 gdb::unique_xmalloc_ptr
<char> real_path
;
536 /* Here we are interested in canonicalizing an absolute path, not
537 absolutizing a relative path. */
538 if (IS_ABSOLUTE_PATH (name
))
540 real_path
= gdb_realpath (name
);
541 gdb_assert (IS_ABSOLUTE_PATH (real_path
.get ()));
544 for (objfile
*objfile
: current_program_space
->objfiles ())
546 if (iterate_over_some_symtabs (name
, real_path
.get (),
547 objfile
->compunit_symtabs
, NULL
,
552 /* Same search rules as above apply here, but now we look thru the
555 for (objfile
*objfile
: current_program_space
->objfiles ())
558 && objfile
->sf
->qf
->map_symtabs_matching_filename (objfile
,
566 /* A wrapper for iterate_over_symtabs that returns the first matching
570 lookup_symtab (const char *name
)
572 struct symtab
*result
= NULL
;
574 iterate_over_symtabs (name
, [&] (symtab
*symtab
)
584 /* Mangle a GDB method stub type. This actually reassembles the pieces of the
585 full method name, which consist of the class name (from T), the unadorned
586 method name from METHOD_ID, and the signature for the specific overload,
587 specified by SIGNATURE_ID. Note that this function is g++ specific. */
590 gdb_mangle_name (struct type
*type
, int method_id
, int signature_id
)
592 int mangled_name_len
;
594 struct fn_field
*f
= TYPE_FN_FIELDLIST1 (type
, method_id
);
595 struct fn_field
*method
= &f
[signature_id
];
596 const char *field_name
= TYPE_FN_FIELDLIST_NAME (type
, method_id
);
597 const char *physname
= TYPE_FN_FIELD_PHYSNAME (f
, signature_id
);
598 const char *newname
= type
->name ();
600 /* Does the form of physname indicate that it is the full mangled name
601 of a constructor (not just the args)? */
602 int is_full_physname_constructor
;
605 int is_destructor
= is_destructor_name (physname
);
606 /* Need a new type prefix. */
607 const char *const_prefix
= method
->is_const
? "C" : "";
608 const char *volatile_prefix
= method
->is_volatile
? "V" : "";
610 int len
= (newname
== NULL
? 0 : strlen (newname
));
612 /* Nothing to do if physname already contains a fully mangled v3 abi name
613 or an operator name. */
614 if ((physname
[0] == '_' && physname
[1] == 'Z')
615 || is_operator_name (field_name
))
616 return xstrdup (physname
);
618 is_full_physname_constructor
= is_constructor_name (physname
);
620 is_constructor
= is_full_physname_constructor
621 || (newname
&& strcmp (field_name
, newname
) == 0);
624 is_destructor
= (startswith (physname
, "__dt"));
626 if (is_destructor
|| is_full_physname_constructor
)
628 mangled_name
= (char *) xmalloc (strlen (physname
) + 1);
629 strcpy (mangled_name
, physname
);
635 xsnprintf (buf
, sizeof (buf
), "__%s%s", const_prefix
, volatile_prefix
);
637 else if (physname
[0] == 't' || physname
[0] == 'Q')
639 /* The physname for template and qualified methods already includes
641 xsnprintf (buf
, sizeof (buf
), "__%s%s", const_prefix
, volatile_prefix
);
647 xsnprintf (buf
, sizeof (buf
), "__%s%s%d", const_prefix
,
648 volatile_prefix
, len
);
650 mangled_name_len
= ((is_constructor
? 0 : strlen (field_name
))
651 + strlen (buf
) + len
+ strlen (physname
) + 1);
653 mangled_name
= (char *) xmalloc (mangled_name_len
);
655 mangled_name
[0] = '\0';
657 strcpy (mangled_name
, field_name
);
659 strcat (mangled_name
, buf
);
660 /* If the class doesn't have a name, i.e. newname NULL, then we just
661 mangle it using 0 for the length of the class. Thus it gets mangled
662 as something starting with `::' rather than `classname::'. */
664 strcat (mangled_name
, newname
);
666 strcat (mangled_name
, physname
);
667 return (mangled_name
);
673 general_symbol_info::set_demangled_name (const char *name
,
674 struct obstack
*obstack
)
676 if (language () == language_ada
)
681 language_specific
.obstack
= obstack
;
686 language_specific
.demangled_name
= name
;
690 language_specific
.demangled_name
= name
;
694 /* Initialize the language dependent portion of a symbol
695 depending upon the language for the symbol. */
698 general_symbol_info::set_language (enum language language
,
699 struct obstack
*obstack
)
701 m_language
= language
;
702 if (language
== language_cplus
703 || language
== language_d
704 || language
== language_go
705 || language
== language_objc
706 || language
== language_fortran
)
708 set_demangled_name (NULL
, obstack
);
710 else if (language
== language_ada
)
712 gdb_assert (ada_mangled
== 0);
713 language_specific
.obstack
= obstack
;
717 memset (&language_specific
, 0, sizeof (language_specific
));
721 /* Functions to initialize a symbol's mangled name. */
723 /* Objects of this type are stored in the demangled name hash table. */
724 struct demangled_name_entry
726 demangled_name_entry (gdb::string_view mangled_name
)
727 : mangled (mangled_name
) {}
729 gdb::string_view mangled
;
730 enum language language
;
731 gdb::unique_xmalloc_ptr
<char> demangled
;
734 /* Hash function for the demangled name hash. */
737 hash_demangled_name_entry (const void *data
)
739 const struct demangled_name_entry
*e
740 = (const struct demangled_name_entry
*) data
;
742 return fast_hash (e
->mangled
.data (), e
->mangled
.length ());
745 /* Equality function for the demangled name hash. */
748 eq_demangled_name_entry (const void *a
, const void *b
)
750 const struct demangled_name_entry
*da
751 = (const struct demangled_name_entry
*) a
;
752 const struct demangled_name_entry
*db
753 = (const struct demangled_name_entry
*) b
;
755 return da
->mangled
== db
->mangled
;
759 free_demangled_name_entry (void *data
)
761 struct demangled_name_entry
*e
762 = (struct demangled_name_entry
*) data
;
764 e
->~demangled_name_entry();
767 /* Create the hash table used for demangled names. Each hash entry is
768 a pair of strings; one for the mangled name and one for the demangled
769 name. The entry is hashed via just the mangled name. */
772 create_demangled_names_hash (struct objfile_per_bfd_storage
*per_bfd
)
774 /* Choose 256 as the starting size of the hash table, somewhat arbitrarily.
775 The hash table code will round this up to the next prime number.
776 Choosing a much larger table size wastes memory, and saves only about
777 1% in symbol reading. However, if the minsym count is already
778 initialized (e.g. because symbol name setting was deferred to
779 a background thread) we can initialize the hashtable with a count
780 based on that, because we will almost certainly have at least that
781 many entries. If we have a nonzero number but less than 256,
782 we still stay with 256 to have some space for psymbols, etc. */
784 /* htab will expand the table when it is 3/4th full, so we account for that
785 here. +2 to round up. */
786 int minsym_based_count
= (per_bfd
->minimal_symbol_count
+ 2) / 3 * 4;
787 int count
= std::max (per_bfd
->minimal_symbol_count
, minsym_based_count
);
789 per_bfd
->demangled_names_hash
.reset (htab_create_alloc
790 (count
, hash_demangled_name_entry
, eq_demangled_name_entry
,
791 free_demangled_name_entry
, xcalloc
, xfree
));
797 symbol_find_demangled_name (struct general_symbol_info
*gsymbol
,
800 char *demangled
= NULL
;
803 if (gsymbol
->language () == language_unknown
)
804 gsymbol
->m_language
= language_auto
;
806 if (gsymbol
->language () != language_auto
)
808 const struct language_defn
*lang
= language_def (gsymbol
->language ());
810 language_sniff_from_mangled_name (lang
, mangled
, &demangled
);
814 for (i
= language_unknown
; i
< nr_languages
; ++i
)
816 enum language l
= (enum language
) i
;
817 const struct language_defn
*lang
= language_def (l
);
819 if (language_sniff_from_mangled_name (lang
, mangled
, &demangled
))
821 gsymbol
->m_language
= l
;
829 /* Set both the mangled and demangled (if any) names for GSYMBOL based
830 on LINKAGE_NAME and LEN. Ordinarily, NAME is copied onto the
831 objfile's obstack; but if COPY_NAME is 0 and if NAME is
832 NUL-terminated, then this function assumes that NAME is already
833 correctly saved (either permanently or with a lifetime tied to the
834 objfile), and it will not be copied.
836 The hash table corresponding to OBJFILE is used, and the memory
837 comes from the per-BFD storage_obstack. LINKAGE_NAME is copied,
838 so the pointer can be discarded after calling this function. */
841 general_symbol_info::compute_and_set_names (gdb::string_view linkage_name
,
843 objfile_per_bfd_storage
*per_bfd
,
844 gdb::optional
<hashval_t
> hash
)
846 struct demangled_name_entry
**slot
;
848 if (language () == language_ada
)
850 /* In Ada, we do the symbol lookups using the mangled name, so
851 we can save some space by not storing the demangled name. */
853 m_name
= linkage_name
.data ();
855 m_name
= obstack_strndup (&per_bfd
->storage_obstack
,
856 linkage_name
.data (),
857 linkage_name
.length ());
858 set_demangled_name (NULL
, &per_bfd
->storage_obstack
);
863 if (per_bfd
->demangled_names_hash
== NULL
)
864 create_demangled_names_hash (per_bfd
);
866 struct demangled_name_entry
entry (linkage_name
);
867 if (!hash
.has_value ())
868 hash
= hash_demangled_name_entry (&entry
);
869 slot
= ((struct demangled_name_entry
**)
870 htab_find_slot_with_hash (per_bfd
->demangled_names_hash
.get (),
871 &entry
, *hash
, INSERT
));
873 /* The const_cast is safe because the only reason it is already
874 initialized is if we purposefully set it from a background
875 thread to avoid doing the work here. However, it is still
876 allocated from the heap and needs to be freed by us, just
877 like if we called symbol_find_demangled_name here. If this is
878 nullptr, we call symbol_find_demangled_name below, but we put
879 this smart pointer here to be sure that we don't leak this name. */
880 gdb::unique_xmalloc_ptr
<char> demangled_name
881 (const_cast<char *> (language_specific
.demangled_name
));
883 /* If this name is not in the hash table, add it. */
885 /* A C version of the symbol may have already snuck into the table.
886 This happens to, e.g., main.init (__go_init_main). Cope. */
887 || (language () == language_go
&& (*slot
)->demangled
== nullptr))
889 /* A 0-terminated copy of the linkage name. Callers must set COPY_NAME
890 to true if the string might not be nullterminated. We have to make
891 this copy because demangling needs a nullterminated string. */
892 gdb::string_view linkage_name_copy
;
895 char *alloc_name
= (char *) alloca (linkage_name
.length () + 1);
896 memcpy (alloc_name
, linkage_name
.data (), linkage_name
.length ());
897 alloc_name
[linkage_name
.length ()] = '\0';
899 linkage_name_copy
= gdb::string_view (alloc_name
,
900 linkage_name
.length ());
903 linkage_name_copy
= linkage_name
;
905 if (demangled_name
.get () == nullptr)
907 (symbol_find_demangled_name (this, linkage_name_copy
.data ()));
909 /* Suppose we have demangled_name==NULL, copy_name==0, and
910 linkage_name_copy==linkage_name. In this case, we already have the
911 mangled name saved, and we don't have a demangled name. So,
912 you might think we could save a little space by not recording
913 this in the hash table at all.
915 It turns out that it is actually important to still save such
916 an entry in the hash table, because storing this name gives
917 us better bcache hit rates for partial symbols. */
921 = ((struct demangled_name_entry
*)
922 obstack_alloc (&per_bfd
->storage_obstack
,
923 sizeof (demangled_name_entry
)));
924 new (*slot
) demangled_name_entry (linkage_name
);
928 /* If we must copy the mangled name, put it directly after
929 the struct so we can have a single allocation. */
931 = ((struct demangled_name_entry
*)
932 obstack_alloc (&per_bfd
->storage_obstack
,
933 sizeof (demangled_name_entry
)
934 + linkage_name
.length () + 1));
935 char *mangled_ptr
= reinterpret_cast<char *> (*slot
+ 1);
936 memcpy (mangled_ptr
, linkage_name
.data (), linkage_name
.length ());
937 mangled_ptr
[linkage_name
.length ()] = '\0';
938 new (*slot
) demangled_name_entry
939 (gdb::string_view (mangled_ptr
, linkage_name
.length ()));
941 (*slot
)->demangled
= std::move (demangled_name
);
942 (*slot
)->language
= language ();
944 else if (language () == language_unknown
|| language () == language_auto
)
945 m_language
= (*slot
)->language
;
947 m_name
= (*slot
)->mangled
.data ();
948 set_demangled_name ((*slot
)->demangled
.get (), &per_bfd
->storage_obstack
);
954 general_symbol_info::natural_name () const
962 case language_fortran
:
964 if (language_specific
.demangled_name
!= nullptr)
965 return language_specific
.demangled_name
;
968 return ada_decode_symbol (this);
972 return linkage_name ();
978 general_symbol_info::demangled_name () const
980 const char *dem_name
= NULL
;
988 case language_fortran
:
990 dem_name
= language_specific
.demangled_name
;
993 dem_name
= ada_decode_symbol (this);
1004 general_symbol_info::search_name () const
1006 if (language () == language_ada
)
1007 return linkage_name ();
1009 return natural_name ();
1015 symbol_matches_search_name (const struct general_symbol_info
*gsymbol
,
1016 const lookup_name_info
&name
)
1018 symbol_name_matcher_ftype
*name_match
1019 = get_symbol_name_matcher (language_def (gsymbol
->language ()), name
);
1020 return name_match (gsymbol
->search_name (), name
, NULL
);
1025 /* Return true if the two sections are the same, or if they could
1026 plausibly be copies of each other, one in an original object
1027 file and another in a separated debug file. */
1030 matching_obj_sections (struct obj_section
*obj_first
,
1031 struct obj_section
*obj_second
)
1033 asection
*first
= obj_first
? obj_first
->the_bfd_section
: NULL
;
1034 asection
*second
= obj_second
? obj_second
->the_bfd_section
: NULL
;
1036 /* If they're the same section, then they match. */
1037 if (first
== second
)
1040 /* If either is NULL, give up. */
1041 if (first
== NULL
|| second
== NULL
)
1044 /* This doesn't apply to absolute symbols. */
1045 if (first
->owner
== NULL
|| second
->owner
== NULL
)
1048 /* If they're in the same object file, they must be different sections. */
1049 if (first
->owner
== second
->owner
)
1052 /* Check whether the two sections are potentially corresponding. They must
1053 have the same size, address, and name. We can't compare section indexes,
1054 which would be more reliable, because some sections may have been
1056 if (bfd_section_size (first
) != bfd_section_size (second
))
1059 /* In-memory addresses may start at a different offset, relativize them. */
1060 if (bfd_section_vma (first
) - bfd_get_start_address (first
->owner
)
1061 != bfd_section_vma (second
) - bfd_get_start_address (second
->owner
))
1064 if (bfd_section_name (first
) == NULL
1065 || bfd_section_name (second
) == NULL
1066 || strcmp (bfd_section_name (first
), bfd_section_name (second
)) != 0)
1069 /* Otherwise check that they are in corresponding objfiles. */
1071 struct objfile
*obj
= NULL
;
1072 for (objfile
*objfile
: current_program_space
->objfiles ())
1073 if (objfile
->obfd
== first
->owner
)
1078 gdb_assert (obj
!= NULL
);
1080 if (obj
->separate_debug_objfile
!= NULL
1081 && obj
->separate_debug_objfile
->obfd
== second
->owner
)
1083 if (obj
->separate_debug_objfile_backlink
!= NULL
1084 && obj
->separate_debug_objfile_backlink
->obfd
== second
->owner
)
1093 expand_symtab_containing_pc (CORE_ADDR pc
, struct obj_section
*section
)
1095 struct bound_minimal_symbol msymbol
;
1097 /* If we know that this is not a text address, return failure. This is
1098 necessary because we loop based on texthigh and textlow, which do
1099 not include the data ranges. */
1100 msymbol
= lookup_minimal_symbol_by_pc_section (pc
, section
);
1101 if (msymbol
.minsym
&& msymbol
.minsym
->data_p ())
1104 for (objfile
*objfile
: current_program_space
->objfiles ())
1106 struct compunit_symtab
*cust
= NULL
;
1109 cust
= objfile
->sf
->qf
->find_pc_sect_compunit_symtab (objfile
, msymbol
,
1116 /* Hash function for the symbol cache. */
1119 hash_symbol_entry (const struct objfile
*objfile_context
,
1120 const char *name
, domain_enum domain
)
1122 unsigned int hash
= (uintptr_t) objfile_context
;
1125 hash
+= htab_hash_string (name
);
1127 /* Because of symbol_matches_domain we need VAR_DOMAIN and STRUCT_DOMAIN
1128 to map to the same slot. */
1129 if (domain
== STRUCT_DOMAIN
)
1130 hash
+= VAR_DOMAIN
* 7;
1137 /* Equality function for the symbol cache. */
1140 eq_symbol_entry (const struct symbol_cache_slot
*slot
,
1141 const struct objfile
*objfile_context
,
1142 const char *name
, domain_enum domain
)
1144 const char *slot_name
;
1145 domain_enum slot_domain
;
1147 if (slot
->state
== SYMBOL_SLOT_UNUSED
)
1150 if (slot
->objfile_context
!= objfile_context
)
1153 if (slot
->state
== SYMBOL_SLOT_NOT_FOUND
)
1155 slot_name
= slot
->value
.not_found
.name
;
1156 slot_domain
= slot
->value
.not_found
.domain
;
1160 slot_name
= slot
->value
.found
.symbol
->search_name ();
1161 slot_domain
= SYMBOL_DOMAIN (slot
->value
.found
.symbol
);
1164 /* NULL names match. */
1165 if (slot_name
== NULL
&& name
== NULL
)
1167 /* But there's no point in calling symbol_matches_domain in the
1168 SYMBOL_SLOT_FOUND case. */
1169 if (slot_domain
!= domain
)
1172 else if (slot_name
!= NULL
&& name
!= NULL
)
1174 /* It's important that we use the same comparison that was done
1175 the first time through. If the slot records a found symbol,
1176 then this means using the symbol name comparison function of
1177 the symbol's language with symbol->search_name (). See
1178 dictionary.c. It also means using symbol_matches_domain for
1179 found symbols. See block.c.
1181 If the slot records a not-found symbol, then require a precise match.
1182 We could still be lax with whitespace like strcmp_iw though. */
1184 if (slot
->state
== SYMBOL_SLOT_NOT_FOUND
)
1186 if (strcmp (slot_name
, name
) != 0)
1188 if (slot_domain
!= domain
)
1193 struct symbol
*sym
= slot
->value
.found
.symbol
;
1194 lookup_name_info
lookup_name (name
, symbol_name_match_type::FULL
);
1196 if (!SYMBOL_MATCHES_SEARCH_NAME (sym
, lookup_name
))
1199 if (!symbol_matches_domain (sym
->language (), slot_domain
, domain
))
1205 /* Only one name is NULL. */
1212 /* Given a cache of size SIZE, return the size of the struct (with variable
1213 length array) in bytes. */
1216 symbol_cache_byte_size (unsigned int size
)
1218 return (sizeof (struct block_symbol_cache
)
1219 + ((size
- 1) * sizeof (struct symbol_cache_slot
)));
1225 resize_symbol_cache (struct symbol_cache
*cache
, unsigned int new_size
)
1227 /* If there's no change in size, don't do anything.
1228 All caches have the same size, so we can just compare with the size
1229 of the global symbols cache. */
1230 if ((cache
->global_symbols
!= NULL
1231 && cache
->global_symbols
->size
== new_size
)
1232 || (cache
->global_symbols
== NULL
1236 destroy_block_symbol_cache (cache
->global_symbols
);
1237 destroy_block_symbol_cache (cache
->static_symbols
);
1241 cache
->global_symbols
= NULL
;
1242 cache
->static_symbols
= NULL
;
1246 size_t total_size
= symbol_cache_byte_size (new_size
);
1248 cache
->global_symbols
1249 = (struct block_symbol_cache
*) xcalloc (1, total_size
);
1250 cache
->static_symbols
1251 = (struct block_symbol_cache
*) xcalloc (1, total_size
);
1252 cache
->global_symbols
->size
= new_size
;
1253 cache
->static_symbols
->size
= new_size
;
1257 /* Return the symbol cache of PSPACE.
1258 Create one if it doesn't exist yet. */
1260 static struct symbol_cache
*
1261 get_symbol_cache (struct program_space
*pspace
)
1263 struct symbol_cache
*cache
= symbol_cache_key
.get (pspace
);
1267 cache
= symbol_cache_key
.emplace (pspace
);
1268 resize_symbol_cache (cache
, symbol_cache_size
);
1274 /* Set the size of the symbol cache in all program spaces. */
1277 set_symbol_cache_size (unsigned int new_size
)
1279 for (struct program_space
*pspace
: program_spaces
)
1281 struct symbol_cache
*cache
= symbol_cache_key
.get (pspace
);
1283 /* The pspace could have been created but not have a cache yet. */
1285 resize_symbol_cache (cache
, new_size
);
1289 /* Called when symbol-cache-size is set. */
1292 set_symbol_cache_size_handler (const char *args
, int from_tty
,
1293 struct cmd_list_element
*c
)
1295 if (new_symbol_cache_size
> MAX_SYMBOL_CACHE_SIZE
)
1297 /* Restore the previous value.
1298 This is the value the "show" command prints. */
1299 new_symbol_cache_size
= symbol_cache_size
;
1301 error (_("Symbol cache size is too large, max is %u."),
1302 MAX_SYMBOL_CACHE_SIZE
);
1304 symbol_cache_size
= new_symbol_cache_size
;
1306 set_symbol_cache_size (symbol_cache_size
);
1309 /* Lookup symbol NAME,DOMAIN in BLOCK in the symbol cache of PSPACE.
1310 OBJFILE_CONTEXT is the current objfile, which may be NULL.
1311 The result is the symbol if found, SYMBOL_LOOKUP_FAILED if a previous lookup
1312 failed (and thus this one will too), or NULL if the symbol is not present
1314 *BSC_PTR and *SLOT_PTR are set to the cache and slot of the symbol, which
1315 can be used to save the result of a full lookup attempt. */
1317 static struct block_symbol
1318 symbol_cache_lookup (struct symbol_cache
*cache
,
1319 struct objfile
*objfile_context
, enum block_enum block
,
1320 const char *name
, domain_enum domain
,
1321 struct block_symbol_cache
**bsc_ptr
,
1322 struct symbol_cache_slot
**slot_ptr
)
1324 struct block_symbol_cache
*bsc
;
1326 struct symbol_cache_slot
*slot
;
1328 if (block
== GLOBAL_BLOCK
)
1329 bsc
= cache
->global_symbols
;
1331 bsc
= cache
->static_symbols
;
1339 hash
= hash_symbol_entry (objfile_context
, name
, domain
);
1340 slot
= bsc
->symbols
+ hash
% bsc
->size
;
1345 if (eq_symbol_entry (slot
, objfile_context
, name
, domain
))
1347 if (symbol_lookup_debug
)
1348 fprintf_unfiltered (gdb_stdlog
,
1349 "%s block symbol cache hit%s for %s, %s\n",
1350 block
== GLOBAL_BLOCK
? "Global" : "Static",
1351 slot
->state
== SYMBOL_SLOT_NOT_FOUND
1352 ? " (not found)" : "",
1353 name
, domain_name (domain
));
1355 if (slot
->state
== SYMBOL_SLOT_NOT_FOUND
)
1356 return SYMBOL_LOOKUP_FAILED
;
1357 return slot
->value
.found
;
1360 /* Symbol is not present in the cache. */
1362 if (symbol_lookup_debug
)
1364 fprintf_unfiltered (gdb_stdlog
,
1365 "%s block symbol cache miss for %s, %s\n",
1366 block
== GLOBAL_BLOCK
? "Global" : "Static",
1367 name
, domain_name (domain
));
1373 /* Mark SYMBOL as found in SLOT.
1374 OBJFILE_CONTEXT is the current objfile when the lookup was done, or NULL
1375 if it's not needed to distinguish lookups (STATIC_BLOCK). It is *not*
1376 necessarily the objfile the symbol was found in. */
1379 symbol_cache_mark_found (struct block_symbol_cache
*bsc
,
1380 struct symbol_cache_slot
*slot
,
1381 struct objfile
*objfile_context
,
1382 struct symbol
*symbol
,
1383 const struct block
*block
)
1387 if (slot
->state
!= SYMBOL_SLOT_UNUSED
)
1390 symbol_cache_clear_slot (slot
);
1392 slot
->state
= SYMBOL_SLOT_FOUND
;
1393 slot
->objfile_context
= objfile_context
;
1394 slot
->value
.found
.symbol
= symbol
;
1395 slot
->value
.found
.block
= block
;
1398 /* Mark symbol NAME, DOMAIN as not found in SLOT.
1399 OBJFILE_CONTEXT is the current objfile when the lookup was done, or NULL
1400 if it's not needed to distinguish lookups (STATIC_BLOCK). */
1403 symbol_cache_mark_not_found (struct block_symbol_cache
*bsc
,
1404 struct symbol_cache_slot
*slot
,
1405 struct objfile
*objfile_context
,
1406 const char *name
, domain_enum domain
)
1410 if (slot
->state
!= SYMBOL_SLOT_UNUSED
)
1413 symbol_cache_clear_slot (slot
);
1415 slot
->state
= SYMBOL_SLOT_NOT_FOUND
;
1416 slot
->objfile_context
= objfile_context
;
1417 slot
->value
.not_found
.name
= xstrdup (name
);
1418 slot
->value
.not_found
.domain
= domain
;
1421 /* Flush the symbol cache of PSPACE. */
1424 symbol_cache_flush (struct program_space
*pspace
)
1426 struct symbol_cache
*cache
= symbol_cache_key
.get (pspace
);
1431 if (cache
->global_symbols
== NULL
)
1433 gdb_assert (symbol_cache_size
== 0);
1434 gdb_assert (cache
->static_symbols
== NULL
);
1438 /* If the cache is untouched since the last flush, early exit.
1439 This is important for performance during the startup of a program linked
1440 with 100s (or 1000s) of shared libraries. */
1441 if (cache
->global_symbols
->misses
== 0
1442 && cache
->static_symbols
->misses
== 0)
1445 gdb_assert (cache
->global_symbols
->size
== symbol_cache_size
);
1446 gdb_assert (cache
->static_symbols
->size
== symbol_cache_size
);
1448 for (pass
= 0; pass
< 2; ++pass
)
1450 struct block_symbol_cache
*bsc
1451 = pass
== 0 ? cache
->global_symbols
: cache
->static_symbols
;
1454 for (i
= 0; i
< bsc
->size
; ++i
)
1455 symbol_cache_clear_slot (&bsc
->symbols
[i
]);
1458 cache
->global_symbols
->hits
= 0;
1459 cache
->global_symbols
->misses
= 0;
1460 cache
->global_symbols
->collisions
= 0;
1461 cache
->static_symbols
->hits
= 0;
1462 cache
->static_symbols
->misses
= 0;
1463 cache
->static_symbols
->collisions
= 0;
1469 symbol_cache_dump (const struct symbol_cache
*cache
)
1473 if (cache
->global_symbols
== NULL
)
1475 printf_filtered (" <disabled>\n");
1479 for (pass
= 0; pass
< 2; ++pass
)
1481 const struct block_symbol_cache
*bsc
1482 = pass
== 0 ? cache
->global_symbols
: cache
->static_symbols
;
1486 printf_filtered ("Global symbols:\n");
1488 printf_filtered ("Static symbols:\n");
1490 for (i
= 0; i
< bsc
->size
; ++i
)
1492 const struct symbol_cache_slot
*slot
= &bsc
->symbols
[i
];
1496 switch (slot
->state
)
1498 case SYMBOL_SLOT_UNUSED
:
1500 case SYMBOL_SLOT_NOT_FOUND
:
1501 printf_filtered (" [%4u] = %s, %s %s (not found)\n", i
,
1502 host_address_to_string (slot
->objfile_context
),
1503 slot
->value
.not_found
.name
,
1504 domain_name (slot
->value
.not_found
.domain
));
1506 case SYMBOL_SLOT_FOUND
:
1508 struct symbol
*found
= slot
->value
.found
.symbol
;
1509 const struct objfile
*context
= slot
->objfile_context
;
1511 printf_filtered (" [%4u] = %s, %s %s\n", i
,
1512 host_address_to_string (context
),
1513 found
->print_name (),
1514 domain_name (SYMBOL_DOMAIN (found
)));
1522 /* The "mt print symbol-cache" command. */
1525 maintenance_print_symbol_cache (const char *args
, int from_tty
)
1527 for (struct program_space
*pspace
: program_spaces
)
1529 struct symbol_cache
*cache
;
1531 printf_filtered (_("Symbol cache for pspace %d\n%s:\n"),
1533 pspace
->symfile_object_file
!= NULL
1534 ? objfile_name (pspace
->symfile_object_file
)
1535 : "(no object file)");
1537 /* If the cache hasn't been created yet, avoid creating one. */
1538 cache
= symbol_cache_key
.get (pspace
);
1540 printf_filtered (" <empty>\n");
1542 symbol_cache_dump (cache
);
1546 /* The "mt flush-symbol-cache" command. */
1549 maintenance_flush_symbol_cache (const char *args
, int from_tty
)
1551 for (struct program_space
*pspace
: program_spaces
)
1553 symbol_cache_flush (pspace
);
1557 /* Print usage statistics of CACHE. */
1560 symbol_cache_stats (struct symbol_cache
*cache
)
1564 if (cache
->global_symbols
== NULL
)
1566 printf_filtered (" <disabled>\n");
1570 for (pass
= 0; pass
< 2; ++pass
)
1572 const struct block_symbol_cache
*bsc
1573 = pass
== 0 ? cache
->global_symbols
: cache
->static_symbols
;
1578 printf_filtered ("Global block cache stats:\n");
1580 printf_filtered ("Static block cache stats:\n");
1582 printf_filtered (" size: %u\n", bsc
->size
);
1583 printf_filtered (" hits: %u\n", bsc
->hits
);
1584 printf_filtered (" misses: %u\n", bsc
->misses
);
1585 printf_filtered (" collisions: %u\n", bsc
->collisions
);
1589 /* The "mt print symbol-cache-statistics" command. */
1592 maintenance_print_symbol_cache_statistics (const char *args
, int from_tty
)
1594 for (struct program_space
*pspace
: program_spaces
)
1596 struct symbol_cache
*cache
;
1598 printf_filtered (_("Symbol cache statistics for pspace %d\n%s:\n"),
1600 pspace
->symfile_object_file
!= NULL
1601 ? objfile_name (pspace
->symfile_object_file
)
1602 : "(no object file)");
1604 /* If the cache hasn't been created yet, avoid creating one. */
1605 cache
= symbol_cache_key
.get (pspace
);
1607 printf_filtered (" empty, no stats available\n");
1609 symbol_cache_stats (cache
);
1613 /* This module's 'new_objfile' observer. */
1616 symtab_new_objfile_observer (struct objfile
*objfile
)
1618 /* Ideally we'd use OBJFILE->pspace, but OBJFILE may be NULL. */
1619 symbol_cache_flush (current_program_space
);
1622 /* This module's 'free_objfile' observer. */
1625 symtab_free_objfile_observer (struct objfile
*objfile
)
1627 symbol_cache_flush (objfile
->pspace
);
1630 /* Debug symbols usually don't have section information. We need to dig that
1631 out of the minimal symbols and stash that in the debug symbol. */
1634 fixup_section (struct general_symbol_info
*ginfo
,
1635 CORE_ADDR addr
, struct objfile
*objfile
)
1637 struct minimal_symbol
*msym
;
1639 /* First, check whether a minimal symbol with the same name exists
1640 and points to the same address. The address check is required
1641 e.g. on PowerPC64, where the minimal symbol for a function will
1642 point to the function descriptor, while the debug symbol will
1643 point to the actual function code. */
1644 msym
= lookup_minimal_symbol_by_pc_name (addr
, ginfo
->linkage_name (),
1647 ginfo
->section
= MSYMBOL_SECTION (msym
);
1650 /* Static, function-local variables do appear in the linker
1651 (minimal) symbols, but are frequently given names that won't
1652 be found via lookup_minimal_symbol(). E.g., it has been
1653 observed in frv-uclinux (ELF) executables that a static,
1654 function-local variable named "foo" might appear in the
1655 linker symbols as "foo.6" or "foo.3". Thus, there is no
1656 point in attempting to extend the lookup-by-name mechanism to
1657 handle this case due to the fact that there can be multiple
1660 So, instead, search the section table when lookup by name has
1661 failed. The ``addr'' and ``endaddr'' fields may have already
1662 been relocated. If so, the relocation offset needs to be
1663 subtracted from these values when performing the comparison.
1664 We unconditionally subtract it, because, when no relocation
1665 has been performed, the value will simply be zero.
1667 The address of the symbol whose section we're fixing up HAS
1668 NOT BEEN adjusted (relocated) yet. It can't have been since
1669 the section isn't yet known and knowing the section is
1670 necessary in order to add the correct relocation value. In
1671 other words, we wouldn't even be in this function (attempting
1672 to compute the section) if it were already known.
1674 Note that it is possible to search the minimal symbols
1675 (subtracting the relocation value if necessary) to find the
1676 matching minimal symbol, but this is overkill and much less
1677 efficient. It is not necessary to find the matching minimal
1678 symbol, only its section.
1680 Note that this technique (of doing a section table search)
1681 can fail when unrelocated section addresses overlap. For
1682 this reason, we still attempt a lookup by name prior to doing
1683 a search of the section table. */
1685 struct obj_section
*s
;
1688 ALL_OBJFILE_OSECTIONS (objfile
, s
)
1690 int idx
= s
- objfile
->sections
;
1691 CORE_ADDR offset
= objfile
->section_offsets
[idx
];
1696 if (obj_section_addr (s
) - offset
<= addr
1697 && addr
< obj_section_endaddr (s
) - offset
)
1699 ginfo
->section
= idx
;
1704 /* If we didn't find the section, assume it is in the first
1705 section. If there is no allocated section, then it hardly
1706 matters what we pick, so just pick zero. */
1710 ginfo
->section
= fallback
;
1715 fixup_symbol_section (struct symbol
*sym
, struct objfile
*objfile
)
1722 if (!SYMBOL_OBJFILE_OWNED (sym
))
1725 /* We either have an OBJFILE, or we can get at it from the sym's
1726 symtab. Anything else is a bug. */
1727 gdb_assert (objfile
|| symbol_symtab (sym
));
1729 if (objfile
== NULL
)
1730 objfile
= symbol_objfile (sym
);
1732 if (SYMBOL_OBJ_SECTION (objfile
, sym
))
1735 /* We should have an objfile by now. */
1736 gdb_assert (objfile
);
1738 switch (SYMBOL_CLASS (sym
))
1742 addr
= SYMBOL_VALUE_ADDRESS (sym
);
1745 addr
= BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
));
1749 /* Nothing else will be listed in the minsyms -- no use looking
1754 fixup_section (sym
, addr
, objfile
);
1761 demangle_for_lookup_info::demangle_for_lookup_info
1762 (const lookup_name_info
&lookup_name
, language lang
)
1764 demangle_result_storage storage
;
1766 if (lookup_name
.ignore_parameters () && lang
== language_cplus
)
1768 gdb::unique_xmalloc_ptr
<char> without_params
1769 = cp_remove_params_if_any (lookup_name
.c_str (),
1770 lookup_name
.completion_mode ());
1772 if (without_params
!= NULL
)
1774 if (lookup_name
.match_type () != symbol_name_match_type::SEARCH_NAME
)
1775 m_demangled_name
= demangle_for_lookup (without_params
.get (),
1781 if (lookup_name
.match_type () == symbol_name_match_type::SEARCH_NAME
)
1782 m_demangled_name
= lookup_name
.c_str ();
1784 m_demangled_name
= demangle_for_lookup (lookup_name
.c_str (),
1790 const lookup_name_info
&
1791 lookup_name_info::match_any ()
1793 /* Lookup any symbol that "" would complete. I.e., this matches all
1795 static const lookup_name_info
lookup_name ("", symbol_name_match_type::FULL
,
1801 /* Compute the demangled form of NAME as used by the various symbol
1802 lookup functions. The result can either be the input NAME
1803 directly, or a pointer to a buffer owned by the STORAGE object.
1805 For Ada, this function just returns NAME, unmodified.
1806 Normally, Ada symbol lookups are performed using the encoded name
1807 rather than the demangled name, and so it might seem to make sense
1808 for this function to return an encoded version of NAME.
1809 Unfortunately, we cannot do this, because this function is used in
1810 circumstances where it is not appropriate to try to encode NAME.
1811 For instance, when displaying the frame info, we demangle the name
1812 of each parameter, and then perform a symbol lookup inside our
1813 function using that demangled name. In Ada, certain functions
1814 have internally-generated parameters whose name contain uppercase
1815 characters. Encoding those name would result in those uppercase
1816 characters to become lowercase, and thus cause the symbol lookup
1820 demangle_for_lookup (const char *name
, enum language lang
,
1821 demangle_result_storage
&storage
)
1823 /* If we are using C++, D, or Go, demangle the name before doing a
1824 lookup, so we can always binary search. */
1825 if (lang
== language_cplus
)
1827 char *demangled_name
= gdb_demangle (name
, DMGL_ANSI
| DMGL_PARAMS
);
1828 if (demangled_name
!= NULL
)
1829 return storage
.set_malloc_ptr (demangled_name
);
1831 /* If we were given a non-mangled name, canonicalize it
1832 according to the language (so far only for C++). */
1833 gdb::unique_xmalloc_ptr
<char> canon
= cp_canonicalize_string (name
);
1834 if (canon
!= nullptr)
1835 return storage
.set_malloc_ptr (std::move (canon
));
1837 else if (lang
== language_d
)
1839 char *demangled_name
= d_demangle (name
, 0);
1840 if (demangled_name
!= NULL
)
1841 return storage
.set_malloc_ptr (demangled_name
);
1843 else if (lang
== language_go
)
1845 char *demangled_name
= go_demangle (name
, 0);
1846 if (demangled_name
!= NULL
)
1847 return storage
.set_malloc_ptr (demangled_name
);
1856 search_name_hash (enum language language
, const char *search_name
)
1858 return language_def (language
)->la_search_name_hash (search_name
);
1863 This function (or rather its subordinates) have a bunch of loops and
1864 it would seem to be attractive to put in some QUIT's (though I'm not really
1865 sure whether it can run long enough to be really important). But there
1866 are a few calls for which it would appear to be bad news to quit
1867 out of here: e.g., find_proc_desc in alpha-mdebug-tdep.c. (Note
1868 that there is C++ code below which can error(), but that probably
1869 doesn't affect these calls since they are looking for a known
1870 variable and thus can probably assume it will never hit the C++
1874 lookup_symbol_in_language (const char *name
, const struct block
*block
,
1875 const domain_enum domain
, enum language lang
,
1876 struct field_of_this_result
*is_a_field_of_this
)
1878 demangle_result_storage storage
;
1879 const char *modified_name
= demangle_for_lookup (name
, lang
, storage
);
1881 return lookup_symbol_aux (modified_name
,
1882 symbol_name_match_type::FULL
,
1883 block
, domain
, lang
,
1884 is_a_field_of_this
);
1890 lookup_symbol (const char *name
, const struct block
*block
,
1892 struct field_of_this_result
*is_a_field_of_this
)
1894 return lookup_symbol_in_language (name
, block
, domain
,
1895 current_language
->la_language
,
1896 is_a_field_of_this
);
1902 lookup_symbol_search_name (const char *search_name
, const struct block
*block
,
1905 return lookup_symbol_aux (search_name
, symbol_name_match_type::SEARCH_NAME
,
1906 block
, domain
, language_asm
, NULL
);
1912 lookup_language_this (const struct language_defn
*lang
,
1913 const struct block
*block
)
1915 if (lang
->la_name_of_this
== NULL
|| block
== NULL
)
1918 if (symbol_lookup_debug
> 1)
1920 struct objfile
*objfile
= block_objfile (block
);
1922 fprintf_unfiltered (gdb_stdlog
,
1923 "lookup_language_this (%s, %s (objfile %s))",
1924 lang
->la_name
, host_address_to_string (block
),
1925 objfile_debug_name (objfile
));
1932 sym
= block_lookup_symbol (block
, lang
->la_name_of_this
,
1933 symbol_name_match_type::SEARCH_NAME
,
1937 if (symbol_lookup_debug
> 1)
1939 fprintf_unfiltered (gdb_stdlog
, " = %s (%s, block %s)\n",
1941 host_address_to_string (sym
),
1942 host_address_to_string (block
));
1944 return (struct block_symbol
) {sym
, block
};
1946 if (BLOCK_FUNCTION (block
))
1948 block
= BLOCK_SUPERBLOCK (block
);
1951 if (symbol_lookup_debug
> 1)
1952 fprintf_unfiltered (gdb_stdlog
, " = NULL\n");
1956 /* Given TYPE, a structure/union,
1957 return 1 if the component named NAME from the ultimate target
1958 structure/union is defined, otherwise, return 0. */
1961 check_field (struct type
*type
, const char *name
,
1962 struct field_of_this_result
*is_a_field_of_this
)
1966 /* The type may be a stub. */
1967 type
= check_typedef (type
);
1969 for (i
= type
->num_fields () - 1; i
>= TYPE_N_BASECLASSES (type
); i
--)
1971 const char *t_field_name
= TYPE_FIELD_NAME (type
, i
);
1973 if (t_field_name
&& (strcmp_iw (t_field_name
, name
) == 0))
1975 is_a_field_of_this
->type
= type
;
1976 is_a_field_of_this
->field
= &type
->field (i
);
1981 /* C++: If it was not found as a data field, then try to return it
1982 as a pointer to a method. */
1984 for (i
= TYPE_NFN_FIELDS (type
) - 1; i
>= 0; --i
)
1986 if (strcmp_iw (TYPE_FN_FIELDLIST_NAME (type
, i
), name
) == 0)
1988 is_a_field_of_this
->type
= type
;
1989 is_a_field_of_this
->fn_field
= &TYPE_FN_FIELDLIST (type
, i
);
1994 for (i
= TYPE_N_BASECLASSES (type
) - 1; i
>= 0; i
--)
1995 if (check_field (TYPE_BASECLASS (type
, i
), name
, is_a_field_of_this
))
2001 /* Behave like lookup_symbol except that NAME is the natural name
2002 (e.g., demangled name) of the symbol that we're looking for. */
2004 static struct block_symbol
2005 lookup_symbol_aux (const char *name
, symbol_name_match_type match_type
,
2006 const struct block
*block
,
2007 const domain_enum domain
, enum language language
,
2008 struct field_of_this_result
*is_a_field_of_this
)
2010 struct block_symbol result
;
2011 const struct language_defn
*langdef
;
2013 if (symbol_lookup_debug
)
2015 struct objfile
*objfile
= (block
== nullptr
2016 ? nullptr : block_objfile (block
));
2018 fprintf_unfiltered (gdb_stdlog
,
2019 "lookup_symbol_aux (%s, %s (objfile %s), %s, %s)\n",
2020 name
, host_address_to_string (block
),
2022 ? objfile_debug_name (objfile
) : "NULL",
2023 domain_name (domain
), language_str (language
));
2026 /* Make sure we do something sensible with is_a_field_of_this, since
2027 the callers that set this parameter to some non-null value will
2028 certainly use it later. If we don't set it, the contents of
2029 is_a_field_of_this are undefined. */
2030 if (is_a_field_of_this
!= NULL
)
2031 memset (is_a_field_of_this
, 0, sizeof (*is_a_field_of_this
));
2033 /* Search specified block and its superiors. Don't search
2034 STATIC_BLOCK or GLOBAL_BLOCK. */
2036 result
= lookup_local_symbol (name
, match_type
, block
, domain
, language
);
2037 if (result
.symbol
!= NULL
)
2039 if (symbol_lookup_debug
)
2041 fprintf_unfiltered (gdb_stdlog
, "lookup_symbol_aux (...) = %s\n",
2042 host_address_to_string (result
.symbol
));
2047 /* If requested to do so by the caller and if appropriate for LANGUAGE,
2048 check to see if NAME is a field of `this'. */
2050 langdef
= language_def (language
);
2052 /* Don't do this check if we are searching for a struct. It will
2053 not be found by check_field, but will be found by other
2055 if (is_a_field_of_this
!= NULL
&& domain
!= STRUCT_DOMAIN
)
2057 result
= lookup_language_this (langdef
, block
);
2061 struct type
*t
= result
.symbol
->type
;
2063 /* I'm not really sure that type of this can ever
2064 be typedefed; just be safe. */
2065 t
= check_typedef (t
);
2066 if (t
->code () == TYPE_CODE_PTR
|| TYPE_IS_REFERENCE (t
))
2067 t
= TYPE_TARGET_TYPE (t
);
2069 if (t
->code () != TYPE_CODE_STRUCT
2070 && t
->code () != TYPE_CODE_UNION
)
2071 error (_("Internal error: `%s' is not an aggregate"),
2072 langdef
->la_name_of_this
);
2074 if (check_field (t
, name
, is_a_field_of_this
))
2076 if (symbol_lookup_debug
)
2078 fprintf_unfiltered (gdb_stdlog
,
2079 "lookup_symbol_aux (...) = NULL\n");
2086 /* Now do whatever is appropriate for LANGUAGE to look
2087 up static and global variables. */
2089 result
= langdef
->la_lookup_symbol_nonlocal (langdef
, name
, block
, domain
);
2090 if (result
.symbol
!= NULL
)
2092 if (symbol_lookup_debug
)
2094 fprintf_unfiltered (gdb_stdlog
, "lookup_symbol_aux (...) = %s\n",
2095 host_address_to_string (result
.symbol
));
2100 /* Now search all static file-level symbols. Not strictly correct,
2101 but more useful than an error. */
2103 result
= lookup_static_symbol (name
, domain
);
2104 if (symbol_lookup_debug
)
2106 fprintf_unfiltered (gdb_stdlog
, "lookup_symbol_aux (...) = %s\n",
2107 result
.symbol
!= NULL
2108 ? host_address_to_string (result
.symbol
)
2114 /* Check to see if the symbol is defined in BLOCK or its superiors.
2115 Don't search STATIC_BLOCK or GLOBAL_BLOCK. */
2117 static struct block_symbol
2118 lookup_local_symbol (const char *name
,
2119 symbol_name_match_type match_type
,
2120 const struct block
*block
,
2121 const domain_enum domain
,
2122 enum language language
)
2125 const struct block
*static_block
= block_static_block (block
);
2126 const char *scope
= block_scope (block
);
2128 /* Check if either no block is specified or it's a global block. */
2130 if (static_block
== NULL
)
2133 while (block
!= static_block
)
2135 sym
= lookup_symbol_in_block (name
, match_type
, block
, domain
);
2137 return (struct block_symbol
) {sym
, block
};
2139 if (language
== language_cplus
|| language
== language_fortran
)
2141 struct block_symbol blocksym
2142 = cp_lookup_symbol_imports_or_template (scope
, name
, block
,
2145 if (blocksym
.symbol
!= NULL
)
2149 if (BLOCK_FUNCTION (block
) != NULL
&& block_inlined_p (block
))
2151 block
= BLOCK_SUPERBLOCK (block
);
2154 /* We've reached the end of the function without finding a result. */
2162 lookup_symbol_in_block (const char *name
, symbol_name_match_type match_type
,
2163 const struct block
*block
,
2164 const domain_enum domain
)
2168 if (symbol_lookup_debug
> 1)
2170 struct objfile
*objfile
= (block
== nullptr
2171 ? nullptr : block_objfile (block
));
2173 fprintf_unfiltered (gdb_stdlog
,
2174 "lookup_symbol_in_block (%s, %s (objfile %s), %s)",
2175 name
, host_address_to_string (block
),
2176 objfile_debug_name (objfile
),
2177 domain_name (domain
));
2180 sym
= block_lookup_symbol (block
, name
, match_type
, domain
);
2183 if (symbol_lookup_debug
> 1)
2185 fprintf_unfiltered (gdb_stdlog
, " = %s\n",
2186 host_address_to_string (sym
));
2188 return fixup_symbol_section (sym
, NULL
);
2191 if (symbol_lookup_debug
> 1)
2192 fprintf_unfiltered (gdb_stdlog
, " = NULL\n");
2199 lookup_global_symbol_from_objfile (struct objfile
*main_objfile
,
2200 enum block_enum block_index
,
2202 const domain_enum domain
)
2204 gdb_assert (block_index
== GLOBAL_BLOCK
|| block_index
== STATIC_BLOCK
);
2206 for (objfile
*objfile
: main_objfile
->separate_debug_objfiles ())
2208 struct block_symbol result
2209 = lookup_symbol_in_objfile (objfile
, block_index
, name
, domain
);
2211 if (result
.symbol
!= nullptr)
2218 /* Check to see if the symbol is defined in one of the OBJFILE's
2219 symtabs. BLOCK_INDEX should be either GLOBAL_BLOCK or STATIC_BLOCK,
2220 depending on whether or not we want to search global symbols or
2223 static struct block_symbol
2224 lookup_symbol_in_objfile_symtabs (struct objfile
*objfile
,
2225 enum block_enum block_index
, const char *name
,
2226 const domain_enum domain
)
2228 gdb_assert (block_index
== GLOBAL_BLOCK
|| block_index
== STATIC_BLOCK
);
2230 if (symbol_lookup_debug
> 1)
2232 fprintf_unfiltered (gdb_stdlog
,
2233 "lookup_symbol_in_objfile_symtabs (%s, %s, %s, %s)",
2234 objfile_debug_name (objfile
),
2235 block_index
== GLOBAL_BLOCK
2236 ? "GLOBAL_BLOCK" : "STATIC_BLOCK",
2237 name
, domain_name (domain
));
2240 struct block_symbol other
;
2241 other
.symbol
= NULL
;
2242 for (compunit_symtab
*cust
: objfile
->compunits ())
2244 const struct blockvector
*bv
;
2245 const struct block
*block
;
2246 struct block_symbol result
;
2248 bv
= COMPUNIT_BLOCKVECTOR (cust
);
2249 block
= BLOCKVECTOR_BLOCK (bv
, block_index
);
2250 result
.symbol
= block_lookup_symbol_primary (block
, name
, domain
);
2251 result
.block
= block
;
2252 if (result
.symbol
== NULL
)
2254 if (best_symbol (result
.symbol
, domain
))
2259 if (symbol_matches_domain (result
.symbol
->language (),
2260 SYMBOL_DOMAIN (result
.symbol
), domain
))
2262 struct symbol
*better
2263 = better_symbol (other
.symbol
, result
.symbol
, domain
);
2264 if (better
!= other
.symbol
)
2266 other
.symbol
= better
;
2267 other
.block
= block
;
2272 if (other
.symbol
!= NULL
)
2274 if (symbol_lookup_debug
> 1)
2276 fprintf_unfiltered (gdb_stdlog
, " = %s (block %s)\n",
2277 host_address_to_string (other
.symbol
),
2278 host_address_to_string (other
.block
));
2280 other
.symbol
= fixup_symbol_section (other
.symbol
, objfile
);
2284 if (symbol_lookup_debug
> 1)
2285 fprintf_unfiltered (gdb_stdlog
, " = NULL\n");
2289 /* Wrapper around lookup_symbol_in_objfile_symtabs for search_symbols.
2290 Look up LINKAGE_NAME in DOMAIN in the global and static blocks of OBJFILE
2291 and all associated separate debug objfiles.
2293 Normally we only look in OBJFILE, and not any separate debug objfiles
2294 because the outer loop will cause them to be searched too. This case is
2295 different. Here we're called from search_symbols where it will only
2296 call us for the objfile that contains a matching minsym. */
2298 static struct block_symbol
2299 lookup_symbol_in_objfile_from_linkage_name (struct objfile
*objfile
,
2300 const char *linkage_name
,
2303 enum language lang
= current_language
->la_language
;
2304 struct objfile
*main_objfile
;
2306 demangle_result_storage storage
;
2307 const char *modified_name
= demangle_for_lookup (linkage_name
, lang
, storage
);
2309 if (objfile
->separate_debug_objfile_backlink
)
2310 main_objfile
= objfile
->separate_debug_objfile_backlink
;
2312 main_objfile
= objfile
;
2314 for (::objfile
*cur_objfile
: main_objfile
->separate_debug_objfiles ())
2316 struct block_symbol result
;
2318 result
= lookup_symbol_in_objfile_symtabs (cur_objfile
, GLOBAL_BLOCK
,
2319 modified_name
, domain
);
2320 if (result
.symbol
== NULL
)
2321 result
= lookup_symbol_in_objfile_symtabs (cur_objfile
, STATIC_BLOCK
,
2322 modified_name
, domain
);
2323 if (result
.symbol
!= NULL
)
2330 /* A helper function that throws an exception when a symbol was found
2331 in a psymtab but not in a symtab. */
2333 static void ATTRIBUTE_NORETURN
2334 error_in_psymtab_expansion (enum block_enum block_index
, const char *name
,
2335 struct compunit_symtab
*cust
)
2338 Internal: %s symbol `%s' found in %s psymtab but not in symtab.\n\
2339 %s may be an inlined function, or may be a template function\n \
2340 (if a template, try specifying an instantiation: %s<type>)."),
2341 block_index
== GLOBAL_BLOCK
? "global" : "static",
2343 symtab_to_filename_for_display (compunit_primary_filetab (cust
)),
2347 /* A helper function for various lookup routines that interfaces with
2348 the "quick" symbol table functions. */
2350 static struct block_symbol
2351 lookup_symbol_via_quick_fns (struct objfile
*objfile
,
2352 enum block_enum block_index
, const char *name
,
2353 const domain_enum domain
)
2355 struct compunit_symtab
*cust
;
2356 const struct blockvector
*bv
;
2357 const struct block
*block
;
2358 struct block_symbol result
;
2363 if (symbol_lookup_debug
> 1)
2365 fprintf_unfiltered (gdb_stdlog
,
2366 "lookup_symbol_via_quick_fns (%s, %s, %s, %s)\n",
2367 objfile_debug_name (objfile
),
2368 block_index
== GLOBAL_BLOCK
2369 ? "GLOBAL_BLOCK" : "STATIC_BLOCK",
2370 name
, domain_name (domain
));
2373 cust
= objfile
->sf
->qf
->lookup_symbol (objfile
, block_index
, name
, domain
);
2376 if (symbol_lookup_debug
> 1)
2378 fprintf_unfiltered (gdb_stdlog
,
2379 "lookup_symbol_via_quick_fns (...) = NULL\n");
2384 bv
= COMPUNIT_BLOCKVECTOR (cust
);
2385 block
= BLOCKVECTOR_BLOCK (bv
, block_index
);
2386 result
.symbol
= block_lookup_symbol (block
, name
,
2387 symbol_name_match_type::FULL
, domain
);
2388 if (result
.symbol
== NULL
)
2389 error_in_psymtab_expansion (block_index
, name
, cust
);
2391 if (symbol_lookup_debug
> 1)
2393 fprintf_unfiltered (gdb_stdlog
,
2394 "lookup_symbol_via_quick_fns (...) = %s (block %s)\n",
2395 host_address_to_string (result
.symbol
),
2396 host_address_to_string (block
));
2399 result
.symbol
= fixup_symbol_section (result
.symbol
, objfile
);
2400 result
.block
= block
;
2407 basic_lookup_symbol_nonlocal (const struct language_defn
*langdef
,
2409 const struct block
*block
,
2410 const domain_enum domain
)
2412 struct block_symbol result
;
2414 /* NOTE: dje/2014-10-26: The lookup in all objfiles search could skip
2415 the current objfile. Searching the current objfile first is useful
2416 for both matching user expectations as well as performance. */
2418 result
= lookup_symbol_in_static_block (name
, block
, domain
);
2419 if (result
.symbol
!= NULL
)
2422 /* If we didn't find a definition for a builtin type in the static block,
2423 search for it now. This is actually the right thing to do and can be
2424 a massive performance win. E.g., when debugging a program with lots of
2425 shared libraries we could search all of them only to find out the
2426 builtin type isn't defined in any of them. This is common for types
2428 if (domain
== VAR_DOMAIN
)
2430 struct gdbarch
*gdbarch
;
2433 gdbarch
= target_gdbarch ();
2435 gdbarch
= block_gdbarch (block
);
2436 result
.symbol
= language_lookup_primitive_type_as_symbol (langdef
,
2438 result
.block
= NULL
;
2439 if (result
.symbol
!= NULL
)
2443 return lookup_global_symbol (name
, block
, domain
);
2449 lookup_symbol_in_static_block (const char *name
,
2450 const struct block
*block
,
2451 const domain_enum domain
)
2453 const struct block
*static_block
= block_static_block (block
);
2456 if (static_block
== NULL
)
2459 if (symbol_lookup_debug
)
2461 struct objfile
*objfile
= (block
== nullptr
2462 ? nullptr : block_objfile (block
));
2464 fprintf_unfiltered (gdb_stdlog
,
2465 "lookup_symbol_in_static_block (%s, %s (objfile %s),"
2468 host_address_to_string (block
),
2469 objfile_debug_name (objfile
),
2470 domain_name (domain
));
2473 sym
= lookup_symbol_in_block (name
,
2474 symbol_name_match_type::FULL
,
2475 static_block
, domain
);
2476 if (symbol_lookup_debug
)
2478 fprintf_unfiltered (gdb_stdlog
,
2479 "lookup_symbol_in_static_block (...) = %s\n",
2480 sym
!= NULL
? host_address_to_string (sym
) : "NULL");
2482 return (struct block_symbol
) {sym
, static_block
};
2485 /* Perform the standard symbol lookup of NAME in OBJFILE:
2486 1) First search expanded symtabs, and if not found
2487 2) Search the "quick" symtabs (partial or .gdb_index).
2488 BLOCK_INDEX is one of GLOBAL_BLOCK or STATIC_BLOCK. */
2490 static struct block_symbol
2491 lookup_symbol_in_objfile (struct objfile
*objfile
, enum block_enum block_index
,
2492 const char *name
, const domain_enum domain
)
2494 struct block_symbol result
;
2496 gdb_assert (block_index
== GLOBAL_BLOCK
|| block_index
== STATIC_BLOCK
);
2498 if (symbol_lookup_debug
)
2500 fprintf_unfiltered (gdb_stdlog
,
2501 "lookup_symbol_in_objfile (%s, %s, %s, %s)\n",
2502 objfile_debug_name (objfile
),
2503 block_index
== GLOBAL_BLOCK
2504 ? "GLOBAL_BLOCK" : "STATIC_BLOCK",
2505 name
, domain_name (domain
));
2508 result
= lookup_symbol_in_objfile_symtabs (objfile
, block_index
,
2510 if (result
.symbol
!= NULL
)
2512 if (symbol_lookup_debug
)
2514 fprintf_unfiltered (gdb_stdlog
,
2515 "lookup_symbol_in_objfile (...) = %s"
2517 host_address_to_string (result
.symbol
));
2522 result
= lookup_symbol_via_quick_fns (objfile
, block_index
,
2524 if (symbol_lookup_debug
)
2526 fprintf_unfiltered (gdb_stdlog
,
2527 "lookup_symbol_in_objfile (...) = %s%s\n",
2528 result
.symbol
!= NULL
2529 ? host_address_to_string (result
.symbol
)
2531 result
.symbol
!= NULL
? " (via quick fns)" : "");
2536 /* Find the language for partial symbol with NAME. */
2538 static enum language
2539 find_quick_global_symbol_language (const char *name
, const domain_enum domain
)
2541 for (objfile
*objfile
: current_program_space
->objfiles ())
2543 if (objfile
->sf
&& objfile
->sf
->qf
2544 && objfile
->sf
->qf
->lookup_global_symbol_language
)
2546 return language_unknown
;
2549 for (objfile
*objfile
: current_program_space
->objfiles ())
2551 bool symbol_found_p
;
2553 = objfile
->sf
->qf
->lookup_global_symbol_language (objfile
, name
, domain
,
2555 if (!symbol_found_p
)
2560 return language_unknown
;
2563 /* Private data to be used with lookup_symbol_global_iterator_cb. */
2565 struct global_or_static_sym_lookup_data
2567 /* The name of the symbol we are searching for. */
2570 /* The domain to use for our search. */
2573 /* The block index in which to search. */
2574 enum block_enum block_index
;
2576 /* The field where the callback should store the symbol if found.
2577 It should be initialized to {NULL, NULL} before the search is started. */
2578 struct block_symbol result
;
2581 /* A callback function for gdbarch_iterate_over_objfiles_in_search_order.
2582 It searches by name for a symbol in the block given by BLOCK_INDEX of the
2583 given OBJFILE. The arguments for the search are passed via CB_DATA, which
2584 in reality is a pointer to struct global_or_static_sym_lookup_data. */
2587 lookup_symbol_global_or_static_iterator_cb (struct objfile
*objfile
,
2590 struct global_or_static_sym_lookup_data
*data
=
2591 (struct global_or_static_sym_lookup_data
*) cb_data
;
2593 gdb_assert (data
->result
.symbol
== NULL
2594 && data
->result
.block
== NULL
);
2596 data
->result
= lookup_symbol_in_objfile (objfile
, data
->block_index
,
2597 data
->name
, data
->domain
);
2599 /* If we found a match, tell the iterator to stop. Otherwise,
2601 return (data
->result
.symbol
!= NULL
);
2604 /* This function contains the common code of lookup_{global,static}_symbol.
2605 OBJFILE is only used if BLOCK_INDEX is GLOBAL_SCOPE, in which case it is
2606 the objfile to start the lookup in. */
2608 static struct block_symbol
2609 lookup_global_or_static_symbol (const char *name
,
2610 enum block_enum block_index
,
2611 struct objfile
*objfile
,
2612 const domain_enum domain
)
2614 struct symbol_cache
*cache
= get_symbol_cache (current_program_space
);
2615 struct block_symbol result
;
2616 struct global_or_static_sym_lookup_data lookup_data
;
2617 struct block_symbol_cache
*bsc
;
2618 struct symbol_cache_slot
*slot
;
2620 gdb_assert (block_index
== GLOBAL_BLOCK
|| block_index
== STATIC_BLOCK
);
2621 gdb_assert (objfile
== nullptr || block_index
== GLOBAL_BLOCK
);
2623 /* First see if we can find the symbol in the cache.
2624 This works because we use the current objfile to qualify the lookup. */
2625 result
= symbol_cache_lookup (cache
, objfile
, block_index
, name
, domain
,
2627 if (result
.symbol
!= NULL
)
2629 if (SYMBOL_LOOKUP_FAILED_P (result
))
2634 /* Do a global search (of global blocks, heh). */
2635 if (result
.symbol
== NULL
)
2637 memset (&lookup_data
, 0, sizeof (lookup_data
));
2638 lookup_data
.name
= name
;
2639 lookup_data
.block_index
= block_index
;
2640 lookup_data
.domain
= domain
;
2641 gdbarch_iterate_over_objfiles_in_search_order
2642 (objfile
!= NULL
? objfile
->arch () : target_gdbarch (),
2643 lookup_symbol_global_or_static_iterator_cb
, &lookup_data
, objfile
);
2644 result
= lookup_data
.result
;
2647 if (result
.symbol
!= NULL
)
2648 symbol_cache_mark_found (bsc
, slot
, objfile
, result
.symbol
, result
.block
);
2650 symbol_cache_mark_not_found (bsc
, slot
, objfile
, name
, domain
);
2658 lookup_static_symbol (const char *name
, const domain_enum domain
)
2660 return lookup_global_or_static_symbol (name
, STATIC_BLOCK
, nullptr, domain
);
2666 lookup_global_symbol (const char *name
,
2667 const struct block
*block
,
2668 const domain_enum domain
)
2670 /* If a block was passed in, we want to search the corresponding
2671 global block first. This yields "more expected" behavior, and is
2672 needed to support 'FILENAME'::VARIABLE lookups. */
2673 const struct block
*global_block
= block_global_block (block
);
2675 if (global_block
!= nullptr)
2677 sym
= lookup_symbol_in_block (name
,
2678 symbol_name_match_type::FULL
,
2679 global_block
, domain
);
2680 if (sym
!= NULL
&& best_symbol (sym
, domain
))
2681 return { sym
, global_block
};
2684 struct objfile
*objfile
= nullptr;
2685 if (block
!= nullptr)
2687 objfile
= block_objfile (block
);
2688 if (objfile
->separate_debug_objfile_backlink
!= nullptr)
2689 objfile
= objfile
->separate_debug_objfile_backlink
;
2693 = lookup_global_or_static_symbol (name
, GLOBAL_BLOCK
, objfile
, domain
);
2694 if (better_symbol (sym
, bs
.symbol
, domain
) == sym
)
2695 return { sym
, global_block
};
2701 symbol_matches_domain (enum language symbol_language
,
2702 domain_enum symbol_domain
,
2705 /* For C++ "struct foo { ... }" also defines a typedef for "foo".
2706 Similarly, any Ada type declaration implicitly defines a typedef. */
2707 if (symbol_language
== language_cplus
2708 || symbol_language
== language_d
2709 || symbol_language
== language_ada
2710 || symbol_language
== language_rust
)
2712 if ((domain
== VAR_DOMAIN
|| domain
== STRUCT_DOMAIN
)
2713 && symbol_domain
== STRUCT_DOMAIN
)
2716 /* For all other languages, strict match is required. */
2717 return (symbol_domain
== domain
);
2723 lookup_transparent_type (const char *name
)
2725 return current_language
->la_lookup_transparent_type (name
);
2728 /* A helper for basic_lookup_transparent_type that interfaces with the
2729 "quick" symbol table functions. */
2731 static struct type
*
2732 basic_lookup_transparent_type_quick (struct objfile
*objfile
,
2733 enum block_enum block_index
,
2736 struct compunit_symtab
*cust
;
2737 const struct blockvector
*bv
;
2738 const struct block
*block
;
2743 cust
= objfile
->sf
->qf
->lookup_symbol (objfile
, block_index
, name
,
2748 bv
= COMPUNIT_BLOCKVECTOR (cust
);
2749 block
= BLOCKVECTOR_BLOCK (bv
, block_index
);
2750 sym
= block_find_symbol (block
, name
, STRUCT_DOMAIN
,
2751 block_find_non_opaque_type
, NULL
);
2753 error_in_psymtab_expansion (block_index
, name
, cust
);
2754 gdb_assert (!TYPE_IS_OPAQUE (SYMBOL_TYPE (sym
)));
2755 return SYMBOL_TYPE (sym
);
2758 /* Subroutine of basic_lookup_transparent_type to simplify it.
2759 Look up the non-opaque definition of NAME in BLOCK_INDEX of OBJFILE.
2760 BLOCK_INDEX is either GLOBAL_BLOCK or STATIC_BLOCK. */
2762 static struct type
*
2763 basic_lookup_transparent_type_1 (struct objfile
*objfile
,
2764 enum block_enum block_index
,
2767 const struct blockvector
*bv
;
2768 const struct block
*block
;
2769 const struct symbol
*sym
;
2771 for (compunit_symtab
*cust
: objfile
->compunits ())
2773 bv
= COMPUNIT_BLOCKVECTOR (cust
);
2774 block
= BLOCKVECTOR_BLOCK (bv
, block_index
);
2775 sym
= block_find_symbol (block
, name
, STRUCT_DOMAIN
,
2776 block_find_non_opaque_type
, NULL
);
2779 gdb_assert (!TYPE_IS_OPAQUE (SYMBOL_TYPE (sym
)));
2780 return SYMBOL_TYPE (sym
);
2787 /* The standard implementation of lookup_transparent_type. This code
2788 was modeled on lookup_symbol -- the parts not relevant to looking
2789 up types were just left out. In particular it's assumed here that
2790 types are available in STRUCT_DOMAIN and only in file-static or
2794 basic_lookup_transparent_type (const char *name
)
2798 /* Now search all the global symbols. Do the symtab's first, then
2799 check the psymtab's. If a psymtab indicates the existence
2800 of the desired name as a global, then do psymtab-to-symtab
2801 conversion on the fly and return the found symbol. */
2803 for (objfile
*objfile
: current_program_space
->objfiles ())
2805 t
= basic_lookup_transparent_type_1 (objfile
, GLOBAL_BLOCK
, name
);
2810 for (objfile
*objfile
: current_program_space
->objfiles ())
2812 t
= basic_lookup_transparent_type_quick (objfile
, GLOBAL_BLOCK
, name
);
2817 /* Now search the static file-level symbols.
2818 Not strictly correct, but more useful than an error.
2819 Do the symtab's first, then
2820 check the psymtab's. If a psymtab indicates the existence
2821 of the desired name as a file-level static, then do psymtab-to-symtab
2822 conversion on the fly and return the found symbol. */
2824 for (objfile
*objfile
: current_program_space
->objfiles ())
2826 t
= basic_lookup_transparent_type_1 (objfile
, STATIC_BLOCK
, name
);
2831 for (objfile
*objfile
: current_program_space
->objfiles ())
2833 t
= basic_lookup_transparent_type_quick (objfile
, STATIC_BLOCK
, name
);
2838 return (struct type
*) 0;
2844 iterate_over_symbols (const struct block
*block
,
2845 const lookup_name_info
&name
,
2846 const domain_enum domain
,
2847 gdb::function_view
<symbol_found_callback_ftype
> callback
)
2849 struct block_iterator iter
;
2852 ALL_BLOCK_SYMBOLS_WITH_NAME (block
, name
, iter
, sym
)
2854 if (symbol_matches_domain (sym
->language (), SYMBOL_DOMAIN (sym
), domain
))
2856 struct block_symbol block_sym
= {sym
, block
};
2858 if (!callback (&block_sym
))
2868 iterate_over_symbols_terminated
2869 (const struct block
*block
,
2870 const lookup_name_info
&name
,
2871 const domain_enum domain
,
2872 gdb::function_view
<symbol_found_callback_ftype
> callback
)
2874 if (!iterate_over_symbols (block
, name
, domain
, callback
))
2876 struct block_symbol block_sym
= {nullptr, block
};
2877 return callback (&block_sym
);
2880 /* Find the compunit symtab associated with PC and SECTION.
2881 This will read in debug info as necessary. */
2883 struct compunit_symtab
*
2884 find_pc_sect_compunit_symtab (CORE_ADDR pc
, struct obj_section
*section
)
2886 struct compunit_symtab
*best_cust
= NULL
;
2887 CORE_ADDR distance
= 0;
2888 struct bound_minimal_symbol msymbol
;
2890 /* If we know that this is not a text address, return failure. This is
2891 necessary because we loop based on the block's high and low code
2892 addresses, which do not include the data ranges, and because
2893 we call find_pc_sect_psymtab which has a similar restriction based
2894 on the partial_symtab's texthigh and textlow. */
2895 msymbol
= lookup_minimal_symbol_by_pc_section (pc
, section
);
2896 if (msymbol
.minsym
&& msymbol
.minsym
->data_p ())
2899 /* Search all symtabs for the one whose file contains our address, and which
2900 is the smallest of all the ones containing the address. This is designed
2901 to deal with a case like symtab a is at 0x1000-0x2000 and 0x3000-0x4000
2902 and symtab b is at 0x2000-0x3000. So the GLOBAL_BLOCK for a is from
2903 0x1000-0x4000, but for address 0x2345 we want to return symtab b.
2905 This happens for native ecoff format, where code from included files
2906 gets its own symtab. The symtab for the included file should have
2907 been read in already via the dependency mechanism.
2908 It might be swifter to create several symtabs with the same name
2909 like xcoff does (I'm not sure).
2911 It also happens for objfiles that have their functions reordered.
2912 For these, the symtab we are looking for is not necessarily read in. */
2914 for (objfile
*obj_file
: current_program_space
->objfiles ())
2916 for (compunit_symtab
*cust
: obj_file
->compunits ())
2918 const struct block
*b
;
2919 const struct blockvector
*bv
;
2921 bv
= COMPUNIT_BLOCKVECTOR (cust
);
2922 b
= BLOCKVECTOR_BLOCK (bv
, GLOBAL_BLOCK
);
2924 if (BLOCK_START (b
) <= pc
2925 && BLOCK_END (b
) > pc
2927 || BLOCK_END (b
) - BLOCK_START (b
) < distance
))
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
) && obj_file
->sf
)
2937 struct compunit_symtab
*result
;
2940 = obj_file
->sf
->qf
->find_pc_sect_compunit_symtab (obj_file
,
2950 struct block_iterator iter
;
2951 struct symbol
*sym
= NULL
;
2953 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
2955 fixup_symbol_section (sym
, obj_file
);
2956 if (matching_obj_sections (SYMBOL_OBJ_SECTION (obj_file
,
2962 continue; /* No symbol in this symtab matches
2965 distance
= BLOCK_END (b
) - BLOCK_START (b
);
2971 if (best_cust
!= NULL
)
2974 /* Not found in symtabs, search the "quick" symtabs (e.g. psymtabs). */
2976 for (objfile
*objf
: current_program_space
->objfiles ())
2978 struct compunit_symtab
*result
;
2982 result
= objf
->sf
->qf
->find_pc_sect_compunit_symtab (objf
,
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 for (objfile
*objfile
: current_program_space
->objfiles ())
3010 if (objfile
->sf
== NULL
3011 || objfile
->sf
->qf
->find_compunit_symtab_by_address
== NULL
)
3014 struct compunit_symtab
*symtab
3015 = objfile
->sf
->qf
->find_compunit_symtab_by_address (objfile
, address
);
3018 const struct blockvector
*bv
= COMPUNIT_BLOCKVECTOR (symtab
);
3020 for (int i
= GLOBAL_BLOCK
; i
<= STATIC_BLOCK
; ++i
)
3022 const struct block
*b
= BLOCKVECTOR_BLOCK (bv
, i
);
3023 struct block_iterator iter
;
3026 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
3028 if (SYMBOL_CLASS (sym
) == LOC_STATIC
3029 && SYMBOL_VALUE_ADDRESS (sym
) == address
)
3041 /* Find the source file and line number for a given PC value and SECTION.
3042 Return a structure containing a symtab pointer, a line number,
3043 and a pc range for the entire source line.
3044 The value's .pc field is NOT the specified pc.
3045 NOTCURRENT nonzero means, if specified pc is on a line boundary,
3046 use the line that ends there. Otherwise, in that case, the line
3047 that begins there is used. */
3049 /* The big complication here is that a line may start in one file, and end just
3050 before the start of another file. This usually occurs when you #include
3051 code in the middle of a subroutine. To properly find the end of a line's PC
3052 range, we must search all symtabs associated with this compilation unit, and
3053 find the one whose first PC is closer than that of the next line in this
3056 struct symtab_and_line
3057 find_pc_sect_line (CORE_ADDR pc
, struct obj_section
*section
, int notcurrent
)
3059 struct compunit_symtab
*cust
;
3060 struct linetable
*l
;
3062 struct linetable_entry
*item
;
3063 const struct blockvector
*bv
;
3064 struct bound_minimal_symbol msymbol
;
3066 /* Info on best line seen so far, and where it starts, and its file. */
3068 struct linetable_entry
*best
= NULL
;
3069 CORE_ADDR best_end
= 0;
3070 struct symtab
*best_symtab
= 0;
3072 /* Store here the first line number
3073 of a file which contains the line at the smallest pc after PC.
3074 If we don't find a line whose range contains PC,
3075 we will use a line one less than this,
3076 with a range from the start of that file to the first line's pc. */
3077 struct linetable_entry
*alt
= NULL
;
3079 /* Info on best line seen in this file. */
3081 struct linetable_entry
*prev
;
3083 /* If this pc is not from the current frame,
3084 it is the address of the end of a call instruction.
3085 Quite likely that is the start of the following statement.
3086 But what we want is the statement containing the instruction.
3087 Fudge the pc to make sure we get that. */
3089 /* It's tempting to assume that, if we can't find debugging info for
3090 any function enclosing PC, that we shouldn't search for line
3091 number info, either. However, GAS can emit line number info for
3092 assembly files --- very helpful when debugging hand-written
3093 assembly code. In such a case, we'd have no debug info for the
3094 function, but we would have line info. */
3099 /* elz: added this because this function returned the wrong
3100 information if the pc belongs to a stub (import/export)
3101 to call a shlib function. This stub would be anywhere between
3102 two functions in the target, and the line info was erroneously
3103 taken to be the one of the line before the pc. */
3105 /* RT: Further explanation:
3107 * We have stubs (trampolines) inserted between procedures.
3109 * Example: "shr1" exists in a shared library, and a "shr1" stub also
3110 * exists in the main image.
3112 * In the minimal symbol table, we have a bunch of symbols
3113 * sorted by start address. The stubs are marked as "trampoline",
3114 * the others appear as text. E.g.:
3116 * Minimal symbol table for main image
3117 * main: code for main (text symbol)
3118 * shr1: stub (trampoline symbol)
3119 * foo: code for foo (text symbol)
3121 * Minimal symbol table for "shr1" image:
3123 * shr1: code for shr1 (text symbol)
3126 * So the code below is trying to detect if we are in the stub
3127 * ("shr1" stub), and if so, find the real code ("shr1" trampoline),
3128 * and if found, do the symbolization from the real-code address
3129 * rather than the stub address.
3131 * Assumptions being made about the minimal symbol table:
3132 * 1. lookup_minimal_symbol_by_pc() will return a trampoline only
3133 * if we're really in the trampoline.s If we're beyond it (say
3134 * we're in "foo" in the above example), it'll have a closer
3135 * symbol (the "foo" text symbol for example) and will not
3136 * return the trampoline.
3137 * 2. lookup_minimal_symbol_text() will find a real text symbol
3138 * corresponding to the trampoline, and whose address will
3139 * be different than the trampoline address. I put in a sanity
3140 * check for the address being the same, to avoid an
3141 * infinite recursion.
3143 msymbol
= lookup_minimal_symbol_by_pc (pc
);
3144 if (msymbol
.minsym
!= NULL
)
3145 if (MSYMBOL_TYPE (msymbol
.minsym
) == mst_solib_trampoline
)
3147 struct bound_minimal_symbol mfunsym
3148 = lookup_minimal_symbol_text (msymbol
.minsym
->linkage_name (),
3151 if (mfunsym
.minsym
== NULL
)
3152 /* I eliminated this warning since it is coming out
3153 * in the following situation:
3154 * gdb shmain // test program with shared libraries
3155 * (gdb) break shr1 // function in shared lib
3156 * Warning: In stub for ...
3157 * In the above situation, the shared lib is not loaded yet,
3158 * so of course we can't find the real func/line info,
3159 * but the "break" still works, and the warning is annoying.
3160 * So I commented out the warning. RT */
3161 /* warning ("In stub for %s; unable to find real function/line info",
3162 msymbol->linkage_name ()); */
3165 else if (BMSYMBOL_VALUE_ADDRESS (mfunsym
)
3166 == BMSYMBOL_VALUE_ADDRESS (msymbol
))
3167 /* Avoid infinite recursion */
3168 /* See above comment about why warning is commented out. */
3169 /* warning ("In stub for %s; unable to find real function/line info",
3170 msymbol->linkage_name ()); */
3175 /* Detect an obvious case of infinite recursion. If this
3176 should occur, we'd like to know about it, so error out,
3178 if (BMSYMBOL_VALUE_ADDRESS (mfunsym
) == pc
)
3179 internal_error (__FILE__
, __LINE__
,
3180 _("Infinite recursion detected in find_pc_sect_line;"
3181 "please file a bug report"));
3183 return find_pc_line (BMSYMBOL_VALUE_ADDRESS (mfunsym
), 0);
3187 symtab_and_line val
;
3188 val
.pspace
= current_program_space
;
3190 cust
= find_pc_sect_compunit_symtab (pc
, section
);
3193 /* If no symbol information, return previous pc. */
3200 bv
= COMPUNIT_BLOCKVECTOR (cust
);
3202 /* Look at all the symtabs that share this blockvector.
3203 They all have the same apriori range, that we found was right;
3204 but they have different line tables. */
3206 for (symtab
*iter_s
: compunit_filetabs (cust
))
3208 /* Find the best line in this symtab. */
3209 l
= SYMTAB_LINETABLE (iter_s
);
3215 /* I think len can be zero if the symtab lacks line numbers
3216 (e.g. gcc -g1). (Either that or the LINETABLE is NULL;
3217 I'm not sure which, and maybe it depends on the symbol
3223 item
= l
->item
; /* Get first line info. */
3225 /* Is this file's first line closer than the first lines of other files?
3226 If so, record this file, and its first line, as best alternate. */
3227 if (item
->pc
> pc
&& (!alt
|| item
->pc
< alt
->pc
))
3230 auto pc_compare
= [](const CORE_ADDR
& comp_pc
,
3231 const struct linetable_entry
& lhs
)->bool
3233 return comp_pc
< lhs
.pc
;
3236 struct linetable_entry
*first
= item
;
3237 struct linetable_entry
*last
= item
+ len
;
3238 item
= std::upper_bound (first
, last
, pc
, pc_compare
);
3241 /* Found a matching item. Skip backwards over any end of
3242 sequence markers. */
3243 for (prev
= item
- 1; prev
->line
== 0 && prev
!= first
; prev
--)
3247 /* At this point, prev points at the line whose start addr is <= pc, and
3248 item points at the next line. If we ran off the end of the linetable
3249 (pc >= start of the last line), then prev == item. If pc < start of
3250 the first line, prev will not be set. */
3252 /* Is this file's best line closer than the best in the other files?
3253 If so, record this file, and its best line, as best so far. Don't
3254 save prev if it represents the end of a function (i.e. line number
3255 0) instead of a real line. */
3257 if (prev
&& prev
->line
&& (!best
|| prev
->pc
> best
->pc
))
3260 best_symtab
= iter_s
;
3262 /* If during the binary search we land on a non-statement entry,
3263 scan backward through entries at the same address to see if
3264 there is an entry marked as is-statement. In theory this
3265 duplication should have been removed from the line table
3266 during construction, this is just a double check. If the line
3267 table has had the duplication removed then this should be
3271 struct linetable_entry
*tmp
= best
;
3272 while (tmp
> first
&& (tmp
- 1)->pc
== tmp
->pc
3273 && (tmp
- 1)->line
!= 0 && !tmp
->is_stmt
)
3279 /* Discard BEST_END if it's before the PC of the current BEST. */
3280 if (best_end
<= best
->pc
)
3284 /* If another line (denoted by ITEM) is in the linetable and its
3285 PC is after BEST's PC, but before the current BEST_END, then
3286 use ITEM's PC as the new best_end. */
3287 if (best
&& item
< last
&& item
->pc
> best
->pc
3288 && (best_end
== 0 || best_end
> item
->pc
))
3289 best_end
= item
->pc
;
3294 /* If we didn't find any line number info, just return zeros.
3295 We used to return alt->line - 1 here, but that could be
3296 anywhere; if we don't have line number info for this PC,
3297 don't make some up. */
3300 else if (best
->line
== 0)
3302 /* If our best fit is in a range of PC's for which no line
3303 number info is available (line number is zero) then we didn't
3304 find any valid line information. */
3309 val
.is_stmt
= best
->is_stmt
;
3310 val
.symtab
= best_symtab
;
3311 val
.line
= best
->line
;
3313 if (best_end
&& (!alt
|| best_end
< alt
->pc
))
3318 val
.end
= BLOCK_END (BLOCKVECTOR_BLOCK (bv
, GLOBAL_BLOCK
));
3320 val
.section
= section
;
3324 /* Backward compatibility (no section). */
3326 struct symtab_and_line
3327 find_pc_line (CORE_ADDR pc
, int notcurrent
)
3329 struct obj_section
*section
;
3331 section
= find_pc_overlay (pc
);
3332 if (pc_in_unmapped_range (pc
, section
))
3333 pc
= overlay_mapped_address (pc
, section
);
3334 return find_pc_sect_line (pc
, section
, notcurrent
);
3340 find_pc_line_symtab (CORE_ADDR pc
)
3342 struct symtab_and_line sal
;
3344 /* This always passes zero for NOTCURRENT to find_pc_line.
3345 There are currently no callers that ever pass non-zero. */
3346 sal
= find_pc_line (pc
, 0);
3350 /* Find line number LINE in any symtab whose name is the same as
3353 If found, return the symtab that contains the linetable in which it was
3354 found, set *INDEX to the index in the linetable of the best entry
3355 found, and set *EXACT_MATCH to true if the value returned is an
3358 If not found, return NULL. */
3361 find_line_symtab (struct symtab
*sym_tab
, int line
,
3362 int *index
, bool *exact_match
)
3364 int exact
= 0; /* Initialized here to avoid a compiler warning. */
3366 /* BEST_INDEX and BEST_LINETABLE identify the smallest linenumber > LINE
3370 struct linetable
*best_linetable
;
3371 struct symtab
*best_symtab
;
3373 /* First try looking it up in the given symtab. */
3374 best_linetable
= SYMTAB_LINETABLE (sym_tab
);
3375 best_symtab
= sym_tab
;
3376 best_index
= find_line_common (best_linetable
, line
, &exact
, 0);
3377 if (best_index
< 0 || !exact
)
3379 /* Didn't find an exact match. So we better keep looking for
3380 another symtab with the same name. In the case of xcoff,
3381 multiple csects for one source file (produced by IBM's FORTRAN
3382 compiler) produce multiple symtabs (this is unavoidable
3383 assuming csects can be at arbitrary places in memory and that
3384 the GLOBAL_BLOCK of a symtab has a begin and end address). */
3386 /* BEST is the smallest linenumber > LINE so far seen,
3387 or 0 if none has been seen so far.
3388 BEST_INDEX and BEST_LINETABLE identify the item for it. */
3391 if (best_index
>= 0)
3392 best
= best_linetable
->item
[best_index
].line
;
3396 for (objfile
*objfile
: current_program_space
->objfiles ())
3399 objfile
->sf
->qf
->expand_symtabs_with_fullname
3400 (objfile
, symtab_to_fullname (sym_tab
));
3403 for (objfile
*objfile
: current_program_space
->objfiles ())
3405 for (compunit_symtab
*cu
: objfile
->compunits ())
3407 for (symtab
*s
: compunit_filetabs (cu
))
3409 struct linetable
*l
;
3412 if (FILENAME_CMP (sym_tab
->filename
, s
->filename
) != 0)
3414 if (FILENAME_CMP (symtab_to_fullname (sym_tab
),
3415 symtab_to_fullname (s
)) != 0)
3417 l
= SYMTAB_LINETABLE (s
);
3418 ind
= find_line_common (l
, line
, &exact
, 0);
3428 if (best
== 0 || l
->item
[ind
].line
< best
)
3430 best
= l
->item
[ind
].line
;
3445 *index
= best_index
;
3447 *exact_match
= (exact
!= 0);
3452 /* Given SYMTAB, returns all the PCs function in the symtab that
3453 exactly match LINE. Returns an empty vector if there are no exact
3454 matches, but updates BEST_ITEM in this case. */
3456 std::vector
<CORE_ADDR
>
3457 find_pcs_for_symtab_line (struct symtab
*symtab
, int line
,
3458 struct linetable_entry
**best_item
)
3461 std::vector
<CORE_ADDR
> result
;
3463 /* First, collect all the PCs that are at this line. */
3469 idx
= find_line_common (SYMTAB_LINETABLE (symtab
), line
, &was_exact
,
3476 struct linetable_entry
*item
= &SYMTAB_LINETABLE (symtab
)->item
[idx
];
3478 if (*best_item
== NULL
3479 || (item
->line
< (*best_item
)->line
&& item
->is_stmt
))
3485 result
.push_back (SYMTAB_LINETABLE (symtab
)->item
[idx
].pc
);
3493 /* Set the PC value for a given source file and line number and return true.
3494 Returns false for invalid line number (and sets the PC to 0).
3495 The source file is specified with a struct symtab. */
3498 find_line_pc (struct symtab
*symtab
, int line
, CORE_ADDR
*pc
)
3500 struct linetable
*l
;
3507 symtab
= find_line_symtab (symtab
, line
, &ind
, NULL
);
3510 l
= SYMTAB_LINETABLE (symtab
);
3511 *pc
= l
->item
[ind
].pc
;
3518 /* Find the range of pc values in a line.
3519 Store the starting pc of the line into *STARTPTR
3520 and the ending pc (start of next line) into *ENDPTR.
3521 Returns true to indicate success.
3522 Returns false if could not find the specified line. */
3525 find_line_pc_range (struct symtab_and_line sal
, CORE_ADDR
*startptr
,
3528 CORE_ADDR startaddr
;
3529 struct symtab_and_line found_sal
;
3532 if (startaddr
== 0 && !find_line_pc (sal
.symtab
, sal
.line
, &startaddr
))
3535 /* This whole function is based on address. For example, if line 10 has
3536 two parts, one from 0x100 to 0x200 and one from 0x300 to 0x400, then
3537 "info line *0x123" should say the line goes from 0x100 to 0x200
3538 and "info line *0x355" should say the line goes from 0x300 to 0x400.
3539 This also insures that we never give a range like "starts at 0x134
3540 and ends at 0x12c". */
3542 found_sal
= find_pc_sect_line (startaddr
, sal
.section
, 0);
3543 if (found_sal
.line
!= sal
.line
)
3545 /* The specified line (sal) has zero bytes. */
3546 *startptr
= found_sal
.pc
;
3547 *endptr
= found_sal
.pc
;
3551 *startptr
= found_sal
.pc
;
3552 *endptr
= found_sal
.end
;
3557 /* Given a line table and a line number, return the index into the line
3558 table for the pc of the nearest line whose number is >= the specified one.
3559 Return -1 if none is found. The value is >= 0 if it is an index.
3560 START is the index at which to start searching the line table.
3562 Set *EXACT_MATCH nonzero if the value returned is an exact match. */
3565 find_line_common (struct linetable
*l
, int lineno
,
3566 int *exact_match
, int start
)
3571 /* BEST is the smallest linenumber > LINENO so far seen,
3572 or 0 if none has been seen so far.
3573 BEST_INDEX identifies the item for it. */
3575 int best_index
= -1;
3586 for (i
= start
; i
< len
; i
++)
3588 struct linetable_entry
*item
= &(l
->item
[i
]);
3590 /* Ignore non-statements. */
3594 if (item
->line
== lineno
)
3596 /* Return the first (lowest address) entry which matches. */
3601 if (item
->line
> lineno
&& (best
== 0 || item
->line
< best
))
3608 /* If we got here, we didn't get an exact match. */
3613 find_pc_line_pc_range (CORE_ADDR pc
, CORE_ADDR
*startptr
, CORE_ADDR
*endptr
)
3615 struct symtab_and_line sal
;
3617 sal
= find_pc_line (pc
, 0);
3620 return sal
.symtab
!= 0;
3623 /* Helper for find_function_start_sal. Does most of the work, except
3624 setting the sal's symbol. */
3626 static symtab_and_line
3627 find_function_start_sal_1 (CORE_ADDR func_addr
, obj_section
*section
,
3630 symtab_and_line sal
= find_pc_sect_line (func_addr
, section
, 0);
3632 if (funfirstline
&& sal
.symtab
!= NULL
3633 && (COMPUNIT_LOCATIONS_VALID (SYMTAB_COMPUNIT (sal
.symtab
))
3634 || SYMTAB_LANGUAGE (sal
.symtab
) == language_asm
))
3636 struct gdbarch
*gdbarch
= SYMTAB_OBJFILE (sal
.symtab
)->arch ();
3639 if (gdbarch_skip_entrypoint_p (gdbarch
))
3640 sal
.pc
= gdbarch_skip_entrypoint (gdbarch
, sal
.pc
);
3644 /* We always should have a line for the function start address.
3645 If we don't, something is odd. Create a plain SAL referring
3646 just the PC and hope that skip_prologue_sal (if requested)
3647 can find a line number for after the prologue. */
3648 if (sal
.pc
< func_addr
)
3651 sal
.pspace
= current_program_space
;
3653 sal
.section
= section
;
3657 skip_prologue_sal (&sal
);
3665 find_function_start_sal (CORE_ADDR func_addr
, obj_section
*section
,
3669 = find_function_start_sal_1 (func_addr
, section
, funfirstline
);
3671 /* find_function_start_sal_1 does a linetable search, so it finds
3672 the symtab and linenumber, but not a symbol. Fill in the
3673 function symbol too. */
3674 sal
.symbol
= find_pc_sect_containing_function (sal
.pc
, sal
.section
);
3682 find_function_start_sal (symbol
*sym
, bool funfirstline
)
3684 fixup_symbol_section (sym
, NULL
);
3686 = find_function_start_sal_1 (BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
)),
3687 SYMBOL_OBJ_SECTION (symbol_objfile (sym
), sym
),
3694 /* Given a function start address FUNC_ADDR and SYMTAB, find the first
3695 address for that function that has an entry in SYMTAB's line info
3696 table. If such an entry cannot be found, return FUNC_ADDR
3700 skip_prologue_using_lineinfo (CORE_ADDR func_addr
, struct symtab
*symtab
)
3702 CORE_ADDR func_start
, func_end
;
3703 struct linetable
*l
;
3706 /* Give up if this symbol has no lineinfo table. */
3707 l
= SYMTAB_LINETABLE (symtab
);
3711 /* Get the range for the function's PC values, or give up if we
3712 cannot, for some reason. */
3713 if (!find_pc_partial_function (func_addr
, NULL
, &func_start
, &func_end
))
3716 /* Linetable entries are ordered by PC values, see the commentary in
3717 symtab.h where `struct linetable' is defined. Thus, the first
3718 entry whose PC is in the range [FUNC_START..FUNC_END[ is the
3719 address we are looking for. */
3720 for (i
= 0; i
< l
->nitems
; i
++)
3722 struct linetable_entry
*item
= &(l
->item
[i
]);
3724 /* Don't use line numbers of zero, they mark special entries in
3725 the table. See the commentary on symtab.h before the
3726 definition of struct linetable. */
3727 if (item
->line
> 0 && func_start
<= item
->pc
&& item
->pc
< func_end
)
3734 /* Adjust SAL to the first instruction past the function prologue.
3735 If the PC was explicitly specified, the SAL is not changed.
3736 If the line number was explicitly specified then the SAL can still be
3737 updated, unless the language for SAL is assembler, in which case the SAL
3738 will be left unchanged.
3739 If SAL is already past the prologue, then do nothing. */
3742 skip_prologue_sal (struct symtab_and_line
*sal
)
3745 struct symtab_and_line start_sal
;
3746 CORE_ADDR pc
, saved_pc
;
3747 struct obj_section
*section
;
3749 struct objfile
*objfile
;
3750 struct gdbarch
*gdbarch
;
3751 const struct block
*b
, *function_block
;
3752 int force_skip
, skip
;
3754 /* Do not change the SAL if PC was specified explicitly. */
3755 if (sal
->explicit_pc
)
3758 /* In assembly code, if the user asks for a specific line then we should
3759 not adjust the SAL. The user already has instruction level
3760 visibility in this case, so selecting a line other than one requested
3761 is likely to be the wrong choice. */
3762 if (sal
->symtab
!= nullptr
3763 && sal
->explicit_line
3764 && SYMTAB_LANGUAGE (sal
->symtab
) == language_asm
)
3767 scoped_restore_current_pspace_and_thread restore_pspace_thread
;
3769 switch_to_program_space_and_thread (sal
->pspace
);
3771 sym
= find_pc_sect_function (sal
->pc
, sal
->section
);
3774 fixup_symbol_section (sym
, NULL
);
3776 objfile
= symbol_objfile (sym
);
3777 pc
= BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
));
3778 section
= SYMBOL_OBJ_SECTION (objfile
, sym
);
3779 name
= sym
->linkage_name ();
3783 struct bound_minimal_symbol msymbol
3784 = lookup_minimal_symbol_by_pc_section (sal
->pc
, sal
->section
);
3786 if (msymbol
.minsym
== NULL
)
3789 objfile
= msymbol
.objfile
;
3790 pc
= BMSYMBOL_VALUE_ADDRESS (msymbol
);
3791 section
= MSYMBOL_OBJ_SECTION (objfile
, msymbol
.minsym
);
3792 name
= msymbol
.minsym
->linkage_name ();
3795 gdbarch
= objfile
->arch ();
3797 /* Process the prologue in two passes. In the first pass try to skip the
3798 prologue (SKIP is true) and verify there is a real need for it (indicated
3799 by FORCE_SKIP). If no such reason was found run a second pass where the
3800 prologue is not skipped (SKIP is false). */
3805 /* Be conservative - allow direct PC (without skipping prologue) only if we
3806 have proven the CU (Compilation Unit) supports it. sal->SYMTAB does not
3807 have to be set by the caller so we use SYM instead. */
3809 && COMPUNIT_LOCATIONS_VALID (SYMTAB_COMPUNIT (symbol_symtab (sym
))))
3817 /* If the function is in an unmapped overlay, use its unmapped LMA address,
3818 so that gdbarch_skip_prologue has something unique to work on. */
3819 if (section_is_overlay (section
) && !section_is_mapped (section
))
3820 pc
= overlay_unmapped_address (pc
, section
);
3822 /* Skip "first line" of function (which is actually its prologue). */
3823 pc
+= gdbarch_deprecated_function_start_offset (gdbarch
);
3824 if (gdbarch_skip_entrypoint_p (gdbarch
))
3825 pc
= gdbarch_skip_entrypoint (gdbarch
, pc
);
3827 pc
= gdbarch_skip_prologue_noexcept (gdbarch
, pc
);
3829 /* For overlays, map pc back into its mapped VMA range. */
3830 pc
= overlay_mapped_address (pc
, section
);
3832 /* Calculate line number. */
3833 start_sal
= find_pc_sect_line (pc
, section
, 0);
3835 /* Check if gdbarch_skip_prologue left us in mid-line, and the next
3836 line is still part of the same function. */
3837 if (skip
&& start_sal
.pc
!= pc
3838 && (sym
? (BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
)) <= start_sal
.end
3839 && start_sal
.end
< BLOCK_END (SYMBOL_BLOCK_VALUE (sym
)))
3840 : (lookup_minimal_symbol_by_pc_section (start_sal
.end
, section
).minsym
3841 == lookup_minimal_symbol_by_pc_section (pc
, section
).minsym
)))
3843 /* First pc of next line */
3845 /* Recalculate the line number (might not be N+1). */
3846 start_sal
= find_pc_sect_line (pc
, section
, 0);
3849 /* On targets with executable formats that don't have a concept of
3850 constructors (ELF with .init has, PE doesn't), gcc emits a call
3851 to `__main' in `main' between the prologue and before user
3853 if (gdbarch_skip_main_prologue_p (gdbarch
)
3854 && name
&& strcmp_iw (name
, "main") == 0)
3856 pc
= gdbarch_skip_main_prologue (gdbarch
, pc
);
3857 /* Recalculate the line number (might not be N+1). */
3858 start_sal
= find_pc_sect_line (pc
, section
, 0);
3862 while (!force_skip
&& skip
--);
3864 /* If we still don't have a valid source line, try to find the first
3865 PC in the lineinfo table that belongs to the same function. This
3866 happens with COFF debug info, which does not seem to have an
3867 entry in lineinfo table for the code after the prologue which has
3868 no direct relation to source. For example, this was found to be
3869 the case with the DJGPP target using "gcc -gcoff" when the
3870 compiler inserted code after the prologue to make sure the stack
3872 if (!force_skip
&& sym
&& start_sal
.symtab
== NULL
)
3874 pc
= skip_prologue_using_lineinfo (pc
, symbol_symtab (sym
));
3875 /* Recalculate the line number. */
3876 start_sal
= find_pc_sect_line (pc
, section
, 0);
3879 /* If we're already past the prologue, leave SAL unchanged. Otherwise
3880 forward SAL to the end of the prologue. */
3885 sal
->section
= section
;
3886 sal
->symtab
= start_sal
.symtab
;
3887 sal
->line
= start_sal
.line
;
3888 sal
->end
= start_sal
.end
;
3890 /* Check if we are now inside an inlined function. If we can,
3891 use the call site of the function instead. */
3892 b
= block_for_pc_sect (sal
->pc
, sal
->section
);
3893 function_block
= NULL
;
3896 if (BLOCK_FUNCTION (b
) != NULL
&& block_inlined_p (b
))
3898 else if (BLOCK_FUNCTION (b
) != NULL
)
3900 b
= BLOCK_SUPERBLOCK (b
);
3902 if (function_block
!= NULL
3903 && SYMBOL_LINE (BLOCK_FUNCTION (function_block
)) != 0)
3905 sal
->line
= SYMBOL_LINE (BLOCK_FUNCTION (function_block
));
3906 sal
->symtab
= symbol_symtab (BLOCK_FUNCTION (function_block
));
3910 /* Given PC at the function's start address, attempt to find the
3911 prologue end using SAL information. Return zero if the skip fails.
3913 A non-optimized prologue traditionally has one SAL for the function
3914 and a second for the function body. A single line function has
3915 them both pointing at the same line.
3917 An optimized prologue is similar but the prologue may contain
3918 instructions (SALs) from the instruction body. Need to skip those
3919 while not getting into the function body.
3921 The functions end point and an increasing SAL line are used as
3922 indicators of the prologue's endpoint.
3924 This code is based on the function refine_prologue_limit
3928 skip_prologue_using_sal (struct gdbarch
*gdbarch
, CORE_ADDR func_addr
)
3930 struct symtab_and_line prologue_sal
;
3933 const struct block
*bl
;
3935 /* Get an initial range for the function. */
3936 find_pc_partial_function (func_addr
, NULL
, &start_pc
, &end_pc
);
3937 start_pc
+= gdbarch_deprecated_function_start_offset (gdbarch
);
3939 prologue_sal
= find_pc_line (start_pc
, 0);
3940 if (prologue_sal
.line
!= 0)
3942 /* For languages other than assembly, treat two consecutive line
3943 entries at the same address as a zero-instruction prologue.
3944 The GNU assembler emits separate line notes for each instruction
3945 in a multi-instruction macro, but compilers generally will not
3947 if (prologue_sal
.symtab
->language
!= language_asm
)
3949 struct linetable
*linetable
= SYMTAB_LINETABLE (prologue_sal
.symtab
);
3952 /* Skip any earlier lines, and any end-of-sequence marker
3953 from a previous function. */
3954 while (linetable
->item
[idx
].pc
!= prologue_sal
.pc
3955 || linetable
->item
[idx
].line
== 0)
3958 if (idx
+1 < linetable
->nitems
3959 && linetable
->item
[idx
+1].line
!= 0
3960 && linetable
->item
[idx
+1].pc
== start_pc
)
3964 /* If there is only one sal that covers the entire function,
3965 then it is probably a single line function, like
3967 if (prologue_sal
.end
>= end_pc
)
3970 while (prologue_sal
.end
< end_pc
)
3972 struct symtab_and_line sal
;
3974 sal
= find_pc_line (prologue_sal
.end
, 0);
3977 /* Assume that a consecutive SAL for the same (or larger)
3978 line mark the prologue -> body transition. */
3979 if (sal
.line
>= prologue_sal
.line
)
3981 /* Likewise if we are in a different symtab altogether
3982 (e.g. within a file included via #include). */
3983 if (sal
.symtab
!= prologue_sal
.symtab
)
3986 /* The line number is smaller. Check that it's from the
3987 same function, not something inlined. If it's inlined,
3988 then there is no point comparing the line numbers. */
3989 bl
= block_for_pc (prologue_sal
.end
);
3992 if (block_inlined_p (bl
))
3994 if (BLOCK_FUNCTION (bl
))
3999 bl
= BLOCK_SUPERBLOCK (bl
);
4004 /* The case in which compiler's optimizer/scheduler has
4005 moved instructions into the prologue. We look ahead in
4006 the function looking for address ranges whose
4007 corresponding line number is less the first one that we
4008 found for the function. This is more conservative then
4009 refine_prologue_limit which scans a large number of SALs
4010 looking for any in the prologue. */
4015 if (prologue_sal
.end
< end_pc
)
4016 /* Return the end of this line, or zero if we could not find a
4018 return prologue_sal
.end
;
4020 /* Don't return END_PC, which is past the end of the function. */
4021 return prologue_sal
.pc
;
4027 find_function_alias_target (bound_minimal_symbol msymbol
)
4029 CORE_ADDR func_addr
;
4030 if (!msymbol_is_function (msymbol
.objfile
, msymbol
.minsym
, &func_addr
))
4033 symbol
*sym
= find_pc_function (func_addr
);
4035 && SYMBOL_CLASS (sym
) == LOC_BLOCK
4036 && BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
)) == func_addr
)
4043 /* If P is of the form "operator[ \t]+..." where `...' is
4044 some legitimate operator text, return a pointer to the
4045 beginning of the substring of the operator text.
4046 Otherwise, return "". */
4049 operator_chars (const char *p
, const char **end
)
4052 if (!startswith (p
, CP_OPERATOR_STR
))
4054 p
+= CP_OPERATOR_LEN
;
4056 /* Don't get faked out by `operator' being part of a longer
4058 if (isalpha (*p
) || *p
== '_' || *p
== '$' || *p
== '\0')
4061 /* Allow some whitespace between `operator' and the operator symbol. */
4062 while (*p
== ' ' || *p
== '\t')
4065 /* Recognize 'operator TYPENAME'. */
4067 if (isalpha (*p
) || *p
== '_' || *p
== '$')
4069 const char *q
= p
+ 1;
4071 while (isalnum (*q
) || *q
== '_' || *q
== '$')
4080 case '\\': /* regexp quoting */
4083 if (p
[2] == '=') /* 'operator\*=' */
4085 else /* 'operator\*' */
4089 else if (p
[1] == '[')
4092 error (_("mismatched quoting on brackets, "
4093 "try 'operator\\[\\]'"));
4094 else if (p
[2] == '\\' && p
[3] == ']')
4096 *end
= p
+ 4; /* 'operator\[\]' */
4100 error (_("nothing is allowed between '[' and ']'"));
4104 /* Gratuitous quote: skip it and move on. */
4126 if (p
[0] == '-' && p
[1] == '>')
4128 /* Struct pointer member operator 'operator->'. */
4131 *end
= p
+ 3; /* 'operator->*' */
4134 else if (p
[2] == '\\')
4136 *end
= p
+ 4; /* Hopefully 'operator->\*' */
4141 *end
= p
+ 2; /* 'operator->' */
4145 if (p
[1] == '=' || p
[1] == p
[0])
4156 error (_("`operator ()' must be specified "
4157 "without whitespace in `()'"));
4162 error (_("`operator ?:' must be specified "
4163 "without whitespace in `?:'"));
4168 error (_("`operator []' must be specified "
4169 "without whitespace in `[]'"));
4173 error (_("`operator %s' not supported"), p
);
4182 /* What part to match in a file name. */
4184 struct filename_partial_match_opts
4186 /* Only match the directory name part. */
4187 bool dirname
= false;
4189 /* Only match the basename part. */
4190 bool basename
= false;
4193 /* Data structure to maintain printing state for output_source_filename. */
4195 struct output_source_filename_data
4197 /* Output only filenames matching REGEXP. */
4199 gdb::optional
<compiled_regex
> c_regexp
;
4200 /* Possibly only match a part of the filename. */
4201 filename_partial_match_opts partial_match
;
4204 /* Cache of what we've seen so far. */
4205 struct filename_seen_cache
*filename_seen_cache
;
4207 /* Flag of whether we're printing the first one. */
4211 /* Slave routine for sources_info. Force line breaks at ,'s.
4212 NAME is the name to print.
4213 DATA contains the state for printing and watching for duplicates. */
4216 output_source_filename (const char *name
,
4217 struct output_source_filename_data
*data
)
4219 /* Since a single source file can result in several partial symbol
4220 tables, we need to avoid printing it more than once. Note: if
4221 some of the psymtabs are read in and some are not, it gets
4222 printed both under "Source files for which symbols have been
4223 read" and "Source files for which symbols will be read in on
4224 demand". I consider this a reasonable way to deal with the
4225 situation. I'm not sure whether this can also happen for
4226 symtabs; it doesn't hurt to check. */
4228 /* Was NAME already seen? */
4229 if (data
->filename_seen_cache
->seen (name
))
4231 /* Yes; don't print it again. */
4235 /* Does it match data->regexp? */
4236 if (data
->c_regexp
.has_value ())
4238 const char *to_match
;
4239 std::string dirname
;
4241 if (data
->partial_match
.dirname
)
4243 dirname
= ldirname (name
);
4244 to_match
= dirname
.c_str ();
4246 else if (data
->partial_match
.basename
)
4247 to_match
= lbasename (name
);
4251 if (data
->c_regexp
->exec (to_match
, 0, NULL
, 0) != 0)
4255 /* Print it and reset *FIRST. */
4257 printf_filtered (", ");
4261 fputs_styled (name
, file_name_style
.style (), gdb_stdout
);
4264 /* A callback for map_partial_symbol_filenames. */
4267 output_partial_symbol_filename (const char *filename
, const char *fullname
,
4270 output_source_filename (fullname
? fullname
: filename
,
4271 (struct output_source_filename_data
*) data
);
4274 using isrc_flag_option_def
4275 = gdb::option::flag_option_def
<filename_partial_match_opts
>;
4277 static const gdb::option::option_def info_sources_option_defs
[] = {
4279 isrc_flag_option_def
{
4281 [] (filename_partial_match_opts
*opts
) { return &opts
->dirname
; },
4282 N_("Show only the files having a dirname matching REGEXP."),
4285 isrc_flag_option_def
{
4287 [] (filename_partial_match_opts
*opts
) { return &opts
->basename
; },
4288 N_("Show only the files having a basename matching REGEXP."),
4293 /* Create an option_def_group for the "info sources" options, with
4294 ISRC_OPTS as context. */
4296 static inline gdb::option::option_def_group
4297 make_info_sources_options_def_group (filename_partial_match_opts
*isrc_opts
)
4299 return {{info_sources_option_defs
}, isrc_opts
};
4302 /* Prints the header message for the source files that will be printed
4303 with the matching info present in DATA. SYMBOL_MSG is a message
4304 that tells what will or has been done with the symbols of the
4305 matching source files. */
4308 print_info_sources_header (const char *symbol_msg
,
4309 const struct output_source_filename_data
*data
)
4311 puts_filtered (symbol_msg
);
4312 if (!data
->regexp
.empty ())
4314 if (data
->partial_match
.dirname
)
4315 printf_filtered (_("(dirname matching regular expression \"%s\")"),
4316 data
->regexp
.c_str ());
4317 else if (data
->partial_match
.basename
)
4318 printf_filtered (_("(basename matching regular expression \"%s\")"),
4319 data
->regexp
.c_str ());
4321 printf_filtered (_("(filename matching regular expression \"%s\")"),
4322 data
->regexp
.c_str ());
4324 puts_filtered ("\n");
4327 /* Completer for "info sources". */
4330 info_sources_command_completer (cmd_list_element
*ignore
,
4331 completion_tracker
&tracker
,
4332 const char *text
, const char *word
)
4334 const auto group
= make_info_sources_options_def_group (nullptr);
4335 if (gdb::option::complete_options
4336 (tracker
, &text
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, group
))
4341 info_sources_command (const char *args
, int from_tty
)
4343 struct output_source_filename_data data
;
4345 if (!have_full_symbols () && !have_partial_symbols ())
4347 error (_("No symbol table is loaded. Use the \"file\" command."));
4350 filename_seen_cache filenames_seen
;
4352 auto group
= make_info_sources_options_def_group (&data
.partial_match
);
4354 gdb::option::process_options
4355 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_ERROR
, group
);
4357 if (args
!= NULL
&& *args
!= '\000')
4360 data
.filename_seen_cache
= &filenames_seen
;
4363 if (data
.partial_match
.dirname
&& data
.partial_match
.basename
)
4364 error (_("You cannot give both -basename and -dirname to 'info sources'."));
4365 if ((data
.partial_match
.dirname
|| data
.partial_match
.basename
)
4366 && data
.regexp
.empty ())
4367 error (_("Missing REGEXP for 'info sources'."));
4369 if (data
.regexp
.empty ())
4370 data
.c_regexp
.reset ();
4373 int cflags
= REG_NOSUB
;
4374 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
4375 cflags
|= REG_ICASE
;
4377 data
.c_regexp
.emplace (data
.regexp
.c_str (), cflags
,
4378 _("Invalid regexp"));
4381 print_info_sources_header
4382 (_("Source files for which symbols have been read in:\n"), &data
);
4384 for (objfile
*objfile
: current_program_space
->objfiles ())
4386 for (compunit_symtab
*cu
: objfile
->compunits ())
4388 for (symtab
*s
: compunit_filetabs (cu
))
4390 const char *fullname
= symtab_to_fullname (s
);
4392 output_source_filename (fullname
, &data
);
4396 printf_filtered ("\n\n");
4398 print_info_sources_header
4399 (_("Source files for which symbols will be read in on demand:\n"), &data
);
4401 filenames_seen
.clear ();
4403 map_symbol_filenames (output_partial_symbol_filename
, &data
,
4404 1 /*need_fullname*/);
4405 printf_filtered ("\n");
4408 /* Compare FILE against all the entries of FILENAMES. If BASENAMES is
4409 true compare only lbasename of FILENAMES. */
4412 file_matches (const char *file
, const std::vector
<const char *> &filenames
,
4415 if (filenames
.empty ())
4418 for (const char *name
: filenames
)
4420 name
= (basenames
? lbasename (name
) : name
);
4421 if (compare_filenames_for_search (file
, name
))
4428 /* Helper function for std::sort on symbol_search objects. Can only sort
4429 symbols, not minimal symbols. */
4432 symbol_search::compare_search_syms (const symbol_search
&sym_a
,
4433 const symbol_search
&sym_b
)
4437 c
= FILENAME_CMP (symbol_symtab (sym_a
.symbol
)->filename
,
4438 symbol_symtab (sym_b
.symbol
)->filename
);
4442 if (sym_a
.block
!= sym_b
.block
)
4443 return sym_a
.block
- sym_b
.block
;
4445 return strcmp (sym_a
.symbol
->print_name (), sym_b
.symbol
->print_name ());
4448 /* Returns true if the type_name of symbol_type of SYM matches TREG.
4449 If SYM has no symbol_type or symbol_name, returns false. */
4452 treg_matches_sym_type_name (const compiled_regex
&treg
,
4453 const struct symbol
*sym
)
4455 struct type
*sym_type
;
4456 std::string printed_sym_type_name
;
4458 if (symbol_lookup_debug
> 1)
4460 fprintf_unfiltered (gdb_stdlog
,
4461 "treg_matches_sym_type_name\n sym %s\n",
4462 sym
->natural_name ());
4465 sym_type
= SYMBOL_TYPE (sym
);
4466 if (sym_type
== NULL
)
4470 scoped_switch_to_sym_language_if_auto
l (sym
);
4472 printed_sym_type_name
= type_to_string (sym_type
);
4476 if (symbol_lookup_debug
> 1)
4478 fprintf_unfiltered (gdb_stdlog
,
4479 " sym_type_name %s\n",
4480 printed_sym_type_name
.c_str ());
4484 if (printed_sym_type_name
.empty ())
4487 return treg
.exec (printed_sym_type_name
.c_str (), 0, NULL
, 0) == 0;
4493 global_symbol_searcher::is_suitable_msymbol
4494 (const enum search_domain kind
, const minimal_symbol
*msymbol
)
4496 switch (MSYMBOL_TYPE (msymbol
))
4502 return kind
== VARIABLES_DOMAIN
;
4505 case mst_solib_trampoline
:
4506 case mst_text_gnu_ifunc
:
4507 return kind
== FUNCTIONS_DOMAIN
;
4516 global_symbol_searcher::expand_symtabs
4517 (objfile
*objfile
, const gdb::optional
<compiled_regex
> &preg
) const
4519 enum search_domain kind
= m_kind
;
4520 bool found_msymbol
= false;
4523 objfile
->sf
->qf
->expand_symtabs_matching
4525 [&] (const char *filename
, bool basenames
)
4527 return file_matches (filename
, filenames
, basenames
);
4529 &lookup_name_info::match_any (),
4530 [&] (const char *symname
)
4532 return (!preg
.has_value ()
4533 || preg
->exec (symname
, 0, NULL
, 0) == 0);
4538 /* Here, we search through the minimal symbol tables for functions and
4539 variables that match, and force their symbols to be read. This is in
4540 particular necessary for demangled variable names, which are no longer
4541 put into the partial symbol tables. The symbol will then be found
4542 during the scan of symtabs later.
4544 For functions, find_pc_symtab should succeed if we have debug info for
4545 the function, for variables we have to call
4546 lookup_symbol_in_objfile_from_linkage_name to determine if the
4547 variable has debug info. If the lookup fails, set found_msymbol so
4548 that we will rescan to print any matching symbols without debug info.
4549 We only search the objfile the msymbol came from, we no longer search
4550 all objfiles. In large programs (1000s of shared libs) searching all
4551 objfiles is not worth the pain. */
4552 if (filenames
.empty ()
4553 && (kind
== VARIABLES_DOMAIN
|| kind
== FUNCTIONS_DOMAIN
))
4555 for (minimal_symbol
*msymbol
: objfile
->msymbols ())
4559 if (msymbol
->created_by_gdb
)
4562 if (is_suitable_msymbol (kind
, msymbol
))
4564 if (!preg
.has_value ()
4565 || preg
->exec (msymbol
->natural_name (), 0,
4568 /* An important side-effect of these lookup functions is
4569 to expand the symbol table if msymbol is found, later
4570 in the process we will add matching symbols or
4571 msymbols to the results list, and that requires that
4572 the symbols tables are expanded. */
4573 if (kind
== FUNCTIONS_DOMAIN
4574 ? (find_pc_compunit_symtab
4575 (MSYMBOL_VALUE_ADDRESS (objfile
, msymbol
))
4577 : (lookup_symbol_in_objfile_from_linkage_name
4578 (objfile
, msymbol
->linkage_name (),
4581 found_msymbol
= true;
4587 return found_msymbol
;
4593 global_symbol_searcher::add_matching_symbols
4595 const gdb::optional
<compiled_regex
> &preg
,
4596 const gdb::optional
<compiled_regex
> &treg
,
4597 std::set
<symbol_search
> *result_set
) const
4599 enum search_domain kind
= m_kind
;
4601 /* Add matching symbols (if not already present). */
4602 for (compunit_symtab
*cust
: objfile
->compunits ())
4604 const struct blockvector
*bv
= COMPUNIT_BLOCKVECTOR (cust
);
4606 for (block_enum block
: { GLOBAL_BLOCK
, STATIC_BLOCK
})
4608 struct block_iterator iter
;
4610 const struct block
*b
= BLOCKVECTOR_BLOCK (bv
, block
);
4612 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
4614 struct symtab
*real_symtab
= symbol_symtab (sym
);
4618 /* Check first sole REAL_SYMTAB->FILENAME. It does
4619 not need to be a substring of symtab_to_fullname as
4620 it may contain "./" etc. */
4621 if ((file_matches (real_symtab
->filename
, filenames
, false)
4622 || ((basenames_may_differ
4623 || file_matches (lbasename (real_symtab
->filename
),
4625 && file_matches (symtab_to_fullname (real_symtab
),
4627 && ((!preg
.has_value ()
4628 || preg
->exec (sym
->natural_name (), 0,
4630 && ((kind
== VARIABLES_DOMAIN
4631 && SYMBOL_CLASS (sym
) != LOC_TYPEDEF
4632 && SYMBOL_CLASS (sym
) != LOC_UNRESOLVED
4633 && SYMBOL_CLASS (sym
) != LOC_BLOCK
4634 /* LOC_CONST can be used for more than
4635 just enums, e.g., c++ static const
4636 members. We only want to skip enums
4638 && !(SYMBOL_CLASS (sym
) == LOC_CONST
4639 && (SYMBOL_TYPE (sym
)->code ()
4641 && (!treg
.has_value ()
4642 || treg_matches_sym_type_name (*treg
, sym
)))
4643 || (kind
== FUNCTIONS_DOMAIN
4644 && SYMBOL_CLASS (sym
) == LOC_BLOCK
4645 && (!treg
.has_value ()
4646 || treg_matches_sym_type_name (*treg
,
4648 || (kind
== TYPES_DOMAIN
4649 && SYMBOL_CLASS (sym
) == LOC_TYPEDEF
4650 && SYMBOL_DOMAIN (sym
) != MODULE_DOMAIN
)
4651 || (kind
== MODULES_DOMAIN
4652 && SYMBOL_DOMAIN (sym
) == MODULE_DOMAIN
4653 && SYMBOL_LINE (sym
) != 0))))
4655 if (result_set
->size () < m_max_search_results
)
4657 /* Match, insert if not already in the results. */
4658 symbol_search
ss (block
, sym
);
4659 if (result_set
->find (ss
) == result_set
->end ())
4660 result_set
->insert (ss
);
4675 global_symbol_searcher::add_matching_msymbols
4676 (objfile
*objfile
, const gdb::optional
<compiled_regex
> &preg
,
4677 std::vector
<symbol_search
> *results
) const
4679 enum search_domain kind
= m_kind
;
4681 for (minimal_symbol
*msymbol
: objfile
->msymbols ())
4685 if (msymbol
->created_by_gdb
)
4688 if (is_suitable_msymbol (kind
, msymbol
))
4690 if (!preg
.has_value ()
4691 || preg
->exec (msymbol
->natural_name (), 0,
4694 /* For functions we can do a quick check of whether the
4695 symbol might be found via find_pc_symtab. */
4696 if (kind
!= FUNCTIONS_DOMAIN
4697 || (find_pc_compunit_symtab
4698 (MSYMBOL_VALUE_ADDRESS (objfile
, msymbol
))
4701 if (lookup_symbol_in_objfile_from_linkage_name
4702 (objfile
, msymbol
->linkage_name (),
4703 VAR_DOMAIN
).symbol
== NULL
)
4705 /* Matching msymbol, add it to the results list. */
4706 if (results
->size () < m_max_search_results
)
4707 results
->emplace_back (GLOBAL_BLOCK
, msymbol
, objfile
);
4721 std::vector
<symbol_search
>
4722 global_symbol_searcher::search () const
4724 gdb::optional
<compiled_regex
> preg
;
4725 gdb::optional
<compiled_regex
> treg
;
4727 gdb_assert (m_kind
!= ALL_DOMAIN
);
4729 if (m_symbol_name_regexp
!= NULL
)
4731 const char *symbol_name_regexp
= m_symbol_name_regexp
;
4733 /* Make sure spacing is right for C++ operators.
4734 This is just a courtesy to make the matching less sensitive
4735 to how many spaces the user leaves between 'operator'
4736 and <TYPENAME> or <OPERATOR>. */
4738 const char *opname
= operator_chars (symbol_name_regexp
, &opend
);
4742 int fix
= -1; /* -1 means ok; otherwise number of
4745 if (isalpha (*opname
) || *opname
== '_' || *opname
== '$')
4747 /* There should 1 space between 'operator' and 'TYPENAME'. */
4748 if (opname
[-1] != ' ' || opname
[-2] == ' ')
4753 /* There should 0 spaces between 'operator' and 'OPERATOR'. */
4754 if (opname
[-1] == ' ')
4757 /* If wrong number of spaces, fix it. */
4760 char *tmp
= (char *) alloca (8 + fix
+ strlen (opname
) + 1);
4762 sprintf (tmp
, "operator%.*s%s", fix
, " ", opname
);
4763 symbol_name_regexp
= tmp
;
4767 int cflags
= REG_NOSUB
| (case_sensitivity
== case_sensitive_off
4769 preg
.emplace (symbol_name_regexp
, cflags
,
4770 _("Invalid regexp"));
4773 if (m_symbol_type_regexp
!= NULL
)
4775 int cflags
= REG_NOSUB
| (case_sensitivity
== case_sensitive_off
4777 treg
.emplace (m_symbol_type_regexp
, cflags
,
4778 _("Invalid regexp"));
4781 bool found_msymbol
= false;
4782 std::set
<symbol_search
> result_set
;
4783 for (objfile
*objfile
: current_program_space
->objfiles ())
4785 /* Expand symtabs within objfile that possibly contain matching
4787 found_msymbol
|= expand_symtabs (objfile
, preg
);
4789 /* Find matching symbols within OBJFILE and add them in to the
4790 RESULT_SET set. Use a set here so that we can easily detect
4791 duplicates as we go, and can therefore track how many unique
4792 matches we have found so far. */
4793 if (!add_matching_symbols (objfile
, preg
, treg
, &result_set
))
4797 /* Convert the result set into a sorted result list, as std::set is
4798 defined to be sorted then no explicit call to std::sort is needed. */
4799 std::vector
<symbol_search
> result (result_set
.begin (), result_set
.end ());
4801 /* If there are no debug symbols, then add matching minsyms. But if the
4802 user wants to see symbols matching a type regexp, then never give a
4803 minimal symbol, as we assume that a minimal symbol does not have a
4805 if ((found_msymbol
|| (filenames
.empty () && m_kind
== VARIABLES_DOMAIN
))
4806 && !m_exclude_minsyms
4807 && !treg
.has_value ())
4809 gdb_assert (m_kind
== VARIABLES_DOMAIN
|| m_kind
== FUNCTIONS_DOMAIN
);
4810 for (objfile
*objfile
: current_program_space
->objfiles ())
4811 if (!add_matching_msymbols (objfile
, preg
, &result
))
4821 symbol_to_info_string (struct symbol
*sym
, int block
,
4822 enum search_domain kind
)
4826 gdb_assert (block
== GLOBAL_BLOCK
|| block
== STATIC_BLOCK
);
4828 if (kind
!= TYPES_DOMAIN
&& block
== STATIC_BLOCK
)
4831 /* Typedef that is not a C++ class. */
4832 if (kind
== TYPES_DOMAIN
4833 && SYMBOL_DOMAIN (sym
) != STRUCT_DOMAIN
)
4835 string_file tmp_stream
;
4837 /* FIXME: For C (and C++) we end up with a difference in output here
4838 between how a typedef is printed, and non-typedefs are printed.
4839 The TYPEDEF_PRINT code places a ";" at the end in an attempt to
4840 appear C-like, while TYPE_PRINT doesn't.
4842 For the struct printing case below, things are worse, we force
4843 printing of the ";" in this function, which is going to be wrong
4844 for languages that don't require a ";" between statements. */
4845 if (SYMBOL_TYPE (sym
)->code () == TYPE_CODE_TYPEDEF
)
4846 typedef_print (SYMBOL_TYPE (sym
), sym
, &tmp_stream
);
4848 type_print (SYMBOL_TYPE (sym
), "", &tmp_stream
, -1);
4849 str
+= tmp_stream
.string ();
4851 /* variable, func, or typedef-that-is-c++-class. */
4852 else if (kind
< TYPES_DOMAIN
4853 || (kind
== TYPES_DOMAIN
4854 && SYMBOL_DOMAIN (sym
) == STRUCT_DOMAIN
))
4856 string_file tmp_stream
;
4858 type_print (SYMBOL_TYPE (sym
),
4859 (SYMBOL_CLASS (sym
) == LOC_TYPEDEF
4860 ? "" : sym
->print_name ()),
4863 str
+= tmp_stream
.string ();
4866 /* Printing of modules is currently done here, maybe at some future
4867 point we might want a language specific method to print the module
4868 symbol so that we can customise the output more. */
4869 else if (kind
== MODULES_DOMAIN
)
4870 str
+= sym
->print_name ();
4875 /* Helper function for symbol info commands, for example 'info functions',
4876 'info variables', etc. KIND is the kind of symbol we searched for, and
4877 BLOCK is the type of block the symbols was found in, either GLOBAL_BLOCK
4878 or STATIC_BLOCK. SYM is the symbol we found. If LAST is not NULL,
4879 print file and line number information for the symbol as well. Skip
4880 printing the filename if it matches LAST. */
4883 print_symbol_info (enum search_domain kind
,
4885 int block
, const char *last
)
4887 scoped_switch_to_sym_language_if_auto
l (sym
);
4888 struct symtab
*s
= symbol_symtab (sym
);
4892 const char *s_filename
= symtab_to_filename_for_display (s
);
4894 if (filename_cmp (last
, s_filename
) != 0)
4896 printf_filtered (_("\nFile %ps:\n"),
4897 styled_string (file_name_style
.style (),
4901 if (SYMBOL_LINE (sym
) != 0)
4902 printf_filtered ("%d:\t", SYMBOL_LINE (sym
));
4904 puts_filtered ("\t");
4907 std::string str
= symbol_to_info_string (sym
, block
, kind
);
4908 printf_filtered ("%s\n", str
.c_str ());
4911 /* This help function for symtab_symbol_info() prints information
4912 for non-debugging symbols to gdb_stdout. */
4915 print_msymbol_info (struct bound_minimal_symbol msymbol
)
4917 struct gdbarch
*gdbarch
= msymbol
.objfile
->arch ();
4920 if (gdbarch_addr_bit (gdbarch
) <= 32)
4921 tmp
= hex_string_custom (BMSYMBOL_VALUE_ADDRESS (msymbol
)
4922 & (CORE_ADDR
) 0xffffffff,
4925 tmp
= hex_string_custom (BMSYMBOL_VALUE_ADDRESS (msymbol
),
4928 ui_file_style sym_style
= (msymbol
.minsym
->text_p ()
4929 ? function_name_style
.style ()
4930 : ui_file_style ());
4932 printf_filtered (_("%ps %ps\n"),
4933 styled_string (address_style
.style (), tmp
),
4934 styled_string (sym_style
, msymbol
.minsym
->print_name ()));
4937 /* This is the guts of the commands "info functions", "info types", and
4938 "info variables". It calls search_symbols to find all matches and then
4939 print_[m]symbol_info to print out some useful information about the
4943 symtab_symbol_info (bool quiet
, bool exclude_minsyms
,
4944 const char *regexp
, enum search_domain kind
,
4945 const char *t_regexp
, int from_tty
)
4947 static const char * const classnames
[] =
4948 {"variable", "function", "type", "module"};
4949 const char *last_filename
= "";
4952 gdb_assert (kind
!= ALL_DOMAIN
);
4954 if (regexp
!= nullptr && *regexp
== '\0')
4957 global_symbol_searcher
spec (kind
, regexp
);
4958 spec
.set_symbol_type_regexp (t_regexp
);
4959 spec
.set_exclude_minsyms (exclude_minsyms
);
4960 std::vector
<symbol_search
> symbols
= spec
.search ();
4966 if (t_regexp
!= NULL
)
4968 (_("All %ss matching regular expression \"%s\""
4969 " with type matching regular expression \"%s\":\n"),
4970 classnames
[kind
], regexp
, t_regexp
);
4972 printf_filtered (_("All %ss matching regular expression \"%s\":\n"),
4973 classnames
[kind
], regexp
);
4977 if (t_regexp
!= NULL
)
4979 (_("All defined %ss"
4980 " with type matching regular expression \"%s\" :\n"),
4981 classnames
[kind
], t_regexp
);
4983 printf_filtered (_("All defined %ss:\n"), classnames
[kind
]);
4987 for (const symbol_search
&p
: symbols
)
4991 if (p
.msymbol
.minsym
!= NULL
)
4996 printf_filtered (_("\nNon-debugging symbols:\n"));
4999 print_msymbol_info (p
.msymbol
);
5003 print_symbol_info (kind
,
5008 = symtab_to_filename_for_display (symbol_symtab (p
.symbol
));
5013 /* Structure to hold the values of the options used by the 'info variables'
5014 and 'info functions' commands. These correspond to the -q, -t, and -n
5017 struct info_vars_funcs_options
5020 bool exclude_minsyms
= false;
5021 char *type_regexp
= nullptr;
5023 ~info_vars_funcs_options ()
5025 xfree (type_regexp
);
5029 /* The options used by the 'info variables' and 'info functions'
5032 static const gdb::option::option_def info_vars_funcs_options_defs
[] = {
5033 gdb::option::boolean_option_def
<info_vars_funcs_options
> {
5035 [] (info_vars_funcs_options
*opt
) { return &opt
->quiet
; },
5036 nullptr, /* show_cmd_cb */
5037 nullptr /* set_doc */
5040 gdb::option::boolean_option_def
<info_vars_funcs_options
> {
5042 [] (info_vars_funcs_options
*opt
) { return &opt
->exclude_minsyms
; },
5043 nullptr, /* show_cmd_cb */
5044 nullptr /* set_doc */
5047 gdb::option::string_option_def
<info_vars_funcs_options
> {
5049 [] (info_vars_funcs_options
*opt
) { return &opt
->type_regexp
;
5051 nullptr, /* show_cmd_cb */
5052 nullptr /* set_doc */
5056 /* Returns the option group used by 'info variables' and 'info
5059 static gdb::option::option_def_group
5060 make_info_vars_funcs_options_def_group (info_vars_funcs_options
*opts
)
5062 return {{info_vars_funcs_options_defs
}, opts
};
5065 /* Command completer for 'info variables' and 'info functions'. */
5068 info_vars_funcs_command_completer (struct cmd_list_element
*ignore
,
5069 completion_tracker
&tracker
,
5070 const char *text
, const char * /* word */)
5073 = make_info_vars_funcs_options_def_group (nullptr);
5074 if (gdb::option::complete_options
5075 (tracker
, &text
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, group
))
5078 const char *word
= advance_to_expression_complete_word_point (tracker
, text
);
5079 symbol_completer (ignore
, tracker
, text
, word
);
5082 /* Implement the 'info variables' command. */
5085 info_variables_command (const char *args
, int from_tty
)
5087 info_vars_funcs_options opts
;
5088 auto grp
= make_info_vars_funcs_options_def_group (&opts
);
5089 gdb::option::process_options
5090 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
5091 if (args
!= nullptr && *args
== '\0')
5094 symtab_symbol_info (opts
.quiet
, opts
.exclude_minsyms
, args
, VARIABLES_DOMAIN
,
5095 opts
.type_regexp
, from_tty
);
5098 /* Implement the 'info functions' command. */
5101 info_functions_command (const char *args
, int from_tty
)
5103 info_vars_funcs_options opts
;
5105 auto grp
= make_info_vars_funcs_options_def_group (&opts
);
5106 gdb::option::process_options
5107 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
5108 if (args
!= nullptr && *args
== '\0')
5111 symtab_symbol_info (opts
.quiet
, opts
.exclude_minsyms
, args
,
5112 FUNCTIONS_DOMAIN
, opts
.type_regexp
, from_tty
);
5115 /* Holds the -q option for the 'info types' command. */
5117 struct info_types_options
5122 /* The options used by the 'info types' command. */
5124 static const gdb::option::option_def info_types_options_defs
[] = {
5125 gdb::option::boolean_option_def
<info_types_options
> {
5127 [] (info_types_options
*opt
) { return &opt
->quiet
; },
5128 nullptr, /* show_cmd_cb */
5129 nullptr /* set_doc */
5133 /* Returns the option group used by 'info types'. */
5135 static gdb::option::option_def_group
5136 make_info_types_options_def_group (info_types_options
*opts
)
5138 return {{info_types_options_defs
}, opts
};
5141 /* Implement the 'info types' command. */
5144 info_types_command (const char *args
, int from_tty
)
5146 info_types_options opts
;
5148 auto grp
= make_info_types_options_def_group (&opts
);
5149 gdb::option::process_options
5150 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
5151 if (args
!= nullptr && *args
== '\0')
5153 symtab_symbol_info (opts
.quiet
, false, args
, TYPES_DOMAIN
, NULL
, from_tty
);
5156 /* Command completer for 'info types' command. */
5159 info_types_command_completer (struct cmd_list_element
*ignore
,
5160 completion_tracker
&tracker
,
5161 const char *text
, const char * /* word */)
5164 = make_info_types_options_def_group (nullptr);
5165 if (gdb::option::complete_options
5166 (tracker
, &text
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, group
))
5169 const char *word
= advance_to_expression_complete_word_point (tracker
, text
);
5170 symbol_completer (ignore
, tracker
, text
, word
);
5173 /* Implement the 'info modules' command. */
5176 info_modules_command (const char *args
, int from_tty
)
5178 info_types_options opts
;
5180 auto grp
= make_info_types_options_def_group (&opts
);
5181 gdb::option::process_options
5182 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
5183 if (args
!= nullptr && *args
== '\0')
5185 symtab_symbol_info (opts
.quiet
, true, args
, MODULES_DOMAIN
, NULL
,
5190 rbreak_command (const char *regexp
, int from_tty
)
5193 const char *file_name
= nullptr;
5195 if (regexp
!= nullptr)
5197 const char *colon
= strchr (regexp
, ':');
5199 if (colon
&& *(colon
+ 1) != ':')
5204 colon_index
= colon
- regexp
;
5205 local_name
= (char *) alloca (colon_index
+ 1);
5206 memcpy (local_name
, regexp
, colon_index
);
5207 local_name
[colon_index
--] = 0;
5208 while (isspace (local_name
[colon_index
]))
5209 local_name
[colon_index
--] = 0;
5210 file_name
= local_name
;
5211 regexp
= skip_spaces (colon
+ 1);
5215 global_symbol_searcher
spec (FUNCTIONS_DOMAIN
, regexp
);
5216 if (file_name
!= nullptr)
5217 spec
.filenames
.push_back (file_name
);
5218 std::vector
<symbol_search
> symbols
= spec
.search ();
5220 scoped_rbreak_breakpoints finalize
;
5221 for (const symbol_search
&p
: symbols
)
5223 if (p
.msymbol
.minsym
== NULL
)
5225 struct symtab
*symtab
= symbol_symtab (p
.symbol
);
5226 const char *fullname
= symtab_to_fullname (symtab
);
5228 string
= string_printf ("%s:'%s'", fullname
,
5229 p
.symbol
->linkage_name ());
5230 break_command (&string
[0], from_tty
);
5231 print_symbol_info (FUNCTIONS_DOMAIN
, p
.symbol
, p
.block
, NULL
);
5235 string
= string_printf ("'%s'",
5236 p
.msymbol
.minsym
->linkage_name ());
5238 break_command (&string
[0], from_tty
);
5239 printf_filtered ("<function, no debug info> %s;\n",
5240 p
.msymbol
.minsym
->print_name ());
5246 /* Evaluate if SYMNAME matches LOOKUP_NAME. */
5249 compare_symbol_name (const char *symbol_name
, language symbol_language
,
5250 const lookup_name_info
&lookup_name
,
5251 completion_match_result
&match_res
)
5253 const language_defn
*lang
= language_def (symbol_language
);
5255 symbol_name_matcher_ftype
*name_match
5256 = get_symbol_name_matcher (lang
, lookup_name
);
5258 return name_match (symbol_name
, lookup_name
, &match_res
);
5264 completion_list_add_name (completion_tracker
&tracker
,
5265 language symbol_language
,
5266 const char *symname
,
5267 const lookup_name_info
&lookup_name
,
5268 const char *text
, const char *word
)
5270 completion_match_result
&match_res
5271 = tracker
.reset_completion_match_result ();
5273 /* Clip symbols that cannot match. */
5274 if (!compare_symbol_name (symname
, symbol_language
, lookup_name
, match_res
))
5277 /* Refresh SYMNAME from the match string. It's potentially
5278 different depending on language. (E.g., on Ada, the match may be
5279 the encoded symbol name wrapped in "<>"). */
5280 symname
= match_res
.match
.match ();
5281 gdb_assert (symname
!= NULL
);
5283 /* We have a match for a completion, so add SYMNAME to the current list
5284 of matches. Note that the name is moved to freshly malloc'd space. */
5287 gdb::unique_xmalloc_ptr
<char> completion
5288 = make_completion_match_str (symname
, text
, word
);
5290 /* Here we pass the match-for-lcd object to add_completion. Some
5291 languages match the user text against substrings of symbol
5292 names in some cases. E.g., in C++, "b push_ba" completes to
5293 "std::vector::push_back", "std::string::push_back", etc., and
5294 in this case we want the completion lowest common denominator
5295 to be "push_back" instead of "std::". */
5296 tracker
.add_completion (std::move (completion
),
5297 &match_res
.match_for_lcd
, text
, word
);
5303 /* completion_list_add_name wrapper for struct symbol. */
5306 completion_list_add_symbol (completion_tracker
&tracker
,
5308 const lookup_name_info
&lookup_name
,
5309 const char *text
, const char *word
)
5311 if (!completion_list_add_name (tracker
, sym
->language (),
5312 sym
->natural_name (),
5313 lookup_name
, text
, word
))
5316 /* C++ function symbols include the parameters within both the msymbol
5317 name and the symbol name. The problem is that the msymbol name will
5318 describe the parameters in the most basic way, with typedefs stripped
5319 out, while the symbol name will represent the types as they appear in
5320 the program. This means we will see duplicate entries in the
5321 completion tracker. The following converts the symbol name back to
5322 the msymbol name and removes the msymbol name from the completion
5324 if (sym
->language () == language_cplus
5325 && SYMBOL_DOMAIN (sym
) == VAR_DOMAIN
5326 && SYMBOL_CLASS (sym
) == LOC_BLOCK
)
5328 /* The call to canonicalize returns the empty string if the input
5329 string is already in canonical form, thanks to this we don't
5330 remove the symbol we just added above. */
5331 gdb::unique_xmalloc_ptr
<char> str
5332 = cp_canonicalize_string_no_typedefs (sym
->natural_name ());
5334 tracker
.remove_completion (str
.get ());
5338 /* completion_list_add_name wrapper for struct minimal_symbol. */
5341 completion_list_add_msymbol (completion_tracker
&tracker
,
5342 minimal_symbol
*sym
,
5343 const lookup_name_info
&lookup_name
,
5344 const char *text
, const char *word
)
5346 completion_list_add_name (tracker
, sym
->language (),
5347 sym
->natural_name (),
5348 lookup_name
, text
, word
);
5352 /* ObjC: In case we are completing on a selector, look as the msymbol
5353 again and feed all the selectors into the mill. */
5356 completion_list_objc_symbol (completion_tracker
&tracker
,
5357 struct minimal_symbol
*msymbol
,
5358 const lookup_name_info
&lookup_name
,
5359 const char *text
, const char *word
)
5361 static char *tmp
= NULL
;
5362 static unsigned int tmplen
= 0;
5364 const char *method
, *category
, *selector
;
5367 method
= msymbol
->natural_name ();
5369 /* Is it a method? */
5370 if ((method
[0] != '-') && (method
[0] != '+'))
5374 /* Complete on shortened method method. */
5375 completion_list_add_name (tracker
, language_objc
,
5380 while ((strlen (method
) + 1) >= tmplen
)
5386 tmp
= (char *) xrealloc (tmp
, tmplen
);
5388 selector
= strchr (method
, ' ');
5389 if (selector
!= NULL
)
5392 category
= strchr (method
, '(');
5394 if ((category
!= NULL
) && (selector
!= NULL
))
5396 memcpy (tmp
, method
, (category
- method
));
5397 tmp
[category
- method
] = ' ';
5398 memcpy (tmp
+ (category
- method
) + 1, selector
, strlen (selector
) + 1);
5399 completion_list_add_name (tracker
, language_objc
, tmp
,
5400 lookup_name
, text
, word
);
5402 completion_list_add_name (tracker
, language_objc
, tmp
+ 1,
5403 lookup_name
, text
, word
);
5406 if (selector
!= NULL
)
5408 /* Complete on selector only. */
5409 strcpy (tmp
, selector
);
5410 tmp2
= strchr (tmp
, ']');
5414 completion_list_add_name (tracker
, language_objc
, tmp
,
5415 lookup_name
, text
, word
);
5419 /* Break the non-quoted text based on the characters which are in
5420 symbols. FIXME: This should probably be language-specific. */
5423 language_search_unquoted_string (const char *text
, const char *p
)
5425 for (; p
> text
; --p
)
5427 if (isalnum (p
[-1]) || p
[-1] == '_' || p
[-1] == '\0')
5431 if ((current_language
->la_language
== language_objc
))
5433 if (p
[-1] == ':') /* Might be part of a method name. */
5435 else if (p
[-1] == '[' && (p
[-2] == '-' || p
[-2] == '+'))
5436 p
-= 2; /* Beginning of a method name. */
5437 else if (p
[-1] == ' ' || p
[-1] == '(' || p
[-1] == ')')
5438 { /* Might be part of a method name. */
5441 /* Seeing a ' ' or a '(' is not conclusive evidence
5442 that we are in the middle of a method name. However,
5443 finding "-[" or "+[" should be pretty un-ambiguous.
5444 Unfortunately we have to find it now to decide. */
5447 if (isalnum (t
[-1]) || t
[-1] == '_' ||
5448 t
[-1] == ' ' || t
[-1] == ':' ||
5449 t
[-1] == '(' || t
[-1] == ')')
5454 if (t
[-1] == '[' && (t
[-2] == '-' || t
[-2] == '+'))
5455 p
= t
- 2; /* Method name detected. */
5456 /* Else we leave with p unchanged. */
5466 completion_list_add_fields (completion_tracker
&tracker
,
5468 const lookup_name_info
&lookup_name
,
5469 const char *text
, const char *word
)
5471 if (SYMBOL_CLASS (sym
) == LOC_TYPEDEF
)
5473 struct type
*t
= SYMBOL_TYPE (sym
);
5474 enum type_code c
= t
->code ();
5477 if (c
== TYPE_CODE_UNION
|| c
== TYPE_CODE_STRUCT
)
5478 for (j
= TYPE_N_BASECLASSES (t
); j
< t
->num_fields (); j
++)
5479 if (TYPE_FIELD_NAME (t
, j
))
5480 completion_list_add_name (tracker
, sym
->language (),
5481 TYPE_FIELD_NAME (t
, j
),
5482 lookup_name
, text
, word
);
5489 symbol_is_function_or_method (symbol
*sym
)
5491 switch (SYMBOL_TYPE (sym
)->code ())
5493 case TYPE_CODE_FUNC
:
5494 case TYPE_CODE_METHOD
:
5504 symbol_is_function_or_method (minimal_symbol
*msymbol
)
5506 switch (MSYMBOL_TYPE (msymbol
))
5509 case mst_text_gnu_ifunc
:
5510 case mst_solib_trampoline
:
5520 bound_minimal_symbol
5521 find_gnu_ifunc (const symbol
*sym
)
5523 if (SYMBOL_CLASS (sym
) != LOC_BLOCK
)
5526 lookup_name_info
lookup_name (sym
->search_name (),
5527 symbol_name_match_type::SEARCH_NAME
);
5528 struct objfile
*objfile
= symbol_objfile (sym
);
5530 CORE_ADDR address
= BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
));
5531 minimal_symbol
*ifunc
= NULL
;
5533 iterate_over_minimal_symbols (objfile
, lookup_name
,
5534 [&] (minimal_symbol
*minsym
)
5536 if (MSYMBOL_TYPE (minsym
) == mst_text_gnu_ifunc
5537 || MSYMBOL_TYPE (minsym
) == mst_data_gnu_ifunc
)
5539 CORE_ADDR msym_addr
= MSYMBOL_VALUE_ADDRESS (objfile
, minsym
);
5540 if (MSYMBOL_TYPE (minsym
) == mst_data_gnu_ifunc
)
5542 struct gdbarch
*gdbarch
= objfile
->arch ();
5544 = gdbarch_convert_from_func_ptr_addr (gdbarch
,
5546 current_top_target ());
5548 if (msym_addr
== address
)
5558 return {ifunc
, objfile
};
5562 /* Add matching symbols from SYMTAB to the current completion list. */
5565 add_symtab_completions (struct compunit_symtab
*cust
,
5566 completion_tracker
&tracker
,
5567 complete_symbol_mode mode
,
5568 const lookup_name_info
&lookup_name
,
5569 const char *text
, const char *word
,
5570 enum type_code code
)
5573 const struct block
*b
;
5574 struct block_iterator iter
;
5580 for (i
= GLOBAL_BLOCK
; i
<= STATIC_BLOCK
; i
++)
5583 b
= BLOCKVECTOR_BLOCK (COMPUNIT_BLOCKVECTOR (cust
), i
);
5584 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
5586 if (completion_skip_symbol (mode
, sym
))
5589 if (code
== TYPE_CODE_UNDEF
5590 || (SYMBOL_DOMAIN (sym
) == STRUCT_DOMAIN
5591 && SYMBOL_TYPE (sym
)->code () == code
))
5592 completion_list_add_symbol (tracker
, sym
,
5600 default_collect_symbol_completion_matches_break_on
5601 (completion_tracker
&tracker
, complete_symbol_mode mode
,
5602 symbol_name_match_type name_match_type
,
5603 const char *text
, const char *word
,
5604 const char *break_on
, enum type_code code
)
5606 /* Problem: All of the symbols have to be copied because readline
5607 frees them. I'm not going to worry about this; hopefully there
5608 won't be that many. */
5611 const struct block
*b
;
5612 const struct block
*surrounding_static_block
, *surrounding_global_block
;
5613 struct block_iterator iter
;
5614 /* The symbol we are completing on. Points in same buffer as text. */
5615 const char *sym_text
;
5617 /* Now look for the symbol we are supposed to complete on. */
5618 if (mode
== complete_symbol_mode::LINESPEC
)
5624 const char *quote_pos
= NULL
;
5626 /* First see if this is a quoted string. */
5628 for (p
= text
; *p
!= '\0'; ++p
)
5630 if (quote_found
!= '\0')
5632 if (*p
== quote_found
)
5633 /* Found close quote. */
5635 else if (*p
== '\\' && p
[1] == quote_found
)
5636 /* A backslash followed by the quote character
5637 doesn't end the string. */
5640 else if (*p
== '\'' || *p
== '"')
5646 if (quote_found
== '\'')
5647 /* A string within single quotes can be a symbol, so complete on it. */
5648 sym_text
= quote_pos
+ 1;
5649 else if (quote_found
== '"')
5650 /* A double-quoted string is never a symbol, nor does it make sense
5651 to complete it any other way. */
5657 /* It is not a quoted string. Break it based on the characters
5658 which are in symbols. */
5661 if (isalnum (p
[-1]) || p
[-1] == '_' || p
[-1] == '\0'
5662 || p
[-1] == ':' || strchr (break_on
, p
[-1]) != NULL
)
5671 lookup_name_info
lookup_name (sym_text
, name_match_type
, true);
5673 /* At this point scan through the misc symbol vectors and add each
5674 symbol you find to the list. Eventually we want to ignore
5675 anything that isn't a text symbol (everything else will be
5676 handled by the psymtab code below). */
5678 if (code
== TYPE_CODE_UNDEF
)
5680 for (objfile
*objfile
: current_program_space
->objfiles ())
5682 for (minimal_symbol
*msymbol
: objfile
->msymbols ())
5686 if (completion_skip_symbol (mode
, msymbol
))
5689 completion_list_add_msymbol (tracker
, msymbol
, lookup_name
,
5692 completion_list_objc_symbol (tracker
, msymbol
, lookup_name
,
5698 /* Add completions for all currently loaded symbol tables. */
5699 for (objfile
*objfile
: current_program_space
->objfiles ())
5701 for (compunit_symtab
*cust
: objfile
->compunits ())
5702 add_symtab_completions (cust
, tracker
, mode
, lookup_name
,
5703 sym_text
, word
, code
);
5706 /* Look through the partial symtabs for all symbols which begin by
5707 matching SYM_TEXT. Expand all CUs that you find to the list. */
5708 expand_symtabs_matching (NULL
,
5711 [&] (compunit_symtab
*symtab
) /* expansion notify */
5713 add_symtab_completions (symtab
,
5714 tracker
, mode
, lookup_name
,
5715 sym_text
, word
, code
);
5719 /* Search upwards from currently selected frame (so that we can
5720 complete on local vars). Also catch fields of types defined in
5721 this places which match our text string. Only complete on types
5722 visible from current context. */
5724 b
= get_selected_block (0);
5725 surrounding_static_block
= block_static_block (b
);
5726 surrounding_global_block
= block_global_block (b
);
5727 if (surrounding_static_block
!= NULL
)
5728 while (b
!= surrounding_static_block
)
5732 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
5734 if (code
== TYPE_CODE_UNDEF
)
5736 completion_list_add_symbol (tracker
, sym
, lookup_name
,
5738 completion_list_add_fields (tracker
, sym
, lookup_name
,
5741 else if (SYMBOL_DOMAIN (sym
) == STRUCT_DOMAIN
5742 && SYMBOL_TYPE (sym
)->code () == code
)
5743 completion_list_add_symbol (tracker
, sym
, lookup_name
,
5747 /* Stop when we encounter an enclosing function. Do not stop for
5748 non-inlined functions - the locals of the enclosing function
5749 are in scope for a nested function. */
5750 if (BLOCK_FUNCTION (b
) != NULL
&& block_inlined_p (b
))
5752 b
= BLOCK_SUPERBLOCK (b
);
5755 /* Add fields from the file's types; symbols will be added below. */
5757 if (code
== TYPE_CODE_UNDEF
)
5759 if (surrounding_static_block
!= NULL
)
5760 ALL_BLOCK_SYMBOLS (surrounding_static_block
, iter
, sym
)
5761 completion_list_add_fields (tracker
, sym
, lookup_name
,
5764 if (surrounding_global_block
!= NULL
)
5765 ALL_BLOCK_SYMBOLS (surrounding_global_block
, iter
, sym
)
5766 completion_list_add_fields (tracker
, sym
, lookup_name
,
5770 /* Skip macros if we are completing a struct tag -- arguable but
5771 usually what is expected. */
5772 if (current_language
->la_macro_expansion
== macro_expansion_c
5773 && code
== TYPE_CODE_UNDEF
)
5775 gdb::unique_xmalloc_ptr
<struct macro_scope
> scope
;
5777 /* This adds a macro's name to the current completion list. */
5778 auto add_macro_name
= [&] (const char *macro_name
,
5779 const macro_definition
*,
5780 macro_source_file
*,
5783 completion_list_add_name (tracker
, language_c
, macro_name
,
5784 lookup_name
, sym_text
, word
);
5787 /* Add any macros visible in the default scope. Note that this
5788 may yield the occasional wrong result, because an expression
5789 might be evaluated in a scope other than the default. For
5790 example, if the user types "break file:line if <TAB>", the
5791 resulting expression will be evaluated at "file:line" -- but
5792 at there does not seem to be a way to detect this at
5794 scope
= default_macro_scope ();
5796 macro_for_each_in_scope (scope
->file
, scope
->line
,
5799 /* User-defined macros are always visible. */
5800 macro_for_each (macro_user_macros
, add_macro_name
);
5805 default_collect_symbol_completion_matches (completion_tracker
&tracker
,
5806 complete_symbol_mode mode
,
5807 symbol_name_match_type name_match_type
,
5808 const char *text
, const char *word
,
5809 enum type_code code
)
5811 return default_collect_symbol_completion_matches_break_on (tracker
, mode
,
5817 /* Collect all symbols (regardless of class) which begin by matching
5821 collect_symbol_completion_matches (completion_tracker
&tracker
,
5822 complete_symbol_mode mode
,
5823 symbol_name_match_type name_match_type
,
5824 const char *text
, const char *word
)
5826 current_language
->la_collect_symbol_completion_matches (tracker
, mode
,
5832 /* Like collect_symbol_completion_matches, but only collect
5833 STRUCT_DOMAIN symbols whose type code is CODE. */
5836 collect_symbol_completion_matches_type (completion_tracker
&tracker
,
5837 const char *text
, const char *word
,
5838 enum type_code code
)
5840 complete_symbol_mode mode
= complete_symbol_mode::EXPRESSION
;
5841 symbol_name_match_type name_match_type
= symbol_name_match_type::EXPRESSION
;
5843 gdb_assert (code
== TYPE_CODE_UNION
5844 || code
== TYPE_CODE_STRUCT
5845 || code
== TYPE_CODE_ENUM
);
5846 current_language
->la_collect_symbol_completion_matches (tracker
, mode
,
5851 /* Like collect_symbol_completion_matches, but collects a list of
5852 symbols defined in all source files named SRCFILE. */
5855 collect_file_symbol_completion_matches (completion_tracker
&tracker
,
5856 complete_symbol_mode mode
,
5857 symbol_name_match_type name_match_type
,
5858 const char *text
, const char *word
,
5859 const char *srcfile
)
5861 /* The symbol we are completing on. Points in same buffer as text. */
5862 const char *sym_text
;
5864 /* Now look for the symbol we are supposed to complete on.
5865 FIXME: This should be language-specific. */
5866 if (mode
== complete_symbol_mode::LINESPEC
)
5872 const char *quote_pos
= NULL
;
5874 /* First see if this is a quoted string. */
5876 for (p
= text
; *p
!= '\0'; ++p
)
5878 if (quote_found
!= '\0')
5880 if (*p
== quote_found
)
5881 /* Found close quote. */
5883 else if (*p
== '\\' && p
[1] == quote_found
)
5884 /* A backslash followed by the quote character
5885 doesn't end the string. */
5888 else if (*p
== '\'' || *p
== '"')
5894 if (quote_found
== '\'')
5895 /* A string within single quotes can be a symbol, so complete on it. */
5896 sym_text
= quote_pos
+ 1;
5897 else if (quote_found
== '"')
5898 /* A double-quoted string is never a symbol, nor does it make sense
5899 to complete it any other way. */
5905 /* Not a quoted string. */
5906 sym_text
= language_search_unquoted_string (text
, p
);
5910 lookup_name_info
lookup_name (sym_text
, name_match_type
, true);
5912 /* Go through symtabs for SRCFILE and check the externs and statics
5913 for symbols which match. */
5914 iterate_over_symtabs (srcfile
, [&] (symtab
*s
)
5916 add_symtab_completions (SYMTAB_COMPUNIT (s
),
5917 tracker
, mode
, lookup_name
,
5918 sym_text
, word
, TYPE_CODE_UNDEF
);
5923 /* A helper function for make_source_files_completion_list. It adds
5924 another file name to a list of possible completions, growing the
5925 list as necessary. */
5928 add_filename_to_list (const char *fname
, const char *text
, const char *word
,
5929 completion_list
*list
)
5931 list
->emplace_back (make_completion_match_str (fname
, text
, word
));
5935 not_interesting_fname (const char *fname
)
5937 static const char *illegal_aliens
[] = {
5938 "_globals_", /* inserted by coff_symtab_read */
5943 for (i
= 0; illegal_aliens
[i
]; i
++)
5945 if (filename_cmp (fname
, illegal_aliens
[i
]) == 0)
5951 /* An object of this type is passed as the user_data argument to
5952 map_partial_symbol_filenames. */
5953 struct add_partial_filename_data
5955 struct filename_seen_cache
*filename_seen_cache
;
5959 completion_list
*list
;
5962 /* A callback for map_partial_symbol_filenames. */
5965 maybe_add_partial_symtab_filename (const char *filename
, const char *fullname
,
5968 struct add_partial_filename_data
*data
5969 = (struct add_partial_filename_data
*) user_data
;
5971 if (not_interesting_fname (filename
))
5973 if (!data
->filename_seen_cache
->seen (filename
)
5974 && filename_ncmp (filename
, data
->text
, data
->text_len
) == 0)
5976 /* This file matches for a completion; add it to the
5977 current list of matches. */
5978 add_filename_to_list (filename
, data
->text
, data
->word
, data
->list
);
5982 const char *base_name
= lbasename (filename
);
5984 if (base_name
!= filename
5985 && !data
->filename_seen_cache
->seen (base_name
)
5986 && filename_ncmp (base_name
, data
->text
, data
->text_len
) == 0)
5987 add_filename_to_list (base_name
, data
->text
, data
->word
, data
->list
);
5991 /* Return a list of all source files whose names begin with matching
5992 TEXT. The file names are looked up in the symbol tables of this
5996 make_source_files_completion_list (const char *text
, const char *word
)
5998 size_t text_len
= strlen (text
);
5999 completion_list list
;
6000 const char *base_name
;
6001 struct add_partial_filename_data datum
;
6003 if (!have_full_symbols () && !have_partial_symbols ())
6006 filename_seen_cache filenames_seen
;
6008 for (objfile
*objfile
: current_program_space
->objfiles ())
6010 for (compunit_symtab
*cu
: objfile
->compunits ())
6012 for (symtab
*s
: compunit_filetabs (cu
))
6014 if (not_interesting_fname (s
->filename
))
6016 if (!filenames_seen
.seen (s
->filename
)
6017 && filename_ncmp (s
->filename
, text
, text_len
) == 0)
6019 /* This file matches for a completion; add it to the current
6021 add_filename_to_list (s
->filename
, text
, word
, &list
);
6025 /* NOTE: We allow the user to type a base name when the
6026 debug info records leading directories, but not the other
6027 way around. This is what subroutines of breakpoint
6028 command do when they parse file names. */
6029 base_name
= lbasename (s
->filename
);
6030 if (base_name
!= s
->filename
6031 && !filenames_seen
.seen (base_name
)
6032 && filename_ncmp (base_name
, text
, text_len
) == 0)
6033 add_filename_to_list (base_name
, text
, word
, &list
);
6039 datum
.filename_seen_cache
= &filenames_seen
;
6042 datum
.text_len
= text_len
;
6044 map_symbol_filenames (maybe_add_partial_symtab_filename
, &datum
,
6045 0 /*need_fullname*/);
6052 /* Return the "main_info" object for the current program space. If
6053 the object has not yet been created, create it and fill in some
6056 static struct main_info
*
6057 get_main_info (void)
6059 struct main_info
*info
= main_progspace_key
.get (current_program_space
);
6063 /* It may seem strange to store the main name in the progspace
6064 and also in whatever objfile happens to see a main name in
6065 its debug info. The reason for this is mainly historical:
6066 gdb returned "main" as the name even if no function named
6067 "main" was defined the program; and this approach lets us
6068 keep compatibility. */
6069 info
= main_progspace_key
.emplace (current_program_space
);
6076 set_main_name (const char *name
, enum language lang
)
6078 struct main_info
*info
= get_main_info ();
6080 if (info
->name_of_main
!= NULL
)
6082 xfree (info
->name_of_main
);
6083 info
->name_of_main
= NULL
;
6084 info
->language_of_main
= language_unknown
;
6088 info
->name_of_main
= xstrdup (name
);
6089 info
->language_of_main
= lang
;
6093 /* Deduce the name of the main procedure, and set NAME_OF_MAIN
6097 find_main_name (void)
6099 const char *new_main_name
;
6101 /* First check the objfiles to see whether a debuginfo reader has
6102 picked up the appropriate main name. Historically the main name
6103 was found in a more or less random way; this approach instead
6104 relies on the order of objfile creation -- which still isn't
6105 guaranteed to get the correct answer, but is just probably more
6107 for (objfile
*objfile
: current_program_space
->objfiles ())
6109 if (objfile
->per_bfd
->name_of_main
!= NULL
)
6111 set_main_name (objfile
->per_bfd
->name_of_main
,
6112 objfile
->per_bfd
->language_of_main
);
6117 /* Try to see if the main procedure is in Ada. */
6118 /* FIXME: brobecker/2005-03-07: Another way of doing this would
6119 be to add a new method in the language vector, and call this
6120 method for each language until one of them returns a non-empty
6121 name. This would allow us to remove this hard-coded call to
6122 an Ada function. It is not clear that this is a better approach
6123 at this point, because all methods need to be written in a way
6124 such that false positives never be returned. For instance, it is
6125 important that a method does not return a wrong name for the main
6126 procedure if the main procedure is actually written in a different
6127 language. It is easy to guaranty this with Ada, since we use a
6128 special symbol generated only when the main in Ada to find the name
6129 of the main procedure. It is difficult however to see how this can
6130 be guarantied for languages such as C, for instance. This suggests
6131 that order of call for these methods becomes important, which means
6132 a more complicated approach. */
6133 new_main_name
= ada_main_name ();
6134 if (new_main_name
!= NULL
)
6136 set_main_name (new_main_name
, language_ada
);
6140 new_main_name
= d_main_name ();
6141 if (new_main_name
!= NULL
)
6143 set_main_name (new_main_name
, language_d
);
6147 new_main_name
= go_main_name ();
6148 if (new_main_name
!= NULL
)
6150 set_main_name (new_main_name
, language_go
);
6154 new_main_name
= pascal_main_name ();
6155 if (new_main_name
!= NULL
)
6157 set_main_name (new_main_name
, language_pascal
);
6161 /* The languages above didn't identify the name of the main procedure.
6162 Fallback to "main". */
6164 /* Try to find language for main in psymtabs. */
6166 = find_quick_global_symbol_language ("main", VAR_DOMAIN
);
6167 if (lang
!= language_unknown
)
6169 set_main_name ("main", lang
);
6173 set_main_name ("main", language_unknown
);
6181 struct main_info
*info
= get_main_info ();
6183 if (info
->name_of_main
== NULL
)
6186 return info
->name_of_main
;
6189 /* Return the language of the main function. If it is not known,
6190 return language_unknown. */
6193 main_language (void)
6195 struct main_info
*info
= get_main_info ();
6197 if (info
->name_of_main
== NULL
)
6200 return info
->language_of_main
;
6203 /* Handle ``executable_changed'' events for the symtab module. */
6206 symtab_observer_executable_changed (void)
6208 /* NAME_OF_MAIN may no longer be the same, so reset it for now. */
6209 set_main_name (NULL
, language_unknown
);
6212 /* Return 1 if the supplied producer string matches the ARM RealView
6213 compiler (armcc). */
6216 producer_is_realview (const char *producer
)
6218 static const char *const arm_idents
[] = {
6219 "ARM C Compiler, ADS",
6220 "Thumb C Compiler, ADS",
6221 "ARM C++ Compiler, ADS",
6222 "Thumb C++ Compiler, ADS",
6223 "ARM/Thumb C/C++ Compiler, RVCT",
6224 "ARM C/C++ Compiler, RVCT"
6228 if (producer
== NULL
)
6231 for (i
= 0; i
< ARRAY_SIZE (arm_idents
); i
++)
6232 if (startswith (producer
, arm_idents
[i
]))
6240 /* The next index to hand out in response to a registration request. */
6242 static int next_aclass_value
= LOC_FINAL_VALUE
;
6244 /* The maximum number of "aclass" registrations we support. This is
6245 constant for convenience. */
6246 #define MAX_SYMBOL_IMPLS (LOC_FINAL_VALUE + 10)
6248 /* The objects representing the various "aclass" values. The elements
6249 from 0 up to LOC_FINAL_VALUE-1 represent themselves, and subsequent
6250 elements are those registered at gdb initialization time. */
6252 static struct symbol_impl symbol_impl
[MAX_SYMBOL_IMPLS
];
6254 /* The globally visible pointer. This is separate from 'symbol_impl'
6255 so that it can be const. */
6257 const struct symbol_impl
*symbol_impls
= &symbol_impl
[0];
6259 /* Make sure we saved enough room in struct symbol. */
6261 gdb_static_assert (MAX_SYMBOL_IMPLS
<= (1 << SYMBOL_ACLASS_BITS
));
6263 /* Register a computed symbol type. ACLASS must be LOC_COMPUTED. OPS
6264 is the ops vector associated with this index. This returns the new
6265 index, which should be used as the aclass_index field for symbols
6269 register_symbol_computed_impl (enum address_class aclass
,
6270 const struct symbol_computed_ops
*ops
)
6272 int result
= next_aclass_value
++;
6274 gdb_assert (aclass
== LOC_COMPUTED
);
6275 gdb_assert (result
< MAX_SYMBOL_IMPLS
);
6276 symbol_impl
[result
].aclass
= aclass
;
6277 symbol_impl
[result
].ops_computed
= ops
;
6279 /* Sanity check OPS. */
6280 gdb_assert (ops
!= NULL
);
6281 gdb_assert (ops
->tracepoint_var_ref
!= NULL
);
6282 gdb_assert (ops
->describe_location
!= NULL
);
6283 gdb_assert (ops
->get_symbol_read_needs
!= NULL
);
6284 gdb_assert (ops
->read_variable
!= NULL
);
6289 /* Register a function with frame base type. ACLASS must be LOC_BLOCK.
6290 OPS is the ops vector associated with this index. This returns the
6291 new index, which should be used as the aclass_index field for symbols
6295 register_symbol_block_impl (enum address_class aclass
,
6296 const struct symbol_block_ops
*ops
)
6298 int result
= next_aclass_value
++;
6300 gdb_assert (aclass
== LOC_BLOCK
);
6301 gdb_assert (result
< MAX_SYMBOL_IMPLS
);
6302 symbol_impl
[result
].aclass
= aclass
;
6303 symbol_impl
[result
].ops_block
= ops
;
6305 /* Sanity check OPS. */
6306 gdb_assert (ops
!= NULL
);
6307 gdb_assert (ops
->find_frame_base_location
!= NULL
);
6312 /* Register a register symbol type. ACLASS must be LOC_REGISTER or
6313 LOC_REGPARM_ADDR. OPS is the register ops vector associated with
6314 this index. This returns the new index, which should be used as
6315 the aclass_index field for symbols of this type. */
6318 register_symbol_register_impl (enum address_class aclass
,
6319 const struct symbol_register_ops
*ops
)
6321 int result
= next_aclass_value
++;
6323 gdb_assert (aclass
== LOC_REGISTER
|| aclass
== LOC_REGPARM_ADDR
);
6324 gdb_assert (result
< MAX_SYMBOL_IMPLS
);
6325 symbol_impl
[result
].aclass
= aclass
;
6326 symbol_impl
[result
].ops_register
= ops
;
6331 /* Initialize elements of 'symbol_impl' for the constants in enum
6335 initialize_ordinary_address_classes (void)
6339 for (i
= 0; i
< LOC_FINAL_VALUE
; ++i
)
6340 symbol_impl
[i
].aclass
= (enum address_class
) i
;
6348 symbol_objfile (const struct symbol
*symbol
)
6350 gdb_assert (SYMBOL_OBJFILE_OWNED (symbol
));
6351 return SYMTAB_OBJFILE (symbol
->owner
.symtab
);
6357 symbol_arch (const struct symbol
*symbol
)
6359 if (!SYMBOL_OBJFILE_OWNED (symbol
))
6360 return symbol
->owner
.arch
;
6361 return SYMTAB_OBJFILE (symbol
->owner
.symtab
)->arch ();
6367 symbol_symtab (const struct symbol
*symbol
)
6369 gdb_assert (SYMBOL_OBJFILE_OWNED (symbol
));
6370 return symbol
->owner
.symtab
;
6376 symbol_set_symtab (struct symbol
*symbol
, struct symtab
*symtab
)
6378 gdb_assert (SYMBOL_OBJFILE_OWNED (symbol
));
6379 symbol
->owner
.symtab
= symtab
;
6385 get_symbol_address (const struct symbol
*sym
)
6387 gdb_assert (sym
->maybe_copied
);
6388 gdb_assert (SYMBOL_CLASS (sym
) == LOC_STATIC
);
6390 const char *linkage_name
= sym
->linkage_name ();
6392 for (objfile
*objfile
: current_program_space
->objfiles ())
6394 if (objfile
->separate_debug_objfile_backlink
!= nullptr)
6397 bound_minimal_symbol minsym
6398 = lookup_minimal_symbol_linkage (linkage_name
, objfile
);
6399 if (minsym
.minsym
!= nullptr)
6400 return BMSYMBOL_VALUE_ADDRESS (minsym
);
6402 return sym
->value
.address
;
6408 get_msymbol_address (struct objfile
*objf
, const struct minimal_symbol
*minsym
)
6410 gdb_assert (minsym
->maybe_copied
);
6411 gdb_assert ((objf
->flags
& OBJF_MAINLINE
) == 0);
6413 const char *linkage_name
= minsym
->linkage_name ();
6415 for (objfile
*objfile
: current_program_space
->objfiles ())
6417 if (objfile
->separate_debug_objfile_backlink
== nullptr
6418 && (objfile
->flags
& OBJF_MAINLINE
) != 0)
6420 bound_minimal_symbol found
6421 = lookup_minimal_symbol_linkage (linkage_name
, objfile
);
6422 if (found
.minsym
!= nullptr)
6423 return BMSYMBOL_VALUE_ADDRESS (found
);
6426 return minsym
->value
.address
+ objf
->section_offsets
[minsym
->section
];
6431 /* Hold the sub-commands of 'info module'. */
6433 static struct cmd_list_element
*info_module_cmdlist
= NULL
;
6437 std::vector
<module_symbol_search
>
6438 search_module_symbols (const char *module_regexp
, const char *regexp
,
6439 const char *type_regexp
, search_domain kind
)
6441 std::vector
<module_symbol_search
> results
;
6443 /* Search for all modules matching MODULE_REGEXP. */
6444 global_symbol_searcher
spec1 (MODULES_DOMAIN
, module_regexp
);
6445 spec1
.set_exclude_minsyms (true);
6446 std::vector
<symbol_search
> modules
= spec1
.search ();
6448 /* Now search for all symbols of the required KIND matching the required
6449 regular expressions. We figure out which ones are in which modules
6451 global_symbol_searcher
spec2 (kind
, regexp
);
6452 spec2
.set_symbol_type_regexp (type_regexp
);
6453 spec2
.set_exclude_minsyms (true);
6454 std::vector
<symbol_search
> symbols
= spec2
.search ();
6456 /* Now iterate over all MODULES, checking to see which items from
6457 SYMBOLS are in each module. */
6458 for (const symbol_search
&p
: modules
)
6462 /* This is a module. */
6463 gdb_assert (p
.symbol
!= nullptr);
6465 std::string prefix
= p
.symbol
->print_name ();
6468 for (const symbol_search
&q
: symbols
)
6470 if (q
.symbol
== nullptr)
6473 if (strncmp (q
.symbol
->print_name (), prefix
.c_str (),
6474 prefix
.size ()) != 0)
6477 results
.push_back ({p
, q
});
6484 /* Implement the core of both 'info module functions' and 'info module
6488 info_module_subcommand (bool quiet
, const char *module_regexp
,
6489 const char *regexp
, const char *type_regexp
,
6492 /* Print a header line. Don't build the header line bit by bit as this
6493 prevents internationalisation. */
6496 if (module_regexp
== nullptr)
6498 if (type_regexp
== nullptr)
6500 if (regexp
== nullptr)
6501 printf_filtered ((kind
== VARIABLES_DOMAIN
6502 ? _("All variables in all modules:")
6503 : _("All functions in all modules:")));
6506 ((kind
== VARIABLES_DOMAIN
6507 ? _("All variables matching regular expression"
6508 " \"%s\" in all modules:")
6509 : _("All functions matching regular expression"
6510 " \"%s\" in all modules:")),
6515 if (regexp
== nullptr)
6517 ((kind
== VARIABLES_DOMAIN
6518 ? _("All variables with type matching regular "
6519 "expression \"%s\" in all modules:")
6520 : _("All functions with type matching regular "
6521 "expression \"%s\" in all modules:")),
6525 ((kind
== VARIABLES_DOMAIN
6526 ? _("All variables matching regular expression "
6527 "\"%s\",\n\twith type matching regular "
6528 "expression \"%s\" in all modules:")
6529 : _("All functions matching regular expression "
6530 "\"%s\",\n\twith type matching regular "
6531 "expression \"%s\" in all modules:")),
6532 regexp
, type_regexp
);
6537 if (type_regexp
== nullptr)
6539 if (regexp
== nullptr)
6541 ((kind
== VARIABLES_DOMAIN
6542 ? _("All variables in all modules matching regular "
6543 "expression \"%s\":")
6544 : _("All functions in all modules matching regular "
6545 "expression \"%s\":")),
6549 ((kind
== VARIABLES_DOMAIN
6550 ? _("All variables matching regular expression "
6551 "\"%s\",\n\tin all modules matching regular "
6552 "expression \"%s\":")
6553 : _("All functions matching regular expression "
6554 "\"%s\",\n\tin all modules matching regular "
6555 "expression \"%s\":")),
6556 regexp
, module_regexp
);
6560 if (regexp
== nullptr)
6562 ((kind
== VARIABLES_DOMAIN
6563 ? _("All variables with type matching regular "
6564 "expression \"%s\"\n\tin all modules matching "
6565 "regular expression \"%s\":")
6566 : _("All functions with type matching regular "
6567 "expression \"%s\"\n\tin all modules matching "
6568 "regular expression \"%s\":")),
6569 type_regexp
, module_regexp
);
6572 ((kind
== VARIABLES_DOMAIN
6573 ? _("All variables matching regular expression "
6574 "\"%s\",\n\twith type matching regular expression "
6575 "\"%s\",\n\tin all modules matching regular "
6576 "expression \"%s\":")
6577 : _("All functions matching regular expression "
6578 "\"%s\",\n\twith type matching regular expression "
6579 "\"%s\",\n\tin all modules matching regular "
6580 "expression \"%s\":")),
6581 regexp
, type_regexp
, module_regexp
);
6584 printf_filtered ("\n");
6587 /* Find all symbols of type KIND matching the given regular expressions
6588 along with the symbols for the modules in which those symbols
6590 std::vector
<module_symbol_search
> module_symbols
6591 = search_module_symbols (module_regexp
, regexp
, type_regexp
, kind
);
6593 std::sort (module_symbols
.begin (), module_symbols
.end (),
6594 [] (const module_symbol_search
&a
, const module_symbol_search
&b
)
6596 if (a
.first
< b
.first
)
6598 else if (a
.first
== b
.first
)
6599 return a
.second
< b
.second
;
6604 const char *last_filename
= "";
6605 const symbol
*last_module_symbol
= nullptr;
6606 for (const module_symbol_search
&ms
: module_symbols
)
6608 const symbol_search
&p
= ms
.first
;
6609 const symbol_search
&q
= ms
.second
;
6611 gdb_assert (q
.symbol
!= nullptr);
6613 if (last_module_symbol
!= p
.symbol
)
6615 printf_filtered ("\n");
6616 printf_filtered (_("Module \"%s\":\n"), p
.symbol
->print_name ());
6617 last_module_symbol
= p
.symbol
;
6621 print_symbol_info (FUNCTIONS_DOMAIN
, q
.symbol
, q
.block
,
6624 = symtab_to_filename_for_display (symbol_symtab (q
.symbol
));
6628 /* Hold the option values for the 'info module .....' sub-commands. */
6630 struct info_modules_var_func_options
6633 char *type_regexp
= nullptr;
6634 char *module_regexp
= nullptr;
6636 ~info_modules_var_func_options ()
6638 xfree (type_regexp
);
6639 xfree (module_regexp
);
6643 /* The options used by 'info module variables' and 'info module functions'
6646 static const gdb::option::option_def info_modules_var_func_options_defs
[] = {
6647 gdb::option::boolean_option_def
<info_modules_var_func_options
> {
6649 [] (info_modules_var_func_options
*opt
) { return &opt
->quiet
; },
6650 nullptr, /* show_cmd_cb */
6651 nullptr /* set_doc */
6654 gdb::option::string_option_def
<info_modules_var_func_options
> {
6656 [] (info_modules_var_func_options
*opt
) { return &opt
->type_regexp
; },
6657 nullptr, /* show_cmd_cb */
6658 nullptr /* set_doc */
6661 gdb::option::string_option_def
<info_modules_var_func_options
> {
6663 [] (info_modules_var_func_options
*opt
) { return &opt
->module_regexp
; },
6664 nullptr, /* show_cmd_cb */
6665 nullptr /* set_doc */
6669 /* Return the option group used by the 'info module ...' sub-commands. */
6671 static inline gdb::option::option_def_group
6672 make_info_modules_var_func_options_def_group
6673 (info_modules_var_func_options
*opts
)
6675 return {{info_modules_var_func_options_defs
}, opts
};
6678 /* Implements the 'info module functions' command. */
6681 info_module_functions_command (const char *args
, int from_tty
)
6683 info_modules_var_func_options opts
;
6684 auto grp
= make_info_modules_var_func_options_def_group (&opts
);
6685 gdb::option::process_options
6686 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
6687 if (args
!= nullptr && *args
== '\0')
6690 info_module_subcommand (opts
.quiet
, opts
.module_regexp
, args
,
6691 opts
.type_regexp
, FUNCTIONS_DOMAIN
);
6694 /* Implements the 'info module variables' command. */
6697 info_module_variables_command (const char *args
, int from_tty
)
6699 info_modules_var_func_options opts
;
6700 auto grp
= make_info_modules_var_func_options_def_group (&opts
);
6701 gdb::option::process_options
6702 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
6703 if (args
!= nullptr && *args
== '\0')
6706 info_module_subcommand (opts
.quiet
, opts
.module_regexp
, args
,
6707 opts
.type_regexp
, VARIABLES_DOMAIN
);
6710 /* Command completer for 'info module ...' sub-commands. */
6713 info_module_var_func_command_completer (struct cmd_list_element
*ignore
,
6714 completion_tracker
&tracker
,
6716 const char * /* word */)
6719 const auto group
= make_info_modules_var_func_options_def_group (nullptr);
6720 if (gdb::option::complete_options
6721 (tracker
, &text
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, group
))
6724 const char *word
= advance_to_expression_complete_word_point (tracker
, text
);
6725 symbol_completer (ignore
, tracker
, text
, word
);
6730 void _initialize_symtab ();
6732 _initialize_symtab ()
6734 cmd_list_element
*c
;
6736 initialize_ordinary_address_classes ();
6738 c
= add_info ("variables", info_variables_command
,
6739 info_print_args_help (_("\
6740 All global and static variable names or those matching REGEXPs.\n\
6741 Usage: info variables [-q] [-n] [-t TYPEREGEXP] [NAMEREGEXP]\n\
6742 Prints the global and static variables.\n"),
6743 _("global and static variables"),
6745 set_cmd_completer_handle_brkchars (c
, info_vars_funcs_command_completer
);
6748 c
= add_com ("whereis", class_info
, info_variables_command
,
6749 info_print_args_help (_("\
6750 All global and static variable names, or those matching REGEXPs.\n\
6751 Usage: whereis [-q] [-n] [-t TYPEREGEXP] [NAMEREGEXP]\n\
6752 Prints the global and static variables.\n"),
6753 _("global and static variables"),
6755 set_cmd_completer_handle_brkchars (c
, info_vars_funcs_command_completer
);
6758 c
= add_info ("functions", info_functions_command
,
6759 info_print_args_help (_("\
6760 All function names or those matching REGEXPs.\n\
6761 Usage: info functions [-q] [-n] [-t TYPEREGEXP] [NAMEREGEXP]\n\
6762 Prints the functions.\n"),
6765 set_cmd_completer_handle_brkchars (c
, info_vars_funcs_command_completer
);
6767 c
= add_info ("types", info_types_command
, _("\
6768 All type names, or those matching REGEXP.\n\
6769 Usage: info types [-q] [REGEXP]\n\
6770 Print information about all types matching REGEXP, or all types if no\n\
6771 REGEXP is given. The optional flag -q disables printing of headers."));
6772 set_cmd_completer_handle_brkchars (c
, info_types_command_completer
);
6774 const auto info_sources_opts
= make_info_sources_options_def_group (nullptr);
6776 static std::string info_sources_help
6777 = gdb::option::build_help (_("\
6778 All source files in the program or those matching REGEXP.\n\
6779 Usage: info sources [OPTION]... [REGEXP]\n\
6780 By default, REGEXP is used to match anywhere in the filename.\n\
6786 c
= add_info ("sources", info_sources_command
, info_sources_help
.c_str ());
6787 set_cmd_completer_handle_brkchars (c
, info_sources_command_completer
);
6789 c
= add_info ("modules", info_modules_command
,
6790 _("All module names, or those matching REGEXP."));
6791 set_cmd_completer_handle_brkchars (c
, info_types_command_completer
);
6793 add_basic_prefix_cmd ("module", class_info
, _("\
6794 Print information about modules."),
6795 &info_module_cmdlist
, "info module ",
6798 c
= add_cmd ("functions", class_info
, info_module_functions_command
, _("\
6799 Display functions arranged by modules.\n\
6800 Usage: info module functions [-q] [-m MODREGEXP] [-t TYPEREGEXP] [REGEXP]\n\
6801 Print a summary of all functions within each Fortran module, grouped by\n\
6802 module and file. For each function the line on which the function is\n\
6803 defined is given along with the type signature and name of the function.\n\
6805 If REGEXP is provided then only functions whose name matches REGEXP are\n\
6806 listed. If MODREGEXP is provided then only functions in modules matching\n\
6807 MODREGEXP are listed. If TYPEREGEXP is given then only functions whose\n\
6808 type signature matches TYPEREGEXP are listed.\n\
6810 The -q flag suppresses printing some header information."),
6811 &info_module_cmdlist
);
6812 set_cmd_completer_handle_brkchars
6813 (c
, info_module_var_func_command_completer
);
6815 c
= add_cmd ("variables", class_info
, info_module_variables_command
, _("\
6816 Display variables arranged by modules.\n\
6817 Usage: info module variables [-q] [-m MODREGEXP] [-t TYPEREGEXP] [REGEXP]\n\
6818 Print a summary of all variables within each Fortran module, grouped by\n\
6819 module and file. For each variable the line on which the variable is\n\
6820 defined is given along with the type and name of the variable.\n\
6822 If REGEXP is provided then only variables whose name matches REGEXP are\n\
6823 listed. If MODREGEXP is provided then only variables in modules matching\n\
6824 MODREGEXP are listed. If TYPEREGEXP is given then only variables whose\n\
6825 type matches TYPEREGEXP are listed.\n\
6827 The -q flag suppresses printing some header information."),
6828 &info_module_cmdlist
);
6829 set_cmd_completer_handle_brkchars
6830 (c
, info_module_var_func_command_completer
);
6832 add_com ("rbreak", class_breakpoint
, rbreak_command
,
6833 _("Set a breakpoint for all functions matching REGEXP."));
6835 add_setshow_enum_cmd ("multiple-symbols", no_class
,
6836 multiple_symbols_modes
, &multiple_symbols_mode
,
6838 Set how the debugger handles ambiguities in expressions."), _("\
6839 Show how the debugger handles ambiguities in expressions."), _("\
6840 Valid values are \"ask\", \"all\", \"cancel\", and the default is \"all\"."),
6841 NULL
, NULL
, &setlist
, &showlist
);
6843 add_setshow_boolean_cmd ("basenames-may-differ", class_obscure
,
6844 &basenames_may_differ
, _("\
6845 Set whether a source file may have multiple base names."), _("\
6846 Show whether a source file may have multiple base names."), _("\
6847 (A \"base name\" is the name of a file with the directory part removed.\n\
6848 Example: The base name of \"/home/user/hello.c\" is \"hello.c\".)\n\
6849 If set, GDB will canonicalize file names (e.g., expand symlinks)\n\
6850 before comparing them. Canonicalization is an expensive operation,\n\
6851 but it allows the same file be known by more than one base name.\n\
6852 If not set (the default), all source files are assumed to have just\n\
6853 one base name, and gdb will do file name comparisons more efficiently."),
6855 &setlist
, &showlist
);
6857 add_setshow_zuinteger_cmd ("symtab-create", no_class
, &symtab_create_debug
,
6858 _("Set debugging of symbol table creation."),
6859 _("Show debugging of symbol table creation."), _("\
6860 When enabled (non-zero), debugging messages are printed when building\n\
6861 symbol tables. A value of 1 (one) normally provides enough information.\n\
6862 A value greater than 1 provides more verbose information."),
6865 &setdebuglist
, &showdebuglist
);
6867 add_setshow_zuinteger_cmd ("symbol-lookup", no_class
, &symbol_lookup_debug
,
6869 Set debugging of symbol lookup."), _("\
6870 Show debugging of symbol lookup."), _("\
6871 When enabled (non-zero), symbol lookups are logged."),
6873 &setdebuglist
, &showdebuglist
);
6875 add_setshow_zuinteger_cmd ("symbol-cache-size", no_class
,
6876 &new_symbol_cache_size
,
6877 _("Set the size of the symbol cache."),
6878 _("Show the size of the symbol cache."), _("\
6879 The size of the symbol cache.\n\
6880 If zero then the symbol cache is disabled."),
6881 set_symbol_cache_size_handler
, NULL
,
6882 &maintenance_set_cmdlist
,
6883 &maintenance_show_cmdlist
);
6885 add_cmd ("symbol-cache", class_maintenance
, maintenance_print_symbol_cache
,
6886 _("Dump the symbol cache for each program space."),
6887 &maintenanceprintlist
);
6889 add_cmd ("symbol-cache-statistics", class_maintenance
,
6890 maintenance_print_symbol_cache_statistics
,
6891 _("Print symbol cache statistics for each program space."),
6892 &maintenanceprintlist
);
6894 add_cmd ("flush-symbol-cache", class_maintenance
,
6895 maintenance_flush_symbol_cache
,
6896 _("Flush the symbol cache for each program space."),
6899 gdb::observers::executable_changed
.attach (symtab_observer_executable_changed
);
6900 gdb::observers::new_objfile
.attach (symtab_new_objfile_observer
);
6901 gdb::observers::free_objfile
.attach (symtab_free_objfile_observer
);