1 /* Symbol table lookup for the GNU debugger, GDB.
3 Copyright (C) 1986-2021 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
30 #include "gdb_regex.h"
31 #include "expression.h"
36 #include "filenames.h" /* for FILENAME_CMP */
37 #include "objc-lang.h"
43 #include "cli/cli-utils.h"
44 #include "cli/cli-style.h"
45 #include "cli/cli-cmds.h"
48 #include "typeprint.h"
50 #include "gdb_obstack.h"
52 #include "dictionary.h"
54 #include <sys/types.h>
59 #include "cp-support.h"
60 #include "observable.h"
63 #include "macroscope.h"
65 #include "parser-defs.h"
66 #include "completer.h"
67 #include "progspace-and-thread.h"
68 #include "gdbsupport/gdb_optional.h"
69 #include "filename-seen-cache.h"
70 #include "arch-utils.h"
72 #include "gdbsupport/gdb_string_view.h"
73 #include "gdbsupport/pathstuff.h"
74 #include "gdbsupport/common-utils.h"
76 /* Forward declarations for local functions. */
78 static void rbreak_command (const char *, int);
80 static int find_line_common (struct linetable
*, int, int *, int);
82 static struct block_symbol
83 lookup_symbol_aux (const char *name
,
84 symbol_name_match_type match_type
,
85 const struct block
*block
,
86 const domain_enum domain
,
87 enum language language
,
88 struct field_of_this_result
*);
91 struct block_symbol
lookup_local_symbol (const char *name
,
92 symbol_name_match_type match_type
,
93 const struct block
*block
,
94 const domain_enum domain
,
95 enum language language
);
97 static struct block_symbol
98 lookup_symbol_in_objfile (struct objfile
*objfile
,
99 enum block_enum block_index
,
100 const char *name
, const domain_enum domain
);
102 /* Type of the data stored on the program space. */
106 main_info () = default;
110 xfree (name_of_main
);
113 /* Name of "main". */
115 char *name_of_main
= nullptr;
117 /* Language of "main". */
119 enum language language_of_main
= language_unknown
;
122 /* Program space key for finding name and language of "main". */
124 static const program_space_key
<main_info
> main_progspace_key
;
126 /* The default symbol cache size.
127 There is no extra cpu cost for large N (except when flushing the cache,
128 which is rare). The value here is just a first attempt. A better default
129 value may be higher or lower. A prime number can make up for a bad hash
130 computation, so that's why the number is what it is. */
131 #define DEFAULT_SYMBOL_CACHE_SIZE 1021
133 /* The maximum symbol cache size.
134 There's no method to the decision of what value to use here, other than
135 there's no point in allowing a user typo to make gdb consume all memory. */
136 #define MAX_SYMBOL_CACHE_SIZE (1024*1024)
138 /* symbol_cache_lookup returns this if a previous lookup failed to find the
139 symbol in any objfile. */
140 #define SYMBOL_LOOKUP_FAILED \
141 ((struct block_symbol) {(struct symbol *) 1, NULL})
142 #define SYMBOL_LOOKUP_FAILED_P(SIB) (SIB.symbol == (struct symbol *) 1)
144 /* Recording lookups that don't find the symbol is just as important, if not
145 more so, than recording found symbols. */
147 enum symbol_cache_slot_state
150 SYMBOL_SLOT_NOT_FOUND
,
154 struct symbol_cache_slot
156 enum symbol_cache_slot_state state
;
158 /* The objfile that was current when the symbol was looked up.
159 This is only needed for global blocks, but for simplicity's sake
160 we allocate the space for both. If data shows the extra space used
161 for static blocks is a problem, we can split things up then.
163 Global blocks need cache lookup to include the objfile context because
164 we need to account for gdbarch_iterate_over_objfiles_in_search_order
165 which can traverse objfiles in, effectively, any order, depending on
166 the current objfile, thus affecting which symbol is found. Normally,
167 only the current objfile is searched first, and then the rest are
168 searched in recorded order; but putting cache lookup inside
169 gdbarch_iterate_over_objfiles_in_search_order would be awkward.
170 Instead we just make the current objfile part of the context of
171 cache lookup. This means we can record the same symbol multiple times,
172 each with a different "current objfile" that was in effect when the
173 lookup was saved in the cache, but cache space is pretty cheap. */
174 const struct objfile
*objfile_context
;
178 struct block_symbol found
;
187 /* Clear out SLOT. */
190 symbol_cache_clear_slot (struct symbol_cache_slot
*slot
)
192 if (slot
->state
== SYMBOL_SLOT_NOT_FOUND
)
193 xfree (slot
->value
.not_found
.name
);
194 slot
->state
= SYMBOL_SLOT_UNUSED
;
197 /* Symbols don't specify global vs static block.
198 So keep them in separate caches. */
200 struct block_symbol_cache
204 unsigned int collisions
;
206 /* SYMBOLS is a variable length array of this size.
207 One can imagine that in general one cache (global/static) should be a
208 fraction of the size of the other, but there's no data at the moment
209 on which to decide. */
212 struct symbol_cache_slot symbols
[1];
215 /* Clear all slots of BSC and free BSC. */
218 destroy_block_symbol_cache (struct block_symbol_cache
*bsc
)
222 for (unsigned int i
= 0; i
< bsc
->size
; i
++)
223 symbol_cache_clear_slot (&bsc
->symbols
[i
]);
230 Searching for symbols in the static and global blocks over multiple objfiles
231 again and again can be slow, as can searching very big objfiles. This is a
232 simple cache to improve symbol lookup performance, which is critical to
233 overall gdb performance.
235 Symbols are hashed on the name, its domain, and block.
236 They are also hashed on their objfile for objfile-specific lookups. */
240 symbol_cache () = default;
244 destroy_block_symbol_cache (global_symbols
);
245 destroy_block_symbol_cache (static_symbols
);
248 struct block_symbol_cache
*global_symbols
= nullptr;
249 struct block_symbol_cache
*static_symbols
= nullptr;
252 /* Program space key for finding its symbol cache. */
254 static const program_space_key
<symbol_cache
> symbol_cache_key
;
256 /* When non-zero, print debugging messages related to symtab creation. */
257 unsigned int symtab_create_debug
= 0;
259 /* When non-zero, print debugging messages related to symbol lookup. */
260 unsigned int symbol_lookup_debug
= 0;
262 /* The size of the cache is staged here. */
263 static unsigned int new_symbol_cache_size
= DEFAULT_SYMBOL_CACHE_SIZE
;
265 /* The current value of the symbol cache size.
266 This is saved so that if the user enters a value too big we can restore
267 the original value from here. */
268 static unsigned int symbol_cache_size
= DEFAULT_SYMBOL_CACHE_SIZE
;
270 /* True if a file may be known by two different basenames.
271 This is the uncommon case, and significantly slows down gdb.
272 Default set to "off" to not slow down the common case. */
273 bool basenames_may_differ
= false;
275 /* Allow the user to configure the debugger behavior with respect
276 to multiple-choice menus when more than one symbol matches during
279 const char multiple_symbols_ask
[] = "ask";
280 const char multiple_symbols_all
[] = "all";
281 const char multiple_symbols_cancel
[] = "cancel";
282 static const char *const multiple_symbols_modes
[] =
284 multiple_symbols_ask
,
285 multiple_symbols_all
,
286 multiple_symbols_cancel
,
289 static const char *multiple_symbols_mode
= multiple_symbols_all
;
291 /* Read-only accessor to AUTO_SELECT_MODE. */
294 multiple_symbols_select_mode (void)
296 return multiple_symbols_mode
;
299 /* Return the name of a domain_enum. */
302 domain_name (domain_enum e
)
306 case UNDEF_DOMAIN
: return "UNDEF_DOMAIN";
307 case VAR_DOMAIN
: return "VAR_DOMAIN";
308 case STRUCT_DOMAIN
: return "STRUCT_DOMAIN";
309 case MODULE_DOMAIN
: return "MODULE_DOMAIN";
310 case LABEL_DOMAIN
: return "LABEL_DOMAIN";
311 case COMMON_BLOCK_DOMAIN
: return "COMMON_BLOCK_DOMAIN";
312 default: gdb_assert_not_reached ("bad domain_enum");
316 /* Return the name of a search_domain . */
319 search_domain_name (enum search_domain e
)
323 case VARIABLES_DOMAIN
: return "VARIABLES_DOMAIN";
324 case FUNCTIONS_DOMAIN
: return "FUNCTIONS_DOMAIN";
325 case TYPES_DOMAIN
: return "TYPES_DOMAIN";
326 case MODULES_DOMAIN
: return "MODULES_DOMAIN";
327 case ALL_DOMAIN
: return "ALL_DOMAIN";
328 default: gdb_assert_not_reached ("bad search_domain");
335 compunit_symtab::find_call_site (CORE_ADDR pc
) const
337 if (m_call_site_htab
== nullptr)
341 = this->objfile
->section_offsets
[COMPUNIT_BLOCK_LINE_SECTION (this)];
342 CORE_ADDR unrelocated_pc
= pc
- delta
;
344 struct call_site
call_site_local (unrelocated_pc
, nullptr, nullptr);
346 = htab_find_slot (m_call_site_htab
, &call_site_local
, NO_INSERT
);
350 return (call_site
*) *slot
;
356 compunit_symtab::set_call_site_htab (htab_t call_site_htab
)
358 gdb_assert (m_call_site_htab
== nullptr);
359 m_call_site_htab
= call_site_htab
;
365 compunit_primary_filetab (const struct compunit_symtab
*cust
)
367 gdb_assert (COMPUNIT_FILETABS (cust
) != NULL
);
369 /* The primary file symtab is the first one in the list. */
370 return COMPUNIT_FILETABS (cust
);
376 compunit_language (const struct compunit_symtab
*cust
)
378 struct symtab
*symtab
= compunit_primary_filetab (cust
);
380 /* The language of the compunit symtab is the language of its primary
382 return SYMTAB_LANGUAGE (symtab
);
388 minimal_symbol::data_p () const
390 return type
== mst_data
393 || type
== mst_file_data
394 || type
== mst_file_bss
;
400 minimal_symbol::text_p () const
402 return type
== mst_text
403 || type
== mst_text_gnu_ifunc
404 || type
== mst_data_gnu_ifunc
405 || type
== mst_slot_got_plt
406 || type
== mst_solib_trampoline
407 || type
== mst_file_text
;
410 /* See whether FILENAME matches SEARCH_NAME using the rule that we
411 advertise to the user. (The manual's description of linespecs
412 describes what we advertise). Returns true if they match, false
416 compare_filenames_for_search (const char *filename
, const char *search_name
)
418 int len
= strlen (filename
);
419 size_t search_len
= strlen (search_name
);
421 if (len
< search_len
)
424 /* The tail of FILENAME must match. */
425 if (FILENAME_CMP (filename
+ len
- search_len
, search_name
) != 0)
428 /* Either the names must completely match, or the character
429 preceding the trailing SEARCH_NAME segment of FILENAME must be a
432 The check !IS_ABSOLUTE_PATH ensures SEARCH_NAME "/dir/file.c"
433 cannot match FILENAME "/path//dir/file.c" - as user has requested
434 absolute path. The sama applies for "c:\file.c" possibly
435 incorrectly hypothetically matching "d:\dir\c:\file.c".
437 The HAS_DRIVE_SPEC purpose is to make FILENAME "c:file.c"
438 compatible with SEARCH_NAME "file.c". In such case a compiler had
439 to put the "c:file.c" name into debug info. Such compatibility
440 works only on GDB built for DOS host. */
441 return (len
== search_len
442 || (!IS_ABSOLUTE_PATH (search_name
)
443 && IS_DIR_SEPARATOR (filename
[len
- search_len
- 1]))
444 || (HAS_DRIVE_SPEC (filename
)
445 && STRIP_DRIVE_SPEC (filename
) == &filename
[len
- search_len
]));
448 /* Same as compare_filenames_for_search, but for glob-style patterns.
449 Heads up on the order of the arguments. They match the order of
450 compare_filenames_for_search, but it's the opposite of the order of
451 arguments to gdb_filename_fnmatch. */
454 compare_glob_filenames_for_search (const char *filename
,
455 const char *search_name
)
457 /* We rely on the property of glob-style patterns with FNM_FILE_NAME that
458 all /s have to be explicitly specified. */
459 int file_path_elements
= count_path_elements (filename
);
460 int search_path_elements
= count_path_elements (search_name
);
462 if (search_path_elements
> file_path_elements
)
465 if (IS_ABSOLUTE_PATH (search_name
))
467 return (search_path_elements
== file_path_elements
468 && gdb_filename_fnmatch (search_name
, filename
,
469 FNM_FILE_NAME
| FNM_NOESCAPE
) == 0);
473 const char *file_to_compare
474 = strip_leading_path_elements (filename
,
475 file_path_elements
- search_path_elements
);
477 return gdb_filename_fnmatch (search_name
, file_to_compare
,
478 FNM_FILE_NAME
| FNM_NOESCAPE
) == 0;
482 /* Check for a symtab of a specific name by searching some symtabs.
483 This is a helper function for callbacks of iterate_over_symtabs.
485 If NAME is not absolute, then REAL_PATH is NULL
486 If NAME is absolute, then REAL_PATH is the gdb_realpath form of NAME.
488 The return value, NAME, REAL_PATH and CALLBACK are identical to the
489 `map_symtabs_matching_filename' method of quick_symbol_functions.
491 FIRST and AFTER_LAST indicate the range of compunit symtabs to search.
492 Each symtab within the specified compunit symtab is also searched.
493 AFTER_LAST is one past the last compunit symtab to search; NULL means to
494 search until the end of the list. */
497 iterate_over_some_symtabs (const char *name
,
498 const char *real_path
,
499 struct compunit_symtab
*first
,
500 struct compunit_symtab
*after_last
,
501 gdb::function_view
<bool (symtab
*)> callback
)
503 struct compunit_symtab
*cust
;
504 const char* base_name
= lbasename (name
);
506 for (cust
= first
; cust
!= NULL
&& cust
!= after_last
; cust
= cust
->next
)
508 for (symtab
*s
: compunit_filetabs (cust
))
510 if (compare_filenames_for_search (s
->filename
, name
))
517 /* Before we invoke realpath, which can get expensive when many
518 files are involved, do a quick comparison of the basenames. */
519 if (! basenames_may_differ
520 && FILENAME_CMP (base_name
, lbasename (s
->filename
)) != 0)
523 if (compare_filenames_for_search (symtab_to_fullname (s
), name
))
530 /* If the user gave us an absolute path, try to find the file in
531 this symtab and use its absolute path. */
532 if (real_path
!= NULL
)
534 const char *fullname
= symtab_to_fullname (s
);
536 gdb_assert (IS_ABSOLUTE_PATH (real_path
));
537 gdb_assert (IS_ABSOLUTE_PATH (name
));
538 gdb::unique_xmalloc_ptr
<char> fullname_real_path
539 = gdb_realpath (fullname
);
540 fullname
= fullname_real_path
.get ();
541 if (FILENAME_CMP (real_path
, fullname
) == 0)
554 /* Check for a symtab of a specific name; first in symtabs, then in
555 psymtabs. *If* there is no '/' in the name, a match after a '/'
556 in the symtab filename will also work.
558 Calls CALLBACK with each symtab that is found. If CALLBACK returns
559 true, the search stops. */
562 iterate_over_symtabs (const char *name
,
563 gdb::function_view
<bool (symtab
*)> callback
)
565 gdb::unique_xmalloc_ptr
<char> real_path
;
567 /* Here we are interested in canonicalizing an absolute path, not
568 absolutizing a relative path. */
569 if (IS_ABSOLUTE_PATH (name
))
571 real_path
= gdb_realpath (name
);
572 gdb_assert (IS_ABSOLUTE_PATH (real_path
.get ()));
575 for (objfile
*objfile
: current_program_space
->objfiles ())
577 if (iterate_over_some_symtabs (name
, real_path
.get (),
578 objfile
->compunit_symtabs
, NULL
,
583 /* Same search rules as above apply here, but now we look thru the
586 for (objfile
*objfile
: current_program_space
->objfiles ())
588 if (objfile
->map_symtabs_matching_filename (name
, real_path
.get (),
594 /* A wrapper for iterate_over_symtabs that returns the first matching
598 lookup_symtab (const char *name
)
600 struct symtab
*result
= NULL
;
602 iterate_over_symtabs (name
, [&] (symtab
*symtab
)
612 /* Mangle a GDB method stub type. This actually reassembles the pieces of the
613 full method name, which consist of the class name (from T), the unadorned
614 method name from METHOD_ID, and the signature for the specific overload,
615 specified by SIGNATURE_ID. Note that this function is g++ specific. */
618 gdb_mangle_name (struct type
*type
, int method_id
, int signature_id
)
620 int mangled_name_len
;
622 struct fn_field
*f
= TYPE_FN_FIELDLIST1 (type
, method_id
);
623 struct fn_field
*method
= &f
[signature_id
];
624 const char *field_name
= TYPE_FN_FIELDLIST_NAME (type
, method_id
);
625 const char *physname
= TYPE_FN_FIELD_PHYSNAME (f
, signature_id
);
626 const char *newname
= type
->name ();
628 /* Does the form of physname indicate that it is the full mangled name
629 of a constructor (not just the args)? */
630 int is_full_physname_constructor
;
633 int is_destructor
= is_destructor_name (physname
);
634 /* Need a new type prefix. */
635 const char *const_prefix
= method
->is_const
? "C" : "";
636 const char *volatile_prefix
= method
->is_volatile
? "V" : "";
638 int len
= (newname
== NULL
? 0 : strlen (newname
));
640 /* Nothing to do if physname already contains a fully mangled v3 abi name
641 or an operator name. */
642 if ((physname
[0] == '_' && physname
[1] == 'Z')
643 || is_operator_name (field_name
))
644 return xstrdup (physname
);
646 is_full_physname_constructor
= is_constructor_name (physname
);
648 is_constructor
= is_full_physname_constructor
649 || (newname
&& strcmp (field_name
, newname
) == 0);
652 is_destructor
= (startswith (physname
, "__dt"));
654 if (is_destructor
|| is_full_physname_constructor
)
656 mangled_name
= (char *) xmalloc (strlen (physname
) + 1);
657 strcpy (mangled_name
, physname
);
663 xsnprintf (buf
, sizeof (buf
), "__%s%s", const_prefix
, volatile_prefix
);
665 else if (physname
[0] == 't' || physname
[0] == 'Q')
667 /* The physname for template and qualified methods already includes
669 xsnprintf (buf
, sizeof (buf
), "__%s%s", const_prefix
, volatile_prefix
);
675 xsnprintf (buf
, sizeof (buf
), "__%s%s%d", const_prefix
,
676 volatile_prefix
, len
);
678 mangled_name_len
= ((is_constructor
? 0 : strlen (field_name
))
679 + strlen (buf
) + len
+ strlen (physname
) + 1);
681 mangled_name
= (char *) xmalloc (mangled_name_len
);
683 mangled_name
[0] = '\0';
685 strcpy (mangled_name
, field_name
);
687 strcat (mangled_name
, buf
);
688 /* If the class doesn't have a name, i.e. newname NULL, then we just
689 mangle it using 0 for the length of the class. Thus it gets mangled
690 as something starting with `::' rather than `classname::'. */
692 strcat (mangled_name
, newname
);
694 strcat (mangled_name
, physname
);
695 return (mangled_name
);
701 general_symbol_info::set_demangled_name (const char *name
,
702 struct obstack
*obstack
)
704 if (language () == language_ada
)
709 language_specific
.obstack
= obstack
;
714 language_specific
.demangled_name
= name
;
718 language_specific
.demangled_name
= name
;
722 /* Initialize the language dependent portion of a symbol
723 depending upon the language for the symbol. */
726 general_symbol_info::set_language (enum language language
,
727 struct obstack
*obstack
)
729 m_language
= language
;
730 if (language
== language_cplus
731 || language
== language_d
732 || language
== language_go
733 || language
== language_objc
734 || language
== language_fortran
)
736 set_demangled_name (NULL
, obstack
);
738 else if (language
== language_ada
)
740 gdb_assert (ada_mangled
== 0);
741 language_specific
.obstack
= obstack
;
745 memset (&language_specific
, 0, sizeof (language_specific
));
749 /* Functions to initialize a symbol's mangled name. */
751 /* Objects of this type are stored in the demangled name hash table. */
752 struct demangled_name_entry
754 demangled_name_entry (gdb::string_view mangled_name
)
755 : mangled (mangled_name
) {}
757 gdb::string_view mangled
;
758 enum language language
;
759 gdb::unique_xmalloc_ptr
<char> demangled
;
762 /* Hash function for the demangled name hash. */
765 hash_demangled_name_entry (const void *data
)
767 const struct demangled_name_entry
*e
768 = (const struct demangled_name_entry
*) data
;
770 return fast_hash (e
->mangled
.data (), e
->mangled
.length ());
773 /* Equality function for the demangled name hash. */
776 eq_demangled_name_entry (const void *a
, const void *b
)
778 const struct demangled_name_entry
*da
779 = (const struct demangled_name_entry
*) a
;
780 const struct demangled_name_entry
*db
781 = (const struct demangled_name_entry
*) b
;
783 return da
->mangled
== db
->mangled
;
787 free_demangled_name_entry (void *data
)
789 struct demangled_name_entry
*e
790 = (struct demangled_name_entry
*) data
;
792 e
->~demangled_name_entry();
795 /* Create the hash table used for demangled names. Each hash entry is
796 a pair of strings; one for the mangled name and one for the demangled
797 name. The entry is hashed via just the mangled name. */
800 create_demangled_names_hash (struct objfile_per_bfd_storage
*per_bfd
)
802 /* Choose 256 as the starting size of the hash table, somewhat arbitrarily.
803 The hash table code will round this up to the next prime number.
804 Choosing a much larger table size wastes memory, and saves only about
805 1% in symbol reading. However, if the minsym count is already
806 initialized (e.g. because symbol name setting was deferred to
807 a background thread) we can initialize the hashtable with a count
808 based on that, because we will almost certainly have at least that
809 many entries. If we have a nonzero number but less than 256,
810 we still stay with 256 to have some space for psymbols, etc. */
812 /* htab will expand the table when it is 3/4th full, so we account for that
813 here. +2 to round up. */
814 int minsym_based_count
= (per_bfd
->minimal_symbol_count
+ 2) / 3 * 4;
815 int count
= std::max (per_bfd
->minimal_symbol_count
, minsym_based_count
);
817 per_bfd
->demangled_names_hash
.reset (htab_create_alloc
818 (count
, hash_demangled_name_entry
, eq_demangled_name_entry
,
819 free_demangled_name_entry
, xcalloc
, xfree
));
824 gdb::unique_xmalloc_ptr
<char>
825 symbol_find_demangled_name (struct general_symbol_info
*gsymbol
,
828 gdb::unique_xmalloc_ptr
<char> demangled
;
831 if (gsymbol
->language () == language_unknown
)
832 gsymbol
->m_language
= language_auto
;
834 if (gsymbol
->language () != language_auto
)
836 const struct language_defn
*lang
= language_def (gsymbol
->language ());
838 lang
->sniff_from_mangled_name (mangled
, &demangled
);
842 for (i
= language_unknown
; i
< nr_languages
; ++i
)
844 enum language l
= (enum language
) i
;
845 const struct language_defn
*lang
= language_def (l
);
847 if (lang
->sniff_from_mangled_name (mangled
, &demangled
))
849 gsymbol
->m_language
= l
;
857 /* Set both the mangled and demangled (if any) names for GSYMBOL based
858 on LINKAGE_NAME and LEN. Ordinarily, NAME is copied onto the
859 objfile's obstack; but if COPY_NAME is 0 and if NAME is
860 NUL-terminated, then this function assumes that NAME is already
861 correctly saved (either permanently or with a lifetime tied to the
862 objfile), and it will not be copied.
864 The hash table corresponding to OBJFILE is used, and the memory
865 comes from the per-BFD storage_obstack. LINKAGE_NAME is copied,
866 so the pointer can be discarded after calling this function. */
869 general_symbol_info::compute_and_set_names (gdb::string_view linkage_name
,
871 objfile_per_bfd_storage
*per_bfd
,
872 gdb::optional
<hashval_t
> hash
)
874 struct demangled_name_entry
**slot
;
876 if (language () == language_ada
)
878 /* In Ada, we do the symbol lookups using the mangled name, so
879 we can save some space by not storing the demangled name. */
881 m_name
= linkage_name
.data ();
883 m_name
= obstack_strndup (&per_bfd
->storage_obstack
,
884 linkage_name
.data (),
885 linkage_name
.length ());
886 set_demangled_name (NULL
, &per_bfd
->storage_obstack
);
891 if (per_bfd
->demangled_names_hash
== NULL
)
892 create_demangled_names_hash (per_bfd
);
894 struct demangled_name_entry
entry (linkage_name
);
895 if (!hash
.has_value ())
896 hash
= hash_demangled_name_entry (&entry
);
897 slot
= ((struct demangled_name_entry
**)
898 htab_find_slot_with_hash (per_bfd
->demangled_names_hash
.get (),
899 &entry
, *hash
, INSERT
));
901 /* The const_cast is safe because the only reason it is already
902 initialized is if we purposefully set it from a background
903 thread to avoid doing the work here. However, it is still
904 allocated from the heap and needs to be freed by us, just
905 like if we called symbol_find_demangled_name here. If this is
906 nullptr, we call symbol_find_demangled_name below, but we put
907 this smart pointer here to be sure that we don't leak this name. */
908 gdb::unique_xmalloc_ptr
<char> demangled_name
909 (const_cast<char *> (language_specific
.demangled_name
));
911 /* If this name is not in the hash table, add it. */
913 /* A C version of the symbol may have already snuck into the table.
914 This happens to, e.g., main.init (__go_init_main). Cope. */
915 || (language () == language_go
&& (*slot
)->demangled
== nullptr))
917 /* A 0-terminated copy of the linkage name. Callers must set COPY_NAME
918 to true if the string might not be nullterminated. We have to make
919 this copy because demangling needs a nullterminated string. */
920 gdb::string_view linkage_name_copy
;
923 char *alloc_name
= (char *) alloca (linkage_name
.length () + 1);
924 memcpy (alloc_name
, linkage_name
.data (), linkage_name
.length ());
925 alloc_name
[linkage_name
.length ()] = '\0';
927 linkage_name_copy
= gdb::string_view (alloc_name
,
928 linkage_name
.length ());
931 linkage_name_copy
= linkage_name
;
933 if (demangled_name
.get () == nullptr)
935 = symbol_find_demangled_name (this, linkage_name_copy
.data ());
937 /* Suppose we have demangled_name==NULL, copy_name==0, and
938 linkage_name_copy==linkage_name. In this case, we already have the
939 mangled name saved, and we don't have a demangled name. So,
940 you might think we could save a little space by not recording
941 this in the hash table at all.
943 It turns out that it is actually important to still save such
944 an entry in the hash table, because storing this name gives
945 us better bcache hit rates for partial symbols. */
949 = ((struct demangled_name_entry
*)
950 obstack_alloc (&per_bfd
->storage_obstack
,
951 sizeof (demangled_name_entry
)));
952 new (*slot
) demangled_name_entry (linkage_name
);
956 /* If we must copy the mangled name, put it directly after
957 the struct so we can have a single allocation. */
959 = ((struct demangled_name_entry
*)
960 obstack_alloc (&per_bfd
->storage_obstack
,
961 sizeof (demangled_name_entry
)
962 + linkage_name
.length () + 1));
963 char *mangled_ptr
= reinterpret_cast<char *> (*slot
+ 1);
964 memcpy (mangled_ptr
, linkage_name
.data (), linkage_name
.length ());
965 mangled_ptr
[linkage_name
.length ()] = '\0';
966 new (*slot
) demangled_name_entry
967 (gdb::string_view (mangled_ptr
, linkage_name
.length ()));
969 (*slot
)->demangled
= std::move (demangled_name
);
970 (*slot
)->language
= language ();
972 else if (language () == language_unknown
|| language () == language_auto
)
973 m_language
= (*slot
)->language
;
975 m_name
= (*slot
)->mangled
.data ();
976 set_demangled_name ((*slot
)->demangled
.get (), &per_bfd
->storage_obstack
);
982 general_symbol_info::natural_name () const
990 case language_fortran
:
992 if (language_specific
.demangled_name
!= nullptr)
993 return language_specific
.demangled_name
;
996 return ada_decode_symbol (this);
1000 return linkage_name ();
1006 general_symbol_info::demangled_name () const
1008 const char *dem_name
= NULL
;
1010 switch (language ())
1012 case language_cplus
:
1016 case language_fortran
:
1018 dem_name
= language_specific
.demangled_name
;
1021 dem_name
= ada_decode_symbol (this);
1032 general_symbol_info::search_name () const
1034 if (language () == language_ada
)
1035 return linkage_name ();
1037 return natural_name ();
1042 struct obj_section
*
1043 general_symbol_info::obj_section (const struct objfile
*objfile
) const
1045 if (section_index () >= 0)
1046 return &objfile
->sections
[section_index ()];
1053 symbol_matches_search_name (const struct general_symbol_info
*gsymbol
,
1054 const lookup_name_info
&name
)
1056 symbol_name_matcher_ftype
*name_match
1057 = language_def (gsymbol
->language ())->get_symbol_name_matcher (name
);
1058 return name_match (gsymbol
->search_name (), name
, NULL
);
1063 /* Return true if the two sections are the same, or if they could
1064 plausibly be copies of each other, one in an original object
1065 file and another in a separated debug file. */
1068 matching_obj_sections (struct obj_section
*obj_first
,
1069 struct obj_section
*obj_second
)
1071 asection
*first
= obj_first
? obj_first
->the_bfd_section
: NULL
;
1072 asection
*second
= obj_second
? obj_second
->the_bfd_section
: NULL
;
1074 /* If they're the same section, then they match. */
1075 if (first
== second
)
1078 /* If either is NULL, give up. */
1079 if (first
== NULL
|| second
== NULL
)
1082 /* This doesn't apply to absolute symbols. */
1083 if (first
->owner
== NULL
|| second
->owner
== NULL
)
1086 /* If they're in the same object file, they must be different sections. */
1087 if (first
->owner
== second
->owner
)
1090 /* Check whether the two sections are potentially corresponding. They must
1091 have the same size, address, and name. We can't compare section indexes,
1092 which would be more reliable, because some sections may have been
1094 if (bfd_section_size (first
) != bfd_section_size (second
))
1097 /* In-memory addresses may start at a different offset, relativize them. */
1098 if (bfd_section_vma (first
) - bfd_get_start_address (first
->owner
)
1099 != bfd_section_vma (second
) - bfd_get_start_address (second
->owner
))
1102 if (bfd_section_name (first
) == NULL
1103 || bfd_section_name (second
) == NULL
1104 || strcmp (bfd_section_name (first
), bfd_section_name (second
)) != 0)
1107 /* Otherwise check that they are in corresponding objfiles. */
1109 struct objfile
*obj
= NULL
;
1110 for (objfile
*objfile
: current_program_space
->objfiles ())
1111 if (objfile
->obfd
== first
->owner
)
1116 gdb_assert (obj
!= NULL
);
1118 if (obj
->separate_debug_objfile
!= NULL
1119 && obj
->separate_debug_objfile
->obfd
== second
->owner
)
1121 if (obj
->separate_debug_objfile_backlink
!= NULL
1122 && obj
->separate_debug_objfile_backlink
->obfd
== second
->owner
)
1131 expand_symtab_containing_pc (CORE_ADDR pc
, struct obj_section
*section
)
1133 struct bound_minimal_symbol msymbol
;
1135 /* If we know that this is not a text address, return failure. This is
1136 necessary because we loop based on texthigh and textlow, which do
1137 not include the data ranges. */
1138 msymbol
= lookup_minimal_symbol_by_pc_section (pc
, section
);
1139 if (msymbol
.minsym
&& msymbol
.minsym
->data_p ())
1142 for (objfile
*objfile
: current_program_space
->objfiles ())
1144 struct compunit_symtab
*cust
1145 = objfile
->find_pc_sect_compunit_symtab (msymbol
, pc
, section
, 0);
1151 /* Hash function for the symbol cache. */
1154 hash_symbol_entry (const struct objfile
*objfile_context
,
1155 const char *name
, domain_enum domain
)
1157 unsigned int hash
= (uintptr_t) objfile_context
;
1160 hash
+= htab_hash_string (name
);
1162 /* Because of symbol_matches_domain we need VAR_DOMAIN and STRUCT_DOMAIN
1163 to map to the same slot. */
1164 if (domain
== STRUCT_DOMAIN
)
1165 hash
+= VAR_DOMAIN
* 7;
1172 /* Equality function for the symbol cache. */
1175 eq_symbol_entry (const struct symbol_cache_slot
*slot
,
1176 const struct objfile
*objfile_context
,
1177 const char *name
, domain_enum domain
)
1179 const char *slot_name
;
1180 domain_enum slot_domain
;
1182 if (slot
->state
== SYMBOL_SLOT_UNUSED
)
1185 if (slot
->objfile_context
!= objfile_context
)
1188 if (slot
->state
== SYMBOL_SLOT_NOT_FOUND
)
1190 slot_name
= slot
->value
.not_found
.name
;
1191 slot_domain
= slot
->value
.not_found
.domain
;
1195 slot_name
= slot
->value
.found
.symbol
->search_name ();
1196 slot_domain
= SYMBOL_DOMAIN (slot
->value
.found
.symbol
);
1199 /* NULL names match. */
1200 if (slot_name
== NULL
&& name
== NULL
)
1202 /* But there's no point in calling symbol_matches_domain in the
1203 SYMBOL_SLOT_FOUND case. */
1204 if (slot_domain
!= domain
)
1207 else if (slot_name
!= NULL
&& name
!= NULL
)
1209 /* It's important that we use the same comparison that was done
1210 the first time through. If the slot records a found symbol,
1211 then this means using the symbol name comparison function of
1212 the symbol's language with symbol->search_name (). See
1213 dictionary.c. It also means using symbol_matches_domain for
1214 found symbols. See block.c.
1216 If the slot records a not-found symbol, then require a precise match.
1217 We could still be lax with whitespace like strcmp_iw though. */
1219 if (slot
->state
== SYMBOL_SLOT_NOT_FOUND
)
1221 if (strcmp (slot_name
, name
) != 0)
1223 if (slot_domain
!= domain
)
1228 struct symbol
*sym
= slot
->value
.found
.symbol
;
1229 lookup_name_info
lookup_name (name
, symbol_name_match_type::FULL
);
1231 if (!SYMBOL_MATCHES_SEARCH_NAME (sym
, lookup_name
))
1234 if (!symbol_matches_domain (sym
->language (), slot_domain
, domain
))
1240 /* Only one name is NULL. */
1247 /* Given a cache of size SIZE, return the size of the struct (with variable
1248 length array) in bytes. */
1251 symbol_cache_byte_size (unsigned int size
)
1253 return (sizeof (struct block_symbol_cache
)
1254 + ((size
- 1) * sizeof (struct symbol_cache_slot
)));
1260 resize_symbol_cache (struct symbol_cache
*cache
, unsigned int new_size
)
1262 /* If there's no change in size, don't do anything.
1263 All caches have the same size, so we can just compare with the size
1264 of the global symbols cache. */
1265 if ((cache
->global_symbols
!= NULL
1266 && cache
->global_symbols
->size
== new_size
)
1267 || (cache
->global_symbols
== NULL
1271 destroy_block_symbol_cache (cache
->global_symbols
);
1272 destroy_block_symbol_cache (cache
->static_symbols
);
1276 cache
->global_symbols
= NULL
;
1277 cache
->static_symbols
= NULL
;
1281 size_t total_size
= symbol_cache_byte_size (new_size
);
1283 cache
->global_symbols
1284 = (struct block_symbol_cache
*) xcalloc (1, total_size
);
1285 cache
->static_symbols
1286 = (struct block_symbol_cache
*) xcalloc (1, total_size
);
1287 cache
->global_symbols
->size
= new_size
;
1288 cache
->static_symbols
->size
= new_size
;
1292 /* Return the symbol cache of PSPACE.
1293 Create one if it doesn't exist yet. */
1295 static struct symbol_cache
*
1296 get_symbol_cache (struct program_space
*pspace
)
1298 struct symbol_cache
*cache
= symbol_cache_key
.get (pspace
);
1302 cache
= symbol_cache_key
.emplace (pspace
);
1303 resize_symbol_cache (cache
, symbol_cache_size
);
1309 /* Set the size of the symbol cache in all program spaces. */
1312 set_symbol_cache_size (unsigned int new_size
)
1314 for (struct program_space
*pspace
: program_spaces
)
1316 struct symbol_cache
*cache
= symbol_cache_key
.get (pspace
);
1318 /* The pspace could have been created but not have a cache yet. */
1320 resize_symbol_cache (cache
, new_size
);
1324 /* Called when symbol-cache-size is set. */
1327 set_symbol_cache_size_handler (const char *args
, int from_tty
,
1328 struct cmd_list_element
*c
)
1330 if (new_symbol_cache_size
> MAX_SYMBOL_CACHE_SIZE
)
1332 /* Restore the previous value.
1333 This is the value the "show" command prints. */
1334 new_symbol_cache_size
= symbol_cache_size
;
1336 error (_("Symbol cache size is too large, max is %u."),
1337 MAX_SYMBOL_CACHE_SIZE
);
1339 symbol_cache_size
= new_symbol_cache_size
;
1341 set_symbol_cache_size (symbol_cache_size
);
1344 /* Lookup symbol NAME,DOMAIN in BLOCK in the symbol cache of PSPACE.
1345 OBJFILE_CONTEXT is the current objfile, which may be NULL.
1346 The result is the symbol if found, SYMBOL_LOOKUP_FAILED if a previous lookup
1347 failed (and thus this one will too), or NULL if the symbol is not present
1349 *BSC_PTR and *SLOT_PTR are set to the cache and slot of the symbol, which
1350 can be used to save the result of a full lookup attempt. */
1352 static struct block_symbol
1353 symbol_cache_lookup (struct symbol_cache
*cache
,
1354 struct objfile
*objfile_context
, enum block_enum block
,
1355 const char *name
, domain_enum domain
,
1356 struct block_symbol_cache
**bsc_ptr
,
1357 struct symbol_cache_slot
**slot_ptr
)
1359 struct block_symbol_cache
*bsc
;
1361 struct symbol_cache_slot
*slot
;
1363 if (block
== GLOBAL_BLOCK
)
1364 bsc
= cache
->global_symbols
;
1366 bsc
= cache
->static_symbols
;
1374 hash
= hash_symbol_entry (objfile_context
, name
, domain
);
1375 slot
= bsc
->symbols
+ hash
% bsc
->size
;
1380 if (eq_symbol_entry (slot
, objfile_context
, name
, domain
))
1382 if (symbol_lookup_debug
)
1383 fprintf_unfiltered (gdb_stdlog
,
1384 "%s block symbol cache hit%s for %s, %s\n",
1385 block
== GLOBAL_BLOCK
? "Global" : "Static",
1386 slot
->state
== SYMBOL_SLOT_NOT_FOUND
1387 ? " (not found)" : "",
1388 name
, domain_name (domain
));
1390 if (slot
->state
== SYMBOL_SLOT_NOT_FOUND
)
1391 return SYMBOL_LOOKUP_FAILED
;
1392 return slot
->value
.found
;
1395 /* Symbol is not present in the cache. */
1397 if (symbol_lookup_debug
)
1399 fprintf_unfiltered (gdb_stdlog
,
1400 "%s block symbol cache miss for %s, %s\n",
1401 block
== GLOBAL_BLOCK
? "Global" : "Static",
1402 name
, domain_name (domain
));
1408 /* Mark SYMBOL as found in SLOT.
1409 OBJFILE_CONTEXT is the current objfile when the lookup was done, or NULL
1410 if it's not needed to distinguish lookups (STATIC_BLOCK). It is *not*
1411 necessarily the objfile the symbol was found in. */
1414 symbol_cache_mark_found (struct block_symbol_cache
*bsc
,
1415 struct symbol_cache_slot
*slot
,
1416 struct objfile
*objfile_context
,
1417 struct symbol
*symbol
,
1418 const struct block
*block
)
1422 if (slot
->state
!= SYMBOL_SLOT_UNUSED
)
1425 symbol_cache_clear_slot (slot
);
1427 slot
->state
= SYMBOL_SLOT_FOUND
;
1428 slot
->objfile_context
= objfile_context
;
1429 slot
->value
.found
.symbol
= symbol
;
1430 slot
->value
.found
.block
= block
;
1433 /* Mark symbol NAME, DOMAIN as not found in SLOT.
1434 OBJFILE_CONTEXT is the current objfile when the lookup was done, or NULL
1435 if it's not needed to distinguish lookups (STATIC_BLOCK). */
1438 symbol_cache_mark_not_found (struct block_symbol_cache
*bsc
,
1439 struct symbol_cache_slot
*slot
,
1440 struct objfile
*objfile_context
,
1441 const char *name
, domain_enum domain
)
1445 if (slot
->state
!= SYMBOL_SLOT_UNUSED
)
1448 symbol_cache_clear_slot (slot
);
1450 slot
->state
= SYMBOL_SLOT_NOT_FOUND
;
1451 slot
->objfile_context
= objfile_context
;
1452 slot
->value
.not_found
.name
= xstrdup (name
);
1453 slot
->value
.not_found
.domain
= domain
;
1456 /* Flush the symbol cache of PSPACE. */
1459 symbol_cache_flush (struct program_space
*pspace
)
1461 struct symbol_cache
*cache
= symbol_cache_key
.get (pspace
);
1466 if (cache
->global_symbols
== NULL
)
1468 gdb_assert (symbol_cache_size
== 0);
1469 gdb_assert (cache
->static_symbols
== NULL
);
1473 /* If the cache is untouched since the last flush, early exit.
1474 This is important for performance during the startup of a program linked
1475 with 100s (or 1000s) of shared libraries. */
1476 if (cache
->global_symbols
->misses
== 0
1477 && cache
->static_symbols
->misses
== 0)
1480 gdb_assert (cache
->global_symbols
->size
== symbol_cache_size
);
1481 gdb_assert (cache
->static_symbols
->size
== symbol_cache_size
);
1483 for (pass
= 0; pass
< 2; ++pass
)
1485 struct block_symbol_cache
*bsc
1486 = pass
== 0 ? cache
->global_symbols
: cache
->static_symbols
;
1489 for (i
= 0; i
< bsc
->size
; ++i
)
1490 symbol_cache_clear_slot (&bsc
->symbols
[i
]);
1493 cache
->global_symbols
->hits
= 0;
1494 cache
->global_symbols
->misses
= 0;
1495 cache
->global_symbols
->collisions
= 0;
1496 cache
->static_symbols
->hits
= 0;
1497 cache
->static_symbols
->misses
= 0;
1498 cache
->static_symbols
->collisions
= 0;
1504 symbol_cache_dump (const struct symbol_cache
*cache
)
1508 if (cache
->global_symbols
== NULL
)
1510 printf_filtered (" <disabled>\n");
1514 for (pass
= 0; pass
< 2; ++pass
)
1516 const struct block_symbol_cache
*bsc
1517 = pass
== 0 ? cache
->global_symbols
: cache
->static_symbols
;
1521 printf_filtered ("Global symbols:\n");
1523 printf_filtered ("Static symbols:\n");
1525 for (i
= 0; i
< bsc
->size
; ++i
)
1527 const struct symbol_cache_slot
*slot
= &bsc
->symbols
[i
];
1531 switch (slot
->state
)
1533 case SYMBOL_SLOT_UNUSED
:
1535 case SYMBOL_SLOT_NOT_FOUND
:
1536 printf_filtered (" [%4u] = %s, %s %s (not found)\n", i
,
1537 host_address_to_string (slot
->objfile_context
),
1538 slot
->value
.not_found
.name
,
1539 domain_name (slot
->value
.not_found
.domain
));
1541 case SYMBOL_SLOT_FOUND
:
1543 struct symbol
*found
= slot
->value
.found
.symbol
;
1544 const struct objfile
*context
= slot
->objfile_context
;
1546 printf_filtered (" [%4u] = %s, %s %s\n", i
,
1547 host_address_to_string (context
),
1548 found
->print_name (),
1549 domain_name (SYMBOL_DOMAIN (found
)));
1557 /* The "mt print symbol-cache" command. */
1560 maintenance_print_symbol_cache (const char *args
, int from_tty
)
1562 for (struct program_space
*pspace
: program_spaces
)
1564 struct symbol_cache
*cache
;
1566 printf_filtered (_("Symbol cache for pspace %d\n%s:\n"),
1568 pspace
->symfile_object_file
!= NULL
1569 ? objfile_name (pspace
->symfile_object_file
)
1570 : "(no object file)");
1572 /* If the cache hasn't been created yet, avoid creating one. */
1573 cache
= symbol_cache_key
.get (pspace
);
1575 printf_filtered (" <empty>\n");
1577 symbol_cache_dump (cache
);
1581 /* The "mt flush-symbol-cache" command. */
1584 maintenance_flush_symbol_cache (const char *args
, int from_tty
)
1586 for (struct program_space
*pspace
: program_spaces
)
1588 symbol_cache_flush (pspace
);
1592 /* Print usage statistics of CACHE. */
1595 symbol_cache_stats (struct symbol_cache
*cache
)
1599 if (cache
->global_symbols
== NULL
)
1601 printf_filtered (" <disabled>\n");
1605 for (pass
= 0; pass
< 2; ++pass
)
1607 const struct block_symbol_cache
*bsc
1608 = pass
== 0 ? cache
->global_symbols
: cache
->static_symbols
;
1613 printf_filtered ("Global block cache stats:\n");
1615 printf_filtered ("Static block cache stats:\n");
1617 printf_filtered (" size: %u\n", bsc
->size
);
1618 printf_filtered (" hits: %u\n", bsc
->hits
);
1619 printf_filtered (" misses: %u\n", bsc
->misses
);
1620 printf_filtered (" collisions: %u\n", bsc
->collisions
);
1624 /* The "mt print symbol-cache-statistics" command. */
1627 maintenance_print_symbol_cache_statistics (const char *args
, int from_tty
)
1629 for (struct program_space
*pspace
: program_spaces
)
1631 struct symbol_cache
*cache
;
1633 printf_filtered (_("Symbol cache statistics for pspace %d\n%s:\n"),
1635 pspace
->symfile_object_file
!= NULL
1636 ? objfile_name (pspace
->symfile_object_file
)
1637 : "(no object file)");
1639 /* If the cache hasn't been created yet, avoid creating one. */
1640 cache
= symbol_cache_key
.get (pspace
);
1642 printf_filtered (" empty, no stats available\n");
1644 symbol_cache_stats (cache
);
1648 /* This module's 'new_objfile' observer. */
1651 symtab_new_objfile_observer (struct objfile
*objfile
)
1653 /* Ideally we'd use OBJFILE->pspace, but OBJFILE may be NULL. */
1654 symbol_cache_flush (current_program_space
);
1657 /* This module's 'free_objfile' observer. */
1660 symtab_free_objfile_observer (struct objfile
*objfile
)
1662 symbol_cache_flush (objfile
->pspace
);
1665 /* Debug symbols usually don't have section information. We need to dig that
1666 out of the minimal symbols and stash that in the debug symbol. */
1669 fixup_section (struct general_symbol_info
*ginfo
,
1670 CORE_ADDR addr
, struct objfile
*objfile
)
1672 struct minimal_symbol
*msym
;
1674 /* First, check whether a minimal symbol with the same name exists
1675 and points to the same address. The address check is required
1676 e.g. on PowerPC64, where the minimal symbol for a function will
1677 point to the function descriptor, while the debug symbol will
1678 point to the actual function code. */
1679 msym
= lookup_minimal_symbol_by_pc_name (addr
, ginfo
->linkage_name (),
1682 ginfo
->set_section_index (msym
->section_index ());
1685 /* Static, function-local variables do appear in the linker
1686 (minimal) symbols, but are frequently given names that won't
1687 be found via lookup_minimal_symbol(). E.g., it has been
1688 observed in frv-uclinux (ELF) executables that a static,
1689 function-local variable named "foo" might appear in the
1690 linker symbols as "foo.6" or "foo.3". Thus, there is no
1691 point in attempting to extend the lookup-by-name mechanism to
1692 handle this case due to the fact that there can be multiple
1695 So, instead, search the section table when lookup by name has
1696 failed. The ``addr'' and ``endaddr'' fields may have already
1697 been relocated. If so, the relocation offset needs to be
1698 subtracted from these values when performing the comparison.
1699 We unconditionally subtract it, because, when no relocation
1700 has been performed, the value will simply be zero.
1702 The address of the symbol whose section we're fixing up HAS
1703 NOT BEEN adjusted (relocated) yet. It can't have been since
1704 the section isn't yet known and knowing the section is
1705 necessary in order to add the correct relocation value. In
1706 other words, we wouldn't even be in this function (attempting
1707 to compute the section) if it were already known.
1709 Note that it is possible to search the minimal symbols
1710 (subtracting the relocation value if necessary) to find the
1711 matching minimal symbol, but this is overkill and much less
1712 efficient. It is not necessary to find the matching minimal
1713 symbol, only its section.
1715 Note that this technique (of doing a section table search)
1716 can fail when unrelocated section addresses overlap. For
1717 this reason, we still attempt a lookup by name prior to doing
1718 a search of the section table. */
1720 struct obj_section
*s
;
1723 ALL_OBJFILE_OSECTIONS (objfile
, s
)
1725 int idx
= s
- objfile
->sections
;
1726 CORE_ADDR offset
= objfile
->section_offsets
[idx
];
1731 if (s
->addr () - offset
<= addr
&& addr
< s
->endaddr () - offset
)
1733 ginfo
->set_section_index (idx
);
1738 /* If we didn't find the section, assume it is in the first
1739 section. If there is no allocated section, then it hardly
1740 matters what we pick, so just pick zero. */
1742 ginfo
->set_section_index (0);
1744 ginfo
->set_section_index (fallback
);
1749 fixup_symbol_section (struct symbol
*sym
, struct objfile
*objfile
)
1756 if (!SYMBOL_OBJFILE_OWNED (sym
))
1759 /* We either have an OBJFILE, or we can get at it from the sym's
1760 symtab. Anything else is a bug. */
1761 gdb_assert (objfile
|| symbol_symtab (sym
));
1763 if (objfile
== NULL
)
1764 objfile
= symbol_objfile (sym
);
1766 if (sym
->obj_section (objfile
) != nullptr)
1769 /* We should have an objfile by now. */
1770 gdb_assert (objfile
);
1772 switch (SYMBOL_CLASS (sym
))
1776 addr
= SYMBOL_VALUE_ADDRESS (sym
);
1779 addr
= BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
));
1783 /* Nothing else will be listed in the minsyms -- no use looking
1788 fixup_section (sym
, addr
, objfile
);
1795 demangle_for_lookup_info::demangle_for_lookup_info
1796 (const lookup_name_info
&lookup_name
, language lang
)
1798 demangle_result_storage storage
;
1800 if (lookup_name
.ignore_parameters () && lang
== language_cplus
)
1802 gdb::unique_xmalloc_ptr
<char> without_params
1803 = cp_remove_params_if_any (lookup_name
.c_str (),
1804 lookup_name
.completion_mode ());
1806 if (without_params
!= NULL
)
1808 if (lookup_name
.match_type () != symbol_name_match_type::SEARCH_NAME
)
1809 m_demangled_name
= demangle_for_lookup (without_params
.get (),
1815 if (lookup_name
.match_type () == symbol_name_match_type::SEARCH_NAME
)
1816 m_demangled_name
= lookup_name
.c_str ();
1818 m_demangled_name
= demangle_for_lookup (lookup_name
.c_str (),
1824 const lookup_name_info
&
1825 lookup_name_info::match_any ()
1827 /* Lookup any symbol that "" would complete. I.e., this matches all
1829 static const lookup_name_info
lookup_name ("", symbol_name_match_type::FULL
,
1835 /* Compute the demangled form of NAME as used by the various symbol
1836 lookup functions. The result can either be the input NAME
1837 directly, or a pointer to a buffer owned by the STORAGE object.
1839 For Ada, this function just returns NAME, unmodified.
1840 Normally, Ada symbol lookups are performed using the encoded name
1841 rather than the demangled name, and so it might seem to make sense
1842 for this function to return an encoded version of NAME.
1843 Unfortunately, we cannot do this, because this function is used in
1844 circumstances where it is not appropriate to try to encode NAME.
1845 For instance, when displaying the frame info, we demangle the name
1846 of each parameter, and then perform a symbol lookup inside our
1847 function using that demangled name. In Ada, certain functions
1848 have internally-generated parameters whose name contain uppercase
1849 characters. Encoding those name would result in those uppercase
1850 characters to become lowercase, and thus cause the symbol lookup
1854 demangle_for_lookup (const char *name
, enum language lang
,
1855 demangle_result_storage
&storage
)
1857 /* If we are using C++, D, or Go, demangle the name before doing a
1858 lookup, so we can always binary search. */
1859 if (lang
== language_cplus
)
1861 gdb::unique_xmalloc_ptr
<char> demangled_name
1862 = gdb_demangle (name
, DMGL_ANSI
| DMGL_PARAMS
);
1863 if (demangled_name
!= NULL
)
1864 return storage
.set_malloc_ptr (std::move (demangled_name
));
1866 /* If we were given a non-mangled name, canonicalize it
1867 according to the language (so far only for C++). */
1868 gdb::unique_xmalloc_ptr
<char> canon
= cp_canonicalize_string (name
);
1869 if (canon
!= nullptr)
1870 return storage
.set_malloc_ptr (std::move (canon
));
1872 else if (lang
== language_d
)
1874 gdb::unique_xmalloc_ptr
<char> demangled_name
= d_demangle (name
, 0);
1875 if (demangled_name
!= NULL
)
1876 return storage
.set_malloc_ptr (std::move (demangled_name
));
1878 else if (lang
== language_go
)
1880 gdb::unique_xmalloc_ptr
<char> demangled_name
1881 = language_def (language_go
)->demangle_symbol (name
, 0);
1882 if (demangled_name
!= NULL
)
1883 return storage
.set_malloc_ptr (std::move (demangled_name
));
1892 search_name_hash (enum language language
, const char *search_name
)
1894 return language_def (language
)->search_name_hash (search_name
);
1899 This function (or rather its subordinates) have a bunch of loops and
1900 it would seem to be attractive to put in some QUIT's (though I'm not really
1901 sure whether it can run long enough to be really important). But there
1902 are a few calls for which it would appear to be bad news to quit
1903 out of here: e.g., find_proc_desc in alpha-mdebug-tdep.c. (Note
1904 that there is C++ code below which can error(), but that probably
1905 doesn't affect these calls since they are looking for a known
1906 variable and thus can probably assume it will never hit the C++
1910 lookup_symbol_in_language (const char *name
, const struct block
*block
,
1911 const domain_enum domain
, enum language lang
,
1912 struct field_of_this_result
*is_a_field_of_this
)
1914 demangle_result_storage storage
;
1915 const char *modified_name
= demangle_for_lookup (name
, lang
, storage
);
1917 return lookup_symbol_aux (modified_name
,
1918 symbol_name_match_type::FULL
,
1919 block
, domain
, lang
,
1920 is_a_field_of_this
);
1926 lookup_symbol (const char *name
, const struct block
*block
,
1928 struct field_of_this_result
*is_a_field_of_this
)
1930 return lookup_symbol_in_language (name
, block
, domain
,
1931 current_language
->la_language
,
1932 is_a_field_of_this
);
1938 lookup_symbol_search_name (const char *search_name
, const struct block
*block
,
1941 return lookup_symbol_aux (search_name
, symbol_name_match_type::SEARCH_NAME
,
1942 block
, domain
, language_asm
, NULL
);
1948 lookup_language_this (const struct language_defn
*lang
,
1949 const struct block
*block
)
1951 if (lang
->name_of_this () == NULL
|| block
== NULL
)
1954 if (symbol_lookup_debug
> 1)
1956 struct objfile
*objfile
= block_objfile (block
);
1958 fprintf_unfiltered (gdb_stdlog
,
1959 "lookup_language_this (%s, %s (objfile %s))",
1960 lang
->name (), host_address_to_string (block
),
1961 objfile_debug_name (objfile
));
1968 sym
= block_lookup_symbol (block
, lang
->name_of_this (),
1969 symbol_name_match_type::SEARCH_NAME
,
1973 if (symbol_lookup_debug
> 1)
1975 fprintf_unfiltered (gdb_stdlog
, " = %s (%s, block %s)\n",
1977 host_address_to_string (sym
),
1978 host_address_to_string (block
));
1980 return (struct block_symbol
) {sym
, block
};
1982 if (BLOCK_FUNCTION (block
))
1984 block
= BLOCK_SUPERBLOCK (block
);
1987 if (symbol_lookup_debug
> 1)
1988 fprintf_unfiltered (gdb_stdlog
, " = NULL\n");
1992 /* Given TYPE, a structure/union,
1993 return 1 if the component named NAME from the ultimate target
1994 structure/union is defined, otherwise, return 0. */
1997 check_field (struct type
*type
, const char *name
,
1998 struct field_of_this_result
*is_a_field_of_this
)
2002 /* The type may be a stub. */
2003 type
= check_typedef (type
);
2005 for (i
= type
->num_fields () - 1; i
>= TYPE_N_BASECLASSES (type
); i
--)
2007 const char *t_field_name
= type
->field (i
).name ();
2009 if (t_field_name
&& (strcmp_iw (t_field_name
, name
) == 0))
2011 is_a_field_of_this
->type
= type
;
2012 is_a_field_of_this
->field
= &type
->field (i
);
2017 /* C++: If it was not found as a data field, then try to return it
2018 as a pointer to a method. */
2020 for (i
= TYPE_NFN_FIELDS (type
) - 1; i
>= 0; --i
)
2022 if (strcmp_iw (TYPE_FN_FIELDLIST_NAME (type
, i
), name
) == 0)
2024 is_a_field_of_this
->type
= type
;
2025 is_a_field_of_this
->fn_field
= &TYPE_FN_FIELDLIST (type
, i
);
2030 for (i
= TYPE_N_BASECLASSES (type
) - 1; i
>= 0; i
--)
2031 if (check_field (TYPE_BASECLASS (type
, i
), name
, is_a_field_of_this
))
2037 /* Behave like lookup_symbol except that NAME is the natural name
2038 (e.g., demangled name) of the symbol that we're looking for. */
2040 static struct block_symbol
2041 lookup_symbol_aux (const char *name
, symbol_name_match_type match_type
,
2042 const struct block
*block
,
2043 const domain_enum domain
, enum language language
,
2044 struct field_of_this_result
*is_a_field_of_this
)
2046 struct block_symbol result
;
2047 const struct language_defn
*langdef
;
2049 if (symbol_lookup_debug
)
2051 struct objfile
*objfile
= (block
== nullptr
2052 ? nullptr : block_objfile (block
));
2054 fprintf_unfiltered (gdb_stdlog
,
2055 "lookup_symbol_aux (%s, %s (objfile %s), %s, %s)\n",
2056 name
, host_address_to_string (block
),
2058 ? objfile_debug_name (objfile
) : "NULL",
2059 domain_name (domain
), language_str (language
));
2062 /* Make sure we do something sensible with is_a_field_of_this, since
2063 the callers that set this parameter to some non-null value will
2064 certainly use it later. If we don't set it, the contents of
2065 is_a_field_of_this are undefined. */
2066 if (is_a_field_of_this
!= NULL
)
2067 memset (is_a_field_of_this
, 0, sizeof (*is_a_field_of_this
));
2069 /* Search specified block and its superiors. Don't search
2070 STATIC_BLOCK or GLOBAL_BLOCK. */
2072 result
= lookup_local_symbol (name
, match_type
, block
, domain
, language
);
2073 if (result
.symbol
!= NULL
)
2075 if (symbol_lookup_debug
)
2077 fprintf_unfiltered (gdb_stdlog
, "lookup_symbol_aux (...) = %s\n",
2078 host_address_to_string (result
.symbol
));
2083 /* If requested to do so by the caller and if appropriate for LANGUAGE,
2084 check to see if NAME is a field of `this'. */
2086 langdef
= language_def (language
);
2088 /* Don't do this check if we are searching for a struct. It will
2089 not be found by check_field, but will be found by other
2091 if (is_a_field_of_this
!= NULL
&& domain
!= STRUCT_DOMAIN
)
2093 result
= lookup_language_this (langdef
, block
);
2097 struct type
*t
= result
.symbol
->type
;
2099 /* I'm not really sure that type of this can ever
2100 be typedefed; just be safe. */
2101 t
= check_typedef (t
);
2102 if (t
->is_pointer_or_reference ())
2103 t
= TYPE_TARGET_TYPE (t
);
2105 if (t
->code () != TYPE_CODE_STRUCT
2106 && t
->code () != TYPE_CODE_UNION
)
2107 error (_("Internal error: `%s' is not an aggregate"),
2108 langdef
->name_of_this ());
2110 if (check_field (t
, name
, is_a_field_of_this
))
2112 if (symbol_lookup_debug
)
2114 fprintf_unfiltered (gdb_stdlog
,
2115 "lookup_symbol_aux (...) = NULL\n");
2122 /* Now do whatever is appropriate for LANGUAGE to look
2123 up static and global variables. */
2125 result
= langdef
->lookup_symbol_nonlocal (name
, block
, domain
);
2126 if (result
.symbol
!= NULL
)
2128 if (symbol_lookup_debug
)
2130 fprintf_unfiltered (gdb_stdlog
, "lookup_symbol_aux (...) = %s\n",
2131 host_address_to_string (result
.symbol
));
2136 /* Now search all static file-level symbols. Not strictly correct,
2137 but more useful than an error. */
2139 result
= lookup_static_symbol (name
, domain
);
2140 if (symbol_lookup_debug
)
2142 fprintf_unfiltered (gdb_stdlog
, "lookup_symbol_aux (...) = %s\n",
2143 result
.symbol
!= NULL
2144 ? host_address_to_string (result
.symbol
)
2150 /* Check to see if the symbol is defined in BLOCK or its superiors.
2151 Don't search STATIC_BLOCK or GLOBAL_BLOCK. */
2153 static struct block_symbol
2154 lookup_local_symbol (const char *name
,
2155 symbol_name_match_type match_type
,
2156 const struct block
*block
,
2157 const domain_enum domain
,
2158 enum language language
)
2161 const struct block
*static_block
= block_static_block (block
);
2162 const char *scope
= block_scope (block
);
2164 /* Check if either no block is specified or it's a global block. */
2166 if (static_block
== NULL
)
2169 while (block
!= static_block
)
2171 sym
= lookup_symbol_in_block (name
, match_type
, block
, domain
);
2173 return (struct block_symbol
) {sym
, block
};
2175 if (language
== language_cplus
|| language
== language_fortran
)
2177 struct block_symbol blocksym
2178 = cp_lookup_symbol_imports_or_template (scope
, name
, block
,
2181 if (blocksym
.symbol
!= NULL
)
2185 if (BLOCK_FUNCTION (block
) != NULL
&& block_inlined_p (block
))
2187 block
= BLOCK_SUPERBLOCK (block
);
2190 /* We've reached the end of the function without finding a result. */
2198 lookup_symbol_in_block (const char *name
, symbol_name_match_type match_type
,
2199 const struct block
*block
,
2200 const domain_enum domain
)
2204 if (symbol_lookup_debug
> 1)
2206 struct objfile
*objfile
= (block
== nullptr
2207 ? nullptr : block_objfile (block
));
2209 fprintf_unfiltered (gdb_stdlog
,
2210 "lookup_symbol_in_block (%s, %s (objfile %s), %s)",
2211 name
, host_address_to_string (block
),
2212 objfile_debug_name (objfile
),
2213 domain_name (domain
));
2216 sym
= block_lookup_symbol (block
, name
, match_type
, domain
);
2219 if (symbol_lookup_debug
> 1)
2221 fprintf_unfiltered (gdb_stdlog
, " = %s\n",
2222 host_address_to_string (sym
));
2224 return fixup_symbol_section (sym
, NULL
);
2227 if (symbol_lookup_debug
> 1)
2228 fprintf_unfiltered (gdb_stdlog
, " = NULL\n");
2235 lookup_global_symbol_from_objfile (struct objfile
*main_objfile
,
2236 enum block_enum block_index
,
2238 const domain_enum domain
)
2240 gdb_assert (block_index
== GLOBAL_BLOCK
|| block_index
== STATIC_BLOCK
);
2242 for (objfile
*objfile
: main_objfile
->separate_debug_objfiles ())
2244 struct block_symbol result
2245 = lookup_symbol_in_objfile (objfile
, block_index
, name
, domain
);
2247 if (result
.symbol
!= nullptr)
2254 /* Check to see if the symbol is defined in one of the OBJFILE's
2255 symtabs. BLOCK_INDEX should be either GLOBAL_BLOCK or STATIC_BLOCK,
2256 depending on whether or not we want to search global symbols or
2259 static struct block_symbol
2260 lookup_symbol_in_objfile_symtabs (struct objfile
*objfile
,
2261 enum block_enum block_index
, const char *name
,
2262 const domain_enum domain
)
2264 gdb_assert (block_index
== GLOBAL_BLOCK
|| block_index
== STATIC_BLOCK
);
2266 if (symbol_lookup_debug
> 1)
2268 fprintf_unfiltered (gdb_stdlog
,
2269 "lookup_symbol_in_objfile_symtabs (%s, %s, %s, %s)",
2270 objfile_debug_name (objfile
),
2271 block_index
== GLOBAL_BLOCK
2272 ? "GLOBAL_BLOCK" : "STATIC_BLOCK",
2273 name
, domain_name (domain
));
2276 struct block_symbol other
;
2277 other
.symbol
= NULL
;
2278 for (compunit_symtab
*cust
: objfile
->compunits ())
2280 const struct blockvector
*bv
;
2281 const struct block
*block
;
2282 struct block_symbol result
;
2284 bv
= COMPUNIT_BLOCKVECTOR (cust
);
2285 block
= BLOCKVECTOR_BLOCK (bv
, block_index
);
2286 result
.symbol
= block_lookup_symbol_primary (block
, name
, domain
);
2287 result
.block
= block
;
2288 if (result
.symbol
== NULL
)
2290 if (best_symbol (result
.symbol
, domain
))
2295 if (symbol_matches_domain (result
.symbol
->language (),
2296 SYMBOL_DOMAIN (result
.symbol
), domain
))
2298 struct symbol
*better
2299 = better_symbol (other
.symbol
, result
.symbol
, domain
);
2300 if (better
!= other
.symbol
)
2302 other
.symbol
= better
;
2303 other
.block
= block
;
2308 if (other
.symbol
!= NULL
)
2310 if (symbol_lookup_debug
> 1)
2312 fprintf_unfiltered (gdb_stdlog
, " = %s (block %s)\n",
2313 host_address_to_string (other
.symbol
),
2314 host_address_to_string (other
.block
));
2316 other
.symbol
= fixup_symbol_section (other
.symbol
, objfile
);
2320 if (symbol_lookup_debug
> 1)
2321 fprintf_unfiltered (gdb_stdlog
, " = NULL\n");
2325 /* Wrapper around lookup_symbol_in_objfile_symtabs for search_symbols.
2326 Look up LINKAGE_NAME in DOMAIN in the global and static blocks of OBJFILE
2327 and all associated separate debug objfiles.
2329 Normally we only look in OBJFILE, and not any separate debug objfiles
2330 because the outer loop will cause them to be searched too. This case is
2331 different. Here we're called from search_symbols where it will only
2332 call us for the objfile that contains a matching minsym. */
2334 static struct block_symbol
2335 lookup_symbol_in_objfile_from_linkage_name (struct objfile
*objfile
,
2336 const char *linkage_name
,
2339 enum language lang
= current_language
->la_language
;
2340 struct objfile
*main_objfile
;
2342 demangle_result_storage storage
;
2343 const char *modified_name
= demangle_for_lookup (linkage_name
, lang
, storage
);
2345 if (objfile
->separate_debug_objfile_backlink
)
2346 main_objfile
= objfile
->separate_debug_objfile_backlink
;
2348 main_objfile
= objfile
;
2350 for (::objfile
*cur_objfile
: main_objfile
->separate_debug_objfiles ())
2352 struct block_symbol result
;
2354 result
= lookup_symbol_in_objfile_symtabs (cur_objfile
, GLOBAL_BLOCK
,
2355 modified_name
, domain
);
2356 if (result
.symbol
== NULL
)
2357 result
= lookup_symbol_in_objfile_symtabs (cur_objfile
, STATIC_BLOCK
,
2358 modified_name
, domain
);
2359 if (result
.symbol
!= NULL
)
2366 /* A helper function that throws an exception when a symbol was found
2367 in a psymtab but not in a symtab. */
2369 static void ATTRIBUTE_NORETURN
2370 error_in_psymtab_expansion (enum block_enum block_index
, const char *name
,
2371 struct compunit_symtab
*cust
)
2374 Internal: %s symbol `%s' found in %s psymtab but not in symtab.\n\
2375 %s may be an inlined function, or may be a template function\n \
2376 (if a template, try specifying an instantiation: %s<type>)."),
2377 block_index
== GLOBAL_BLOCK
? "global" : "static",
2379 symtab_to_filename_for_display (compunit_primary_filetab (cust
)),
2383 /* A helper function for various lookup routines that interfaces with
2384 the "quick" symbol table functions. */
2386 static struct block_symbol
2387 lookup_symbol_via_quick_fns (struct objfile
*objfile
,
2388 enum block_enum block_index
, const char *name
,
2389 const domain_enum domain
)
2391 struct compunit_symtab
*cust
;
2392 const struct blockvector
*bv
;
2393 const struct block
*block
;
2394 struct block_symbol result
;
2396 if (symbol_lookup_debug
> 1)
2398 fprintf_unfiltered (gdb_stdlog
,
2399 "lookup_symbol_via_quick_fns (%s, %s, %s, %s)\n",
2400 objfile_debug_name (objfile
),
2401 block_index
== GLOBAL_BLOCK
2402 ? "GLOBAL_BLOCK" : "STATIC_BLOCK",
2403 name
, domain_name (domain
));
2406 cust
= objfile
->lookup_symbol (block_index
, name
, domain
);
2409 if (symbol_lookup_debug
> 1)
2411 fprintf_unfiltered (gdb_stdlog
,
2412 "lookup_symbol_via_quick_fns (...) = NULL\n");
2417 bv
= COMPUNIT_BLOCKVECTOR (cust
);
2418 block
= BLOCKVECTOR_BLOCK (bv
, block_index
);
2419 result
.symbol
= block_lookup_symbol (block
, name
,
2420 symbol_name_match_type::FULL
, domain
);
2421 if (result
.symbol
== NULL
)
2422 error_in_psymtab_expansion (block_index
, name
, cust
);
2424 if (symbol_lookup_debug
> 1)
2426 fprintf_unfiltered (gdb_stdlog
,
2427 "lookup_symbol_via_quick_fns (...) = %s (block %s)\n",
2428 host_address_to_string (result
.symbol
),
2429 host_address_to_string (block
));
2432 result
.symbol
= fixup_symbol_section (result
.symbol
, objfile
);
2433 result
.block
= block
;
2437 /* See language.h. */
2440 language_defn::lookup_symbol_nonlocal (const char *name
,
2441 const struct block
*block
,
2442 const domain_enum domain
) const
2444 struct block_symbol result
;
2446 /* NOTE: dje/2014-10-26: The lookup in all objfiles search could skip
2447 the current objfile. Searching the current objfile first is useful
2448 for both matching user expectations as well as performance. */
2450 result
= lookup_symbol_in_static_block (name
, block
, domain
);
2451 if (result
.symbol
!= NULL
)
2454 /* If we didn't find a definition for a builtin type in the static block,
2455 search for it now. This is actually the right thing to do and can be
2456 a massive performance win. E.g., when debugging a program with lots of
2457 shared libraries we could search all of them only to find out the
2458 builtin type isn't defined in any of them. This is common for types
2460 if (domain
== VAR_DOMAIN
)
2462 struct gdbarch
*gdbarch
;
2465 gdbarch
= target_gdbarch ();
2467 gdbarch
= block_gdbarch (block
);
2468 result
.symbol
= language_lookup_primitive_type_as_symbol (this,
2470 result
.block
= NULL
;
2471 if (result
.symbol
!= NULL
)
2475 return lookup_global_symbol (name
, block
, domain
);
2481 lookup_symbol_in_static_block (const char *name
,
2482 const struct block
*block
,
2483 const domain_enum domain
)
2485 const struct block
*static_block
= block_static_block (block
);
2488 if (static_block
== NULL
)
2491 if (symbol_lookup_debug
)
2493 struct objfile
*objfile
= (block
== nullptr
2494 ? nullptr : block_objfile (block
));
2496 fprintf_unfiltered (gdb_stdlog
,
2497 "lookup_symbol_in_static_block (%s, %s (objfile %s),"
2500 host_address_to_string (block
),
2501 objfile_debug_name (objfile
),
2502 domain_name (domain
));
2505 sym
= lookup_symbol_in_block (name
,
2506 symbol_name_match_type::FULL
,
2507 static_block
, domain
);
2508 if (symbol_lookup_debug
)
2510 fprintf_unfiltered (gdb_stdlog
,
2511 "lookup_symbol_in_static_block (...) = %s\n",
2512 sym
!= NULL
? host_address_to_string (sym
) : "NULL");
2514 return (struct block_symbol
) {sym
, static_block
};
2517 /* Perform the standard symbol lookup of NAME in OBJFILE:
2518 1) First search expanded symtabs, and if not found
2519 2) Search the "quick" symtabs (partial or .gdb_index).
2520 BLOCK_INDEX is one of GLOBAL_BLOCK or STATIC_BLOCK. */
2522 static struct block_symbol
2523 lookup_symbol_in_objfile (struct objfile
*objfile
, enum block_enum block_index
,
2524 const char *name
, const domain_enum domain
)
2526 struct block_symbol result
;
2528 gdb_assert (block_index
== GLOBAL_BLOCK
|| block_index
== STATIC_BLOCK
);
2530 if (symbol_lookup_debug
)
2532 fprintf_unfiltered (gdb_stdlog
,
2533 "lookup_symbol_in_objfile (%s, %s, %s, %s)\n",
2534 objfile_debug_name (objfile
),
2535 block_index
== GLOBAL_BLOCK
2536 ? "GLOBAL_BLOCK" : "STATIC_BLOCK",
2537 name
, domain_name (domain
));
2540 result
= lookup_symbol_in_objfile_symtabs (objfile
, block_index
,
2542 if (result
.symbol
!= NULL
)
2544 if (symbol_lookup_debug
)
2546 fprintf_unfiltered (gdb_stdlog
,
2547 "lookup_symbol_in_objfile (...) = %s"
2549 host_address_to_string (result
.symbol
));
2554 result
= lookup_symbol_via_quick_fns (objfile
, block_index
,
2556 if (symbol_lookup_debug
)
2558 fprintf_unfiltered (gdb_stdlog
,
2559 "lookup_symbol_in_objfile (...) = %s%s\n",
2560 result
.symbol
!= NULL
2561 ? host_address_to_string (result
.symbol
)
2563 result
.symbol
!= NULL
? " (via quick fns)" : "");
2568 /* Find the language for partial symbol with NAME. */
2570 static enum language
2571 find_quick_global_symbol_language (const char *name
, const domain_enum domain
)
2573 for (objfile
*objfile
: current_program_space
->objfiles ())
2575 bool symbol_found_p
;
2577 = objfile
->lookup_global_symbol_language (name
, domain
, &symbol_found_p
);
2582 return language_unknown
;
2585 /* Private data to be used with lookup_symbol_global_iterator_cb. */
2587 struct global_or_static_sym_lookup_data
2589 /* The name of the symbol we are searching for. */
2592 /* The domain to use for our search. */
2595 /* The block index in which to search. */
2596 enum block_enum block_index
;
2598 /* The field where the callback should store the symbol if found.
2599 It should be initialized to {NULL, NULL} before the search is started. */
2600 struct block_symbol result
;
2603 /* A callback function for gdbarch_iterate_over_objfiles_in_search_order.
2604 It searches by name for a symbol in the block given by BLOCK_INDEX of the
2605 given OBJFILE. The arguments for the search are passed via CB_DATA, which
2606 in reality is a pointer to struct global_or_static_sym_lookup_data. */
2609 lookup_symbol_global_or_static_iterator_cb (struct objfile
*objfile
,
2612 struct global_or_static_sym_lookup_data
*data
=
2613 (struct global_or_static_sym_lookup_data
*) cb_data
;
2615 gdb_assert (data
->result
.symbol
== NULL
2616 && data
->result
.block
== NULL
);
2618 data
->result
= lookup_symbol_in_objfile (objfile
, data
->block_index
,
2619 data
->name
, data
->domain
);
2621 /* If we found a match, tell the iterator to stop. Otherwise,
2623 return (data
->result
.symbol
!= NULL
);
2626 /* This function contains the common code of lookup_{global,static}_symbol.
2627 OBJFILE is only used if BLOCK_INDEX is GLOBAL_SCOPE, in which case it is
2628 the objfile to start the lookup in. */
2630 static struct block_symbol
2631 lookup_global_or_static_symbol (const char *name
,
2632 enum block_enum block_index
,
2633 struct objfile
*objfile
,
2634 const domain_enum domain
)
2636 struct symbol_cache
*cache
= get_symbol_cache (current_program_space
);
2637 struct block_symbol result
;
2638 struct global_or_static_sym_lookup_data lookup_data
;
2639 struct block_symbol_cache
*bsc
;
2640 struct symbol_cache_slot
*slot
;
2642 gdb_assert (block_index
== GLOBAL_BLOCK
|| block_index
== STATIC_BLOCK
);
2643 gdb_assert (objfile
== nullptr || block_index
== GLOBAL_BLOCK
);
2645 /* First see if we can find the symbol in the cache.
2646 This works because we use the current objfile to qualify the lookup. */
2647 result
= symbol_cache_lookup (cache
, objfile
, block_index
, name
, domain
,
2649 if (result
.symbol
!= NULL
)
2651 if (SYMBOL_LOOKUP_FAILED_P (result
))
2656 /* Do a global search (of global blocks, heh). */
2657 if (result
.symbol
== NULL
)
2659 memset (&lookup_data
, 0, sizeof (lookup_data
));
2660 lookup_data
.name
= name
;
2661 lookup_data
.block_index
= block_index
;
2662 lookup_data
.domain
= domain
;
2663 gdbarch_iterate_over_objfiles_in_search_order
2664 (objfile
!= NULL
? objfile
->arch () : target_gdbarch (),
2665 lookup_symbol_global_or_static_iterator_cb
, &lookup_data
, objfile
);
2666 result
= lookup_data
.result
;
2669 if (result
.symbol
!= NULL
)
2670 symbol_cache_mark_found (bsc
, slot
, objfile
, result
.symbol
, result
.block
);
2672 symbol_cache_mark_not_found (bsc
, slot
, objfile
, name
, domain
);
2680 lookup_static_symbol (const char *name
, const domain_enum domain
)
2682 return lookup_global_or_static_symbol (name
, STATIC_BLOCK
, nullptr, domain
);
2688 lookup_global_symbol (const char *name
,
2689 const struct block
*block
,
2690 const domain_enum domain
)
2692 /* If a block was passed in, we want to search the corresponding
2693 global block first. This yields "more expected" behavior, and is
2694 needed to support 'FILENAME'::VARIABLE lookups. */
2695 const struct block
*global_block
= block_global_block (block
);
2697 if (global_block
!= nullptr)
2699 sym
= lookup_symbol_in_block (name
,
2700 symbol_name_match_type::FULL
,
2701 global_block
, domain
);
2702 if (sym
!= NULL
&& best_symbol (sym
, domain
))
2703 return { sym
, global_block
};
2706 struct objfile
*objfile
= nullptr;
2707 if (block
!= nullptr)
2709 objfile
= block_objfile (block
);
2710 if (objfile
->separate_debug_objfile_backlink
!= nullptr)
2711 objfile
= objfile
->separate_debug_objfile_backlink
;
2715 = lookup_global_or_static_symbol (name
, GLOBAL_BLOCK
, objfile
, domain
);
2716 if (better_symbol (sym
, bs
.symbol
, domain
) == sym
)
2717 return { sym
, global_block
};
2723 symbol_matches_domain (enum language symbol_language
,
2724 domain_enum symbol_domain
,
2727 /* For C++ "struct foo { ... }" also defines a typedef for "foo".
2728 Similarly, any Ada type declaration implicitly defines a typedef. */
2729 if (symbol_language
== language_cplus
2730 || symbol_language
== language_d
2731 || symbol_language
== language_ada
2732 || symbol_language
== language_rust
)
2734 if ((domain
== VAR_DOMAIN
|| domain
== STRUCT_DOMAIN
)
2735 && symbol_domain
== STRUCT_DOMAIN
)
2738 /* For all other languages, strict match is required. */
2739 return (symbol_domain
== domain
);
2745 lookup_transparent_type (const char *name
)
2747 return current_language
->lookup_transparent_type (name
);
2750 /* A helper for basic_lookup_transparent_type that interfaces with the
2751 "quick" symbol table functions. */
2753 static struct type
*
2754 basic_lookup_transparent_type_quick (struct objfile
*objfile
,
2755 enum block_enum block_index
,
2758 struct compunit_symtab
*cust
;
2759 const struct blockvector
*bv
;
2760 const struct block
*block
;
2763 cust
= objfile
->lookup_symbol (block_index
, name
, STRUCT_DOMAIN
);
2767 bv
= COMPUNIT_BLOCKVECTOR (cust
);
2768 block
= BLOCKVECTOR_BLOCK (bv
, block_index
);
2769 sym
= block_find_symbol (block
, name
, STRUCT_DOMAIN
,
2770 block_find_non_opaque_type
, NULL
);
2772 error_in_psymtab_expansion (block_index
, name
, cust
);
2773 gdb_assert (!TYPE_IS_OPAQUE (SYMBOL_TYPE (sym
)));
2774 return SYMBOL_TYPE (sym
);
2777 /* Subroutine of basic_lookup_transparent_type to simplify it.
2778 Look up the non-opaque definition of NAME in BLOCK_INDEX of OBJFILE.
2779 BLOCK_INDEX is either GLOBAL_BLOCK or STATIC_BLOCK. */
2781 static struct type
*
2782 basic_lookup_transparent_type_1 (struct objfile
*objfile
,
2783 enum block_enum block_index
,
2786 const struct blockvector
*bv
;
2787 const struct block
*block
;
2788 const struct symbol
*sym
;
2790 for (compunit_symtab
*cust
: objfile
->compunits ())
2792 bv
= COMPUNIT_BLOCKVECTOR (cust
);
2793 block
= BLOCKVECTOR_BLOCK (bv
, block_index
);
2794 sym
= block_find_symbol (block
, name
, STRUCT_DOMAIN
,
2795 block_find_non_opaque_type
, NULL
);
2798 gdb_assert (!TYPE_IS_OPAQUE (SYMBOL_TYPE (sym
)));
2799 return SYMBOL_TYPE (sym
);
2806 /* The standard implementation of lookup_transparent_type. This code
2807 was modeled on lookup_symbol -- the parts not relevant to looking
2808 up types were just left out. In particular it's assumed here that
2809 types are available in STRUCT_DOMAIN and only in file-static or
2813 basic_lookup_transparent_type (const char *name
)
2817 /* Now search all the global symbols. Do the symtab's first, then
2818 check the psymtab's. If a psymtab indicates the existence
2819 of the desired name as a global, then do psymtab-to-symtab
2820 conversion on the fly and return the found symbol. */
2822 for (objfile
*objfile
: current_program_space
->objfiles ())
2824 t
= basic_lookup_transparent_type_1 (objfile
, GLOBAL_BLOCK
, name
);
2829 for (objfile
*objfile
: current_program_space
->objfiles ())
2831 t
= basic_lookup_transparent_type_quick (objfile
, GLOBAL_BLOCK
, name
);
2836 /* Now search the static file-level symbols.
2837 Not strictly correct, but more useful than an error.
2838 Do the symtab's first, then
2839 check the psymtab's. If a psymtab indicates the existence
2840 of the desired name as a file-level static, then do psymtab-to-symtab
2841 conversion on the fly and return the found symbol. */
2843 for (objfile
*objfile
: current_program_space
->objfiles ())
2845 t
= basic_lookup_transparent_type_1 (objfile
, STATIC_BLOCK
, name
);
2850 for (objfile
*objfile
: current_program_space
->objfiles ())
2852 t
= basic_lookup_transparent_type_quick (objfile
, STATIC_BLOCK
, name
);
2857 return (struct type
*) 0;
2863 iterate_over_symbols (const struct block
*block
,
2864 const lookup_name_info
&name
,
2865 const domain_enum domain
,
2866 gdb::function_view
<symbol_found_callback_ftype
> callback
)
2868 struct block_iterator iter
;
2871 ALL_BLOCK_SYMBOLS_WITH_NAME (block
, name
, iter
, sym
)
2873 if (symbol_matches_domain (sym
->language (), SYMBOL_DOMAIN (sym
), domain
))
2875 struct block_symbol block_sym
= {sym
, block
};
2877 if (!callback (&block_sym
))
2887 iterate_over_symbols_terminated
2888 (const struct block
*block
,
2889 const lookup_name_info
&name
,
2890 const domain_enum domain
,
2891 gdb::function_view
<symbol_found_callback_ftype
> callback
)
2893 if (!iterate_over_symbols (block
, name
, domain
, callback
))
2895 struct block_symbol block_sym
= {nullptr, block
};
2896 return callback (&block_sym
);
2899 /* Find the compunit symtab associated with PC and SECTION.
2900 This will read in debug info as necessary. */
2902 struct compunit_symtab
*
2903 find_pc_sect_compunit_symtab (CORE_ADDR pc
, struct obj_section
*section
)
2905 struct compunit_symtab
*best_cust
= NULL
;
2906 CORE_ADDR best_cust_range
= 0;
2907 struct bound_minimal_symbol msymbol
;
2909 /* If we know that this is not a text address, return failure. This is
2910 necessary because we loop based on the block's high and low code
2911 addresses, which do not include the data ranges, and because
2912 we call find_pc_sect_psymtab which has a similar restriction based
2913 on the partial_symtab's texthigh and textlow. */
2914 msymbol
= lookup_minimal_symbol_by_pc_section (pc
, section
);
2915 if (msymbol
.minsym
&& msymbol
.minsym
->data_p ())
2918 /* Search all symtabs for the one whose file contains our address, and which
2919 is the smallest of all the ones containing the address. This is designed
2920 to deal with a case like symtab a is at 0x1000-0x2000 and 0x3000-0x4000
2921 and symtab b is at 0x2000-0x3000. So the GLOBAL_BLOCK for a is from
2922 0x1000-0x4000, but for address 0x2345 we want to return symtab b.
2924 This happens for native ecoff format, where code from included files
2925 gets its own symtab. The symtab for the included file should have
2926 been read in already via the dependency mechanism.
2927 It might be swifter to create several symtabs with the same name
2928 like xcoff does (I'm not sure).
2930 It also happens for objfiles that have their functions reordered.
2931 For these, the symtab we are looking for is not necessarily read in. */
2933 for (objfile
*obj_file
: current_program_space
->objfiles ())
2935 for (compunit_symtab
*cust
: obj_file
->compunits ())
2937 const struct blockvector
*bv
= COMPUNIT_BLOCKVECTOR (cust
);
2938 const struct block
*global_block
2939 = BLOCKVECTOR_BLOCK (bv
, GLOBAL_BLOCK
);
2940 CORE_ADDR start
= BLOCK_START (global_block
);
2941 CORE_ADDR end
= BLOCK_END (global_block
);
2942 bool in_range_p
= start
<= pc
&& pc
< end
;
2946 if (BLOCKVECTOR_MAP (bv
))
2948 if (addrmap_find (BLOCKVECTOR_MAP (bv
), pc
) == nullptr)
2954 CORE_ADDR range
= end
- start
;
2955 if (best_cust
!= nullptr
2956 && range
>= best_cust_range
)
2957 /* Cust doesn't have a smaller range than best_cust, skip it. */
2960 /* For an objfile that has its functions reordered,
2961 find_pc_psymtab will find the proper partial symbol table
2962 and we simply return its corresponding symtab. */
2963 /* In order to better support objfiles that contain both
2964 stabs and coff debugging info, we continue on if a psymtab
2966 if ((obj_file
->flags
& OBJF_REORDERED
) != 0)
2968 struct compunit_symtab
*result
;
2971 = obj_file
->find_pc_sect_compunit_symtab (msymbol
,
2981 struct symbol
*sym
= NULL
;
2982 struct block_iterator iter
;
2984 for (int b_index
= GLOBAL_BLOCK
;
2985 b_index
<= STATIC_BLOCK
&& sym
== NULL
;
2988 const struct block
*b
= BLOCKVECTOR_BLOCK (bv
, b_index
);
2989 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
2991 fixup_symbol_section (sym
, obj_file
);
2992 if (matching_obj_sections (sym
->obj_section (obj_file
),
2998 continue; /* No symbol in this symtab matches
3002 /* Cust is best found sofar, save it. */
3004 best_cust_range
= range
;
3008 if (best_cust
!= NULL
)
3011 /* Not found in symtabs, search the "quick" symtabs (e.g. psymtabs). */
3013 for (objfile
*objf
: current_program_space
->objfiles ())
3015 struct compunit_symtab
*result
3016 = objf
->find_pc_sect_compunit_symtab (msymbol
, pc
, section
, 1);
3024 /* Find the compunit symtab associated with PC.
3025 This will read in debug info as necessary.
3026 Backward compatibility, no section. */
3028 struct compunit_symtab
*
3029 find_pc_compunit_symtab (CORE_ADDR pc
)
3031 return find_pc_sect_compunit_symtab (pc
, find_pc_mapped_section (pc
));
3037 find_symbol_at_address (CORE_ADDR address
)
3039 /* A helper function to search a given symtab for a symbol matching
3041 auto search_symtab
= [] (compunit_symtab
*symtab
, CORE_ADDR addr
) -> symbol
*
3043 const struct blockvector
*bv
= COMPUNIT_BLOCKVECTOR (symtab
);
3045 for (int i
= GLOBAL_BLOCK
; i
<= STATIC_BLOCK
; ++i
)
3047 const struct block
*b
= BLOCKVECTOR_BLOCK (bv
, i
);
3048 struct block_iterator iter
;
3051 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
3053 if (SYMBOL_CLASS (sym
) == LOC_STATIC
3054 && SYMBOL_VALUE_ADDRESS (sym
) == addr
)
3061 for (objfile
*objfile
: current_program_space
->objfiles ())
3063 /* If this objfile was read with -readnow, then we need to
3064 search the symtabs directly. */
3065 if ((objfile
->flags
& OBJF_READNOW
) != 0)
3067 for (compunit_symtab
*symtab
: objfile
->compunits ())
3069 struct symbol
*sym
= search_symtab (symtab
, address
);
3076 struct compunit_symtab
*symtab
3077 = objfile
->find_compunit_symtab_by_address (address
);
3080 struct symbol
*sym
= search_symtab (symtab
, address
);
3092 /* Find the source file and line number for a given PC value and SECTION.
3093 Return a structure containing a symtab pointer, a line number,
3094 and a pc range for the entire source line.
3095 The value's .pc field is NOT the specified pc.
3096 NOTCURRENT nonzero means, if specified pc is on a line boundary,
3097 use the line that ends there. Otherwise, in that case, the line
3098 that begins there is used. */
3100 /* The big complication here is that a line may start in one file, and end just
3101 before the start of another file. This usually occurs when you #include
3102 code in the middle of a subroutine. To properly find the end of a line's PC
3103 range, we must search all symtabs associated with this compilation unit, and
3104 find the one whose first PC is closer than that of the next line in this
3107 struct symtab_and_line
3108 find_pc_sect_line (CORE_ADDR pc
, struct obj_section
*section
, int notcurrent
)
3110 struct compunit_symtab
*cust
;
3111 struct linetable
*l
;
3113 struct linetable_entry
*item
;
3114 const struct blockvector
*bv
;
3115 struct bound_minimal_symbol msymbol
;
3117 /* Info on best line seen so far, and where it starts, and its file. */
3119 struct linetable_entry
*best
= NULL
;
3120 CORE_ADDR best_end
= 0;
3121 struct symtab
*best_symtab
= 0;
3123 /* Store here the first line number
3124 of a file which contains the line at the smallest pc after PC.
3125 If we don't find a line whose range contains PC,
3126 we will use a line one less than this,
3127 with a range from the start of that file to the first line's pc. */
3128 struct linetable_entry
*alt
= NULL
;
3130 /* Info on best line seen in this file. */
3132 struct linetable_entry
*prev
;
3134 /* If this pc is not from the current frame,
3135 it is the address of the end of a call instruction.
3136 Quite likely that is the start of the following statement.
3137 But what we want is the statement containing the instruction.
3138 Fudge the pc to make sure we get that. */
3140 /* It's tempting to assume that, if we can't find debugging info for
3141 any function enclosing PC, that we shouldn't search for line
3142 number info, either. However, GAS can emit line number info for
3143 assembly files --- very helpful when debugging hand-written
3144 assembly code. In such a case, we'd have no debug info for the
3145 function, but we would have line info. */
3150 /* elz: added this because this function returned the wrong
3151 information if the pc belongs to a stub (import/export)
3152 to call a shlib function. This stub would be anywhere between
3153 two functions in the target, and the line info was erroneously
3154 taken to be the one of the line before the pc. */
3156 /* RT: Further explanation:
3158 * We have stubs (trampolines) inserted between procedures.
3160 * Example: "shr1" exists in a shared library, and a "shr1" stub also
3161 * exists in the main image.
3163 * In the minimal symbol table, we have a bunch of symbols
3164 * sorted by start address. The stubs are marked as "trampoline",
3165 * the others appear as text. E.g.:
3167 * Minimal symbol table for main image
3168 * main: code for main (text symbol)
3169 * shr1: stub (trampoline symbol)
3170 * foo: code for foo (text symbol)
3172 * Minimal symbol table for "shr1" image:
3174 * shr1: code for shr1 (text symbol)
3177 * So the code below is trying to detect if we are in the stub
3178 * ("shr1" stub), and if so, find the real code ("shr1" trampoline),
3179 * and if found, do the symbolization from the real-code address
3180 * rather than the stub address.
3182 * Assumptions being made about the minimal symbol table:
3183 * 1. lookup_minimal_symbol_by_pc() will return a trampoline only
3184 * if we're really in the trampoline.s If we're beyond it (say
3185 * we're in "foo" in the above example), it'll have a closer
3186 * symbol (the "foo" text symbol for example) and will not
3187 * return the trampoline.
3188 * 2. lookup_minimal_symbol_text() will find a real text symbol
3189 * corresponding to the trampoline, and whose address will
3190 * be different than the trampoline address. I put in a sanity
3191 * check for the address being the same, to avoid an
3192 * infinite recursion.
3194 msymbol
= lookup_minimal_symbol_by_pc (pc
);
3195 if (msymbol
.minsym
!= NULL
)
3196 if (MSYMBOL_TYPE (msymbol
.minsym
) == mst_solib_trampoline
)
3198 struct bound_minimal_symbol mfunsym
3199 = lookup_minimal_symbol_text (msymbol
.minsym
->linkage_name (),
3202 if (mfunsym
.minsym
== NULL
)
3203 /* I eliminated this warning since it is coming out
3204 * in the following situation:
3205 * gdb shmain // test program with shared libraries
3206 * (gdb) break shr1 // function in shared lib
3207 * Warning: In stub for ...
3208 * In the above situation, the shared lib is not loaded yet,
3209 * so of course we can't find the real func/line info,
3210 * but the "break" still works, and the warning is annoying.
3211 * So I commented out the warning. RT */
3212 /* warning ("In stub for %s; unable to find real function/line info",
3213 msymbol->linkage_name ()); */
3216 else if (BMSYMBOL_VALUE_ADDRESS (mfunsym
)
3217 == BMSYMBOL_VALUE_ADDRESS (msymbol
))
3218 /* Avoid infinite recursion */
3219 /* See above comment about why warning is commented out. */
3220 /* warning ("In stub for %s; unable to find real function/line info",
3221 msymbol->linkage_name ()); */
3226 /* Detect an obvious case of infinite recursion. If this
3227 should occur, we'd like to know about it, so error out,
3229 if (BMSYMBOL_VALUE_ADDRESS (mfunsym
) == pc
)
3230 internal_error (__FILE__
, __LINE__
,
3231 _("Infinite recursion detected in find_pc_sect_line;"
3232 "please file a bug report"));
3234 return find_pc_line (BMSYMBOL_VALUE_ADDRESS (mfunsym
), 0);
3238 symtab_and_line val
;
3239 val
.pspace
= current_program_space
;
3241 cust
= find_pc_sect_compunit_symtab (pc
, section
);
3244 /* If no symbol information, return previous pc. */
3251 bv
= COMPUNIT_BLOCKVECTOR (cust
);
3253 /* Look at all the symtabs that share this blockvector.
3254 They all have the same apriori range, that we found was right;
3255 but they have different line tables. */
3257 for (symtab
*iter_s
: compunit_filetabs (cust
))
3259 /* Find the best line in this symtab. */
3260 l
= SYMTAB_LINETABLE (iter_s
);
3266 /* I think len can be zero if the symtab lacks line numbers
3267 (e.g. gcc -g1). (Either that or the LINETABLE is NULL;
3268 I'm not sure which, and maybe it depends on the symbol
3274 item
= l
->item
; /* Get first line info. */
3276 /* Is this file's first line closer than the first lines of other files?
3277 If so, record this file, and its first line, as best alternate. */
3278 if (item
->pc
> pc
&& (!alt
|| item
->pc
< alt
->pc
))
3281 auto pc_compare
= [](const CORE_ADDR
& comp_pc
,
3282 const struct linetable_entry
& lhs
)->bool
3284 return comp_pc
< lhs
.pc
;
3287 struct linetable_entry
*first
= item
;
3288 struct linetable_entry
*last
= item
+ len
;
3289 item
= std::upper_bound (first
, last
, pc
, pc_compare
);
3291 prev
= item
- 1; /* Found a matching item. */
3293 /* At this point, prev points at the line whose start addr is <= pc, and
3294 item points at the next line. If we ran off the end of the linetable
3295 (pc >= start of the last line), then prev == item. If pc < start of
3296 the first line, prev will not be set. */
3298 /* Is this file's best line closer than the best in the other files?
3299 If so, record this file, and its best line, as best so far. Don't
3300 save prev if it represents the end of a function (i.e. line number
3301 0) instead of a real line. */
3303 if (prev
&& prev
->line
&& (!best
|| prev
->pc
> best
->pc
))
3306 best_symtab
= iter_s
;
3308 /* If during the binary search we land on a non-statement entry,
3309 scan backward through entries at the same address to see if
3310 there is an entry marked as is-statement. In theory this
3311 duplication should have been removed from the line table
3312 during construction, this is just a double check. If the line
3313 table has had the duplication removed then this should be
3317 struct linetable_entry
*tmp
= best
;
3318 while (tmp
> first
&& (tmp
- 1)->pc
== tmp
->pc
3319 && (tmp
- 1)->line
!= 0 && !tmp
->is_stmt
)
3325 /* Discard BEST_END if it's before the PC of the current BEST. */
3326 if (best_end
<= best
->pc
)
3330 /* If another line (denoted by ITEM) is in the linetable and its
3331 PC is after BEST's PC, but before the current BEST_END, then
3332 use ITEM's PC as the new best_end. */
3333 if (best
&& item
< last
&& item
->pc
> best
->pc
3334 && (best_end
== 0 || best_end
> item
->pc
))
3335 best_end
= item
->pc
;
3340 /* If we didn't find any line number info, just return zeros.
3341 We used to return alt->line - 1 here, but that could be
3342 anywhere; if we don't have line number info for this PC,
3343 don't make some up. */
3346 else if (best
->line
== 0)
3348 /* If our best fit is in a range of PC's for which no line
3349 number info is available (line number is zero) then we didn't
3350 find any valid line information. */
3355 val
.is_stmt
= best
->is_stmt
;
3356 val
.symtab
= best_symtab
;
3357 val
.line
= best
->line
;
3359 if (best_end
&& (!alt
|| best_end
< alt
->pc
))
3364 val
.end
= BLOCK_END (BLOCKVECTOR_BLOCK (bv
, GLOBAL_BLOCK
));
3366 val
.section
= section
;
3370 /* Backward compatibility (no section). */
3372 struct symtab_and_line
3373 find_pc_line (CORE_ADDR pc
, int notcurrent
)
3375 struct obj_section
*section
;
3377 section
= find_pc_overlay (pc
);
3378 if (!pc_in_unmapped_range (pc
, section
))
3379 return find_pc_sect_line (pc
, section
, notcurrent
);
3381 /* If the original PC was an unmapped address then we translate this to a
3382 mapped address in order to lookup the sal. However, as the user
3383 passed us an unmapped address it makes more sense to return a result
3384 that has the pc and end fields translated to unmapped addresses. */
3385 pc
= overlay_mapped_address (pc
, section
);
3386 symtab_and_line sal
= find_pc_sect_line (pc
, section
, notcurrent
);
3387 sal
.pc
= overlay_unmapped_address (sal
.pc
, section
);
3388 sal
.end
= overlay_unmapped_address (sal
.end
, section
);
3395 find_pc_line_symtab (CORE_ADDR pc
)
3397 struct symtab_and_line sal
;
3399 /* This always passes zero for NOTCURRENT to find_pc_line.
3400 There are currently no callers that ever pass non-zero. */
3401 sal
= find_pc_line (pc
, 0);
3405 /* Find line number LINE in any symtab whose name is the same as
3408 If found, return the symtab that contains the linetable in which it was
3409 found, set *INDEX to the index in the linetable of the best entry
3410 found, and set *EXACT_MATCH to true if the value returned is an
3413 If not found, return NULL. */
3416 find_line_symtab (struct symtab
*sym_tab
, int line
,
3417 int *index
, bool *exact_match
)
3419 int exact
= 0; /* Initialized here to avoid a compiler warning. */
3421 /* BEST_INDEX and BEST_LINETABLE identify the smallest linenumber > LINE
3425 struct linetable
*best_linetable
;
3426 struct symtab
*best_symtab
;
3428 /* First try looking it up in the given symtab. */
3429 best_linetable
= SYMTAB_LINETABLE (sym_tab
);
3430 best_symtab
= sym_tab
;
3431 best_index
= find_line_common (best_linetable
, line
, &exact
, 0);
3432 if (best_index
< 0 || !exact
)
3434 /* Didn't find an exact match. So we better keep looking for
3435 another symtab with the same name. In the case of xcoff,
3436 multiple csects for one source file (produced by IBM's FORTRAN
3437 compiler) produce multiple symtabs (this is unavoidable
3438 assuming csects can be at arbitrary places in memory and that
3439 the GLOBAL_BLOCK of a symtab has a begin and end address). */
3441 /* BEST is the smallest linenumber > LINE so far seen,
3442 or 0 if none has been seen so far.
3443 BEST_INDEX and BEST_LINETABLE identify the item for it. */
3446 if (best_index
>= 0)
3447 best
= best_linetable
->item
[best_index
].line
;
3451 for (objfile
*objfile
: current_program_space
->objfiles ())
3452 objfile
->expand_symtabs_with_fullname (symtab_to_fullname (sym_tab
));
3454 for (objfile
*objfile
: current_program_space
->objfiles ())
3456 for (compunit_symtab
*cu
: objfile
->compunits ())
3458 for (symtab
*s
: compunit_filetabs (cu
))
3460 struct linetable
*l
;
3463 if (FILENAME_CMP (sym_tab
->filename
, s
->filename
) != 0)
3465 if (FILENAME_CMP (symtab_to_fullname (sym_tab
),
3466 symtab_to_fullname (s
)) != 0)
3468 l
= SYMTAB_LINETABLE (s
);
3469 ind
= find_line_common (l
, line
, &exact
, 0);
3479 if (best
== 0 || l
->item
[ind
].line
< best
)
3481 best
= l
->item
[ind
].line
;
3496 *index
= best_index
;
3498 *exact_match
= (exact
!= 0);
3503 /* Given SYMTAB, returns all the PCs function in the symtab that
3504 exactly match LINE. Returns an empty vector if there are no exact
3505 matches, but updates BEST_ITEM in this case. */
3507 std::vector
<CORE_ADDR
>
3508 find_pcs_for_symtab_line (struct symtab
*symtab
, int line
,
3509 struct linetable_entry
**best_item
)
3512 std::vector
<CORE_ADDR
> result
;
3514 /* First, collect all the PCs that are at this line. */
3520 idx
= find_line_common (SYMTAB_LINETABLE (symtab
), line
, &was_exact
,
3527 struct linetable_entry
*item
= &SYMTAB_LINETABLE (symtab
)->item
[idx
];
3529 if (*best_item
== NULL
3530 || (item
->line
< (*best_item
)->line
&& item
->is_stmt
))
3536 result
.push_back (SYMTAB_LINETABLE (symtab
)->item
[idx
].pc
);
3544 /* Set the PC value for a given source file and line number and return true.
3545 Returns false for invalid line number (and sets the PC to 0).
3546 The source file is specified with a struct symtab. */
3549 find_line_pc (struct symtab
*symtab
, int line
, CORE_ADDR
*pc
)
3551 struct linetable
*l
;
3558 symtab
= find_line_symtab (symtab
, line
, &ind
, NULL
);
3561 l
= SYMTAB_LINETABLE (symtab
);
3562 *pc
= l
->item
[ind
].pc
;
3569 /* Find the range of pc values in a line.
3570 Store the starting pc of the line into *STARTPTR
3571 and the ending pc (start of next line) into *ENDPTR.
3572 Returns true to indicate success.
3573 Returns false if could not find the specified line. */
3576 find_line_pc_range (struct symtab_and_line sal
, CORE_ADDR
*startptr
,
3579 CORE_ADDR startaddr
;
3580 struct symtab_and_line found_sal
;
3583 if (startaddr
== 0 && !find_line_pc (sal
.symtab
, sal
.line
, &startaddr
))
3586 /* This whole function is based on address. For example, if line 10 has
3587 two parts, one from 0x100 to 0x200 and one from 0x300 to 0x400, then
3588 "info line *0x123" should say the line goes from 0x100 to 0x200
3589 and "info line *0x355" should say the line goes from 0x300 to 0x400.
3590 This also insures that we never give a range like "starts at 0x134
3591 and ends at 0x12c". */
3593 found_sal
= find_pc_sect_line (startaddr
, sal
.section
, 0);
3594 if (found_sal
.line
!= sal
.line
)
3596 /* The specified line (sal) has zero bytes. */
3597 *startptr
= found_sal
.pc
;
3598 *endptr
= found_sal
.pc
;
3602 *startptr
= found_sal
.pc
;
3603 *endptr
= found_sal
.end
;
3608 /* Given a line table and a line number, return the index into the line
3609 table for the pc of the nearest line whose number is >= the specified one.
3610 Return -1 if none is found. The value is >= 0 if it is an index.
3611 START is the index at which to start searching the line table.
3613 Set *EXACT_MATCH nonzero if the value returned is an exact match. */
3616 find_line_common (struct linetable
*l
, int lineno
,
3617 int *exact_match
, int start
)
3622 /* BEST is the smallest linenumber > LINENO so far seen,
3623 or 0 if none has been seen so far.
3624 BEST_INDEX identifies the item for it. */
3626 int best_index
= -1;
3637 for (i
= start
; i
< len
; i
++)
3639 struct linetable_entry
*item
= &(l
->item
[i
]);
3641 /* Ignore non-statements. */
3645 if (item
->line
== lineno
)
3647 /* Return the first (lowest address) entry which matches. */
3652 if (item
->line
> lineno
&& (best
== 0 || item
->line
< best
))
3659 /* If we got here, we didn't get an exact match. */
3664 find_pc_line_pc_range (CORE_ADDR pc
, CORE_ADDR
*startptr
, CORE_ADDR
*endptr
)
3666 struct symtab_and_line sal
;
3668 sal
= find_pc_line (pc
, 0);
3671 return sal
.symtab
!= 0;
3674 /* Helper for find_function_start_sal. Does most of the work, except
3675 setting the sal's symbol. */
3677 static symtab_and_line
3678 find_function_start_sal_1 (CORE_ADDR func_addr
, obj_section
*section
,
3681 symtab_and_line sal
= find_pc_sect_line (func_addr
, section
, 0);
3683 if (funfirstline
&& sal
.symtab
!= NULL
3684 && (COMPUNIT_LOCATIONS_VALID (SYMTAB_COMPUNIT (sal
.symtab
))
3685 || SYMTAB_LANGUAGE (sal
.symtab
) == language_asm
))
3687 struct gdbarch
*gdbarch
= SYMTAB_OBJFILE (sal
.symtab
)->arch ();
3690 if (gdbarch_skip_entrypoint_p (gdbarch
))
3691 sal
.pc
= gdbarch_skip_entrypoint (gdbarch
, sal
.pc
);
3695 /* We always should have a line for the function start address.
3696 If we don't, something is odd. Create a plain SAL referring
3697 just the PC and hope that skip_prologue_sal (if requested)
3698 can find a line number for after the prologue. */
3699 if (sal
.pc
< func_addr
)
3702 sal
.pspace
= current_program_space
;
3704 sal
.section
= section
;
3708 skip_prologue_sal (&sal
);
3716 find_function_start_sal (CORE_ADDR func_addr
, obj_section
*section
,
3720 = find_function_start_sal_1 (func_addr
, section
, funfirstline
);
3722 /* find_function_start_sal_1 does a linetable search, so it finds
3723 the symtab and linenumber, but not a symbol. Fill in the
3724 function symbol too. */
3725 sal
.symbol
= find_pc_sect_containing_function (sal
.pc
, sal
.section
);
3733 find_function_start_sal (symbol
*sym
, bool funfirstline
)
3735 fixup_symbol_section (sym
, NULL
);
3737 = find_function_start_sal_1 (BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
)),
3738 sym
->obj_section (symbol_objfile (sym
)),
3745 /* Given a function start address FUNC_ADDR and SYMTAB, find the first
3746 address for that function that has an entry in SYMTAB's line info
3747 table. If such an entry cannot be found, return FUNC_ADDR
3751 skip_prologue_using_lineinfo (CORE_ADDR func_addr
, struct symtab
*symtab
)
3753 CORE_ADDR func_start
, func_end
;
3754 struct linetable
*l
;
3757 /* Give up if this symbol has no lineinfo table. */
3758 l
= SYMTAB_LINETABLE (symtab
);
3762 /* Get the range for the function's PC values, or give up if we
3763 cannot, for some reason. */
3764 if (!find_pc_partial_function (func_addr
, NULL
, &func_start
, &func_end
))
3767 /* Linetable entries are ordered by PC values, see the commentary in
3768 symtab.h where `struct linetable' is defined. Thus, the first
3769 entry whose PC is in the range [FUNC_START..FUNC_END[ is the
3770 address we are looking for. */
3771 for (i
= 0; i
< l
->nitems
; i
++)
3773 struct linetable_entry
*item
= &(l
->item
[i
]);
3775 /* Don't use line numbers of zero, they mark special entries in
3776 the table. See the commentary on symtab.h before the
3777 definition of struct linetable. */
3778 if (item
->line
> 0 && func_start
<= item
->pc
&& item
->pc
< func_end
)
3785 /* Adjust SAL to the first instruction past the function prologue.
3786 If the PC was explicitly specified, the SAL is not changed.
3787 If the line number was explicitly specified then the SAL can still be
3788 updated, unless the language for SAL is assembler, in which case the SAL
3789 will be left unchanged.
3790 If SAL is already past the prologue, then do nothing. */
3793 skip_prologue_sal (struct symtab_and_line
*sal
)
3796 struct symtab_and_line start_sal
;
3797 CORE_ADDR pc
, saved_pc
;
3798 struct obj_section
*section
;
3800 struct objfile
*objfile
;
3801 struct gdbarch
*gdbarch
;
3802 const struct block
*b
, *function_block
;
3803 int force_skip
, skip
;
3805 /* Do not change the SAL if PC was specified explicitly. */
3806 if (sal
->explicit_pc
)
3809 /* In assembly code, if the user asks for a specific line then we should
3810 not adjust the SAL. The user already has instruction level
3811 visibility in this case, so selecting a line other than one requested
3812 is likely to be the wrong choice. */
3813 if (sal
->symtab
!= nullptr
3814 && sal
->explicit_line
3815 && SYMTAB_LANGUAGE (sal
->symtab
) == language_asm
)
3818 scoped_restore_current_pspace_and_thread restore_pspace_thread
;
3820 switch_to_program_space_and_thread (sal
->pspace
);
3822 sym
= find_pc_sect_function (sal
->pc
, sal
->section
);
3825 fixup_symbol_section (sym
, NULL
);
3827 objfile
= symbol_objfile (sym
);
3828 pc
= BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
));
3829 section
= sym
->obj_section (objfile
);
3830 name
= sym
->linkage_name ();
3834 struct bound_minimal_symbol msymbol
3835 = lookup_minimal_symbol_by_pc_section (sal
->pc
, sal
->section
);
3837 if (msymbol
.minsym
== NULL
)
3840 objfile
= msymbol
.objfile
;
3841 pc
= BMSYMBOL_VALUE_ADDRESS (msymbol
);
3842 section
= msymbol
.minsym
->obj_section (objfile
);
3843 name
= msymbol
.minsym
->linkage_name ();
3846 gdbarch
= objfile
->arch ();
3848 /* Process the prologue in two passes. In the first pass try to skip the
3849 prologue (SKIP is true) and verify there is a real need for it (indicated
3850 by FORCE_SKIP). If no such reason was found run a second pass where the
3851 prologue is not skipped (SKIP is false). */
3856 /* Be conservative - allow direct PC (without skipping prologue) only if we
3857 have proven the CU (Compilation Unit) supports it. sal->SYMTAB does not
3858 have to be set by the caller so we use SYM instead. */
3860 && COMPUNIT_LOCATIONS_VALID (SYMTAB_COMPUNIT (symbol_symtab (sym
))))
3868 /* If the function is in an unmapped overlay, use its unmapped LMA address,
3869 so that gdbarch_skip_prologue has something unique to work on. */
3870 if (section_is_overlay (section
) && !section_is_mapped (section
))
3871 pc
= overlay_unmapped_address (pc
, section
);
3873 /* Skip "first line" of function (which is actually its prologue). */
3874 pc
+= gdbarch_deprecated_function_start_offset (gdbarch
);
3875 if (gdbarch_skip_entrypoint_p (gdbarch
))
3876 pc
= gdbarch_skip_entrypoint (gdbarch
, pc
);
3878 pc
= gdbarch_skip_prologue_noexcept (gdbarch
, pc
);
3880 /* For overlays, map pc back into its mapped VMA range. */
3881 pc
= overlay_mapped_address (pc
, section
);
3883 /* Calculate line number. */
3884 start_sal
= find_pc_sect_line (pc
, section
, 0);
3886 /* Check if gdbarch_skip_prologue left us in mid-line, and the next
3887 line is still part of the same function. */
3888 if (skip
&& start_sal
.pc
!= pc
3889 && (sym
? (BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
)) <= start_sal
.end
3890 && start_sal
.end
< BLOCK_END (SYMBOL_BLOCK_VALUE (sym
)))
3891 : (lookup_minimal_symbol_by_pc_section (start_sal
.end
, section
).minsym
3892 == lookup_minimal_symbol_by_pc_section (pc
, section
).minsym
)))
3894 /* First pc of next line */
3896 /* Recalculate the line number (might not be N+1). */
3897 start_sal
= find_pc_sect_line (pc
, section
, 0);
3900 /* On targets with executable formats that don't have a concept of
3901 constructors (ELF with .init has, PE doesn't), gcc emits a call
3902 to `__main' in `main' between the prologue and before user
3904 if (gdbarch_skip_main_prologue_p (gdbarch
)
3905 && name
&& strcmp_iw (name
, "main") == 0)
3907 pc
= gdbarch_skip_main_prologue (gdbarch
, pc
);
3908 /* Recalculate the line number (might not be N+1). */
3909 start_sal
= find_pc_sect_line (pc
, section
, 0);
3913 while (!force_skip
&& skip
--);
3915 /* If we still don't have a valid source line, try to find the first
3916 PC in the lineinfo table that belongs to the same function. This
3917 happens with COFF debug info, which does not seem to have an
3918 entry in lineinfo table for the code after the prologue which has
3919 no direct relation to source. For example, this was found to be
3920 the case with the DJGPP target using "gcc -gcoff" when the
3921 compiler inserted code after the prologue to make sure the stack
3923 if (!force_skip
&& sym
&& start_sal
.symtab
== NULL
)
3925 pc
= skip_prologue_using_lineinfo (pc
, symbol_symtab (sym
));
3926 /* Recalculate the line number. */
3927 start_sal
= find_pc_sect_line (pc
, section
, 0);
3930 /* If we're already past the prologue, leave SAL unchanged. Otherwise
3931 forward SAL to the end of the prologue. */
3936 sal
->section
= section
;
3937 sal
->symtab
= start_sal
.symtab
;
3938 sal
->line
= start_sal
.line
;
3939 sal
->end
= start_sal
.end
;
3941 /* Check if we are now inside an inlined function. If we can,
3942 use the call site of the function instead. */
3943 b
= block_for_pc_sect (sal
->pc
, sal
->section
);
3944 function_block
= NULL
;
3947 if (BLOCK_FUNCTION (b
) != NULL
&& block_inlined_p (b
))
3949 else if (BLOCK_FUNCTION (b
) != NULL
)
3951 b
= BLOCK_SUPERBLOCK (b
);
3953 if (function_block
!= NULL
3954 && SYMBOL_LINE (BLOCK_FUNCTION (function_block
)) != 0)
3956 sal
->line
= SYMBOL_LINE (BLOCK_FUNCTION (function_block
));
3957 sal
->symtab
= symbol_symtab (BLOCK_FUNCTION (function_block
));
3961 /* Given PC at the function's start address, attempt to find the
3962 prologue end using SAL information. Return zero if the skip fails.
3964 A non-optimized prologue traditionally has one SAL for the function
3965 and a second for the function body. A single line function has
3966 them both pointing at the same line.
3968 An optimized prologue is similar but the prologue may contain
3969 instructions (SALs) from the instruction body. Need to skip those
3970 while not getting into the function body.
3972 The functions end point and an increasing SAL line are used as
3973 indicators of the prologue's endpoint.
3975 This code is based on the function refine_prologue_limit
3979 skip_prologue_using_sal (struct gdbarch
*gdbarch
, CORE_ADDR func_addr
)
3981 struct symtab_and_line prologue_sal
;
3984 const struct block
*bl
;
3986 /* Get an initial range for the function. */
3987 find_pc_partial_function (func_addr
, NULL
, &start_pc
, &end_pc
);
3988 start_pc
+= gdbarch_deprecated_function_start_offset (gdbarch
);
3990 prologue_sal
= find_pc_line (start_pc
, 0);
3991 if (prologue_sal
.line
!= 0)
3993 /* For languages other than assembly, treat two consecutive line
3994 entries at the same address as a zero-instruction prologue.
3995 The GNU assembler emits separate line notes for each instruction
3996 in a multi-instruction macro, but compilers generally will not
3998 if (prologue_sal
.symtab
->language
!= language_asm
)
4000 struct linetable
*linetable
= SYMTAB_LINETABLE (prologue_sal
.symtab
);
4003 /* Skip any earlier lines, and any end-of-sequence marker
4004 from a previous function. */
4005 while (linetable
->item
[idx
].pc
!= prologue_sal
.pc
4006 || linetable
->item
[idx
].line
== 0)
4009 if (idx
+1 < linetable
->nitems
4010 && linetable
->item
[idx
+1].line
!= 0
4011 && linetable
->item
[idx
+1].pc
== start_pc
)
4015 /* If there is only one sal that covers the entire function,
4016 then it is probably a single line function, like
4018 if (prologue_sal
.end
>= end_pc
)
4021 while (prologue_sal
.end
< end_pc
)
4023 struct symtab_and_line sal
;
4025 sal
= find_pc_line (prologue_sal
.end
, 0);
4028 /* Assume that a consecutive SAL for the same (or larger)
4029 line mark the prologue -> body transition. */
4030 if (sal
.line
>= prologue_sal
.line
)
4032 /* Likewise if we are in a different symtab altogether
4033 (e.g. within a file included via #include). */
4034 if (sal
.symtab
!= prologue_sal
.symtab
)
4037 /* The line number is smaller. Check that it's from the
4038 same function, not something inlined. If it's inlined,
4039 then there is no point comparing the line numbers. */
4040 bl
= block_for_pc (prologue_sal
.end
);
4043 if (block_inlined_p (bl
))
4045 if (BLOCK_FUNCTION (bl
))
4050 bl
= BLOCK_SUPERBLOCK (bl
);
4055 /* The case in which compiler's optimizer/scheduler has
4056 moved instructions into the prologue. We look ahead in
4057 the function looking for address ranges whose
4058 corresponding line number is less the first one that we
4059 found for the function. This is more conservative then
4060 refine_prologue_limit which scans a large number of SALs
4061 looking for any in the prologue. */
4066 if (prologue_sal
.end
< end_pc
)
4067 /* Return the end of this line, or zero if we could not find a
4069 return prologue_sal
.end
;
4071 /* Don't return END_PC, which is past the end of the function. */
4072 return prologue_sal
.pc
;
4078 find_function_alias_target (bound_minimal_symbol msymbol
)
4080 CORE_ADDR func_addr
;
4081 if (!msymbol_is_function (msymbol
.objfile
, msymbol
.minsym
, &func_addr
))
4084 symbol
*sym
= find_pc_function (func_addr
);
4086 && SYMBOL_CLASS (sym
) == LOC_BLOCK
4087 && BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
)) == func_addr
)
4094 /* If P is of the form "operator[ \t]+..." where `...' is
4095 some legitimate operator text, return a pointer to the
4096 beginning of the substring of the operator text.
4097 Otherwise, return "". */
4100 operator_chars (const char *p
, const char **end
)
4103 if (!startswith (p
, CP_OPERATOR_STR
))
4105 p
+= CP_OPERATOR_LEN
;
4107 /* Don't get faked out by `operator' being part of a longer
4109 if (isalpha (*p
) || *p
== '_' || *p
== '$' || *p
== '\0')
4112 /* Allow some whitespace between `operator' and the operator symbol. */
4113 while (*p
== ' ' || *p
== '\t')
4116 /* Recognize 'operator TYPENAME'. */
4118 if (isalpha (*p
) || *p
== '_' || *p
== '$')
4120 const char *q
= p
+ 1;
4122 while (isalnum (*q
) || *q
== '_' || *q
== '$')
4131 case '\\': /* regexp quoting */
4134 if (p
[2] == '=') /* 'operator\*=' */
4136 else /* 'operator\*' */
4140 else if (p
[1] == '[')
4143 error (_("mismatched quoting on brackets, "
4144 "try 'operator\\[\\]'"));
4145 else if (p
[2] == '\\' && p
[3] == ']')
4147 *end
= p
+ 4; /* 'operator\[\]' */
4151 error (_("nothing is allowed between '[' and ']'"));
4155 /* Gratuitous quote: skip it and move on. */
4177 if (p
[0] == '-' && p
[1] == '>')
4179 /* Struct pointer member operator 'operator->'. */
4182 *end
= p
+ 3; /* 'operator->*' */
4185 else if (p
[2] == '\\')
4187 *end
= p
+ 4; /* Hopefully 'operator->\*' */
4192 *end
= p
+ 2; /* 'operator->' */
4196 if (p
[1] == '=' || p
[1] == p
[0])
4207 error (_("`operator ()' must be specified "
4208 "without whitespace in `()'"));
4213 error (_("`operator ?:' must be specified "
4214 "without whitespace in `?:'"));
4219 error (_("`operator []' must be specified "
4220 "without whitespace in `[]'"));
4224 error (_("`operator %s' not supported"), p
);
4233 /* See class declaration. */
4235 info_sources_filter::info_sources_filter (match_on match_type
,
4237 : m_match_type (match_type
),
4240 /* Setup the compiled regular expression M_C_REGEXP based on M_REGEXP. */
4241 if (m_regexp
!= nullptr && *m_regexp
!= '\0')
4243 gdb_assert (m_regexp
!= nullptr);
4245 int cflags
= REG_NOSUB
;
4246 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
4247 cflags
|= REG_ICASE
;
4249 m_c_regexp
.emplace (m_regexp
, cflags
, _("Invalid regexp"));
4253 /* See class declaration. */
4256 info_sources_filter::matches (const char *fullname
) const
4258 /* Does it match regexp? */
4259 if (m_c_regexp
.has_value ())
4261 const char *to_match
;
4262 std::string dirname
;
4264 switch (m_match_type
)
4266 case match_on::DIRNAME
:
4267 dirname
= ldirname (fullname
);
4268 to_match
= dirname
.c_str ();
4270 case match_on::BASENAME
:
4271 to_match
= lbasename (fullname
);
4273 case match_on::FULLNAME
:
4274 to_match
= fullname
;
4277 gdb_assert_not_reached ("bad m_match_type");
4280 if (m_c_regexp
->exec (to_match
, 0, NULL
, 0) != 0)
4287 /* Data structure to maintain the state used for printing the results of
4288 the 'info sources' command. */
4290 struct output_source_filename_data
4292 /* Create an object for displaying the results of the 'info sources'
4293 command to UIOUT. FILTER must remain valid and unchanged for the
4294 lifetime of this object as this object retains a reference to FILTER. */
4295 output_source_filename_data (struct ui_out
*uiout
,
4296 const info_sources_filter
&filter
)
4297 : m_filter (filter
),
4301 DISABLE_COPY_AND_ASSIGN (output_source_filename_data
);
4303 /* Reset enough state of this object so we can match against a new set of
4304 files. The existing regular expression is retained though. */
4305 void reset_output ()
4308 m_filename_seen_cache
.clear ();
4311 /* Worker for sources_info, outputs the file name formatted for either
4312 cli or mi (based on the current_uiout). In cli mode displays
4313 FULLNAME with a comma separating this name from any previously
4314 printed name (line breaks are added at the comma). In MI mode
4315 outputs a tuple containing DISP_NAME (the files display name),
4316 FULLNAME, and EXPANDED_P (true when this file is from a fully
4317 expanded symtab, otherwise false). */
4318 void output (const char *disp_name
, const char *fullname
, bool expanded_p
);
4320 /* An overload suitable for use as a callback to
4321 quick_symbol_functions::map_symbol_filenames. */
4322 void operator() (const char *filename
, const char *fullname
)
4324 /* The false here indicates that this file is from an unexpanded
4326 output (filename
, fullname
, false);
4329 /* Return true if at least one filename has been printed (after a call to
4330 output) since either this object was created, or the last call to
4332 bool printed_filename_p () const
4339 /* Flag of whether we're printing the first one. */
4340 bool m_first
= true;
4342 /* Cache of what we've seen so far. */
4343 filename_seen_cache m_filename_seen_cache
;
4345 /* How source filename should be filtered. */
4346 const info_sources_filter
&m_filter
;
4348 /* The object to which output is sent. */
4349 struct ui_out
*m_uiout
;
4352 /* See comment in class declaration above. */
4355 output_source_filename_data::output (const char *disp_name
,
4356 const char *fullname
,
4359 /* Since a single source file can result in several partial symbol
4360 tables, we need to avoid printing it more than once. Note: if
4361 some of the psymtabs are read in and some are not, it gets
4362 printed both under "Source files for which symbols have been
4363 read" and "Source files for which symbols will be read in on
4364 demand". I consider this a reasonable way to deal with the
4365 situation. I'm not sure whether this can also happen for
4366 symtabs; it doesn't hurt to check. */
4368 /* Was NAME already seen? If so, then don't print it again. */
4369 if (m_filename_seen_cache
.seen (fullname
))
4372 /* If the filter rejects this file then don't print it. */
4373 if (!m_filter
.matches (fullname
))
4376 ui_out_emit_tuple
ui_emitter (m_uiout
, nullptr);
4378 /* Print it and reset *FIRST. */
4380 m_uiout
->text (", ");
4384 if (m_uiout
->is_mi_like_p ())
4386 m_uiout
->field_string ("file", disp_name
, file_name_style
.style ());
4387 if (fullname
!= nullptr)
4388 m_uiout
->field_string ("fullname", fullname
,
4389 file_name_style
.style ());
4390 m_uiout
->field_string ("debug-fully-read",
4391 (expanded_p
? "true" : "false"));
4395 if (fullname
== nullptr)
4396 fullname
= disp_name
;
4397 m_uiout
->field_string ("fullname", fullname
,
4398 file_name_style
.style ());
4402 /* For the 'info sources' command, what part of the file names should we be
4403 matching the user supplied regular expression against? */
4405 struct filename_partial_match_opts
4407 /* Only match the directory name part. */
4408 bool dirname
= false;
4410 /* Only match the basename part. */
4411 bool basename
= false;
4414 using isrc_flag_option_def
4415 = gdb::option::flag_option_def
<filename_partial_match_opts
>;
4417 static const gdb::option::option_def info_sources_option_defs
[] = {
4419 isrc_flag_option_def
{
4421 [] (filename_partial_match_opts
*opts
) { return &opts
->dirname
; },
4422 N_("Show only the files having a dirname matching REGEXP."),
4425 isrc_flag_option_def
{
4427 [] (filename_partial_match_opts
*opts
) { return &opts
->basename
; },
4428 N_("Show only the files having a basename matching REGEXP."),
4433 /* Create an option_def_group for the "info sources" options, with
4434 ISRC_OPTS as context. */
4436 static inline gdb::option::option_def_group
4437 make_info_sources_options_def_group (filename_partial_match_opts
*isrc_opts
)
4439 return {{info_sources_option_defs
}, isrc_opts
};
4442 /* Completer for "info sources". */
4445 info_sources_command_completer (cmd_list_element
*ignore
,
4446 completion_tracker
&tracker
,
4447 const char *text
, const char *word
)
4449 const auto group
= make_info_sources_options_def_group (nullptr);
4450 if (gdb::option::complete_options
4451 (tracker
, &text
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, group
))
4458 info_sources_worker (struct ui_out
*uiout
,
4459 bool group_by_objfile
,
4460 const info_sources_filter
&filter
)
4462 output_source_filename_data
data (uiout
, filter
);
4464 ui_out_emit_list
results_emitter (uiout
, "files");
4465 gdb::optional
<ui_out_emit_tuple
> output_tuple
;
4466 gdb::optional
<ui_out_emit_list
> sources_list
;
4468 gdb_assert (group_by_objfile
|| uiout
->is_mi_like_p ());
4470 for (objfile
*objfile
: current_program_space
->objfiles ())
4472 if (group_by_objfile
)
4474 output_tuple
.emplace (uiout
, nullptr);
4475 uiout
->field_string ("filename", objfile_name (objfile
));
4476 uiout
->text (":\n");
4477 bool debug_fully_readin
= !objfile
->has_unexpanded_symtabs ();
4478 if (uiout
->is_mi_like_p ())
4480 const char *debug_info_state
;
4481 if (objfile_has_symbols (objfile
))
4483 if (debug_fully_readin
)
4484 debug_info_state
= "fully-read";
4486 debug_info_state
= "partially-read";
4489 debug_info_state
= "none";
4490 current_uiout
->field_string ("debug-info", debug_info_state
);
4494 if (!debug_fully_readin
)
4495 uiout
->text ("(Full debug information has not yet been read "
4496 "for this file.)\n");
4497 if (!objfile_has_symbols (objfile
))
4498 uiout
->text ("(Objfile has no debug information.)\n");
4501 sources_list
.emplace (uiout
, "sources");
4504 for (compunit_symtab
*cu
: objfile
->compunits ())
4506 for (symtab
*s
: compunit_filetabs (cu
))
4508 const char *file
= symtab_to_filename_for_display (s
);
4509 const char *fullname
= symtab_to_fullname (s
);
4510 data
.output (file
, fullname
, true);
4514 if (group_by_objfile
)
4516 objfile
->map_symbol_filenames (data
, true /* need_fullname */);
4517 if (data
.printed_filename_p ())
4518 uiout
->text ("\n\n");
4519 data
.reset_output ();
4520 sources_list
.reset ();
4521 output_tuple
.reset ();
4525 if (!group_by_objfile
)
4527 data
.reset_output ();
4528 map_symbol_filenames (data
, true /*need_fullname*/);
4532 /* Implement the 'info sources' command. */
4535 info_sources_command (const char *args
, int from_tty
)
4537 if (!have_full_symbols () && !have_partial_symbols ())
4538 error (_("No symbol table is loaded. Use the \"file\" command."));
4540 filename_partial_match_opts match_opts
;
4541 auto group
= make_info_sources_options_def_group (&match_opts
);
4542 gdb::option::process_options
4543 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_ERROR
, group
);
4545 if (match_opts
.dirname
&& match_opts
.basename
)
4546 error (_("You cannot give both -basename and -dirname to 'info sources'."));
4548 const char *regex
= nullptr;
4549 if (args
!= NULL
&& *args
!= '\000')
4552 if ((match_opts
.dirname
|| match_opts
.basename
) && regex
== nullptr)
4553 error (_("Missing REGEXP for 'info sources'."));
4555 info_sources_filter::match_on match_type
;
4556 if (match_opts
.dirname
)
4557 match_type
= info_sources_filter::match_on::DIRNAME
;
4558 else if (match_opts
.basename
)
4559 match_type
= info_sources_filter::match_on::BASENAME
;
4561 match_type
= info_sources_filter::match_on::FULLNAME
;
4563 info_sources_filter
filter (match_type
, regex
);
4564 info_sources_worker (current_uiout
, true, filter
);
4567 /* Compare FILE against all the entries of FILENAMES. If BASENAMES is
4568 true compare only lbasename of FILENAMES. */
4571 file_matches (const char *file
, const std::vector
<const char *> &filenames
,
4574 if (filenames
.empty ())
4577 for (const char *name
: filenames
)
4579 name
= (basenames
? lbasename (name
) : name
);
4580 if (compare_filenames_for_search (file
, name
))
4587 /* Helper function for std::sort on symbol_search objects. Can only sort
4588 symbols, not minimal symbols. */
4591 symbol_search::compare_search_syms (const symbol_search
&sym_a
,
4592 const symbol_search
&sym_b
)
4596 c
= FILENAME_CMP (symbol_symtab (sym_a
.symbol
)->filename
,
4597 symbol_symtab (sym_b
.symbol
)->filename
);
4601 if (sym_a
.block
!= sym_b
.block
)
4602 return sym_a
.block
- sym_b
.block
;
4604 return strcmp (sym_a
.symbol
->print_name (), sym_b
.symbol
->print_name ());
4607 /* Returns true if the type_name of symbol_type of SYM matches TREG.
4608 If SYM has no symbol_type or symbol_name, returns false. */
4611 treg_matches_sym_type_name (const compiled_regex
&treg
,
4612 const struct symbol
*sym
)
4614 struct type
*sym_type
;
4615 std::string printed_sym_type_name
;
4617 if (symbol_lookup_debug
> 1)
4619 fprintf_unfiltered (gdb_stdlog
,
4620 "treg_matches_sym_type_name\n sym %s\n",
4621 sym
->natural_name ());
4624 sym_type
= SYMBOL_TYPE (sym
);
4625 if (sym_type
== NULL
)
4629 scoped_switch_to_sym_language_if_auto
l (sym
);
4631 printed_sym_type_name
= type_to_string (sym_type
);
4635 if (symbol_lookup_debug
> 1)
4637 fprintf_unfiltered (gdb_stdlog
,
4638 " sym_type_name %s\n",
4639 printed_sym_type_name
.c_str ());
4643 if (printed_sym_type_name
.empty ())
4646 return treg
.exec (printed_sym_type_name
.c_str (), 0, NULL
, 0) == 0;
4652 global_symbol_searcher::is_suitable_msymbol
4653 (const enum search_domain kind
, const minimal_symbol
*msymbol
)
4655 switch (MSYMBOL_TYPE (msymbol
))
4661 return kind
== VARIABLES_DOMAIN
;
4664 case mst_solib_trampoline
:
4665 case mst_text_gnu_ifunc
:
4666 return kind
== FUNCTIONS_DOMAIN
;
4675 global_symbol_searcher::expand_symtabs
4676 (objfile
*objfile
, const gdb::optional
<compiled_regex
> &preg
) const
4678 enum search_domain kind
= m_kind
;
4679 bool found_msymbol
= false;
4681 objfile
->expand_symtabs_matching
4682 ([&] (const char *filename
, bool basenames
)
4684 return file_matches (filename
, filenames
, basenames
);
4686 &lookup_name_info::match_any (),
4687 [&] (const char *symname
)
4689 return (!preg
.has_value ()
4690 || preg
->exec (symname
, 0, NULL
, 0) == 0);
4693 SEARCH_GLOBAL_BLOCK
| SEARCH_STATIC_BLOCK
,
4697 /* Here, we search through the minimal symbol tables for functions and
4698 variables that match, and force their symbols to be read. This is in
4699 particular necessary for demangled variable names, which are no longer
4700 put into the partial symbol tables. The symbol will then be found
4701 during the scan of symtabs later.
4703 For functions, find_pc_symtab should succeed if we have debug info for
4704 the function, for variables we have to call
4705 lookup_symbol_in_objfile_from_linkage_name to determine if the
4706 variable has debug info. If the lookup fails, set found_msymbol so
4707 that we will rescan to print any matching symbols without debug info.
4708 We only search the objfile the msymbol came from, we no longer search
4709 all objfiles. In large programs (1000s of shared libs) searching all
4710 objfiles is not worth the pain. */
4711 if (filenames
.empty ()
4712 && (kind
== VARIABLES_DOMAIN
|| kind
== FUNCTIONS_DOMAIN
))
4714 for (minimal_symbol
*msymbol
: objfile
->msymbols ())
4718 if (msymbol
->created_by_gdb
)
4721 if (is_suitable_msymbol (kind
, msymbol
))
4723 if (!preg
.has_value ()
4724 || preg
->exec (msymbol
->natural_name (), 0,
4727 /* An important side-effect of these lookup functions is
4728 to expand the symbol table if msymbol is found, later
4729 in the process we will add matching symbols or
4730 msymbols to the results list, and that requires that
4731 the symbols tables are expanded. */
4732 if (kind
== FUNCTIONS_DOMAIN
4733 ? (find_pc_compunit_symtab
4734 (MSYMBOL_VALUE_ADDRESS (objfile
, msymbol
))
4736 : (lookup_symbol_in_objfile_from_linkage_name
4737 (objfile
, msymbol
->linkage_name (),
4740 found_msymbol
= true;
4746 return found_msymbol
;
4752 global_symbol_searcher::add_matching_symbols
4754 const gdb::optional
<compiled_regex
> &preg
,
4755 const gdb::optional
<compiled_regex
> &treg
,
4756 std::set
<symbol_search
> *result_set
) const
4758 enum search_domain kind
= m_kind
;
4760 /* Add matching symbols (if not already present). */
4761 for (compunit_symtab
*cust
: objfile
->compunits ())
4763 const struct blockvector
*bv
= COMPUNIT_BLOCKVECTOR (cust
);
4765 for (block_enum block
: { GLOBAL_BLOCK
, STATIC_BLOCK
})
4767 struct block_iterator iter
;
4769 const struct block
*b
= BLOCKVECTOR_BLOCK (bv
, block
);
4771 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
4773 struct symtab
*real_symtab
= symbol_symtab (sym
);
4777 /* Check first sole REAL_SYMTAB->FILENAME. It does
4778 not need to be a substring of symtab_to_fullname as
4779 it may contain "./" etc. */
4780 if ((file_matches (real_symtab
->filename
, filenames
, false)
4781 || ((basenames_may_differ
4782 || file_matches (lbasename (real_symtab
->filename
),
4784 && file_matches (symtab_to_fullname (real_symtab
),
4786 && ((!preg
.has_value ()
4787 || preg
->exec (sym
->natural_name (), 0,
4789 && ((kind
== VARIABLES_DOMAIN
4790 && SYMBOL_CLASS (sym
) != LOC_TYPEDEF
4791 && SYMBOL_CLASS (sym
) != LOC_UNRESOLVED
4792 && SYMBOL_CLASS (sym
) != LOC_BLOCK
4793 /* LOC_CONST can be used for more than
4794 just enums, e.g., c++ static const
4795 members. We only want to skip enums
4797 && !(SYMBOL_CLASS (sym
) == LOC_CONST
4798 && (SYMBOL_TYPE (sym
)->code ()
4800 && (!treg
.has_value ()
4801 || treg_matches_sym_type_name (*treg
, sym
)))
4802 || (kind
== FUNCTIONS_DOMAIN
4803 && SYMBOL_CLASS (sym
) == LOC_BLOCK
4804 && (!treg
.has_value ()
4805 || treg_matches_sym_type_name (*treg
,
4807 || (kind
== TYPES_DOMAIN
4808 && SYMBOL_CLASS (sym
) == LOC_TYPEDEF
4809 && SYMBOL_DOMAIN (sym
) != MODULE_DOMAIN
)
4810 || (kind
== MODULES_DOMAIN
4811 && SYMBOL_DOMAIN (sym
) == MODULE_DOMAIN
4812 && SYMBOL_LINE (sym
) != 0))))
4814 if (result_set
->size () < m_max_search_results
)
4816 /* Match, insert if not already in the results. */
4817 symbol_search
ss (block
, sym
);
4818 if (result_set
->find (ss
) == result_set
->end ())
4819 result_set
->insert (ss
);
4834 global_symbol_searcher::add_matching_msymbols
4835 (objfile
*objfile
, const gdb::optional
<compiled_regex
> &preg
,
4836 std::vector
<symbol_search
> *results
) const
4838 enum search_domain kind
= m_kind
;
4840 for (minimal_symbol
*msymbol
: objfile
->msymbols ())
4844 if (msymbol
->created_by_gdb
)
4847 if (is_suitable_msymbol (kind
, msymbol
))
4849 if (!preg
.has_value ()
4850 || preg
->exec (msymbol
->natural_name (), 0,
4853 /* For functions we can do a quick check of whether the
4854 symbol might be found via find_pc_symtab. */
4855 if (kind
!= FUNCTIONS_DOMAIN
4856 || (find_pc_compunit_symtab
4857 (MSYMBOL_VALUE_ADDRESS (objfile
, msymbol
))
4860 if (lookup_symbol_in_objfile_from_linkage_name
4861 (objfile
, msymbol
->linkage_name (),
4862 VAR_DOMAIN
).symbol
== NULL
)
4864 /* Matching msymbol, add it to the results list. */
4865 if (results
->size () < m_max_search_results
)
4866 results
->emplace_back (GLOBAL_BLOCK
, msymbol
, objfile
);
4880 std::vector
<symbol_search
>
4881 global_symbol_searcher::search () const
4883 gdb::optional
<compiled_regex
> preg
;
4884 gdb::optional
<compiled_regex
> treg
;
4886 gdb_assert (m_kind
!= ALL_DOMAIN
);
4888 if (m_symbol_name_regexp
!= NULL
)
4890 const char *symbol_name_regexp
= m_symbol_name_regexp
;
4892 /* Make sure spacing is right for C++ operators.
4893 This is just a courtesy to make the matching less sensitive
4894 to how many spaces the user leaves between 'operator'
4895 and <TYPENAME> or <OPERATOR>. */
4897 const char *opname
= operator_chars (symbol_name_regexp
, &opend
);
4901 int fix
= -1; /* -1 means ok; otherwise number of
4904 if (isalpha (*opname
) || *opname
== '_' || *opname
== '$')
4906 /* There should 1 space between 'operator' and 'TYPENAME'. */
4907 if (opname
[-1] != ' ' || opname
[-2] == ' ')
4912 /* There should 0 spaces between 'operator' and 'OPERATOR'. */
4913 if (opname
[-1] == ' ')
4916 /* If wrong number of spaces, fix it. */
4919 char *tmp
= (char *) alloca (8 + fix
+ strlen (opname
) + 1);
4921 sprintf (tmp
, "operator%.*s%s", fix
, " ", opname
);
4922 symbol_name_regexp
= tmp
;
4926 int cflags
= REG_NOSUB
| (case_sensitivity
== case_sensitive_off
4928 preg
.emplace (symbol_name_regexp
, cflags
,
4929 _("Invalid regexp"));
4932 if (m_symbol_type_regexp
!= NULL
)
4934 int cflags
= REG_NOSUB
| (case_sensitivity
== case_sensitive_off
4936 treg
.emplace (m_symbol_type_regexp
, cflags
,
4937 _("Invalid regexp"));
4940 bool found_msymbol
= false;
4941 std::set
<symbol_search
> result_set
;
4942 for (objfile
*objfile
: current_program_space
->objfiles ())
4944 /* Expand symtabs within objfile that possibly contain matching
4946 found_msymbol
|= expand_symtabs (objfile
, preg
);
4948 /* Find matching symbols within OBJFILE and add them in to the
4949 RESULT_SET set. Use a set here so that we can easily detect
4950 duplicates as we go, and can therefore track how many unique
4951 matches we have found so far. */
4952 if (!add_matching_symbols (objfile
, preg
, treg
, &result_set
))
4956 /* Convert the result set into a sorted result list, as std::set is
4957 defined to be sorted then no explicit call to std::sort is needed. */
4958 std::vector
<symbol_search
> result (result_set
.begin (), result_set
.end ());
4960 /* If there are no debug symbols, then add matching minsyms. But if the
4961 user wants to see symbols matching a type regexp, then never give a
4962 minimal symbol, as we assume that a minimal symbol does not have a
4964 if ((found_msymbol
|| (filenames
.empty () && m_kind
== VARIABLES_DOMAIN
))
4965 && !m_exclude_minsyms
4966 && !treg
.has_value ())
4968 gdb_assert (m_kind
== VARIABLES_DOMAIN
|| m_kind
== FUNCTIONS_DOMAIN
);
4969 for (objfile
*objfile
: current_program_space
->objfiles ())
4970 if (!add_matching_msymbols (objfile
, preg
, &result
))
4980 symbol_to_info_string (struct symbol
*sym
, int block
,
4981 enum search_domain kind
)
4985 gdb_assert (block
== GLOBAL_BLOCK
|| block
== STATIC_BLOCK
);
4987 if (kind
!= TYPES_DOMAIN
&& block
== STATIC_BLOCK
)
4990 /* Typedef that is not a C++ class. */
4991 if (kind
== TYPES_DOMAIN
4992 && SYMBOL_DOMAIN (sym
) != STRUCT_DOMAIN
)
4994 string_file tmp_stream
;
4996 /* FIXME: For C (and C++) we end up with a difference in output here
4997 between how a typedef is printed, and non-typedefs are printed.
4998 The TYPEDEF_PRINT code places a ";" at the end in an attempt to
4999 appear C-like, while TYPE_PRINT doesn't.
5001 For the struct printing case below, things are worse, we force
5002 printing of the ";" in this function, which is going to be wrong
5003 for languages that don't require a ";" between statements. */
5004 if (SYMBOL_TYPE (sym
)->code () == TYPE_CODE_TYPEDEF
)
5005 typedef_print (SYMBOL_TYPE (sym
), sym
, &tmp_stream
);
5007 type_print (SYMBOL_TYPE (sym
), "", &tmp_stream
, -1);
5008 str
+= tmp_stream
.string ();
5010 /* variable, func, or typedef-that-is-c++-class. */
5011 else if (kind
< TYPES_DOMAIN
5012 || (kind
== TYPES_DOMAIN
5013 && SYMBOL_DOMAIN (sym
) == STRUCT_DOMAIN
))
5015 string_file tmp_stream
;
5017 type_print (SYMBOL_TYPE (sym
),
5018 (SYMBOL_CLASS (sym
) == LOC_TYPEDEF
5019 ? "" : sym
->print_name ()),
5022 str
+= tmp_stream
.string ();
5025 /* Printing of modules is currently done here, maybe at some future
5026 point we might want a language specific method to print the module
5027 symbol so that we can customise the output more. */
5028 else if (kind
== MODULES_DOMAIN
)
5029 str
+= sym
->print_name ();
5034 /* Helper function for symbol info commands, for example 'info functions',
5035 'info variables', etc. KIND is the kind of symbol we searched for, and
5036 BLOCK is the type of block the symbols was found in, either GLOBAL_BLOCK
5037 or STATIC_BLOCK. SYM is the symbol we found. If LAST is not NULL,
5038 print file and line number information for the symbol as well. Skip
5039 printing the filename if it matches LAST. */
5042 print_symbol_info (enum search_domain kind
,
5044 int block
, const char *last
)
5046 scoped_switch_to_sym_language_if_auto
l (sym
);
5047 struct symtab
*s
= symbol_symtab (sym
);
5051 const char *s_filename
= symtab_to_filename_for_display (s
);
5053 if (filename_cmp (last
, s_filename
) != 0)
5055 printf_filtered (_("\nFile %ps:\n"),
5056 styled_string (file_name_style
.style (),
5060 if (SYMBOL_LINE (sym
) != 0)
5061 printf_filtered ("%d:\t", SYMBOL_LINE (sym
));
5063 puts_filtered ("\t");
5066 std::string str
= symbol_to_info_string (sym
, block
, kind
);
5067 printf_filtered ("%s\n", str
.c_str ());
5070 /* This help function for symtab_symbol_info() prints information
5071 for non-debugging symbols to gdb_stdout. */
5074 print_msymbol_info (struct bound_minimal_symbol msymbol
)
5076 struct gdbarch
*gdbarch
= msymbol
.objfile
->arch ();
5079 if (gdbarch_addr_bit (gdbarch
) <= 32)
5080 tmp
= hex_string_custom (BMSYMBOL_VALUE_ADDRESS (msymbol
)
5081 & (CORE_ADDR
) 0xffffffff,
5084 tmp
= hex_string_custom (BMSYMBOL_VALUE_ADDRESS (msymbol
),
5087 ui_file_style sym_style
= (msymbol
.minsym
->text_p ()
5088 ? function_name_style
.style ()
5089 : ui_file_style ());
5091 printf_filtered (_("%ps %ps\n"),
5092 styled_string (address_style
.style (), tmp
),
5093 styled_string (sym_style
, msymbol
.minsym
->print_name ()));
5096 /* This is the guts of the commands "info functions", "info types", and
5097 "info variables". It calls search_symbols to find all matches and then
5098 print_[m]symbol_info to print out some useful information about the
5102 symtab_symbol_info (bool quiet
, bool exclude_minsyms
,
5103 const char *regexp
, enum search_domain kind
,
5104 const char *t_regexp
, int from_tty
)
5106 static const char * const classnames
[] =
5107 {"variable", "function", "type", "module"};
5108 const char *last_filename
= "";
5111 gdb_assert (kind
!= ALL_DOMAIN
);
5113 if (regexp
!= nullptr && *regexp
== '\0')
5116 global_symbol_searcher
spec (kind
, regexp
);
5117 spec
.set_symbol_type_regexp (t_regexp
);
5118 spec
.set_exclude_minsyms (exclude_minsyms
);
5119 std::vector
<symbol_search
> symbols
= spec
.search ();
5125 if (t_regexp
!= NULL
)
5127 (_("All %ss matching regular expression \"%s\""
5128 " with type matching regular expression \"%s\":\n"),
5129 classnames
[kind
], regexp
, t_regexp
);
5131 printf_filtered (_("All %ss matching regular expression \"%s\":\n"),
5132 classnames
[kind
], regexp
);
5136 if (t_regexp
!= NULL
)
5138 (_("All defined %ss"
5139 " with type matching regular expression \"%s\" :\n"),
5140 classnames
[kind
], t_regexp
);
5142 printf_filtered (_("All defined %ss:\n"), classnames
[kind
]);
5146 for (const symbol_search
&p
: symbols
)
5150 if (p
.msymbol
.minsym
!= NULL
)
5155 printf_filtered (_("\nNon-debugging symbols:\n"));
5158 print_msymbol_info (p
.msymbol
);
5162 print_symbol_info (kind
,
5167 = symtab_to_filename_for_display (symbol_symtab (p
.symbol
));
5172 /* Structure to hold the values of the options used by the 'info variables'
5173 and 'info functions' commands. These correspond to the -q, -t, and -n
5176 struct info_vars_funcs_options
5179 bool exclude_minsyms
= false;
5180 std::string type_regexp
;
5183 /* The options used by the 'info variables' and 'info functions'
5186 static const gdb::option::option_def info_vars_funcs_options_defs
[] = {
5187 gdb::option::boolean_option_def
<info_vars_funcs_options
> {
5189 [] (info_vars_funcs_options
*opt
) { return &opt
->quiet
; },
5190 nullptr, /* show_cmd_cb */
5191 nullptr /* set_doc */
5194 gdb::option::boolean_option_def
<info_vars_funcs_options
> {
5196 [] (info_vars_funcs_options
*opt
) { return &opt
->exclude_minsyms
; },
5197 nullptr, /* show_cmd_cb */
5198 nullptr /* set_doc */
5201 gdb::option::string_option_def
<info_vars_funcs_options
> {
5203 [] (info_vars_funcs_options
*opt
) { return &opt
->type_regexp
; },
5204 nullptr, /* show_cmd_cb */
5205 nullptr /* set_doc */
5209 /* Returns the option group used by 'info variables' and 'info
5212 static gdb::option::option_def_group
5213 make_info_vars_funcs_options_def_group (info_vars_funcs_options
*opts
)
5215 return {{info_vars_funcs_options_defs
}, opts
};
5218 /* Command completer for 'info variables' and 'info functions'. */
5221 info_vars_funcs_command_completer (struct cmd_list_element
*ignore
,
5222 completion_tracker
&tracker
,
5223 const char *text
, const char * /* word */)
5226 = make_info_vars_funcs_options_def_group (nullptr);
5227 if (gdb::option::complete_options
5228 (tracker
, &text
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, group
))
5231 const char *word
= advance_to_expression_complete_word_point (tracker
, text
);
5232 symbol_completer (ignore
, tracker
, text
, word
);
5235 /* Implement the 'info variables' command. */
5238 info_variables_command (const char *args
, int from_tty
)
5240 info_vars_funcs_options opts
;
5241 auto grp
= make_info_vars_funcs_options_def_group (&opts
);
5242 gdb::option::process_options
5243 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
5244 if (args
!= nullptr && *args
== '\0')
5248 (opts
.quiet
, opts
.exclude_minsyms
, args
, VARIABLES_DOMAIN
,
5249 opts
.type_regexp
.empty () ? nullptr : opts
.type_regexp
.c_str (),
5253 /* Implement the 'info functions' command. */
5256 info_functions_command (const char *args
, int from_tty
)
5258 info_vars_funcs_options opts
;
5260 auto grp
= make_info_vars_funcs_options_def_group (&opts
);
5261 gdb::option::process_options
5262 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
5263 if (args
!= nullptr && *args
== '\0')
5267 (opts
.quiet
, opts
.exclude_minsyms
, args
, FUNCTIONS_DOMAIN
,
5268 opts
.type_regexp
.empty () ? nullptr : opts
.type_regexp
.c_str (),
5272 /* Holds the -q option for the 'info types' command. */
5274 struct info_types_options
5279 /* The options used by the 'info types' command. */
5281 static const gdb::option::option_def info_types_options_defs
[] = {
5282 gdb::option::boolean_option_def
<info_types_options
> {
5284 [] (info_types_options
*opt
) { return &opt
->quiet
; },
5285 nullptr, /* show_cmd_cb */
5286 nullptr /* set_doc */
5290 /* Returns the option group used by 'info types'. */
5292 static gdb::option::option_def_group
5293 make_info_types_options_def_group (info_types_options
*opts
)
5295 return {{info_types_options_defs
}, opts
};
5298 /* Implement the 'info types' command. */
5301 info_types_command (const char *args
, int from_tty
)
5303 info_types_options opts
;
5305 auto grp
= make_info_types_options_def_group (&opts
);
5306 gdb::option::process_options
5307 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
5308 if (args
!= nullptr && *args
== '\0')
5310 symtab_symbol_info (opts
.quiet
, false, args
, TYPES_DOMAIN
, NULL
, from_tty
);
5313 /* Command completer for 'info types' command. */
5316 info_types_command_completer (struct cmd_list_element
*ignore
,
5317 completion_tracker
&tracker
,
5318 const char *text
, const char * /* word */)
5321 = make_info_types_options_def_group (nullptr);
5322 if (gdb::option::complete_options
5323 (tracker
, &text
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, group
))
5326 const char *word
= advance_to_expression_complete_word_point (tracker
, text
);
5327 symbol_completer (ignore
, tracker
, text
, word
);
5330 /* Implement the 'info modules' command. */
5333 info_modules_command (const char *args
, int from_tty
)
5335 info_types_options opts
;
5337 auto grp
= make_info_types_options_def_group (&opts
);
5338 gdb::option::process_options
5339 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
5340 if (args
!= nullptr && *args
== '\0')
5342 symtab_symbol_info (opts
.quiet
, true, args
, MODULES_DOMAIN
, NULL
,
5347 rbreak_command (const char *regexp
, int from_tty
)
5350 const char *file_name
= nullptr;
5352 if (regexp
!= nullptr)
5354 const char *colon
= strchr (regexp
, ':');
5356 /* Ignore the colon if it is part of a Windows drive. */
5357 if (HAS_DRIVE_SPEC (regexp
)
5358 && (regexp
[2] == '/' || regexp
[2] == '\\'))
5359 colon
= strchr (STRIP_DRIVE_SPEC (regexp
), ':');
5361 if (colon
&& *(colon
+ 1) != ':')
5366 colon_index
= colon
- regexp
;
5367 local_name
= (char *) alloca (colon_index
+ 1);
5368 memcpy (local_name
, regexp
, colon_index
);
5369 local_name
[colon_index
--] = 0;
5370 while (isspace (local_name
[colon_index
]))
5371 local_name
[colon_index
--] = 0;
5372 file_name
= local_name
;
5373 regexp
= skip_spaces (colon
+ 1);
5377 global_symbol_searcher
spec (FUNCTIONS_DOMAIN
, regexp
);
5378 if (file_name
!= nullptr)
5379 spec
.filenames
.push_back (file_name
);
5380 std::vector
<symbol_search
> symbols
= spec
.search ();
5382 scoped_rbreak_breakpoints finalize
;
5383 for (const symbol_search
&p
: symbols
)
5385 if (p
.msymbol
.minsym
== NULL
)
5387 struct symtab
*symtab
= symbol_symtab (p
.symbol
);
5388 const char *fullname
= symtab_to_fullname (symtab
);
5390 string
= string_printf ("%s:'%s'", fullname
,
5391 p
.symbol
->linkage_name ());
5392 break_command (&string
[0], from_tty
);
5393 print_symbol_info (FUNCTIONS_DOMAIN
, p
.symbol
, p
.block
, NULL
);
5397 string
= string_printf ("'%s'",
5398 p
.msymbol
.minsym
->linkage_name ());
5400 break_command (&string
[0], from_tty
);
5401 printf_filtered ("<function, no debug info> %s;\n",
5402 p
.msymbol
.minsym
->print_name ());
5408 /* Evaluate if SYMNAME matches LOOKUP_NAME. */
5411 compare_symbol_name (const char *symbol_name
, language symbol_language
,
5412 const lookup_name_info
&lookup_name
,
5413 completion_match_result
&match_res
)
5415 const language_defn
*lang
= language_def (symbol_language
);
5417 symbol_name_matcher_ftype
*name_match
5418 = lang
->get_symbol_name_matcher (lookup_name
);
5420 return name_match (symbol_name
, lookup_name
, &match_res
);
5426 completion_list_add_name (completion_tracker
&tracker
,
5427 language symbol_language
,
5428 const char *symname
,
5429 const lookup_name_info
&lookup_name
,
5430 const char *text
, const char *word
)
5432 completion_match_result
&match_res
5433 = tracker
.reset_completion_match_result ();
5435 /* Clip symbols that cannot match. */
5436 if (!compare_symbol_name (symname
, symbol_language
, lookup_name
, match_res
))
5439 /* Refresh SYMNAME from the match string. It's potentially
5440 different depending on language. (E.g., on Ada, the match may be
5441 the encoded symbol name wrapped in "<>"). */
5442 symname
= match_res
.match
.match ();
5443 gdb_assert (symname
!= NULL
);
5445 /* We have a match for a completion, so add SYMNAME to the current list
5446 of matches. Note that the name is moved to freshly malloc'd space. */
5449 gdb::unique_xmalloc_ptr
<char> completion
5450 = make_completion_match_str (symname
, text
, word
);
5452 /* Here we pass the match-for-lcd object to add_completion. Some
5453 languages match the user text against substrings of symbol
5454 names in some cases. E.g., in C++, "b push_ba" completes to
5455 "std::vector::push_back", "std::string::push_back", etc., and
5456 in this case we want the completion lowest common denominator
5457 to be "push_back" instead of "std::". */
5458 tracker
.add_completion (std::move (completion
),
5459 &match_res
.match_for_lcd
, text
, word
);
5465 /* completion_list_add_name wrapper for struct symbol. */
5468 completion_list_add_symbol (completion_tracker
&tracker
,
5470 const lookup_name_info
&lookup_name
,
5471 const char *text
, const char *word
)
5473 if (!completion_list_add_name (tracker
, sym
->language (),
5474 sym
->natural_name (),
5475 lookup_name
, text
, word
))
5478 /* C++ function symbols include the parameters within both the msymbol
5479 name and the symbol name. The problem is that the msymbol name will
5480 describe the parameters in the most basic way, with typedefs stripped
5481 out, while the symbol name will represent the types as they appear in
5482 the program. This means we will see duplicate entries in the
5483 completion tracker. The following converts the symbol name back to
5484 the msymbol name and removes the msymbol name from the completion
5486 if (sym
->language () == language_cplus
5487 && SYMBOL_DOMAIN (sym
) == VAR_DOMAIN
5488 && SYMBOL_CLASS (sym
) == LOC_BLOCK
)
5490 /* The call to canonicalize returns the empty string if the input
5491 string is already in canonical form, thanks to this we don't
5492 remove the symbol we just added above. */
5493 gdb::unique_xmalloc_ptr
<char> str
5494 = cp_canonicalize_string_no_typedefs (sym
->natural_name ());
5496 tracker
.remove_completion (str
.get ());
5500 /* completion_list_add_name wrapper for struct minimal_symbol. */
5503 completion_list_add_msymbol (completion_tracker
&tracker
,
5504 minimal_symbol
*sym
,
5505 const lookup_name_info
&lookup_name
,
5506 const char *text
, const char *word
)
5508 completion_list_add_name (tracker
, sym
->language (),
5509 sym
->natural_name (),
5510 lookup_name
, text
, word
);
5514 /* ObjC: In case we are completing on a selector, look as the msymbol
5515 again and feed all the selectors into the mill. */
5518 completion_list_objc_symbol (completion_tracker
&tracker
,
5519 struct minimal_symbol
*msymbol
,
5520 const lookup_name_info
&lookup_name
,
5521 const char *text
, const char *word
)
5523 static char *tmp
= NULL
;
5524 static unsigned int tmplen
= 0;
5526 const char *method
, *category
, *selector
;
5529 method
= msymbol
->natural_name ();
5531 /* Is it a method? */
5532 if ((method
[0] != '-') && (method
[0] != '+'))
5536 /* Complete on shortened method method. */
5537 completion_list_add_name (tracker
, language_objc
,
5542 while ((strlen (method
) + 1) >= tmplen
)
5548 tmp
= (char *) xrealloc (tmp
, tmplen
);
5550 selector
= strchr (method
, ' ');
5551 if (selector
!= NULL
)
5554 category
= strchr (method
, '(');
5556 if ((category
!= NULL
) && (selector
!= NULL
))
5558 memcpy (tmp
, method
, (category
- method
));
5559 tmp
[category
- method
] = ' ';
5560 memcpy (tmp
+ (category
- method
) + 1, selector
, strlen (selector
) + 1);
5561 completion_list_add_name (tracker
, language_objc
, tmp
,
5562 lookup_name
, text
, word
);
5564 completion_list_add_name (tracker
, language_objc
, tmp
+ 1,
5565 lookup_name
, text
, word
);
5568 if (selector
!= NULL
)
5570 /* Complete on selector only. */
5571 strcpy (tmp
, selector
);
5572 tmp2
= strchr (tmp
, ']');
5576 completion_list_add_name (tracker
, language_objc
, tmp
,
5577 lookup_name
, text
, word
);
5581 /* Break the non-quoted text based on the characters which are in
5582 symbols. FIXME: This should probably be language-specific. */
5585 language_search_unquoted_string (const char *text
, const char *p
)
5587 for (; p
> text
; --p
)
5589 if (isalnum (p
[-1]) || p
[-1] == '_' || p
[-1] == '\0')
5593 if ((current_language
->la_language
== language_objc
))
5595 if (p
[-1] == ':') /* Might be part of a method name. */
5597 else if (p
[-1] == '[' && (p
[-2] == '-' || p
[-2] == '+'))
5598 p
-= 2; /* Beginning of a method name. */
5599 else if (p
[-1] == ' ' || p
[-1] == '(' || p
[-1] == ')')
5600 { /* Might be part of a method name. */
5603 /* Seeing a ' ' or a '(' is not conclusive evidence
5604 that we are in the middle of a method name. However,
5605 finding "-[" or "+[" should be pretty un-ambiguous.
5606 Unfortunately we have to find it now to decide. */
5609 if (isalnum (t
[-1]) || t
[-1] == '_' ||
5610 t
[-1] == ' ' || t
[-1] == ':' ||
5611 t
[-1] == '(' || t
[-1] == ')')
5616 if (t
[-1] == '[' && (t
[-2] == '-' || t
[-2] == '+'))
5617 p
= t
- 2; /* Method name detected. */
5618 /* Else we leave with p unchanged. */
5628 completion_list_add_fields (completion_tracker
&tracker
,
5630 const lookup_name_info
&lookup_name
,
5631 const char *text
, const char *word
)
5633 if (SYMBOL_CLASS (sym
) == LOC_TYPEDEF
)
5635 struct type
*t
= SYMBOL_TYPE (sym
);
5636 enum type_code c
= t
->code ();
5639 if (c
== TYPE_CODE_UNION
|| c
== TYPE_CODE_STRUCT
)
5640 for (j
= TYPE_N_BASECLASSES (t
); j
< t
->num_fields (); j
++)
5641 if (t
->field (j
).name ())
5642 completion_list_add_name (tracker
, sym
->language (),
5643 t
->field (j
).name (),
5644 lookup_name
, text
, word
);
5651 symbol_is_function_or_method (symbol
*sym
)
5653 switch (SYMBOL_TYPE (sym
)->code ())
5655 case TYPE_CODE_FUNC
:
5656 case TYPE_CODE_METHOD
:
5666 symbol_is_function_or_method (minimal_symbol
*msymbol
)
5668 switch (MSYMBOL_TYPE (msymbol
))
5671 case mst_text_gnu_ifunc
:
5672 case mst_solib_trampoline
:
5682 bound_minimal_symbol
5683 find_gnu_ifunc (const symbol
*sym
)
5685 if (SYMBOL_CLASS (sym
) != LOC_BLOCK
)
5688 lookup_name_info
lookup_name (sym
->search_name (),
5689 symbol_name_match_type::SEARCH_NAME
);
5690 struct objfile
*objfile
= symbol_objfile (sym
);
5692 CORE_ADDR address
= BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
));
5693 minimal_symbol
*ifunc
= NULL
;
5695 iterate_over_minimal_symbols (objfile
, lookup_name
,
5696 [&] (minimal_symbol
*minsym
)
5698 if (MSYMBOL_TYPE (minsym
) == mst_text_gnu_ifunc
5699 || MSYMBOL_TYPE (minsym
) == mst_data_gnu_ifunc
)
5701 CORE_ADDR msym_addr
= MSYMBOL_VALUE_ADDRESS (objfile
, minsym
);
5702 if (MSYMBOL_TYPE (minsym
) == mst_data_gnu_ifunc
)
5704 struct gdbarch
*gdbarch
= objfile
->arch ();
5705 msym_addr
= gdbarch_convert_from_func_ptr_addr
5706 (gdbarch
, msym_addr
, current_inferior ()->top_target ());
5708 if (msym_addr
== address
)
5718 return {ifunc
, objfile
};
5722 /* Add matching symbols from SYMTAB to the current completion list. */
5725 add_symtab_completions (struct compunit_symtab
*cust
,
5726 completion_tracker
&tracker
,
5727 complete_symbol_mode mode
,
5728 const lookup_name_info
&lookup_name
,
5729 const char *text
, const char *word
,
5730 enum type_code code
)
5733 const struct block
*b
;
5734 struct block_iterator iter
;
5740 for (i
= GLOBAL_BLOCK
; i
<= STATIC_BLOCK
; i
++)
5743 b
= BLOCKVECTOR_BLOCK (COMPUNIT_BLOCKVECTOR (cust
), i
);
5744 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
5746 if (completion_skip_symbol (mode
, sym
))
5749 if (code
== TYPE_CODE_UNDEF
5750 || (SYMBOL_DOMAIN (sym
) == STRUCT_DOMAIN
5751 && SYMBOL_TYPE (sym
)->code () == code
))
5752 completion_list_add_symbol (tracker
, sym
,
5760 default_collect_symbol_completion_matches_break_on
5761 (completion_tracker
&tracker
, complete_symbol_mode mode
,
5762 symbol_name_match_type name_match_type
,
5763 const char *text
, const char *word
,
5764 const char *break_on
, enum type_code code
)
5766 /* Problem: All of the symbols have to be copied because readline
5767 frees them. I'm not going to worry about this; hopefully there
5768 won't be that many. */
5771 const struct block
*b
;
5772 const struct block
*surrounding_static_block
, *surrounding_global_block
;
5773 struct block_iterator iter
;
5774 /* The symbol we are completing on. Points in same buffer as text. */
5775 const char *sym_text
;
5777 /* Now look for the symbol we are supposed to complete on. */
5778 if (mode
== complete_symbol_mode::LINESPEC
)
5784 const char *quote_pos
= NULL
;
5786 /* First see if this is a quoted string. */
5788 for (p
= text
; *p
!= '\0'; ++p
)
5790 if (quote_found
!= '\0')
5792 if (*p
== quote_found
)
5793 /* Found close quote. */
5795 else if (*p
== '\\' && p
[1] == quote_found
)
5796 /* A backslash followed by the quote character
5797 doesn't end the string. */
5800 else if (*p
== '\'' || *p
== '"')
5806 if (quote_found
== '\'')
5807 /* A string within single quotes can be a symbol, so complete on it. */
5808 sym_text
= quote_pos
+ 1;
5809 else if (quote_found
== '"')
5810 /* A double-quoted string is never a symbol, nor does it make sense
5811 to complete it any other way. */
5817 /* It is not a quoted string. Break it based on the characters
5818 which are in symbols. */
5821 if (isalnum (p
[-1]) || p
[-1] == '_' || p
[-1] == '\0'
5822 || p
[-1] == ':' || strchr (break_on
, p
[-1]) != NULL
)
5831 lookup_name_info
lookup_name (sym_text
, name_match_type
, true);
5833 /* At this point scan through the misc symbol vectors and add each
5834 symbol you find to the list. Eventually we want to ignore
5835 anything that isn't a text symbol (everything else will be
5836 handled by the psymtab code below). */
5838 if (code
== TYPE_CODE_UNDEF
)
5840 for (objfile
*objfile
: current_program_space
->objfiles ())
5842 for (minimal_symbol
*msymbol
: objfile
->msymbols ())
5846 if (completion_skip_symbol (mode
, msymbol
))
5849 completion_list_add_msymbol (tracker
, msymbol
, lookup_name
,
5852 completion_list_objc_symbol (tracker
, msymbol
, lookup_name
,
5858 /* Add completions for all currently loaded symbol tables. */
5859 for (objfile
*objfile
: current_program_space
->objfiles ())
5861 for (compunit_symtab
*cust
: objfile
->compunits ())
5862 add_symtab_completions (cust
, tracker
, mode
, lookup_name
,
5863 sym_text
, word
, code
);
5866 /* Look through the partial symtabs for all symbols which begin by
5867 matching SYM_TEXT. Expand all CUs that you find to the list. */
5868 expand_symtabs_matching (NULL
,
5871 [&] (compunit_symtab
*symtab
) /* expansion notify */
5873 add_symtab_completions (symtab
,
5874 tracker
, mode
, lookup_name
,
5875 sym_text
, word
, code
);
5878 SEARCH_GLOBAL_BLOCK
| SEARCH_STATIC_BLOCK
,
5881 /* Search upwards from currently selected frame (so that we can
5882 complete on local vars). Also catch fields of types defined in
5883 this places which match our text string. Only complete on types
5884 visible from current context. */
5886 b
= get_selected_block (0);
5887 surrounding_static_block
= block_static_block (b
);
5888 surrounding_global_block
= block_global_block (b
);
5889 if (surrounding_static_block
!= NULL
)
5890 while (b
!= surrounding_static_block
)
5894 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
5896 if (code
== TYPE_CODE_UNDEF
)
5898 completion_list_add_symbol (tracker
, sym
, lookup_name
,
5900 completion_list_add_fields (tracker
, sym
, lookup_name
,
5903 else if (SYMBOL_DOMAIN (sym
) == STRUCT_DOMAIN
5904 && SYMBOL_TYPE (sym
)->code () == code
)
5905 completion_list_add_symbol (tracker
, sym
, lookup_name
,
5909 /* Stop when we encounter an enclosing function. Do not stop for
5910 non-inlined functions - the locals of the enclosing function
5911 are in scope for a nested function. */
5912 if (BLOCK_FUNCTION (b
) != NULL
&& block_inlined_p (b
))
5914 b
= BLOCK_SUPERBLOCK (b
);
5917 /* Add fields from the file's types; symbols will be added below. */
5919 if (code
== TYPE_CODE_UNDEF
)
5921 if (surrounding_static_block
!= NULL
)
5922 ALL_BLOCK_SYMBOLS (surrounding_static_block
, iter
, sym
)
5923 completion_list_add_fields (tracker
, sym
, lookup_name
,
5926 if (surrounding_global_block
!= NULL
)
5927 ALL_BLOCK_SYMBOLS (surrounding_global_block
, iter
, sym
)
5928 completion_list_add_fields (tracker
, sym
, lookup_name
,
5932 /* Skip macros if we are completing a struct tag -- arguable but
5933 usually what is expected. */
5934 if (current_language
->macro_expansion () == macro_expansion_c
5935 && code
== TYPE_CODE_UNDEF
)
5937 gdb::unique_xmalloc_ptr
<struct macro_scope
> scope
;
5939 /* This adds a macro's name to the current completion list. */
5940 auto add_macro_name
= [&] (const char *macro_name
,
5941 const macro_definition
*,
5942 macro_source_file
*,
5945 completion_list_add_name (tracker
, language_c
, macro_name
,
5946 lookup_name
, sym_text
, word
);
5949 /* Add any macros visible in the default scope. Note that this
5950 may yield the occasional wrong result, because an expression
5951 might be evaluated in a scope other than the default. For
5952 example, if the user types "break file:line if <TAB>", the
5953 resulting expression will be evaluated at "file:line" -- but
5954 at there does not seem to be a way to detect this at
5956 scope
= default_macro_scope ();
5958 macro_for_each_in_scope (scope
->file
, scope
->line
,
5961 /* User-defined macros are always visible. */
5962 macro_for_each (macro_user_macros
, add_macro_name
);
5966 /* Collect all symbols (regardless of class) which begin by matching
5970 collect_symbol_completion_matches (completion_tracker
&tracker
,
5971 complete_symbol_mode mode
,
5972 symbol_name_match_type name_match_type
,
5973 const char *text
, const char *word
)
5975 current_language
->collect_symbol_completion_matches (tracker
, mode
,
5981 /* Like collect_symbol_completion_matches, but only collect
5982 STRUCT_DOMAIN symbols whose type code is CODE. */
5985 collect_symbol_completion_matches_type (completion_tracker
&tracker
,
5986 const char *text
, const char *word
,
5987 enum type_code code
)
5989 complete_symbol_mode mode
= complete_symbol_mode::EXPRESSION
;
5990 symbol_name_match_type name_match_type
= symbol_name_match_type::EXPRESSION
;
5992 gdb_assert (code
== TYPE_CODE_UNION
5993 || code
== TYPE_CODE_STRUCT
5994 || code
== TYPE_CODE_ENUM
);
5995 current_language
->collect_symbol_completion_matches (tracker
, mode
,
6000 /* Like collect_symbol_completion_matches, but collects a list of
6001 symbols defined in all source files named SRCFILE. */
6004 collect_file_symbol_completion_matches (completion_tracker
&tracker
,
6005 complete_symbol_mode mode
,
6006 symbol_name_match_type name_match_type
,
6007 const char *text
, const char *word
,
6008 const char *srcfile
)
6010 /* The symbol we are completing on. Points in same buffer as text. */
6011 const char *sym_text
;
6013 /* Now look for the symbol we are supposed to complete on.
6014 FIXME: This should be language-specific. */
6015 if (mode
== complete_symbol_mode::LINESPEC
)
6021 const char *quote_pos
= NULL
;
6023 /* First see if this is a quoted string. */
6025 for (p
= text
; *p
!= '\0'; ++p
)
6027 if (quote_found
!= '\0')
6029 if (*p
== quote_found
)
6030 /* Found close quote. */
6032 else if (*p
== '\\' && p
[1] == quote_found
)
6033 /* A backslash followed by the quote character
6034 doesn't end the string. */
6037 else if (*p
== '\'' || *p
== '"')
6043 if (quote_found
== '\'')
6044 /* A string within single quotes can be a symbol, so complete on it. */
6045 sym_text
= quote_pos
+ 1;
6046 else if (quote_found
== '"')
6047 /* A double-quoted string is never a symbol, nor does it make sense
6048 to complete it any other way. */
6054 /* Not a quoted string. */
6055 sym_text
= language_search_unquoted_string (text
, p
);
6059 lookup_name_info
lookup_name (sym_text
, name_match_type
, true);
6061 /* Go through symtabs for SRCFILE and check the externs and statics
6062 for symbols which match. */
6063 iterate_over_symtabs (srcfile
, [&] (symtab
*s
)
6065 add_symtab_completions (SYMTAB_COMPUNIT (s
),
6066 tracker
, mode
, lookup_name
,
6067 sym_text
, word
, TYPE_CODE_UNDEF
);
6072 /* A helper function for make_source_files_completion_list. It adds
6073 another file name to a list of possible completions, growing the
6074 list as necessary. */
6077 add_filename_to_list (const char *fname
, const char *text
, const char *word
,
6078 completion_list
*list
)
6080 list
->emplace_back (make_completion_match_str (fname
, text
, word
));
6084 not_interesting_fname (const char *fname
)
6086 static const char *illegal_aliens
[] = {
6087 "_globals_", /* inserted by coff_symtab_read */
6092 for (i
= 0; illegal_aliens
[i
]; i
++)
6094 if (filename_cmp (fname
, illegal_aliens
[i
]) == 0)
6100 /* An object of this type is passed as the callback argument to
6101 map_partial_symbol_filenames. */
6102 struct add_partial_filename_data
6104 struct filename_seen_cache
*filename_seen_cache
;
6108 completion_list
*list
;
6110 void operator() (const char *filename
, const char *fullname
);
6113 /* A callback for map_partial_symbol_filenames. */
6116 add_partial_filename_data::operator() (const char *filename
,
6117 const char *fullname
)
6119 if (not_interesting_fname (filename
))
6121 if (!filename_seen_cache
->seen (filename
)
6122 && filename_ncmp (filename
, text
, text_len
) == 0)
6124 /* This file matches for a completion; add it to the
6125 current list of matches. */
6126 add_filename_to_list (filename
, text
, word
, list
);
6130 const char *base_name
= lbasename (filename
);
6132 if (base_name
!= filename
6133 && !filename_seen_cache
->seen (base_name
)
6134 && filename_ncmp (base_name
, text
, text_len
) == 0)
6135 add_filename_to_list (base_name
, text
, word
, list
);
6139 /* Return a list of all source files whose names begin with matching
6140 TEXT. The file names are looked up in the symbol tables of this
6144 make_source_files_completion_list (const char *text
, const char *word
)
6146 size_t text_len
= strlen (text
);
6147 completion_list list
;
6148 const char *base_name
;
6149 struct add_partial_filename_data datum
;
6151 if (!have_full_symbols () && !have_partial_symbols ())
6154 filename_seen_cache filenames_seen
;
6156 for (objfile
*objfile
: current_program_space
->objfiles ())
6158 for (compunit_symtab
*cu
: objfile
->compunits ())
6160 for (symtab
*s
: compunit_filetabs (cu
))
6162 if (not_interesting_fname (s
->filename
))
6164 if (!filenames_seen
.seen (s
->filename
)
6165 && filename_ncmp (s
->filename
, text
, text_len
) == 0)
6167 /* This file matches for a completion; add it to the current
6169 add_filename_to_list (s
->filename
, text
, word
, &list
);
6173 /* NOTE: We allow the user to type a base name when the
6174 debug info records leading directories, but not the other
6175 way around. This is what subroutines of breakpoint
6176 command do when they parse file names. */
6177 base_name
= lbasename (s
->filename
);
6178 if (base_name
!= s
->filename
6179 && !filenames_seen
.seen (base_name
)
6180 && filename_ncmp (base_name
, text
, text_len
) == 0)
6181 add_filename_to_list (base_name
, text
, word
, &list
);
6187 datum
.filename_seen_cache
= &filenames_seen
;
6190 datum
.text_len
= text_len
;
6192 map_symbol_filenames (datum
, false /*need_fullname*/);
6199 /* Return the "main_info" object for the current program space. If
6200 the object has not yet been created, create it and fill in some
6203 static struct main_info
*
6204 get_main_info (void)
6206 struct main_info
*info
= main_progspace_key
.get (current_program_space
);
6210 /* It may seem strange to store the main name in the progspace
6211 and also in whatever objfile happens to see a main name in
6212 its debug info. The reason for this is mainly historical:
6213 gdb returned "main" as the name even if no function named
6214 "main" was defined the program; and this approach lets us
6215 keep compatibility. */
6216 info
= main_progspace_key
.emplace (current_program_space
);
6223 set_main_name (const char *name
, enum language lang
)
6225 struct main_info
*info
= get_main_info ();
6227 if (info
->name_of_main
!= NULL
)
6229 xfree (info
->name_of_main
);
6230 info
->name_of_main
= NULL
;
6231 info
->language_of_main
= language_unknown
;
6235 info
->name_of_main
= xstrdup (name
);
6236 info
->language_of_main
= lang
;
6240 /* Deduce the name of the main procedure, and set NAME_OF_MAIN
6244 find_main_name (void)
6246 const char *new_main_name
;
6248 /* First check the objfiles to see whether a debuginfo reader has
6249 picked up the appropriate main name. Historically the main name
6250 was found in a more or less random way; this approach instead
6251 relies on the order of objfile creation -- which still isn't
6252 guaranteed to get the correct answer, but is just probably more
6254 for (objfile
*objfile
: current_program_space
->objfiles ())
6256 if (objfile
->per_bfd
->name_of_main
!= NULL
)
6258 set_main_name (objfile
->per_bfd
->name_of_main
,
6259 objfile
->per_bfd
->language_of_main
);
6264 /* Try to see if the main procedure is in Ada. */
6265 /* FIXME: brobecker/2005-03-07: Another way of doing this would
6266 be to add a new method in the language vector, and call this
6267 method for each language until one of them returns a non-empty
6268 name. This would allow us to remove this hard-coded call to
6269 an Ada function. It is not clear that this is a better approach
6270 at this point, because all methods need to be written in a way
6271 such that false positives never be returned. For instance, it is
6272 important that a method does not return a wrong name for the main
6273 procedure if the main procedure is actually written in a different
6274 language. It is easy to guaranty this with Ada, since we use a
6275 special symbol generated only when the main in Ada to find the name
6276 of the main procedure. It is difficult however to see how this can
6277 be guarantied for languages such as C, for instance. This suggests
6278 that order of call for these methods becomes important, which means
6279 a more complicated approach. */
6280 new_main_name
= ada_main_name ();
6281 if (new_main_name
!= NULL
)
6283 set_main_name (new_main_name
, language_ada
);
6287 new_main_name
= d_main_name ();
6288 if (new_main_name
!= NULL
)
6290 set_main_name (new_main_name
, language_d
);
6294 new_main_name
= go_main_name ();
6295 if (new_main_name
!= NULL
)
6297 set_main_name (new_main_name
, language_go
);
6301 new_main_name
= pascal_main_name ();
6302 if (new_main_name
!= NULL
)
6304 set_main_name (new_main_name
, language_pascal
);
6308 /* The languages above didn't identify the name of the main procedure.
6309 Fallback to "main". */
6311 /* Try to find language for main in psymtabs. */
6313 = find_quick_global_symbol_language ("main", VAR_DOMAIN
);
6314 if (lang
!= language_unknown
)
6316 set_main_name ("main", lang
);
6320 set_main_name ("main", language_unknown
);
6328 struct main_info
*info
= get_main_info ();
6330 if (info
->name_of_main
== NULL
)
6333 return info
->name_of_main
;
6336 /* Return the language of the main function. If it is not known,
6337 return language_unknown. */
6340 main_language (void)
6342 struct main_info
*info
= get_main_info ();
6344 if (info
->name_of_main
== NULL
)
6347 return info
->language_of_main
;
6350 /* Handle ``executable_changed'' events for the symtab module. */
6353 symtab_observer_executable_changed (void)
6355 /* NAME_OF_MAIN may no longer be the same, so reset it for now. */
6356 set_main_name (NULL
, language_unknown
);
6359 /* Return 1 if the supplied producer string matches the ARM RealView
6360 compiler (armcc). */
6363 producer_is_realview (const char *producer
)
6365 static const char *const arm_idents
[] = {
6366 "ARM C Compiler, ADS",
6367 "Thumb C Compiler, ADS",
6368 "ARM C++ Compiler, ADS",
6369 "Thumb C++ Compiler, ADS",
6370 "ARM/Thumb C/C++ Compiler, RVCT",
6371 "ARM C/C++ Compiler, RVCT"
6375 if (producer
== NULL
)
6378 for (i
= 0; i
< ARRAY_SIZE (arm_idents
); i
++)
6379 if (startswith (producer
, arm_idents
[i
]))
6387 /* The next index to hand out in response to a registration request. */
6389 static int next_aclass_value
= LOC_FINAL_VALUE
;
6391 /* The maximum number of "aclass" registrations we support. This is
6392 constant for convenience. */
6393 #define MAX_SYMBOL_IMPLS (LOC_FINAL_VALUE + 10)
6395 /* The objects representing the various "aclass" values. The elements
6396 from 0 up to LOC_FINAL_VALUE-1 represent themselves, and subsequent
6397 elements are those registered at gdb initialization time. */
6399 static struct symbol_impl symbol_impl
[MAX_SYMBOL_IMPLS
];
6401 /* The globally visible pointer. This is separate from 'symbol_impl'
6402 so that it can be const. */
6404 const struct symbol_impl
*symbol_impls
= &symbol_impl
[0];
6406 /* Make sure we saved enough room in struct symbol. */
6408 gdb_static_assert (MAX_SYMBOL_IMPLS
<= (1 << SYMBOL_ACLASS_BITS
));
6410 /* Register a computed symbol type. ACLASS must be LOC_COMPUTED. OPS
6411 is the ops vector associated with this index. This returns the new
6412 index, which should be used as the aclass_index field for symbols
6416 register_symbol_computed_impl (enum address_class aclass
,
6417 const struct symbol_computed_ops
*ops
)
6419 int result
= next_aclass_value
++;
6421 gdb_assert (aclass
== LOC_COMPUTED
);
6422 gdb_assert (result
< MAX_SYMBOL_IMPLS
);
6423 symbol_impl
[result
].aclass
= aclass
;
6424 symbol_impl
[result
].ops_computed
= ops
;
6426 /* Sanity check OPS. */
6427 gdb_assert (ops
!= NULL
);
6428 gdb_assert (ops
->tracepoint_var_ref
!= NULL
);
6429 gdb_assert (ops
->describe_location
!= NULL
);
6430 gdb_assert (ops
->get_symbol_read_needs
!= NULL
);
6431 gdb_assert (ops
->read_variable
!= NULL
);
6436 /* Register a function with frame base type. ACLASS must be LOC_BLOCK.
6437 OPS is the ops vector associated with this index. This returns the
6438 new index, which should be used as the aclass_index field for symbols
6442 register_symbol_block_impl (enum address_class aclass
,
6443 const struct symbol_block_ops
*ops
)
6445 int result
= next_aclass_value
++;
6447 gdb_assert (aclass
== LOC_BLOCK
);
6448 gdb_assert (result
< MAX_SYMBOL_IMPLS
);
6449 symbol_impl
[result
].aclass
= aclass
;
6450 symbol_impl
[result
].ops_block
= ops
;
6452 /* Sanity check OPS. */
6453 gdb_assert (ops
!= NULL
);
6454 gdb_assert (ops
->find_frame_base_location
!= NULL
);
6459 /* Register a register symbol type. ACLASS must be LOC_REGISTER or
6460 LOC_REGPARM_ADDR. OPS is the register ops vector associated with
6461 this index. This returns the new index, which should be used as
6462 the aclass_index field for symbols of this type. */
6465 register_symbol_register_impl (enum address_class aclass
,
6466 const struct symbol_register_ops
*ops
)
6468 int result
= next_aclass_value
++;
6470 gdb_assert (aclass
== LOC_REGISTER
|| aclass
== LOC_REGPARM_ADDR
);
6471 gdb_assert (result
< MAX_SYMBOL_IMPLS
);
6472 symbol_impl
[result
].aclass
= aclass
;
6473 symbol_impl
[result
].ops_register
= ops
;
6478 /* Initialize elements of 'symbol_impl' for the constants in enum
6482 initialize_ordinary_address_classes (void)
6486 for (i
= 0; i
< LOC_FINAL_VALUE
; ++i
)
6487 symbol_impl
[i
].aclass
= (enum address_class
) i
;
6495 symbol_objfile (const struct symbol
*symbol
)
6497 gdb_assert (SYMBOL_OBJFILE_OWNED (symbol
));
6498 return SYMTAB_OBJFILE (symbol
->owner
.symtab
);
6504 symbol_arch (const struct symbol
*symbol
)
6506 if (!SYMBOL_OBJFILE_OWNED (symbol
))
6507 return symbol
->owner
.arch
;
6508 return SYMTAB_OBJFILE (symbol
->owner
.symtab
)->arch ();
6514 symbol_symtab (const struct symbol
*symbol
)
6516 gdb_assert (SYMBOL_OBJFILE_OWNED (symbol
));
6517 return symbol
->owner
.symtab
;
6523 symbol_set_symtab (struct symbol
*symbol
, struct symtab
*symtab
)
6525 gdb_assert (SYMBOL_OBJFILE_OWNED (symbol
));
6526 symbol
->owner
.symtab
= symtab
;
6532 get_symbol_address (const struct symbol
*sym
)
6534 gdb_assert (sym
->maybe_copied
);
6535 gdb_assert (SYMBOL_CLASS (sym
) == LOC_STATIC
);
6537 const char *linkage_name
= sym
->linkage_name ();
6539 for (objfile
*objfile
: current_program_space
->objfiles ())
6541 if (objfile
->separate_debug_objfile_backlink
!= nullptr)
6544 bound_minimal_symbol minsym
6545 = lookup_minimal_symbol_linkage (linkage_name
, objfile
);
6546 if (minsym
.minsym
!= nullptr)
6547 return BMSYMBOL_VALUE_ADDRESS (minsym
);
6549 return sym
->value
.address
;
6555 get_msymbol_address (struct objfile
*objf
, const struct minimal_symbol
*minsym
)
6557 gdb_assert (minsym
->maybe_copied
);
6558 gdb_assert ((objf
->flags
& OBJF_MAINLINE
) == 0);
6560 const char *linkage_name
= minsym
->linkage_name ();
6562 for (objfile
*objfile
: current_program_space
->objfiles ())
6564 if (objfile
->separate_debug_objfile_backlink
== nullptr
6565 && (objfile
->flags
& OBJF_MAINLINE
) != 0)
6567 bound_minimal_symbol found
6568 = lookup_minimal_symbol_linkage (linkage_name
, objfile
);
6569 if (found
.minsym
!= nullptr)
6570 return BMSYMBOL_VALUE_ADDRESS (found
);
6573 return (minsym
->value
.address
6574 + objf
->section_offsets
[minsym
->section_index ()]);
6579 /* Hold the sub-commands of 'info module'. */
6581 static struct cmd_list_element
*info_module_cmdlist
= NULL
;
6585 std::vector
<module_symbol_search
>
6586 search_module_symbols (const char *module_regexp
, const char *regexp
,
6587 const char *type_regexp
, search_domain kind
)
6589 std::vector
<module_symbol_search
> results
;
6591 /* Search for all modules matching MODULE_REGEXP. */
6592 global_symbol_searcher
spec1 (MODULES_DOMAIN
, module_regexp
);
6593 spec1
.set_exclude_minsyms (true);
6594 std::vector
<symbol_search
> modules
= spec1
.search ();
6596 /* Now search for all symbols of the required KIND matching the required
6597 regular expressions. We figure out which ones are in which modules
6599 global_symbol_searcher
spec2 (kind
, regexp
);
6600 spec2
.set_symbol_type_regexp (type_regexp
);
6601 spec2
.set_exclude_minsyms (true);
6602 std::vector
<symbol_search
> symbols
= spec2
.search ();
6604 /* Now iterate over all MODULES, checking to see which items from
6605 SYMBOLS are in each module. */
6606 for (const symbol_search
&p
: modules
)
6610 /* This is a module. */
6611 gdb_assert (p
.symbol
!= nullptr);
6613 std::string prefix
= p
.symbol
->print_name ();
6616 for (const symbol_search
&q
: symbols
)
6618 if (q
.symbol
== nullptr)
6621 if (strncmp (q
.symbol
->print_name (), prefix
.c_str (),
6622 prefix
.size ()) != 0)
6625 results
.push_back ({p
, q
});
6632 /* Implement the core of both 'info module functions' and 'info module
6636 info_module_subcommand (bool quiet
, const char *module_regexp
,
6637 const char *regexp
, const char *type_regexp
,
6640 /* Print a header line. Don't build the header line bit by bit as this
6641 prevents internationalisation. */
6644 if (module_regexp
== nullptr)
6646 if (type_regexp
== nullptr)
6648 if (regexp
== nullptr)
6649 printf_filtered ((kind
== VARIABLES_DOMAIN
6650 ? _("All variables in all modules:")
6651 : _("All functions in all modules:")));
6654 ((kind
== VARIABLES_DOMAIN
6655 ? _("All variables matching regular expression"
6656 " \"%s\" in all modules:")
6657 : _("All functions matching regular expression"
6658 " \"%s\" in all modules:")),
6663 if (regexp
== nullptr)
6665 ((kind
== VARIABLES_DOMAIN
6666 ? _("All variables with type matching regular "
6667 "expression \"%s\" in all modules:")
6668 : _("All functions with type matching regular "
6669 "expression \"%s\" in all modules:")),
6673 ((kind
== VARIABLES_DOMAIN
6674 ? _("All variables matching regular expression "
6675 "\"%s\",\n\twith type matching regular "
6676 "expression \"%s\" in all modules:")
6677 : _("All functions matching regular expression "
6678 "\"%s\",\n\twith type matching regular "
6679 "expression \"%s\" in all modules:")),
6680 regexp
, type_regexp
);
6685 if (type_regexp
== nullptr)
6687 if (regexp
== nullptr)
6689 ((kind
== VARIABLES_DOMAIN
6690 ? _("All variables in all modules matching regular "
6691 "expression \"%s\":")
6692 : _("All functions in all modules matching regular "
6693 "expression \"%s\":")),
6697 ((kind
== VARIABLES_DOMAIN
6698 ? _("All variables matching regular expression "
6699 "\"%s\",\n\tin all modules matching regular "
6700 "expression \"%s\":")
6701 : _("All functions matching regular expression "
6702 "\"%s\",\n\tin all modules matching regular "
6703 "expression \"%s\":")),
6704 regexp
, module_regexp
);
6708 if (regexp
== nullptr)
6710 ((kind
== VARIABLES_DOMAIN
6711 ? _("All variables with type matching regular "
6712 "expression \"%s\"\n\tin all modules matching "
6713 "regular expression \"%s\":")
6714 : _("All functions with type matching regular "
6715 "expression \"%s\"\n\tin all modules matching "
6716 "regular expression \"%s\":")),
6717 type_regexp
, module_regexp
);
6720 ((kind
== VARIABLES_DOMAIN
6721 ? _("All variables matching regular expression "
6722 "\"%s\",\n\twith type matching regular expression "
6723 "\"%s\",\n\tin all modules matching regular "
6724 "expression \"%s\":")
6725 : _("All functions matching regular expression "
6726 "\"%s\",\n\twith type matching regular expression "
6727 "\"%s\",\n\tin all modules matching regular "
6728 "expression \"%s\":")),
6729 regexp
, type_regexp
, module_regexp
);
6732 printf_filtered ("\n");
6735 /* Find all symbols of type KIND matching the given regular expressions
6736 along with the symbols for the modules in which those symbols
6738 std::vector
<module_symbol_search
> module_symbols
6739 = search_module_symbols (module_regexp
, regexp
, type_regexp
, kind
);
6741 std::sort (module_symbols
.begin (), module_symbols
.end (),
6742 [] (const module_symbol_search
&a
, const module_symbol_search
&b
)
6744 if (a
.first
< b
.first
)
6746 else if (a
.first
== b
.first
)
6747 return a
.second
< b
.second
;
6752 const char *last_filename
= "";
6753 const symbol
*last_module_symbol
= nullptr;
6754 for (const module_symbol_search
&ms
: module_symbols
)
6756 const symbol_search
&p
= ms
.first
;
6757 const symbol_search
&q
= ms
.second
;
6759 gdb_assert (q
.symbol
!= nullptr);
6761 if (last_module_symbol
!= p
.symbol
)
6763 printf_filtered ("\n");
6764 printf_filtered (_("Module \"%s\":\n"), p
.symbol
->print_name ());
6765 last_module_symbol
= p
.symbol
;
6769 print_symbol_info (FUNCTIONS_DOMAIN
, q
.symbol
, q
.block
,
6772 = symtab_to_filename_for_display (symbol_symtab (q
.symbol
));
6776 /* Hold the option values for the 'info module .....' sub-commands. */
6778 struct info_modules_var_func_options
6781 std::string type_regexp
;
6782 std::string module_regexp
;
6785 /* The options used by 'info module variables' and 'info module functions'
6788 static const gdb::option::option_def info_modules_var_func_options_defs
[] = {
6789 gdb::option::boolean_option_def
<info_modules_var_func_options
> {
6791 [] (info_modules_var_func_options
*opt
) { return &opt
->quiet
; },
6792 nullptr, /* show_cmd_cb */
6793 nullptr /* set_doc */
6796 gdb::option::string_option_def
<info_modules_var_func_options
> {
6798 [] (info_modules_var_func_options
*opt
) { return &opt
->type_regexp
; },
6799 nullptr, /* show_cmd_cb */
6800 nullptr /* set_doc */
6803 gdb::option::string_option_def
<info_modules_var_func_options
> {
6805 [] (info_modules_var_func_options
*opt
) { return &opt
->module_regexp
; },
6806 nullptr, /* show_cmd_cb */
6807 nullptr /* set_doc */
6811 /* Return the option group used by the 'info module ...' sub-commands. */
6813 static inline gdb::option::option_def_group
6814 make_info_modules_var_func_options_def_group
6815 (info_modules_var_func_options
*opts
)
6817 return {{info_modules_var_func_options_defs
}, opts
};
6820 /* Implements the 'info module functions' command. */
6823 info_module_functions_command (const char *args
, int from_tty
)
6825 info_modules_var_func_options opts
;
6826 auto grp
= make_info_modules_var_func_options_def_group (&opts
);
6827 gdb::option::process_options
6828 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
6829 if (args
!= nullptr && *args
== '\0')
6832 info_module_subcommand
6834 opts
.module_regexp
.empty () ? nullptr : opts
.module_regexp
.c_str (), args
,
6835 opts
.type_regexp
.empty () ? nullptr : opts
.type_regexp
.c_str (),
6839 /* Implements the 'info module variables' command. */
6842 info_module_variables_command (const char *args
, int from_tty
)
6844 info_modules_var_func_options opts
;
6845 auto grp
= make_info_modules_var_func_options_def_group (&opts
);
6846 gdb::option::process_options
6847 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
6848 if (args
!= nullptr && *args
== '\0')
6851 info_module_subcommand
6853 opts
.module_regexp
.empty () ? nullptr : opts
.module_regexp
.c_str (), args
,
6854 opts
.type_regexp
.empty () ? nullptr : opts
.type_regexp
.c_str (),
6858 /* Command completer for 'info module ...' sub-commands. */
6861 info_module_var_func_command_completer (struct cmd_list_element
*ignore
,
6862 completion_tracker
&tracker
,
6864 const char * /* word */)
6867 const auto group
= make_info_modules_var_func_options_def_group (nullptr);
6868 if (gdb::option::complete_options
6869 (tracker
, &text
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, group
))
6872 const char *word
= advance_to_expression_complete_word_point (tracker
, text
);
6873 symbol_completer (ignore
, tracker
, text
, word
);
6878 void _initialize_symtab ();
6880 _initialize_symtab ()
6882 cmd_list_element
*c
;
6884 initialize_ordinary_address_classes ();
6886 c
= add_info ("variables", info_variables_command
,
6887 info_print_args_help (_("\
6888 All global and static variable names or those matching REGEXPs.\n\
6889 Usage: info variables [-q] [-n] [-t TYPEREGEXP] [NAMEREGEXP]\n\
6890 Prints the global and static variables.\n"),
6891 _("global and static variables"),
6893 set_cmd_completer_handle_brkchars (c
, info_vars_funcs_command_completer
);
6896 c
= add_com ("whereis", class_info
, info_variables_command
,
6897 info_print_args_help (_("\
6898 All global and static variable names, or those matching REGEXPs.\n\
6899 Usage: whereis [-q] [-n] [-t TYPEREGEXP] [NAMEREGEXP]\n\
6900 Prints the global and static variables.\n"),
6901 _("global and static variables"),
6903 set_cmd_completer_handle_brkchars (c
, info_vars_funcs_command_completer
);
6906 c
= add_info ("functions", info_functions_command
,
6907 info_print_args_help (_("\
6908 All function names or those matching REGEXPs.\n\
6909 Usage: info functions [-q] [-n] [-t TYPEREGEXP] [NAMEREGEXP]\n\
6910 Prints the functions.\n"),
6913 set_cmd_completer_handle_brkchars (c
, info_vars_funcs_command_completer
);
6915 c
= add_info ("types", info_types_command
, _("\
6916 All type names, or those matching REGEXP.\n\
6917 Usage: info types [-q] [REGEXP]\n\
6918 Print information about all types matching REGEXP, or all types if no\n\
6919 REGEXP is given. The optional flag -q disables printing of headers."));
6920 set_cmd_completer_handle_brkchars (c
, info_types_command_completer
);
6922 const auto info_sources_opts
6923 = make_info_sources_options_def_group (nullptr);
6925 static std::string info_sources_help
6926 = gdb::option::build_help (_("\
6927 All source files in the program or those matching REGEXP.\n\
6928 Usage: info sources [OPTION]... [REGEXP]\n\
6929 By default, REGEXP is used to match anywhere in the filename.\n\
6935 c
= add_info ("sources", info_sources_command
, info_sources_help
.c_str ());
6936 set_cmd_completer_handle_brkchars (c
, info_sources_command_completer
);
6938 c
= add_info ("modules", info_modules_command
,
6939 _("All module names, or those matching REGEXP."));
6940 set_cmd_completer_handle_brkchars (c
, info_types_command_completer
);
6942 add_basic_prefix_cmd ("module", class_info
, _("\
6943 Print information about modules."),
6944 &info_module_cmdlist
, 0, &infolist
);
6946 c
= add_cmd ("functions", class_info
, info_module_functions_command
, _("\
6947 Display functions arranged by modules.\n\
6948 Usage: info module functions [-q] [-m MODREGEXP] [-t TYPEREGEXP] [REGEXP]\n\
6949 Print a summary of all functions within each Fortran module, grouped by\n\
6950 module and file. For each function the line on which the function is\n\
6951 defined is given along with the type signature and name of the function.\n\
6953 If REGEXP is provided then only functions whose name matches REGEXP are\n\
6954 listed. If MODREGEXP is provided then only functions in modules matching\n\
6955 MODREGEXP are listed. If TYPEREGEXP is given then only functions whose\n\
6956 type signature matches TYPEREGEXP are listed.\n\
6958 The -q flag suppresses printing some header information."),
6959 &info_module_cmdlist
);
6960 set_cmd_completer_handle_brkchars
6961 (c
, info_module_var_func_command_completer
);
6963 c
= add_cmd ("variables", class_info
, info_module_variables_command
, _("\
6964 Display variables arranged by modules.\n\
6965 Usage: info module variables [-q] [-m MODREGEXP] [-t TYPEREGEXP] [REGEXP]\n\
6966 Print a summary of all variables within each Fortran module, grouped by\n\
6967 module and file. For each variable the line on which the variable is\n\
6968 defined is given along with the type and name of the variable.\n\
6970 If REGEXP is provided then only variables whose name matches REGEXP are\n\
6971 listed. If MODREGEXP is provided then only variables in modules matching\n\
6972 MODREGEXP are listed. If TYPEREGEXP is given then only variables whose\n\
6973 type matches TYPEREGEXP are listed.\n\
6975 The -q flag suppresses printing some header information."),
6976 &info_module_cmdlist
);
6977 set_cmd_completer_handle_brkchars
6978 (c
, info_module_var_func_command_completer
);
6980 add_com ("rbreak", class_breakpoint
, rbreak_command
,
6981 _("Set a breakpoint for all functions matching REGEXP."));
6983 add_setshow_enum_cmd ("multiple-symbols", no_class
,
6984 multiple_symbols_modes
, &multiple_symbols_mode
,
6986 Set how the debugger handles ambiguities in expressions."), _("\
6987 Show how the debugger handles ambiguities in expressions."), _("\
6988 Valid values are \"ask\", \"all\", \"cancel\", and the default is \"all\"."),
6989 NULL
, NULL
, &setlist
, &showlist
);
6991 add_setshow_boolean_cmd ("basenames-may-differ", class_obscure
,
6992 &basenames_may_differ
, _("\
6993 Set whether a source file may have multiple base names."), _("\
6994 Show whether a source file may have multiple base names."), _("\
6995 (A \"base name\" is the name of a file with the directory part removed.\n\
6996 Example: The base name of \"/home/user/hello.c\" is \"hello.c\".)\n\
6997 If set, GDB will canonicalize file names (e.g., expand symlinks)\n\
6998 before comparing them. Canonicalization is an expensive operation,\n\
6999 but it allows the same file be known by more than one base name.\n\
7000 If not set (the default), all source files are assumed to have just\n\
7001 one base name, and gdb will do file name comparisons more efficiently."),
7003 &setlist
, &showlist
);
7005 add_setshow_zuinteger_cmd ("symtab-create", no_class
, &symtab_create_debug
,
7006 _("Set debugging of symbol table creation."),
7007 _("Show debugging of symbol table creation."), _("\
7008 When enabled (non-zero), debugging messages are printed when building\n\
7009 symbol tables. A value of 1 (one) normally provides enough information.\n\
7010 A value greater than 1 provides more verbose information."),
7013 &setdebuglist
, &showdebuglist
);
7015 add_setshow_zuinteger_cmd ("symbol-lookup", no_class
, &symbol_lookup_debug
,
7017 Set debugging of symbol lookup."), _("\
7018 Show debugging of symbol lookup."), _("\
7019 When enabled (non-zero), symbol lookups are logged."),
7021 &setdebuglist
, &showdebuglist
);
7023 add_setshow_zuinteger_cmd ("symbol-cache-size", no_class
,
7024 &new_symbol_cache_size
,
7025 _("Set the size of the symbol cache."),
7026 _("Show the size of the symbol cache."), _("\
7027 The size of the symbol cache.\n\
7028 If zero then the symbol cache is disabled."),
7029 set_symbol_cache_size_handler
, NULL
,
7030 &maintenance_set_cmdlist
,
7031 &maintenance_show_cmdlist
);
7033 add_cmd ("symbol-cache", class_maintenance
, maintenance_print_symbol_cache
,
7034 _("Dump the symbol cache for each program space."),
7035 &maintenanceprintlist
);
7037 add_cmd ("symbol-cache-statistics", class_maintenance
,
7038 maintenance_print_symbol_cache_statistics
,
7039 _("Print symbol cache statistics for each program space."),
7040 &maintenanceprintlist
);
7042 cmd_list_element
*maintenance_flush_symbol_cache_cmd
7043 = add_cmd ("symbol-cache", class_maintenance
,
7044 maintenance_flush_symbol_cache
,
7045 _("Flush the symbol cache for each program space."),
7046 &maintenanceflushlist
);
7047 c
= add_alias_cmd ("flush-symbol-cache", maintenance_flush_symbol_cache_cmd
,
7048 class_maintenance
, 0, &maintenancelist
);
7049 deprecate_cmd (c
, "maintenancelist flush symbol-cache");
7051 gdb::observers::executable_changed
.attach (symtab_observer_executable_changed
,
7053 gdb::observers::new_objfile
.attach (symtab_new_objfile_observer
, "symtab");
7054 gdb::observers::free_objfile
.attach (symtab_free_objfile_observer
, "symtab");