1 /* Symbol table lookup for the GNU debugger, GDB.
3 Copyright (C) 1986-2020 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
30 #include "gdb_regex.h"
31 #include "expression.h"
36 #include "filenames.h" /* for FILENAME_CMP */
37 #include "objc-lang.h"
43 #include "cli/cli-utils.h"
44 #include "cli/cli-style.h"
47 #include "typeprint.h"
49 #include "gdb_obstack.h"
51 #include "dictionary.h"
53 #include <sys/types.h>
58 #include "cp-support.h"
59 #include "observable.h"
62 #include "macroscope.h"
64 #include "parser-defs.h"
65 #include "completer.h"
66 #include "progspace-and-thread.h"
67 #include "gdbsupport/gdb_optional.h"
68 #include "filename-seen-cache.h"
69 #include "arch-utils.h"
71 #include "gdbsupport/gdb_string_view.h"
72 #include "gdbsupport/pathstuff.h"
73 #include "gdbsupport/common-utils.h"
75 /* Forward declarations for local functions. */
77 static void rbreak_command (const char *, int);
79 static int find_line_common (struct linetable
*, int, int *, int);
81 static struct block_symbol
82 lookup_symbol_aux (const char *name
,
83 symbol_name_match_type match_type
,
84 const struct block
*block
,
85 const domain_enum domain
,
86 enum language language
,
87 struct field_of_this_result
*);
90 struct block_symbol
lookup_local_symbol (const char *name
,
91 symbol_name_match_type match_type
,
92 const struct block
*block
,
93 const domain_enum domain
,
94 enum language language
);
96 static struct block_symbol
97 lookup_symbol_in_objfile (struct objfile
*objfile
,
98 enum block_enum block_index
,
99 const char *name
, const domain_enum domain
);
101 /* Type of the data stored on the program space. */
105 main_info () = default;
109 xfree (name_of_main
);
112 /* Name of "main". */
114 char *name_of_main
= nullptr;
116 /* Language of "main". */
118 enum language language_of_main
= language_unknown
;
121 /* Program space key for finding name and language of "main". */
123 static const program_space_key
<main_info
> main_progspace_key
;
125 /* The default symbol cache size.
126 There is no extra cpu cost for large N (except when flushing the cache,
127 which is rare). The value here is just a first attempt. A better default
128 value may be higher or lower. A prime number can make up for a bad hash
129 computation, so that's why the number is what it is. */
130 #define DEFAULT_SYMBOL_CACHE_SIZE 1021
132 /* The maximum symbol cache size.
133 There's no method to the decision of what value to use here, other than
134 there's no point in allowing a user typo to make gdb consume all memory. */
135 #define MAX_SYMBOL_CACHE_SIZE (1024*1024)
137 /* symbol_cache_lookup returns this if a previous lookup failed to find the
138 symbol in any objfile. */
139 #define SYMBOL_LOOKUP_FAILED \
140 ((struct block_symbol) {(struct symbol *) 1, NULL})
141 #define SYMBOL_LOOKUP_FAILED_P(SIB) (SIB.symbol == (struct symbol *) 1)
143 /* Recording lookups that don't find the symbol is just as important, if not
144 more so, than recording found symbols. */
146 enum symbol_cache_slot_state
149 SYMBOL_SLOT_NOT_FOUND
,
153 struct symbol_cache_slot
155 enum symbol_cache_slot_state state
;
157 /* The objfile that was current when the symbol was looked up.
158 This is only needed for global blocks, but for simplicity's sake
159 we allocate the space for both. If data shows the extra space used
160 for static blocks is a problem, we can split things up then.
162 Global blocks need cache lookup to include the objfile context because
163 we need to account for gdbarch_iterate_over_objfiles_in_search_order
164 which can traverse objfiles in, effectively, any order, depending on
165 the current objfile, thus affecting which symbol is found. Normally,
166 only the current objfile is searched first, and then the rest are
167 searched in recorded order; but putting cache lookup inside
168 gdbarch_iterate_over_objfiles_in_search_order would be awkward.
169 Instead we just make the current objfile part of the context of
170 cache lookup. This means we can record the same symbol multiple times,
171 each with a different "current objfile" that was in effect when the
172 lookup was saved in the cache, but cache space is pretty cheap. */
173 const struct objfile
*objfile_context
;
177 struct block_symbol found
;
186 /* Clear out SLOT. */
189 symbol_cache_clear_slot (struct symbol_cache_slot
*slot
)
191 if (slot
->state
== SYMBOL_SLOT_NOT_FOUND
)
192 xfree (slot
->value
.not_found
.name
);
193 slot
->state
= SYMBOL_SLOT_UNUSED
;
196 /* Symbols don't specify global vs static block.
197 So keep them in separate caches. */
199 struct block_symbol_cache
203 unsigned int collisions
;
205 /* SYMBOLS is a variable length array of this size.
206 One can imagine that in general one cache (global/static) should be a
207 fraction of the size of the other, but there's no data at the moment
208 on which to decide. */
211 struct symbol_cache_slot symbols
[1];
214 /* Clear all slots of BSC and free BSC. */
217 destroy_block_symbol_cache (struct block_symbol_cache
*bsc
)
221 for (unsigned int i
= 0; i
< bsc
->size
; i
++)
222 symbol_cache_clear_slot (&bsc
->symbols
[i
]);
229 Searching for symbols in the static and global blocks over multiple objfiles
230 again and again can be slow, as can searching very big objfiles. This is a
231 simple cache to improve symbol lookup performance, which is critical to
232 overall gdb performance.
234 Symbols are hashed on the name, its domain, and block.
235 They are also hashed on their objfile for objfile-specific lookups. */
239 symbol_cache () = default;
243 destroy_block_symbol_cache (global_symbols
);
244 destroy_block_symbol_cache (static_symbols
);
247 struct block_symbol_cache
*global_symbols
= nullptr;
248 struct block_symbol_cache
*static_symbols
= nullptr;
251 /* Program space key for finding its symbol cache. */
253 static const program_space_key
<symbol_cache
> symbol_cache_key
;
255 /* When non-zero, print debugging messages related to symtab creation. */
256 unsigned int symtab_create_debug
= 0;
258 /* When non-zero, print debugging messages related to symbol lookup. */
259 unsigned int symbol_lookup_debug
= 0;
261 /* The size of the cache is staged here. */
262 static unsigned int new_symbol_cache_size
= DEFAULT_SYMBOL_CACHE_SIZE
;
264 /* The current value of the symbol cache size.
265 This is saved so that if the user enters a value too big we can restore
266 the original value from here. */
267 static unsigned int symbol_cache_size
= DEFAULT_SYMBOL_CACHE_SIZE
;
269 /* True if a file may be known by two different basenames.
270 This is the uncommon case, and significantly slows down gdb.
271 Default set to "off" to not slow down the common case. */
272 bool basenames_may_differ
= false;
274 /* Allow the user to configure the debugger behavior with respect
275 to multiple-choice menus when more than one symbol matches during
278 const char multiple_symbols_ask
[] = "ask";
279 const char multiple_symbols_all
[] = "all";
280 const char multiple_symbols_cancel
[] = "cancel";
281 static const char *const multiple_symbols_modes
[] =
283 multiple_symbols_ask
,
284 multiple_symbols_all
,
285 multiple_symbols_cancel
,
288 static const char *multiple_symbols_mode
= multiple_symbols_all
;
290 /* Read-only accessor to AUTO_SELECT_MODE. */
293 multiple_symbols_select_mode (void)
295 return multiple_symbols_mode
;
298 /* Return the name of a domain_enum. */
301 domain_name (domain_enum e
)
305 case UNDEF_DOMAIN
: return "UNDEF_DOMAIN";
306 case VAR_DOMAIN
: return "VAR_DOMAIN";
307 case STRUCT_DOMAIN
: return "STRUCT_DOMAIN";
308 case MODULE_DOMAIN
: return "MODULE_DOMAIN";
309 case LABEL_DOMAIN
: return "LABEL_DOMAIN";
310 case COMMON_BLOCK_DOMAIN
: return "COMMON_BLOCK_DOMAIN";
311 default: gdb_assert_not_reached ("bad domain_enum");
315 /* Return the name of a search_domain . */
318 search_domain_name (enum search_domain e
)
322 case VARIABLES_DOMAIN
: return "VARIABLES_DOMAIN";
323 case FUNCTIONS_DOMAIN
: return "FUNCTIONS_DOMAIN";
324 case TYPES_DOMAIN
: return "TYPES_DOMAIN";
325 case MODULES_DOMAIN
: return "MODULES_DOMAIN";
326 case ALL_DOMAIN
: return "ALL_DOMAIN";
327 default: gdb_assert_not_reached ("bad search_domain");
334 compunit_primary_filetab (const struct compunit_symtab
*cust
)
336 gdb_assert (COMPUNIT_FILETABS (cust
) != NULL
);
338 /* The primary file symtab is the first one in the list. */
339 return COMPUNIT_FILETABS (cust
);
345 compunit_language (const struct compunit_symtab
*cust
)
347 struct symtab
*symtab
= compunit_primary_filetab (cust
);
349 /* The language of the compunit symtab is the language of its primary
351 return SYMTAB_LANGUAGE (symtab
);
357 minimal_symbol::data_p () const
359 return type
== mst_data
362 || type
== mst_file_data
363 || type
== mst_file_bss
;
369 minimal_symbol::text_p () const
371 return type
== mst_text
372 || type
== mst_text_gnu_ifunc
373 || type
== mst_data_gnu_ifunc
374 || type
== mst_slot_got_plt
375 || type
== mst_solib_trampoline
376 || type
== mst_file_text
;
379 /* See whether FILENAME matches SEARCH_NAME using the rule that we
380 advertise to the user. (The manual's description of linespecs
381 describes what we advertise). Returns true if they match, false
385 compare_filenames_for_search (const char *filename
, const char *search_name
)
387 int len
= strlen (filename
);
388 size_t search_len
= strlen (search_name
);
390 if (len
< search_len
)
393 /* The tail of FILENAME must match. */
394 if (FILENAME_CMP (filename
+ len
- search_len
, search_name
) != 0)
397 /* Either the names must completely match, or the character
398 preceding the trailing SEARCH_NAME segment of FILENAME must be a
401 The check !IS_ABSOLUTE_PATH ensures SEARCH_NAME "/dir/file.c"
402 cannot match FILENAME "/path//dir/file.c" - as user has requested
403 absolute path. The sama applies for "c:\file.c" possibly
404 incorrectly hypothetically matching "d:\dir\c:\file.c".
406 The HAS_DRIVE_SPEC purpose is to make FILENAME "c:file.c"
407 compatible with SEARCH_NAME "file.c". In such case a compiler had
408 to put the "c:file.c" name into debug info. Such compatibility
409 works only on GDB built for DOS host. */
410 return (len
== search_len
411 || (!IS_ABSOLUTE_PATH (search_name
)
412 && IS_DIR_SEPARATOR (filename
[len
- search_len
- 1]))
413 || (HAS_DRIVE_SPEC (filename
)
414 && STRIP_DRIVE_SPEC (filename
) == &filename
[len
- search_len
]));
417 /* Same as compare_filenames_for_search, but for glob-style patterns.
418 Heads up on the order of the arguments. They match the order of
419 compare_filenames_for_search, but it's the opposite of the order of
420 arguments to gdb_filename_fnmatch. */
423 compare_glob_filenames_for_search (const char *filename
,
424 const char *search_name
)
426 /* We rely on the property of glob-style patterns with FNM_FILE_NAME that
427 all /s have to be explicitly specified. */
428 int file_path_elements
= count_path_elements (filename
);
429 int search_path_elements
= count_path_elements (search_name
);
431 if (search_path_elements
> file_path_elements
)
434 if (IS_ABSOLUTE_PATH (search_name
))
436 return (search_path_elements
== file_path_elements
437 && gdb_filename_fnmatch (search_name
, filename
,
438 FNM_FILE_NAME
| FNM_NOESCAPE
) == 0);
442 const char *file_to_compare
443 = strip_leading_path_elements (filename
,
444 file_path_elements
- search_path_elements
);
446 return gdb_filename_fnmatch (search_name
, file_to_compare
,
447 FNM_FILE_NAME
| FNM_NOESCAPE
) == 0;
451 /* Check for a symtab of a specific name by searching some symtabs.
452 This is a helper function for callbacks of iterate_over_symtabs.
454 If NAME is not absolute, then REAL_PATH is NULL
455 If NAME is absolute, then REAL_PATH is the gdb_realpath form of NAME.
457 The return value, NAME, REAL_PATH and CALLBACK are identical to the
458 `map_symtabs_matching_filename' method of quick_symbol_functions.
460 FIRST and AFTER_LAST indicate the range of compunit symtabs to search.
461 Each symtab within the specified compunit symtab is also searched.
462 AFTER_LAST is one past the last compunit symtab to search; NULL means to
463 search until the end of the list. */
466 iterate_over_some_symtabs (const char *name
,
467 const char *real_path
,
468 struct compunit_symtab
*first
,
469 struct compunit_symtab
*after_last
,
470 gdb::function_view
<bool (symtab
*)> callback
)
472 struct compunit_symtab
*cust
;
473 const char* base_name
= lbasename (name
);
475 for (cust
= first
; cust
!= NULL
&& cust
!= after_last
; cust
= cust
->next
)
477 for (symtab
*s
: compunit_filetabs (cust
))
479 if (compare_filenames_for_search (s
->filename
, name
))
486 /* Before we invoke realpath, which can get expensive when many
487 files are involved, do a quick comparison of the basenames. */
488 if (! basenames_may_differ
489 && FILENAME_CMP (base_name
, lbasename (s
->filename
)) != 0)
492 if (compare_filenames_for_search (symtab_to_fullname (s
), name
))
499 /* If the user gave us an absolute path, try to find the file in
500 this symtab and use its absolute path. */
501 if (real_path
!= NULL
)
503 const char *fullname
= symtab_to_fullname (s
);
505 gdb_assert (IS_ABSOLUTE_PATH (real_path
));
506 gdb_assert (IS_ABSOLUTE_PATH (name
));
507 gdb::unique_xmalloc_ptr
<char> fullname_real_path
508 = gdb_realpath (fullname
);
509 fullname
= fullname_real_path
.get ();
510 if (FILENAME_CMP (real_path
, fullname
) == 0)
523 /* Check for a symtab of a specific name; first in symtabs, then in
524 psymtabs. *If* there is no '/' in the name, a match after a '/'
525 in the symtab filename will also work.
527 Calls CALLBACK with each symtab that is found. If CALLBACK returns
528 true, the search stops. */
531 iterate_over_symtabs (const char *name
,
532 gdb::function_view
<bool (symtab
*)> callback
)
534 gdb::unique_xmalloc_ptr
<char> real_path
;
536 /* Here we are interested in canonicalizing an absolute path, not
537 absolutizing a relative path. */
538 if (IS_ABSOLUTE_PATH (name
))
540 real_path
= gdb_realpath (name
);
541 gdb_assert (IS_ABSOLUTE_PATH (real_path
.get ()));
544 for (objfile
*objfile
: current_program_space
->objfiles ())
546 if (iterate_over_some_symtabs (name
, real_path
.get (),
547 objfile
->compunit_symtabs
, NULL
,
552 /* Same search rules as above apply here, but now we look thru the
555 for (objfile
*objfile
: current_program_space
->objfiles ())
558 && objfile
->sf
->qf
->map_symtabs_matching_filename (objfile
,
566 /* A wrapper for iterate_over_symtabs that returns the first matching
570 lookup_symtab (const char *name
)
572 struct symtab
*result
= NULL
;
574 iterate_over_symtabs (name
, [&] (symtab
*symtab
)
584 /* Mangle a GDB method stub type. This actually reassembles the pieces of the
585 full method name, which consist of the class name (from T), the unadorned
586 method name from METHOD_ID, and the signature for the specific overload,
587 specified by SIGNATURE_ID. Note that this function is g++ specific. */
590 gdb_mangle_name (struct type
*type
, int method_id
, int signature_id
)
592 int mangled_name_len
;
594 struct fn_field
*f
= TYPE_FN_FIELDLIST1 (type
, method_id
);
595 struct fn_field
*method
= &f
[signature_id
];
596 const char *field_name
= TYPE_FN_FIELDLIST_NAME (type
, method_id
);
597 const char *physname
= TYPE_FN_FIELD_PHYSNAME (f
, signature_id
);
598 const char *newname
= TYPE_NAME (type
);
600 /* Does the form of physname indicate that it is the full mangled name
601 of a constructor (not just the args)? */
602 int is_full_physname_constructor
;
605 int is_destructor
= is_destructor_name (physname
);
606 /* Need a new type prefix. */
607 const char *const_prefix
= method
->is_const
? "C" : "";
608 const char *volatile_prefix
= method
->is_volatile
? "V" : "";
610 int len
= (newname
== NULL
? 0 : strlen (newname
));
612 /* Nothing to do if physname already contains a fully mangled v3 abi name
613 or an operator name. */
614 if ((physname
[0] == '_' && physname
[1] == 'Z')
615 || is_operator_name (field_name
))
616 return xstrdup (physname
);
618 is_full_physname_constructor
= is_constructor_name (physname
);
620 is_constructor
= is_full_physname_constructor
621 || (newname
&& strcmp (field_name
, newname
) == 0);
624 is_destructor
= (startswith (physname
, "__dt"));
626 if (is_destructor
|| is_full_physname_constructor
)
628 mangled_name
= (char *) xmalloc (strlen (physname
) + 1);
629 strcpy (mangled_name
, physname
);
635 xsnprintf (buf
, sizeof (buf
), "__%s%s", const_prefix
, volatile_prefix
);
637 else if (physname
[0] == 't' || physname
[0] == 'Q')
639 /* The physname for template and qualified methods already includes
641 xsnprintf (buf
, sizeof (buf
), "__%s%s", const_prefix
, volatile_prefix
);
647 xsnprintf (buf
, sizeof (buf
), "__%s%s%d", const_prefix
,
648 volatile_prefix
, len
);
650 mangled_name_len
= ((is_constructor
? 0 : strlen (field_name
))
651 + strlen (buf
) + len
+ strlen (physname
) + 1);
653 mangled_name
= (char *) xmalloc (mangled_name_len
);
655 mangled_name
[0] = '\0';
657 strcpy (mangled_name
, field_name
);
659 strcat (mangled_name
, buf
);
660 /* If the class doesn't have a name, i.e. newname NULL, then we just
661 mangle it using 0 for the length of the class. Thus it gets mangled
662 as something starting with `::' rather than `classname::'. */
664 strcat (mangled_name
, newname
);
666 strcat (mangled_name
, physname
);
667 return (mangled_name
);
670 /* Set the demangled name of GSYMBOL to NAME. NAME must be already
671 correctly allocated. */
674 symbol_set_demangled_name (struct general_symbol_info
*gsymbol
,
676 struct obstack
*obstack
)
678 if (gsymbol
->language () == language_ada
)
682 gsymbol
->ada_mangled
= 0;
683 gsymbol
->language_specific
.obstack
= obstack
;
687 gsymbol
->ada_mangled
= 1;
688 gsymbol
->language_specific
.demangled_name
= name
;
692 gsymbol
->language_specific
.demangled_name
= name
;
695 /* Return the demangled name of GSYMBOL. */
698 symbol_get_demangled_name (const struct general_symbol_info
*gsymbol
)
700 if (gsymbol
->language () == language_ada
)
702 if (!gsymbol
->ada_mangled
)
707 return gsymbol
->language_specific
.demangled_name
;
711 /* Initialize the language dependent portion of a symbol
712 depending upon the language for the symbol. */
715 general_symbol_info::set_language (enum language language
,
716 struct obstack
*obstack
)
718 m_language
= language
;
719 if (language
== language_cplus
720 || language
== language_d
721 || language
== language_go
722 || language
== language_objc
723 || language
== language_fortran
)
725 symbol_set_demangled_name (this, NULL
, obstack
);
727 else if (language
== language_ada
)
729 gdb_assert (ada_mangled
== 0);
730 language_specific
.obstack
= obstack
;
734 memset (&language_specific
, 0, sizeof (language_specific
));
738 /* Functions to initialize a symbol's mangled name. */
740 /* Objects of this type are stored in the demangled name hash table. */
741 struct demangled_name_entry
743 demangled_name_entry (gdb::string_view mangled_name
)
744 : mangled (mangled_name
) {}
746 gdb::string_view mangled
;
747 enum language language
;
748 gdb::unique_xmalloc_ptr
<char> demangled
;
751 /* Hash function for the demangled name hash. */
754 hash_demangled_name_entry (const void *data
)
756 const struct demangled_name_entry
*e
757 = (const struct demangled_name_entry
*) data
;
759 return fast_hash (e
->mangled
.data (), e
->mangled
.length ());
762 /* Equality function for the demangled name hash. */
765 eq_demangled_name_entry (const void *a
, const void *b
)
767 const struct demangled_name_entry
*da
768 = (const struct demangled_name_entry
*) a
;
769 const struct demangled_name_entry
*db
770 = (const struct demangled_name_entry
*) b
;
772 return da
->mangled
== db
->mangled
;
776 free_demangled_name_entry (void *data
)
778 struct demangled_name_entry
*e
779 = (struct demangled_name_entry
*) data
;
781 e
->~demangled_name_entry();
784 /* Create the hash table used for demangled names. Each hash entry is
785 a pair of strings; one for the mangled name and one for the demangled
786 name. The entry is hashed via just the mangled name. */
789 create_demangled_names_hash (struct objfile_per_bfd_storage
*per_bfd
)
791 /* Choose 256 as the starting size of the hash table, somewhat arbitrarily.
792 The hash table code will round this up to the next prime number.
793 Choosing a much larger table size wastes memory, and saves only about
794 1% in symbol reading. However, if the minsym count is already
795 initialized (e.g. because symbol name setting was deferred to
796 a background thread) we can initialize the hashtable with a count
797 based on that, because we will almost certainly have at least that
798 many entries. If we have a nonzero number but less than 256,
799 we still stay with 256 to have some space for psymbols, etc. */
801 /* htab will expand the table when it is 3/4th full, so we account for that
802 here. +2 to round up. */
803 int minsym_based_count
= (per_bfd
->minimal_symbol_count
+ 2) / 3 * 4;
804 int count
= std::max (per_bfd
->minimal_symbol_count
, minsym_based_count
);
806 per_bfd
->demangled_names_hash
.reset (htab_create_alloc
807 (count
, hash_demangled_name_entry
, eq_demangled_name_entry
,
808 free_demangled_name_entry
, xcalloc
, xfree
));
814 symbol_find_demangled_name (struct general_symbol_info
*gsymbol
,
817 char *demangled
= NULL
;
820 if (gsymbol
->language () == language_unknown
)
821 gsymbol
->m_language
= language_auto
;
823 if (gsymbol
->language () != language_auto
)
825 const struct language_defn
*lang
= language_def (gsymbol
->language ());
827 language_sniff_from_mangled_name (lang
, mangled
, &demangled
);
831 for (i
= language_unknown
; i
< nr_languages
; ++i
)
833 enum language l
= (enum language
) i
;
834 const struct language_defn
*lang
= language_def (l
);
836 if (language_sniff_from_mangled_name (lang
, mangled
, &demangled
))
838 gsymbol
->m_language
= l
;
846 /* Set both the mangled and demangled (if any) names for GSYMBOL based
847 on LINKAGE_NAME and LEN. Ordinarily, NAME is copied onto the
848 objfile's obstack; but if COPY_NAME is 0 and if NAME is
849 NUL-terminated, then this function assumes that NAME is already
850 correctly saved (either permanently or with a lifetime tied to the
851 objfile), and it will not be copied.
853 The hash table corresponding to OBJFILE is used, and the memory
854 comes from the per-BFD storage_obstack. LINKAGE_NAME is copied,
855 so the pointer can be discarded after calling this function. */
858 general_symbol_info::compute_and_set_names (gdb::string_view linkage_name
,
860 objfile_per_bfd_storage
*per_bfd
,
861 gdb::optional
<hashval_t
> hash
)
863 struct demangled_name_entry
**slot
;
865 if (language () == language_ada
)
867 /* In Ada, we do the symbol lookups using the mangled name, so
868 we can save some space by not storing the demangled name. */
870 m_name
= linkage_name
.data ();
872 m_name
= obstack_strndup (&per_bfd
->storage_obstack
,
873 linkage_name
.data (),
874 linkage_name
.length ());
875 symbol_set_demangled_name (this, NULL
, &per_bfd
->storage_obstack
);
880 if (per_bfd
->demangled_names_hash
== NULL
)
881 create_demangled_names_hash (per_bfd
);
883 struct demangled_name_entry
entry (linkage_name
);
884 if (!hash
.has_value ())
885 hash
= hash_demangled_name_entry (&entry
);
886 slot
= ((struct demangled_name_entry
**)
887 htab_find_slot_with_hash (per_bfd
->demangled_names_hash
.get (),
888 &entry
, *hash
, INSERT
));
890 /* The const_cast is safe because the only reason it is already
891 initialized is if we purposefully set it from a background
892 thread to avoid doing the work here. However, it is still
893 allocated from the heap and needs to be freed by us, just
894 like if we called symbol_find_demangled_name here. If this is
895 nullptr, we call symbol_find_demangled_name below, but we put
896 this smart pointer here to be sure that we don't leak this name. */
897 gdb::unique_xmalloc_ptr
<char> demangled_name
898 (const_cast<char *> (language_specific
.demangled_name
));
900 /* If this name is not in the hash table, add it. */
902 /* A C version of the symbol may have already snuck into the table.
903 This happens to, e.g., main.init (__go_init_main). Cope. */
904 || (language () == language_go
&& (*slot
)->demangled
== nullptr))
906 /* A 0-terminated copy of the linkage name. Callers must set COPY_NAME
907 to true if the string might not be nullterminated. We have to make
908 this copy because demangling needs a nullterminated string. */
909 gdb::string_view linkage_name_copy
;
912 char *alloc_name
= (char *) alloca (linkage_name
.length () + 1);
913 memcpy (alloc_name
, linkage_name
.data (), linkage_name
.length ());
914 alloc_name
[linkage_name
.length ()] = '\0';
916 linkage_name_copy
= gdb::string_view (alloc_name
,
917 linkage_name
.length ());
920 linkage_name_copy
= linkage_name
;
922 if (demangled_name
.get () == nullptr)
924 (symbol_find_demangled_name (this, linkage_name_copy
.data ()));
926 /* Suppose we have demangled_name==NULL, copy_name==0, and
927 linkage_name_copy==linkage_name. In this case, we already have the
928 mangled name saved, and we don't have a demangled name. So,
929 you might think we could save a little space by not recording
930 this in the hash table at all.
932 It turns out that it is actually important to still save such
933 an entry in the hash table, because storing this name gives
934 us better bcache hit rates for partial symbols. */
938 = ((struct demangled_name_entry
*)
939 obstack_alloc (&per_bfd
->storage_obstack
,
940 sizeof (demangled_name_entry
)));
941 new (*slot
) demangled_name_entry (linkage_name
);
945 /* If we must copy the mangled name, put it directly after
946 the struct so we can have a single allocation. */
948 = ((struct demangled_name_entry
*)
949 obstack_alloc (&per_bfd
->storage_obstack
,
950 sizeof (demangled_name_entry
)
951 + linkage_name
.length () + 1));
952 char *mangled_ptr
= reinterpret_cast<char *> (*slot
+ 1);
953 memcpy (mangled_ptr
, linkage_name
.data (), linkage_name
.length ());
954 mangled_ptr
[linkage_name
.length ()] = '\0';
955 new (*slot
) demangled_name_entry
956 (gdb::string_view (mangled_ptr
, linkage_name
.length ()));
958 (*slot
)->demangled
= std::move (demangled_name
);
959 (*slot
)->language
= language ();
961 else if (language () == language_unknown
|| language () == language_auto
)
962 m_language
= (*slot
)->language
;
964 m_name
= (*slot
)->mangled
.data ();
965 symbol_set_demangled_name (this, (*slot
)->demangled
.get (),
966 &per_bfd
->storage_obstack
);
972 general_symbol_info::natural_name () const
980 case language_fortran
:
981 if (symbol_get_demangled_name (this) != NULL
)
982 return symbol_get_demangled_name (this);
985 return ada_decode_symbol (this);
989 return linkage_name ();
995 general_symbol_info::demangled_name () const
997 const char *dem_name
= NULL
;
1001 case language_cplus
:
1005 case language_fortran
:
1006 dem_name
= symbol_get_demangled_name (this);
1009 dem_name
= ada_decode_symbol (this);
1020 general_symbol_info::search_name () const
1022 if (language () == language_ada
)
1023 return linkage_name ();
1025 return natural_name ();
1031 symbol_matches_search_name (const struct general_symbol_info
*gsymbol
,
1032 const lookup_name_info
&name
)
1034 symbol_name_matcher_ftype
*name_match
1035 = get_symbol_name_matcher (language_def (gsymbol
->language ()), name
);
1036 return name_match (gsymbol
->search_name (), name
, NULL
);
1041 /* Return true if the two sections are the same, or if they could
1042 plausibly be copies of each other, one in an original object
1043 file and another in a separated debug file. */
1046 matching_obj_sections (struct obj_section
*obj_first
,
1047 struct obj_section
*obj_second
)
1049 asection
*first
= obj_first
? obj_first
->the_bfd_section
: NULL
;
1050 asection
*second
= obj_second
? obj_second
->the_bfd_section
: NULL
;
1052 /* If they're the same section, then they match. */
1053 if (first
== second
)
1056 /* If either is NULL, give up. */
1057 if (first
== NULL
|| second
== NULL
)
1060 /* This doesn't apply to absolute symbols. */
1061 if (first
->owner
== NULL
|| second
->owner
== NULL
)
1064 /* If they're in the same object file, they must be different sections. */
1065 if (first
->owner
== second
->owner
)
1068 /* Check whether the two sections are potentially corresponding. They must
1069 have the same size, address, and name. We can't compare section indexes,
1070 which would be more reliable, because some sections may have been
1072 if (bfd_section_size (first
) != bfd_section_size (second
))
1075 /* In-memory addresses may start at a different offset, relativize them. */
1076 if (bfd_section_vma (first
) - bfd_get_start_address (first
->owner
)
1077 != bfd_section_vma (second
) - bfd_get_start_address (second
->owner
))
1080 if (bfd_section_name (first
) == NULL
1081 || bfd_section_name (second
) == NULL
1082 || strcmp (bfd_section_name (first
), bfd_section_name (second
)) != 0)
1085 /* Otherwise check that they are in corresponding objfiles. */
1087 struct objfile
*obj
= NULL
;
1088 for (objfile
*objfile
: current_program_space
->objfiles ())
1089 if (objfile
->obfd
== first
->owner
)
1094 gdb_assert (obj
!= NULL
);
1096 if (obj
->separate_debug_objfile
!= NULL
1097 && obj
->separate_debug_objfile
->obfd
== second
->owner
)
1099 if (obj
->separate_debug_objfile_backlink
!= NULL
1100 && obj
->separate_debug_objfile_backlink
->obfd
== second
->owner
)
1109 expand_symtab_containing_pc (CORE_ADDR pc
, struct obj_section
*section
)
1111 struct bound_minimal_symbol msymbol
;
1113 /* If we know that this is not a text address, return failure. This is
1114 necessary because we loop based on texthigh and textlow, which do
1115 not include the data ranges. */
1116 msymbol
= lookup_minimal_symbol_by_pc_section (pc
, section
);
1117 if (msymbol
.minsym
&& msymbol
.minsym
->data_p ())
1120 for (objfile
*objfile
: current_program_space
->objfiles ())
1122 struct compunit_symtab
*cust
= NULL
;
1125 cust
= objfile
->sf
->qf
->find_pc_sect_compunit_symtab (objfile
, msymbol
,
1132 /* Hash function for the symbol cache. */
1135 hash_symbol_entry (const struct objfile
*objfile_context
,
1136 const char *name
, domain_enum domain
)
1138 unsigned int hash
= (uintptr_t) objfile_context
;
1141 hash
+= htab_hash_string (name
);
1143 /* Because of symbol_matches_domain we need VAR_DOMAIN and STRUCT_DOMAIN
1144 to map to the same slot. */
1145 if (domain
== STRUCT_DOMAIN
)
1146 hash
+= VAR_DOMAIN
* 7;
1153 /* Equality function for the symbol cache. */
1156 eq_symbol_entry (const struct symbol_cache_slot
*slot
,
1157 const struct objfile
*objfile_context
,
1158 const char *name
, domain_enum domain
)
1160 const char *slot_name
;
1161 domain_enum slot_domain
;
1163 if (slot
->state
== SYMBOL_SLOT_UNUSED
)
1166 if (slot
->objfile_context
!= objfile_context
)
1169 if (slot
->state
== SYMBOL_SLOT_NOT_FOUND
)
1171 slot_name
= slot
->value
.not_found
.name
;
1172 slot_domain
= slot
->value
.not_found
.domain
;
1176 slot_name
= slot
->value
.found
.symbol
->search_name ();
1177 slot_domain
= SYMBOL_DOMAIN (slot
->value
.found
.symbol
);
1180 /* NULL names match. */
1181 if (slot_name
== NULL
&& name
== NULL
)
1183 /* But there's no point in calling symbol_matches_domain in the
1184 SYMBOL_SLOT_FOUND case. */
1185 if (slot_domain
!= domain
)
1188 else if (slot_name
!= NULL
&& name
!= NULL
)
1190 /* It's important that we use the same comparison that was done
1191 the first time through. If the slot records a found symbol,
1192 then this means using the symbol name comparison function of
1193 the symbol's language with symbol->search_name (). See
1194 dictionary.c. It also means using symbol_matches_domain for
1195 found symbols. See block.c.
1197 If the slot records a not-found symbol, then require a precise match.
1198 We could still be lax with whitespace like strcmp_iw though. */
1200 if (slot
->state
== SYMBOL_SLOT_NOT_FOUND
)
1202 if (strcmp (slot_name
, name
) != 0)
1204 if (slot_domain
!= domain
)
1209 struct symbol
*sym
= slot
->value
.found
.symbol
;
1210 lookup_name_info
lookup_name (name
, symbol_name_match_type::FULL
);
1212 if (!SYMBOL_MATCHES_SEARCH_NAME (sym
, lookup_name
))
1215 if (!symbol_matches_domain (sym
->language (), slot_domain
, domain
))
1221 /* Only one name is NULL. */
1228 /* Given a cache of size SIZE, return the size of the struct (with variable
1229 length array) in bytes. */
1232 symbol_cache_byte_size (unsigned int size
)
1234 return (sizeof (struct block_symbol_cache
)
1235 + ((size
- 1) * sizeof (struct symbol_cache_slot
)));
1241 resize_symbol_cache (struct symbol_cache
*cache
, unsigned int new_size
)
1243 /* If there's no change in size, don't do anything.
1244 All caches have the same size, so we can just compare with the size
1245 of the global symbols cache. */
1246 if ((cache
->global_symbols
!= NULL
1247 && cache
->global_symbols
->size
== new_size
)
1248 || (cache
->global_symbols
== NULL
1252 destroy_block_symbol_cache (cache
->global_symbols
);
1253 destroy_block_symbol_cache (cache
->static_symbols
);
1257 cache
->global_symbols
= NULL
;
1258 cache
->static_symbols
= NULL
;
1262 size_t total_size
= symbol_cache_byte_size (new_size
);
1264 cache
->global_symbols
1265 = (struct block_symbol_cache
*) xcalloc (1, total_size
);
1266 cache
->static_symbols
1267 = (struct block_symbol_cache
*) xcalloc (1, total_size
);
1268 cache
->global_symbols
->size
= new_size
;
1269 cache
->static_symbols
->size
= new_size
;
1273 /* Return the symbol cache of PSPACE.
1274 Create one if it doesn't exist yet. */
1276 static struct symbol_cache
*
1277 get_symbol_cache (struct program_space
*pspace
)
1279 struct symbol_cache
*cache
= symbol_cache_key
.get (pspace
);
1283 cache
= symbol_cache_key
.emplace (pspace
);
1284 resize_symbol_cache (cache
, symbol_cache_size
);
1290 /* Set the size of the symbol cache in all program spaces. */
1293 set_symbol_cache_size (unsigned int new_size
)
1295 struct program_space
*pspace
;
1297 ALL_PSPACES (pspace
)
1299 struct symbol_cache
*cache
= symbol_cache_key
.get (pspace
);
1301 /* The pspace could have been created but not have a cache yet. */
1303 resize_symbol_cache (cache
, new_size
);
1307 /* Called when symbol-cache-size is set. */
1310 set_symbol_cache_size_handler (const char *args
, int from_tty
,
1311 struct cmd_list_element
*c
)
1313 if (new_symbol_cache_size
> MAX_SYMBOL_CACHE_SIZE
)
1315 /* Restore the previous value.
1316 This is the value the "show" command prints. */
1317 new_symbol_cache_size
= symbol_cache_size
;
1319 error (_("Symbol cache size is too large, max is %u."),
1320 MAX_SYMBOL_CACHE_SIZE
);
1322 symbol_cache_size
= new_symbol_cache_size
;
1324 set_symbol_cache_size (symbol_cache_size
);
1327 /* Lookup symbol NAME,DOMAIN in BLOCK in the symbol cache of PSPACE.
1328 OBJFILE_CONTEXT is the current objfile, which may be NULL.
1329 The result is the symbol if found, SYMBOL_LOOKUP_FAILED if a previous lookup
1330 failed (and thus this one will too), or NULL if the symbol is not present
1332 *BSC_PTR and *SLOT_PTR are set to the cache and slot of the symbol, which
1333 can be used to save the result of a full lookup attempt. */
1335 static struct block_symbol
1336 symbol_cache_lookup (struct symbol_cache
*cache
,
1337 struct objfile
*objfile_context
, enum block_enum block
,
1338 const char *name
, domain_enum domain
,
1339 struct block_symbol_cache
**bsc_ptr
,
1340 struct symbol_cache_slot
**slot_ptr
)
1342 struct block_symbol_cache
*bsc
;
1344 struct symbol_cache_slot
*slot
;
1346 if (block
== GLOBAL_BLOCK
)
1347 bsc
= cache
->global_symbols
;
1349 bsc
= cache
->static_symbols
;
1357 hash
= hash_symbol_entry (objfile_context
, name
, domain
);
1358 slot
= bsc
->symbols
+ hash
% bsc
->size
;
1363 if (eq_symbol_entry (slot
, objfile_context
, name
, domain
))
1365 if (symbol_lookup_debug
)
1366 fprintf_unfiltered (gdb_stdlog
,
1367 "%s block symbol cache hit%s for %s, %s\n",
1368 block
== GLOBAL_BLOCK
? "Global" : "Static",
1369 slot
->state
== SYMBOL_SLOT_NOT_FOUND
1370 ? " (not found)" : "",
1371 name
, domain_name (domain
));
1373 if (slot
->state
== SYMBOL_SLOT_NOT_FOUND
)
1374 return SYMBOL_LOOKUP_FAILED
;
1375 return slot
->value
.found
;
1378 /* Symbol is not present in the cache. */
1380 if (symbol_lookup_debug
)
1382 fprintf_unfiltered (gdb_stdlog
,
1383 "%s block symbol cache miss for %s, %s\n",
1384 block
== GLOBAL_BLOCK
? "Global" : "Static",
1385 name
, domain_name (domain
));
1391 /* Mark SYMBOL as found in SLOT.
1392 OBJFILE_CONTEXT is the current objfile when the lookup was done, or NULL
1393 if it's not needed to distinguish lookups (STATIC_BLOCK). It is *not*
1394 necessarily the objfile the symbol was found in. */
1397 symbol_cache_mark_found (struct block_symbol_cache
*bsc
,
1398 struct symbol_cache_slot
*slot
,
1399 struct objfile
*objfile_context
,
1400 struct symbol
*symbol
,
1401 const struct block
*block
)
1405 if (slot
->state
!= SYMBOL_SLOT_UNUSED
)
1408 symbol_cache_clear_slot (slot
);
1410 slot
->state
= SYMBOL_SLOT_FOUND
;
1411 slot
->objfile_context
= objfile_context
;
1412 slot
->value
.found
.symbol
= symbol
;
1413 slot
->value
.found
.block
= block
;
1416 /* Mark symbol NAME, DOMAIN as not found in SLOT.
1417 OBJFILE_CONTEXT is the current objfile when the lookup was done, or NULL
1418 if it's not needed to distinguish lookups (STATIC_BLOCK). */
1421 symbol_cache_mark_not_found (struct block_symbol_cache
*bsc
,
1422 struct symbol_cache_slot
*slot
,
1423 struct objfile
*objfile_context
,
1424 const char *name
, domain_enum domain
)
1428 if (slot
->state
!= SYMBOL_SLOT_UNUSED
)
1431 symbol_cache_clear_slot (slot
);
1433 slot
->state
= SYMBOL_SLOT_NOT_FOUND
;
1434 slot
->objfile_context
= objfile_context
;
1435 slot
->value
.not_found
.name
= xstrdup (name
);
1436 slot
->value
.not_found
.domain
= domain
;
1439 /* Flush the symbol cache of PSPACE. */
1442 symbol_cache_flush (struct program_space
*pspace
)
1444 struct symbol_cache
*cache
= symbol_cache_key
.get (pspace
);
1449 if (cache
->global_symbols
== NULL
)
1451 gdb_assert (symbol_cache_size
== 0);
1452 gdb_assert (cache
->static_symbols
== NULL
);
1456 /* If the cache is untouched since the last flush, early exit.
1457 This is important for performance during the startup of a program linked
1458 with 100s (or 1000s) of shared libraries. */
1459 if (cache
->global_symbols
->misses
== 0
1460 && cache
->static_symbols
->misses
== 0)
1463 gdb_assert (cache
->global_symbols
->size
== symbol_cache_size
);
1464 gdb_assert (cache
->static_symbols
->size
== symbol_cache_size
);
1466 for (pass
= 0; pass
< 2; ++pass
)
1468 struct block_symbol_cache
*bsc
1469 = pass
== 0 ? cache
->global_symbols
: cache
->static_symbols
;
1472 for (i
= 0; i
< bsc
->size
; ++i
)
1473 symbol_cache_clear_slot (&bsc
->symbols
[i
]);
1476 cache
->global_symbols
->hits
= 0;
1477 cache
->global_symbols
->misses
= 0;
1478 cache
->global_symbols
->collisions
= 0;
1479 cache
->static_symbols
->hits
= 0;
1480 cache
->static_symbols
->misses
= 0;
1481 cache
->static_symbols
->collisions
= 0;
1487 symbol_cache_dump (const struct symbol_cache
*cache
)
1491 if (cache
->global_symbols
== NULL
)
1493 printf_filtered (" <disabled>\n");
1497 for (pass
= 0; pass
< 2; ++pass
)
1499 const struct block_symbol_cache
*bsc
1500 = pass
== 0 ? cache
->global_symbols
: cache
->static_symbols
;
1504 printf_filtered ("Global symbols:\n");
1506 printf_filtered ("Static symbols:\n");
1508 for (i
= 0; i
< bsc
->size
; ++i
)
1510 const struct symbol_cache_slot
*slot
= &bsc
->symbols
[i
];
1514 switch (slot
->state
)
1516 case SYMBOL_SLOT_UNUSED
:
1518 case SYMBOL_SLOT_NOT_FOUND
:
1519 printf_filtered (" [%4u] = %s, %s %s (not found)\n", i
,
1520 host_address_to_string (slot
->objfile_context
),
1521 slot
->value
.not_found
.name
,
1522 domain_name (slot
->value
.not_found
.domain
));
1524 case SYMBOL_SLOT_FOUND
:
1526 struct symbol
*found
= slot
->value
.found
.symbol
;
1527 const struct objfile
*context
= slot
->objfile_context
;
1529 printf_filtered (" [%4u] = %s, %s %s\n", i
,
1530 host_address_to_string (context
),
1531 found
->print_name (),
1532 domain_name (SYMBOL_DOMAIN (found
)));
1540 /* The "mt print symbol-cache" command. */
1543 maintenance_print_symbol_cache (const char *args
, int from_tty
)
1545 struct program_space
*pspace
;
1547 ALL_PSPACES (pspace
)
1549 struct symbol_cache
*cache
;
1551 printf_filtered (_("Symbol cache for pspace %d\n%s:\n"),
1553 pspace
->symfile_object_file
!= NULL
1554 ? objfile_name (pspace
->symfile_object_file
)
1555 : "(no object file)");
1557 /* If the cache hasn't been created yet, avoid creating one. */
1558 cache
= symbol_cache_key
.get (pspace
);
1560 printf_filtered (" <empty>\n");
1562 symbol_cache_dump (cache
);
1566 /* The "mt flush-symbol-cache" command. */
1569 maintenance_flush_symbol_cache (const char *args
, int from_tty
)
1571 struct program_space
*pspace
;
1573 ALL_PSPACES (pspace
)
1575 symbol_cache_flush (pspace
);
1579 /* Print usage statistics of CACHE. */
1582 symbol_cache_stats (struct symbol_cache
*cache
)
1586 if (cache
->global_symbols
== NULL
)
1588 printf_filtered (" <disabled>\n");
1592 for (pass
= 0; pass
< 2; ++pass
)
1594 const struct block_symbol_cache
*bsc
1595 = pass
== 0 ? cache
->global_symbols
: cache
->static_symbols
;
1600 printf_filtered ("Global block cache stats:\n");
1602 printf_filtered ("Static block cache stats:\n");
1604 printf_filtered (" size: %u\n", bsc
->size
);
1605 printf_filtered (" hits: %u\n", bsc
->hits
);
1606 printf_filtered (" misses: %u\n", bsc
->misses
);
1607 printf_filtered (" collisions: %u\n", bsc
->collisions
);
1611 /* The "mt print symbol-cache-statistics" command. */
1614 maintenance_print_symbol_cache_statistics (const char *args
, int from_tty
)
1616 struct program_space
*pspace
;
1618 ALL_PSPACES (pspace
)
1620 struct symbol_cache
*cache
;
1622 printf_filtered (_("Symbol cache statistics for pspace %d\n%s:\n"),
1624 pspace
->symfile_object_file
!= NULL
1625 ? objfile_name (pspace
->symfile_object_file
)
1626 : "(no object file)");
1628 /* If the cache hasn't been created yet, avoid creating one. */
1629 cache
= symbol_cache_key
.get (pspace
);
1631 printf_filtered (" empty, no stats available\n");
1633 symbol_cache_stats (cache
);
1637 /* This module's 'new_objfile' observer. */
1640 symtab_new_objfile_observer (struct objfile
*objfile
)
1642 /* Ideally we'd use OBJFILE->pspace, but OBJFILE may be NULL. */
1643 symbol_cache_flush (current_program_space
);
1646 /* This module's 'free_objfile' observer. */
1649 symtab_free_objfile_observer (struct objfile
*objfile
)
1651 symbol_cache_flush (objfile
->pspace
);
1654 /* Debug symbols usually don't have section information. We need to dig that
1655 out of the minimal symbols and stash that in the debug symbol. */
1658 fixup_section (struct general_symbol_info
*ginfo
,
1659 CORE_ADDR addr
, struct objfile
*objfile
)
1661 struct minimal_symbol
*msym
;
1663 /* First, check whether a minimal symbol with the same name exists
1664 and points to the same address. The address check is required
1665 e.g. on PowerPC64, where the minimal symbol for a function will
1666 point to the function descriptor, while the debug symbol will
1667 point to the actual function code. */
1668 msym
= lookup_minimal_symbol_by_pc_name (addr
, ginfo
->linkage_name (),
1671 ginfo
->section
= MSYMBOL_SECTION (msym
);
1674 /* Static, function-local variables do appear in the linker
1675 (minimal) symbols, but are frequently given names that won't
1676 be found via lookup_minimal_symbol(). E.g., it has been
1677 observed in frv-uclinux (ELF) executables that a static,
1678 function-local variable named "foo" might appear in the
1679 linker symbols as "foo.6" or "foo.3". Thus, there is no
1680 point in attempting to extend the lookup-by-name mechanism to
1681 handle this case due to the fact that there can be multiple
1684 So, instead, search the section table when lookup by name has
1685 failed. The ``addr'' and ``endaddr'' fields may have already
1686 been relocated. If so, the relocation offset needs to be
1687 subtracted from these values when performing the comparison.
1688 We unconditionally subtract it, because, when no relocation
1689 has been performed, the value will simply be zero.
1691 The address of the symbol whose section we're fixing up HAS
1692 NOT BEEN adjusted (relocated) yet. It can't have been since
1693 the section isn't yet known and knowing the section is
1694 necessary in order to add the correct relocation value. In
1695 other words, we wouldn't even be in this function (attempting
1696 to compute the section) if it were already known.
1698 Note that it is possible to search the minimal symbols
1699 (subtracting the relocation value if necessary) to find the
1700 matching minimal symbol, but this is overkill and much less
1701 efficient. It is not necessary to find the matching minimal
1702 symbol, only its section.
1704 Note that this technique (of doing a section table search)
1705 can fail when unrelocated section addresses overlap. For
1706 this reason, we still attempt a lookup by name prior to doing
1707 a search of the section table. */
1709 struct obj_section
*s
;
1712 ALL_OBJFILE_OSECTIONS (objfile
, s
)
1714 int idx
= s
- objfile
->sections
;
1715 CORE_ADDR offset
= objfile
->section_offsets
[idx
];
1720 if (obj_section_addr (s
) - offset
<= addr
1721 && addr
< obj_section_endaddr (s
) - offset
)
1723 ginfo
->section
= idx
;
1728 /* If we didn't find the section, assume it is in the first
1729 section. If there is no allocated section, then it hardly
1730 matters what we pick, so just pick zero. */
1734 ginfo
->section
= fallback
;
1739 fixup_symbol_section (struct symbol
*sym
, struct objfile
*objfile
)
1746 if (!SYMBOL_OBJFILE_OWNED (sym
))
1749 /* We either have an OBJFILE, or we can get at it from the sym's
1750 symtab. Anything else is a bug. */
1751 gdb_assert (objfile
|| symbol_symtab (sym
));
1753 if (objfile
== NULL
)
1754 objfile
= symbol_objfile (sym
);
1756 if (SYMBOL_OBJ_SECTION (objfile
, sym
))
1759 /* We should have an objfile by now. */
1760 gdb_assert (objfile
);
1762 switch (SYMBOL_CLASS (sym
))
1766 addr
= SYMBOL_VALUE_ADDRESS (sym
);
1769 addr
= BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
));
1773 /* Nothing else will be listed in the minsyms -- no use looking
1778 fixup_section (sym
, addr
, objfile
);
1785 demangle_for_lookup_info::demangle_for_lookup_info
1786 (const lookup_name_info
&lookup_name
, language lang
)
1788 demangle_result_storage storage
;
1790 if (lookup_name
.ignore_parameters () && lang
== language_cplus
)
1792 gdb::unique_xmalloc_ptr
<char> without_params
1793 = cp_remove_params_if_any (lookup_name
.name ().c_str (),
1794 lookup_name
.completion_mode ());
1796 if (without_params
!= NULL
)
1798 if (lookup_name
.match_type () != symbol_name_match_type::SEARCH_NAME
)
1799 m_demangled_name
= demangle_for_lookup (without_params
.get (),
1805 if (lookup_name
.match_type () == symbol_name_match_type::SEARCH_NAME
)
1806 m_demangled_name
= lookup_name
.name ();
1808 m_demangled_name
= demangle_for_lookup (lookup_name
.name ().c_str (),
1814 const lookup_name_info
&
1815 lookup_name_info::match_any ()
1817 /* Lookup any symbol that "" would complete. I.e., this matches all
1819 static const lookup_name_info
lookup_name ({}, symbol_name_match_type::FULL
,
1825 /* Compute the demangled form of NAME as used by the various symbol
1826 lookup functions. The result can either be the input NAME
1827 directly, or a pointer to a buffer owned by the STORAGE object.
1829 For Ada, this function just returns NAME, unmodified.
1830 Normally, Ada symbol lookups are performed using the encoded name
1831 rather than the demangled name, and so it might seem to make sense
1832 for this function to return an encoded version of NAME.
1833 Unfortunately, we cannot do this, because this function is used in
1834 circumstances where it is not appropriate to try to encode NAME.
1835 For instance, when displaying the frame info, we demangle the name
1836 of each parameter, and then perform a symbol lookup inside our
1837 function using that demangled name. In Ada, certain functions
1838 have internally-generated parameters whose name contain uppercase
1839 characters. Encoding those name would result in those uppercase
1840 characters to become lowercase, and thus cause the symbol lookup
1844 demangle_for_lookup (const char *name
, enum language lang
,
1845 demangle_result_storage
&storage
)
1847 /* If we are using C++, D, or Go, demangle the name before doing a
1848 lookup, so we can always binary search. */
1849 if (lang
== language_cplus
)
1851 char *demangled_name
= gdb_demangle (name
, DMGL_ANSI
| DMGL_PARAMS
);
1852 if (demangled_name
!= NULL
)
1853 return storage
.set_malloc_ptr (demangled_name
);
1855 /* If we were given a non-mangled name, canonicalize it
1856 according to the language (so far only for C++). */
1857 std::string canon
= cp_canonicalize_string (name
);
1858 if (!canon
.empty ())
1859 return storage
.swap_string (canon
);
1861 else if (lang
== language_d
)
1863 char *demangled_name
= d_demangle (name
, 0);
1864 if (demangled_name
!= NULL
)
1865 return storage
.set_malloc_ptr (demangled_name
);
1867 else if (lang
== language_go
)
1869 char *demangled_name
= go_demangle (name
, 0);
1870 if (demangled_name
!= NULL
)
1871 return storage
.set_malloc_ptr (demangled_name
);
1880 search_name_hash (enum language language
, const char *search_name
)
1882 return language_def (language
)->la_search_name_hash (search_name
);
1887 This function (or rather its subordinates) have a bunch of loops and
1888 it would seem to be attractive to put in some QUIT's (though I'm not really
1889 sure whether it can run long enough to be really important). But there
1890 are a few calls for which it would appear to be bad news to quit
1891 out of here: e.g., find_proc_desc in alpha-mdebug-tdep.c. (Note
1892 that there is C++ code below which can error(), but that probably
1893 doesn't affect these calls since they are looking for a known
1894 variable and thus can probably assume it will never hit the C++
1898 lookup_symbol_in_language (const char *name
, const struct block
*block
,
1899 const domain_enum domain
, enum language lang
,
1900 struct field_of_this_result
*is_a_field_of_this
)
1902 demangle_result_storage storage
;
1903 const char *modified_name
= demangle_for_lookup (name
, lang
, storage
);
1905 return lookup_symbol_aux (modified_name
,
1906 symbol_name_match_type::FULL
,
1907 block
, domain
, lang
,
1908 is_a_field_of_this
);
1914 lookup_symbol (const char *name
, const struct block
*block
,
1916 struct field_of_this_result
*is_a_field_of_this
)
1918 return lookup_symbol_in_language (name
, block
, domain
,
1919 current_language
->la_language
,
1920 is_a_field_of_this
);
1926 lookup_symbol_search_name (const char *search_name
, const struct block
*block
,
1929 return lookup_symbol_aux (search_name
, symbol_name_match_type::SEARCH_NAME
,
1930 block
, domain
, language_asm
, NULL
);
1936 lookup_language_this (const struct language_defn
*lang
,
1937 const struct block
*block
)
1939 if (lang
->la_name_of_this
== NULL
|| block
== NULL
)
1942 if (symbol_lookup_debug
> 1)
1944 struct objfile
*objfile
= lookup_objfile_from_block (block
);
1946 fprintf_unfiltered (gdb_stdlog
,
1947 "lookup_language_this (%s, %s (objfile %s))",
1948 lang
->la_name
, host_address_to_string (block
),
1949 objfile_debug_name (objfile
));
1956 sym
= block_lookup_symbol (block
, lang
->la_name_of_this
,
1957 symbol_name_match_type::SEARCH_NAME
,
1961 if (symbol_lookup_debug
> 1)
1963 fprintf_unfiltered (gdb_stdlog
, " = %s (%s, block %s)\n",
1965 host_address_to_string (sym
),
1966 host_address_to_string (block
));
1968 return (struct block_symbol
) {sym
, block
};
1970 if (BLOCK_FUNCTION (block
))
1972 block
= BLOCK_SUPERBLOCK (block
);
1975 if (symbol_lookup_debug
> 1)
1976 fprintf_unfiltered (gdb_stdlog
, " = NULL\n");
1980 /* Given TYPE, a structure/union,
1981 return 1 if the component named NAME from the ultimate target
1982 structure/union is defined, otherwise, return 0. */
1985 check_field (struct type
*type
, const char *name
,
1986 struct field_of_this_result
*is_a_field_of_this
)
1990 /* The type may be a stub. */
1991 type
= check_typedef (type
);
1993 for (i
= TYPE_NFIELDS (type
) - 1; i
>= TYPE_N_BASECLASSES (type
); i
--)
1995 const char *t_field_name
= TYPE_FIELD_NAME (type
, i
);
1997 if (t_field_name
&& (strcmp_iw (t_field_name
, name
) == 0))
1999 is_a_field_of_this
->type
= type
;
2000 is_a_field_of_this
->field
= &TYPE_FIELD (type
, i
);
2005 /* C++: If it was not found as a data field, then try to return it
2006 as a pointer to a method. */
2008 for (i
= TYPE_NFN_FIELDS (type
) - 1; i
>= 0; --i
)
2010 if (strcmp_iw (TYPE_FN_FIELDLIST_NAME (type
, i
), name
) == 0)
2012 is_a_field_of_this
->type
= type
;
2013 is_a_field_of_this
->fn_field
= &TYPE_FN_FIELDLIST (type
, i
);
2018 for (i
= TYPE_N_BASECLASSES (type
) - 1; i
>= 0; i
--)
2019 if (check_field (TYPE_BASECLASS (type
, i
), name
, is_a_field_of_this
))
2025 /* Behave like lookup_symbol except that NAME is the natural name
2026 (e.g., demangled name) of the symbol that we're looking for. */
2028 static struct block_symbol
2029 lookup_symbol_aux (const char *name
, symbol_name_match_type match_type
,
2030 const struct block
*block
,
2031 const domain_enum domain
, enum language language
,
2032 struct field_of_this_result
*is_a_field_of_this
)
2034 struct block_symbol result
;
2035 const struct language_defn
*langdef
;
2037 if (symbol_lookup_debug
)
2039 struct objfile
*objfile
= lookup_objfile_from_block (block
);
2041 fprintf_unfiltered (gdb_stdlog
,
2042 "lookup_symbol_aux (%s, %s (objfile %s), %s, %s)\n",
2043 name
, host_address_to_string (block
),
2045 ? objfile_debug_name (objfile
) : "NULL",
2046 domain_name (domain
), language_str (language
));
2049 /* Make sure we do something sensible with is_a_field_of_this, since
2050 the callers that set this parameter to some non-null value will
2051 certainly use it later. If we don't set it, the contents of
2052 is_a_field_of_this are undefined. */
2053 if (is_a_field_of_this
!= NULL
)
2054 memset (is_a_field_of_this
, 0, sizeof (*is_a_field_of_this
));
2056 /* Search specified block and its superiors. Don't search
2057 STATIC_BLOCK or GLOBAL_BLOCK. */
2059 result
= lookup_local_symbol (name
, match_type
, block
, domain
, language
);
2060 if (result
.symbol
!= NULL
)
2062 if (symbol_lookup_debug
)
2064 fprintf_unfiltered (gdb_stdlog
, "lookup_symbol_aux (...) = %s\n",
2065 host_address_to_string (result
.symbol
));
2070 /* If requested to do so by the caller and if appropriate for LANGUAGE,
2071 check to see if NAME is a field of `this'. */
2073 langdef
= language_def (language
);
2075 /* Don't do this check if we are searching for a struct. It will
2076 not be found by check_field, but will be found by other
2078 if (is_a_field_of_this
!= NULL
&& domain
!= STRUCT_DOMAIN
)
2080 result
= lookup_language_this (langdef
, block
);
2084 struct type
*t
= result
.symbol
->type
;
2086 /* I'm not really sure that type of this can ever
2087 be typedefed; just be safe. */
2088 t
= check_typedef (t
);
2089 if (TYPE_CODE (t
) == TYPE_CODE_PTR
|| TYPE_IS_REFERENCE (t
))
2090 t
= TYPE_TARGET_TYPE (t
);
2092 if (TYPE_CODE (t
) != TYPE_CODE_STRUCT
2093 && TYPE_CODE (t
) != TYPE_CODE_UNION
)
2094 error (_("Internal error: `%s' is not an aggregate"),
2095 langdef
->la_name_of_this
);
2097 if (check_field (t
, name
, is_a_field_of_this
))
2099 if (symbol_lookup_debug
)
2101 fprintf_unfiltered (gdb_stdlog
,
2102 "lookup_symbol_aux (...) = NULL\n");
2109 /* Now do whatever is appropriate for LANGUAGE to look
2110 up static and global variables. */
2112 result
= langdef
->la_lookup_symbol_nonlocal (langdef
, name
, block
, domain
);
2113 if (result
.symbol
!= NULL
)
2115 if (symbol_lookup_debug
)
2117 fprintf_unfiltered (gdb_stdlog
, "lookup_symbol_aux (...) = %s\n",
2118 host_address_to_string (result
.symbol
));
2123 /* Now search all static file-level symbols. Not strictly correct,
2124 but more useful than an error. */
2126 result
= lookup_static_symbol (name
, domain
);
2127 if (symbol_lookup_debug
)
2129 fprintf_unfiltered (gdb_stdlog
, "lookup_symbol_aux (...) = %s\n",
2130 result
.symbol
!= NULL
2131 ? host_address_to_string (result
.symbol
)
2137 /* Check to see if the symbol is defined in BLOCK or its superiors.
2138 Don't search STATIC_BLOCK or GLOBAL_BLOCK. */
2140 static struct block_symbol
2141 lookup_local_symbol (const char *name
,
2142 symbol_name_match_type match_type
,
2143 const struct block
*block
,
2144 const domain_enum domain
,
2145 enum language language
)
2148 const struct block
*static_block
= block_static_block (block
);
2149 const char *scope
= block_scope (block
);
2151 /* Check if either no block is specified or it's a global block. */
2153 if (static_block
== NULL
)
2156 while (block
!= static_block
)
2158 sym
= lookup_symbol_in_block (name
, match_type
, block
, domain
);
2160 return (struct block_symbol
) {sym
, block
};
2162 if (language
== language_cplus
|| language
== language_fortran
)
2164 struct block_symbol blocksym
2165 = cp_lookup_symbol_imports_or_template (scope
, name
, block
,
2168 if (blocksym
.symbol
!= NULL
)
2172 if (BLOCK_FUNCTION (block
) != NULL
&& block_inlined_p (block
))
2174 block
= BLOCK_SUPERBLOCK (block
);
2177 /* We've reached the end of the function without finding a result. */
2185 lookup_objfile_from_block (const struct block
*block
)
2190 block
= block_global_block (block
);
2191 /* Look through all blockvectors. */
2192 for (objfile
*obj
: current_program_space
->objfiles ())
2194 for (compunit_symtab
*cust
: obj
->compunits ())
2195 if (block
== BLOCKVECTOR_BLOCK (COMPUNIT_BLOCKVECTOR (cust
),
2198 if (obj
->separate_debug_objfile_backlink
)
2199 obj
= obj
->separate_debug_objfile_backlink
;
2211 lookup_symbol_in_block (const char *name
, symbol_name_match_type match_type
,
2212 const struct block
*block
,
2213 const domain_enum domain
)
2217 if (symbol_lookup_debug
> 1)
2219 struct objfile
*objfile
= lookup_objfile_from_block (block
);
2221 fprintf_unfiltered (gdb_stdlog
,
2222 "lookup_symbol_in_block (%s, %s (objfile %s), %s)",
2223 name
, host_address_to_string (block
),
2224 objfile_debug_name (objfile
),
2225 domain_name (domain
));
2228 sym
= block_lookup_symbol (block
, name
, match_type
, domain
);
2231 if (symbol_lookup_debug
> 1)
2233 fprintf_unfiltered (gdb_stdlog
, " = %s\n",
2234 host_address_to_string (sym
));
2236 return fixup_symbol_section (sym
, NULL
);
2239 if (symbol_lookup_debug
> 1)
2240 fprintf_unfiltered (gdb_stdlog
, " = NULL\n");
2247 lookup_global_symbol_from_objfile (struct objfile
*main_objfile
,
2248 enum block_enum block_index
,
2250 const domain_enum domain
)
2252 gdb_assert (block_index
== GLOBAL_BLOCK
|| block_index
== STATIC_BLOCK
);
2254 for (objfile
*objfile
: main_objfile
->separate_debug_objfiles ())
2256 struct block_symbol result
2257 = lookup_symbol_in_objfile (objfile
, block_index
, name
, domain
);
2259 if (result
.symbol
!= nullptr)
2266 /* Check to see if the symbol is defined in one of the OBJFILE's
2267 symtabs. BLOCK_INDEX should be either GLOBAL_BLOCK or STATIC_BLOCK,
2268 depending on whether or not we want to search global symbols or
2271 static struct block_symbol
2272 lookup_symbol_in_objfile_symtabs (struct objfile
*objfile
,
2273 enum block_enum block_index
, const char *name
,
2274 const domain_enum domain
)
2276 gdb_assert (block_index
== GLOBAL_BLOCK
|| block_index
== STATIC_BLOCK
);
2278 if (symbol_lookup_debug
> 1)
2280 fprintf_unfiltered (gdb_stdlog
,
2281 "lookup_symbol_in_objfile_symtabs (%s, %s, %s, %s)",
2282 objfile_debug_name (objfile
),
2283 block_index
== GLOBAL_BLOCK
2284 ? "GLOBAL_BLOCK" : "STATIC_BLOCK",
2285 name
, domain_name (domain
));
2288 for (compunit_symtab
*cust
: objfile
->compunits ())
2290 const struct blockvector
*bv
;
2291 const struct block
*block
;
2292 struct block_symbol result
;
2294 bv
= COMPUNIT_BLOCKVECTOR (cust
);
2295 block
= BLOCKVECTOR_BLOCK (bv
, block_index
);
2296 result
.symbol
= block_lookup_symbol_primary (block
, name
, domain
);
2297 result
.block
= block
;
2298 if (result
.symbol
!= NULL
)
2300 if (symbol_lookup_debug
> 1)
2302 fprintf_unfiltered (gdb_stdlog
, " = %s (block %s)\n",
2303 host_address_to_string (result
.symbol
),
2304 host_address_to_string (block
));
2306 result
.symbol
= fixup_symbol_section (result
.symbol
, objfile
);
2312 if (symbol_lookup_debug
> 1)
2313 fprintf_unfiltered (gdb_stdlog
, " = NULL\n");
2317 /* Wrapper around lookup_symbol_in_objfile_symtabs for search_symbols.
2318 Look up LINKAGE_NAME in DOMAIN in the global and static blocks of OBJFILE
2319 and all associated separate debug objfiles.
2321 Normally we only look in OBJFILE, and not any separate debug objfiles
2322 because the outer loop will cause them to be searched too. This case is
2323 different. Here we're called from search_symbols where it will only
2324 call us for the objfile that contains a matching minsym. */
2326 static struct block_symbol
2327 lookup_symbol_in_objfile_from_linkage_name (struct objfile
*objfile
,
2328 const char *linkage_name
,
2331 enum language lang
= current_language
->la_language
;
2332 struct objfile
*main_objfile
;
2334 demangle_result_storage storage
;
2335 const char *modified_name
= demangle_for_lookup (linkage_name
, lang
, storage
);
2337 if (objfile
->separate_debug_objfile_backlink
)
2338 main_objfile
= objfile
->separate_debug_objfile_backlink
;
2340 main_objfile
= objfile
;
2342 for (::objfile
*cur_objfile
: main_objfile
->separate_debug_objfiles ())
2344 struct block_symbol result
;
2346 result
= lookup_symbol_in_objfile_symtabs (cur_objfile
, GLOBAL_BLOCK
,
2347 modified_name
, domain
);
2348 if (result
.symbol
== NULL
)
2349 result
= lookup_symbol_in_objfile_symtabs (cur_objfile
, STATIC_BLOCK
,
2350 modified_name
, domain
);
2351 if (result
.symbol
!= NULL
)
2358 /* A helper function that throws an exception when a symbol was found
2359 in a psymtab but not in a symtab. */
2361 static void ATTRIBUTE_NORETURN
2362 error_in_psymtab_expansion (enum block_enum block_index
, const char *name
,
2363 struct compunit_symtab
*cust
)
2366 Internal: %s symbol `%s' found in %s psymtab but not in symtab.\n\
2367 %s may be an inlined function, or may be a template function\n \
2368 (if a template, try specifying an instantiation: %s<type>)."),
2369 block_index
== GLOBAL_BLOCK
? "global" : "static",
2371 symtab_to_filename_for_display (compunit_primary_filetab (cust
)),
2375 /* A helper function for various lookup routines that interfaces with
2376 the "quick" symbol table functions. */
2378 static struct block_symbol
2379 lookup_symbol_via_quick_fns (struct objfile
*objfile
,
2380 enum block_enum block_index
, const char *name
,
2381 const domain_enum domain
)
2383 struct compunit_symtab
*cust
;
2384 const struct blockvector
*bv
;
2385 const struct block
*block
;
2386 struct block_symbol result
;
2391 if (symbol_lookup_debug
> 1)
2393 fprintf_unfiltered (gdb_stdlog
,
2394 "lookup_symbol_via_quick_fns (%s, %s, %s, %s)\n",
2395 objfile_debug_name (objfile
),
2396 block_index
== GLOBAL_BLOCK
2397 ? "GLOBAL_BLOCK" : "STATIC_BLOCK",
2398 name
, domain_name (domain
));
2401 cust
= objfile
->sf
->qf
->lookup_symbol (objfile
, block_index
, name
, domain
);
2404 if (symbol_lookup_debug
> 1)
2406 fprintf_unfiltered (gdb_stdlog
,
2407 "lookup_symbol_via_quick_fns (...) = NULL\n");
2412 bv
= COMPUNIT_BLOCKVECTOR (cust
);
2413 block
= BLOCKVECTOR_BLOCK (bv
, block_index
);
2414 result
.symbol
= block_lookup_symbol (block
, name
,
2415 symbol_name_match_type::FULL
, domain
);
2416 if (result
.symbol
== NULL
)
2417 error_in_psymtab_expansion (block_index
, name
, cust
);
2419 if (symbol_lookup_debug
> 1)
2421 fprintf_unfiltered (gdb_stdlog
,
2422 "lookup_symbol_via_quick_fns (...) = %s (block %s)\n",
2423 host_address_to_string (result
.symbol
),
2424 host_address_to_string (block
));
2427 result
.symbol
= fixup_symbol_section (result
.symbol
, objfile
);
2428 result
.block
= block
;
2435 basic_lookup_symbol_nonlocal (const struct language_defn
*langdef
,
2437 const struct block
*block
,
2438 const domain_enum domain
)
2440 struct block_symbol result
;
2442 /* NOTE: dje/2014-10-26: The lookup in all objfiles search could skip
2443 the current objfile. Searching the current objfile first is useful
2444 for both matching user expectations as well as performance. */
2446 result
= lookup_symbol_in_static_block (name
, block
, domain
);
2447 if (result
.symbol
!= NULL
)
2450 /* If we didn't find a definition for a builtin type in the static block,
2451 search for it now. This is actually the right thing to do and can be
2452 a massive performance win. E.g., when debugging a program with lots of
2453 shared libraries we could search all of them only to find out the
2454 builtin type isn't defined in any of them. This is common for types
2456 if (domain
== VAR_DOMAIN
)
2458 struct gdbarch
*gdbarch
;
2461 gdbarch
= target_gdbarch ();
2463 gdbarch
= block_gdbarch (block
);
2464 result
.symbol
= language_lookup_primitive_type_as_symbol (langdef
,
2466 result
.block
= NULL
;
2467 if (result
.symbol
!= NULL
)
2471 return lookup_global_symbol (name
, block
, domain
);
2477 lookup_symbol_in_static_block (const char *name
,
2478 const struct block
*block
,
2479 const domain_enum domain
)
2481 const struct block
*static_block
= block_static_block (block
);
2484 if (static_block
== NULL
)
2487 if (symbol_lookup_debug
)
2489 struct objfile
*objfile
= lookup_objfile_from_block (static_block
);
2491 fprintf_unfiltered (gdb_stdlog
,
2492 "lookup_symbol_in_static_block (%s, %s (objfile %s),"
2495 host_address_to_string (block
),
2496 objfile_debug_name (objfile
),
2497 domain_name (domain
));
2500 sym
= lookup_symbol_in_block (name
,
2501 symbol_name_match_type::FULL
,
2502 static_block
, domain
);
2503 if (symbol_lookup_debug
)
2505 fprintf_unfiltered (gdb_stdlog
,
2506 "lookup_symbol_in_static_block (...) = %s\n",
2507 sym
!= NULL
? host_address_to_string (sym
) : "NULL");
2509 return (struct block_symbol
) {sym
, static_block
};
2512 /* Perform the standard symbol lookup of NAME in OBJFILE:
2513 1) First search expanded symtabs, and if not found
2514 2) Search the "quick" symtabs (partial or .gdb_index).
2515 BLOCK_INDEX is one of GLOBAL_BLOCK or STATIC_BLOCK. */
2517 static struct block_symbol
2518 lookup_symbol_in_objfile (struct objfile
*objfile
, enum block_enum block_index
,
2519 const char *name
, const domain_enum domain
)
2521 struct block_symbol result
;
2523 gdb_assert (block_index
== GLOBAL_BLOCK
|| block_index
== STATIC_BLOCK
);
2525 if (symbol_lookup_debug
)
2527 fprintf_unfiltered (gdb_stdlog
,
2528 "lookup_symbol_in_objfile (%s, %s, %s, %s)\n",
2529 objfile_debug_name (objfile
),
2530 block_index
== GLOBAL_BLOCK
2531 ? "GLOBAL_BLOCK" : "STATIC_BLOCK",
2532 name
, domain_name (domain
));
2535 result
= lookup_symbol_in_objfile_symtabs (objfile
, block_index
,
2537 if (result
.symbol
!= NULL
)
2539 if (symbol_lookup_debug
)
2541 fprintf_unfiltered (gdb_stdlog
,
2542 "lookup_symbol_in_objfile (...) = %s"
2544 host_address_to_string (result
.symbol
));
2549 result
= lookup_symbol_via_quick_fns (objfile
, block_index
,
2551 if (symbol_lookup_debug
)
2553 fprintf_unfiltered (gdb_stdlog
,
2554 "lookup_symbol_in_objfile (...) = %s%s\n",
2555 result
.symbol
!= NULL
2556 ? host_address_to_string (result
.symbol
)
2558 result
.symbol
!= NULL
? " (via quick fns)" : "");
2563 /* Private data to be used with lookup_symbol_global_iterator_cb. */
2565 struct global_or_static_sym_lookup_data
2567 /* The name of the symbol we are searching for. */
2570 /* The domain to use for our search. */
2573 /* The block index in which to search. */
2574 enum block_enum block_index
;
2576 /* The field where the callback should store the symbol if found.
2577 It should be initialized to {NULL, NULL} before the search is started. */
2578 struct block_symbol result
;
2581 /* A callback function for gdbarch_iterate_over_objfiles_in_search_order.
2582 It searches by name for a symbol in the block given by BLOCK_INDEX of the
2583 given OBJFILE. The arguments for the search are passed via CB_DATA, which
2584 in reality is a pointer to struct global_or_static_sym_lookup_data. */
2587 lookup_symbol_global_or_static_iterator_cb (struct objfile
*objfile
,
2590 struct global_or_static_sym_lookup_data
*data
=
2591 (struct global_or_static_sym_lookup_data
*) cb_data
;
2593 gdb_assert (data
->result
.symbol
== NULL
2594 && data
->result
.block
== NULL
);
2596 data
->result
= lookup_symbol_in_objfile (objfile
, data
->block_index
,
2597 data
->name
, data
->domain
);
2599 /* If we found a match, tell the iterator to stop. Otherwise,
2601 return (data
->result
.symbol
!= NULL
);
2604 /* This function contains the common code of lookup_{global,static}_symbol.
2605 OBJFILE is only used if BLOCK_INDEX is GLOBAL_SCOPE, in which case it is
2606 the objfile to start the lookup in. */
2608 static struct block_symbol
2609 lookup_global_or_static_symbol (const char *name
,
2610 enum block_enum block_index
,
2611 struct objfile
*objfile
,
2612 const domain_enum domain
)
2614 struct symbol_cache
*cache
= get_symbol_cache (current_program_space
);
2615 struct block_symbol result
;
2616 struct global_or_static_sym_lookup_data lookup_data
;
2617 struct block_symbol_cache
*bsc
;
2618 struct symbol_cache_slot
*slot
;
2620 gdb_assert (block_index
== GLOBAL_BLOCK
|| block_index
== STATIC_BLOCK
);
2621 gdb_assert (objfile
== nullptr || block_index
== GLOBAL_BLOCK
);
2623 /* First see if we can find the symbol in the cache.
2624 This works because we use the current objfile to qualify the lookup. */
2625 result
= symbol_cache_lookup (cache
, objfile
, block_index
, name
, domain
,
2627 if (result
.symbol
!= NULL
)
2629 if (SYMBOL_LOOKUP_FAILED_P (result
))
2634 /* Do a global search (of global blocks, heh). */
2635 if (result
.symbol
== NULL
)
2637 memset (&lookup_data
, 0, sizeof (lookup_data
));
2638 lookup_data
.name
= name
;
2639 lookup_data
.block_index
= block_index
;
2640 lookup_data
.domain
= domain
;
2641 gdbarch_iterate_over_objfiles_in_search_order
2642 (objfile
!= NULL
? get_objfile_arch (objfile
) : target_gdbarch (),
2643 lookup_symbol_global_or_static_iterator_cb
, &lookup_data
, objfile
);
2644 result
= lookup_data
.result
;
2647 if (result
.symbol
!= NULL
)
2648 symbol_cache_mark_found (bsc
, slot
, objfile
, result
.symbol
, result
.block
);
2650 symbol_cache_mark_not_found (bsc
, slot
, objfile
, name
, domain
);
2658 lookup_static_symbol (const char *name
, const domain_enum domain
)
2660 return lookup_global_or_static_symbol (name
, STATIC_BLOCK
, nullptr, domain
);
2666 lookup_global_symbol (const char *name
,
2667 const struct block
*block
,
2668 const domain_enum domain
)
2670 /* If a block was passed in, we want to search the corresponding
2671 global block first. This yields "more expected" behavior, and is
2672 needed to support 'FILENAME'::VARIABLE lookups. */
2673 const struct block
*global_block
= block_global_block (block
);
2674 if (global_block
!= nullptr)
2676 symbol
*sym
= lookup_symbol_in_block (name
,
2677 symbol_name_match_type::FULL
,
2678 global_block
, domain
);
2680 return { sym
, global_block
};
2683 struct objfile
*objfile
= lookup_objfile_from_block (block
);
2684 return lookup_global_or_static_symbol (name
, GLOBAL_BLOCK
, objfile
, domain
);
2688 symbol_matches_domain (enum language symbol_language
,
2689 domain_enum symbol_domain
,
2692 /* For C++ "struct foo { ... }" also defines a typedef for "foo".
2693 Similarly, any Ada type declaration implicitly defines a typedef. */
2694 if (symbol_language
== language_cplus
2695 || symbol_language
== language_d
2696 || symbol_language
== language_ada
2697 || symbol_language
== language_rust
)
2699 if ((domain
== VAR_DOMAIN
|| domain
== STRUCT_DOMAIN
)
2700 && symbol_domain
== STRUCT_DOMAIN
)
2703 /* For all other languages, strict match is required. */
2704 return (symbol_domain
== domain
);
2710 lookup_transparent_type (const char *name
)
2712 return current_language
->la_lookup_transparent_type (name
);
2715 /* A helper for basic_lookup_transparent_type that interfaces with the
2716 "quick" symbol table functions. */
2718 static struct type
*
2719 basic_lookup_transparent_type_quick (struct objfile
*objfile
,
2720 enum block_enum block_index
,
2723 struct compunit_symtab
*cust
;
2724 const struct blockvector
*bv
;
2725 const struct block
*block
;
2730 cust
= objfile
->sf
->qf
->lookup_symbol (objfile
, block_index
, name
,
2735 bv
= COMPUNIT_BLOCKVECTOR (cust
);
2736 block
= BLOCKVECTOR_BLOCK (bv
, block_index
);
2737 sym
= block_find_symbol (block
, name
, STRUCT_DOMAIN
,
2738 block_find_non_opaque_type
, NULL
);
2740 error_in_psymtab_expansion (block_index
, name
, cust
);
2741 gdb_assert (!TYPE_IS_OPAQUE (SYMBOL_TYPE (sym
)));
2742 return SYMBOL_TYPE (sym
);
2745 /* Subroutine of basic_lookup_transparent_type to simplify it.
2746 Look up the non-opaque definition of NAME in BLOCK_INDEX of OBJFILE.
2747 BLOCK_INDEX is either GLOBAL_BLOCK or STATIC_BLOCK. */
2749 static struct type
*
2750 basic_lookup_transparent_type_1 (struct objfile
*objfile
,
2751 enum block_enum block_index
,
2754 const struct blockvector
*bv
;
2755 const struct block
*block
;
2756 const struct symbol
*sym
;
2758 for (compunit_symtab
*cust
: objfile
->compunits ())
2760 bv
= COMPUNIT_BLOCKVECTOR (cust
);
2761 block
= BLOCKVECTOR_BLOCK (bv
, block_index
);
2762 sym
= block_find_symbol (block
, name
, STRUCT_DOMAIN
,
2763 block_find_non_opaque_type
, NULL
);
2766 gdb_assert (!TYPE_IS_OPAQUE (SYMBOL_TYPE (sym
)));
2767 return SYMBOL_TYPE (sym
);
2774 /* The standard implementation of lookup_transparent_type. This code
2775 was modeled on lookup_symbol -- the parts not relevant to looking
2776 up types were just left out. In particular it's assumed here that
2777 types are available in STRUCT_DOMAIN and only in file-static or
2781 basic_lookup_transparent_type (const char *name
)
2785 /* Now search all the global symbols. Do the symtab's first, then
2786 check the psymtab's. If a psymtab indicates the existence
2787 of the desired name as a global, then do psymtab-to-symtab
2788 conversion on the fly and return the found symbol. */
2790 for (objfile
*objfile
: current_program_space
->objfiles ())
2792 t
= basic_lookup_transparent_type_1 (objfile
, GLOBAL_BLOCK
, name
);
2797 for (objfile
*objfile
: current_program_space
->objfiles ())
2799 t
= basic_lookup_transparent_type_quick (objfile
, GLOBAL_BLOCK
, name
);
2804 /* Now search the static file-level symbols.
2805 Not strictly correct, but more useful than an error.
2806 Do the symtab's first, then
2807 check the psymtab's. If a psymtab indicates the existence
2808 of the desired name as a file-level static, then do psymtab-to-symtab
2809 conversion on the fly and return the found symbol. */
2811 for (objfile
*objfile
: current_program_space
->objfiles ())
2813 t
= basic_lookup_transparent_type_1 (objfile
, STATIC_BLOCK
, name
);
2818 for (objfile
*objfile
: current_program_space
->objfiles ())
2820 t
= basic_lookup_transparent_type_quick (objfile
, STATIC_BLOCK
, name
);
2825 return (struct type
*) 0;
2831 iterate_over_symbols (const struct block
*block
,
2832 const lookup_name_info
&name
,
2833 const domain_enum domain
,
2834 gdb::function_view
<symbol_found_callback_ftype
> callback
)
2836 struct block_iterator iter
;
2839 ALL_BLOCK_SYMBOLS_WITH_NAME (block
, name
, iter
, sym
)
2841 if (symbol_matches_domain (sym
->language (), SYMBOL_DOMAIN (sym
), domain
))
2843 struct block_symbol block_sym
= {sym
, block
};
2845 if (!callback (&block_sym
))
2855 iterate_over_symbols_terminated
2856 (const struct block
*block
,
2857 const lookup_name_info
&name
,
2858 const domain_enum domain
,
2859 gdb::function_view
<symbol_found_callback_ftype
> callback
)
2861 if (!iterate_over_symbols (block
, name
, domain
, callback
))
2863 struct block_symbol block_sym
= {nullptr, block
};
2864 return callback (&block_sym
);
2867 /* Find the compunit symtab associated with PC and SECTION.
2868 This will read in debug info as necessary. */
2870 struct compunit_symtab
*
2871 find_pc_sect_compunit_symtab (CORE_ADDR pc
, struct obj_section
*section
)
2873 struct compunit_symtab
*best_cust
= NULL
;
2874 CORE_ADDR distance
= 0;
2875 struct bound_minimal_symbol msymbol
;
2877 /* If we know that this is not a text address, return failure. This is
2878 necessary because we loop based on the block's high and low code
2879 addresses, which do not include the data ranges, and because
2880 we call find_pc_sect_psymtab which has a similar restriction based
2881 on the partial_symtab's texthigh and textlow. */
2882 msymbol
= lookup_minimal_symbol_by_pc_section (pc
, section
);
2883 if (msymbol
.minsym
&& msymbol
.minsym
->data_p ())
2886 /* Search all symtabs for the one whose file contains our address, and which
2887 is the smallest of all the ones containing the address. This is designed
2888 to deal with a case like symtab a is at 0x1000-0x2000 and 0x3000-0x4000
2889 and symtab b is at 0x2000-0x3000. So the GLOBAL_BLOCK for a is from
2890 0x1000-0x4000, but for address 0x2345 we want to return symtab b.
2892 This happens for native ecoff format, where code from included files
2893 gets its own symtab. The symtab for the included file should have
2894 been read in already via the dependency mechanism.
2895 It might be swifter to create several symtabs with the same name
2896 like xcoff does (I'm not sure).
2898 It also happens for objfiles that have their functions reordered.
2899 For these, the symtab we are looking for is not necessarily read in. */
2901 for (objfile
*obj_file
: current_program_space
->objfiles ())
2903 for (compunit_symtab
*cust
: obj_file
->compunits ())
2905 const struct block
*b
;
2906 const struct blockvector
*bv
;
2908 bv
= COMPUNIT_BLOCKVECTOR (cust
);
2909 b
= BLOCKVECTOR_BLOCK (bv
, GLOBAL_BLOCK
);
2911 if (BLOCK_START (b
) <= pc
2912 && BLOCK_END (b
) > pc
2914 || BLOCK_END (b
) - BLOCK_START (b
) < distance
))
2916 /* For an objfile that has its functions reordered,
2917 find_pc_psymtab will find the proper partial symbol table
2918 and we simply return its corresponding symtab. */
2919 /* In order to better support objfiles that contain both
2920 stabs and coff debugging info, we continue on if a psymtab
2922 if ((obj_file
->flags
& OBJF_REORDERED
) && obj_file
->sf
)
2924 struct compunit_symtab
*result
;
2927 = obj_file
->sf
->qf
->find_pc_sect_compunit_symtab (obj_file
,
2937 struct block_iterator iter
;
2938 struct symbol
*sym
= NULL
;
2940 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
2942 fixup_symbol_section (sym
, obj_file
);
2943 if (matching_obj_sections (SYMBOL_OBJ_SECTION (obj_file
,
2949 continue; /* No symbol in this symtab matches
2952 distance
= BLOCK_END (b
) - BLOCK_START (b
);
2958 if (best_cust
!= NULL
)
2961 /* Not found in symtabs, search the "quick" symtabs (e.g. psymtabs). */
2963 for (objfile
*objf
: current_program_space
->objfiles ())
2965 struct compunit_symtab
*result
;
2969 result
= objf
->sf
->qf
->find_pc_sect_compunit_symtab (objf
,
2980 /* Find the compunit symtab associated with PC.
2981 This will read in debug info as necessary.
2982 Backward compatibility, no section. */
2984 struct compunit_symtab
*
2985 find_pc_compunit_symtab (CORE_ADDR pc
)
2987 return find_pc_sect_compunit_symtab (pc
, find_pc_mapped_section (pc
));
2993 find_symbol_at_address (CORE_ADDR address
)
2995 for (objfile
*objfile
: current_program_space
->objfiles ())
2997 if (objfile
->sf
== NULL
2998 || objfile
->sf
->qf
->find_compunit_symtab_by_address
== NULL
)
3001 struct compunit_symtab
*symtab
3002 = objfile
->sf
->qf
->find_compunit_symtab_by_address (objfile
, address
);
3005 const struct blockvector
*bv
= COMPUNIT_BLOCKVECTOR (symtab
);
3007 for (int i
= GLOBAL_BLOCK
; i
<= STATIC_BLOCK
; ++i
)
3009 const struct block
*b
= BLOCKVECTOR_BLOCK (bv
, i
);
3010 struct block_iterator iter
;
3013 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
3015 if (SYMBOL_CLASS (sym
) == LOC_STATIC
3016 && SYMBOL_VALUE_ADDRESS (sym
) == address
)
3028 /* Find the source file and line number for a given PC value and SECTION.
3029 Return a structure containing a symtab pointer, a line number,
3030 and a pc range for the entire source line.
3031 The value's .pc field is NOT the specified pc.
3032 NOTCURRENT nonzero means, if specified pc is on a line boundary,
3033 use the line that ends there. Otherwise, in that case, the line
3034 that begins there is used. */
3036 /* The big complication here is that a line may start in one file, and end just
3037 before the start of another file. This usually occurs when you #include
3038 code in the middle of a subroutine. To properly find the end of a line's PC
3039 range, we must search all symtabs associated with this compilation unit, and
3040 find the one whose first PC is closer than that of the next line in this
3043 struct symtab_and_line
3044 find_pc_sect_line (CORE_ADDR pc
, struct obj_section
*section
, int notcurrent
)
3046 struct compunit_symtab
*cust
;
3047 struct linetable
*l
;
3049 struct linetable_entry
*item
;
3050 const struct blockvector
*bv
;
3051 struct bound_minimal_symbol msymbol
;
3053 /* Info on best line seen so far, and where it starts, and its file. */
3055 struct linetable_entry
*best
= NULL
;
3056 CORE_ADDR best_end
= 0;
3057 struct symtab
*best_symtab
= 0;
3059 /* Store here the first line number
3060 of a file which contains the line at the smallest pc after PC.
3061 If we don't find a line whose range contains PC,
3062 we will use a line one less than this,
3063 with a range from the start of that file to the first line's pc. */
3064 struct linetable_entry
*alt
= NULL
;
3066 /* Info on best line seen in this file. */
3068 struct linetable_entry
*prev
;
3070 /* If this pc is not from the current frame,
3071 it is the address of the end of a call instruction.
3072 Quite likely that is the start of the following statement.
3073 But what we want is the statement containing the instruction.
3074 Fudge the pc to make sure we get that. */
3076 /* It's tempting to assume that, if we can't find debugging info for
3077 any function enclosing PC, that we shouldn't search for line
3078 number info, either. However, GAS can emit line number info for
3079 assembly files --- very helpful when debugging hand-written
3080 assembly code. In such a case, we'd have no debug info for the
3081 function, but we would have line info. */
3086 /* elz: added this because this function returned the wrong
3087 information if the pc belongs to a stub (import/export)
3088 to call a shlib function. This stub would be anywhere between
3089 two functions in the target, and the line info was erroneously
3090 taken to be the one of the line before the pc. */
3092 /* RT: Further explanation:
3094 * We have stubs (trampolines) inserted between procedures.
3096 * Example: "shr1" exists in a shared library, and a "shr1" stub also
3097 * exists in the main image.
3099 * In the minimal symbol table, we have a bunch of symbols
3100 * sorted by start address. The stubs are marked as "trampoline",
3101 * the others appear as text. E.g.:
3103 * Minimal symbol table for main image
3104 * main: code for main (text symbol)
3105 * shr1: stub (trampoline symbol)
3106 * foo: code for foo (text symbol)
3108 * Minimal symbol table for "shr1" image:
3110 * shr1: code for shr1 (text symbol)
3113 * So the code below is trying to detect if we are in the stub
3114 * ("shr1" stub), and if so, find the real code ("shr1" trampoline),
3115 * and if found, do the symbolization from the real-code address
3116 * rather than the stub address.
3118 * Assumptions being made about the minimal symbol table:
3119 * 1. lookup_minimal_symbol_by_pc() will return a trampoline only
3120 * if we're really in the trampoline.s If we're beyond it (say
3121 * we're in "foo" in the above example), it'll have a closer
3122 * symbol (the "foo" text symbol for example) and will not
3123 * return the trampoline.
3124 * 2. lookup_minimal_symbol_text() will find a real text symbol
3125 * corresponding to the trampoline, and whose address will
3126 * be different than the trampoline address. I put in a sanity
3127 * check for the address being the same, to avoid an
3128 * infinite recursion.
3130 msymbol
= lookup_minimal_symbol_by_pc (pc
);
3131 if (msymbol
.minsym
!= NULL
)
3132 if (MSYMBOL_TYPE (msymbol
.minsym
) == mst_solib_trampoline
)
3134 struct bound_minimal_symbol mfunsym
3135 = lookup_minimal_symbol_text (msymbol
.minsym
->linkage_name (),
3138 if (mfunsym
.minsym
== NULL
)
3139 /* I eliminated this warning since it is coming out
3140 * in the following situation:
3141 * gdb shmain // test program with shared libraries
3142 * (gdb) break shr1 // function in shared lib
3143 * Warning: In stub for ...
3144 * In the above situation, the shared lib is not loaded yet,
3145 * so of course we can't find the real func/line info,
3146 * but the "break" still works, and the warning is annoying.
3147 * So I commented out the warning. RT */
3148 /* warning ("In stub for %s; unable to find real function/line info",
3149 msymbol->linkage_name ()); */
3152 else if (BMSYMBOL_VALUE_ADDRESS (mfunsym
)
3153 == BMSYMBOL_VALUE_ADDRESS (msymbol
))
3154 /* Avoid infinite recursion */
3155 /* See above comment about why warning is commented out. */
3156 /* warning ("In stub for %s; unable to find real function/line info",
3157 msymbol->linkage_name ()); */
3162 /* Detect an obvious case of infinite recursion. If this
3163 should occur, we'd like to know about it, so error out,
3165 if (BMSYMBOL_VALUE_ADDRESS (mfunsym
) == pc
)
3166 internal_error (__FILE__
, __LINE__
,
3167 _("Infinite recursion detected in find_pc_sect_line;"
3168 "please file a bug report"));
3170 return find_pc_line (BMSYMBOL_VALUE_ADDRESS (mfunsym
), 0);
3174 symtab_and_line val
;
3175 val
.pspace
= current_program_space
;
3177 cust
= find_pc_sect_compunit_symtab (pc
, section
);
3180 /* If no symbol information, return previous pc. */
3187 bv
= COMPUNIT_BLOCKVECTOR (cust
);
3189 /* Look at all the symtabs that share this blockvector.
3190 They all have the same apriori range, that we found was right;
3191 but they have different line tables. */
3193 for (symtab
*iter_s
: compunit_filetabs (cust
))
3195 /* Find the best line in this symtab. */
3196 l
= SYMTAB_LINETABLE (iter_s
);
3202 /* I think len can be zero if the symtab lacks line numbers
3203 (e.g. gcc -g1). (Either that or the LINETABLE is NULL;
3204 I'm not sure which, and maybe it depends on the symbol
3210 item
= l
->item
; /* Get first line info. */
3212 /* Is this file's first line closer than the first lines of other files?
3213 If so, record this file, and its first line, as best alternate. */
3214 if (item
->pc
> pc
&& (!alt
|| item
->pc
< alt
->pc
))
3217 auto pc_compare
= [](const CORE_ADDR
& comp_pc
,
3218 const struct linetable_entry
& lhs
)->bool
3220 return comp_pc
< lhs
.pc
;
3223 struct linetable_entry
*first
= item
;
3224 struct linetable_entry
*last
= item
+ len
;
3225 item
= std::upper_bound (first
, last
, pc
, pc_compare
);
3228 /* Found a matching item. Skip backwards over any end of
3229 sequence markers. */
3230 for (prev
= item
- 1; prev
->line
== 0 && prev
!= first
; prev
--)
3234 /* At this point, prev points at the line whose start addr is <= pc, and
3235 item points at the next line. If we ran off the end of the linetable
3236 (pc >= start of the last line), then prev == item. If pc < start of
3237 the first line, prev will not be set. */
3239 /* Is this file's best line closer than the best in the other files?
3240 If so, record this file, and its best line, as best so far. Don't
3241 save prev if it represents the end of a function (i.e. line number
3242 0) instead of a real line. */
3244 if (prev
&& prev
->line
&& (!best
|| prev
->pc
> best
->pc
))
3247 best_symtab
= iter_s
;
3249 /* If during the binary search we land on a non-statement entry,
3250 scan backward through entries at the same address to see if
3251 there is an entry marked as is-statement. In theory this
3252 duplication should have been removed from the line table
3253 during construction, this is just a double check. If the line
3254 table has had the duplication removed then this should be
3258 struct linetable_entry
*tmp
= best
;
3259 while (tmp
> first
&& (tmp
- 1)->pc
== tmp
->pc
3260 && (tmp
- 1)->line
!= 0 && !tmp
->is_stmt
)
3266 /* Discard BEST_END if it's before the PC of the current BEST. */
3267 if (best_end
<= best
->pc
)
3271 /* If another line (denoted by ITEM) is in the linetable and its
3272 PC is after BEST's PC, but before the current BEST_END, then
3273 use ITEM's PC as the new best_end. */
3274 if (best
&& item
< last
&& item
->pc
> best
->pc
3275 && (best_end
== 0 || best_end
> item
->pc
))
3276 best_end
= item
->pc
;
3281 /* If we didn't find any line number info, just return zeros.
3282 We used to return alt->line - 1 here, but that could be
3283 anywhere; if we don't have line number info for this PC,
3284 don't make some up. */
3287 else if (best
->line
== 0)
3289 /* If our best fit is in a range of PC's for which no line
3290 number info is available (line number is zero) then we didn't
3291 find any valid line information. */
3296 val
.is_stmt
= best
->is_stmt
;
3297 val
.symtab
= best_symtab
;
3298 val
.line
= best
->line
;
3300 if (best_end
&& (!alt
|| best_end
< alt
->pc
))
3305 val
.end
= BLOCK_END (BLOCKVECTOR_BLOCK (bv
, GLOBAL_BLOCK
));
3307 val
.section
= section
;
3311 /* Backward compatibility (no section). */
3313 struct symtab_and_line
3314 find_pc_line (CORE_ADDR pc
, int notcurrent
)
3316 struct obj_section
*section
;
3318 section
= find_pc_overlay (pc
);
3319 if (pc_in_unmapped_range (pc
, section
))
3320 pc
= overlay_mapped_address (pc
, section
);
3321 return find_pc_sect_line (pc
, section
, notcurrent
);
3327 find_pc_line_symtab (CORE_ADDR pc
)
3329 struct symtab_and_line sal
;
3331 /* This always passes zero for NOTCURRENT to find_pc_line.
3332 There are currently no callers that ever pass non-zero. */
3333 sal
= find_pc_line (pc
, 0);
3337 /* Find line number LINE in any symtab whose name is the same as
3340 If found, return the symtab that contains the linetable in which it was
3341 found, set *INDEX to the index in the linetable of the best entry
3342 found, and set *EXACT_MATCH to true if the value returned is an
3345 If not found, return NULL. */
3348 find_line_symtab (struct symtab
*sym_tab
, int line
,
3349 int *index
, bool *exact_match
)
3351 int exact
= 0; /* Initialized here to avoid a compiler warning. */
3353 /* BEST_INDEX and BEST_LINETABLE identify the smallest linenumber > LINE
3357 struct linetable
*best_linetable
;
3358 struct symtab
*best_symtab
;
3360 /* First try looking it up in the given symtab. */
3361 best_linetable
= SYMTAB_LINETABLE (sym_tab
);
3362 best_symtab
= sym_tab
;
3363 best_index
= find_line_common (best_linetable
, line
, &exact
, 0);
3364 if (best_index
< 0 || !exact
)
3366 /* Didn't find an exact match. So we better keep looking for
3367 another symtab with the same name. In the case of xcoff,
3368 multiple csects for one source file (produced by IBM's FORTRAN
3369 compiler) produce multiple symtabs (this is unavoidable
3370 assuming csects can be at arbitrary places in memory and that
3371 the GLOBAL_BLOCK of a symtab has a begin and end address). */
3373 /* BEST is the smallest linenumber > LINE so far seen,
3374 or 0 if none has been seen so far.
3375 BEST_INDEX and BEST_LINETABLE identify the item for it. */
3378 if (best_index
>= 0)
3379 best
= best_linetable
->item
[best_index
].line
;
3383 for (objfile
*objfile
: current_program_space
->objfiles ())
3386 objfile
->sf
->qf
->expand_symtabs_with_fullname
3387 (objfile
, symtab_to_fullname (sym_tab
));
3390 for (objfile
*objfile
: current_program_space
->objfiles ())
3392 for (compunit_symtab
*cu
: objfile
->compunits ())
3394 for (symtab
*s
: compunit_filetabs (cu
))
3396 struct linetable
*l
;
3399 if (FILENAME_CMP (sym_tab
->filename
, s
->filename
) != 0)
3401 if (FILENAME_CMP (symtab_to_fullname (sym_tab
),
3402 symtab_to_fullname (s
)) != 0)
3404 l
= SYMTAB_LINETABLE (s
);
3405 ind
= find_line_common (l
, line
, &exact
, 0);
3415 if (best
== 0 || l
->item
[ind
].line
< best
)
3417 best
= l
->item
[ind
].line
;
3432 *index
= best_index
;
3434 *exact_match
= (exact
!= 0);
3439 /* Given SYMTAB, returns all the PCs function in the symtab that
3440 exactly match LINE. Returns an empty vector if there are no exact
3441 matches, but updates BEST_ITEM in this case. */
3443 std::vector
<CORE_ADDR
>
3444 find_pcs_for_symtab_line (struct symtab
*symtab
, int line
,
3445 struct linetable_entry
**best_item
)
3448 std::vector
<CORE_ADDR
> result
;
3450 /* First, collect all the PCs that are at this line. */
3456 idx
= find_line_common (SYMTAB_LINETABLE (symtab
), line
, &was_exact
,
3463 struct linetable_entry
*item
= &SYMTAB_LINETABLE (symtab
)->item
[idx
];
3465 if (*best_item
== NULL
3466 || (item
->line
< (*best_item
)->line
&& item
->is_stmt
))
3472 result
.push_back (SYMTAB_LINETABLE (symtab
)->item
[idx
].pc
);
3480 /* Set the PC value for a given source file and line number and return true.
3481 Returns false for invalid line number (and sets the PC to 0).
3482 The source file is specified with a struct symtab. */
3485 find_line_pc (struct symtab
*symtab
, int line
, CORE_ADDR
*pc
)
3487 struct linetable
*l
;
3494 symtab
= find_line_symtab (symtab
, line
, &ind
, NULL
);
3497 l
= SYMTAB_LINETABLE (symtab
);
3498 *pc
= l
->item
[ind
].pc
;
3505 /* Find the range of pc values in a line.
3506 Store the starting pc of the line into *STARTPTR
3507 and the ending pc (start of next line) into *ENDPTR.
3508 Returns true to indicate success.
3509 Returns false if could not find the specified line. */
3512 find_line_pc_range (struct symtab_and_line sal
, CORE_ADDR
*startptr
,
3515 CORE_ADDR startaddr
;
3516 struct symtab_and_line found_sal
;
3519 if (startaddr
== 0 && !find_line_pc (sal
.symtab
, sal
.line
, &startaddr
))
3522 /* This whole function is based on address. For example, if line 10 has
3523 two parts, one from 0x100 to 0x200 and one from 0x300 to 0x400, then
3524 "info line *0x123" should say the line goes from 0x100 to 0x200
3525 and "info line *0x355" should say the line goes from 0x300 to 0x400.
3526 This also insures that we never give a range like "starts at 0x134
3527 and ends at 0x12c". */
3529 found_sal
= find_pc_sect_line (startaddr
, sal
.section
, 0);
3530 if (found_sal
.line
!= sal
.line
)
3532 /* The specified line (sal) has zero bytes. */
3533 *startptr
= found_sal
.pc
;
3534 *endptr
= found_sal
.pc
;
3538 *startptr
= found_sal
.pc
;
3539 *endptr
= found_sal
.end
;
3544 /* Given a line table and a line number, return the index into the line
3545 table for the pc of the nearest line whose number is >= the specified one.
3546 Return -1 if none is found. The value is >= 0 if it is an index.
3547 START is the index at which to start searching the line table.
3549 Set *EXACT_MATCH nonzero if the value returned is an exact match. */
3552 find_line_common (struct linetable
*l
, int lineno
,
3553 int *exact_match
, int start
)
3558 /* BEST is the smallest linenumber > LINENO so far seen,
3559 or 0 if none has been seen so far.
3560 BEST_INDEX identifies the item for it. */
3562 int best_index
= -1;
3573 for (i
= start
; i
< len
; i
++)
3575 struct linetable_entry
*item
= &(l
->item
[i
]);
3577 /* Ignore non-statements. */
3581 if (item
->line
== lineno
)
3583 /* Return the first (lowest address) entry which matches. */
3588 if (item
->line
> lineno
&& (best
== 0 || item
->line
< best
))
3595 /* If we got here, we didn't get an exact match. */
3600 find_pc_line_pc_range (CORE_ADDR pc
, CORE_ADDR
*startptr
, CORE_ADDR
*endptr
)
3602 struct symtab_and_line sal
;
3604 sal
= find_pc_line (pc
, 0);
3607 return sal
.symtab
!= 0;
3610 /* Helper for find_function_start_sal. Does most of the work, except
3611 setting the sal's symbol. */
3613 static symtab_and_line
3614 find_function_start_sal_1 (CORE_ADDR func_addr
, obj_section
*section
,
3617 symtab_and_line sal
= find_pc_sect_line (func_addr
, section
, 0);
3619 if (funfirstline
&& sal
.symtab
!= NULL
3620 && (COMPUNIT_LOCATIONS_VALID (SYMTAB_COMPUNIT (sal
.symtab
))
3621 || SYMTAB_LANGUAGE (sal
.symtab
) == language_asm
))
3623 struct gdbarch
*gdbarch
= get_objfile_arch (SYMTAB_OBJFILE (sal
.symtab
));
3626 if (gdbarch_skip_entrypoint_p (gdbarch
))
3627 sal
.pc
= gdbarch_skip_entrypoint (gdbarch
, sal
.pc
);
3631 /* We always should have a line for the function start address.
3632 If we don't, something is odd. Create a plain SAL referring
3633 just the PC and hope that skip_prologue_sal (if requested)
3634 can find a line number for after the prologue. */
3635 if (sal
.pc
< func_addr
)
3638 sal
.pspace
= current_program_space
;
3640 sal
.section
= section
;
3644 skip_prologue_sal (&sal
);
3652 find_function_start_sal (CORE_ADDR func_addr
, obj_section
*section
,
3656 = find_function_start_sal_1 (func_addr
, section
, funfirstline
);
3658 /* find_function_start_sal_1 does a linetable search, so it finds
3659 the symtab and linenumber, but not a symbol. Fill in the
3660 function symbol too. */
3661 sal
.symbol
= find_pc_sect_containing_function (sal
.pc
, sal
.section
);
3669 find_function_start_sal (symbol
*sym
, bool funfirstline
)
3671 fixup_symbol_section (sym
, NULL
);
3673 = find_function_start_sal_1 (BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
)),
3674 SYMBOL_OBJ_SECTION (symbol_objfile (sym
), sym
),
3681 /* Given a function start address FUNC_ADDR and SYMTAB, find the first
3682 address for that function that has an entry in SYMTAB's line info
3683 table. If such an entry cannot be found, return FUNC_ADDR
3687 skip_prologue_using_lineinfo (CORE_ADDR func_addr
, struct symtab
*symtab
)
3689 CORE_ADDR func_start
, func_end
;
3690 struct linetable
*l
;
3693 /* Give up if this symbol has no lineinfo table. */
3694 l
= SYMTAB_LINETABLE (symtab
);
3698 /* Get the range for the function's PC values, or give up if we
3699 cannot, for some reason. */
3700 if (!find_pc_partial_function (func_addr
, NULL
, &func_start
, &func_end
))
3703 /* Linetable entries are ordered by PC values, see the commentary in
3704 symtab.h where `struct linetable' is defined. Thus, the first
3705 entry whose PC is in the range [FUNC_START..FUNC_END[ is the
3706 address we are looking for. */
3707 for (i
= 0; i
< l
->nitems
; i
++)
3709 struct linetable_entry
*item
= &(l
->item
[i
]);
3711 /* Don't use line numbers of zero, they mark special entries in
3712 the table. See the commentary on symtab.h before the
3713 definition of struct linetable. */
3714 if (item
->line
> 0 && func_start
<= item
->pc
&& item
->pc
< func_end
)
3721 /* Adjust SAL to the first instruction past the function prologue.
3722 If the PC was explicitly specified, the SAL is not changed.
3723 If the line number was explicitly specified then the SAL can still be
3724 updated, unless the language for SAL is assembler, in which case the SAL
3725 will be left unchanged.
3726 If SAL is already past the prologue, then do nothing. */
3729 skip_prologue_sal (struct symtab_and_line
*sal
)
3732 struct symtab_and_line start_sal
;
3733 CORE_ADDR pc
, saved_pc
;
3734 struct obj_section
*section
;
3736 struct objfile
*objfile
;
3737 struct gdbarch
*gdbarch
;
3738 const struct block
*b
, *function_block
;
3739 int force_skip
, skip
;
3741 /* Do not change the SAL if PC was specified explicitly. */
3742 if (sal
->explicit_pc
)
3745 /* In assembly code, if the user asks for a specific line then we should
3746 not adjust the SAL. The user already has instruction level
3747 visibility in this case, so selecting a line other than one requested
3748 is likely to be the wrong choice. */
3749 if (sal
->symtab
!= nullptr
3750 && sal
->explicit_line
3751 && SYMTAB_LANGUAGE (sal
->symtab
) == language_asm
)
3754 scoped_restore_current_pspace_and_thread restore_pspace_thread
;
3756 switch_to_program_space_and_thread (sal
->pspace
);
3758 sym
= find_pc_sect_function (sal
->pc
, sal
->section
);
3761 fixup_symbol_section (sym
, NULL
);
3763 objfile
= symbol_objfile (sym
);
3764 pc
= BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
));
3765 section
= SYMBOL_OBJ_SECTION (objfile
, sym
);
3766 name
= sym
->linkage_name ();
3770 struct bound_minimal_symbol msymbol
3771 = lookup_minimal_symbol_by_pc_section (sal
->pc
, sal
->section
);
3773 if (msymbol
.minsym
== NULL
)
3776 objfile
= msymbol
.objfile
;
3777 pc
= BMSYMBOL_VALUE_ADDRESS (msymbol
);
3778 section
= MSYMBOL_OBJ_SECTION (objfile
, msymbol
.minsym
);
3779 name
= msymbol
.minsym
->linkage_name ();
3782 gdbarch
= get_objfile_arch (objfile
);
3784 /* Process the prologue in two passes. In the first pass try to skip the
3785 prologue (SKIP is true) and verify there is a real need for it (indicated
3786 by FORCE_SKIP). If no such reason was found run a second pass where the
3787 prologue is not skipped (SKIP is false). */
3792 /* Be conservative - allow direct PC (without skipping prologue) only if we
3793 have proven the CU (Compilation Unit) supports it. sal->SYMTAB does not
3794 have to be set by the caller so we use SYM instead. */
3796 && COMPUNIT_LOCATIONS_VALID (SYMTAB_COMPUNIT (symbol_symtab (sym
))))
3804 /* If the function is in an unmapped overlay, use its unmapped LMA address,
3805 so that gdbarch_skip_prologue has something unique to work on. */
3806 if (section_is_overlay (section
) && !section_is_mapped (section
))
3807 pc
= overlay_unmapped_address (pc
, section
);
3809 /* Skip "first line" of function (which is actually its prologue). */
3810 pc
+= gdbarch_deprecated_function_start_offset (gdbarch
);
3811 if (gdbarch_skip_entrypoint_p (gdbarch
))
3812 pc
= gdbarch_skip_entrypoint (gdbarch
, pc
);
3814 pc
= gdbarch_skip_prologue_noexcept (gdbarch
, pc
);
3816 /* For overlays, map pc back into its mapped VMA range. */
3817 pc
= overlay_mapped_address (pc
, section
);
3819 /* Calculate line number. */
3820 start_sal
= find_pc_sect_line (pc
, section
, 0);
3822 /* Check if gdbarch_skip_prologue left us in mid-line, and the next
3823 line is still part of the same function. */
3824 if (skip
&& start_sal
.pc
!= pc
3825 && (sym
? (BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
)) <= start_sal
.end
3826 && start_sal
.end
< BLOCK_END (SYMBOL_BLOCK_VALUE (sym
)))
3827 : (lookup_minimal_symbol_by_pc_section (start_sal
.end
, section
).minsym
3828 == lookup_minimal_symbol_by_pc_section (pc
, section
).minsym
)))
3830 /* First pc of next line */
3832 /* Recalculate the line number (might not be N+1). */
3833 start_sal
= find_pc_sect_line (pc
, section
, 0);
3836 /* On targets with executable formats that don't have a concept of
3837 constructors (ELF with .init has, PE doesn't), gcc emits a call
3838 to `__main' in `main' between the prologue and before user
3840 if (gdbarch_skip_main_prologue_p (gdbarch
)
3841 && name
&& strcmp_iw (name
, "main") == 0)
3843 pc
= gdbarch_skip_main_prologue (gdbarch
, pc
);
3844 /* Recalculate the line number (might not be N+1). */
3845 start_sal
= find_pc_sect_line (pc
, section
, 0);
3849 while (!force_skip
&& skip
--);
3851 /* If we still don't have a valid source line, try to find the first
3852 PC in the lineinfo table that belongs to the same function. This
3853 happens with COFF debug info, which does not seem to have an
3854 entry in lineinfo table for the code after the prologue which has
3855 no direct relation to source. For example, this was found to be
3856 the case with the DJGPP target using "gcc -gcoff" when the
3857 compiler inserted code after the prologue to make sure the stack
3859 if (!force_skip
&& sym
&& start_sal
.symtab
== NULL
)
3861 pc
= skip_prologue_using_lineinfo (pc
, symbol_symtab (sym
));
3862 /* Recalculate the line number. */
3863 start_sal
= find_pc_sect_line (pc
, section
, 0);
3866 /* If we're already past the prologue, leave SAL unchanged. Otherwise
3867 forward SAL to the end of the prologue. */
3872 sal
->section
= section
;
3873 sal
->symtab
= start_sal
.symtab
;
3874 sal
->line
= start_sal
.line
;
3875 sal
->end
= start_sal
.end
;
3877 /* Check if we are now inside an inlined function. If we can,
3878 use the call site of the function instead. */
3879 b
= block_for_pc_sect (sal
->pc
, sal
->section
);
3880 function_block
= NULL
;
3883 if (BLOCK_FUNCTION (b
) != NULL
&& block_inlined_p (b
))
3885 else if (BLOCK_FUNCTION (b
) != NULL
)
3887 b
= BLOCK_SUPERBLOCK (b
);
3889 if (function_block
!= NULL
3890 && SYMBOL_LINE (BLOCK_FUNCTION (function_block
)) != 0)
3892 sal
->line
= SYMBOL_LINE (BLOCK_FUNCTION (function_block
));
3893 sal
->symtab
= symbol_symtab (BLOCK_FUNCTION (function_block
));
3897 /* Given PC at the function's start address, attempt to find the
3898 prologue end using SAL information. Return zero if the skip fails.
3900 A non-optimized prologue traditionally has one SAL for the function
3901 and a second for the function body. A single line function has
3902 them both pointing at the same line.
3904 An optimized prologue is similar but the prologue may contain
3905 instructions (SALs) from the instruction body. Need to skip those
3906 while not getting into the function body.
3908 The functions end point and an increasing SAL line are used as
3909 indicators of the prologue's endpoint.
3911 This code is based on the function refine_prologue_limit
3915 skip_prologue_using_sal (struct gdbarch
*gdbarch
, CORE_ADDR func_addr
)
3917 struct symtab_and_line prologue_sal
;
3920 const struct block
*bl
;
3922 /* Get an initial range for the function. */
3923 find_pc_partial_function (func_addr
, NULL
, &start_pc
, &end_pc
);
3924 start_pc
+= gdbarch_deprecated_function_start_offset (gdbarch
);
3926 prologue_sal
= find_pc_line (start_pc
, 0);
3927 if (prologue_sal
.line
!= 0)
3929 /* For languages other than assembly, treat two consecutive line
3930 entries at the same address as a zero-instruction prologue.
3931 The GNU assembler emits separate line notes for each instruction
3932 in a multi-instruction macro, but compilers generally will not
3934 if (prologue_sal
.symtab
->language
!= language_asm
)
3936 struct linetable
*linetable
= SYMTAB_LINETABLE (prologue_sal
.symtab
);
3939 /* Skip any earlier lines, and any end-of-sequence marker
3940 from a previous function. */
3941 while (linetable
->item
[idx
].pc
!= prologue_sal
.pc
3942 || linetable
->item
[idx
].line
== 0)
3945 if (idx
+1 < linetable
->nitems
3946 && linetable
->item
[idx
+1].line
!= 0
3947 && linetable
->item
[idx
+1].pc
== start_pc
)
3951 /* If there is only one sal that covers the entire function,
3952 then it is probably a single line function, like
3954 if (prologue_sal
.end
>= end_pc
)
3957 while (prologue_sal
.end
< end_pc
)
3959 struct symtab_and_line sal
;
3961 sal
= find_pc_line (prologue_sal
.end
, 0);
3964 /* Assume that a consecutive SAL for the same (or larger)
3965 line mark the prologue -> body transition. */
3966 if (sal
.line
>= prologue_sal
.line
)
3968 /* Likewise if we are in a different symtab altogether
3969 (e.g. within a file included via #include). */
3970 if (sal
.symtab
!= prologue_sal
.symtab
)
3973 /* The line number is smaller. Check that it's from the
3974 same function, not something inlined. If it's inlined,
3975 then there is no point comparing the line numbers. */
3976 bl
= block_for_pc (prologue_sal
.end
);
3979 if (block_inlined_p (bl
))
3981 if (BLOCK_FUNCTION (bl
))
3986 bl
= BLOCK_SUPERBLOCK (bl
);
3991 /* The case in which compiler's optimizer/scheduler has
3992 moved instructions into the prologue. We look ahead in
3993 the function looking for address ranges whose
3994 corresponding line number is less the first one that we
3995 found for the function. This is more conservative then
3996 refine_prologue_limit which scans a large number of SALs
3997 looking for any in the prologue. */
4002 if (prologue_sal
.end
< end_pc
)
4003 /* Return the end of this line, or zero if we could not find a
4005 return prologue_sal
.end
;
4007 /* Don't return END_PC, which is past the end of the function. */
4008 return prologue_sal
.pc
;
4014 find_function_alias_target (bound_minimal_symbol msymbol
)
4016 CORE_ADDR func_addr
;
4017 if (!msymbol_is_function (msymbol
.objfile
, msymbol
.minsym
, &func_addr
))
4020 symbol
*sym
= find_pc_function (func_addr
);
4022 && SYMBOL_CLASS (sym
) == LOC_BLOCK
4023 && BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
)) == func_addr
)
4030 /* If P is of the form "operator[ \t]+..." where `...' is
4031 some legitimate operator text, return a pointer to the
4032 beginning of the substring of the operator text.
4033 Otherwise, return "". */
4036 operator_chars (const char *p
, const char **end
)
4039 if (!startswith (p
, CP_OPERATOR_STR
))
4041 p
+= CP_OPERATOR_LEN
;
4043 /* Don't get faked out by `operator' being part of a longer
4045 if (isalpha (*p
) || *p
== '_' || *p
== '$' || *p
== '\0')
4048 /* Allow some whitespace between `operator' and the operator symbol. */
4049 while (*p
== ' ' || *p
== '\t')
4052 /* Recognize 'operator TYPENAME'. */
4054 if (isalpha (*p
) || *p
== '_' || *p
== '$')
4056 const char *q
= p
+ 1;
4058 while (isalnum (*q
) || *q
== '_' || *q
== '$')
4067 case '\\': /* regexp quoting */
4070 if (p
[2] == '=') /* 'operator\*=' */
4072 else /* 'operator\*' */
4076 else if (p
[1] == '[')
4079 error (_("mismatched quoting on brackets, "
4080 "try 'operator\\[\\]'"));
4081 else if (p
[2] == '\\' && p
[3] == ']')
4083 *end
= p
+ 4; /* 'operator\[\]' */
4087 error (_("nothing is allowed between '[' and ']'"));
4091 /* Gratuitous quote: skip it and move on. */
4113 if (p
[0] == '-' && p
[1] == '>')
4115 /* Struct pointer member operator 'operator->'. */
4118 *end
= p
+ 3; /* 'operator->*' */
4121 else if (p
[2] == '\\')
4123 *end
= p
+ 4; /* Hopefully 'operator->\*' */
4128 *end
= p
+ 2; /* 'operator->' */
4132 if (p
[1] == '=' || p
[1] == p
[0])
4143 error (_("`operator ()' must be specified "
4144 "without whitespace in `()'"));
4149 error (_("`operator ?:' must be specified "
4150 "without whitespace in `?:'"));
4155 error (_("`operator []' must be specified "
4156 "without whitespace in `[]'"));
4160 error (_("`operator %s' not supported"), p
);
4169 /* What part to match in a file name. */
4171 struct filename_partial_match_opts
4173 /* Only match the directory name part. */
4174 bool dirname
= false;
4176 /* Only match the basename part. */
4177 bool basename
= false;
4180 /* Data structure to maintain printing state for output_source_filename. */
4182 struct output_source_filename_data
4184 /* Output only filenames matching REGEXP. */
4186 gdb::optional
<compiled_regex
> c_regexp
;
4187 /* Possibly only match a part of the filename. */
4188 filename_partial_match_opts partial_match
;
4191 /* Cache of what we've seen so far. */
4192 struct filename_seen_cache
*filename_seen_cache
;
4194 /* Flag of whether we're printing the first one. */
4198 /* Slave routine for sources_info. Force line breaks at ,'s.
4199 NAME is the name to print.
4200 DATA contains the state for printing and watching for duplicates. */
4203 output_source_filename (const char *name
,
4204 struct output_source_filename_data
*data
)
4206 /* Since a single source file can result in several partial symbol
4207 tables, we need to avoid printing it more than once. Note: if
4208 some of the psymtabs are read in and some are not, it gets
4209 printed both under "Source files for which symbols have been
4210 read" and "Source files for which symbols will be read in on
4211 demand". I consider this a reasonable way to deal with the
4212 situation. I'm not sure whether this can also happen for
4213 symtabs; it doesn't hurt to check. */
4215 /* Was NAME already seen? */
4216 if (data
->filename_seen_cache
->seen (name
))
4218 /* Yes; don't print it again. */
4222 /* Does it match data->regexp? */
4223 if (data
->c_regexp
.has_value ())
4225 const char *to_match
;
4226 std::string dirname
;
4228 if (data
->partial_match
.dirname
)
4230 dirname
= ldirname (name
);
4231 to_match
= dirname
.c_str ();
4233 else if (data
->partial_match
.basename
)
4234 to_match
= lbasename (name
);
4238 if (data
->c_regexp
->exec (to_match
, 0, NULL
, 0) != 0)
4242 /* Print it and reset *FIRST. */
4244 printf_filtered (", ");
4248 fputs_styled (name
, file_name_style
.style (), gdb_stdout
);
4251 /* A callback for map_partial_symbol_filenames. */
4254 output_partial_symbol_filename (const char *filename
, const char *fullname
,
4257 output_source_filename (fullname
? fullname
: filename
,
4258 (struct output_source_filename_data
*) data
);
4261 using isrc_flag_option_def
4262 = gdb::option::flag_option_def
<filename_partial_match_opts
>;
4264 static const gdb::option::option_def info_sources_option_defs
[] = {
4266 isrc_flag_option_def
{
4268 [] (filename_partial_match_opts
*opts
) { return &opts
->dirname
; },
4269 N_("Show only the files having a dirname matching REGEXP."),
4272 isrc_flag_option_def
{
4274 [] (filename_partial_match_opts
*opts
) { return &opts
->basename
; },
4275 N_("Show only the files having a basename matching REGEXP."),
4280 /* Create an option_def_group for the "info sources" options, with
4281 ISRC_OPTS as context. */
4283 static inline gdb::option::option_def_group
4284 make_info_sources_options_def_group (filename_partial_match_opts
*isrc_opts
)
4286 return {{info_sources_option_defs
}, isrc_opts
};
4289 /* Prints the header message for the source files that will be printed
4290 with the matching info present in DATA. SYMBOL_MSG is a message
4291 that tells what will or has been done with the symbols of the
4292 matching source files. */
4295 print_info_sources_header (const char *symbol_msg
,
4296 const struct output_source_filename_data
*data
)
4298 puts_filtered (symbol_msg
);
4299 if (!data
->regexp
.empty ())
4301 if (data
->partial_match
.dirname
)
4302 printf_filtered (_("(dirname matching regular expression \"%s\")"),
4303 data
->regexp
.c_str ());
4304 else if (data
->partial_match
.basename
)
4305 printf_filtered (_("(basename matching regular expression \"%s\")"),
4306 data
->regexp
.c_str ());
4308 printf_filtered (_("(filename matching regular expression \"%s\")"),
4309 data
->regexp
.c_str ());
4311 puts_filtered ("\n");
4314 /* Completer for "info sources". */
4317 info_sources_command_completer (cmd_list_element
*ignore
,
4318 completion_tracker
&tracker
,
4319 const char *text
, const char *word
)
4321 const auto group
= make_info_sources_options_def_group (nullptr);
4322 if (gdb::option::complete_options
4323 (tracker
, &text
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, group
))
4328 info_sources_command (const char *args
, int from_tty
)
4330 struct output_source_filename_data data
;
4332 if (!have_full_symbols () && !have_partial_symbols ())
4334 error (_("No symbol table is loaded. Use the \"file\" command."));
4337 filename_seen_cache filenames_seen
;
4339 auto group
= make_info_sources_options_def_group (&data
.partial_match
);
4341 gdb::option::process_options
4342 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_ERROR
, group
);
4344 if (args
!= NULL
&& *args
!= '\000')
4347 data
.filename_seen_cache
= &filenames_seen
;
4350 if (data
.partial_match
.dirname
&& data
.partial_match
.basename
)
4351 error (_("You cannot give both -basename and -dirname to 'info sources'."));
4352 if ((data
.partial_match
.dirname
|| data
.partial_match
.basename
)
4353 && data
.regexp
.empty ())
4354 error (_("Missing REGEXP for 'info sources'."));
4356 if (data
.regexp
.empty ())
4357 data
.c_regexp
.reset ();
4360 int cflags
= REG_NOSUB
;
4361 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
4362 cflags
|= REG_ICASE
;
4364 data
.c_regexp
.emplace (data
.regexp
.c_str (), cflags
,
4365 _("Invalid regexp"));
4368 print_info_sources_header
4369 (_("Source files for which symbols have been read in:\n"), &data
);
4371 for (objfile
*objfile
: current_program_space
->objfiles ())
4373 for (compunit_symtab
*cu
: objfile
->compunits ())
4375 for (symtab
*s
: compunit_filetabs (cu
))
4377 const char *fullname
= symtab_to_fullname (s
);
4379 output_source_filename (fullname
, &data
);
4383 printf_filtered ("\n\n");
4385 print_info_sources_header
4386 (_("Source files for which symbols will be read in on demand:\n"), &data
);
4388 filenames_seen
.clear ();
4390 map_symbol_filenames (output_partial_symbol_filename
, &data
,
4391 1 /*need_fullname*/);
4392 printf_filtered ("\n");
4395 /* Compare FILE against all the entries of FILENAMES. If BASENAMES is
4396 true compare only lbasename of FILENAMES. */
4399 file_matches (const char *file
, const std::vector
<const char *> &filenames
,
4402 if (filenames
.empty ())
4405 for (const char *name
: filenames
)
4407 name
= (basenames
? lbasename (name
) : name
);
4408 if (compare_filenames_for_search (file
, name
))
4415 /* Helper function for std::sort on symbol_search objects. Can only sort
4416 symbols, not minimal symbols. */
4419 symbol_search::compare_search_syms (const symbol_search
&sym_a
,
4420 const symbol_search
&sym_b
)
4424 c
= FILENAME_CMP (symbol_symtab (sym_a
.symbol
)->filename
,
4425 symbol_symtab (sym_b
.symbol
)->filename
);
4429 if (sym_a
.block
!= sym_b
.block
)
4430 return sym_a
.block
- sym_b
.block
;
4432 return strcmp (sym_a
.symbol
->print_name (), sym_b
.symbol
->print_name ());
4435 /* Returns true if the type_name of symbol_type of SYM matches TREG.
4436 If SYM has no symbol_type or symbol_name, returns false. */
4439 treg_matches_sym_type_name (const compiled_regex
&treg
,
4440 const struct symbol
*sym
)
4442 struct type
*sym_type
;
4443 std::string printed_sym_type_name
;
4445 if (symbol_lookup_debug
> 1)
4447 fprintf_unfiltered (gdb_stdlog
,
4448 "treg_matches_sym_type_name\n sym %s\n",
4449 sym
->natural_name ());
4452 sym_type
= SYMBOL_TYPE (sym
);
4453 if (sym_type
== NULL
)
4457 scoped_switch_to_sym_language_if_auto
l (sym
);
4459 printed_sym_type_name
= type_to_string (sym_type
);
4463 if (symbol_lookup_debug
> 1)
4465 fprintf_unfiltered (gdb_stdlog
,
4466 " sym_type_name %s\n",
4467 printed_sym_type_name
.c_str ());
4471 if (printed_sym_type_name
.empty ())
4474 return treg
.exec (printed_sym_type_name
.c_str (), 0, NULL
, 0) == 0;
4480 global_symbol_searcher::is_suitable_msymbol
4481 (const enum search_domain kind
, const minimal_symbol
*msymbol
)
4483 switch (MSYMBOL_TYPE (msymbol
))
4489 return kind
== VARIABLES_DOMAIN
;
4492 case mst_solib_trampoline
:
4493 case mst_text_gnu_ifunc
:
4494 return kind
== FUNCTIONS_DOMAIN
;
4503 global_symbol_searcher::expand_symtabs
4504 (objfile
*objfile
, const gdb::optional
<compiled_regex
> &preg
) const
4506 enum search_domain kind
= m_kind
;
4507 bool found_msymbol
= false;
4510 objfile
->sf
->qf
->expand_symtabs_matching
4512 [&] (const char *filename
, bool basenames
)
4514 return file_matches (filename
, filenames
, basenames
);
4516 lookup_name_info::match_any (),
4517 [&] (const char *symname
)
4519 return (!preg
.has_value ()
4520 || preg
->exec (symname
, 0, NULL
, 0) == 0);
4525 /* Here, we search through the minimal symbol tables for functions and
4526 variables that match, and force their symbols to be read. This is in
4527 particular necessary for demangled variable names, which are no longer
4528 put into the partial symbol tables. The symbol will then be found
4529 during the scan of symtabs later.
4531 For functions, find_pc_symtab should succeed if we have debug info for
4532 the function, for variables we have to call
4533 lookup_symbol_in_objfile_from_linkage_name to determine if the
4534 variable has debug info. If the lookup fails, set found_msymbol so
4535 that we will rescan to print any matching symbols without debug info.
4536 We only search the objfile the msymbol came from, we no longer search
4537 all objfiles. In large programs (1000s of shared libs) searching all
4538 objfiles is not worth the pain. */
4539 if (filenames
.empty ()
4540 && (kind
== VARIABLES_DOMAIN
|| kind
== FUNCTIONS_DOMAIN
))
4542 for (minimal_symbol
*msymbol
: objfile
->msymbols ())
4546 if (msymbol
->created_by_gdb
)
4549 if (is_suitable_msymbol (kind
, msymbol
))
4551 if (!preg
.has_value ()
4552 || preg
->exec (msymbol
->natural_name (), 0,
4555 /* An important side-effect of these lookup functions is
4556 to expand the symbol table if msymbol is found, later
4557 in the process we will add matching symbols or
4558 msymbols to the results list, and that requires that
4559 the symbols tables are expanded. */
4560 if (kind
== FUNCTIONS_DOMAIN
4561 ? (find_pc_compunit_symtab
4562 (MSYMBOL_VALUE_ADDRESS (objfile
, msymbol
))
4564 : (lookup_symbol_in_objfile_from_linkage_name
4565 (objfile
, msymbol
->linkage_name (),
4568 found_msymbol
= true;
4574 return found_msymbol
;
4580 global_symbol_searcher::add_matching_symbols
4582 const gdb::optional
<compiled_regex
> &preg
,
4583 const gdb::optional
<compiled_regex
> &treg
,
4584 std::set
<symbol_search
> *result_set
) const
4586 enum search_domain kind
= m_kind
;
4588 /* Add matching symbols (if not already present). */
4589 for (compunit_symtab
*cust
: objfile
->compunits ())
4591 const struct blockvector
*bv
= COMPUNIT_BLOCKVECTOR (cust
);
4593 for (block_enum block
: { GLOBAL_BLOCK
, STATIC_BLOCK
})
4595 struct block_iterator iter
;
4597 const struct block
*b
= BLOCKVECTOR_BLOCK (bv
, block
);
4599 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
4601 struct symtab
*real_symtab
= symbol_symtab (sym
);
4605 /* Check first sole REAL_SYMTAB->FILENAME. It does
4606 not need to be a substring of symtab_to_fullname as
4607 it may contain "./" etc. */
4608 if ((file_matches (real_symtab
->filename
, filenames
, false)
4609 || ((basenames_may_differ
4610 || file_matches (lbasename (real_symtab
->filename
),
4612 && file_matches (symtab_to_fullname (real_symtab
),
4614 && ((!preg
.has_value ()
4615 || preg
->exec (sym
->natural_name (), 0,
4617 && ((kind
== VARIABLES_DOMAIN
4618 && SYMBOL_CLASS (sym
) != LOC_TYPEDEF
4619 && SYMBOL_CLASS (sym
) != LOC_UNRESOLVED
4620 && SYMBOL_CLASS (sym
) != LOC_BLOCK
4621 /* LOC_CONST can be used for more than
4622 just enums, e.g., c++ static const
4623 members. We only want to skip enums
4625 && !(SYMBOL_CLASS (sym
) == LOC_CONST
4626 && (TYPE_CODE (SYMBOL_TYPE (sym
))
4628 && (!treg
.has_value ()
4629 || treg_matches_sym_type_name (*treg
, sym
)))
4630 || (kind
== FUNCTIONS_DOMAIN
4631 && SYMBOL_CLASS (sym
) == LOC_BLOCK
4632 && (!treg
.has_value ()
4633 || treg_matches_sym_type_name (*treg
,
4635 || (kind
== TYPES_DOMAIN
4636 && SYMBOL_CLASS (sym
) == LOC_TYPEDEF
4637 && SYMBOL_DOMAIN (sym
) != MODULE_DOMAIN
)
4638 || (kind
== MODULES_DOMAIN
4639 && SYMBOL_DOMAIN (sym
) == MODULE_DOMAIN
4640 && SYMBOL_LINE (sym
) != 0))))
4642 if (result_set
->size () < m_max_search_results
)
4644 /* Match, insert if not already in the results. */
4645 symbol_search
ss (block
, sym
);
4646 if (result_set
->find (ss
) == result_set
->end ())
4647 result_set
->insert (ss
);
4662 global_symbol_searcher::add_matching_msymbols
4663 (objfile
*objfile
, const gdb::optional
<compiled_regex
> &preg
,
4664 std::vector
<symbol_search
> *results
) const
4666 enum search_domain kind
= m_kind
;
4668 for (minimal_symbol
*msymbol
: objfile
->msymbols ())
4672 if (msymbol
->created_by_gdb
)
4675 if (is_suitable_msymbol (kind
, msymbol
))
4677 if (!preg
.has_value ()
4678 || preg
->exec (msymbol
->natural_name (), 0,
4681 /* For functions we can do a quick check of whether the
4682 symbol might be found via find_pc_symtab. */
4683 if (kind
!= FUNCTIONS_DOMAIN
4684 || (find_pc_compunit_symtab
4685 (MSYMBOL_VALUE_ADDRESS (objfile
, msymbol
))
4688 if (lookup_symbol_in_objfile_from_linkage_name
4689 (objfile
, msymbol
->linkage_name (),
4690 VAR_DOMAIN
).symbol
== NULL
)
4692 /* Matching msymbol, add it to the results list. */
4693 if (results
->size () < m_max_search_results
)
4694 results
->emplace_back (GLOBAL_BLOCK
, msymbol
, objfile
);
4708 std::vector
<symbol_search
>
4709 global_symbol_searcher::search () const
4711 gdb::optional
<compiled_regex
> preg
;
4712 gdb::optional
<compiled_regex
> treg
;
4714 gdb_assert (m_kind
!= ALL_DOMAIN
);
4716 if (m_symbol_name_regexp
!= NULL
)
4718 const char *symbol_name_regexp
= m_symbol_name_regexp
;
4720 /* Make sure spacing is right for C++ operators.
4721 This is just a courtesy to make the matching less sensitive
4722 to how many spaces the user leaves between 'operator'
4723 and <TYPENAME> or <OPERATOR>. */
4725 const char *opname
= operator_chars (symbol_name_regexp
, &opend
);
4729 int fix
= -1; /* -1 means ok; otherwise number of
4732 if (isalpha (*opname
) || *opname
== '_' || *opname
== '$')
4734 /* There should 1 space between 'operator' and 'TYPENAME'. */
4735 if (opname
[-1] != ' ' || opname
[-2] == ' ')
4740 /* There should 0 spaces between 'operator' and 'OPERATOR'. */
4741 if (opname
[-1] == ' ')
4744 /* If wrong number of spaces, fix it. */
4747 char *tmp
= (char *) alloca (8 + fix
+ strlen (opname
) + 1);
4749 sprintf (tmp
, "operator%.*s%s", fix
, " ", opname
);
4750 symbol_name_regexp
= tmp
;
4754 int cflags
= REG_NOSUB
| (case_sensitivity
== case_sensitive_off
4756 preg
.emplace (symbol_name_regexp
, cflags
,
4757 _("Invalid regexp"));
4760 if (m_symbol_type_regexp
!= NULL
)
4762 int cflags
= REG_NOSUB
| (case_sensitivity
== case_sensitive_off
4764 treg
.emplace (m_symbol_type_regexp
, cflags
,
4765 _("Invalid regexp"));
4768 bool found_msymbol
= false;
4769 std::set
<symbol_search
> result_set
;
4770 for (objfile
*objfile
: current_program_space
->objfiles ())
4772 /* Expand symtabs within objfile that possibly contain matching
4774 found_msymbol
|= expand_symtabs (objfile
, preg
);
4776 /* Find matching symbols within OBJFILE and add them in to the
4777 RESULT_SET set. Use a set here so that we can easily detect
4778 duplicates as we go, and can therefore track how many unique
4779 matches we have found so far. */
4780 if (!add_matching_symbols (objfile
, preg
, treg
, &result_set
))
4784 /* Convert the result set into a sorted result list, as std::set is
4785 defined to be sorted then no explicit call to std::sort is needed. */
4786 std::vector
<symbol_search
> result (result_set
.begin (), result_set
.end ());
4788 /* If there are no debug symbols, then add matching minsyms. But if the
4789 user wants to see symbols matching a type regexp, then never give a
4790 minimal symbol, as we assume that a minimal symbol does not have a
4792 if ((found_msymbol
|| (filenames
.empty () && m_kind
== VARIABLES_DOMAIN
))
4793 && !m_exclude_minsyms
4794 && !treg
.has_value ())
4796 gdb_assert (m_kind
== VARIABLES_DOMAIN
|| m_kind
== FUNCTIONS_DOMAIN
);
4797 for (objfile
*objfile
: current_program_space
->objfiles ())
4798 if (!add_matching_msymbols (objfile
, preg
, &result
))
4808 symbol_to_info_string (struct symbol
*sym
, int block
,
4809 enum search_domain kind
)
4813 gdb_assert (block
== GLOBAL_BLOCK
|| block
== STATIC_BLOCK
);
4815 if (kind
!= TYPES_DOMAIN
&& block
== STATIC_BLOCK
)
4818 /* Typedef that is not a C++ class. */
4819 if (kind
== TYPES_DOMAIN
4820 && SYMBOL_DOMAIN (sym
) != STRUCT_DOMAIN
)
4822 string_file tmp_stream
;
4824 /* FIXME: For C (and C++) we end up with a difference in output here
4825 between how a typedef is printed, and non-typedefs are printed.
4826 The TYPEDEF_PRINT code places a ";" at the end in an attempt to
4827 appear C-like, while TYPE_PRINT doesn't.
4829 For the struct printing case below, things are worse, we force
4830 printing of the ";" in this function, which is going to be wrong
4831 for languages that don't require a ";" between statements. */
4832 if (TYPE_CODE (SYMBOL_TYPE (sym
)) == TYPE_CODE_TYPEDEF
)
4833 typedef_print (SYMBOL_TYPE (sym
), sym
, &tmp_stream
);
4835 type_print (SYMBOL_TYPE (sym
), "", &tmp_stream
, -1);
4836 str
+= tmp_stream
.string ();
4838 /* variable, func, or typedef-that-is-c++-class. */
4839 else if (kind
< TYPES_DOMAIN
4840 || (kind
== TYPES_DOMAIN
4841 && SYMBOL_DOMAIN (sym
) == STRUCT_DOMAIN
))
4843 string_file tmp_stream
;
4845 type_print (SYMBOL_TYPE (sym
),
4846 (SYMBOL_CLASS (sym
) == LOC_TYPEDEF
4847 ? "" : sym
->print_name ()),
4850 str
+= tmp_stream
.string ();
4853 /* Printing of modules is currently done here, maybe at some future
4854 point we might want a language specific method to print the module
4855 symbol so that we can customise the output more. */
4856 else if (kind
== MODULES_DOMAIN
)
4857 str
+= sym
->print_name ();
4862 /* Helper function for symbol info commands, for example 'info functions',
4863 'info variables', etc. KIND is the kind of symbol we searched for, and
4864 BLOCK is the type of block the symbols was found in, either GLOBAL_BLOCK
4865 or STATIC_BLOCK. SYM is the symbol we found. If LAST is not NULL,
4866 print file and line number information for the symbol as well. Skip
4867 printing the filename if it matches LAST. */
4870 print_symbol_info (enum search_domain kind
,
4872 int block
, const char *last
)
4874 scoped_switch_to_sym_language_if_auto
l (sym
);
4875 struct symtab
*s
= symbol_symtab (sym
);
4879 const char *s_filename
= symtab_to_filename_for_display (s
);
4881 if (filename_cmp (last
, s_filename
) != 0)
4883 printf_filtered (_("\nFile %ps:\n"),
4884 styled_string (file_name_style
.style (),
4888 if (SYMBOL_LINE (sym
) != 0)
4889 printf_filtered ("%d:\t", SYMBOL_LINE (sym
));
4891 puts_filtered ("\t");
4894 std::string str
= symbol_to_info_string (sym
, block
, kind
);
4895 printf_filtered ("%s\n", str
.c_str ());
4898 /* This help function for symtab_symbol_info() prints information
4899 for non-debugging symbols to gdb_stdout. */
4902 print_msymbol_info (struct bound_minimal_symbol msymbol
)
4904 struct gdbarch
*gdbarch
= get_objfile_arch (msymbol
.objfile
);
4907 if (gdbarch_addr_bit (gdbarch
) <= 32)
4908 tmp
= hex_string_custom (BMSYMBOL_VALUE_ADDRESS (msymbol
)
4909 & (CORE_ADDR
) 0xffffffff,
4912 tmp
= hex_string_custom (BMSYMBOL_VALUE_ADDRESS (msymbol
),
4915 ui_file_style sym_style
= (msymbol
.minsym
->text_p ()
4916 ? function_name_style
.style ()
4917 : ui_file_style ());
4919 printf_filtered (_("%ps %ps\n"),
4920 styled_string (address_style
.style (), tmp
),
4921 styled_string (sym_style
, msymbol
.minsym
->print_name ()));
4924 /* This is the guts of the commands "info functions", "info types", and
4925 "info variables". It calls search_symbols to find all matches and then
4926 print_[m]symbol_info to print out some useful information about the
4930 symtab_symbol_info (bool quiet
, bool exclude_minsyms
,
4931 const char *regexp
, enum search_domain kind
,
4932 const char *t_regexp
, int from_tty
)
4934 static const char * const classnames
[] =
4935 {"variable", "function", "type", "module"};
4936 const char *last_filename
= "";
4939 gdb_assert (kind
!= ALL_DOMAIN
);
4941 if (regexp
!= nullptr && *regexp
== '\0')
4944 global_symbol_searcher
spec (kind
, regexp
);
4945 spec
.set_symbol_type_regexp (t_regexp
);
4946 spec
.set_exclude_minsyms (exclude_minsyms
);
4947 std::vector
<symbol_search
> symbols
= spec
.search ();
4953 if (t_regexp
!= NULL
)
4955 (_("All %ss matching regular expression \"%s\""
4956 " with type matching regular expression \"%s\":\n"),
4957 classnames
[kind
], regexp
, t_regexp
);
4959 printf_filtered (_("All %ss matching regular expression \"%s\":\n"),
4960 classnames
[kind
], regexp
);
4964 if (t_regexp
!= NULL
)
4966 (_("All defined %ss"
4967 " with type matching regular expression \"%s\" :\n"),
4968 classnames
[kind
], t_regexp
);
4970 printf_filtered (_("All defined %ss:\n"), classnames
[kind
]);
4974 for (const symbol_search
&p
: symbols
)
4978 if (p
.msymbol
.minsym
!= NULL
)
4983 printf_filtered (_("\nNon-debugging symbols:\n"));
4986 print_msymbol_info (p
.msymbol
);
4990 print_symbol_info (kind
,
4995 = symtab_to_filename_for_display (symbol_symtab (p
.symbol
));
5000 /* Structure to hold the values of the options used by the 'info variables'
5001 and 'info functions' commands. These correspond to the -q, -t, and -n
5004 struct info_vars_funcs_options
5007 bool exclude_minsyms
= false;
5008 char *type_regexp
= nullptr;
5010 ~info_vars_funcs_options ()
5012 xfree (type_regexp
);
5016 /* The options used by the 'info variables' and 'info functions'
5019 static const gdb::option::option_def info_vars_funcs_options_defs
[] = {
5020 gdb::option::boolean_option_def
<info_vars_funcs_options
> {
5022 [] (info_vars_funcs_options
*opt
) { return &opt
->quiet
; },
5023 nullptr, /* show_cmd_cb */
5024 nullptr /* set_doc */
5027 gdb::option::boolean_option_def
<info_vars_funcs_options
> {
5029 [] (info_vars_funcs_options
*opt
) { return &opt
->exclude_minsyms
; },
5030 nullptr, /* show_cmd_cb */
5031 nullptr /* set_doc */
5034 gdb::option::string_option_def
<info_vars_funcs_options
> {
5036 [] (info_vars_funcs_options
*opt
) { return &opt
->type_regexp
;
5038 nullptr, /* show_cmd_cb */
5039 nullptr /* set_doc */
5043 /* Returns the option group used by 'info variables' and 'info
5046 static gdb::option::option_def_group
5047 make_info_vars_funcs_options_def_group (info_vars_funcs_options
*opts
)
5049 return {{info_vars_funcs_options_defs
}, opts
};
5052 /* Command completer for 'info variables' and 'info functions'. */
5055 info_vars_funcs_command_completer (struct cmd_list_element
*ignore
,
5056 completion_tracker
&tracker
,
5057 const char *text
, const char * /* word */)
5060 = make_info_vars_funcs_options_def_group (nullptr);
5061 if (gdb::option::complete_options
5062 (tracker
, &text
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, group
))
5065 const char *word
= advance_to_expression_complete_word_point (tracker
, text
);
5066 symbol_completer (ignore
, tracker
, text
, word
);
5069 /* Implement the 'info variables' command. */
5072 info_variables_command (const char *args
, int from_tty
)
5074 info_vars_funcs_options opts
;
5075 auto grp
= make_info_vars_funcs_options_def_group (&opts
);
5076 gdb::option::process_options
5077 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
5078 if (args
!= nullptr && *args
== '\0')
5081 symtab_symbol_info (opts
.quiet
, opts
.exclude_minsyms
, args
, VARIABLES_DOMAIN
,
5082 opts
.type_regexp
, from_tty
);
5085 /* Implement the 'info functions' command. */
5088 info_functions_command (const char *args
, int from_tty
)
5090 info_vars_funcs_options opts
;
5092 auto grp
= make_info_vars_funcs_options_def_group (&opts
);
5093 gdb::option::process_options
5094 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
5095 if (args
!= nullptr && *args
== '\0')
5098 symtab_symbol_info (opts
.quiet
, opts
.exclude_minsyms
, args
,
5099 FUNCTIONS_DOMAIN
, opts
.type_regexp
, from_tty
);
5102 /* Holds the -q option for the 'info types' command. */
5104 struct info_types_options
5109 /* The options used by the 'info types' command. */
5111 static const gdb::option::option_def info_types_options_defs
[] = {
5112 gdb::option::boolean_option_def
<info_types_options
> {
5114 [] (info_types_options
*opt
) { return &opt
->quiet
; },
5115 nullptr, /* show_cmd_cb */
5116 nullptr /* set_doc */
5120 /* Returns the option group used by 'info types'. */
5122 static gdb::option::option_def_group
5123 make_info_types_options_def_group (info_types_options
*opts
)
5125 return {{info_types_options_defs
}, opts
};
5128 /* Implement the 'info types' command. */
5131 info_types_command (const char *args
, int from_tty
)
5133 info_types_options opts
;
5135 auto grp
= make_info_types_options_def_group (&opts
);
5136 gdb::option::process_options
5137 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
5138 if (args
!= nullptr && *args
== '\0')
5140 symtab_symbol_info (opts
.quiet
, false, args
, TYPES_DOMAIN
, NULL
, from_tty
);
5143 /* Command completer for 'info types' command. */
5146 info_types_command_completer (struct cmd_list_element
*ignore
,
5147 completion_tracker
&tracker
,
5148 const char *text
, const char * /* word */)
5151 = make_info_types_options_def_group (nullptr);
5152 if (gdb::option::complete_options
5153 (tracker
, &text
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, group
))
5156 const char *word
= advance_to_expression_complete_word_point (tracker
, text
);
5157 symbol_completer (ignore
, tracker
, text
, word
);
5160 /* Implement the 'info modules' command. */
5163 info_modules_command (const char *args
, int from_tty
)
5165 info_types_options opts
;
5167 auto grp
= make_info_types_options_def_group (&opts
);
5168 gdb::option::process_options
5169 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
5170 if (args
!= nullptr && *args
== '\0')
5172 symtab_symbol_info (opts
.quiet
, true, args
, MODULES_DOMAIN
, NULL
,
5177 rbreak_command (const char *regexp
, int from_tty
)
5180 const char *file_name
= nullptr;
5182 if (regexp
!= nullptr)
5184 const char *colon
= strchr (regexp
, ':');
5186 if (colon
&& *(colon
+ 1) != ':')
5191 colon_index
= colon
- regexp
;
5192 local_name
= (char *) alloca (colon_index
+ 1);
5193 memcpy (local_name
, regexp
, colon_index
);
5194 local_name
[colon_index
--] = 0;
5195 while (isspace (local_name
[colon_index
]))
5196 local_name
[colon_index
--] = 0;
5197 file_name
= local_name
;
5198 regexp
= skip_spaces (colon
+ 1);
5202 global_symbol_searcher
spec (FUNCTIONS_DOMAIN
, regexp
);
5203 if (file_name
!= nullptr)
5204 spec
.filenames
.push_back (file_name
);
5205 std::vector
<symbol_search
> symbols
= spec
.search ();
5207 scoped_rbreak_breakpoints finalize
;
5208 for (const symbol_search
&p
: symbols
)
5210 if (p
.msymbol
.minsym
== NULL
)
5212 struct symtab
*symtab
= symbol_symtab (p
.symbol
);
5213 const char *fullname
= symtab_to_fullname (symtab
);
5215 string
= string_printf ("%s:'%s'", fullname
,
5216 p
.symbol
->linkage_name ());
5217 break_command (&string
[0], from_tty
);
5218 print_symbol_info (FUNCTIONS_DOMAIN
, p
.symbol
, p
.block
, NULL
);
5222 string
= string_printf ("'%s'",
5223 p
.msymbol
.minsym
->linkage_name ());
5225 break_command (&string
[0], from_tty
);
5226 printf_filtered ("<function, no debug info> %s;\n",
5227 p
.msymbol
.minsym
->print_name ());
5233 /* Evaluate if SYMNAME matches LOOKUP_NAME. */
5236 compare_symbol_name (const char *symbol_name
, language symbol_language
,
5237 const lookup_name_info
&lookup_name
,
5238 completion_match_result
&match_res
)
5240 const language_defn
*lang
= language_def (symbol_language
);
5242 symbol_name_matcher_ftype
*name_match
5243 = get_symbol_name_matcher (lang
, lookup_name
);
5245 return name_match (symbol_name
, lookup_name
, &match_res
);
5251 completion_list_add_name (completion_tracker
&tracker
,
5252 language symbol_language
,
5253 const char *symname
,
5254 const lookup_name_info
&lookup_name
,
5255 const char *text
, const char *word
)
5257 completion_match_result
&match_res
5258 = tracker
.reset_completion_match_result ();
5260 /* Clip symbols that cannot match. */
5261 if (!compare_symbol_name (symname
, symbol_language
, lookup_name
, match_res
))
5264 /* Refresh SYMNAME from the match string. It's potentially
5265 different depending on language. (E.g., on Ada, the match may be
5266 the encoded symbol name wrapped in "<>"). */
5267 symname
= match_res
.match
.match ();
5268 gdb_assert (symname
!= NULL
);
5270 /* We have a match for a completion, so add SYMNAME to the current list
5271 of matches. Note that the name is moved to freshly malloc'd space. */
5274 gdb::unique_xmalloc_ptr
<char> completion
5275 = make_completion_match_str (symname
, text
, word
);
5277 /* Here we pass the match-for-lcd object to add_completion. Some
5278 languages match the user text against substrings of symbol
5279 names in some cases. E.g., in C++, "b push_ba" completes to
5280 "std::vector::push_back", "std::string::push_back", etc., and
5281 in this case we want the completion lowest common denominator
5282 to be "push_back" instead of "std::". */
5283 tracker
.add_completion (std::move (completion
),
5284 &match_res
.match_for_lcd
, text
, word
);
5288 /* completion_list_add_name wrapper for struct symbol. */
5291 completion_list_add_symbol (completion_tracker
&tracker
,
5293 const lookup_name_info
&lookup_name
,
5294 const char *text
, const char *word
)
5296 completion_list_add_name (tracker
, sym
->language (),
5297 sym
->natural_name (),
5298 lookup_name
, text
, word
);
5300 /* C++ function symbols include the parameters within both the msymbol
5301 name and the symbol name. The problem is that the msymbol name will
5302 describe the parameters in the most basic way, with typedefs stripped
5303 out, while the symbol name will represent the types as they appear in
5304 the program. This means we will see duplicate entries in the
5305 completion tracker. The following converts the symbol name back to
5306 the msymbol name and removes the msymbol name from the completion
5308 if (sym
->language () == language_cplus
5309 && SYMBOL_DOMAIN (sym
) == VAR_DOMAIN
5310 && SYMBOL_CLASS (sym
) == LOC_BLOCK
)
5312 /* The call to canonicalize returns the empty string if the input
5313 string is already in canonical form, thanks to this we don't
5314 remove the symbol we just added above. */
5316 = cp_canonicalize_string_no_typedefs (sym
->natural_name ());
5318 tracker
.remove_completion (str
.c_str ());
5322 /* completion_list_add_name wrapper for struct minimal_symbol. */
5325 completion_list_add_msymbol (completion_tracker
&tracker
,
5326 minimal_symbol
*sym
,
5327 const lookup_name_info
&lookup_name
,
5328 const char *text
, const char *word
)
5330 completion_list_add_name (tracker
, sym
->language (),
5331 sym
->natural_name (),
5332 lookup_name
, text
, word
);
5336 /* ObjC: In case we are completing on a selector, look as the msymbol
5337 again and feed all the selectors into the mill. */
5340 completion_list_objc_symbol (completion_tracker
&tracker
,
5341 struct minimal_symbol
*msymbol
,
5342 const lookup_name_info
&lookup_name
,
5343 const char *text
, const char *word
)
5345 static char *tmp
= NULL
;
5346 static unsigned int tmplen
= 0;
5348 const char *method
, *category
, *selector
;
5351 method
= msymbol
->natural_name ();
5353 /* Is it a method? */
5354 if ((method
[0] != '-') && (method
[0] != '+'))
5358 /* Complete on shortened method method. */
5359 completion_list_add_name (tracker
, language_objc
,
5364 while ((strlen (method
) + 1) >= tmplen
)
5370 tmp
= (char *) xrealloc (tmp
, tmplen
);
5372 selector
= strchr (method
, ' ');
5373 if (selector
!= NULL
)
5376 category
= strchr (method
, '(');
5378 if ((category
!= NULL
) && (selector
!= NULL
))
5380 memcpy (tmp
, method
, (category
- method
));
5381 tmp
[category
- method
] = ' ';
5382 memcpy (tmp
+ (category
- method
) + 1, selector
, strlen (selector
) + 1);
5383 completion_list_add_name (tracker
, language_objc
, tmp
,
5384 lookup_name
, text
, word
);
5386 completion_list_add_name (tracker
, language_objc
, tmp
+ 1,
5387 lookup_name
, text
, word
);
5390 if (selector
!= NULL
)
5392 /* Complete on selector only. */
5393 strcpy (tmp
, selector
);
5394 tmp2
= strchr (tmp
, ']');
5398 completion_list_add_name (tracker
, language_objc
, tmp
,
5399 lookup_name
, text
, word
);
5403 /* Break the non-quoted text based on the characters which are in
5404 symbols. FIXME: This should probably be language-specific. */
5407 language_search_unquoted_string (const char *text
, const char *p
)
5409 for (; p
> text
; --p
)
5411 if (isalnum (p
[-1]) || p
[-1] == '_' || p
[-1] == '\0')
5415 if ((current_language
->la_language
== language_objc
))
5417 if (p
[-1] == ':') /* Might be part of a method name. */
5419 else if (p
[-1] == '[' && (p
[-2] == '-' || p
[-2] == '+'))
5420 p
-= 2; /* Beginning of a method name. */
5421 else if (p
[-1] == ' ' || p
[-1] == '(' || p
[-1] == ')')
5422 { /* Might be part of a method name. */
5425 /* Seeing a ' ' or a '(' is not conclusive evidence
5426 that we are in the middle of a method name. However,
5427 finding "-[" or "+[" should be pretty un-ambiguous.
5428 Unfortunately we have to find it now to decide. */
5431 if (isalnum (t
[-1]) || t
[-1] == '_' ||
5432 t
[-1] == ' ' || t
[-1] == ':' ||
5433 t
[-1] == '(' || t
[-1] == ')')
5438 if (t
[-1] == '[' && (t
[-2] == '-' || t
[-2] == '+'))
5439 p
= t
- 2; /* Method name detected. */
5440 /* Else we leave with p unchanged. */
5450 completion_list_add_fields (completion_tracker
&tracker
,
5452 const lookup_name_info
&lookup_name
,
5453 const char *text
, const char *word
)
5455 if (SYMBOL_CLASS (sym
) == LOC_TYPEDEF
)
5457 struct type
*t
= SYMBOL_TYPE (sym
);
5458 enum type_code c
= TYPE_CODE (t
);
5461 if (c
== TYPE_CODE_UNION
|| c
== TYPE_CODE_STRUCT
)
5462 for (j
= TYPE_N_BASECLASSES (t
); j
< TYPE_NFIELDS (t
); j
++)
5463 if (TYPE_FIELD_NAME (t
, j
))
5464 completion_list_add_name (tracker
, sym
->language (),
5465 TYPE_FIELD_NAME (t
, j
),
5466 lookup_name
, text
, word
);
5473 symbol_is_function_or_method (symbol
*sym
)
5475 switch (TYPE_CODE (SYMBOL_TYPE (sym
)))
5477 case TYPE_CODE_FUNC
:
5478 case TYPE_CODE_METHOD
:
5488 symbol_is_function_or_method (minimal_symbol
*msymbol
)
5490 switch (MSYMBOL_TYPE (msymbol
))
5493 case mst_text_gnu_ifunc
:
5494 case mst_solib_trampoline
:
5504 bound_minimal_symbol
5505 find_gnu_ifunc (const symbol
*sym
)
5507 if (SYMBOL_CLASS (sym
) != LOC_BLOCK
)
5510 lookup_name_info
lookup_name (sym
->search_name (),
5511 symbol_name_match_type::SEARCH_NAME
);
5512 struct objfile
*objfile
= symbol_objfile (sym
);
5514 CORE_ADDR address
= BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
));
5515 minimal_symbol
*ifunc
= NULL
;
5517 iterate_over_minimal_symbols (objfile
, lookup_name
,
5518 [&] (minimal_symbol
*minsym
)
5520 if (MSYMBOL_TYPE (minsym
) == mst_text_gnu_ifunc
5521 || MSYMBOL_TYPE (minsym
) == mst_data_gnu_ifunc
)
5523 CORE_ADDR msym_addr
= MSYMBOL_VALUE_ADDRESS (objfile
, minsym
);
5524 if (MSYMBOL_TYPE (minsym
) == mst_data_gnu_ifunc
)
5526 struct gdbarch
*gdbarch
= get_objfile_arch (objfile
);
5528 = gdbarch_convert_from_func_ptr_addr (gdbarch
,
5530 current_top_target ());
5532 if (msym_addr
== address
)
5542 return {ifunc
, objfile
};
5546 /* Add matching symbols from SYMTAB to the current completion list. */
5549 add_symtab_completions (struct compunit_symtab
*cust
,
5550 completion_tracker
&tracker
,
5551 complete_symbol_mode mode
,
5552 const lookup_name_info
&lookup_name
,
5553 const char *text
, const char *word
,
5554 enum type_code code
)
5557 const struct block
*b
;
5558 struct block_iterator iter
;
5564 for (i
= GLOBAL_BLOCK
; i
<= STATIC_BLOCK
; i
++)
5567 b
= BLOCKVECTOR_BLOCK (COMPUNIT_BLOCKVECTOR (cust
), i
);
5568 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
5570 if (completion_skip_symbol (mode
, sym
))
5573 if (code
== TYPE_CODE_UNDEF
5574 || (SYMBOL_DOMAIN (sym
) == STRUCT_DOMAIN
5575 && TYPE_CODE (SYMBOL_TYPE (sym
)) == code
))
5576 completion_list_add_symbol (tracker
, sym
,
5584 default_collect_symbol_completion_matches_break_on
5585 (completion_tracker
&tracker
, complete_symbol_mode mode
,
5586 symbol_name_match_type name_match_type
,
5587 const char *text
, const char *word
,
5588 const char *break_on
, enum type_code code
)
5590 /* Problem: All of the symbols have to be copied because readline
5591 frees them. I'm not going to worry about this; hopefully there
5592 won't be that many. */
5595 const struct block
*b
;
5596 const struct block
*surrounding_static_block
, *surrounding_global_block
;
5597 struct block_iterator iter
;
5598 /* The symbol we are completing on. Points in same buffer as text. */
5599 const char *sym_text
;
5601 /* Now look for the symbol we are supposed to complete on. */
5602 if (mode
== complete_symbol_mode::LINESPEC
)
5608 const char *quote_pos
= NULL
;
5610 /* First see if this is a quoted string. */
5612 for (p
= text
; *p
!= '\0'; ++p
)
5614 if (quote_found
!= '\0')
5616 if (*p
== quote_found
)
5617 /* Found close quote. */
5619 else if (*p
== '\\' && p
[1] == quote_found
)
5620 /* A backslash followed by the quote character
5621 doesn't end the string. */
5624 else if (*p
== '\'' || *p
== '"')
5630 if (quote_found
== '\'')
5631 /* A string within single quotes can be a symbol, so complete on it. */
5632 sym_text
= quote_pos
+ 1;
5633 else if (quote_found
== '"')
5634 /* A double-quoted string is never a symbol, nor does it make sense
5635 to complete it any other way. */
5641 /* It is not a quoted string. Break it based on the characters
5642 which are in symbols. */
5645 if (isalnum (p
[-1]) || p
[-1] == '_' || p
[-1] == '\0'
5646 || p
[-1] == ':' || strchr (break_on
, p
[-1]) != NULL
)
5655 lookup_name_info
lookup_name (sym_text
, name_match_type
, true);
5657 /* At this point scan through the misc symbol vectors and add each
5658 symbol you find to the list. Eventually we want to ignore
5659 anything that isn't a text symbol (everything else will be
5660 handled by the psymtab code below). */
5662 if (code
== TYPE_CODE_UNDEF
)
5664 for (objfile
*objfile
: current_program_space
->objfiles ())
5666 for (minimal_symbol
*msymbol
: objfile
->msymbols ())
5670 if (completion_skip_symbol (mode
, msymbol
))
5673 completion_list_add_msymbol (tracker
, msymbol
, lookup_name
,
5676 completion_list_objc_symbol (tracker
, msymbol
, lookup_name
,
5682 /* Add completions for all currently loaded symbol tables. */
5683 for (objfile
*objfile
: current_program_space
->objfiles ())
5685 for (compunit_symtab
*cust
: objfile
->compunits ())
5686 add_symtab_completions (cust
, tracker
, mode
, lookup_name
,
5687 sym_text
, word
, code
);
5690 /* Look through the partial symtabs for all symbols which begin by
5691 matching SYM_TEXT. Expand all CUs that you find to the list. */
5692 expand_symtabs_matching (NULL
,
5695 [&] (compunit_symtab
*symtab
) /* expansion notify */
5697 add_symtab_completions (symtab
,
5698 tracker
, mode
, lookup_name
,
5699 sym_text
, word
, code
);
5703 /* Search upwards from currently selected frame (so that we can
5704 complete on local vars). Also catch fields of types defined in
5705 this places which match our text string. Only complete on types
5706 visible from current context. */
5708 b
= get_selected_block (0);
5709 surrounding_static_block
= block_static_block (b
);
5710 surrounding_global_block
= block_global_block (b
);
5711 if (surrounding_static_block
!= NULL
)
5712 while (b
!= surrounding_static_block
)
5716 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
5718 if (code
== TYPE_CODE_UNDEF
)
5720 completion_list_add_symbol (tracker
, sym
, lookup_name
,
5722 completion_list_add_fields (tracker
, sym
, lookup_name
,
5725 else if (SYMBOL_DOMAIN (sym
) == STRUCT_DOMAIN
5726 && TYPE_CODE (SYMBOL_TYPE (sym
)) == code
)
5727 completion_list_add_symbol (tracker
, sym
, lookup_name
,
5731 /* Stop when we encounter an enclosing function. Do not stop for
5732 non-inlined functions - the locals of the enclosing function
5733 are in scope for a nested function. */
5734 if (BLOCK_FUNCTION (b
) != NULL
&& block_inlined_p (b
))
5736 b
= BLOCK_SUPERBLOCK (b
);
5739 /* Add fields from the file's types; symbols will be added below. */
5741 if (code
== TYPE_CODE_UNDEF
)
5743 if (surrounding_static_block
!= NULL
)
5744 ALL_BLOCK_SYMBOLS (surrounding_static_block
, iter
, sym
)
5745 completion_list_add_fields (tracker
, sym
, lookup_name
,
5748 if (surrounding_global_block
!= NULL
)
5749 ALL_BLOCK_SYMBOLS (surrounding_global_block
, iter
, sym
)
5750 completion_list_add_fields (tracker
, sym
, lookup_name
,
5754 /* Skip macros if we are completing a struct tag -- arguable but
5755 usually what is expected. */
5756 if (current_language
->la_macro_expansion
== macro_expansion_c
5757 && code
== TYPE_CODE_UNDEF
)
5759 gdb::unique_xmalloc_ptr
<struct macro_scope
> scope
;
5761 /* This adds a macro's name to the current completion list. */
5762 auto add_macro_name
= [&] (const char *macro_name
,
5763 const macro_definition
*,
5764 macro_source_file
*,
5767 completion_list_add_name (tracker
, language_c
, macro_name
,
5768 lookup_name
, sym_text
, word
);
5771 /* Add any macros visible in the default scope. Note that this
5772 may yield the occasional wrong result, because an expression
5773 might be evaluated in a scope other than the default. For
5774 example, if the user types "break file:line if <TAB>", the
5775 resulting expression will be evaluated at "file:line" -- but
5776 at there does not seem to be a way to detect this at
5778 scope
= default_macro_scope ();
5780 macro_for_each_in_scope (scope
->file
, scope
->line
,
5783 /* User-defined macros are always visible. */
5784 macro_for_each (macro_user_macros
, add_macro_name
);
5789 default_collect_symbol_completion_matches (completion_tracker
&tracker
,
5790 complete_symbol_mode mode
,
5791 symbol_name_match_type name_match_type
,
5792 const char *text
, const char *word
,
5793 enum type_code code
)
5795 return default_collect_symbol_completion_matches_break_on (tracker
, mode
,
5801 /* Collect all symbols (regardless of class) which begin by matching
5805 collect_symbol_completion_matches (completion_tracker
&tracker
,
5806 complete_symbol_mode mode
,
5807 symbol_name_match_type name_match_type
,
5808 const char *text
, const char *word
)
5810 current_language
->la_collect_symbol_completion_matches (tracker
, mode
,
5816 /* Like collect_symbol_completion_matches, but only collect
5817 STRUCT_DOMAIN symbols whose type code is CODE. */
5820 collect_symbol_completion_matches_type (completion_tracker
&tracker
,
5821 const char *text
, const char *word
,
5822 enum type_code code
)
5824 complete_symbol_mode mode
= complete_symbol_mode::EXPRESSION
;
5825 symbol_name_match_type name_match_type
= symbol_name_match_type::EXPRESSION
;
5827 gdb_assert (code
== TYPE_CODE_UNION
5828 || code
== TYPE_CODE_STRUCT
5829 || code
== TYPE_CODE_ENUM
);
5830 current_language
->la_collect_symbol_completion_matches (tracker
, mode
,
5835 /* Like collect_symbol_completion_matches, but collects a list of
5836 symbols defined in all source files named SRCFILE. */
5839 collect_file_symbol_completion_matches (completion_tracker
&tracker
,
5840 complete_symbol_mode mode
,
5841 symbol_name_match_type name_match_type
,
5842 const char *text
, const char *word
,
5843 const char *srcfile
)
5845 /* The symbol we are completing on. Points in same buffer as text. */
5846 const char *sym_text
;
5848 /* Now look for the symbol we are supposed to complete on.
5849 FIXME: This should be language-specific. */
5850 if (mode
== complete_symbol_mode::LINESPEC
)
5856 const char *quote_pos
= NULL
;
5858 /* First see if this is a quoted string. */
5860 for (p
= text
; *p
!= '\0'; ++p
)
5862 if (quote_found
!= '\0')
5864 if (*p
== quote_found
)
5865 /* Found close quote. */
5867 else if (*p
== '\\' && p
[1] == quote_found
)
5868 /* A backslash followed by the quote character
5869 doesn't end the string. */
5872 else if (*p
== '\'' || *p
== '"')
5878 if (quote_found
== '\'')
5879 /* A string within single quotes can be a symbol, so complete on it. */
5880 sym_text
= quote_pos
+ 1;
5881 else if (quote_found
== '"')
5882 /* A double-quoted string is never a symbol, nor does it make sense
5883 to complete it any other way. */
5889 /* Not a quoted string. */
5890 sym_text
= language_search_unquoted_string (text
, p
);
5894 lookup_name_info
lookup_name (sym_text
, name_match_type
, true);
5896 /* Go through symtabs for SRCFILE and check the externs and statics
5897 for symbols which match. */
5898 iterate_over_symtabs (srcfile
, [&] (symtab
*s
)
5900 add_symtab_completions (SYMTAB_COMPUNIT (s
),
5901 tracker
, mode
, lookup_name
,
5902 sym_text
, word
, TYPE_CODE_UNDEF
);
5907 /* A helper function for make_source_files_completion_list. It adds
5908 another file name to a list of possible completions, growing the
5909 list as necessary. */
5912 add_filename_to_list (const char *fname
, const char *text
, const char *word
,
5913 completion_list
*list
)
5915 list
->emplace_back (make_completion_match_str (fname
, text
, word
));
5919 not_interesting_fname (const char *fname
)
5921 static const char *illegal_aliens
[] = {
5922 "_globals_", /* inserted by coff_symtab_read */
5927 for (i
= 0; illegal_aliens
[i
]; i
++)
5929 if (filename_cmp (fname
, illegal_aliens
[i
]) == 0)
5935 /* An object of this type is passed as the user_data argument to
5936 map_partial_symbol_filenames. */
5937 struct add_partial_filename_data
5939 struct filename_seen_cache
*filename_seen_cache
;
5943 completion_list
*list
;
5946 /* A callback for map_partial_symbol_filenames. */
5949 maybe_add_partial_symtab_filename (const char *filename
, const char *fullname
,
5952 struct add_partial_filename_data
*data
5953 = (struct add_partial_filename_data
*) user_data
;
5955 if (not_interesting_fname (filename
))
5957 if (!data
->filename_seen_cache
->seen (filename
)
5958 && filename_ncmp (filename
, data
->text
, data
->text_len
) == 0)
5960 /* This file matches for a completion; add it to the
5961 current list of matches. */
5962 add_filename_to_list (filename
, data
->text
, data
->word
, data
->list
);
5966 const char *base_name
= lbasename (filename
);
5968 if (base_name
!= filename
5969 && !data
->filename_seen_cache
->seen (base_name
)
5970 && filename_ncmp (base_name
, data
->text
, data
->text_len
) == 0)
5971 add_filename_to_list (base_name
, data
->text
, data
->word
, data
->list
);
5975 /* Return a list of all source files whose names begin with matching
5976 TEXT. The file names are looked up in the symbol tables of this
5980 make_source_files_completion_list (const char *text
, const char *word
)
5982 size_t text_len
= strlen (text
);
5983 completion_list list
;
5984 const char *base_name
;
5985 struct add_partial_filename_data datum
;
5987 if (!have_full_symbols () && !have_partial_symbols ())
5990 filename_seen_cache filenames_seen
;
5992 for (objfile
*objfile
: current_program_space
->objfiles ())
5994 for (compunit_symtab
*cu
: objfile
->compunits ())
5996 for (symtab
*s
: compunit_filetabs (cu
))
5998 if (not_interesting_fname (s
->filename
))
6000 if (!filenames_seen
.seen (s
->filename
)
6001 && filename_ncmp (s
->filename
, text
, text_len
) == 0)
6003 /* This file matches for a completion; add it to the current
6005 add_filename_to_list (s
->filename
, text
, word
, &list
);
6009 /* NOTE: We allow the user to type a base name when the
6010 debug info records leading directories, but not the other
6011 way around. This is what subroutines of breakpoint
6012 command do when they parse file names. */
6013 base_name
= lbasename (s
->filename
);
6014 if (base_name
!= s
->filename
6015 && !filenames_seen
.seen (base_name
)
6016 && filename_ncmp (base_name
, text
, text_len
) == 0)
6017 add_filename_to_list (base_name
, text
, word
, &list
);
6023 datum
.filename_seen_cache
= &filenames_seen
;
6026 datum
.text_len
= text_len
;
6028 map_symbol_filenames (maybe_add_partial_symtab_filename
, &datum
,
6029 0 /*need_fullname*/);
6036 /* Return the "main_info" object for the current program space. If
6037 the object has not yet been created, create it and fill in some
6040 static struct main_info
*
6041 get_main_info (void)
6043 struct main_info
*info
= main_progspace_key
.get (current_program_space
);
6047 /* It may seem strange to store the main name in the progspace
6048 and also in whatever objfile happens to see a main name in
6049 its debug info. The reason for this is mainly historical:
6050 gdb returned "main" as the name even if no function named
6051 "main" was defined the program; and this approach lets us
6052 keep compatibility. */
6053 info
= main_progspace_key
.emplace (current_program_space
);
6060 set_main_name (const char *name
, enum language lang
)
6062 struct main_info
*info
= get_main_info ();
6064 if (info
->name_of_main
!= NULL
)
6066 xfree (info
->name_of_main
);
6067 info
->name_of_main
= NULL
;
6068 info
->language_of_main
= language_unknown
;
6072 info
->name_of_main
= xstrdup (name
);
6073 info
->language_of_main
= lang
;
6077 /* Deduce the name of the main procedure, and set NAME_OF_MAIN
6081 find_main_name (void)
6083 const char *new_main_name
;
6085 /* First check the objfiles to see whether a debuginfo reader has
6086 picked up the appropriate main name. Historically the main name
6087 was found in a more or less random way; this approach instead
6088 relies on the order of objfile creation -- which still isn't
6089 guaranteed to get the correct answer, but is just probably more
6091 for (objfile
*objfile
: current_program_space
->objfiles ())
6093 if (objfile
->per_bfd
->name_of_main
!= NULL
)
6095 set_main_name (objfile
->per_bfd
->name_of_main
,
6096 objfile
->per_bfd
->language_of_main
);
6101 /* Try to see if the main procedure is in Ada. */
6102 /* FIXME: brobecker/2005-03-07: Another way of doing this would
6103 be to add a new method in the language vector, and call this
6104 method for each language until one of them returns a non-empty
6105 name. This would allow us to remove this hard-coded call to
6106 an Ada function. It is not clear that this is a better approach
6107 at this point, because all methods need to be written in a way
6108 such that false positives never be returned. For instance, it is
6109 important that a method does not return a wrong name for the main
6110 procedure if the main procedure is actually written in a different
6111 language. It is easy to guaranty this with Ada, since we use a
6112 special symbol generated only when the main in Ada to find the name
6113 of the main procedure. It is difficult however to see how this can
6114 be guarantied for languages such as C, for instance. This suggests
6115 that order of call for these methods becomes important, which means
6116 a more complicated approach. */
6117 new_main_name
= ada_main_name ();
6118 if (new_main_name
!= NULL
)
6120 set_main_name (new_main_name
, language_ada
);
6124 new_main_name
= d_main_name ();
6125 if (new_main_name
!= NULL
)
6127 set_main_name (new_main_name
, language_d
);
6131 new_main_name
= go_main_name ();
6132 if (new_main_name
!= NULL
)
6134 set_main_name (new_main_name
, language_go
);
6138 new_main_name
= pascal_main_name ();
6139 if (new_main_name
!= NULL
)
6141 set_main_name (new_main_name
, language_pascal
);
6145 /* The languages above didn't identify the name of the main procedure.
6146 Fallback to "main". */
6147 set_main_name ("main", language_unknown
);
6155 struct main_info
*info
= get_main_info ();
6157 if (info
->name_of_main
== NULL
)
6160 return info
->name_of_main
;
6163 /* Return the language of the main function. If it is not known,
6164 return language_unknown. */
6167 main_language (void)
6169 struct main_info
*info
= get_main_info ();
6171 if (info
->name_of_main
== NULL
)
6174 return info
->language_of_main
;
6177 /* Handle ``executable_changed'' events for the symtab module. */
6180 symtab_observer_executable_changed (void)
6182 /* NAME_OF_MAIN may no longer be the same, so reset it for now. */
6183 set_main_name (NULL
, language_unknown
);
6186 /* Return 1 if the supplied producer string matches the ARM RealView
6187 compiler (armcc). */
6190 producer_is_realview (const char *producer
)
6192 static const char *const arm_idents
[] = {
6193 "ARM C Compiler, ADS",
6194 "Thumb C Compiler, ADS",
6195 "ARM C++ Compiler, ADS",
6196 "Thumb C++ Compiler, ADS",
6197 "ARM/Thumb C/C++ Compiler, RVCT",
6198 "ARM C/C++ Compiler, RVCT"
6202 if (producer
== NULL
)
6205 for (i
= 0; i
< ARRAY_SIZE (arm_idents
); i
++)
6206 if (startswith (producer
, arm_idents
[i
]))
6214 /* The next index to hand out in response to a registration request. */
6216 static int next_aclass_value
= LOC_FINAL_VALUE
;
6218 /* The maximum number of "aclass" registrations we support. This is
6219 constant for convenience. */
6220 #define MAX_SYMBOL_IMPLS (LOC_FINAL_VALUE + 10)
6222 /* The objects representing the various "aclass" values. The elements
6223 from 0 up to LOC_FINAL_VALUE-1 represent themselves, and subsequent
6224 elements are those registered at gdb initialization time. */
6226 static struct symbol_impl symbol_impl
[MAX_SYMBOL_IMPLS
];
6228 /* The globally visible pointer. This is separate from 'symbol_impl'
6229 so that it can be const. */
6231 const struct symbol_impl
*symbol_impls
= &symbol_impl
[0];
6233 /* Make sure we saved enough room in struct symbol. */
6235 gdb_static_assert (MAX_SYMBOL_IMPLS
<= (1 << SYMBOL_ACLASS_BITS
));
6237 /* Register a computed symbol type. ACLASS must be LOC_COMPUTED. OPS
6238 is the ops vector associated with this index. This returns the new
6239 index, which should be used as the aclass_index field for symbols
6243 register_symbol_computed_impl (enum address_class aclass
,
6244 const struct symbol_computed_ops
*ops
)
6246 int result
= next_aclass_value
++;
6248 gdb_assert (aclass
== LOC_COMPUTED
);
6249 gdb_assert (result
< MAX_SYMBOL_IMPLS
);
6250 symbol_impl
[result
].aclass
= aclass
;
6251 symbol_impl
[result
].ops_computed
= ops
;
6253 /* Sanity check OPS. */
6254 gdb_assert (ops
!= NULL
);
6255 gdb_assert (ops
->tracepoint_var_ref
!= NULL
);
6256 gdb_assert (ops
->describe_location
!= NULL
);
6257 gdb_assert (ops
->get_symbol_read_needs
!= NULL
);
6258 gdb_assert (ops
->read_variable
!= NULL
);
6263 /* Register a function with frame base type. ACLASS must be LOC_BLOCK.
6264 OPS is the ops vector associated with this index. This returns the
6265 new index, which should be used as the aclass_index field for symbols
6269 register_symbol_block_impl (enum address_class aclass
,
6270 const struct symbol_block_ops
*ops
)
6272 int result
= next_aclass_value
++;
6274 gdb_assert (aclass
== LOC_BLOCK
);
6275 gdb_assert (result
< MAX_SYMBOL_IMPLS
);
6276 symbol_impl
[result
].aclass
= aclass
;
6277 symbol_impl
[result
].ops_block
= ops
;
6279 /* Sanity check OPS. */
6280 gdb_assert (ops
!= NULL
);
6281 gdb_assert (ops
->find_frame_base_location
!= NULL
);
6286 /* Register a register symbol type. ACLASS must be LOC_REGISTER or
6287 LOC_REGPARM_ADDR. OPS is the register ops vector associated with
6288 this index. This returns the new index, which should be used as
6289 the aclass_index field for symbols of this type. */
6292 register_symbol_register_impl (enum address_class aclass
,
6293 const struct symbol_register_ops
*ops
)
6295 int result
= next_aclass_value
++;
6297 gdb_assert (aclass
== LOC_REGISTER
|| aclass
== LOC_REGPARM_ADDR
);
6298 gdb_assert (result
< MAX_SYMBOL_IMPLS
);
6299 symbol_impl
[result
].aclass
= aclass
;
6300 symbol_impl
[result
].ops_register
= ops
;
6305 /* Initialize elements of 'symbol_impl' for the constants in enum
6309 initialize_ordinary_address_classes (void)
6313 for (i
= 0; i
< LOC_FINAL_VALUE
; ++i
)
6314 symbol_impl
[i
].aclass
= (enum address_class
) i
;
6319 /* Initialize the symbol SYM, and mark it as being owned by an objfile. */
6322 initialize_objfile_symbol (struct symbol
*sym
)
6324 SYMBOL_OBJFILE_OWNED (sym
) = 1;
6325 SYMBOL_SECTION (sym
) = -1;
6328 /* Allocate and initialize a new 'struct symbol' on OBJFILE's
6332 allocate_symbol (struct objfile
*objfile
)
6334 struct symbol
*result
= new (&objfile
->objfile_obstack
) symbol ();
6336 initialize_objfile_symbol (result
);
6341 /* Allocate and initialize a new 'struct template_symbol' on OBJFILE's
6344 struct template_symbol
*
6345 allocate_template_symbol (struct objfile
*objfile
)
6347 struct template_symbol
*result
;
6349 result
= new (&objfile
->objfile_obstack
) template_symbol ();
6350 initialize_objfile_symbol (result
);
6358 symbol_objfile (const struct symbol
*symbol
)
6360 gdb_assert (SYMBOL_OBJFILE_OWNED (symbol
));
6361 return SYMTAB_OBJFILE (symbol
->owner
.symtab
);
6367 symbol_arch (const struct symbol
*symbol
)
6369 if (!SYMBOL_OBJFILE_OWNED (symbol
))
6370 return symbol
->owner
.arch
;
6371 return get_objfile_arch (SYMTAB_OBJFILE (symbol
->owner
.symtab
));
6377 symbol_symtab (const struct symbol
*symbol
)
6379 gdb_assert (SYMBOL_OBJFILE_OWNED (symbol
));
6380 return symbol
->owner
.symtab
;
6386 symbol_set_symtab (struct symbol
*symbol
, struct symtab
*symtab
)
6388 gdb_assert (SYMBOL_OBJFILE_OWNED (symbol
));
6389 symbol
->owner
.symtab
= symtab
;
6395 get_symbol_address (const struct symbol
*sym
)
6397 gdb_assert (sym
->maybe_copied
);
6398 gdb_assert (SYMBOL_CLASS (sym
) == LOC_STATIC
);
6400 const char *linkage_name
= sym
->linkage_name ();
6402 for (objfile
*objfile
: current_program_space
->objfiles ())
6404 bound_minimal_symbol minsym
6405 = lookup_minimal_symbol_linkage (linkage_name
, objfile
);
6406 if (minsym
.minsym
!= nullptr)
6407 return BMSYMBOL_VALUE_ADDRESS (minsym
);
6409 return sym
->value
.address
;
6415 get_msymbol_address (struct objfile
*objf
, const struct minimal_symbol
*minsym
)
6417 gdb_assert (minsym
->maybe_copied
);
6418 gdb_assert ((objf
->flags
& OBJF_MAINLINE
) == 0);
6420 const char *linkage_name
= minsym
->linkage_name ();
6422 for (objfile
*objfile
: current_program_space
->objfiles ())
6424 if ((objfile
->flags
& OBJF_MAINLINE
) != 0)
6426 bound_minimal_symbol found
6427 = lookup_minimal_symbol_linkage (linkage_name
, objfile
);
6428 if (found
.minsym
!= nullptr)
6429 return BMSYMBOL_VALUE_ADDRESS (found
);
6432 return minsym
->value
.address
+ objf
->section_offsets
[minsym
->section
];
6437 /* Hold the sub-commands of 'info module'. */
6439 static struct cmd_list_element
*info_module_cmdlist
= NULL
;
6441 /* Implement the 'info module' command, just displays some help text for
6442 the available sub-commands. */
6445 info_module_command (const char *args
, int from_tty
)
6447 help_list (info_module_cmdlist
, "info module ", class_info
, gdb_stdout
);
6452 std::vector
<module_symbol_search
>
6453 search_module_symbols (const char *module_regexp
, const char *regexp
,
6454 const char *type_regexp
, search_domain kind
)
6456 std::vector
<module_symbol_search
> results
;
6458 /* Search for all modules matching MODULE_REGEXP. */
6459 global_symbol_searcher
spec1 (MODULES_DOMAIN
, module_regexp
);
6460 spec1
.set_exclude_minsyms (true);
6461 std::vector
<symbol_search
> modules
= spec1
.search ();
6463 /* Now search for all symbols of the required KIND matching the required
6464 regular expressions. We figure out which ones are in which modules
6466 global_symbol_searcher
spec2 (kind
, regexp
);
6467 spec2
.set_symbol_type_regexp (type_regexp
);
6468 spec2
.set_exclude_minsyms (true);
6469 std::vector
<symbol_search
> symbols
= spec2
.search ();
6471 /* Now iterate over all MODULES, checking to see which items from
6472 SYMBOLS are in each module. */
6473 for (const symbol_search
&p
: modules
)
6477 /* This is a module. */
6478 gdb_assert (p
.symbol
!= nullptr);
6480 std::string prefix
= p
.symbol
->print_name ();
6483 for (const symbol_search
&q
: symbols
)
6485 if (q
.symbol
== nullptr)
6488 if (strncmp (q
.symbol
->print_name (), prefix
.c_str (),
6489 prefix
.size ()) != 0)
6492 results
.push_back ({p
, q
});
6499 /* Implement the core of both 'info module functions' and 'info module
6503 info_module_subcommand (bool quiet
, const char *module_regexp
,
6504 const char *regexp
, const char *type_regexp
,
6507 /* Print a header line. Don't build the header line bit by bit as this
6508 prevents internationalisation. */
6511 if (module_regexp
== nullptr)
6513 if (type_regexp
== nullptr)
6515 if (regexp
== nullptr)
6516 printf_filtered ((kind
== VARIABLES_DOMAIN
6517 ? _("All variables in all modules:")
6518 : _("All functions in all modules:")));
6521 ((kind
== VARIABLES_DOMAIN
6522 ? _("All variables matching regular expression"
6523 " \"%s\" in all modules:")
6524 : _("All functions matching regular expression"
6525 " \"%s\" in all modules:")),
6530 if (regexp
== nullptr)
6532 ((kind
== VARIABLES_DOMAIN
6533 ? _("All variables with type matching regular "
6534 "expression \"%s\" in all modules:")
6535 : _("All functions with type matching regular "
6536 "expression \"%s\" in all modules:")),
6540 ((kind
== VARIABLES_DOMAIN
6541 ? _("All variables matching regular expression "
6542 "\"%s\",\n\twith type matching regular "
6543 "expression \"%s\" in all modules:")
6544 : _("All functions matching regular expression "
6545 "\"%s\",\n\twith type matching regular "
6546 "expression \"%s\" in all modules:")),
6547 regexp
, type_regexp
);
6552 if (type_regexp
== nullptr)
6554 if (regexp
== nullptr)
6556 ((kind
== VARIABLES_DOMAIN
6557 ? _("All variables in all modules matching regular "
6558 "expression \"%s\":")
6559 : _("All functions in all modules matching regular "
6560 "expression \"%s\":")),
6564 ((kind
== VARIABLES_DOMAIN
6565 ? _("All variables matching regular expression "
6566 "\"%s\",\n\tin all modules matching regular "
6567 "expression \"%s\":")
6568 : _("All functions matching regular expression "
6569 "\"%s\",\n\tin all modules matching regular "
6570 "expression \"%s\":")),
6571 regexp
, module_regexp
);
6575 if (regexp
== nullptr)
6577 ((kind
== VARIABLES_DOMAIN
6578 ? _("All variables with type matching regular "
6579 "expression \"%s\"\n\tin all modules matching "
6580 "regular expression \"%s\":")
6581 : _("All functions with type matching regular "
6582 "expression \"%s\"\n\tin all modules matching "
6583 "regular expression \"%s\":")),
6584 type_regexp
, module_regexp
);
6587 ((kind
== VARIABLES_DOMAIN
6588 ? _("All variables matching regular expression "
6589 "\"%s\",\n\twith type matching regular expression "
6590 "\"%s\",\n\tin all modules matching regular "
6591 "expression \"%s\":")
6592 : _("All functions matching regular expression "
6593 "\"%s\",\n\twith type matching regular expression "
6594 "\"%s\",\n\tin all modules matching regular "
6595 "expression \"%s\":")),
6596 regexp
, type_regexp
, module_regexp
);
6599 printf_filtered ("\n");
6602 /* Find all symbols of type KIND matching the given regular expressions
6603 along with the symbols for the modules in which those symbols
6605 std::vector
<module_symbol_search
> module_symbols
6606 = search_module_symbols (module_regexp
, regexp
, type_regexp
, kind
);
6608 std::sort (module_symbols
.begin (), module_symbols
.end (),
6609 [] (const module_symbol_search
&a
, const module_symbol_search
&b
)
6611 if (a
.first
< b
.first
)
6613 else if (a
.first
== b
.first
)
6614 return a
.second
< b
.second
;
6619 const char *last_filename
= "";
6620 const symbol
*last_module_symbol
= nullptr;
6621 for (const module_symbol_search
&ms
: module_symbols
)
6623 const symbol_search
&p
= ms
.first
;
6624 const symbol_search
&q
= ms
.second
;
6626 gdb_assert (q
.symbol
!= nullptr);
6628 if (last_module_symbol
!= p
.symbol
)
6630 printf_filtered ("\n");
6631 printf_filtered (_("Module \"%s\":\n"), p
.symbol
->print_name ());
6632 last_module_symbol
= p
.symbol
;
6636 print_symbol_info (FUNCTIONS_DOMAIN
, q
.symbol
, q
.block
,
6639 = symtab_to_filename_for_display (symbol_symtab (q
.symbol
));
6643 /* Hold the option values for the 'info module .....' sub-commands. */
6645 struct info_modules_var_func_options
6648 char *type_regexp
= nullptr;
6649 char *module_regexp
= nullptr;
6651 ~info_modules_var_func_options ()
6653 xfree (type_regexp
);
6654 xfree (module_regexp
);
6658 /* The options used by 'info module variables' and 'info module functions'
6661 static const gdb::option::option_def info_modules_var_func_options_defs
[] = {
6662 gdb::option::boolean_option_def
<info_modules_var_func_options
> {
6664 [] (info_modules_var_func_options
*opt
) { return &opt
->quiet
; },
6665 nullptr, /* show_cmd_cb */
6666 nullptr /* set_doc */
6669 gdb::option::string_option_def
<info_modules_var_func_options
> {
6671 [] (info_modules_var_func_options
*opt
) { return &opt
->type_regexp
; },
6672 nullptr, /* show_cmd_cb */
6673 nullptr /* set_doc */
6676 gdb::option::string_option_def
<info_modules_var_func_options
> {
6678 [] (info_modules_var_func_options
*opt
) { return &opt
->module_regexp
; },
6679 nullptr, /* show_cmd_cb */
6680 nullptr /* set_doc */
6684 /* Return the option group used by the 'info module ...' sub-commands. */
6686 static inline gdb::option::option_def_group
6687 make_info_modules_var_func_options_def_group
6688 (info_modules_var_func_options
*opts
)
6690 return {{info_modules_var_func_options_defs
}, opts
};
6693 /* Implements the 'info module functions' command. */
6696 info_module_functions_command (const char *args
, int from_tty
)
6698 info_modules_var_func_options opts
;
6699 auto grp
= make_info_modules_var_func_options_def_group (&opts
);
6700 gdb::option::process_options
6701 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
6702 if (args
!= nullptr && *args
== '\0')
6705 info_module_subcommand (opts
.quiet
, opts
.module_regexp
, args
,
6706 opts
.type_regexp
, FUNCTIONS_DOMAIN
);
6709 /* Implements the 'info module variables' command. */
6712 info_module_variables_command (const char *args
, int from_tty
)
6714 info_modules_var_func_options opts
;
6715 auto grp
= make_info_modules_var_func_options_def_group (&opts
);
6716 gdb::option::process_options
6717 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
6718 if (args
!= nullptr && *args
== '\0')
6721 info_module_subcommand (opts
.quiet
, opts
.module_regexp
, args
,
6722 opts
.type_regexp
, VARIABLES_DOMAIN
);
6725 /* Command completer for 'info module ...' sub-commands. */
6728 info_module_var_func_command_completer (struct cmd_list_element
*ignore
,
6729 completion_tracker
&tracker
,
6731 const char * /* word */)
6734 const auto group
= make_info_modules_var_func_options_def_group (nullptr);
6735 if (gdb::option::complete_options
6736 (tracker
, &text
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, group
))
6739 const char *word
= advance_to_expression_complete_word_point (tracker
, text
);
6740 symbol_completer (ignore
, tracker
, text
, word
);
6745 void _initialize_symtab ();
6747 _initialize_symtab ()
6749 cmd_list_element
*c
;
6751 initialize_ordinary_address_classes ();
6753 c
= add_info ("variables", info_variables_command
,
6754 info_print_args_help (_("\
6755 All global and static variable names or those matching REGEXPs.\n\
6756 Usage: info variables [-q] [-n] [-t TYPEREGEXP] [NAMEREGEXP]\n\
6757 Prints the global and static variables.\n"),
6758 _("global and static variables"),
6760 set_cmd_completer_handle_brkchars (c
, info_vars_funcs_command_completer
);
6763 c
= add_com ("whereis", class_info
, info_variables_command
,
6764 info_print_args_help (_("\
6765 All global and static variable names, or those matching REGEXPs.\n\
6766 Usage: whereis [-q] [-n] [-t TYPEREGEXP] [NAMEREGEXP]\n\
6767 Prints the global and static variables.\n"),
6768 _("global and static variables"),
6770 set_cmd_completer_handle_brkchars (c
, info_vars_funcs_command_completer
);
6773 c
= add_info ("functions", info_functions_command
,
6774 info_print_args_help (_("\
6775 All function names or those matching REGEXPs.\n\
6776 Usage: info functions [-q] [-n] [-t TYPEREGEXP] [NAMEREGEXP]\n\
6777 Prints the functions.\n"),
6780 set_cmd_completer_handle_brkchars (c
, info_vars_funcs_command_completer
);
6782 c
= add_info ("types", info_types_command
, _("\
6783 All type names, or those matching REGEXP.\n\
6784 Usage: info types [-q] [REGEXP]\n\
6785 Print information about all types matching REGEXP, or all types if no\n\
6786 REGEXP is given. The optional flag -q disables printing of headers."));
6787 set_cmd_completer_handle_brkchars (c
, info_types_command_completer
);
6789 const auto info_sources_opts
= make_info_sources_options_def_group (nullptr);
6791 static std::string info_sources_help
6792 = gdb::option::build_help (_("\
6793 All source files in the program or those matching REGEXP.\n\
6794 Usage: info sources [OPTION]... [REGEXP]\n\
6795 By default, REGEXP is used to match anywhere in the filename.\n\
6801 c
= add_info ("sources", info_sources_command
, info_sources_help
.c_str ());
6802 set_cmd_completer_handle_brkchars (c
, info_sources_command_completer
);
6804 c
= add_info ("modules", info_modules_command
,
6805 _("All module names, or those matching REGEXP."));
6806 set_cmd_completer_handle_brkchars (c
, info_types_command_completer
);
6808 add_prefix_cmd ("module", class_info
, info_module_command
, _("\
6809 Print information about modules."),
6810 &info_module_cmdlist
, "info module ",
6813 c
= add_cmd ("functions", class_info
, info_module_functions_command
, _("\
6814 Display functions arranged by modules.\n\
6815 Usage: info module functions [-q] [-m MODREGEXP] [-t TYPEREGEXP] [REGEXP]\n\
6816 Print a summary of all functions within each Fortran module, grouped by\n\
6817 module and file. For each function the line on which the function is\n\
6818 defined is given along with the type signature and name of the function.\n\
6820 If REGEXP is provided then only functions whose name matches REGEXP are\n\
6821 listed. If MODREGEXP is provided then only functions in modules matching\n\
6822 MODREGEXP are listed. If TYPEREGEXP is given then only functions whose\n\
6823 type signature matches TYPEREGEXP are listed.\n\
6825 The -q flag suppresses printing some header information."),
6826 &info_module_cmdlist
);
6827 set_cmd_completer_handle_brkchars
6828 (c
, info_module_var_func_command_completer
);
6830 c
= add_cmd ("variables", class_info
, info_module_variables_command
, _("\
6831 Display variables arranged by modules.\n\
6832 Usage: info module variables [-q] [-m MODREGEXP] [-t TYPEREGEXP] [REGEXP]\n\
6833 Print a summary of all variables within each Fortran module, grouped by\n\
6834 module and file. For each variable the line on which the variable is\n\
6835 defined is given along with the type and name of the variable.\n\
6837 If REGEXP is provided then only variables whose name matches REGEXP are\n\
6838 listed. If MODREGEXP is provided then only variables in modules matching\n\
6839 MODREGEXP are listed. If TYPEREGEXP is given then only variables whose\n\
6840 type matches TYPEREGEXP are listed.\n\
6842 The -q flag suppresses printing some header information."),
6843 &info_module_cmdlist
);
6844 set_cmd_completer_handle_brkchars
6845 (c
, info_module_var_func_command_completer
);
6847 add_com ("rbreak", class_breakpoint
, rbreak_command
,
6848 _("Set a breakpoint for all functions matching REGEXP."));
6850 add_setshow_enum_cmd ("multiple-symbols", no_class
,
6851 multiple_symbols_modes
, &multiple_symbols_mode
,
6853 Set how the debugger handles ambiguities in expressions."), _("\
6854 Show how the debugger handles ambiguities in expressions."), _("\
6855 Valid values are \"ask\", \"all\", \"cancel\", and the default is \"all\"."),
6856 NULL
, NULL
, &setlist
, &showlist
);
6858 add_setshow_boolean_cmd ("basenames-may-differ", class_obscure
,
6859 &basenames_may_differ
, _("\
6860 Set whether a source file may have multiple base names."), _("\
6861 Show whether a source file may have multiple base names."), _("\
6862 (A \"base name\" is the name of a file with the directory part removed.\n\
6863 Example: The base name of \"/home/user/hello.c\" is \"hello.c\".)\n\
6864 If set, GDB will canonicalize file names (e.g., expand symlinks)\n\
6865 before comparing them. Canonicalization is an expensive operation,\n\
6866 but it allows the same file be known by more than one base name.\n\
6867 If not set (the default), all source files are assumed to have just\n\
6868 one base name, and gdb will do file name comparisons more efficiently."),
6870 &setlist
, &showlist
);
6872 add_setshow_zuinteger_cmd ("symtab-create", no_class
, &symtab_create_debug
,
6873 _("Set debugging of symbol table creation."),
6874 _("Show debugging of symbol table creation."), _("\
6875 When enabled (non-zero), debugging messages are printed when building\n\
6876 symbol tables. A value of 1 (one) normally provides enough information.\n\
6877 A value greater than 1 provides more verbose information."),
6880 &setdebuglist
, &showdebuglist
);
6882 add_setshow_zuinteger_cmd ("symbol-lookup", no_class
, &symbol_lookup_debug
,
6884 Set debugging of symbol lookup."), _("\
6885 Show debugging of symbol lookup."), _("\
6886 When enabled (non-zero), symbol lookups are logged."),
6888 &setdebuglist
, &showdebuglist
);
6890 add_setshow_zuinteger_cmd ("symbol-cache-size", no_class
,
6891 &new_symbol_cache_size
,
6892 _("Set the size of the symbol cache."),
6893 _("Show the size of the symbol cache."), _("\
6894 The size of the symbol cache.\n\
6895 If zero then the symbol cache is disabled."),
6896 set_symbol_cache_size_handler
, NULL
,
6897 &maintenance_set_cmdlist
,
6898 &maintenance_show_cmdlist
);
6900 add_cmd ("symbol-cache", class_maintenance
, maintenance_print_symbol_cache
,
6901 _("Dump the symbol cache for each program space."),
6902 &maintenanceprintlist
);
6904 add_cmd ("symbol-cache-statistics", class_maintenance
,
6905 maintenance_print_symbol_cache_statistics
,
6906 _("Print symbol cache statistics for each program space."),
6907 &maintenanceprintlist
);
6909 add_cmd ("flush-symbol-cache", class_maintenance
,
6910 maintenance_flush_symbol_cache
,
6911 _("Flush the symbol cache for each program space."),
6914 gdb::observers::executable_changed
.attach (symtab_observer_executable_changed
);
6915 gdb::observers::new_objfile
.attach (symtab_new_objfile_observer
);
6916 gdb::observers::free_objfile
.attach (symtab_free_objfile_observer
);