1 /* Symbol table lookup for the GNU debugger, GDB.
3 Copyright (C) 1986-2022 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 "gdbsupport/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 "gdbsupport/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 symtab::pspace () const
337 return this->objfile ()->pspace
;
343 compunit_symtab::find_call_site (CORE_ADDR pc
) const
345 if (m_call_site_htab
== nullptr)
349 = this->objfile ()->section_offsets
[this->block_line_section ()];
350 CORE_ADDR unrelocated_pc
= pc
- delta
;
352 struct call_site
call_site_local (unrelocated_pc
, nullptr, nullptr);
354 = htab_find_slot (m_call_site_htab
, &call_site_local
, NO_INSERT
);
358 return (call_site
*) *slot
;
364 compunit_symtab::set_call_site_htab (htab_t call_site_htab
)
366 gdb_assert (m_call_site_htab
== nullptr);
367 m_call_site_htab
= call_site_htab
;
373 compunit_symtab::set_primary_filetab (symtab
*primary_filetab
)
375 symtab
*prev_filetab
= nullptr;
377 /* Move PRIMARY_FILETAB to the head of the filetab list. */
378 for (symtab
*filetab
: this->filetabs ())
380 if (filetab
== primary_filetab
)
382 if (prev_filetab
!= nullptr)
384 prev_filetab
->next
= primary_filetab
->next
;
385 primary_filetab
->next
= m_filetabs
;
386 m_filetabs
= primary_filetab
;
392 prev_filetab
= filetab
;
395 gdb_assert (primary_filetab
== m_filetabs
);
401 compunit_symtab::primary_filetab () const
403 gdb_assert (m_filetabs
!= nullptr);
405 /* The primary file symtab is the first one in the list. */
412 compunit_language (const struct compunit_symtab
*cust
)
414 struct symtab
*symtab
= cust
->primary_filetab ();
416 /* The language of the compunit symtab is the language of its primary
418 return symtab
->language ();
424 minimal_symbol::data_p () const
426 return type
== mst_data
429 || type
== mst_file_data
430 || type
== mst_file_bss
;
436 minimal_symbol::text_p () const
438 return type
== mst_text
439 || type
== mst_text_gnu_ifunc
440 || type
== mst_data_gnu_ifunc
441 || type
== mst_slot_got_plt
442 || type
== mst_solib_trampoline
443 || type
== mst_file_text
;
446 /* See whether FILENAME matches SEARCH_NAME using the rule that we
447 advertise to the user. (The manual's description of linespecs
448 describes what we advertise). Returns true if they match, false
452 compare_filenames_for_search (const char *filename
, const char *search_name
)
454 int len
= strlen (filename
);
455 size_t search_len
= strlen (search_name
);
457 if (len
< search_len
)
460 /* The tail of FILENAME must match. */
461 if (FILENAME_CMP (filename
+ len
- search_len
, search_name
) != 0)
464 /* Either the names must completely match, or the character
465 preceding the trailing SEARCH_NAME segment of FILENAME must be a
468 The check !IS_ABSOLUTE_PATH ensures SEARCH_NAME "/dir/file.c"
469 cannot match FILENAME "/path//dir/file.c" - as user has requested
470 absolute path. The sama applies for "c:\file.c" possibly
471 incorrectly hypothetically matching "d:\dir\c:\file.c".
473 The HAS_DRIVE_SPEC purpose is to make FILENAME "c:file.c"
474 compatible with SEARCH_NAME "file.c". In such case a compiler had
475 to put the "c:file.c" name into debug info. Such compatibility
476 works only on GDB built for DOS host. */
477 return (len
== search_len
478 || (!IS_ABSOLUTE_PATH (search_name
)
479 && IS_DIR_SEPARATOR (filename
[len
- search_len
- 1]))
480 || (HAS_DRIVE_SPEC (filename
)
481 && STRIP_DRIVE_SPEC (filename
) == &filename
[len
- search_len
]));
484 /* Same as compare_filenames_for_search, but for glob-style patterns.
485 Heads up on the order of the arguments. They match the order of
486 compare_filenames_for_search, but it's the opposite of the order of
487 arguments to gdb_filename_fnmatch. */
490 compare_glob_filenames_for_search (const char *filename
,
491 const char *search_name
)
493 /* We rely on the property of glob-style patterns with FNM_FILE_NAME that
494 all /s have to be explicitly specified. */
495 int file_path_elements
= count_path_elements (filename
);
496 int search_path_elements
= count_path_elements (search_name
);
498 if (search_path_elements
> file_path_elements
)
501 if (IS_ABSOLUTE_PATH (search_name
))
503 return (search_path_elements
== file_path_elements
504 && gdb_filename_fnmatch (search_name
, filename
,
505 FNM_FILE_NAME
| FNM_NOESCAPE
) == 0);
509 const char *file_to_compare
510 = strip_leading_path_elements (filename
,
511 file_path_elements
- search_path_elements
);
513 return gdb_filename_fnmatch (search_name
, file_to_compare
,
514 FNM_FILE_NAME
| FNM_NOESCAPE
) == 0;
518 /* Check for a symtab of a specific name by searching some symtabs.
519 This is a helper function for callbacks of iterate_over_symtabs.
521 If NAME is not absolute, then REAL_PATH is NULL
522 If NAME is absolute, then REAL_PATH is the gdb_realpath form of NAME.
524 The return value, NAME, REAL_PATH and CALLBACK are identical to the
525 `map_symtabs_matching_filename' method of quick_symbol_functions.
527 FIRST and AFTER_LAST indicate the range of compunit symtabs to search.
528 Each symtab within the specified compunit symtab is also searched.
529 AFTER_LAST is one past the last compunit symtab to search; NULL means to
530 search until the end of the list. */
533 iterate_over_some_symtabs (const char *name
,
534 const char *real_path
,
535 struct compunit_symtab
*first
,
536 struct compunit_symtab
*after_last
,
537 gdb::function_view
<bool (symtab
*)> callback
)
539 struct compunit_symtab
*cust
;
540 const char* base_name
= lbasename (name
);
542 for (cust
= first
; cust
!= NULL
&& cust
!= after_last
; cust
= cust
->next
)
544 for (symtab
*s
: cust
->filetabs ())
546 if (compare_filenames_for_search (s
->filename
, name
))
553 /* Before we invoke realpath, which can get expensive when many
554 files are involved, do a quick comparison of the basenames. */
555 if (! basenames_may_differ
556 && FILENAME_CMP (base_name
, lbasename (s
->filename
)) != 0)
559 if (compare_filenames_for_search (symtab_to_fullname (s
), name
))
566 /* If the user gave us an absolute path, try to find the file in
567 this symtab and use its absolute path. */
568 if (real_path
!= NULL
)
570 const char *fullname
= symtab_to_fullname (s
);
572 gdb_assert (IS_ABSOLUTE_PATH (real_path
));
573 gdb_assert (IS_ABSOLUTE_PATH (name
));
574 gdb::unique_xmalloc_ptr
<char> fullname_real_path
575 = gdb_realpath (fullname
);
576 fullname
= fullname_real_path
.get ();
577 if (FILENAME_CMP (real_path
, fullname
) == 0)
590 /* Check for a symtab of a specific name; first in symtabs, then in
591 psymtabs. *If* there is no '/' in the name, a match after a '/'
592 in the symtab filename will also work.
594 Calls CALLBACK with each symtab that is found. If CALLBACK returns
595 true, the search stops. */
598 iterate_over_symtabs (const char *name
,
599 gdb::function_view
<bool (symtab
*)> callback
)
601 gdb::unique_xmalloc_ptr
<char> real_path
;
603 /* Here we are interested in canonicalizing an absolute path, not
604 absolutizing a relative path. */
605 if (IS_ABSOLUTE_PATH (name
))
607 real_path
= gdb_realpath (name
);
608 gdb_assert (IS_ABSOLUTE_PATH (real_path
.get ()));
611 for (objfile
*objfile
: current_program_space
->objfiles ())
613 if (iterate_over_some_symtabs (name
, real_path
.get (),
614 objfile
->compunit_symtabs
, NULL
,
619 /* Same search rules as above apply here, but now we look thru the
622 for (objfile
*objfile
: current_program_space
->objfiles ())
624 if (objfile
->map_symtabs_matching_filename (name
, real_path
.get (),
630 /* A wrapper for iterate_over_symtabs that returns the first matching
634 lookup_symtab (const char *name
)
636 struct symtab
*result
= NULL
;
638 iterate_over_symtabs (name
, [&] (symtab
*symtab
)
648 /* Mangle a GDB method stub type. This actually reassembles the pieces of the
649 full method name, which consist of the class name (from T), the unadorned
650 method name from METHOD_ID, and the signature for the specific overload,
651 specified by SIGNATURE_ID. Note that this function is g++ specific. */
654 gdb_mangle_name (struct type
*type
, int method_id
, int signature_id
)
656 int mangled_name_len
;
658 struct fn_field
*f
= TYPE_FN_FIELDLIST1 (type
, method_id
);
659 struct fn_field
*method
= &f
[signature_id
];
660 const char *field_name
= TYPE_FN_FIELDLIST_NAME (type
, method_id
);
661 const char *physname
= TYPE_FN_FIELD_PHYSNAME (f
, signature_id
);
662 const char *newname
= type
->name ();
664 /* Does the form of physname indicate that it is the full mangled name
665 of a constructor (not just the args)? */
666 int is_full_physname_constructor
;
669 int is_destructor
= is_destructor_name (physname
);
670 /* Need a new type prefix. */
671 const char *const_prefix
= method
->is_const
? "C" : "";
672 const char *volatile_prefix
= method
->is_volatile
? "V" : "";
674 int len
= (newname
== NULL
? 0 : strlen (newname
));
676 /* Nothing to do if physname already contains a fully mangled v3 abi name
677 or an operator name. */
678 if ((physname
[0] == '_' && physname
[1] == 'Z')
679 || is_operator_name (field_name
))
680 return xstrdup (physname
);
682 is_full_physname_constructor
= is_constructor_name (physname
);
684 is_constructor
= is_full_physname_constructor
685 || (newname
&& strcmp (field_name
, newname
) == 0);
688 is_destructor
= (startswith (physname
, "__dt"));
690 if (is_destructor
|| is_full_physname_constructor
)
692 mangled_name
= (char *) xmalloc (strlen (physname
) + 1);
693 strcpy (mangled_name
, physname
);
699 xsnprintf (buf
, sizeof (buf
), "__%s%s", const_prefix
, volatile_prefix
);
701 else if (physname
[0] == 't' || physname
[0] == 'Q')
703 /* The physname for template and qualified methods already includes
705 xsnprintf (buf
, sizeof (buf
), "__%s%s", const_prefix
, volatile_prefix
);
711 xsnprintf (buf
, sizeof (buf
), "__%s%s%d", const_prefix
,
712 volatile_prefix
, len
);
714 mangled_name_len
= ((is_constructor
? 0 : strlen (field_name
))
715 + strlen (buf
) + len
+ strlen (physname
) + 1);
717 mangled_name
= (char *) xmalloc (mangled_name_len
);
719 mangled_name
[0] = '\0';
721 strcpy (mangled_name
, field_name
);
723 strcat (mangled_name
, buf
);
724 /* If the class doesn't have a name, i.e. newname NULL, then we just
725 mangle it using 0 for the length of the class. Thus it gets mangled
726 as something starting with `::' rather than `classname::'. */
728 strcat (mangled_name
, newname
);
730 strcat (mangled_name
, physname
);
731 return (mangled_name
);
737 general_symbol_info::set_demangled_name (const char *name
,
738 struct obstack
*obstack
)
740 if (language () == language_ada
)
745 language_specific
.obstack
= obstack
;
750 language_specific
.demangled_name
= name
;
754 language_specific
.demangled_name
= name
;
758 /* Initialize the language dependent portion of a symbol
759 depending upon the language for the symbol. */
762 general_symbol_info::set_language (enum language language
,
763 struct obstack
*obstack
)
765 m_language
= language
;
766 if (language
== language_cplus
767 || language
== language_d
768 || language
== language_go
769 || language
== language_objc
770 || language
== language_fortran
)
772 set_demangled_name (NULL
, obstack
);
774 else if (language
== language_ada
)
776 gdb_assert (ada_mangled
== 0);
777 language_specific
.obstack
= obstack
;
781 memset (&language_specific
, 0, sizeof (language_specific
));
785 /* Functions to initialize a symbol's mangled name. */
787 /* Objects of this type are stored in the demangled name hash table. */
788 struct demangled_name_entry
790 demangled_name_entry (gdb::string_view mangled_name
)
791 : mangled (mangled_name
) {}
793 gdb::string_view mangled
;
794 enum language language
;
795 gdb::unique_xmalloc_ptr
<char> demangled
;
798 /* Hash function for the demangled name hash. */
801 hash_demangled_name_entry (const void *data
)
803 const struct demangled_name_entry
*e
804 = (const struct demangled_name_entry
*) data
;
806 return fast_hash (e
->mangled
.data (), e
->mangled
.length ());
809 /* Equality function for the demangled name hash. */
812 eq_demangled_name_entry (const void *a
, const void *b
)
814 const struct demangled_name_entry
*da
815 = (const struct demangled_name_entry
*) a
;
816 const struct demangled_name_entry
*db
817 = (const struct demangled_name_entry
*) b
;
819 return da
->mangled
== db
->mangled
;
823 free_demangled_name_entry (void *data
)
825 struct demangled_name_entry
*e
826 = (struct demangled_name_entry
*) data
;
828 e
->~demangled_name_entry();
831 /* Create the hash table used for demangled names. Each hash entry is
832 a pair of strings; one for the mangled name and one for the demangled
833 name. The entry is hashed via just the mangled name. */
836 create_demangled_names_hash (struct objfile_per_bfd_storage
*per_bfd
)
838 /* Choose 256 as the starting size of the hash table, somewhat arbitrarily.
839 The hash table code will round this up to the next prime number.
840 Choosing a much larger table size wastes memory, and saves only about
841 1% in symbol reading. However, if the minsym count is already
842 initialized (e.g. because symbol name setting was deferred to
843 a background thread) we can initialize the hashtable with a count
844 based on that, because we will almost certainly have at least that
845 many entries. If we have a nonzero number but less than 256,
846 we still stay with 256 to have some space for psymbols, etc. */
848 /* htab will expand the table when it is 3/4th full, so we account for that
849 here. +2 to round up. */
850 int minsym_based_count
= (per_bfd
->minimal_symbol_count
+ 2) / 3 * 4;
851 int count
= std::max (per_bfd
->minimal_symbol_count
, minsym_based_count
);
853 per_bfd
->demangled_names_hash
.reset (htab_create_alloc
854 (count
, hash_demangled_name_entry
, eq_demangled_name_entry
,
855 free_demangled_name_entry
, xcalloc
, xfree
));
860 gdb::unique_xmalloc_ptr
<char>
861 symbol_find_demangled_name (struct general_symbol_info
*gsymbol
,
864 gdb::unique_xmalloc_ptr
<char> demangled
;
867 if (gsymbol
->language () == language_unknown
)
868 gsymbol
->m_language
= language_auto
;
870 if (gsymbol
->language () != language_auto
)
872 const struct language_defn
*lang
= language_def (gsymbol
->language ());
874 lang
->sniff_from_mangled_name (mangled
, &demangled
);
878 for (i
= language_unknown
; i
< nr_languages
; ++i
)
880 enum language l
= (enum language
) i
;
881 const struct language_defn
*lang
= language_def (l
);
883 if (lang
->sniff_from_mangled_name (mangled
, &demangled
))
885 gsymbol
->m_language
= l
;
893 /* Set both the mangled and demangled (if any) names for GSYMBOL based
894 on LINKAGE_NAME and LEN. Ordinarily, NAME is copied onto the
895 objfile's obstack; but if COPY_NAME is 0 and if NAME is
896 NUL-terminated, then this function assumes that NAME is already
897 correctly saved (either permanently or with a lifetime tied to the
898 objfile), and it will not be copied.
900 The hash table corresponding to OBJFILE is used, and the memory
901 comes from the per-BFD storage_obstack. LINKAGE_NAME is copied,
902 so the pointer can be discarded after calling this function. */
905 general_symbol_info::compute_and_set_names (gdb::string_view linkage_name
,
907 objfile_per_bfd_storage
*per_bfd
,
908 gdb::optional
<hashval_t
> hash
)
910 struct demangled_name_entry
**slot
;
912 if (language () == language_ada
)
914 /* In Ada, we do the symbol lookups using the mangled name, so
915 we can save some space by not storing the demangled name. */
917 m_name
= linkage_name
.data ();
919 m_name
= obstack_strndup (&per_bfd
->storage_obstack
,
920 linkage_name
.data (),
921 linkage_name
.length ());
922 set_demangled_name (NULL
, &per_bfd
->storage_obstack
);
927 if (per_bfd
->demangled_names_hash
== NULL
)
928 create_demangled_names_hash (per_bfd
);
930 struct demangled_name_entry
entry (linkage_name
);
931 if (!hash
.has_value ())
932 hash
= hash_demangled_name_entry (&entry
);
933 slot
= ((struct demangled_name_entry
**)
934 htab_find_slot_with_hash (per_bfd
->demangled_names_hash
.get (),
935 &entry
, *hash
, INSERT
));
937 /* The const_cast is safe because the only reason it is already
938 initialized is if we purposefully set it from a background
939 thread to avoid doing the work here. However, it is still
940 allocated from the heap and needs to be freed by us, just
941 like if we called symbol_find_demangled_name here. If this is
942 nullptr, we call symbol_find_demangled_name below, but we put
943 this smart pointer here to be sure that we don't leak this name. */
944 gdb::unique_xmalloc_ptr
<char> demangled_name
945 (const_cast<char *> (language_specific
.demangled_name
));
947 /* If this name is not in the hash table, add it. */
949 /* A C version of the symbol may have already snuck into the table.
950 This happens to, e.g., main.init (__go_init_main). Cope. */
951 || (language () == language_go
&& (*slot
)->demangled
== nullptr))
953 /* A 0-terminated copy of the linkage name. Callers must set COPY_NAME
954 to true if the string might not be nullterminated. We have to make
955 this copy because demangling needs a nullterminated string. */
956 gdb::string_view linkage_name_copy
;
959 char *alloc_name
= (char *) alloca (linkage_name
.length () + 1);
960 memcpy (alloc_name
, linkage_name
.data (), linkage_name
.length ());
961 alloc_name
[linkage_name
.length ()] = '\0';
963 linkage_name_copy
= gdb::string_view (alloc_name
,
964 linkage_name
.length ());
967 linkage_name_copy
= linkage_name
;
969 if (demangled_name
.get () == nullptr)
971 = symbol_find_demangled_name (this, linkage_name_copy
.data ());
973 /* Suppose we have demangled_name==NULL, copy_name==0, and
974 linkage_name_copy==linkage_name. In this case, we already have the
975 mangled name saved, and we don't have a demangled name. So,
976 you might think we could save a little space by not recording
977 this in the hash table at all.
979 It turns out that it is actually important to still save such
980 an entry in the hash table, because storing this name gives
981 us better bcache hit rates for partial symbols. */
985 = ((struct demangled_name_entry
*)
986 obstack_alloc (&per_bfd
->storage_obstack
,
987 sizeof (demangled_name_entry
)));
988 new (*slot
) demangled_name_entry (linkage_name
);
992 /* If we must copy the mangled name, put it directly after
993 the struct so we can have a single allocation. */
995 = ((struct demangled_name_entry
*)
996 obstack_alloc (&per_bfd
->storage_obstack
,
997 sizeof (demangled_name_entry
)
998 + linkage_name
.length () + 1));
999 char *mangled_ptr
= reinterpret_cast<char *> (*slot
+ 1);
1000 memcpy (mangled_ptr
, linkage_name
.data (), linkage_name
.length ());
1001 mangled_ptr
[linkage_name
.length ()] = '\0';
1002 new (*slot
) demangled_name_entry
1003 (gdb::string_view (mangled_ptr
, linkage_name
.length ()));
1005 (*slot
)->demangled
= std::move (demangled_name
);
1006 (*slot
)->language
= language ();
1008 else if (language () == language_unknown
|| language () == language_auto
)
1009 m_language
= (*slot
)->language
;
1011 m_name
= (*slot
)->mangled
.data ();
1012 set_demangled_name ((*slot
)->demangled
.get (), &per_bfd
->storage_obstack
);
1018 general_symbol_info::natural_name () const
1020 switch (language ())
1022 case language_cplus
:
1026 case language_fortran
:
1028 if (language_specific
.demangled_name
!= nullptr)
1029 return language_specific
.demangled_name
;
1032 return ada_decode_symbol (this);
1036 return linkage_name ();
1042 general_symbol_info::demangled_name () const
1044 const char *dem_name
= NULL
;
1046 switch (language ())
1048 case language_cplus
:
1052 case language_fortran
:
1054 dem_name
= language_specific
.demangled_name
;
1057 dem_name
= ada_decode_symbol (this);
1068 general_symbol_info::search_name () const
1070 if (language () == language_ada
)
1071 return linkage_name ();
1073 return natural_name ();
1078 struct obj_section
*
1079 general_symbol_info::obj_section (const struct objfile
*objfile
) const
1081 if (section_index () >= 0)
1082 return &objfile
->sections
[section_index ()];
1089 symbol_matches_search_name (const struct general_symbol_info
*gsymbol
,
1090 const lookup_name_info
&name
)
1092 symbol_name_matcher_ftype
*name_match
1093 = language_def (gsymbol
->language ())->get_symbol_name_matcher (name
);
1094 return name_match (gsymbol
->search_name (), name
, NULL
);
1099 /* Return true if the two sections are the same, or if they could
1100 plausibly be copies of each other, one in an original object
1101 file and another in a separated debug file. */
1104 matching_obj_sections (struct obj_section
*obj_first
,
1105 struct obj_section
*obj_second
)
1107 asection
*first
= obj_first
? obj_first
->the_bfd_section
: NULL
;
1108 asection
*second
= obj_second
? obj_second
->the_bfd_section
: NULL
;
1110 /* If they're the same section, then they match. */
1111 if (first
== second
)
1114 /* If either is NULL, give up. */
1115 if (first
== NULL
|| second
== NULL
)
1118 /* This doesn't apply to absolute symbols. */
1119 if (first
->owner
== NULL
|| second
->owner
== NULL
)
1122 /* If they're in the same object file, they must be different sections. */
1123 if (first
->owner
== second
->owner
)
1126 /* Check whether the two sections are potentially corresponding. They must
1127 have the same size, address, and name. We can't compare section indexes,
1128 which would be more reliable, because some sections may have been
1130 if (bfd_section_size (first
) != bfd_section_size (second
))
1133 /* In-memory addresses may start at a different offset, relativize them. */
1134 if (bfd_section_vma (first
) - bfd_get_start_address (first
->owner
)
1135 != bfd_section_vma (second
) - bfd_get_start_address (second
->owner
))
1138 if (bfd_section_name (first
) == NULL
1139 || bfd_section_name (second
) == NULL
1140 || strcmp (bfd_section_name (first
), bfd_section_name (second
)) != 0)
1143 /* Otherwise check that they are in corresponding objfiles. */
1145 struct objfile
*obj
= NULL
;
1146 for (objfile
*objfile
: current_program_space
->objfiles ())
1147 if (objfile
->obfd
== first
->owner
)
1152 gdb_assert (obj
!= NULL
);
1154 if (obj
->separate_debug_objfile
!= NULL
1155 && obj
->separate_debug_objfile
->obfd
== second
->owner
)
1157 if (obj
->separate_debug_objfile_backlink
!= NULL
1158 && obj
->separate_debug_objfile_backlink
->obfd
== second
->owner
)
1167 expand_symtab_containing_pc (CORE_ADDR pc
, struct obj_section
*section
)
1169 struct bound_minimal_symbol msymbol
;
1171 /* If we know that this is not a text address, return failure. This is
1172 necessary because we loop based on texthigh and textlow, which do
1173 not include the data ranges. */
1174 msymbol
= lookup_minimal_symbol_by_pc_section (pc
, section
);
1175 if (msymbol
.minsym
&& msymbol
.minsym
->data_p ())
1178 for (objfile
*objfile
: current_program_space
->objfiles ())
1180 struct compunit_symtab
*cust
1181 = objfile
->find_pc_sect_compunit_symtab (msymbol
, pc
, section
, 0);
1187 /* Hash function for the symbol cache. */
1190 hash_symbol_entry (const struct objfile
*objfile_context
,
1191 const char *name
, domain_enum domain
)
1193 unsigned int hash
= (uintptr_t) objfile_context
;
1196 hash
+= htab_hash_string (name
);
1198 /* Because of symbol_matches_domain we need VAR_DOMAIN and STRUCT_DOMAIN
1199 to map to the same slot. */
1200 if (domain
== STRUCT_DOMAIN
)
1201 hash
+= VAR_DOMAIN
* 7;
1208 /* Equality function for the symbol cache. */
1211 eq_symbol_entry (const struct symbol_cache_slot
*slot
,
1212 const struct objfile
*objfile_context
,
1213 const char *name
, domain_enum domain
)
1215 const char *slot_name
;
1216 domain_enum slot_domain
;
1218 if (slot
->state
== SYMBOL_SLOT_UNUSED
)
1221 if (slot
->objfile_context
!= objfile_context
)
1224 if (slot
->state
== SYMBOL_SLOT_NOT_FOUND
)
1226 slot_name
= slot
->value
.not_found
.name
;
1227 slot_domain
= slot
->value
.not_found
.domain
;
1231 slot_name
= slot
->value
.found
.symbol
->search_name ();
1232 slot_domain
= slot
->value
.found
.symbol
->domain ();
1235 /* NULL names match. */
1236 if (slot_name
== NULL
&& name
== NULL
)
1238 /* But there's no point in calling symbol_matches_domain in the
1239 SYMBOL_SLOT_FOUND case. */
1240 if (slot_domain
!= domain
)
1243 else if (slot_name
!= NULL
&& name
!= NULL
)
1245 /* It's important that we use the same comparison that was done
1246 the first time through. If the slot records a found symbol,
1247 then this means using the symbol name comparison function of
1248 the symbol's language with symbol->search_name (). See
1249 dictionary.c. It also means using symbol_matches_domain for
1250 found symbols. See block.c.
1252 If the slot records a not-found symbol, then require a precise match.
1253 We could still be lax with whitespace like strcmp_iw though. */
1255 if (slot
->state
== SYMBOL_SLOT_NOT_FOUND
)
1257 if (strcmp (slot_name
, name
) != 0)
1259 if (slot_domain
!= domain
)
1264 struct symbol
*sym
= slot
->value
.found
.symbol
;
1265 lookup_name_info
lookup_name (name
, symbol_name_match_type::FULL
);
1267 if (!symbol_matches_search_name (sym
, lookup_name
))
1270 if (!symbol_matches_domain (sym
->language (), slot_domain
, domain
))
1276 /* Only one name is NULL. */
1283 /* Given a cache of size SIZE, return the size of the struct (with variable
1284 length array) in bytes. */
1287 symbol_cache_byte_size (unsigned int size
)
1289 return (sizeof (struct block_symbol_cache
)
1290 + ((size
- 1) * sizeof (struct symbol_cache_slot
)));
1296 resize_symbol_cache (struct symbol_cache
*cache
, unsigned int new_size
)
1298 /* If there's no change in size, don't do anything.
1299 All caches have the same size, so we can just compare with the size
1300 of the global symbols cache. */
1301 if ((cache
->global_symbols
!= NULL
1302 && cache
->global_symbols
->size
== new_size
)
1303 || (cache
->global_symbols
== NULL
1307 destroy_block_symbol_cache (cache
->global_symbols
);
1308 destroy_block_symbol_cache (cache
->static_symbols
);
1312 cache
->global_symbols
= NULL
;
1313 cache
->static_symbols
= NULL
;
1317 size_t total_size
= symbol_cache_byte_size (new_size
);
1319 cache
->global_symbols
1320 = (struct block_symbol_cache
*) xcalloc (1, total_size
);
1321 cache
->static_symbols
1322 = (struct block_symbol_cache
*) xcalloc (1, total_size
);
1323 cache
->global_symbols
->size
= new_size
;
1324 cache
->static_symbols
->size
= new_size
;
1328 /* Return the symbol cache of PSPACE.
1329 Create one if it doesn't exist yet. */
1331 static struct symbol_cache
*
1332 get_symbol_cache (struct program_space
*pspace
)
1334 struct symbol_cache
*cache
= symbol_cache_key
.get (pspace
);
1338 cache
= symbol_cache_key
.emplace (pspace
);
1339 resize_symbol_cache (cache
, symbol_cache_size
);
1345 /* Set the size of the symbol cache in all program spaces. */
1348 set_symbol_cache_size (unsigned int new_size
)
1350 for (struct program_space
*pspace
: program_spaces
)
1352 struct symbol_cache
*cache
= symbol_cache_key
.get (pspace
);
1354 /* The pspace could have been created but not have a cache yet. */
1356 resize_symbol_cache (cache
, new_size
);
1360 /* Called when symbol-cache-size is set. */
1363 set_symbol_cache_size_handler (const char *args
, int from_tty
,
1364 struct cmd_list_element
*c
)
1366 if (new_symbol_cache_size
> MAX_SYMBOL_CACHE_SIZE
)
1368 /* Restore the previous value.
1369 This is the value the "show" command prints. */
1370 new_symbol_cache_size
= symbol_cache_size
;
1372 error (_("Symbol cache size is too large, max is %u."),
1373 MAX_SYMBOL_CACHE_SIZE
);
1375 symbol_cache_size
= new_symbol_cache_size
;
1377 set_symbol_cache_size (symbol_cache_size
);
1380 /* Lookup symbol NAME,DOMAIN in BLOCK in the symbol cache of PSPACE.
1381 OBJFILE_CONTEXT is the current objfile, which may be NULL.
1382 The result is the symbol if found, SYMBOL_LOOKUP_FAILED if a previous lookup
1383 failed (and thus this one will too), or NULL if the symbol is not present
1385 *BSC_PTR and *SLOT_PTR are set to the cache and slot of the symbol, which
1386 can be used to save the result of a full lookup attempt. */
1388 static struct block_symbol
1389 symbol_cache_lookup (struct symbol_cache
*cache
,
1390 struct objfile
*objfile_context
, enum block_enum block
,
1391 const char *name
, domain_enum domain
,
1392 struct block_symbol_cache
**bsc_ptr
,
1393 struct symbol_cache_slot
**slot_ptr
)
1395 struct block_symbol_cache
*bsc
;
1397 struct symbol_cache_slot
*slot
;
1399 if (block
== GLOBAL_BLOCK
)
1400 bsc
= cache
->global_symbols
;
1402 bsc
= cache
->static_symbols
;
1410 hash
= hash_symbol_entry (objfile_context
, name
, domain
);
1411 slot
= bsc
->symbols
+ hash
% bsc
->size
;
1416 if (eq_symbol_entry (slot
, objfile_context
, name
, domain
))
1418 if (symbol_lookup_debug
)
1419 fprintf_unfiltered (gdb_stdlog
,
1420 "%s block symbol cache hit%s for %s, %s\n",
1421 block
== GLOBAL_BLOCK
? "Global" : "Static",
1422 slot
->state
== SYMBOL_SLOT_NOT_FOUND
1423 ? " (not found)" : "",
1424 name
, domain_name (domain
));
1426 if (slot
->state
== SYMBOL_SLOT_NOT_FOUND
)
1427 return SYMBOL_LOOKUP_FAILED
;
1428 return slot
->value
.found
;
1431 /* Symbol is not present in the cache. */
1433 if (symbol_lookup_debug
)
1435 fprintf_unfiltered (gdb_stdlog
,
1436 "%s block symbol cache miss for %s, %s\n",
1437 block
== GLOBAL_BLOCK
? "Global" : "Static",
1438 name
, domain_name (domain
));
1444 /* Mark SYMBOL as found in SLOT.
1445 OBJFILE_CONTEXT is the current objfile when the lookup was done, or NULL
1446 if it's not needed to distinguish lookups (STATIC_BLOCK). It is *not*
1447 necessarily the objfile the symbol was found in. */
1450 symbol_cache_mark_found (struct block_symbol_cache
*bsc
,
1451 struct symbol_cache_slot
*slot
,
1452 struct objfile
*objfile_context
,
1453 struct symbol
*symbol
,
1454 const struct block
*block
)
1458 if (slot
->state
!= SYMBOL_SLOT_UNUSED
)
1461 symbol_cache_clear_slot (slot
);
1463 slot
->state
= SYMBOL_SLOT_FOUND
;
1464 slot
->objfile_context
= objfile_context
;
1465 slot
->value
.found
.symbol
= symbol
;
1466 slot
->value
.found
.block
= block
;
1469 /* Mark symbol NAME, DOMAIN as not found in SLOT.
1470 OBJFILE_CONTEXT is the current objfile when the lookup was done, or NULL
1471 if it's not needed to distinguish lookups (STATIC_BLOCK). */
1474 symbol_cache_mark_not_found (struct block_symbol_cache
*bsc
,
1475 struct symbol_cache_slot
*slot
,
1476 struct objfile
*objfile_context
,
1477 const char *name
, domain_enum domain
)
1481 if (slot
->state
!= SYMBOL_SLOT_UNUSED
)
1484 symbol_cache_clear_slot (slot
);
1486 slot
->state
= SYMBOL_SLOT_NOT_FOUND
;
1487 slot
->objfile_context
= objfile_context
;
1488 slot
->value
.not_found
.name
= xstrdup (name
);
1489 slot
->value
.not_found
.domain
= domain
;
1492 /* Flush the symbol cache of PSPACE. */
1495 symbol_cache_flush (struct program_space
*pspace
)
1497 struct symbol_cache
*cache
= symbol_cache_key
.get (pspace
);
1502 if (cache
->global_symbols
== NULL
)
1504 gdb_assert (symbol_cache_size
== 0);
1505 gdb_assert (cache
->static_symbols
== NULL
);
1509 /* If the cache is untouched since the last flush, early exit.
1510 This is important for performance during the startup of a program linked
1511 with 100s (or 1000s) of shared libraries. */
1512 if (cache
->global_symbols
->misses
== 0
1513 && cache
->static_symbols
->misses
== 0)
1516 gdb_assert (cache
->global_symbols
->size
== symbol_cache_size
);
1517 gdb_assert (cache
->static_symbols
->size
== symbol_cache_size
);
1519 for (pass
= 0; pass
< 2; ++pass
)
1521 struct block_symbol_cache
*bsc
1522 = pass
== 0 ? cache
->global_symbols
: cache
->static_symbols
;
1525 for (i
= 0; i
< bsc
->size
; ++i
)
1526 symbol_cache_clear_slot (&bsc
->symbols
[i
]);
1529 cache
->global_symbols
->hits
= 0;
1530 cache
->global_symbols
->misses
= 0;
1531 cache
->global_symbols
->collisions
= 0;
1532 cache
->static_symbols
->hits
= 0;
1533 cache
->static_symbols
->misses
= 0;
1534 cache
->static_symbols
->collisions
= 0;
1540 symbol_cache_dump (const struct symbol_cache
*cache
)
1544 if (cache
->global_symbols
== NULL
)
1546 printf_filtered (" <disabled>\n");
1550 for (pass
= 0; pass
< 2; ++pass
)
1552 const struct block_symbol_cache
*bsc
1553 = pass
== 0 ? cache
->global_symbols
: cache
->static_symbols
;
1557 printf_filtered ("Global symbols:\n");
1559 printf_filtered ("Static symbols:\n");
1561 for (i
= 0; i
< bsc
->size
; ++i
)
1563 const struct symbol_cache_slot
*slot
= &bsc
->symbols
[i
];
1567 switch (slot
->state
)
1569 case SYMBOL_SLOT_UNUSED
:
1571 case SYMBOL_SLOT_NOT_FOUND
:
1572 printf_filtered (" [%4u] = %s, %s %s (not found)\n", i
,
1573 host_address_to_string (slot
->objfile_context
),
1574 slot
->value
.not_found
.name
,
1575 domain_name (slot
->value
.not_found
.domain
));
1577 case SYMBOL_SLOT_FOUND
:
1579 struct symbol
*found
= slot
->value
.found
.symbol
;
1580 const struct objfile
*context
= slot
->objfile_context
;
1582 printf_filtered (" [%4u] = %s, %s %s\n", i
,
1583 host_address_to_string (context
),
1584 found
->print_name (),
1585 domain_name (found
->domain ()));
1593 /* The "mt print symbol-cache" command. */
1596 maintenance_print_symbol_cache (const char *args
, int from_tty
)
1598 for (struct program_space
*pspace
: program_spaces
)
1600 struct symbol_cache
*cache
;
1602 printf_filtered (_("Symbol cache for pspace %d\n%s:\n"),
1604 pspace
->symfile_object_file
!= NULL
1605 ? objfile_name (pspace
->symfile_object_file
)
1606 : "(no object file)");
1608 /* If the cache hasn't been created yet, avoid creating one. */
1609 cache
= symbol_cache_key
.get (pspace
);
1611 printf_filtered (" <empty>\n");
1613 symbol_cache_dump (cache
);
1617 /* The "mt flush-symbol-cache" command. */
1620 maintenance_flush_symbol_cache (const char *args
, int from_tty
)
1622 for (struct program_space
*pspace
: program_spaces
)
1624 symbol_cache_flush (pspace
);
1628 /* Print usage statistics of CACHE. */
1631 symbol_cache_stats (struct symbol_cache
*cache
)
1635 if (cache
->global_symbols
== NULL
)
1637 printf_filtered (" <disabled>\n");
1641 for (pass
= 0; pass
< 2; ++pass
)
1643 const struct block_symbol_cache
*bsc
1644 = pass
== 0 ? cache
->global_symbols
: cache
->static_symbols
;
1649 printf_filtered ("Global block cache stats:\n");
1651 printf_filtered ("Static block cache stats:\n");
1653 printf_filtered (" size: %u\n", bsc
->size
);
1654 printf_filtered (" hits: %u\n", bsc
->hits
);
1655 printf_filtered (" misses: %u\n", bsc
->misses
);
1656 printf_filtered (" collisions: %u\n", bsc
->collisions
);
1660 /* The "mt print symbol-cache-statistics" command. */
1663 maintenance_print_symbol_cache_statistics (const char *args
, int from_tty
)
1665 for (struct program_space
*pspace
: program_spaces
)
1667 struct symbol_cache
*cache
;
1669 printf_filtered (_("Symbol cache statistics for pspace %d\n%s:\n"),
1671 pspace
->symfile_object_file
!= NULL
1672 ? objfile_name (pspace
->symfile_object_file
)
1673 : "(no object file)");
1675 /* If the cache hasn't been created yet, avoid creating one. */
1676 cache
= symbol_cache_key
.get (pspace
);
1678 printf_filtered (" empty, no stats available\n");
1680 symbol_cache_stats (cache
);
1684 /* This module's 'new_objfile' observer. */
1687 symtab_new_objfile_observer (struct objfile
*objfile
)
1689 /* Ideally we'd use OBJFILE->pspace, but OBJFILE may be NULL. */
1690 symbol_cache_flush (current_program_space
);
1693 /* This module's 'free_objfile' observer. */
1696 symtab_free_objfile_observer (struct objfile
*objfile
)
1698 symbol_cache_flush (objfile
->pspace
);
1701 /* Debug symbols usually don't have section information. We need to dig that
1702 out of the minimal symbols and stash that in the debug symbol. */
1705 fixup_section (struct general_symbol_info
*ginfo
,
1706 CORE_ADDR addr
, struct objfile
*objfile
)
1708 struct minimal_symbol
*msym
;
1710 /* First, check whether a minimal symbol with the same name exists
1711 and points to the same address. The address check is required
1712 e.g. on PowerPC64, where the minimal symbol for a function will
1713 point to the function descriptor, while the debug symbol will
1714 point to the actual function code. */
1715 msym
= lookup_minimal_symbol_by_pc_name (addr
, ginfo
->linkage_name (),
1718 ginfo
->set_section_index (msym
->section_index ());
1721 /* Static, function-local variables do appear in the linker
1722 (minimal) symbols, but are frequently given names that won't
1723 be found via lookup_minimal_symbol(). E.g., it has been
1724 observed in frv-uclinux (ELF) executables that a static,
1725 function-local variable named "foo" might appear in the
1726 linker symbols as "foo.6" or "foo.3". Thus, there is no
1727 point in attempting to extend the lookup-by-name mechanism to
1728 handle this case due to the fact that there can be multiple
1731 So, instead, search the section table when lookup by name has
1732 failed. The ``addr'' and ``endaddr'' fields may have already
1733 been relocated. If so, the relocation offset needs to be
1734 subtracted from these values when performing the comparison.
1735 We unconditionally subtract it, because, when no relocation
1736 has been performed, the value will simply be zero.
1738 The address of the symbol whose section we're fixing up HAS
1739 NOT BEEN adjusted (relocated) yet. It can't have been since
1740 the section isn't yet known and knowing the section is
1741 necessary in order to add the correct relocation value. In
1742 other words, we wouldn't even be in this function (attempting
1743 to compute the section) if it were already known.
1745 Note that it is possible to search the minimal symbols
1746 (subtracting the relocation value if necessary) to find the
1747 matching minimal symbol, but this is overkill and much less
1748 efficient. It is not necessary to find the matching minimal
1749 symbol, only its section.
1751 Note that this technique (of doing a section table search)
1752 can fail when unrelocated section addresses overlap. For
1753 this reason, we still attempt a lookup by name prior to doing
1754 a search of the section table. */
1756 struct obj_section
*s
;
1759 ALL_OBJFILE_OSECTIONS (objfile
, s
)
1761 int idx
= s
- objfile
->sections
;
1762 CORE_ADDR offset
= objfile
->section_offsets
[idx
];
1767 if (s
->addr () - offset
<= addr
&& addr
< s
->endaddr () - offset
)
1769 ginfo
->set_section_index (idx
);
1774 /* If we didn't find the section, assume it is in the first
1775 section. If there is no allocated section, then it hardly
1776 matters what we pick, so just pick zero. */
1778 ginfo
->set_section_index (0);
1780 ginfo
->set_section_index (fallback
);
1785 fixup_symbol_section (struct symbol
*sym
, struct objfile
*objfile
)
1792 if (!sym
->is_objfile_owned ())
1795 /* We either have an OBJFILE, or we can get at it from the sym's
1796 symtab. Anything else is a bug. */
1797 gdb_assert (objfile
|| symbol_symtab (sym
));
1799 if (objfile
== NULL
)
1800 objfile
= symbol_objfile (sym
);
1802 if (sym
->obj_section (objfile
) != nullptr)
1805 /* We should have an objfile by now. */
1806 gdb_assert (objfile
);
1808 switch (sym
->aclass ())
1812 addr
= SYMBOL_VALUE_ADDRESS (sym
);
1815 addr
= BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
));
1819 /* Nothing else will be listed in the minsyms -- no use looking
1824 fixup_section (sym
, addr
, objfile
);
1831 demangle_for_lookup_info::demangle_for_lookup_info
1832 (const lookup_name_info
&lookup_name
, language lang
)
1834 demangle_result_storage storage
;
1836 if (lookup_name
.ignore_parameters () && lang
== language_cplus
)
1838 gdb::unique_xmalloc_ptr
<char> without_params
1839 = cp_remove_params_if_any (lookup_name
.c_str (),
1840 lookup_name
.completion_mode ());
1842 if (without_params
!= NULL
)
1844 if (lookup_name
.match_type () != symbol_name_match_type::SEARCH_NAME
)
1845 m_demangled_name
= demangle_for_lookup (without_params
.get (),
1851 if (lookup_name
.match_type () == symbol_name_match_type::SEARCH_NAME
)
1852 m_demangled_name
= lookup_name
.c_str ();
1854 m_demangled_name
= demangle_for_lookup (lookup_name
.c_str (),
1860 const lookup_name_info
&
1861 lookup_name_info::match_any ()
1863 /* Lookup any symbol that "" would complete. I.e., this matches all
1865 static const lookup_name_info
lookup_name ("", symbol_name_match_type::FULL
,
1871 /* Compute the demangled form of NAME as used by the various symbol
1872 lookup functions. The result can either be the input NAME
1873 directly, or a pointer to a buffer owned by the STORAGE object.
1875 For Ada, this function just returns NAME, unmodified.
1876 Normally, Ada symbol lookups are performed using the encoded name
1877 rather than the demangled name, and so it might seem to make sense
1878 for this function to return an encoded version of NAME.
1879 Unfortunately, we cannot do this, because this function is used in
1880 circumstances where it is not appropriate to try to encode NAME.
1881 For instance, when displaying the frame info, we demangle the name
1882 of each parameter, and then perform a symbol lookup inside our
1883 function using that demangled name. In Ada, certain functions
1884 have internally-generated parameters whose name contain uppercase
1885 characters. Encoding those name would result in those uppercase
1886 characters to become lowercase, and thus cause the symbol lookup
1890 demangle_for_lookup (const char *name
, enum language lang
,
1891 demangle_result_storage
&storage
)
1893 /* If we are using C++, D, or Go, demangle the name before doing a
1894 lookup, so we can always binary search. */
1895 if (lang
== language_cplus
)
1897 gdb::unique_xmalloc_ptr
<char> demangled_name
1898 = gdb_demangle (name
, DMGL_ANSI
| DMGL_PARAMS
);
1899 if (demangled_name
!= NULL
)
1900 return storage
.set_malloc_ptr (std::move (demangled_name
));
1902 /* If we were given a non-mangled name, canonicalize it
1903 according to the language (so far only for C++). */
1904 gdb::unique_xmalloc_ptr
<char> canon
= cp_canonicalize_string (name
);
1905 if (canon
!= nullptr)
1906 return storage
.set_malloc_ptr (std::move (canon
));
1908 else if (lang
== language_d
)
1910 gdb::unique_xmalloc_ptr
<char> demangled_name
= d_demangle (name
, 0);
1911 if (demangled_name
!= NULL
)
1912 return storage
.set_malloc_ptr (std::move (demangled_name
));
1914 else if (lang
== language_go
)
1916 gdb::unique_xmalloc_ptr
<char> demangled_name
1917 = language_def (language_go
)->demangle_symbol (name
, 0);
1918 if (demangled_name
!= NULL
)
1919 return storage
.set_malloc_ptr (std::move (demangled_name
));
1928 search_name_hash (enum language language
, const char *search_name
)
1930 return language_def (language
)->search_name_hash (search_name
);
1935 This function (or rather its subordinates) have a bunch of loops and
1936 it would seem to be attractive to put in some QUIT's (though I'm not really
1937 sure whether it can run long enough to be really important). But there
1938 are a few calls for which it would appear to be bad news to quit
1939 out of here: e.g., find_proc_desc in alpha-mdebug-tdep.c. (Note
1940 that there is C++ code below which can error(), but that probably
1941 doesn't affect these calls since they are looking for a known
1942 variable and thus can probably assume it will never hit the C++
1946 lookup_symbol_in_language (const char *name
, const struct block
*block
,
1947 const domain_enum domain
, enum language lang
,
1948 struct field_of_this_result
*is_a_field_of_this
)
1950 demangle_result_storage storage
;
1951 const char *modified_name
= demangle_for_lookup (name
, lang
, storage
);
1953 return lookup_symbol_aux (modified_name
,
1954 symbol_name_match_type::FULL
,
1955 block
, domain
, lang
,
1956 is_a_field_of_this
);
1962 lookup_symbol (const char *name
, const struct block
*block
,
1964 struct field_of_this_result
*is_a_field_of_this
)
1966 return lookup_symbol_in_language (name
, block
, domain
,
1967 current_language
->la_language
,
1968 is_a_field_of_this
);
1974 lookup_symbol_search_name (const char *search_name
, const struct block
*block
,
1977 return lookup_symbol_aux (search_name
, symbol_name_match_type::SEARCH_NAME
,
1978 block
, domain
, language_asm
, NULL
);
1984 lookup_language_this (const struct language_defn
*lang
,
1985 const struct block
*block
)
1987 if (lang
->name_of_this () == NULL
|| block
== NULL
)
1990 if (symbol_lookup_debug
> 1)
1992 struct objfile
*objfile
= block_objfile (block
);
1994 fprintf_unfiltered (gdb_stdlog
,
1995 "lookup_language_this (%s, %s (objfile %s))",
1996 lang
->name (), host_address_to_string (block
),
1997 objfile_debug_name (objfile
));
2004 sym
= block_lookup_symbol (block
, lang
->name_of_this (),
2005 symbol_name_match_type::SEARCH_NAME
,
2009 if (symbol_lookup_debug
> 1)
2011 fprintf_unfiltered (gdb_stdlog
, " = %s (%s, block %s)\n",
2013 host_address_to_string (sym
),
2014 host_address_to_string (block
));
2016 return (struct block_symbol
) {sym
, block
};
2018 if (BLOCK_FUNCTION (block
))
2020 block
= BLOCK_SUPERBLOCK (block
);
2023 if (symbol_lookup_debug
> 1)
2024 fprintf_unfiltered (gdb_stdlog
, " = NULL\n");
2028 /* Given TYPE, a structure/union,
2029 return 1 if the component named NAME from the ultimate target
2030 structure/union is defined, otherwise, return 0. */
2033 check_field (struct type
*type
, const char *name
,
2034 struct field_of_this_result
*is_a_field_of_this
)
2038 /* The type may be a stub. */
2039 type
= check_typedef (type
);
2041 for (i
= type
->num_fields () - 1; i
>= TYPE_N_BASECLASSES (type
); i
--)
2043 const char *t_field_name
= type
->field (i
).name ();
2045 if (t_field_name
&& (strcmp_iw (t_field_name
, name
) == 0))
2047 is_a_field_of_this
->type
= type
;
2048 is_a_field_of_this
->field
= &type
->field (i
);
2053 /* C++: If it was not found as a data field, then try to return it
2054 as a pointer to a method. */
2056 for (i
= TYPE_NFN_FIELDS (type
) - 1; i
>= 0; --i
)
2058 if (strcmp_iw (TYPE_FN_FIELDLIST_NAME (type
, i
), name
) == 0)
2060 is_a_field_of_this
->type
= type
;
2061 is_a_field_of_this
->fn_field
= &TYPE_FN_FIELDLIST (type
, i
);
2066 for (i
= TYPE_N_BASECLASSES (type
) - 1; i
>= 0; i
--)
2067 if (check_field (TYPE_BASECLASS (type
, i
), name
, is_a_field_of_this
))
2073 /* Behave like lookup_symbol except that NAME is the natural name
2074 (e.g., demangled name) of the symbol that we're looking for. */
2076 static struct block_symbol
2077 lookup_symbol_aux (const char *name
, symbol_name_match_type match_type
,
2078 const struct block
*block
,
2079 const domain_enum domain
, enum language language
,
2080 struct field_of_this_result
*is_a_field_of_this
)
2082 struct block_symbol result
;
2083 const struct language_defn
*langdef
;
2085 if (symbol_lookup_debug
)
2087 struct objfile
*objfile
= (block
== nullptr
2088 ? nullptr : block_objfile (block
));
2090 fprintf_unfiltered (gdb_stdlog
,
2091 "lookup_symbol_aux (%s, %s (objfile %s), %s, %s)\n",
2092 name
, host_address_to_string (block
),
2094 ? objfile_debug_name (objfile
) : "NULL",
2095 domain_name (domain
), language_str (language
));
2098 /* Make sure we do something sensible with is_a_field_of_this, since
2099 the callers that set this parameter to some non-null value will
2100 certainly use it later. If we don't set it, the contents of
2101 is_a_field_of_this are undefined. */
2102 if (is_a_field_of_this
!= NULL
)
2103 memset (is_a_field_of_this
, 0, sizeof (*is_a_field_of_this
));
2105 /* Search specified block and its superiors. Don't search
2106 STATIC_BLOCK or GLOBAL_BLOCK. */
2108 result
= lookup_local_symbol (name
, match_type
, block
, domain
, language
);
2109 if (result
.symbol
!= NULL
)
2111 if (symbol_lookup_debug
)
2113 fprintf_unfiltered (gdb_stdlog
, "lookup_symbol_aux (...) = %s\n",
2114 host_address_to_string (result
.symbol
));
2119 /* If requested to do so by the caller and if appropriate for LANGUAGE,
2120 check to see if NAME is a field of `this'. */
2122 langdef
= language_def (language
);
2124 /* Don't do this check if we are searching for a struct. It will
2125 not be found by check_field, but will be found by other
2127 if (is_a_field_of_this
!= NULL
&& domain
!= STRUCT_DOMAIN
)
2129 result
= lookup_language_this (langdef
, block
);
2133 struct type
*t
= result
.symbol
->type ();
2135 /* I'm not really sure that type of this can ever
2136 be typedefed; just be safe. */
2137 t
= check_typedef (t
);
2138 if (t
->is_pointer_or_reference ())
2139 t
= TYPE_TARGET_TYPE (t
);
2141 if (t
->code () != TYPE_CODE_STRUCT
2142 && t
->code () != TYPE_CODE_UNION
)
2143 error (_("Internal error: `%s' is not an aggregate"),
2144 langdef
->name_of_this ());
2146 if (check_field (t
, name
, is_a_field_of_this
))
2148 if (symbol_lookup_debug
)
2150 fprintf_unfiltered (gdb_stdlog
,
2151 "lookup_symbol_aux (...) = NULL\n");
2158 /* Now do whatever is appropriate for LANGUAGE to look
2159 up static and global variables. */
2161 result
= langdef
->lookup_symbol_nonlocal (name
, block
, domain
);
2162 if (result
.symbol
!= NULL
)
2164 if (symbol_lookup_debug
)
2166 fprintf_unfiltered (gdb_stdlog
, "lookup_symbol_aux (...) = %s\n",
2167 host_address_to_string (result
.symbol
));
2172 /* Now search all static file-level symbols. Not strictly correct,
2173 but more useful than an error. */
2175 result
= lookup_static_symbol (name
, domain
);
2176 if (symbol_lookup_debug
)
2178 fprintf_unfiltered (gdb_stdlog
, "lookup_symbol_aux (...) = %s\n",
2179 result
.symbol
!= NULL
2180 ? host_address_to_string (result
.symbol
)
2186 /* Check to see if the symbol is defined in BLOCK or its superiors.
2187 Don't search STATIC_BLOCK or GLOBAL_BLOCK. */
2189 static struct block_symbol
2190 lookup_local_symbol (const char *name
,
2191 symbol_name_match_type match_type
,
2192 const struct block
*block
,
2193 const domain_enum domain
,
2194 enum language language
)
2197 const struct block
*static_block
= block_static_block (block
);
2198 const char *scope
= block_scope (block
);
2200 /* Check if either no block is specified or it's a global block. */
2202 if (static_block
== NULL
)
2205 while (block
!= static_block
)
2207 sym
= lookup_symbol_in_block (name
, match_type
, block
, domain
);
2209 return (struct block_symbol
) {sym
, block
};
2211 if (language
== language_cplus
|| language
== language_fortran
)
2213 struct block_symbol blocksym
2214 = cp_lookup_symbol_imports_or_template (scope
, name
, block
,
2217 if (blocksym
.symbol
!= NULL
)
2221 if (BLOCK_FUNCTION (block
) != NULL
&& block_inlined_p (block
))
2223 block
= BLOCK_SUPERBLOCK (block
);
2226 /* We've reached the end of the function without finding a result. */
2234 lookup_symbol_in_block (const char *name
, symbol_name_match_type match_type
,
2235 const struct block
*block
,
2236 const domain_enum domain
)
2240 if (symbol_lookup_debug
> 1)
2242 struct objfile
*objfile
= (block
== nullptr
2243 ? nullptr : block_objfile (block
));
2245 fprintf_unfiltered (gdb_stdlog
,
2246 "lookup_symbol_in_block (%s, %s (objfile %s), %s)",
2247 name
, host_address_to_string (block
),
2248 objfile_debug_name (objfile
),
2249 domain_name (domain
));
2252 sym
= block_lookup_symbol (block
, name
, match_type
, domain
);
2255 if (symbol_lookup_debug
> 1)
2257 fprintf_unfiltered (gdb_stdlog
, " = %s\n",
2258 host_address_to_string (sym
));
2260 return fixup_symbol_section (sym
, NULL
);
2263 if (symbol_lookup_debug
> 1)
2264 fprintf_unfiltered (gdb_stdlog
, " = NULL\n");
2271 lookup_global_symbol_from_objfile (struct objfile
*main_objfile
,
2272 enum block_enum block_index
,
2274 const domain_enum domain
)
2276 gdb_assert (block_index
== GLOBAL_BLOCK
|| block_index
== STATIC_BLOCK
);
2278 for (objfile
*objfile
: main_objfile
->separate_debug_objfiles ())
2280 struct block_symbol result
2281 = lookup_symbol_in_objfile (objfile
, block_index
, name
, domain
);
2283 if (result
.symbol
!= nullptr)
2290 /* Check to see if the symbol is defined in one of the OBJFILE's
2291 symtabs. BLOCK_INDEX should be either GLOBAL_BLOCK or STATIC_BLOCK,
2292 depending on whether or not we want to search global symbols or
2295 static struct block_symbol
2296 lookup_symbol_in_objfile_symtabs (struct objfile
*objfile
,
2297 enum block_enum block_index
, const char *name
,
2298 const domain_enum domain
)
2300 gdb_assert (block_index
== GLOBAL_BLOCK
|| block_index
== STATIC_BLOCK
);
2302 if (symbol_lookup_debug
> 1)
2304 fprintf_unfiltered (gdb_stdlog
,
2305 "lookup_symbol_in_objfile_symtabs (%s, %s, %s, %s)",
2306 objfile_debug_name (objfile
),
2307 block_index
== GLOBAL_BLOCK
2308 ? "GLOBAL_BLOCK" : "STATIC_BLOCK",
2309 name
, domain_name (domain
));
2312 struct block_symbol other
;
2313 other
.symbol
= NULL
;
2314 for (compunit_symtab
*cust
: objfile
->compunits ())
2316 const struct blockvector
*bv
;
2317 const struct block
*block
;
2318 struct block_symbol result
;
2320 bv
= cust
->blockvector ();
2321 block
= BLOCKVECTOR_BLOCK (bv
, block_index
);
2322 result
.symbol
= block_lookup_symbol_primary (block
, name
, domain
);
2323 result
.block
= block
;
2324 if (result
.symbol
== NULL
)
2326 if (best_symbol (result
.symbol
, domain
))
2331 if (symbol_matches_domain (result
.symbol
->language (),
2332 result
.symbol
->domain (), domain
))
2334 struct symbol
*better
2335 = better_symbol (other
.symbol
, result
.symbol
, domain
);
2336 if (better
!= other
.symbol
)
2338 other
.symbol
= better
;
2339 other
.block
= block
;
2344 if (other
.symbol
!= NULL
)
2346 if (symbol_lookup_debug
> 1)
2348 fprintf_unfiltered (gdb_stdlog
, " = %s (block %s)\n",
2349 host_address_to_string (other
.symbol
),
2350 host_address_to_string (other
.block
));
2352 other
.symbol
= fixup_symbol_section (other
.symbol
, objfile
);
2356 if (symbol_lookup_debug
> 1)
2357 fprintf_unfiltered (gdb_stdlog
, " = NULL\n");
2361 /* Wrapper around lookup_symbol_in_objfile_symtabs for search_symbols.
2362 Look up LINKAGE_NAME in DOMAIN in the global and static blocks of OBJFILE
2363 and all associated separate debug objfiles.
2365 Normally we only look in OBJFILE, and not any separate debug objfiles
2366 because the outer loop will cause them to be searched too. This case is
2367 different. Here we're called from search_symbols where it will only
2368 call us for the objfile that contains a matching minsym. */
2370 static struct block_symbol
2371 lookup_symbol_in_objfile_from_linkage_name (struct objfile
*objfile
,
2372 const char *linkage_name
,
2375 enum language lang
= current_language
->la_language
;
2376 struct objfile
*main_objfile
;
2378 demangle_result_storage storage
;
2379 const char *modified_name
= demangle_for_lookup (linkage_name
, lang
, storage
);
2381 if (objfile
->separate_debug_objfile_backlink
)
2382 main_objfile
= objfile
->separate_debug_objfile_backlink
;
2384 main_objfile
= objfile
;
2386 for (::objfile
*cur_objfile
: main_objfile
->separate_debug_objfiles ())
2388 struct block_symbol result
;
2390 result
= lookup_symbol_in_objfile_symtabs (cur_objfile
, GLOBAL_BLOCK
,
2391 modified_name
, domain
);
2392 if (result
.symbol
== NULL
)
2393 result
= lookup_symbol_in_objfile_symtabs (cur_objfile
, STATIC_BLOCK
,
2394 modified_name
, domain
);
2395 if (result
.symbol
!= NULL
)
2402 /* A helper function that throws an exception when a symbol was found
2403 in a psymtab but not in a symtab. */
2405 static void ATTRIBUTE_NORETURN
2406 error_in_psymtab_expansion (enum block_enum block_index
, const char *name
,
2407 struct compunit_symtab
*cust
)
2410 Internal: %s symbol `%s' found in %s psymtab but not in symtab.\n\
2411 %s may be an inlined function, or may be a template function\n \
2412 (if a template, try specifying an instantiation: %s<type>)."),
2413 block_index
== GLOBAL_BLOCK
? "global" : "static",
2415 symtab_to_filename_for_display (cust
->primary_filetab ()),
2419 /* A helper function for various lookup routines that interfaces with
2420 the "quick" symbol table functions. */
2422 static struct block_symbol
2423 lookup_symbol_via_quick_fns (struct objfile
*objfile
,
2424 enum block_enum block_index
, const char *name
,
2425 const domain_enum domain
)
2427 struct compunit_symtab
*cust
;
2428 const struct blockvector
*bv
;
2429 const struct block
*block
;
2430 struct block_symbol result
;
2432 if (symbol_lookup_debug
> 1)
2434 fprintf_unfiltered (gdb_stdlog
,
2435 "lookup_symbol_via_quick_fns (%s, %s, %s, %s)\n",
2436 objfile_debug_name (objfile
),
2437 block_index
== GLOBAL_BLOCK
2438 ? "GLOBAL_BLOCK" : "STATIC_BLOCK",
2439 name
, domain_name (domain
));
2442 cust
= objfile
->lookup_symbol (block_index
, name
, domain
);
2445 if (symbol_lookup_debug
> 1)
2447 fprintf_unfiltered (gdb_stdlog
,
2448 "lookup_symbol_via_quick_fns (...) = NULL\n");
2453 bv
= cust
->blockvector ();
2454 block
= BLOCKVECTOR_BLOCK (bv
, block_index
);
2455 result
.symbol
= block_lookup_symbol (block
, name
,
2456 symbol_name_match_type::FULL
, domain
);
2457 if (result
.symbol
== NULL
)
2458 error_in_psymtab_expansion (block_index
, name
, cust
);
2460 if (symbol_lookup_debug
> 1)
2462 fprintf_unfiltered (gdb_stdlog
,
2463 "lookup_symbol_via_quick_fns (...) = %s (block %s)\n",
2464 host_address_to_string (result
.symbol
),
2465 host_address_to_string (block
));
2468 result
.symbol
= fixup_symbol_section (result
.symbol
, objfile
);
2469 result
.block
= block
;
2473 /* See language.h. */
2476 language_defn::lookup_symbol_nonlocal (const char *name
,
2477 const struct block
*block
,
2478 const domain_enum domain
) const
2480 struct block_symbol result
;
2482 /* NOTE: dje/2014-10-26: The lookup in all objfiles search could skip
2483 the current objfile. Searching the current objfile first is useful
2484 for both matching user expectations as well as performance. */
2486 result
= lookup_symbol_in_static_block (name
, block
, domain
);
2487 if (result
.symbol
!= NULL
)
2490 /* If we didn't find a definition for a builtin type in the static block,
2491 search for it now. This is actually the right thing to do and can be
2492 a massive performance win. E.g., when debugging a program with lots of
2493 shared libraries we could search all of them only to find out the
2494 builtin type isn't defined in any of them. This is common for types
2496 if (domain
== VAR_DOMAIN
)
2498 struct gdbarch
*gdbarch
;
2501 gdbarch
= target_gdbarch ();
2503 gdbarch
= block_gdbarch (block
);
2504 result
.symbol
= language_lookup_primitive_type_as_symbol (this,
2506 result
.block
= NULL
;
2507 if (result
.symbol
!= NULL
)
2511 return lookup_global_symbol (name
, block
, domain
);
2517 lookup_symbol_in_static_block (const char *name
,
2518 const struct block
*block
,
2519 const domain_enum domain
)
2521 const struct block
*static_block
= block_static_block (block
);
2524 if (static_block
== NULL
)
2527 if (symbol_lookup_debug
)
2529 struct objfile
*objfile
= (block
== nullptr
2530 ? nullptr : block_objfile (block
));
2532 fprintf_unfiltered (gdb_stdlog
,
2533 "lookup_symbol_in_static_block (%s, %s (objfile %s),"
2536 host_address_to_string (block
),
2537 objfile_debug_name (objfile
),
2538 domain_name (domain
));
2541 sym
= lookup_symbol_in_block (name
,
2542 symbol_name_match_type::FULL
,
2543 static_block
, domain
);
2544 if (symbol_lookup_debug
)
2546 fprintf_unfiltered (gdb_stdlog
,
2547 "lookup_symbol_in_static_block (...) = %s\n",
2548 sym
!= NULL
? host_address_to_string (sym
) : "NULL");
2550 return (struct block_symbol
) {sym
, static_block
};
2553 /* Perform the standard symbol lookup of NAME in OBJFILE:
2554 1) First search expanded symtabs, and if not found
2555 2) Search the "quick" symtabs (partial or .gdb_index).
2556 BLOCK_INDEX is one of GLOBAL_BLOCK or STATIC_BLOCK. */
2558 static struct block_symbol
2559 lookup_symbol_in_objfile (struct objfile
*objfile
, enum block_enum block_index
,
2560 const char *name
, const domain_enum domain
)
2562 struct block_symbol result
;
2564 gdb_assert (block_index
== GLOBAL_BLOCK
|| block_index
== STATIC_BLOCK
);
2566 if (symbol_lookup_debug
)
2568 fprintf_unfiltered (gdb_stdlog
,
2569 "lookup_symbol_in_objfile (%s, %s, %s, %s)\n",
2570 objfile_debug_name (objfile
),
2571 block_index
== GLOBAL_BLOCK
2572 ? "GLOBAL_BLOCK" : "STATIC_BLOCK",
2573 name
, domain_name (domain
));
2576 result
= lookup_symbol_in_objfile_symtabs (objfile
, block_index
,
2578 if (result
.symbol
!= NULL
)
2580 if (symbol_lookup_debug
)
2582 fprintf_unfiltered (gdb_stdlog
,
2583 "lookup_symbol_in_objfile (...) = %s"
2585 host_address_to_string (result
.symbol
));
2590 result
= lookup_symbol_via_quick_fns (objfile
, block_index
,
2592 if (symbol_lookup_debug
)
2594 fprintf_unfiltered (gdb_stdlog
,
2595 "lookup_symbol_in_objfile (...) = %s%s\n",
2596 result
.symbol
!= NULL
2597 ? host_address_to_string (result
.symbol
)
2599 result
.symbol
!= NULL
? " (via quick fns)" : "");
2604 /* Find the language for partial symbol with NAME. */
2606 static enum language
2607 find_quick_global_symbol_language (const char *name
, const domain_enum domain
)
2609 for (objfile
*objfile
: current_program_space
->objfiles ())
2611 bool symbol_found_p
;
2613 = objfile
->lookup_global_symbol_language (name
, domain
, &symbol_found_p
);
2618 return language_unknown
;
2621 /* Private data to be used with lookup_symbol_global_iterator_cb. */
2623 struct global_or_static_sym_lookup_data
2625 /* The name of the symbol we are searching for. */
2628 /* The domain to use for our search. */
2631 /* The block index in which to search. */
2632 enum block_enum block_index
;
2634 /* The field where the callback should store the symbol if found.
2635 It should be initialized to {NULL, NULL} before the search is started. */
2636 struct block_symbol result
;
2639 /* A callback function for gdbarch_iterate_over_objfiles_in_search_order.
2640 It searches by name for a symbol in the block given by BLOCK_INDEX of the
2641 given OBJFILE. The arguments for the search are passed via CB_DATA, which
2642 in reality is a pointer to struct global_or_static_sym_lookup_data. */
2645 lookup_symbol_global_or_static_iterator_cb (struct objfile
*objfile
,
2648 struct global_or_static_sym_lookup_data
*data
=
2649 (struct global_or_static_sym_lookup_data
*) cb_data
;
2651 gdb_assert (data
->result
.symbol
== NULL
2652 && data
->result
.block
== NULL
);
2654 data
->result
= lookup_symbol_in_objfile (objfile
, data
->block_index
,
2655 data
->name
, data
->domain
);
2657 /* If we found a match, tell the iterator to stop. Otherwise,
2659 return (data
->result
.symbol
!= NULL
);
2662 /* This function contains the common code of lookup_{global,static}_symbol.
2663 OBJFILE is only used if BLOCK_INDEX is GLOBAL_SCOPE, in which case it is
2664 the objfile to start the lookup in. */
2666 static struct block_symbol
2667 lookup_global_or_static_symbol (const char *name
,
2668 enum block_enum block_index
,
2669 struct objfile
*objfile
,
2670 const domain_enum domain
)
2672 struct symbol_cache
*cache
= get_symbol_cache (current_program_space
);
2673 struct block_symbol result
;
2674 struct global_or_static_sym_lookup_data lookup_data
;
2675 struct block_symbol_cache
*bsc
;
2676 struct symbol_cache_slot
*slot
;
2678 gdb_assert (block_index
== GLOBAL_BLOCK
|| block_index
== STATIC_BLOCK
);
2679 gdb_assert (objfile
== nullptr || block_index
== GLOBAL_BLOCK
);
2681 /* First see if we can find the symbol in the cache.
2682 This works because we use the current objfile to qualify the lookup. */
2683 result
= symbol_cache_lookup (cache
, objfile
, block_index
, name
, domain
,
2685 if (result
.symbol
!= NULL
)
2687 if (SYMBOL_LOOKUP_FAILED_P (result
))
2692 /* Do a global search (of global blocks, heh). */
2693 if (result
.symbol
== NULL
)
2695 memset (&lookup_data
, 0, sizeof (lookup_data
));
2696 lookup_data
.name
= name
;
2697 lookup_data
.block_index
= block_index
;
2698 lookup_data
.domain
= domain
;
2699 gdbarch_iterate_over_objfiles_in_search_order
2700 (objfile
!= NULL
? objfile
->arch () : target_gdbarch (),
2701 lookup_symbol_global_or_static_iterator_cb
, &lookup_data
, objfile
);
2702 result
= lookup_data
.result
;
2705 if (result
.symbol
!= NULL
)
2706 symbol_cache_mark_found (bsc
, slot
, objfile
, result
.symbol
, result
.block
);
2708 symbol_cache_mark_not_found (bsc
, slot
, objfile
, name
, domain
);
2716 lookup_static_symbol (const char *name
, const domain_enum domain
)
2718 return lookup_global_or_static_symbol (name
, STATIC_BLOCK
, nullptr, domain
);
2724 lookup_global_symbol (const char *name
,
2725 const struct block
*block
,
2726 const domain_enum domain
)
2728 /* If a block was passed in, we want to search the corresponding
2729 global block first. This yields "more expected" behavior, and is
2730 needed to support 'FILENAME'::VARIABLE lookups. */
2731 const struct block
*global_block
= block_global_block (block
);
2733 if (global_block
!= nullptr)
2735 sym
= lookup_symbol_in_block (name
,
2736 symbol_name_match_type::FULL
,
2737 global_block
, domain
);
2738 if (sym
!= NULL
&& best_symbol (sym
, domain
))
2739 return { sym
, global_block
};
2742 struct objfile
*objfile
= nullptr;
2743 if (block
!= nullptr)
2745 objfile
= block_objfile (block
);
2746 if (objfile
->separate_debug_objfile_backlink
!= nullptr)
2747 objfile
= objfile
->separate_debug_objfile_backlink
;
2751 = lookup_global_or_static_symbol (name
, GLOBAL_BLOCK
, objfile
, domain
);
2752 if (better_symbol (sym
, bs
.symbol
, domain
) == sym
)
2753 return { sym
, global_block
};
2759 symbol_matches_domain (enum language symbol_language
,
2760 domain_enum symbol_domain
,
2763 /* For C++ "struct foo { ... }" also defines a typedef for "foo".
2764 Similarly, any Ada type declaration implicitly defines a typedef. */
2765 if (symbol_language
== language_cplus
2766 || symbol_language
== language_d
2767 || symbol_language
== language_ada
2768 || symbol_language
== language_rust
)
2770 if ((domain
== VAR_DOMAIN
|| domain
== STRUCT_DOMAIN
)
2771 && symbol_domain
== STRUCT_DOMAIN
)
2774 /* For all other languages, strict match is required. */
2775 return (symbol_domain
== domain
);
2781 lookup_transparent_type (const char *name
)
2783 return current_language
->lookup_transparent_type (name
);
2786 /* A helper for basic_lookup_transparent_type that interfaces with the
2787 "quick" symbol table functions. */
2789 static struct type
*
2790 basic_lookup_transparent_type_quick (struct objfile
*objfile
,
2791 enum block_enum block_index
,
2794 struct compunit_symtab
*cust
;
2795 const struct blockvector
*bv
;
2796 const struct block
*block
;
2799 cust
= objfile
->lookup_symbol (block_index
, name
, STRUCT_DOMAIN
);
2803 bv
= cust
->blockvector ();
2804 block
= BLOCKVECTOR_BLOCK (bv
, block_index
);
2805 sym
= block_find_symbol (block
, name
, STRUCT_DOMAIN
,
2806 block_find_non_opaque_type
, NULL
);
2808 error_in_psymtab_expansion (block_index
, name
, cust
);
2809 gdb_assert (!TYPE_IS_OPAQUE (sym
->type ()));
2810 return sym
->type ();
2813 /* Subroutine of basic_lookup_transparent_type to simplify it.
2814 Look up the non-opaque definition of NAME in BLOCK_INDEX of OBJFILE.
2815 BLOCK_INDEX is either GLOBAL_BLOCK or STATIC_BLOCK. */
2817 static struct type
*
2818 basic_lookup_transparent_type_1 (struct objfile
*objfile
,
2819 enum block_enum block_index
,
2822 const struct blockvector
*bv
;
2823 const struct block
*block
;
2824 const struct symbol
*sym
;
2826 for (compunit_symtab
*cust
: objfile
->compunits ())
2828 bv
= cust
->blockvector ();
2829 block
= BLOCKVECTOR_BLOCK (bv
, block_index
);
2830 sym
= block_find_symbol (block
, name
, STRUCT_DOMAIN
,
2831 block_find_non_opaque_type
, NULL
);
2834 gdb_assert (!TYPE_IS_OPAQUE (sym
->type ()));
2835 return sym
->type ();
2842 /* The standard implementation of lookup_transparent_type. This code
2843 was modeled on lookup_symbol -- the parts not relevant to looking
2844 up types were just left out. In particular it's assumed here that
2845 types are available in STRUCT_DOMAIN and only in file-static or
2849 basic_lookup_transparent_type (const char *name
)
2853 /* Now search all the global symbols. Do the symtab's first, then
2854 check the psymtab's. If a psymtab indicates the existence
2855 of the desired name as a global, then do psymtab-to-symtab
2856 conversion on the fly and return the found symbol. */
2858 for (objfile
*objfile
: current_program_space
->objfiles ())
2860 t
= basic_lookup_transparent_type_1 (objfile
, GLOBAL_BLOCK
, name
);
2865 for (objfile
*objfile
: current_program_space
->objfiles ())
2867 t
= basic_lookup_transparent_type_quick (objfile
, GLOBAL_BLOCK
, name
);
2872 /* Now search the static file-level symbols.
2873 Not strictly correct, but more useful than an error.
2874 Do the symtab's first, then
2875 check the psymtab's. If a psymtab indicates the existence
2876 of the desired name as a file-level static, then do psymtab-to-symtab
2877 conversion on the fly and return the found symbol. */
2879 for (objfile
*objfile
: current_program_space
->objfiles ())
2881 t
= basic_lookup_transparent_type_1 (objfile
, STATIC_BLOCK
, name
);
2886 for (objfile
*objfile
: current_program_space
->objfiles ())
2888 t
= basic_lookup_transparent_type_quick (objfile
, STATIC_BLOCK
, name
);
2893 return (struct type
*) 0;
2899 iterate_over_symbols (const struct block
*block
,
2900 const lookup_name_info
&name
,
2901 const domain_enum domain
,
2902 gdb::function_view
<symbol_found_callback_ftype
> callback
)
2904 struct block_iterator iter
;
2907 ALL_BLOCK_SYMBOLS_WITH_NAME (block
, name
, iter
, sym
)
2909 if (symbol_matches_domain (sym
->language (), sym
->domain (), domain
))
2911 struct block_symbol block_sym
= {sym
, block
};
2913 if (!callback (&block_sym
))
2923 iterate_over_symbols_terminated
2924 (const struct block
*block
,
2925 const lookup_name_info
&name
,
2926 const domain_enum domain
,
2927 gdb::function_view
<symbol_found_callback_ftype
> callback
)
2929 if (!iterate_over_symbols (block
, name
, domain
, callback
))
2931 struct block_symbol block_sym
= {nullptr, block
};
2932 return callback (&block_sym
);
2935 /* Find the compunit symtab associated with PC and SECTION.
2936 This will read in debug info as necessary. */
2938 struct compunit_symtab
*
2939 find_pc_sect_compunit_symtab (CORE_ADDR pc
, struct obj_section
*section
)
2941 struct compunit_symtab
*best_cust
= NULL
;
2942 CORE_ADDR best_cust_range
= 0;
2943 struct bound_minimal_symbol msymbol
;
2945 /* If we know that this is not a text address, return failure. This is
2946 necessary because we loop based on the block's high and low code
2947 addresses, which do not include the data ranges, and because
2948 we call find_pc_sect_psymtab which has a similar restriction based
2949 on the partial_symtab's texthigh and textlow. */
2950 msymbol
= lookup_minimal_symbol_by_pc_section (pc
, section
);
2951 if (msymbol
.minsym
&& msymbol
.minsym
->data_p ())
2954 /* Search all symtabs for the one whose file contains our address, and which
2955 is the smallest of all the ones containing the address. This is designed
2956 to deal with a case like symtab a is at 0x1000-0x2000 and 0x3000-0x4000
2957 and symtab b is at 0x2000-0x3000. So the GLOBAL_BLOCK for a is from
2958 0x1000-0x4000, but for address 0x2345 we want to return symtab b.
2960 This happens for native ecoff format, where code from included files
2961 gets its own symtab. The symtab for the included file should have
2962 been read in already via the dependency mechanism.
2963 It might be swifter to create several symtabs with the same name
2964 like xcoff does (I'm not sure).
2966 It also happens for objfiles that have their functions reordered.
2967 For these, the symtab we are looking for is not necessarily read in. */
2969 for (objfile
*obj_file
: current_program_space
->objfiles ())
2971 for (compunit_symtab
*cust
: obj_file
->compunits ())
2973 const struct blockvector
*bv
= cust
->blockvector ();
2974 const struct block
*global_block
2975 = BLOCKVECTOR_BLOCK (bv
, GLOBAL_BLOCK
);
2976 CORE_ADDR start
= BLOCK_START (global_block
);
2977 CORE_ADDR end
= BLOCK_END (global_block
);
2978 bool in_range_p
= start
<= pc
&& pc
< end
;
2982 if (BLOCKVECTOR_MAP (bv
))
2984 if (addrmap_find (BLOCKVECTOR_MAP (bv
), pc
) == nullptr)
2990 CORE_ADDR range
= end
- start
;
2991 if (best_cust
!= nullptr
2992 && range
>= best_cust_range
)
2993 /* Cust doesn't have a smaller range than best_cust, skip it. */
2996 /* For an objfile that has its functions reordered,
2997 find_pc_psymtab will find the proper partial symbol table
2998 and we simply return its corresponding symtab. */
2999 /* In order to better support objfiles that contain both
3000 stabs and coff debugging info, we continue on if a psymtab
3002 if ((obj_file
->flags
& OBJF_REORDERED
) != 0)
3004 struct compunit_symtab
*result
;
3007 = obj_file
->find_pc_sect_compunit_symtab (msymbol
,
3017 struct symbol
*sym
= NULL
;
3018 struct block_iterator iter
;
3020 for (int b_index
= GLOBAL_BLOCK
;
3021 b_index
<= STATIC_BLOCK
&& sym
== NULL
;
3024 const struct block
*b
= BLOCKVECTOR_BLOCK (bv
, b_index
);
3025 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
3027 fixup_symbol_section (sym
, obj_file
);
3028 if (matching_obj_sections (sym
->obj_section (obj_file
),
3034 continue; /* No symbol in this symtab matches
3038 /* Cust is best found sofar, save it. */
3040 best_cust_range
= range
;
3044 if (best_cust
!= NULL
)
3047 /* Not found in symtabs, search the "quick" symtabs (e.g. psymtabs). */
3049 for (objfile
*objf
: current_program_space
->objfiles ())
3051 struct compunit_symtab
*result
3052 = objf
->find_pc_sect_compunit_symtab (msymbol
, pc
, section
, 1);
3060 /* Find the compunit symtab associated with PC.
3061 This will read in debug info as necessary.
3062 Backward compatibility, no section. */
3064 struct compunit_symtab
*
3065 find_pc_compunit_symtab (CORE_ADDR pc
)
3067 return find_pc_sect_compunit_symtab (pc
, find_pc_mapped_section (pc
));
3073 find_symbol_at_address (CORE_ADDR address
)
3075 /* A helper function to search a given symtab for a symbol matching
3077 auto search_symtab
= [] (compunit_symtab
*symtab
, CORE_ADDR addr
) -> symbol
*
3079 const struct blockvector
*bv
= symtab
->blockvector ();
3081 for (int i
= GLOBAL_BLOCK
; i
<= STATIC_BLOCK
; ++i
)
3083 const struct block
*b
= BLOCKVECTOR_BLOCK (bv
, i
);
3084 struct block_iterator iter
;
3087 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
3089 if (sym
->aclass () == LOC_STATIC
3090 && SYMBOL_VALUE_ADDRESS (sym
) == addr
)
3097 for (objfile
*objfile
: current_program_space
->objfiles ())
3099 /* If this objfile was read with -readnow, then we need to
3100 search the symtabs directly. */
3101 if ((objfile
->flags
& OBJF_READNOW
) != 0)
3103 for (compunit_symtab
*symtab
: objfile
->compunits ())
3105 struct symbol
*sym
= search_symtab (symtab
, address
);
3112 struct compunit_symtab
*symtab
3113 = objfile
->find_compunit_symtab_by_address (address
);
3116 struct symbol
*sym
= search_symtab (symtab
, address
);
3128 /* Find the source file and line number for a given PC value and SECTION.
3129 Return a structure containing a symtab pointer, a line number,
3130 and a pc range for the entire source line.
3131 The value's .pc field is NOT the specified pc.
3132 NOTCURRENT nonzero means, if specified pc is on a line boundary,
3133 use the line that ends there. Otherwise, in that case, the line
3134 that begins there is used. */
3136 /* The big complication here is that a line may start in one file, and end just
3137 before the start of another file. This usually occurs when you #include
3138 code in the middle of a subroutine. To properly find the end of a line's PC
3139 range, we must search all symtabs associated with this compilation unit, and
3140 find the one whose first PC is closer than that of the next line in this
3143 struct symtab_and_line
3144 find_pc_sect_line (CORE_ADDR pc
, struct obj_section
*section
, int notcurrent
)
3146 struct compunit_symtab
*cust
;
3147 struct linetable
*l
;
3149 struct linetable_entry
*item
;
3150 const struct blockvector
*bv
;
3151 struct bound_minimal_symbol msymbol
;
3153 /* Info on best line seen so far, and where it starts, and its file. */
3155 struct linetable_entry
*best
= NULL
;
3156 CORE_ADDR best_end
= 0;
3157 struct symtab
*best_symtab
= 0;
3159 /* Store here the first line number
3160 of a file which contains the line at the smallest pc after PC.
3161 If we don't find a line whose range contains PC,
3162 we will use a line one less than this,
3163 with a range from the start of that file to the first line's pc. */
3164 struct linetable_entry
*alt
= NULL
;
3166 /* Info on best line seen in this file. */
3168 struct linetable_entry
*prev
;
3170 /* If this pc is not from the current frame,
3171 it is the address of the end of a call instruction.
3172 Quite likely that is the start of the following statement.
3173 But what we want is the statement containing the instruction.
3174 Fudge the pc to make sure we get that. */
3176 /* It's tempting to assume that, if we can't find debugging info for
3177 any function enclosing PC, that we shouldn't search for line
3178 number info, either. However, GAS can emit line number info for
3179 assembly files --- very helpful when debugging hand-written
3180 assembly code. In such a case, we'd have no debug info for the
3181 function, but we would have line info. */
3186 /* elz: added this because this function returned the wrong
3187 information if the pc belongs to a stub (import/export)
3188 to call a shlib function. This stub would be anywhere between
3189 two functions in the target, and the line info was erroneously
3190 taken to be the one of the line before the pc. */
3192 /* RT: Further explanation:
3194 * We have stubs (trampolines) inserted between procedures.
3196 * Example: "shr1" exists in a shared library, and a "shr1" stub also
3197 * exists in the main image.
3199 * In the minimal symbol table, we have a bunch of symbols
3200 * sorted by start address. The stubs are marked as "trampoline",
3201 * the others appear as text. E.g.:
3203 * Minimal symbol table for main image
3204 * main: code for main (text symbol)
3205 * shr1: stub (trampoline symbol)
3206 * foo: code for foo (text symbol)
3208 * Minimal symbol table for "shr1" image:
3210 * shr1: code for shr1 (text symbol)
3213 * So the code below is trying to detect if we are in the stub
3214 * ("shr1" stub), and if so, find the real code ("shr1" trampoline),
3215 * and if found, do the symbolization from the real-code address
3216 * rather than the stub address.
3218 * Assumptions being made about the minimal symbol table:
3219 * 1. lookup_minimal_symbol_by_pc() will return a trampoline only
3220 * if we're really in the trampoline.s If we're beyond it (say
3221 * we're in "foo" in the above example), it'll have a closer
3222 * symbol (the "foo" text symbol for example) and will not
3223 * return the trampoline.
3224 * 2. lookup_minimal_symbol_text() will find a real text symbol
3225 * corresponding to the trampoline, and whose address will
3226 * be different than the trampoline address. I put in a sanity
3227 * check for the address being the same, to avoid an
3228 * infinite recursion.
3230 msymbol
= lookup_minimal_symbol_by_pc (pc
);
3231 if (msymbol
.minsym
!= NULL
)
3232 if (MSYMBOL_TYPE (msymbol
.minsym
) == mst_solib_trampoline
)
3234 struct bound_minimal_symbol mfunsym
3235 = lookup_minimal_symbol_text (msymbol
.minsym
->linkage_name (),
3238 if (mfunsym
.minsym
== NULL
)
3239 /* I eliminated this warning since it is coming out
3240 * in the following situation:
3241 * gdb shmain // test program with shared libraries
3242 * (gdb) break shr1 // function in shared lib
3243 * Warning: In stub for ...
3244 * In the above situation, the shared lib is not loaded yet,
3245 * so of course we can't find the real func/line info,
3246 * but the "break" still works, and the warning is annoying.
3247 * So I commented out the warning. RT */
3248 /* warning ("In stub for %s; unable to find real function/line info",
3249 msymbol->linkage_name ()); */
3252 else if (BMSYMBOL_VALUE_ADDRESS (mfunsym
)
3253 == BMSYMBOL_VALUE_ADDRESS (msymbol
))
3254 /* Avoid infinite recursion */
3255 /* See above comment about why warning is commented out. */
3256 /* warning ("In stub for %s; unable to find real function/line info",
3257 msymbol->linkage_name ()); */
3262 /* Detect an obvious case of infinite recursion. If this
3263 should occur, we'd like to know about it, so error out,
3265 if (BMSYMBOL_VALUE_ADDRESS (mfunsym
) == pc
)
3266 internal_error (__FILE__
, __LINE__
,
3267 _("Infinite recursion detected in find_pc_sect_line;"
3268 "please file a bug report"));
3270 return find_pc_line (BMSYMBOL_VALUE_ADDRESS (mfunsym
), 0);
3274 symtab_and_line val
;
3275 val
.pspace
= current_program_space
;
3277 cust
= find_pc_sect_compunit_symtab (pc
, section
);
3280 /* If no symbol information, return previous pc. */
3287 bv
= cust
->blockvector ();
3289 /* Look at all the symtabs that share this blockvector.
3290 They all have the same apriori range, that we found was right;
3291 but they have different line tables. */
3293 for (symtab
*iter_s
: cust
->filetabs ())
3295 /* Find the best line in this symtab. */
3296 l
= iter_s
->linetable ();
3302 /* I think len can be zero if the symtab lacks line numbers
3303 (e.g. gcc -g1). (Either that or the LINETABLE is NULL;
3304 I'm not sure which, and maybe it depends on the symbol
3310 item
= l
->item
; /* Get first line info. */
3312 /* Is this file's first line closer than the first lines of other files?
3313 If so, record this file, and its first line, as best alternate. */
3314 if (item
->pc
> pc
&& (!alt
|| item
->pc
< alt
->pc
))
3317 auto pc_compare
= [](const CORE_ADDR
& comp_pc
,
3318 const struct linetable_entry
& lhs
)->bool
3320 return comp_pc
< lhs
.pc
;
3323 struct linetable_entry
*first
= item
;
3324 struct linetable_entry
*last
= item
+ len
;
3325 item
= std::upper_bound (first
, last
, pc
, pc_compare
);
3327 prev
= item
- 1; /* Found a matching item. */
3329 /* At this point, prev points at the line whose start addr is <= pc, and
3330 item points at the next line. If we ran off the end of the linetable
3331 (pc >= start of the last line), then prev == item. If pc < start of
3332 the first line, prev will not be set. */
3334 /* Is this file's best line closer than the best in the other files?
3335 If so, record this file, and its best line, as best so far. Don't
3336 save prev if it represents the end of a function (i.e. line number
3337 0) instead of a real line. */
3339 if (prev
&& prev
->line
&& (!best
|| prev
->pc
> best
->pc
))
3342 best_symtab
= iter_s
;
3344 /* If during the binary search we land on a non-statement entry,
3345 scan backward through entries at the same address to see if
3346 there is an entry marked as is-statement. In theory this
3347 duplication should have been removed from the line table
3348 during construction, this is just a double check. If the line
3349 table has had the duplication removed then this should be
3353 struct linetable_entry
*tmp
= best
;
3354 while (tmp
> first
&& (tmp
- 1)->pc
== tmp
->pc
3355 && (tmp
- 1)->line
!= 0 && !tmp
->is_stmt
)
3361 /* Discard BEST_END if it's before the PC of the current BEST. */
3362 if (best_end
<= best
->pc
)
3366 /* If another line (denoted by ITEM) is in the linetable and its
3367 PC is after BEST's PC, but before the current BEST_END, then
3368 use ITEM's PC as the new best_end. */
3369 if (best
&& item
< last
&& item
->pc
> best
->pc
3370 && (best_end
== 0 || best_end
> item
->pc
))
3371 best_end
= item
->pc
;
3376 /* If we didn't find any line number info, just return zeros.
3377 We used to return alt->line - 1 here, but that could be
3378 anywhere; if we don't have line number info for this PC,
3379 don't make some up. */
3382 else if (best
->line
== 0)
3384 /* If our best fit is in a range of PC's for which no line
3385 number info is available (line number is zero) then we didn't
3386 find any valid line information. */
3391 val
.is_stmt
= best
->is_stmt
;
3392 val
.symtab
= best_symtab
;
3393 val
.line
= best
->line
;
3395 if (best_end
&& (!alt
|| best_end
< alt
->pc
))
3400 val
.end
= BLOCK_END (BLOCKVECTOR_BLOCK (bv
, GLOBAL_BLOCK
));
3402 val
.section
= section
;
3406 /* Backward compatibility (no section). */
3408 struct symtab_and_line
3409 find_pc_line (CORE_ADDR pc
, int notcurrent
)
3411 struct obj_section
*section
;
3413 section
= find_pc_overlay (pc
);
3414 if (!pc_in_unmapped_range (pc
, section
))
3415 return find_pc_sect_line (pc
, section
, notcurrent
);
3417 /* If the original PC was an unmapped address then we translate this to a
3418 mapped address in order to lookup the sal. However, as the user
3419 passed us an unmapped address it makes more sense to return a result
3420 that has the pc and end fields translated to unmapped addresses. */
3421 pc
= overlay_mapped_address (pc
, section
);
3422 symtab_and_line sal
= find_pc_sect_line (pc
, section
, notcurrent
);
3423 sal
.pc
= overlay_unmapped_address (sal
.pc
, section
);
3424 sal
.end
= overlay_unmapped_address (sal
.end
, section
);
3431 find_pc_line_symtab (CORE_ADDR pc
)
3433 struct symtab_and_line sal
;
3435 /* This always passes zero for NOTCURRENT to find_pc_line.
3436 There are currently no callers that ever pass non-zero. */
3437 sal
= find_pc_line (pc
, 0);
3441 /* Find line number LINE in any symtab whose name is the same as
3444 If found, return the symtab that contains the linetable in which it was
3445 found, set *INDEX to the index in the linetable of the best entry
3446 found, and set *EXACT_MATCH to true if the value returned is an
3449 If not found, return NULL. */
3452 find_line_symtab (struct symtab
*sym_tab
, int line
,
3453 int *index
, bool *exact_match
)
3455 int exact
= 0; /* Initialized here to avoid a compiler warning. */
3457 /* BEST_INDEX and BEST_LINETABLE identify the smallest linenumber > LINE
3461 struct linetable
*best_linetable
;
3462 struct symtab
*best_symtab
;
3464 /* First try looking it up in the given symtab. */
3465 best_linetable
= sym_tab
->linetable ();
3466 best_symtab
= sym_tab
;
3467 best_index
= find_line_common (best_linetable
, line
, &exact
, 0);
3468 if (best_index
< 0 || !exact
)
3470 /* Didn't find an exact match. So we better keep looking for
3471 another symtab with the same name. In the case of xcoff,
3472 multiple csects for one source file (produced by IBM's FORTRAN
3473 compiler) produce multiple symtabs (this is unavoidable
3474 assuming csects can be at arbitrary places in memory and that
3475 the GLOBAL_BLOCK of a symtab has a begin and end address). */
3477 /* BEST is the smallest linenumber > LINE so far seen,
3478 or 0 if none has been seen so far.
3479 BEST_INDEX and BEST_LINETABLE identify the item for it. */
3482 if (best_index
>= 0)
3483 best
= best_linetable
->item
[best_index
].line
;
3487 for (objfile
*objfile
: current_program_space
->objfiles ())
3488 objfile
->expand_symtabs_with_fullname (symtab_to_fullname (sym_tab
));
3490 for (objfile
*objfile
: current_program_space
->objfiles ())
3492 for (compunit_symtab
*cu
: objfile
->compunits ())
3494 for (symtab
*s
: cu
->filetabs ())
3496 struct linetable
*l
;
3499 if (FILENAME_CMP (sym_tab
->filename
, s
->filename
) != 0)
3501 if (FILENAME_CMP (symtab_to_fullname (sym_tab
),
3502 symtab_to_fullname (s
)) != 0)
3504 l
= s
->linetable ();
3505 ind
= find_line_common (l
, line
, &exact
, 0);
3515 if (best
== 0 || l
->item
[ind
].line
< best
)
3517 best
= l
->item
[ind
].line
;
3532 *index
= best_index
;
3534 *exact_match
= (exact
!= 0);
3539 /* Given SYMTAB, returns all the PCs function in the symtab that
3540 exactly match LINE. Returns an empty vector if there are no exact
3541 matches, but updates BEST_ITEM in this case. */
3543 std::vector
<CORE_ADDR
>
3544 find_pcs_for_symtab_line (struct symtab
*symtab
, int line
,
3545 struct linetable_entry
**best_item
)
3548 std::vector
<CORE_ADDR
> result
;
3550 /* First, collect all the PCs that are at this line. */
3556 idx
= find_line_common (symtab
->linetable (), line
, &was_exact
,
3563 struct linetable_entry
*item
= &symtab
->linetable ()->item
[idx
];
3565 if (*best_item
== NULL
3566 || (item
->line
< (*best_item
)->line
&& item
->is_stmt
))
3572 result
.push_back (symtab
->linetable ()->item
[idx
].pc
);
3580 /* Set the PC value for a given source file and line number and return true.
3581 Returns false for invalid line number (and sets the PC to 0).
3582 The source file is specified with a struct symtab. */
3585 find_line_pc (struct symtab
*symtab
, int line
, CORE_ADDR
*pc
)
3587 struct linetable
*l
;
3594 symtab
= find_line_symtab (symtab
, line
, &ind
, NULL
);
3597 l
= symtab
->linetable ();
3598 *pc
= l
->item
[ind
].pc
;
3605 /* Find the range of pc values in a line.
3606 Store the starting pc of the line into *STARTPTR
3607 and the ending pc (start of next line) into *ENDPTR.
3608 Returns true to indicate success.
3609 Returns false if could not find the specified line. */
3612 find_line_pc_range (struct symtab_and_line sal
, CORE_ADDR
*startptr
,
3615 CORE_ADDR startaddr
;
3616 struct symtab_and_line found_sal
;
3619 if (startaddr
== 0 && !find_line_pc (sal
.symtab
, sal
.line
, &startaddr
))
3622 /* This whole function is based on address. For example, if line 10 has
3623 two parts, one from 0x100 to 0x200 and one from 0x300 to 0x400, then
3624 "info line *0x123" should say the line goes from 0x100 to 0x200
3625 and "info line *0x355" should say the line goes from 0x300 to 0x400.
3626 This also insures that we never give a range like "starts at 0x134
3627 and ends at 0x12c". */
3629 found_sal
= find_pc_sect_line (startaddr
, sal
.section
, 0);
3630 if (found_sal
.line
!= sal
.line
)
3632 /* The specified line (sal) has zero bytes. */
3633 *startptr
= found_sal
.pc
;
3634 *endptr
= found_sal
.pc
;
3638 *startptr
= found_sal
.pc
;
3639 *endptr
= found_sal
.end
;
3644 /* Given a line table and a line number, return the index into the line
3645 table for the pc of the nearest line whose number is >= the specified one.
3646 Return -1 if none is found. The value is >= 0 if it is an index.
3647 START is the index at which to start searching the line table.
3649 Set *EXACT_MATCH nonzero if the value returned is an exact match. */
3652 find_line_common (struct linetable
*l
, int lineno
,
3653 int *exact_match
, int start
)
3658 /* BEST is the smallest linenumber > LINENO so far seen,
3659 or 0 if none has been seen so far.
3660 BEST_INDEX identifies the item for it. */
3662 int best_index
= -1;
3673 for (i
= start
; i
< len
; i
++)
3675 struct linetable_entry
*item
= &(l
->item
[i
]);
3677 /* Ignore non-statements. */
3681 if (item
->line
== lineno
)
3683 /* Return the first (lowest address) entry which matches. */
3688 if (item
->line
> lineno
&& (best
== 0 || item
->line
< best
))
3695 /* If we got here, we didn't get an exact match. */
3700 find_pc_line_pc_range (CORE_ADDR pc
, CORE_ADDR
*startptr
, CORE_ADDR
*endptr
)
3702 struct symtab_and_line sal
;
3704 sal
= find_pc_line (pc
, 0);
3707 return sal
.symtab
!= 0;
3710 /* Helper for find_function_start_sal. Does most of the work, except
3711 setting the sal's symbol. */
3713 static symtab_and_line
3714 find_function_start_sal_1 (CORE_ADDR func_addr
, obj_section
*section
,
3717 symtab_and_line sal
= find_pc_sect_line (func_addr
, section
, 0);
3719 if (funfirstline
&& sal
.symtab
!= NULL
3720 && (sal
.symtab
->compunit ()->locations_valid ()
3721 || sal
.symtab
->language () == language_asm
))
3723 struct gdbarch
*gdbarch
= sal
.symtab
->objfile ()->arch ();
3726 if (gdbarch_skip_entrypoint_p (gdbarch
))
3727 sal
.pc
= gdbarch_skip_entrypoint (gdbarch
, sal
.pc
);
3731 /* We always should have a line for the function start address.
3732 If we don't, something is odd. Create a plain SAL referring
3733 just the PC and hope that skip_prologue_sal (if requested)
3734 can find a line number for after the prologue. */
3735 if (sal
.pc
< func_addr
)
3738 sal
.pspace
= current_program_space
;
3740 sal
.section
= section
;
3744 skip_prologue_sal (&sal
);
3752 find_function_start_sal (CORE_ADDR func_addr
, obj_section
*section
,
3756 = find_function_start_sal_1 (func_addr
, section
, funfirstline
);
3758 /* find_function_start_sal_1 does a linetable search, so it finds
3759 the symtab and linenumber, but not a symbol. Fill in the
3760 function symbol too. */
3761 sal
.symbol
= find_pc_sect_containing_function (sal
.pc
, sal
.section
);
3769 find_function_start_sal (symbol
*sym
, bool funfirstline
)
3771 fixup_symbol_section (sym
, NULL
);
3773 = find_function_start_sal_1 (BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
)),
3774 sym
->obj_section (symbol_objfile (sym
)),
3781 /* Given a function start address FUNC_ADDR and SYMTAB, find the first
3782 address for that function that has an entry in SYMTAB's line info
3783 table. If such an entry cannot be found, return FUNC_ADDR
3787 skip_prologue_using_lineinfo (CORE_ADDR func_addr
, struct symtab
*symtab
)
3789 CORE_ADDR func_start
, func_end
;
3790 struct linetable
*l
;
3793 /* Give up if this symbol has no lineinfo table. */
3794 l
= symtab
->linetable ();
3798 /* Get the range for the function's PC values, or give up if we
3799 cannot, for some reason. */
3800 if (!find_pc_partial_function (func_addr
, NULL
, &func_start
, &func_end
))
3803 /* Linetable entries are ordered by PC values, see the commentary in
3804 symtab.h where `struct linetable' is defined. Thus, the first
3805 entry whose PC is in the range [FUNC_START..FUNC_END[ is the
3806 address we are looking for. */
3807 for (i
= 0; i
< l
->nitems
; i
++)
3809 struct linetable_entry
*item
= &(l
->item
[i
]);
3811 /* Don't use line numbers of zero, they mark special entries in
3812 the table. See the commentary on symtab.h before the
3813 definition of struct linetable. */
3814 if (item
->line
> 0 && func_start
<= item
->pc
&& item
->pc
< func_end
)
3821 /* Adjust SAL to the first instruction past the function prologue.
3822 If the PC was explicitly specified, the SAL is not changed.
3823 If the line number was explicitly specified then the SAL can still be
3824 updated, unless the language for SAL is assembler, in which case the SAL
3825 will be left unchanged.
3826 If SAL is already past the prologue, then do nothing. */
3829 skip_prologue_sal (struct symtab_and_line
*sal
)
3832 struct symtab_and_line start_sal
;
3833 CORE_ADDR pc
, saved_pc
;
3834 struct obj_section
*section
;
3836 struct objfile
*objfile
;
3837 struct gdbarch
*gdbarch
;
3838 const struct block
*b
, *function_block
;
3839 int force_skip
, skip
;
3841 /* Do not change the SAL if PC was specified explicitly. */
3842 if (sal
->explicit_pc
)
3845 /* In assembly code, if the user asks for a specific line then we should
3846 not adjust the SAL. The user already has instruction level
3847 visibility in this case, so selecting a line other than one requested
3848 is likely to be the wrong choice. */
3849 if (sal
->symtab
!= nullptr
3850 && sal
->explicit_line
3851 && sal
->symtab
->language () == language_asm
)
3854 scoped_restore_current_pspace_and_thread restore_pspace_thread
;
3856 switch_to_program_space_and_thread (sal
->pspace
);
3858 sym
= find_pc_sect_function (sal
->pc
, sal
->section
);
3861 fixup_symbol_section (sym
, NULL
);
3863 objfile
= symbol_objfile (sym
);
3864 pc
= BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
));
3865 section
= sym
->obj_section (objfile
);
3866 name
= sym
->linkage_name ();
3870 struct bound_minimal_symbol msymbol
3871 = lookup_minimal_symbol_by_pc_section (sal
->pc
, sal
->section
);
3873 if (msymbol
.minsym
== NULL
)
3876 objfile
= msymbol
.objfile
;
3877 pc
= BMSYMBOL_VALUE_ADDRESS (msymbol
);
3878 section
= msymbol
.minsym
->obj_section (objfile
);
3879 name
= msymbol
.minsym
->linkage_name ();
3882 gdbarch
= objfile
->arch ();
3884 /* Process the prologue in two passes. In the first pass try to skip the
3885 prologue (SKIP is true) and verify there is a real need for it (indicated
3886 by FORCE_SKIP). If no such reason was found run a second pass where the
3887 prologue is not skipped (SKIP is false). */
3892 /* Be conservative - allow direct PC (without skipping prologue) only if we
3893 have proven the CU (Compilation Unit) supports it. sal->SYMTAB does not
3894 have to be set by the caller so we use SYM instead. */
3896 && symbol_symtab (sym
)->compunit ()->locations_valid ())
3904 /* If the function is in an unmapped overlay, use its unmapped LMA address,
3905 so that gdbarch_skip_prologue has something unique to work on. */
3906 if (section_is_overlay (section
) && !section_is_mapped (section
))
3907 pc
= overlay_unmapped_address (pc
, section
);
3909 /* Skip "first line" of function (which is actually its prologue). */
3910 pc
+= gdbarch_deprecated_function_start_offset (gdbarch
);
3911 if (gdbarch_skip_entrypoint_p (gdbarch
))
3912 pc
= gdbarch_skip_entrypoint (gdbarch
, pc
);
3914 pc
= gdbarch_skip_prologue_noexcept (gdbarch
, pc
);
3916 /* For overlays, map pc back into its mapped VMA range. */
3917 pc
= overlay_mapped_address (pc
, section
);
3919 /* Calculate line number. */
3920 start_sal
= find_pc_sect_line (pc
, section
, 0);
3922 /* Check if gdbarch_skip_prologue left us in mid-line, and the next
3923 line is still part of the same function. */
3924 if (skip
&& start_sal
.pc
!= pc
3925 && (sym
? (BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
)) <= start_sal
.end
3926 && start_sal
.end
< BLOCK_END (SYMBOL_BLOCK_VALUE (sym
)))
3927 : (lookup_minimal_symbol_by_pc_section (start_sal
.end
, section
).minsym
3928 == lookup_minimal_symbol_by_pc_section (pc
, section
).minsym
)))
3930 /* First pc of next line */
3932 /* Recalculate the line number (might not be N+1). */
3933 start_sal
= find_pc_sect_line (pc
, section
, 0);
3936 /* On targets with executable formats that don't have a concept of
3937 constructors (ELF with .init has, PE doesn't), gcc emits a call
3938 to `__main' in `main' between the prologue and before user
3940 if (gdbarch_skip_main_prologue_p (gdbarch
)
3941 && name
&& strcmp_iw (name
, "main") == 0)
3943 pc
= gdbarch_skip_main_prologue (gdbarch
, pc
);
3944 /* Recalculate the line number (might not be N+1). */
3945 start_sal
= find_pc_sect_line (pc
, section
, 0);
3949 while (!force_skip
&& skip
--);
3951 /* If we still don't have a valid source line, try to find the first
3952 PC in the lineinfo table that belongs to the same function. This
3953 happens with COFF debug info, which does not seem to have an
3954 entry in lineinfo table for the code after the prologue which has
3955 no direct relation to source. For example, this was found to be
3956 the case with the DJGPP target using "gcc -gcoff" when the
3957 compiler inserted code after the prologue to make sure the stack
3959 if (!force_skip
&& sym
&& start_sal
.symtab
== NULL
)
3961 pc
= skip_prologue_using_lineinfo (pc
, symbol_symtab (sym
));
3962 /* Recalculate the line number. */
3963 start_sal
= find_pc_sect_line (pc
, section
, 0);
3966 /* If we're already past the prologue, leave SAL unchanged. Otherwise
3967 forward SAL to the end of the prologue. */
3972 sal
->section
= section
;
3973 sal
->symtab
= start_sal
.symtab
;
3974 sal
->line
= start_sal
.line
;
3975 sal
->end
= start_sal
.end
;
3977 /* Check if we are now inside an inlined function. If we can,
3978 use the call site of the function instead. */
3979 b
= block_for_pc_sect (sal
->pc
, sal
->section
);
3980 function_block
= NULL
;
3983 if (BLOCK_FUNCTION (b
) != NULL
&& block_inlined_p (b
))
3985 else if (BLOCK_FUNCTION (b
) != NULL
)
3987 b
= BLOCK_SUPERBLOCK (b
);
3989 if (function_block
!= NULL
3990 && BLOCK_FUNCTION (function_block
)->line () != 0)
3992 sal
->line
= BLOCK_FUNCTION (function_block
)->line ();
3993 sal
->symtab
= symbol_symtab (BLOCK_FUNCTION (function_block
));
3997 /* Given PC at the function's start address, attempt to find the
3998 prologue end using SAL information. Return zero if the skip fails.
4000 A non-optimized prologue traditionally has one SAL for the function
4001 and a second for the function body. A single line function has
4002 them both pointing at the same line.
4004 An optimized prologue is similar but the prologue may contain
4005 instructions (SALs) from the instruction body. Need to skip those
4006 while not getting into the function body.
4008 The functions end point and an increasing SAL line are used as
4009 indicators of the prologue's endpoint.
4011 This code is based on the function refine_prologue_limit
4015 skip_prologue_using_sal (struct gdbarch
*gdbarch
, CORE_ADDR func_addr
)
4017 struct symtab_and_line prologue_sal
;
4020 const struct block
*bl
;
4022 /* Get an initial range for the function. */
4023 find_pc_partial_function (func_addr
, NULL
, &start_pc
, &end_pc
);
4024 start_pc
+= gdbarch_deprecated_function_start_offset (gdbarch
);
4026 prologue_sal
= find_pc_line (start_pc
, 0);
4027 if (prologue_sal
.line
!= 0)
4029 /* For languages other than assembly, treat two consecutive line
4030 entries at the same address as a zero-instruction prologue.
4031 The GNU assembler emits separate line notes for each instruction
4032 in a multi-instruction macro, but compilers generally will not
4034 if (prologue_sal
.symtab
->language () != language_asm
)
4036 struct linetable
*linetable
= prologue_sal
.symtab
->linetable ();
4039 /* Skip any earlier lines, and any end-of-sequence marker
4040 from a previous function. */
4041 while (linetable
->item
[idx
].pc
!= prologue_sal
.pc
4042 || linetable
->item
[idx
].line
== 0)
4045 if (idx
+1 < linetable
->nitems
4046 && linetable
->item
[idx
+1].line
!= 0
4047 && linetable
->item
[idx
+1].pc
== start_pc
)
4051 /* If there is only one sal that covers the entire function,
4052 then it is probably a single line function, like
4054 if (prologue_sal
.end
>= end_pc
)
4057 while (prologue_sal
.end
< end_pc
)
4059 struct symtab_and_line sal
;
4061 sal
= find_pc_line (prologue_sal
.end
, 0);
4064 /* Assume that a consecutive SAL for the same (or larger)
4065 line mark the prologue -> body transition. */
4066 if (sal
.line
>= prologue_sal
.line
)
4068 /* Likewise if we are in a different symtab altogether
4069 (e.g. within a file included via #include). */
4070 if (sal
.symtab
!= prologue_sal
.symtab
)
4073 /* The line number is smaller. Check that it's from the
4074 same function, not something inlined. If it's inlined,
4075 then there is no point comparing the line numbers. */
4076 bl
= block_for_pc (prologue_sal
.end
);
4079 if (block_inlined_p (bl
))
4081 if (BLOCK_FUNCTION (bl
))
4086 bl
= BLOCK_SUPERBLOCK (bl
);
4091 /* The case in which compiler's optimizer/scheduler has
4092 moved instructions into the prologue. We look ahead in
4093 the function looking for address ranges whose
4094 corresponding line number is less the first one that we
4095 found for the function. This is more conservative then
4096 refine_prologue_limit which scans a large number of SALs
4097 looking for any in the prologue. */
4102 if (prologue_sal
.end
< end_pc
)
4103 /* Return the end of this line, or zero if we could not find a
4105 return prologue_sal
.end
;
4107 /* Don't return END_PC, which is past the end of the function. */
4108 return prologue_sal
.pc
;
4114 find_function_alias_target (bound_minimal_symbol msymbol
)
4116 CORE_ADDR func_addr
;
4117 if (!msymbol_is_function (msymbol
.objfile
, msymbol
.minsym
, &func_addr
))
4120 symbol
*sym
= find_pc_function (func_addr
);
4122 && sym
->aclass () == LOC_BLOCK
4123 && BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
)) == func_addr
)
4130 /* If P is of the form "operator[ \t]+..." where `...' is
4131 some legitimate operator text, return a pointer to the
4132 beginning of the substring of the operator text.
4133 Otherwise, return "". */
4136 operator_chars (const char *p
, const char **end
)
4139 if (!startswith (p
, CP_OPERATOR_STR
))
4141 p
+= CP_OPERATOR_LEN
;
4143 /* Don't get faked out by `operator' being part of a longer
4145 if (isalpha (*p
) || *p
== '_' || *p
== '$' || *p
== '\0')
4148 /* Allow some whitespace between `operator' and the operator symbol. */
4149 while (*p
== ' ' || *p
== '\t')
4152 /* Recognize 'operator TYPENAME'. */
4154 if (isalpha (*p
) || *p
== '_' || *p
== '$')
4156 const char *q
= p
+ 1;
4158 while (isalnum (*q
) || *q
== '_' || *q
== '$')
4167 case '\\': /* regexp quoting */
4170 if (p
[2] == '=') /* 'operator\*=' */
4172 else /* 'operator\*' */
4176 else if (p
[1] == '[')
4179 error (_("mismatched quoting on brackets, "
4180 "try 'operator\\[\\]'"));
4181 else if (p
[2] == '\\' && p
[3] == ']')
4183 *end
= p
+ 4; /* 'operator\[\]' */
4187 error (_("nothing is allowed between '[' and ']'"));
4191 /* Gratuitous quote: skip it and move on. */
4213 if (p
[0] == '-' && p
[1] == '>')
4215 /* Struct pointer member operator 'operator->'. */
4218 *end
= p
+ 3; /* 'operator->*' */
4221 else if (p
[2] == '\\')
4223 *end
= p
+ 4; /* Hopefully 'operator->\*' */
4228 *end
= p
+ 2; /* 'operator->' */
4232 if (p
[1] == '=' || p
[1] == p
[0])
4243 error (_("`operator ()' must be specified "
4244 "without whitespace in `()'"));
4249 error (_("`operator ?:' must be specified "
4250 "without whitespace in `?:'"));
4255 error (_("`operator []' must be specified "
4256 "without whitespace in `[]'"));
4260 error (_("`operator %s' not supported"), p
);
4269 /* See class declaration. */
4271 info_sources_filter::info_sources_filter (match_on match_type
,
4273 : m_match_type (match_type
),
4276 /* Setup the compiled regular expression M_C_REGEXP based on M_REGEXP. */
4277 if (m_regexp
!= nullptr && *m_regexp
!= '\0')
4279 gdb_assert (m_regexp
!= nullptr);
4281 int cflags
= REG_NOSUB
;
4282 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
4283 cflags
|= REG_ICASE
;
4285 m_c_regexp
.emplace (m_regexp
, cflags
, _("Invalid regexp"));
4289 /* See class declaration. */
4292 info_sources_filter::matches (const char *fullname
) const
4294 /* Does it match regexp? */
4295 if (m_c_regexp
.has_value ())
4297 const char *to_match
;
4298 std::string dirname
;
4300 switch (m_match_type
)
4302 case match_on::DIRNAME
:
4303 dirname
= ldirname (fullname
);
4304 to_match
= dirname
.c_str ();
4306 case match_on::BASENAME
:
4307 to_match
= lbasename (fullname
);
4309 case match_on::FULLNAME
:
4310 to_match
= fullname
;
4313 gdb_assert_not_reached ("bad m_match_type");
4316 if (m_c_regexp
->exec (to_match
, 0, NULL
, 0) != 0)
4323 /* Data structure to maintain the state used for printing the results of
4324 the 'info sources' command. */
4326 struct output_source_filename_data
4328 /* Create an object for displaying the results of the 'info sources'
4329 command to UIOUT. FILTER must remain valid and unchanged for the
4330 lifetime of this object as this object retains a reference to FILTER. */
4331 output_source_filename_data (struct ui_out
*uiout
,
4332 const info_sources_filter
&filter
)
4333 : m_filter (filter
),
4337 DISABLE_COPY_AND_ASSIGN (output_source_filename_data
);
4339 /* Reset enough state of this object so we can match against a new set of
4340 files. The existing regular expression is retained though. */
4341 void reset_output ()
4344 m_filename_seen_cache
.clear ();
4347 /* Worker for sources_info, outputs the file name formatted for either
4348 cli or mi (based on the current_uiout). In cli mode displays
4349 FULLNAME with a comma separating this name from any previously
4350 printed name (line breaks are added at the comma). In MI mode
4351 outputs a tuple containing DISP_NAME (the files display name),
4352 FULLNAME, and EXPANDED_P (true when this file is from a fully
4353 expanded symtab, otherwise false). */
4354 void output (const char *disp_name
, const char *fullname
, bool expanded_p
);
4356 /* An overload suitable for use as a callback to
4357 quick_symbol_functions::map_symbol_filenames. */
4358 void operator() (const char *filename
, const char *fullname
)
4360 /* The false here indicates that this file is from an unexpanded
4362 output (filename
, fullname
, false);
4365 /* Return true if at least one filename has been printed (after a call to
4366 output) since either this object was created, or the last call to
4368 bool printed_filename_p () const
4375 /* Flag of whether we're printing the first one. */
4376 bool m_first
= true;
4378 /* Cache of what we've seen so far. */
4379 filename_seen_cache m_filename_seen_cache
;
4381 /* How source filename should be filtered. */
4382 const info_sources_filter
&m_filter
;
4384 /* The object to which output is sent. */
4385 struct ui_out
*m_uiout
;
4388 /* See comment in class declaration above. */
4391 output_source_filename_data::output (const char *disp_name
,
4392 const char *fullname
,
4395 /* Since a single source file can result in several partial symbol
4396 tables, we need to avoid printing it more than once. Note: if
4397 some of the psymtabs are read in and some are not, it gets
4398 printed both under "Source files for which symbols have been
4399 read" and "Source files for which symbols will be read in on
4400 demand". I consider this a reasonable way to deal with the
4401 situation. I'm not sure whether this can also happen for
4402 symtabs; it doesn't hurt to check. */
4404 /* Was NAME already seen? If so, then don't print it again. */
4405 if (m_filename_seen_cache
.seen (fullname
))
4408 /* If the filter rejects this file then don't print it. */
4409 if (!m_filter
.matches (fullname
))
4412 ui_out_emit_tuple
ui_emitter (m_uiout
, nullptr);
4414 /* Print it and reset *FIRST. */
4416 m_uiout
->text (", ");
4419 m_uiout
->wrap_hint (0);
4420 if (m_uiout
->is_mi_like_p ())
4422 m_uiout
->field_string ("file", disp_name
, file_name_style
.style ());
4423 if (fullname
!= nullptr)
4424 m_uiout
->field_string ("fullname", fullname
,
4425 file_name_style
.style ());
4426 m_uiout
->field_string ("debug-fully-read",
4427 (expanded_p
? "true" : "false"));
4431 if (fullname
== nullptr)
4432 fullname
= disp_name
;
4433 m_uiout
->field_string ("fullname", fullname
,
4434 file_name_style
.style ());
4438 /* For the 'info sources' command, what part of the file names should we be
4439 matching the user supplied regular expression against? */
4441 struct filename_partial_match_opts
4443 /* Only match the directory name part. */
4444 bool dirname
= false;
4446 /* Only match the basename part. */
4447 bool basename
= false;
4450 using isrc_flag_option_def
4451 = gdb::option::flag_option_def
<filename_partial_match_opts
>;
4453 static const gdb::option::option_def info_sources_option_defs
[] = {
4455 isrc_flag_option_def
{
4457 [] (filename_partial_match_opts
*opts
) { return &opts
->dirname
; },
4458 N_("Show only the files having a dirname matching REGEXP."),
4461 isrc_flag_option_def
{
4463 [] (filename_partial_match_opts
*opts
) { return &opts
->basename
; },
4464 N_("Show only the files having a basename matching REGEXP."),
4469 /* Create an option_def_group for the "info sources" options, with
4470 ISRC_OPTS as context. */
4472 static inline gdb::option::option_def_group
4473 make_info_sources_options_def_group (filename_partial_match_opts
*isrc_opts
)
4475 return {{info_sources_option_defs
}, isrc_opts
};
4478 /* Completer for "info sources". */
4481 info_sources_command_completer (cmd_list_element
*ignore
,
4482 completion_tracker
&tracker
,
4483 const char *text
, const char *word
)
4485 const auto group
= make_info_sources_options_def_group (nullptr);
4486 if (gdb::option::complete_options
4487 (tracker
, &text
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, group
))
4494 info_sources_worker (struct ui_out
*uiout
,
4495 bool group_by_objfile
,
4496 const info_sources_filter
&filter
)
4498 output_source_filename_data
data (uiout
, filter
);
4500 ui_out_emit_list
results_emitter (uiout
, "files");
4501 gdb::optional
<ui_out_emit_tuple
> output_tuple
;
4502 gdb::optional
<ui_out_emit_list
> sources_list
;
4504 gdb_assert (group_by_objfile
|| uiout
->is_mi_like_p ());
4506 for (objfile
*objfile
: current_program_space
->objfiles ())
4508 if (group_by_objfile
)
4510 output_tuple
.emplace (uiout
, nullptr);
4511 uiout
->field_string ("filename", objfile_name (objfile
));
4512 uiout
->text (":\n");
4513 bool debug_fully_readin
= !objfile
->has_unexpanded_symtabs ();
4514 if (uiout
->is_mi_like_p ())
4516 const char *debug_info_state
;
4517 if (objfile_has_symbols (objfile
))
4519 if (debug_fully_readin
)
4520 debug_info_state
= "fully-read";
4522 debug_info_state
= "partially-read";
4525 debug_info_state
= "none";
4526 current_uiout
->field_string ("debug-info", debug_info_state
);
4530 if (!debug_fully_readin
)
4531 uiout
->text ("(Full debug information has not yet been read "
4532 "for this file.)\n");
4533 if (!objfile_has_symbols (objfile
))
4534 uiout
->text ("(Objfile has no debug information.)\n");
4537 sources_list
.emplace (uiout
, "sources");
4540 for (compunit_symtab
*cu
: objfile
->compunits ())
4542 for (symtab
*s
: cu
->filetabs ())
4544 const char *file
= symtab_to_filename_for_display (s
);
4545 const char *fullname
= symtab_to_fullname (s
);
4546 data
.output (file
, fullname
, true);
4550 if (group_by_objfile
)
4552 objfile
->map_symbol_filenames (data
, true /* need_fullname */);
4553 if (data
.printed_filename_p ())
4554 uiout
->text ("\n\n");
4555 data
.reset_output ();
4556 sources_list
.reset ();
4557 output_tuple
.reset ();
4561 if (!group_by_objfile
)
4563 data
.reset_output ();
4564 map_symbol_filenames (data
, true /*need_fullname*/);
4568 /* Implement the 'info sources' command. */
4571 info_sources_command (const char *args
, int from_tty
)
4573 if (!have_full_symbols () && !have_partial_symbols ())
4574 error (_("No symbol table is loaded. Use the \"file\" command."));
4576 filename_partial_match_opts match_opts
;
4577 auto group
= make_info_sources_options_def_group (&match_opts
);
4578 gdb::option::process_options
4579 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_ERROR
, group
);
4581 if (match_opts
.dirname
&& match_opts
.basename
)
4582 error (_("You cannot give both -basename and -dirname to 'info sources'."));
4584 const char *regex
= nullptr;
4585 if (args
!= NULL
&& *args
!= '\000')
4588 if ((match_opts
.dirname
|| match_opts
.basename
) && regex
== nullptr)
4589 error (_("Missing REGEXP for 'info sources'."));
4591 info_sources_filter::match_on match_type
;
4592 if (match_opts
.dirname
)
4593 match_type
= info_sources_filter::match_on::DIRNAME
;
4594 else if (match_opts
.basename
)
4595 match_type
= info_sources_filter::match_on::BASENAME
;
4597 match_type
= info_sources_filter::match_on::FULLNAME
;
4599 info_sources_filter
filter (match_type
, regex
);
4600 info_sources_worker (current_uiout
, true, filter
);
4603 /* Compare FILE against all the entries of FILENAMES. If BASENAMES is
4604 true compare only lbasename of FILENAMES. */
4607 file_matches (const char *file
, const std::vector
<const char *> &filenames
,
4610 if (filenames
.empty ())
4613 for (const char *name
: filenames
)
4615 name
= (basenames
? lbasename (name
) : name
);
4616 if (compare_filenames_for_search (file
, name
))
4623 /* Helper function for std::sort on symbol_search objects. Can only sort
4624 symbols, not minimal symbols. */
4627 symbol_search::compare_search_syms (const symbol_search
&sym_a
,
4628 const symbol_search
&sym_b
)
4632 c
= FILENAME_CMP (symbol_symtab (sym_a
.symbol
)->filename
,
4633 symbol_symtab (sym_b
.symbol
)->filename
);
4637 if (sym_a
.block
!= sym_b
.block
)
4638 return sym_a
.block
- sym_b
.block
;
4640 return strcmp (sym_a
.symbol
->print_name (), sym_b
.symbol
->print_name ());
4643 /* Returns true if the type_name of symbol_type of SYM matches TREG.
4644 If SYM has no symbol_type or symbol_name, returns false. */
4647 treg_matches_sym_type_name (const compiled_regex
&treg
,
4648 const struct symbol
*sym
)
4650 struct type
*sym_type
;
4651 std::string printed_sym_type_name
;
4653 if (symbol_lookup_debug
> 1)
4655 fprintf_unfiltered (gdb_stdlog
,
4656 "treg_matches_sym_type_name\n sym %s\n",
4657 sym
->natural_name ());
4660 sym_type
= sym
->type ();
4661 if (sym_type
== NULL
)
4665 scoped_switch_to_sym_language_if_auto
l (sym
);
4667 printed_sym_type_name
= type_to_string (sym_type
);
4671 if (symbol_lookup_debug
> 1)
4673 fprintf_unfiltered (gdb_stdlog
,
4674 " sym_type_name %s\n",
4675 printed_sym_type_name
.c_str ());
4679 if (printed_sym_type_name
.empty ())
4682 return treg
.exec (printed_sym_type_name
.c_str (), 0, NULL
, 0) == 0;
4688 global_symbol_searcher::is_suitable_msymbol
4689 (const enum search_domain kind
, const minimal_symbol
*msymbol
)
4691 switch (MSYMBOL_TYPE (msymbol
))
4697 return kind
== VARIABLES_DOMAIN
;
4700 case mst_solib_trampoline
:
4701 case mst_text_gnu_ifunc
:
4702 return kind
== FUNCTIONS_DOMAIN
;
4711 global_symbol_searcher::expand_symtabs
4712 (objfile
*objfile
, const gdb::optional
<compiled_regex
> &preg
) const
4714 enum search_domain kind
= m_kind
;
4715 bool found_msymbol
= false;
4717 auto do_file_match
= [&] (const char *filename
, bool basenames
)
4719 return file_matches (filename
, filenames
, basenames
);
4721 gdb::function_view
<expand_symtabs_file_matcher_ftype
> file_matcher
= nullptr;
4722 if (!filenames
.empty ())
4723 file_matcher
= do_file_match
;
4725 objfile
->expand_symtabs_matching
4727 &lookup_name_info::match_any (),
4728 [&] (const char *symname
)
4730 return (!preg
.has_value ()
4731 || preg
->exec (symname
, 0, NULL
, 0) == 0);
4734 SEARCH_GLOBAL_BLOCK
| SEARCH_STATIC_BLOCK
,
4738 /* Here, we search through the minimal symbol tables for functions and
4739 variables that match, and force their symbols to be read. This is in
4740 particular necessary for demangled variable names, which are no longer
4741 put into the partial symbol tables. The symbol will then be found
4742 during the scan of symtabs later.
4744 For functions, find_pc_symtab should succeed if we have debug info for
4745 the function, for variables we have to call
4746 lookup_symbol_in_objfile_from_linkage_name to determine if the
4747 variable has debug info. If the lookup fails, set found_msymbol so
4748 that we will rescan to print any matching symbols without debug info.
4749 We only search the objfile the msymbol came from, we no longer search
4750 all objfiles. In large programs (1000s of shared libs) searching all
4751 objfiles is not worth the pain. */
4752 if (filenames
.empty ()
4753 && (kind
== VARIABLES_DOMAIN
|| kind
== FUNCTIONS_DOMAIN
))
4755 for (minimal_symbol
*msymbol
: objfile
->msymbols ())
4759 if (msymbol
->created_by_gdb
)
4762 if (is_suitable_msymbol (kind
, msymbol
))
4764 if (!preg
.has_value ()
4765 || preg
->exec (msymbol
->natural_name (), 0,
4768 /* An important side-effect of these lookup functions is
4769 to expand the symbol table if msymbol is found, later
4770 in the process we will add matching symbols or
4771 msymbols to the results list, and that requires that
4772 the symbols tables are expanded. */
4773 if (kind
== FUNCTIONS_DOMAIN
4774 ? (find_pc_compunit_symtab
4775 (MSYMBOL_VALUE_ADDRESS (objfile
, msymbol
))
4777 : (lookup_symbol_in_objfile_from_linkage_name
4778 (objfile
, msymbol
->linkage_name (),
4781 found_msymbol
= true;
4787 return found_msymbol
;
4793 global_symbol_searcher::add_matching_symbols
4795 const gdb::optional
<compiled_regex
> &preg
,
4796 const gdb::optional
<compiled_regex
> &treg
,
4797 std::set
<symbol_search
> *result_set
) const
4799 enum search_domain kind
= m_kind
;
4801 /* Add matching symbols (if not already present). */
4802 for (compunit_symtab
*cust
: objfile
->compunits ())
4804 const struct blockvector
*bv
= cust
->blockvector ();
4806 for (block_enum block
: { GLOBAL_BLOCK
, STATIC_BLOCK
})
4808 struct block_iterator iter
;
4810 const struct block
*b
= BLOCKVECTOR_BLOCK (bv
, block
);
4812 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
4814 struct symtab
*real_symtab
= symbol_symtab (sym
);
4818 /* Check first sole REAL_SYMTAB->FILENAME. It does
4819 not need to be a substring of symtab_to_fullname as
4820 it may contain "./" etc. */
4821 if ((file_matches (real_symtab
->filename
, filenames
, false)
4822 || ((basenames_may_differ
4823 || file_matches (lbasename (real_symtab
->filename
),
4825 && file_matches (symtab_to_fullname (real_symtab
),
4827 && ((!preg
.has_value ()
4828 || preg
->exec (sym
->natural_name (), 0,
4830 && ((kind
== VARIABLES_DOMAIN
4831 && sym
->aclass () != LOC_TYPEDEF
4832 && sym
->aclass () != LOC_UNRESOLVED
4833 && sym
->aclass () != LOC_BLOCK
4834 /* LOC_CONST can be used for more than
4835 just enums, e.g., c++ static const
4836 members. We only want to skip enums
4838 && !(sym
->aclass () == LOC_CONST
4839 && (sym
->type ()->code ()
4841 && (!treg
.has_value ()
4842 || treg_matches_sym_type_name (*treg
, sym
)))
4843 || (kind
== FUNCTIONS_DOMAIN
4844 && sym
->aclass () == LOC_BLOCK
4845 && (!treg
.has_value ()
4846 || treg_matches_sym_type_name (*treg
,
4848 || (kind
== TYPES_DOMAIN
4849 && sym
->aclass () == LOC_TYPEDEF
4850 && sym
->domain () != MODULE_DOMAIN
)
4851 || (kind
== MODULES_DOMAIN
4852 && sym
->domain () == MODULE_DOMAIN
4853 && sym
->line () != 0))))
4855 if (result_set
->size () < m_max_search_results
)
4857 /* Match, insert if not already in the results. */
4858 symbol_search
ss (block
, sym
);
4859 if (result_set
->find (ss
) == result_set
->end ())
4860 result_set
->insert (ss
);
4875 global_symbol_searcher::add_matching_msymbols
4876 (objfile
*objfile
, const gdb::optional
<compiled_regex
> &preg
,
4877 std::vector
<symbol_search
> *results
) const
4879 enum search_domain kind
= m_kind
;
4881 for (minimal_symbol
*msymbol
: objfile
->msymbols ())
4885 if (msymbol
->created_by_gdb
)
4888 if (is_suitable_msymbol (kind
, msymbol
))
4890 if (!preg
.has_value ()
4891 || preg
->exec (msymbol
->natural_name (), 0,
4894 /* For functions we can do a quick check of whether the
4895 symbol might be found via find_pc_symtab. */
4896 if (kind
!= FUNCTIONS_DOMAIN
4897 || (find_pc_compunit_symtab
4898 (MSYMBOL_VALUE_ADDRESS (objfile
, msymbol
))
4901 if (lookup_symbol_in_objfile_from_linkage_name
4902 (objfile
, msymbol
->linkage_name (),
4903 VAR_DOMAIN
).symbol
== NULL
)
4905 /* Matching msymbol, add it to the results list. */
4906 if (results
->size () < m_max_search_results
)
4907 results
->emplace_back (GLOBAL_BLOCK
, msymbol
, objfile
);
4921 std::vector
<symbol_search
>
4922 global_symbol_searcher::search () const
4924 gdb::optional
<compiled_regex
> preg
;
4925 gdb::optional
<compiled_regex
> treg
;
4927 gdb_assert (m_kind
!= ALL_DOMAIN
);
4929 if (m_symbol_name_regexp
!= NULL
)
4931 const char *symbol_name_regexp
= m_symbol_name_regexp
;
4933 /* Make sure spacing is right for C++ operators.
4934 This is just a courtesy to make the matching less sensitive
4935 to how many spaces the user leaves between 'operator'
4936 and <TYPENAME> or <OPERATOR>. */
4938 const char *opname
= operator_chars (symbol_name_regexp
, &opend
);
4942 int fix
= -1; /* -1 means ok; otherwise number of
4945 if (isalpha (*opname
) || *opname
== '_' || *opname
== '$')
4947 /* There should 1 space between 'operator' and 'TYPENAME'. */
4948 if (opname
[-1] != ' ' || opname
[-2] == ' ')
4953 /* There should 0 spaces between 'operator' and 'OPERATOR'. */
4954 if (opname
[-1] == ' ')
4957 /* If wrong number of spaces, fix it. */
4960 char *tmp
= (char *) alloca (8 + fix
+ strlen (opname
) + 1);
4962 sprintf (tmp
, "operator%.*s%s", fix
, " ", opname
);
4963 symbol_name_regexp
= tmp
;
4967 int cflags
= REG_NOSUB
| (case_sensitivity
== case_sensitive_off
4969 preg
.emplace (symbol_name_regexp
, cflags
,
4970 _("Invalid regexp"));
4973 if (m_symbol_type_regexp
!= NULL
)
4975 int cflags
= REG_NOSUB
| (case_sensitivity
== case_sensitive_off
4977 treg
.emplace (m_symbol_type_regexp
, cflags
,
4978 _("Invalid regexp"));
4981 bool found_msymbol
= false;
4982 std::set
<symbol_search
> result_set
;
4983 for (objfile
*objfile
: current_program_space
->objfiles ())
4985 /* Expand symtabs within objfile that possibly contain matching
4987 found_msymbol
|= expand_symtabs (objfile
, preg
);
4989 /* Find matching symbols within OBJFILE and add them in to the
4990 RESULT_SET set. Use a set here so that we can easily detect
4991 duplicates as we go, and can therefore track how many unique
4992 matches we have found so far. */
4993 if (!add_matching_symbols (objfile
, preg
, treg
, &result_set
))
4997 /* Convert the result set into a sorted result list, as std::set is
4998 defined to be sorted then no explicit call to std::sort is needed. */
4999 std::vector
<symbol_search
> result (result_set
.begin (), result_set
.end ());
5001 /* If there are no debug symbols, then add matching minsyms. But if the
5002 user wants to see symbols matching a type regexp, then never give a
5003 minimal symbol, as we assume that a minimal symbol does not have a
5005 if ((found_msymbol
|| (filenames
.empty () && m_kind
== VARIABLES_DOMAIN
))
5006 && !m_exclude_minsyms
5007 && !treg
.has_value ())
5009 gdb_assert (m_kind
== VARIABLES_DOMAIN
|| m_kind
== FUNCTIONS_DOMAIN
);
5010 for (objfile
*objfile
: current_program_space
->objfiles ())
5011 if (!add_matching_msymbols (objfile
, preg
, &result
))
5021 symbol_to_info_string (struct symbol
*sym
, int block
,
5022 enum search_domain kind
)
5026 gdb_assert (block
== GLOBAL_BLOCK
|| block
== STATIC_BLOCK
);
5028 if (kind
!= TYPES_DOMAIN
&& block
== STATIC_BLOCK
)
5031 /* Typedef that is not a C++ class. */
5032 if (kind
== TYPES_DOMAIN
5033 && sym
->domain () != STRUCT_DOMAIN
)
5035 string_file tmp_stream
;
5037 /* FIXME: For C (and C++) we end up with a difference in output here
5038 between how a typedef is printed, and non-typedefs are printed.
5039 The TYPEDEF_PRINT code places a ";" at the end in an attempt to
5040 appear C-like, while TYPE_PRINT doesn't.
5042 For the struct printing case below, things are worse, we force
5043 printing of the ";" in this function, which is going to be wrong
5044 for languages that don't require a ";" between statements. */
5045 if (sym
->type ()->code () == TYPE_CODE_TYPEDEF
)
5046 typedef_print (sym
->type (), sym
, &tmp_stream
);
5048 type_print (sym
->type (), "", &tmp_stream
, -1);
5049 str
+= tmp_stream
.string ();
5051 /* variable, func, or typedef-that-is-c++-class. */
5052 else if (kind
< TYPES_DOMAIN
5053 || (kind
== TYPES_DOMAIN
5054 && sym
->domain () == STRUCT_DOMAIN
))
5056 string_file tmp_stream
;
5058 type_print (sym
->type (),
5059 (sym
->aclass () == LOC_TYPEDEF
5060 ? "" : sym
->print_name ()),
5063 str
+= tmp_stream
.string ();
5066 /* Printing of modules is currently done here, maybe at some future
5067 point we might want a language specific method to print the module
5068 symbol so that we can customise the output more. */
5069 else if (kind
== MODULES_DOMAIN
)
5070 str
+= sym
->print_name ();
5075 /* Helper function for symbol info commands, for example 'info functions',
5076 'info variables', etc. KIND is the kind of symbol we searched for, and
5077 BLOCK is the type of block the symbols was found in, either GLOBAL_BLOCK
5078 or STATIC_BLOCK. SYM is the symbol we found. If LAST is not NULL,
5079 print file and line number information for the symbol as well. Skip
5080 printing the filename if it matches LAST. */
5083 print_symbol_info (enum search_domain kind
,
5085 int block
, const char *last
)
5087 scoped_switch_to_sym_language_if_auto
l (sym
);
5088 struct symtab
*s
= symbol_symtab (sym
);
5092 const char *s_filename
= symtab_to_filename_for_display (s
);
5094 if (filename_cmp (last
, s_filename
) != 0)
5096 printf_filtered (_("\nFile %ps:\n"),
5097 styled_string (file_name_style
.style (),
5101 if (sym
->line () != 0)
5102 printf_filtered ("%d:\t", sym
->line ());
5104 puts_filtered ("\t");
5107 std::string str
= symbol_to_info_string (sym
, block
, kind
);
5108 printf_filtered ("%s\n", str
.c_str ());
5111 /* This help function for symtab_symbol_info() prints information
5112 for non-debugging symbols to gdb_stdout. */
5115 print_msymbol_info (struct bound_minimal_symbol msymbol
)
5117 struct gdbarch
*gdbarch
= msymbol
.objfile
->arch ();
5120 if (gdbarch_addr_bit (gdbarch
) <= 32)
5121 tmp
= hex_string_custom (BMSYMBOL_VALUE_ADDRESS (msymbol
)
5122 & (CORE_ADDR
) 0xffffffff,
5125 tmp
= hex_string_custom (BMSYMBOL_VALUE_ADDRESS (msymbol
),
5128 ui_file_style sym_style
= (msymbol
.minsym
->text_p ()
5129 ? function_name_style
.style ()
5130 : ui_file_style ());
5132 printf_filtered (_("%ps %ps\n"),
5133 styled_string (address_style
.style (), tmp
),
5134 styled_string (sym_style
, msymbol
.minsym
->print_name ()));
5137 /* This is the guts of the commands "info functions", "info types", and
5138 "info variables". It calls search_symbols to find all matches and then
5139 print_[m]symbol_info to print out some useful information about the
5143 symtab_symbol_info (bool quiet
, bool exclude_minsyms
,
5144 const char *regexp
, enum search_domain kind
,
5145 const char *t_regexp
, int from_tty
)
5147 static const char * const classnames
[] =
5148 {"variable", "function", "type", "module"};
5149 const char *last_filename
= "";
5152 gdb_assert (kind
!= ALL_DOMAIN
);
5154 if (regexp
!= nullptr && *regexp
== '\0')
5157 global_symbol_searcher
spec (kind
, regexp
);
5158 spec
.set_symbol_type_regexp (t_regexp
);
5159 spec
.set_exclude_minsyms (exclude_minsyms
);
5160 std::vector
<symbol_search
> symbols
= spec
.search ();
5166 if (t_regexp
!= NULL
)
5168 (_("All %ss matching regular expression \"%s\""
5169 " with type matching regular expression \"%s\":\n"),
5170 classnames
[kind
], regexp
, t_regexp
);
5172 printf_filtered (_("All %ss matching regular expression \"%s\":\n"),
5173 classnames
[kind
], regexp
);
5177 if (t_regexp
!= NULL
)
5179 (_("All defined %ss"
5180 " with type matching regular expression \"%s\" :\n"),
5181 classnames
[kind
], t_regexp
);
5183 printf_filtered (_("All defined %ss:\n"), classnames
[kind
]);
5187 for (const symbol_search
&p
: symbols
)
5191 if (p
.msymbol
.minsym
!= NULL
)
5196 printf_filtered (_("\nNon-debugging symbols:\n"));
5199 print_msymbol_info (p
.msymbol
);
5203 print_symbol_info (kind
,
5208 = symtab_to_filename_for_display (symbol_symtab (p
.symbol
));
5213 /* Structure to hold the values of the options used by the 'info variables'
5214 and 'info functions' commands. These correspond to the -q, -t, and -n
5217 struct info_vars_funcs_options
5220 bool exclude_minsyms
= false;
5221 std::string type_regexp
;
5224 /* The options used by the 'info variables' and 'info functions'
5227 static const gdb::option::option_def info_vars_funcs_options_defs
[] = {
5228 gdb::option::boolean_option_def
<info_vars_funcs_options
> {
5230 [] (info_vars_funcs_options
*opt
) { return &opt
->quiet
; },
5231 nullptr, /* show_cmd_cb */
5232 nullptr /* set_doc */
5235 gdb::option::boolean_option_def
<info_vars_funcs_options
> {
5237 [] (info_vars_funcs_options
*opt
) { return &opt
->exclude_minsyms
; },
5238 nullptr, /* show_cmd_cb */
5239 nullptr /* set_doc */
5242 gdb::option::string_option_def
<info_vars_funcs_options
> {
5244 [] (info_vars_funcs_options
*opt
) { return &opt
->type_regexp
; },
5245 nullptr, /* show_cmd_cb */
5246 nullptr /* set_doc */
5250 /* Returns the option group used by 'info variables' and 'info
5253 static gdb::option::option_def_group
5254 make_info_vars_funcs_options_def_group (info_vars_funcs_options
*opts
)
5256 return {{info_vars_funcs_options_defs
}, opts
};
5259 /* Command completer for 'info variables' and 'info functions'. */
5262 info_vars_funcs_command_completer (struct cmd_list_element
*ignore
,
5263 completion_tracker
&tracker
,
5264 const char *text
, const char * /* word */)
5267 = make_info_vars_funcs_options_def_group (nullptr);
5268 if (gdb::option::complete_options
5269 (tracker
, &text
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, group
))
5272 const char *word
= advance_to_expression_complete_word_point (tracker
, text
);
5273 symbol_completer (ignore
, tracker
, text
, word
);
5276 /* Implement the 'info variables' command. */
5279 info_variables_command (const char *args
, int from_tty
)
5281 info_vars_funcs_options opts
;
5282 auto grp
= make_info_vars_funcs_options_def_group (&opts
);
5283 gdb::option::process_options
5284 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
5285 if (args
!= nullptr && *args
== '\0')
5289 (opts
.quiet
, opts
.exclude_minsyms
, args
, VARIABLES_DOMAIN
,
5290 opts
.type_regexp
.empty () ? nullptr : opts
.type_regexp
.c_str (),
5294 /* Implement the 'info functions' command. */
5297 info_functions_command (const char *args
, int from_tty
)
5299 info_vars_funcs_options opts
;
5301 auto grp
= make_info_vars_funcs_options_def_group (&opts
);
5302 gdb::option::process_options
5303 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
5304 if (args
!= nullptr && *args
== '\0')
5308 (opts
.quiet
, opts
.exclude_minsyms
, args
, FUNCTIONS_DOMAIN
,
5309 opts
.type_regexp
.empty () ? nullptr : opts
.type_regexp
.c_str (),
5313 /* Holds the -q option for the 'info types' command. */
5315 struct info_types_options
5320 /* The options used by the 'info types' command. */
5322 static const gdb::option::option_def info_types_options_defs
[] = {
5323 gdb::option::boolean_option_def
<info_types_options
> {
5325 [] (info_types_options
*opt
) { return &opt
->quiet
; },
5326 nullptr, /* show_cmd_cb */
5327 nullptr /* set_doc */
5331 /* Returns the option group used by 'info types'. */
5333 static gdb::option::option_def_group
5334 make_info_types_options_def_group (info_types_options
*opts
)
5336 return {{info_types_options_defs
}, opts
};
5339 /* Implement the 'info types' command. */
5342 info_types_command (const char *args
, int from_tty
)
5344 info_types_options opts
;
5346 auto grp
= make_info_types_options_def_group (&opts
);
5347 gdb::option::process_options
5348 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
5349 if (args
!= nullptr && *args
== '\0')
5351 symtab_symbol_info (opts
.quiet
, false, args
, TYPES_DOMAIN
, NULL
, from_tty
);
5354 /* Command completer for 'info types' command. */
5357 info_types_command_completer (struct cmd_list_element
*ignore
,
5358 completion_tracker
&tracker
,
5359 const char *text
, const char * /* word */)
5362 = make_info_types_options_def_group (nullptr);
5363 if (gdb::option::complete_options
5364 (tracker
, &text
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, group
))
5367 const char *word
= advance_to_expression_complete_word_point (tracker
, text
);
5368 symbol_completer (ignore
, tracker
, text
, word
);
5371 /* Implement the 'info modules' command. */
5374 info_modules_command (const char *args
, int from_tty
)
5376 info_types_options opts
;
5378 auto grp
= make_info_types_options_def_group (&opts
);
5379 gdb::option::process_options
5380 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
5381 if (args
!= nullptr && *args
== '\0')
5383 symtab_symbol_info (opts
.quiet
, true, args
, MODULES_DOMAIN
, NULL
,
5388 rbreak_command (const char *regexp
, int from_tty
)
5391 const char *file_name
= nullptr;
5393 if (regexp
!= nullptr)
5395 const char *colon
= strchr (regexp
, ':');
5397 /* Ignore the colon if it is part of a Windows drive. */
5398 if (HAS_DRIVE_SPEC (regexp
)
5399 && (regexp
[2] == '/' || regexp
[2] == '\\'))
5400 colon
= strchr (STRIP_DRIVE_SPEC (regexp
), ':');
5402 if (colon
&& *(colon
+ 1) != ':')
5407 colon_index
= colon
- regexp
;
5408 local_name
= (char *) alloca (colon_index
+ 1);
5409 memcpy (local_name
, regexp
, colon_index
);
5410 local_name
[colon_index
--] = 0;
5411 while (isspace (local_name
[colon_index
]))
5412 local_name
[colon_index
--] = 0;
5413 file_name
= local_name
;
5414 regexp
= skip_spaces (colon
+ 1);
5418 global_symbol_searcher
spec (FUNCTIONS_DOMAIN
, regexp
);
5419 if (file_name
!= nullptr)
5420 spec
.filenames
.push_back (file_name
);
5421 std::vector
<symbol_search
> symbols
= spec
.search ();
5423 scoped_rbreak_breakpoints finalize
;
5424 for (const symbol_search
&p
: symbols
)
5426 if (p
.msymbol
.minsym
== NULL
)
5428 struct symtab
*symtab
= symbol_symtab (p
.symbol
);
5429 const char *fullname
= symtab_to_fullname (symtab
);
5431 string
= string_printf ("%s:'%s'", fullname
,
5432 p
.symbol
->linkage_name ());
5433 break_command (&string
[0], from_tty
);
5434 print_symbol_info (FUNCTIONS_DOMAIN
, p
.symbol
, p
.block
, NULL
);
5438 string
= string_printf ("'%s'",
5439 p
.msymbol
.minsym
->linkage_name ());
5441 break_command (&string
[0], from_tty
);
5442 printf_filtered ("<function, no debug info> %s;\n",
5443 p
.msymbol
.minsym
->print_name ());
5449 /* Evaluate if SYMNAME matches LOOKUP_NAME. */
5452 compare_symbol_name (const char *symbol_name
, language symbol_language
,
5453 const lookup_name_info
&lookup_name
,
5454 completion_match_result
&match_res
)
5456 const language_defn
*lang
= language_def (symbol_language
);
5458 symbol_name_matcher_ftype
*name_match
5459 = lang
->get_symbol_name_matcher (lookup_name
);
5461 return name_match (symbol_name
, lookup_name
, &match_res
);
5467 completion_list_add_name (completion_tracker
&tracker
,
5468 language symbol_language
,
5469 const char *symname
,
5470 const lookup_name_info
&lookup_name
,
5471 const char *text
, const char *word
)
5473 completion_match_result
&match_res
5474 = tracker
.reset_completion_match_result ();
5476 /* Clip symbols that cannot match. */
5477 if (!compare_symbol_name (symname
, symbol_language
, lookup_name
, match_res
))
5480 /* Refresh SYMNAME from the match string. It's potentially
5481 different depending on language. (E.g., on Ada, the match may be
5482 the encoded symbol name wrapped in "<>"). */
5483 symname
= match_res
.match
.match ();
5484 gdb_assert (symname
!= NULL
);
5486 /* We have a match for a completion, so add SYMNAME to the current list
5487 of matches. Note that the name is moved to freshly malloc'd space. */
5490 gdb::unique_xmalloc_ptr
<char> completion
5491 = make_completion_match_str (symname
, text
, word
);
5493 /* Here we pass the match-for-lcd object to add_completion. Some
5494 languages match the user text against substrings of symbol
5495 names in some cases. E.g., in C++, "b push_ba" completes to
5496 "std::vector::push_back", "std::string::push_back", etc., and
5497 in this case we want the completion lowest common denominator
5498 to be "push_back" instead of "std::". */
5499 tracker
.add_completion (std::move (completion
),
5500 &match_res
.match_for_lcd
, text
, word
);
5506 /* completion_list_add_name wrapper for struct symbol. */
5509 completion_list_add_symbol (completion_tracker
&tracker
,
5511 const lookup_name_info
&lookup_name
,
5512 const char *text
, const char *word
)
5514 if (!completion_list_add_name (tracker
, sym
->language (),
5515 sym
->natural_name (),
5516 lookup_name
, text
, word
))
5519 /* C++ function symbols include the parameters within both the msymbol
5520 name and the symbol name. The problem is that the msymbol name will
5521 describe the parameters in the most basic way, with typedefs stripped
5522 out, while the symbol name will represent the types as they appear in
5523 the program. This means we will see duplicate entries in the
5524 completion tracker. The following converts the symbol name back to
5525 the msymbol name and removes the msymbol name from the completion
5527 if (sym
->language () == language_cplus
5528 && sym
->domain () == VAR_DOMAIN
5529 && sym
->aclass () == LOC_BLOCK
)
5531 /* The call to canonicalize returns the empty string if the input
5532 string is already in canonical form, thanks to this we don't
5533 remove the symbol we just added above. */
5534 gdb::unique_xmalloc_ptr
<char> str
5535 = cp_canonicalize_string_no_typedefs (sym
->natural_name ());
5537 tracker
.remove_completion (str
.get ());
5541 /* completion_list_add_name wrapper for struct minimal_symbol. */
5544 completion_list_add_msymbol (completion_tracker
&tracker
,
5545 minimal_symbol
*sym
,
5546 const lookup_name_info
&lookup_name
,
5547 const char *text
, const char *word
)
5549 completion_list_add_name (tracker
, sym
->language (),
5550 sym
->natural_name (),
5551 lookup_name
, text
, word
);
5555 /* ObjC: In case we are completing on a selector, look as the msymbol
5556 again and feed all the selectors into the mill. */
5559 completion_list_objc_symbol (completion_tracker
&tracker
,
5560 struct minimal_symbol
*msymbol
,
5561 const lookup_name_info
&lookup_name
,
5562 const char *text
, const char *word
)
5564 static char *tmp
= NULL
;
5565 static unsigned int tmplen
= 0;
5567 const char *method
, *category
, *selector
;
5570 method
= msymbol
->natural_name ();
5572 /* Is it a method? */
5573 if ((method
[0] != '-') && (method
[0] != '+'))
5577 /* Complete on shortened method method. */
5578 completion_list_add_name (tracker
, language_objc
,
5583 while ((strlen (method
) + 1) >= tmplen
)
5589 tmp
= (char *) xrealloc (tmp
, tmplen
);
5591 selector
= strchr (method
, ' ');
5592 if (selector
!= NULL
)
5595 category
= strchr (method
, '(');
5597 if ((category
!= NULL
) && (selector
!= NULL
))
5599 memcpy (tmp
, method
, (category
- method
));
5600 tmp
[category
- method
] = ' ';
5601 memcpy (tmp
+ (category
- method
) + 1, selector
, strlen (selector
) + 1);
5602 completion_list_add_name (tracker
, language_objc
, tmp
,
5603 lookup_name
, text
, word
);
5605 completion_list_add_name (tracker
, language_objc
, tmp
+ 1,
5606 lookup_name
, text
, word
);
5609 if (selector
!= NULL
)
5611 /* Complete on selector only. */
5612 strcpy (tmp
, selector
);
5613 tmp2
= strchr (tmp
, ']');
5617 completion_list_add_name (tracker
, language_objc
, tmp
,
5618 lookup_name
, text
, word
);
5622 /* Break the non-quoted text based on the characters which are in
5623 symbols. FIXME: This should probably be language-specific. */
5626 language_search_unquoted_string (const char *text
, const char *p
)
5628 for (; p
> text
; --p
)
5630 if (isalnum (p
[-1]) || p
[-1] == '_' || p
[-1] == '\0')
5634 if ((current_language
->la_language
== language_objc
))
5636 if (p
[-1] == ':') /* Might be part of a method name. */
5638 else if (p
[-1] == '[' && (p
[-2] == '-' || p
[-2] == '+'))
5639 p
-= 2; /* Beginning of a method name. */
5640 else if (p
[-1] == ' ' || p
[-1] == '(' || p
[-1] == ')')
5641 { /* Might be part of a method name. */
5644 /* Seeing a ' ' or a '(' is not conclusive evidence
5645 that we are in the middle of a method name. However,
5646 finding "-[" or "+[" should be pretty un-ambiguous.
5647 Unfortunately we have to find it now to decide. */
5650 if (isalnum (t
[-1]) || t
[-1] == '_' ||
5651 t
[-1] == ' ' || t
[-1] == ':' ||
5652 t
[-1] == '(' || t
[-1] == ')')
5657 if (t
[-1] == '[' && (t
[-2] == '-' || t
[-2] == '+'))
5658 p
= t
- 2; /* Method name detected. */
5659 /* Else we leave with p unchanged. */
5669 completion_list_add_fields (completion_tracker
&tracker
,
5671 const lookup_name_info
&lookup_name
,
5672 const char *text
, const char *word
)
5674 if (sym
->aclass () == LOC_TYPEDEF
)
5676 struct type
*t
= sym
->type ();
5677 enum type_code c
= t
->code ();
5680 if (c
== TYPE_CODE_UNION
|| c
== TYPE_CODE_STRUCT
)
5681 for (j
= TYPE_N_BASECLASSES (t
); j
< t
->num_fields (); j
++)
5682 if (t
->field (j
).name ())
5683 completion_list_add_name (tracker
, sym
->language (),
5684 t
->field (j
).name (),
5685 lookup_name
, text
, word
);
5692 symbol_is_function_or_method (symbol
*sym
)
5694 switch (sym
->type ()->code ())
5696 case TYPE_CODE_FUNC
:
5697 case TYPE_CODE_METHOD
:
5707 symbol_is_function_or_method (minimal_symbol
*msymbol
)
5709 switch (MSYMBOL_TYPE (msymbol
))
5712 case mst_text_gnu_ifunc
:
5713 case mst_solib_trampoline
:
5723 bound_minimal_symbol
5724 find_gnu_ifunc (const symbol
*sym
)
5726 if (sym
->aclass () != LOC_BLOCK
)
5729 lookup_name_info
lookup_name (sym
->search_name (),
5730 symbol_name_match_type::SEARCH_NAME
);
5731 struct objfile
*objfile
= symbol_objfile (sym
);
5733 CORE_ADDR address
= BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
));
5734 minimal_symbol
*ifunc
= NULL
;
5736 iterate_over_minimal_symbols (objfile
, lookup_name
,
5737 [&] (minimal_symbol
*minsym
)
5739 if (MSYMBOL_TYPE (minsym
) == mst_text_gnu_ifunc
5740 || MSYMBOL_TYPE (minsym
) == mst_data_gnu_ifunc
)
5742 CORE_ADDR msym_addr
= MSYMBOL_VALUE_ADDRESS (objfile
, minsym
);
5743 if (MSYMBOL_TYPE (minsym
) == mst_data_gnu_ifunc
)
5745 struct gdbarch
*gdbarch
= objfile
->arch ();
5746 msym_addr
= gdbarch_convert_from_func_ptr_addr
5747 (gdbarch
, msym_addr
, current_inferior ()->top_target ());
5749 if (msym_addr
== address
)
5759 return {ifunc
, objfile
};
5763 /* Add matching symbols from SYMTAB to the current completion list. */
5766 add_symtab_completions (struct compunit_symtab
*cust
,
5767 completion_tracker
&tracker
,
5768 complete_symbol_mode mode
,
5769 const lookup_name_info
&lookup_name
,
5770 const char *text
, const char *word
,
5771 enum type_code code
)
5774 const struct block
*b
;
5775 struct block_iterator iter
;
5781 for (i
= GLOBAL_BLOCK
; i
<= STATIC_BLOCK
; i
++)
5784 b
= BLOCKVECTOR_BLOCK (cust
->blockvector (), i
);
5785 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
5787 if (completion_skip_symbol (mode
, sym
))
5790 if (code
== TYPE_CODE_UNDEF
5791 || (sym
->domain () == STRUCT_DOMAIN
5792 && sym
->type ()->code () == code
))
5793 completion_list_add_symbol (tracker
, sym
,
5801 default_collect_symbol_completion_matches_break_on
5802 (completion_tracker
&tracker
, complete_symbol_mode mode
,
5803 symbol_name_match_type name_match_type
,
5804 const char *text
, const char *word
,
5805 const char *break_on
, enum type_code code
)
5807 /* Problem: All of the symbols have to be copied because readline
5808 frees them. I'm not going to worry about this; hopefully there
5809 won't be that many. */
5812 const struct block
*b
;
5813 const struct block
*surrounding_static_block
, *surrounding_global_block
;
5814 struct block_iterator iter
;
5815 /* The symbol we are completing on. Points in same buffer as text. */
5816 const char *sym_text
;
5818 /* Now look for the symbol we are supposed to complete on. */
5819 if (mode
== complete_symbol_mode::LINESPEC
)
5825 const char *quote_pos
= NULL
;
5827 /* First see if this is a quoted string. */
5829 for (p
= text
; *p
!= '\0'; ++p
)
5831 if (quote_found
!= '\0')
5833 if (*p
== quote_found
)
5834 /* Found close quote. */
5836 else if (*p
== '\\' && p
[1] == quote_found
)
5837 /* A backslash followed by the quote character
5838 doesn't end the string. */
5841 else if (*p
== '\'' || *p
== '"')
5847 if (quote_found
== '\'')
5848 /* A string within single quotes can be a symbol, so complete on it. */
5849 sym_text
= quote_pos
+ 1;
5850 else if (quote_found
== '"')
5851 /* A double-quoted string is never a symbol, nor does it make sense
5852 to complete it any other way. */
5858 /* It is not a quoted string. Break it based on the characters
5859 which are in symbols. */
5862 if (isalnum (p
[-1]) || p
[-1] == '_' || p
[-1] == '\0'
5863 || p
[-1] == ':' || strchr (break_on
, p
[-1]) != NULL
)
5872 lookup_name_info
lookup_name (sym_text
, name_match_type
, true);
5874 /* At this point scan through the misc symbol vectors and add each
5875 symbol you find to the list. Eventually we want to ignore
5876 anything that isn't a text symbol (everything else will be
5877 handled by the psymtab code below). */
5879 if (code
== TYPE_CODE_UNDEF
)
5881 for (objfile
*objfile
: current_program_space
->objfiles ())
5883 for (minimal_symbol
*msymbol
: objfile
->msymbols ())
5887 if (completion_skip_symbol (mode
, msymbol
))
5890 completion_list_add_msymbol (tracker
, msymbol
, lookup_name
,
5893 completion_list_objc_symbol (tracker
, msymbol
, lookup_name
,
5899 /* Add completions for all currently loaded symbol tables. */
5900 for (objfile
*objfile
: current_program_space
->objfiles ())
5902 for (compunit_symtab
*cust
: objfile
->compunits ())
5903 add_symtab_completions (cust
, tracker
, mode
, lookup_name
,
5904 sym_text
, word
, code
);
5907 /* Look through the partial symtabs for all symbols which begin by
5908 matching SYM_TEXT. Expand all CUs that you find to the list. */
5909 expand_symtabs_matching (NULL
,
5912 [&] (compunit_symtab
*symtab
) /* expansion notify */
5914 add_symtab_completions (symtab
,
5915 tracker
, mode
, lookup_name
,
5916 sym_text
, word
, code
);
5919 SEARCH_GLOBAL_BLOCK
| SEARCH_STATIC_BLOCK
,
5922 /* Search upwards from currently selected frame (so that we can
5923 complete on local vars). Also catch fields of types defined in
5924 this places which match our text string. Only complete on types
5925 visible from current context. */
5927 b
= get_selected_block (0);
5928 surrounding_static_block
= block_static_block (b
);
5929 surrounding_global_block
= block_global_block (b
);
5930 if (surrounding_static_block
!= NULL
)
5931 while (b
!= surrounding_static_block
)
5935 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
5937 if (code
== TYPE_CODE_UNDEF
)
5939 completion_list_add_symbol (tracker
, sym
, lookup_name
,
5941 completion_list_add_fields (tracker
, sym
, lookup_name
,
5944 else if (sym
->domain () == STRUCT_DOMAIN
5945 && sym
->type ()->code () == code
)
5946 completion_list_add_symbol (tracker
, sym
, lookup_name
,
5950 /* Stop when we encounter an enclosing function. Do not stop for
5951 non-inlined functions - the locals of the enclosing function
5952 are in scope for a nested function. */
5953 if (BLOCK_FUNCTION (b
) != NULL
&& block_inlined_p (b
))
5955 b
= BLOCK_SUPERBLOCK (b
);
5958 /* Add fields from the file's types; symbols will be added below. */
5960 if (code
== TYPE_CODE_UNDEF
)
5962 if (surrounding_static_block
!= NULL
)
5963 ALL_BLOCK_SYMBOLS (surrounding_static_block
, iter
, sym
)
5964 completion_list_add_fields (tracker
, sym
, lookup_name
,
5967 if (surrounding_global_block
!= NULL
)
5968 ALL_BLOCK_SYMBOLS (surrounding_global_block
, iter
, sym
)
5969 completion_list_add_fields (tracker
, sym
, lookup_name
,
5973 /* Skip macros if we are completing a struct tag -- arguable but
5974 usually what is expected. */
5975 if (current_language
->macro_expansion () == macro_expansion_c
5976 && code
== TYPE_CODE_UNDEF
)
5978 gdb::unique_xmalloc_ptr
<struct macro_scope
> scope
;
5980 /* This adds a macro's name to the current completion list. */
5981 auto add_macro_name
= [&] (const char *macro_name
,
5982 const macro_definition
*,
5983 macro_source_file
*,
5986 completion_list_add_name (tracker
, language_c
, macro_name
,
5987 lookup_name
, sym_text
, word
);
5990 /* Add any macros visible in the default scope. Note that this
5991 may yield the occasional wrong result, because an expression
5992 might be evaluated in a scope other than the default. For
5993 example, if the user types "break file:line if <TAB>", the
5994 resulting expression will be evaluated at "file:line" -- but
5995 at there does not seem to be a way to detect this at
5997 scope
= default_macro_scope ();
5999 macro_for_each_in_scope (scope
->file
, scope
->line
,
6002 /* User-defined macros are always visible. */
6003 macro_for_each (macro_user_macros
, add_macro_name
);
6007 /* Collect all symbols (regardless of class) which begin by matching
6011 collect_symbol_completion_matches (completion_tracker
&tracker
,
6012 complete_symbol_mode mode
,
6013 symbol_name_match_type name_match_type
,
6014 const char *text
, const char *word
)
6016 current_language
->collect_symbol_completion_matches (tracker
, mode
,
6022 /* Like collect_symbol_completion_matches, but only collect
6023 STRUCT_DOMAIN symbols whose type code is CODE. */
6026 collect_symbol_completion_matches_type (completion_tracker
&tracker
,
6027 const char *text
, const char *word
,
6028 enum type_code code
)
6030 complete_symbol_mode mode
= complete_symbol_mode::EXPRESSION
;
6031 symbol_name_match_type name_match_type
= symbol_name_match_type::EXPRESSION
;
6033 gdb_assert (code
== TYPE_CODE_UNION
6034 || code
== TYPE_CODE_STRUCT
6035 || code
== TYPE_CODE_ENUM
);
6036 current_language
->collect_symbol_completion_matches (tracker
, mode
,
6041 /* Like collect_symbol_completion_matches, but collects a list of
6042 symbols defined in all source files named SRCFILE. */
6045 collect_file_symbol_completion_matches (completion_tracker
&tracker
,
6046 complete_symbol_mode mode
,
6047 symbol_name_match_type name_match_type
,
6048 const char *text
, const char *word
,
6049 const char *srcfile
)
6051 /* The symbol we are completing on. Points in same buffer as text. */
6052 const char *sym_text
;
6054 /* Now look for the symbol we are supposed to complete on.
6055 FIXME: This should be language-specific. */
6056 if (mode
== complete_symbol_mode::LINESPEC
)
6062 const char *quote_pos
= NULL
;
6064 /* First see if this is a quoted string. */
6066 for (p
= text
; *p
!= '\0'; ++p
)
6068 if (quote_found
!= '\0')
6070 if (*p
== quote_found
)
6071 /* Found close quote. */
6073 else if (*p
== '\\' && p
[1] == quote_found
)
6074 /* A backslash followed by the quote character
6075 doesn't end the string. */
6078 else if (*p
== '\'' || *p
== '"')
6084 if (quote_found
== '\'')
6085 /* A string within single quotes can be a symbol, so complete on it. */
6086 sym_text
= quote_pos
+ 1;
6087 else if (quote_found
== '"')
6088 /* A double-quoted string is never a symbol, nor does it make sense
6089 to complete it any other way. */
6095 /* Not a quoted string. */
6096 sym_text
= language_search_unquoted_string (text
, p
);
6100 lookup_name_info
lookup_name (sym_text
, name_match_type
, true);
6102 /* Go through symtabs for SRCFILE and check the externs and statics
6103 for symbols which match. */
6104 iterate_over_symtabs (srcfile
, [&] (symtab
*s
)
6106 add_symtab_completions (s
->compunit (),
6107 tracker
, mode
, lookup_name
,
6108 sym_text
, word
, TYPE_CODE_UNDEF
);
6113 /* A helper function for make_source_files_completion_list. It adds
6114 another file name to a list of possible completions, growing the
6115 list as necessary. */
6118 add_filename_to_list (const char *fname
, const char *text
, const char *word
,
6119 completion_list
*list
)
6121 list
->emplace_back (make_completion_match_str (fname
, text
, word
));
6125 not_interesting_fname (const char *fname
)
6127 static const char *illegal_aliens
[] = {
6128 "_globals_", /* inserted by coff_symtab_read */
6133 for (i
= 0; illegal_aliens
[i
]; i
++)
6135 if (filename_cmp (fname
, illegal_aliens
[i
]) == 0)
6141 /* An object of this type is passed as the callback argument to
6142 map_partial_symbol_filenames. */
6143 struct add_partial_filename_data
6145 struct filename_seen_cache
*filename_seen_cache
;
6149 completion_list
*list
;
6151 void operator() (const char *filename
, const char *fullname
);
6154 /* A callback for map_partial_symbol_filenames. */
6157 add_partial_filename_data::operator() (const char *filename
,
6158 const char *fullname
)
6160 if (not_interesting_fname (filename
))
6162 if (!filename_seen_cache
->seen (filename
)
6163 && filename_ncmp (filename
, text
, text_len
) == 0)
6165 /* This file matches for a completion; add it to the
6166 current list of matches. */
6167 add_filename_to_list (filename
, text
, word
, list
);
6171 const char *base_name
= lbasename (filename
);
6173 if (base_name
!= filename
6174 && !filename_seen_cache
->seen (base_name
)
6175 && filename_ncmp (base_name
, text
, text_len
) == 0)
6176 add_filename_to_list (base_name
, text
, word
, list
);
6180 /* Return a list of all source files whose names begin with matching
6181 TEXT. The file names are looked up in the symbol tables of this
6185 make_source_files_completion_list (const char *text
, const char *word
)
6187 size_t text_len
= strlen (text
);
6188 completion_list list
;
6189 const char *base_name
;
6190 struct add_partial_filename_data datum
;
6192 if (!have_full_symbols () && !have_partial_symbols ())
6195 filename_seen_cache filenames_seen
;
6197 for (objfile
*objfile
: current_program_space
->objfiles ())
6199 for (compunit_symtab
*cu
: objfile
->compunits ())
6201 for (symtab
*s
: cu
->filetabs ())
6203 if (not_interesting_fname (s
->filename
))
6205 if (!filenames_seen
.seen (s
->filename
)
6206 && filename_ncmp (s
->filename
, text
, text_len
) == 0)
6208 /* This file matches for a completion; add it to the current
6210 add_filename_to_list (s
->filename
, text
, word
, &list
);
6214 /* NOTE: We allow the user to type a base name when the
6215 debug info records leading directories, but not the other
6216 way around. This is what subroutines of breakpoint
6217 command do when they parse file names. */
6218 base_name
= lbasename (s
->filename
);
6219 if (base_name
!= s
->filename
6220 && !filenames_seen
.seen (base_name
)
6221 && filename_ncmp (base_name
, text
, text_len
) == 0)
6222 add_filename_to_list (base_name
, text
, word
, &list
);
6228 datum
.filename_seen_cache
= &filenames_seen
;
6231 datum
.text_len
= text_len
;
6233 map_symbol_filenames (datum
, false /*need_fullname*/);
6240 /* Return the "main_info" object for the current program space. If
6241 the object has not yet been created, create it and fill in some
6244 static struct main_info
*
6245 get_main_info (void)
6247 struct main_info
*info
= main_progspace_key
.get (current_program_space
);
6251 /* It may seem strange to store the main name in the progspace
6252 and also in whatever objfile happens to see a main name in
6253 its debug info. The reason for this is mainly historical:
6254 gdb returned "main" as the name even if no function named
6255 "main" was defined the program; and this approach lets us
6256 keep compatibility. */
6257 info
= main_progspace_key
.emplace (current_program_space
);
6264 set_main_name (const char *name
, enum language lang
)
6266 struct main_info
*info
= get_main_info ();
6268 if (info
->name_of_main
!= NULL
)
6270 xfree (info
->name_of_main
);
6271 info
->name_of_main
= NULL
;
6272 info
->language_of_main
= language_unknown
;
6276 info
->name_of_main
= xstrdup (name
);
6277 info
->language_of_main
= lang
;
6281 /* Deduce the name of the main procedure, and set NAME_OF_MAIN
6285 find_main_name (void)
6287 const char *new_main_name
;
6289 /* First check the objfiles to see whether a debuginfo reader has
6290 picked up the appropriate main name. Historically the main name
6291 was found in a more or less random way; this approach instead
6292 relies on the order of objfile creation -- which still isn't
6293 guaranteed to get the correct answer, but is just probably more
6295 for (objfile
*objfile
: current_program_space
->objfiles ())
6297 if (objfile
->per_bfd
->name_of_main
!= NULL
)
6299 set_main_name (objfile
->per_bfd
->name_of_main
,
6300 objfile
->per_bfd
->language_of_main
);
6305 /* Try to see if the main procedure is in Ada. */
6306 /* FIXME: brobecker/2005-03-07: Another way of doing this would
6307 be to add a new method in the language vector, and call this
6308 method for each language until one of them returns a non-empty
6309 name. This would allow us to remove this hard-coded call to
6310 an Ada function. It is not clear that this is a better approach
6311 at this point, because all methods need to be written in a way
6312 such that false positives never be returned. For instance, it is
6313 important that a method does not return a wrong name for the main
6314 procedure if the main procedure is actually written in a different
6315 language. It is easy to guaranty this with Ada, since we use a
6316 special symbol generated only when the main in Ada to find the name
6317 of the main procedure. It is difficult however to see how this can
6318 be guarantied for languages such as C, for instance. This suggests
6319 that order of call for these methods becomes important, which means
6320 a more complicated approach. */
6321 new_main_name
= ada_main_name ();
6322 if (new_main_name
!= NULL
)
6324 set_main_name (new_main_name
, language_ada
);
6328 new_main_name
= d_main_name ();
6329 if (new_main_name
!= NULL
)
6331 set_main_name (new_main_name
, language_d
);
6335 new_main_name
= go_main_name ();
6336 if (new_main_name
!= NULL
)
6338 set_main_name (new_main_name
, language_go
);
6342 new_main_name
= pascal_main_name ();
6343 if (new_main_name
!= NULL
)
6345 set_main_name (new_main_name
, language_pascal
);
6349 /* The languages above didn't identify the name of the main procedure.
6350 Fallback to "main". */
6352 /* Try to find language for main in psymtabs. */
6354 = find_quick_global_symbol_language ("main", VAR_DOMAIN
);
6355 if (lang
!= language_unknown
)
6357 set_main_name ("main", lang
);
6361 set_main_name ("main", language_unknown
);
6369 struct main_info
*info
= get_main_info ();
6371 if (info
->name_of_main
== NULL
)
6374 return info
->name_of_main
;
6377 /* Return the language of the main function. If it is not known,
6378 return language_unknown. */
6381 main_language (void)
6383 struct main_info
*info
= get_main_info ();
6385 if (info
->name_of_main
== NULL
)
6388 return info
->language_of_main
;
6391 /* Handle ``executable_changed'' events for the symtab module. */
6394 symtab_observer_executable_changed (void)
6396 /* NAME_OF_MAIN may no longer be the same, so reset it for now. */
6397 set_main_name (NULL
, language_unknown
);
6400 /* Return 1 if the supplied producer string matches the ARM RealView
6401 compiler (armcc). */
6404 producer_is_realview (const char *producer
)
6406 static const char *const arm_idents
[] = {
6407 "ARM C Compiler, ADS",
6408 "Thumb C Compiler, ADS",
6409 "ARM C++ Compiler, ADS",
6410 "Thumb C++ Compiler, ADS",
6411 "ARM/Thumb C/C++ Compiler, RVCT",
6412 "ARM C/C++ Compiler, RVCT"
6415 if (producer
== NULL
)
6418 for (const char *ident
: arm_idents
)
6419 if (startswith (producer
, ident
))
6427 /* The next index to hand out in response to a registration request. */
6429 static int next_aclass_value
= LOC_FINAL_VALUE
;
6431 /* The maximum number of "aclass" registrations we support. This is
6432 constant for convenience. */
6433 #define MAX_SYMBOL_IMPLS (LOC_FINAL_VALUE + 10)
6435 /* The objects representing the various "aclass" values. The elements
6436 from 0 up to LOC_FINAL_VALUE-1 represent themselves, and subsequent
6437 elements are those registered at gdb initialization time. */
6439 static struct symbol_impl symbol_impl
[MAX_SYMBOL_IMPLS
];
6441 /* The globally visible pointer. This is separate from 'symbol_impl'
6442 so that it can be const. */
6444 const struct symbol_impl
*symbol_impls
= &symbol_impl
[0];
6446 /* Make sure we saved enough room in struct symbol. */
6448 gdb_static_assert (MAX_SYMBOL_IMPLS
<= (1 << SYMBOL_ACLASS_BITS
));
6450 /* Register a computed symbol type. ACLASS must be LOC_COMPUTED. OPS
6451 is the ops vector associated with this index. This returns the new
6452 index, which should be used as the aclass_index field for symbols
6456 register_symbol_computed_impl (enum address_class aclass
,
6457 const struct symbol_computed_ops
*ops
)
6459 int result
= next_aclass_value
++;
6461 gdb_assert (aclass
== LOC_COMPUTED
);
6462 gdb_assert (result
< MAX_SYMBOL_IMPLS
);
6463 symbol_impl
[result
].aclass
= aclass
;
6464 symbol_impl
[result
].ops_computed
= ops
;
6466 /* Sanity check OPS. */
6467 gdb_assert (ops
!= NULL
);
6468 gdb_assert (ops
->tracepoint_var_ref
!= NULL
);
6469 gdb_assert (ops
->describe_location
!= NULL
);
6470 gdb_assert (ops
->get_symbol_read_needs
!= NULL
);
6471 gdb_assert (ops
->read_variable
!= NULL
);
6476 /* Register a function with frame base type. ACLASS must be LOC_BLOCK.
6477 OPS is the ops vector associated with this index. This returns the
6478 new index, which should be used as the aclass_index field for symbols
6482 register_symbol_block_impl (enum address_class aclass
,
6483 const struct symbol_block_ops
*ops
)
6485 int result
= next_aclass_value
++;
6487 gdb_assert (aclass
== LOC_BLOCK
);
6488 gdb_assert (result
< MAX_SYMBOL_IMPLS
);
6489 symbol_impl
[result
].aclass
= aclass
;
6490 symbol_impl
[result
].ops_block
= ops
;
6492 /* Sanity check OPS. */
6493 gdb_assert (ops
!= NULL
);
6494 gdb_assert (ops
->find_frame_base_location
!= NULL
);
6499 /* Register a register symbol type. ACLASS must be LOC_REGISTER or
6500 LOC_REGPARM_ADDR. OPS is the register ops vector associated with
6501 this index. This returns the new index, which should be used as
6502 the aclass_index field for symbols of this type. */
6505 register_symbol_register_impl (enum address_class aclass
,
6506 const struct symbol_register_ops
*ops
)
6508 int result
= next_aclass_value
++;
6510 gdb_assert (aclass
== LOC_REGISTER
|| aclass
== LOC_REGPARM_ADDR
);
6511 gdb_assert (result
< MAX_SYMBOL_IMPLS
);
6512 symbol_impl
[result
].aclass
= aclass
;
6513 symbol_impl
[result
].ops_register
= ops
;
6518 /* Initialize elements of 'symbol_impl' for the constants in enum
6522 initialize_ordinary_address_classes (void)
6526 for (i
= 0; i
< LOC_FINAL_VALUE
; ++i
)
6527 symbol_impl
[i
].aclass
= (enum address_class
) i
;
6535 symbol_objfile (const struct symbol
*symbol
)
6537 gdb_assert (symbol
->is_objfile_owned ());
6538 return symbol
->owner
.symtab
->objfile ();
6544 symbol_arch (const struct symbol
*symbol
)
6546 if (!symbol
->is_objfile_owned ())
6547 return symbol
->owner
.arch
;
6548 return symbol
->owner
.symtab
->objfile ()->arch ();
6554 symbol_symtab (const struct symbol
*symbol
)
6556 gdb_assert (symbol
->is_objfile_owned ());
6557 return symbol
->owner
.symtab
;
6563 symbol_set_symtab (struct symbol
*symbol
, struct symtab
*symtab
)
6565 gdb_assert (symbol
->is_objfile_owned ());
6566 symbol
->owner
.symtab
= symtab
;
6572 get_symbol_address (const struct symbol
*sym
)
6574 gdb_assert (sym
->maybe_copied
);
6575 gdb_assert (sym
->aclass () == LOC_STATIC
);
6577 const char *linkage_name
= sym
->linkage_name ();
6579 for (objfile
*objfile
: current_program_space
->objfiles ())
6581 if (objfile
->separate_debug_objfile_backlink
!= nullptr)
6584 bound_minimal_symbol minsym
6585 = lookup_minimal_symbol_linkage (linkage_name
, objfile
);
6586 if (minsym
.minsym
!= nullptr)
6587 return BMSYMBOL_VALUE_ADDRESS (minsym
);
6589 return sym
->value
.address
;
6595 get_msymbol_address (struct objfile
*objf
, const struct minimal_symbol
*minsym
)
6597 gdb_assert (minsym
->maybe_copied
);
6598 gdb_assert ((objf
->flags
& OBJF_MAINLINE
) == 0);
6600 const char *linkage_name
= minsym
->linkage_name ();
6602 for (objfile
*objfile
: current_program_space
->objfiles ())
6604 if (objfile
->separate_debug_objfile_backlink
== nullptr
6605 && (objfile
->flags
& OBJF_MAINLINE
) != 0)
6607 bound_minimal_symbol found
6608 = lookup_minimal_symbol_linkage (linkage_name
, objfile
);
6609 if (found
.minsym
!= nullptr)
6610 return BMSYMBOL_VALUE_ADDRESS (found
);
6613 return (minsym
->value
.address
6614 + objf
->section_offsets
[minsym
->section_index ()]);
6619 /* Hold the sub-commands of 'info module'. */
6621 static struct cmd_list_element
*info_module_cmdlist
= NULL
;
6625 std::vector
<module_symbol_search
>
6626 search_module_symbols (const char *module_regexp
, const char *regexp
,
6627 const char *type_regexp
, search_domain kind
)
6629 std::vector
<module_symbol_search
> results
;
6631 /* Search for all modules matching MODULE_REGEXP. */
6632 global_symbol_searcher
spec1 (MODULES_DOMAIN
, module_regexp
);
6633 spec1
.set_exclude_minsyms (true);
6634 std::vector
<symbol_search
> modules
= spec1
.search ();
6636 /* Now search for all symbols of the required KIND matching the required
6637 regular expressions. We figure out which ones are in which modules
6639 global_symbol_searcher
spec2 (kind
, regexp
);
6640 spec2
.set_symbol_type_regexp (type_regexp
);
6641 spec2
.set_exclude_minsyms (true);
6642 std::vector
<symbol_search
> symbols
= spec2
.search ();
6644 /* Now iterate over all MODULES, checking to see which items from
6645 SYMBOLS are in each module. */
6646 for (const symbol_search
&p
: modules
)
6650 /* This is a module. */
6651 gdb_assert (p
.symbol
!= nullptr);
6653 std::string prefix
= p
.symbol
->print_name ();
6656 for (const symbol_search
&q
: symbols
)
6658 if (q
.symbol
== nullptr)
6661 if (strncmp (q
.symbol
->print_name (), prefix
.c_str (),
6662 prefix
.size ()) != 0)
6665 results
.push_back ({p
, q
});
6672 /* Implement the core of both 'info module functions' and 'info module
6676 info_module_subcommand (bool quiet
, const char *module_regexp
,
6677 const char *regexp
, const char *type_regexp
,
6680 /* Print a header line. Don't build the header line bit by bit as this
6681 prevents internationalisation. */
6684 if (module_regexp
== nullptr)
6686 if (type_regexp
== nullptr)
6688 if (regexp
== nullptr)
6689 printf_filtered ((kind
== VARIABLES_DOMAIN
6690 ? _("All variables in all modules:")
6691 : _("All functions in all modules:")));
6694 ((kind
== VARIABLES_DOMAIN
6695 ? _("All variables matching regular expression"
6696 " \"%s\" in all modules:")
6697 : _("All functions matching regular expression"
6698 " \"%s\" in all modules:")),
6703 if (regexp
== nullptr)
6705 ((kind
== VARIABLES_DOMAIN
6706 ? _("All variables with type matching regular "
6707 "expression \"%s\" in all modules:")
6708 : _("All functions with type matching regular "
6709 "expression \"%s\" in all modules:")),
6713 ((kind
== VARIABLES_DOMAIN
6714 ? _("All variables matching regular expression "
6715 "\"%s\",\n\twith type matching regular "
6716 "expression \"%s\" in all modules:")
6717 : _("All functions matching regular expression "
6718 "\"%s\",\n\twith type matching regular "
6719 "expression \"%s\" in all modules:")),
6720 regexp
, type_regexp
);
6725 if (type_regexp
== nullptr)
6727 if (regexp
== nullptr)
6729 ((kind
== VARIABLES_DOMAIN
6730 ? _("All variables in all modules matching regular "
6731 "expression \"%s\":")
6732 : _("All functions in all modules matching regular "
6733 "expression \"%s\":")),
6737 ((kind
== VARIABLES_DOMAIN
6738 ? _("All variables matching regular expression "
6739 "\"%s\",\n\tin all modules matching regular "
6740 "expression \"%s\":")
6741 : _("All functions matching regular expression "
6742 "\"%s\",\n\tin all modules matching regular "
6743 "expression \"%s\":")),
6744 regexp
, module_regexp
);
6748 if (regexp
== nullptr)
6750 ((kind
== VARIABLES_DOMAIN
6751 ? _("All variables with type matching regular "
6752 "expression \"%s\"\n\tin all modules matching "
6753 "regular expression \"%s\":")
6754 : _("All functions with type matching regular "
6755 "expression \"%s\"\n\tin all modules matching "
6756 "regular expression \"%s\":")),
6757 type_regexp
, module_regexp
);
6760 ((kind
== VARIABLES_DOMAIN
6761 ? _("All variables matching regular expression "
6762 "\"%s\",\n\twith type matching regular expression "
6763 "\"%s\",\n\tin all modules matching regular "
6764 "expression \"%s\":")
6765 : _("All functions matching regular expression "
6766 "\"%s\",\n\twith type matching regular expression "
6767 "\"%s\",\n\tin all modules matching regular "
6768 "expression \"%s\":")),
6769 regexp
, type_regexp
, module_regexp
);
6772 printf_filtered ("\n");
6775 /* Find all symbols of type KIND matching the given regular expressions
6776 along with the symbols for the modules in which those symbols
6778 std::vector
<module_symbol_search
> module_symbols
6779 = search_module_symbols (module_regexp
, regexp
, type_regexp
, kind
);
6781 std::sort (module_symbols
.begin (), module_symbols
.end (),
6782 [] (const module_symbol_search
&a
, const module_symbol_search
&b
)
6784 if (a
.first
< b
.first
)
6786 else if (a
.first
== b
.first
)
6787 return a
.second
< b
.second
;
6792 const char *last_filename
= "";
6793 const symbol
*last_module_symbol
= nullptr;
6794 for (const module_symbol_search
&ms
: module_symbols
)
6796 const symbol_search
&p
= ms
.first
;
6797 const symbol_search
&q
= ms
.second
;
6799 gdb_assert (q
.symbol
!= nullptr);
6801 if (last_module_symbol
!= p
.symbol
)
6803 printf_filtered ("\n");
6804 printf_filtered (_("Module \"%s\":\n"), p
.symbol
->print_name ());
6805 last_module_symbol
= p
.symbol
;
6809 print_symbol_info (FUNCTIONS_DOMAIN
, q
.symbol
, q
.block
,
6812 = symtab_to_filename_for_display (symbol_symtab (q
.symbol
));
6816 /* Hold the option values for the 'info module .....' sub-commands. */
6818 struct info_modules_var_func_options
6821 std::string type_regexp
;
6822 std::string module_regexp
;
6825 /* The options used by 'info module variables' and 'info module functions'
6828 static const gdb::option::option_def info_modules_var_func_options_defs
[] = {
6829 gdb::option::boolean_option_def
<info_modules_var_func_options
> {
6831 [] (info_modules_var_func_options
*opt
) { return &opt
->quiet
; },
6832 nullptr, /* show_cmd_cb */
6833 nullptr /* set_doc */
6836 gdb::option::string_option_def
<info_modules_var_func_options
> {
6838 [] (info_modules_var_func_options
*opt
) { return &opt
->type_regexp
; },
6839 nullptr, /* show_cmd_cb */
6840 nullptr /* set_doc */
6843 gdb::option::string_option_def
<info_modules_var_func_options
> {
6845 [] (info_modules_var_func_options
*opt
) { return &opt
->module_regexp
; },
6846 nullptr, /* show_cmd_cb */
6847 nullptr /* set_doc */
6851 /* Return the option group used by the 'info module ...' sub-commands. */
6853 static inline gdb::option::option_def_group
6854 make_info_modules_var_func_options_def_group
6855 (info_modules_var_func_options
*opts
)
6857 return {{info_modules_var_func_options_defs
}, opts
};
6860 /* Implements the 'info module functions' command. */
6863 info_module_functions_command (const char *args
, int from_tty
)
6865 info_modules_var_func_options opts
;
6866 auto grp
= make_info_modules_var_func_options_def_group (&opts
);
6867 gdb::option::process_options
6868 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
6869 if (args
!= nullptr && *args
== '\0')
6872 info_module_subcommand
6874 opts
.module_regexp
.empty () ? nullptr : opts
.module_regexp
.c_str (), args
,
6875 opts
.type_regexp
.empty () ? nullptr : opts
.type_regexp
.c_str (),
6879 /* Implements the 'info module variables' command. */
6882 info_module_variables_command (const char *args
, int from_tty
)
6884 info_modules_var_func_options opts
;
6885 auto grp
= make_info_modules_var_func_options_def_group (&opts
);
6886 gdb::option::process_options
6887 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
6888 if (args
!= nullptr && *args
== '\0')
6891 info_module_subcommand
6893 opts
.module_regexp
.empty () ? nullptr : opts
.module_regexp
.c_str (), args
,
6894 opts
.type_regexp
.empty () ? nullptr : opts
.type_regexp
.c_str (),
6898 /* Command completer for 'info module ...' sub-commands. */
6901 info_module_var_func_command_completer (struct cmd_list_element
*ignore
,
6902 completion_tracker
&tracker
,
6904 const char * /* word */)
6907 const auto group
= make_info_modules_var_func_options_def_group (nullptr);
6908 if (gdb::option::complete_options
6909 (tracker
, &text
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, group
))
6912 const char *word
= advance_to_expression_complete_word_point (tracker
, text
);
6913 symbol_completer (ignore
, tracker
, text
, word
);
6918 void _initialize_symtab ();
6920 _initialize_symtab ()
6922 cmd_list_element
*c
;
6924 initialize_ordinary_address_classes ();
6926 c
= add_info ("variables", info_variables_command
,
6927 info_print_args_help (_("\
6928 All global and static variable names or those matching REGEXPs.\n\
6929 Usage: info variables [-q] [-n] [-t TYPEREGEXP] [NAMEREGEXP]\n\
6930 Prints the global and static variables.\n"),
6931 _("global and static variables"),
6933 set_cmd_completer_handle_brkchars (c
, info_vars_funcs_command_completer
);
6936 c
= add_com ("whereis", class_info
, info_variables_command
,
6937 info_print_args_help (_("\
6938 All global and static variable names, or those matching REGEXPs.\n\
6939 Usage: whereis [-q] [-n] [-t TYPEREGEXP] [NAMEREGEXP]\n\
6940 Prints the global and static variables.\n"),
6941 _("global and static variables"),
6943 set_cmd_completer_handle_brkchars (c
, info_vars_funcs_command_completer
);
6946 c
= add_info ("functions", info_functions_command
,
6947 info_print_args_help (_("\
6948 All function names or those matching REGEXPs.\n\
6949 Usage: info functions [-q] [-n] [-t TYPEREGEXP] [NAMEREGEXP]\n\
6950 Prints the functions.\n"),
6953 set_cmd_completer_handle_brkchars (c
, info_vars_funcs_command_completer
);
6955 c
= add_info ("types", info_types_command
, _("\
6956 All type names, or those matching REGEXP.\n\
6957 Usage: info types [-q] [REGEXP]\n\
6958 Print information about all types matching REGEXP, or all types if no\n\
6959 REGEXP is given. The optional flag -q disables printing of headers."));
6960 set_cmd_completer_handle_brkchars (c
, info_types_command_completer
);
6962 const auto info_sources_opts
6963 = make_info_sources_options_def_group (nullptr);
6965 static std::string info_sources_help
6966 = gdb::option::build_help (_("\
6967 All source files in the program or those matching REGEXP.\n\
6968 Usage: info sources [OPTION]... [REGEXP]\n\
6969 By default, REGEXP is used to match anywhere in the filename.\n\
6975 c
= add_info ("sources", info_sources_command
, info_sources_help
.c_str ());
6976 set_cmd_completer_handle_brkchars (c
, info_sources_command_completer
);
6978 c
= add_info ("modules", info_modules_command
,
6979 _("All module names, or those matching REGEXP."));
6980 set_cmd_completer_handle_brkchars (c
, info_types_command_completer
);
6982 add_basic_prefix_cmd ("module", class_info
, _("\
6983 Print information about modules."),
6984 &info_module_cmdlist
, 0, &infolist
);
6986 c
= add_cmd ("functions", class_info
, info_module_functions_command
, _("\
6987 Display functions arranged by modules.\n\
6988 Usage: info module functions [-q] [-m MODREGEXP] [-t TYPEREGEXP] [REGEXP]\n\
6989 Print a summary of all functions within each Fortran module, grouped by\n\
6990 module and file. For each function the line on which the function is\n\
6991 defined is given along with the type signature and name of the function.\n\
6993 If REGEXP is provided then only functions whose name matches REGEXP are\n\
6994 listed. If MODREGEXP is provided then only functions in modules matching\n\
6995 MODREGEXP are listed. If TYPEREGEXP is given then only functions whose\n\
6996 type signature matches TYPEREGEXP are listed.\n\
6998 The -q flag suppresses printing some header information."),
6999 &info_module_cmdlist
);
7000 set_cmd_completer_handle_brkchars
7001 (c
, info_module_var_func_command_completer
);
7003 c
= add_cmd ("variables", class_info
, info_module_variables_command
, _("\
7004 Display variables arranged by modules.\n\
7005 Usage: info module variables [-q] [-m MODREGEXP] [-t TYPEREGEXP] [REGEXP]\n\
7006 Print a summary of all variables within each Fortran module, grouped by\n\
7007 module and file. For each variable the line on which the variable is\n\
7008 defined is given along with the type and name of the variable.\n\
7010 If REGEXP is provided then only variables whose name matches REGEXP are\n\
7011 listed. If MODREGEXP is provided then only variables in modules matching\n\
7012 MODREGEXP are listed. If TYPEREGEXP is given then only variables whose\n\
7013 type matches TYPEREGEXP are listed.\n\
7015 The -q flag suppresses printing some header information."),
7016 &info_module_cmdlist
);
7017 set_cmd_completer_handle_brkchars
7018 (c
, info_module_var_func_command_completer
);
7020 add_com ("rbreak", class_breakpoint
, rbreak_command
,
7021 _("Set a breakpoint for all functions matching REGEXP."));
7023 add_setshow_enum_cmd ("multiple-symbols", no_class
,
7024 multiple_symbols_modes
, &multiple_symbols_mode
,
7026 Set how the debugger handles ambiguities in expressions."), _("\
7027 Show how the debugger handles ambiguities in expressions."), _("\
7028 Valid values are \"ask\", \"all\", \"cancel\", and the default is \"all\"."),
7029 NULL
, NULL
, &setlist
, &showlist
);
7031 add_setshow_boolean_cmd ("basenames-may-differ", class_obscure
,
7032 &basenames_may_differ
, _("\
7033 Set whether a source file may have multiple base names."), _("\
7034 Show whether a source file may have multiple base names."), _("\
7035 (A \"base name\" is the name of a file with the directory part removed.\n\
7036 Example: The base name of \"/home/user/hello.c\" is \"hello.c\".)\n\
7037 If set, GDB will canonicalize file names (e.g., expand symlinks)\n\
7038 before comparing them. Canonicalization is an expensive operation,\n\
7039 but it allows the same file be known by more than one base name.\n\
7040 If not set (the default), all source files are assumed to have just\n\
7041 one base name, and gdb will do file name comparisons more efficiently."),
7043 &setlist
, &showlist
);
7045 add_setshow_zuinteger_cmd ("symtab-create", no_class
, &symtab_create_debug
,
7046 _("Set debugging of symbol table creation."),
7047 _("Show debugging of symbol table creation."), _("\
7048 When enabled (non-zero), debugging messages are printed when building\n\
7049 symbol tables. A value of 1 (one) normally provides enough information.\n\
7050 A value greater than 1 provides more verbose information."),
7053 &setdebuglist
, &showdebuglist
);
7055 add_setshow_zuinteger_cmd ("symbol-lookup", no_class
, &symbol_lookup_debug
,
7057 Set debugging of symbol lookup."), _("\
7058 Show debugging of symbol lookup."), _("\
7059 When enabled (non-zero), symbol lookups are logged."),
7061 &setdebuglist
, &showdebuglist
);
7063 add_setshow_zuinteger_cmd ("symbol-cache-size", no_class
,
7064 &new_symbol_cache_size
,
7065 _("Set the size of the symbol cache."),
7066 _("Show the size of the symbol cache."), _("\
7067 The size of the symbol cache.\n\
7068 If zero then the symbol cache is disabled."),
7069 set_symbol_cache_size_handler
, NULL
,
7070 &maintenance_set_cmdlist
,
7071 &maintenance_show_cmdlist
);
7073 add_cmd ("symbol-cache", class_maintenance
, maintenance_print_symbol_cache
,
7074 _("Dump the symbol cache for each program space."),
7075 &maintenanceprintlist
);
7077 add_cmd ("symbol-cache-statistics", class_maintenance
,
7078 maintenance_print_symbol_cache_statistics
,
7079 _("Print symbol cache statistics for each program space."),
7080 &maintenanceprintlist
);
7082 cmd_list_element
*maintenance_flush_symbol_cache_cmd
7083 = add_cmd ("symbol-cache", class_maintenance
,
7084 maintenance_flush_symbol_cache
,
7085 _("Flush the symbol cache for each program space."),
7086 &maintenanceflushlist
);
7087 c
= add_alias_cmd ("flush-symbol-cache", maintenance_flush_symbol_cache_cmd
,
7088 class_maintenance
, 0, &maintenancelist
);
7089 deprecate_cmd (c
, "maintenancelist flush symbol-cache");
7091 gdb::observers::executable_changed
.attach (symtab_observer_executable_changed
,
7093 gdb::observers::new_objfile
.attach (symtab_new_objfile_observer
, "symtab");
7094 gdb::observers::free_objfile
.attach (symtab_free_objfile_observer
, "symtab");