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
.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
.c_str ();
1808 m_demangled_name
= demangle_for_lookup (lookup_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 /* Find the language for partial symbol with NAME. */
2565 static enum language
2566 find_quick_global_symbol_language (const char *name
, const domain_enum domain
)
2568 for (objfile
*objfile
: current_program_space
->objfiles ())
2570 if (objfile
->sf
&& objfile
->sf
->qf
2571 && objfile
->sf
->qf
->lookup_global_symbol_language
)
2573 return language_unknown
;
2576 for (objfile
*objfile
: current_program_space
->objfiles ())
2578 bool symbol_found_p
;
2580 = objfile
->sf
->qf
->lookup_global_symbol_language (objfile
, name
, domain
,
2582 if (!symbol_found_p
)
2587 return language_unknown
;
2590 /* Private data to be used with lookup_symbol_global_iterator_cb. */
2592 struct global_or_static_sym_lookup_data
2594 /* The name of the symbol we are searching for. */
2597 /* The domain to use for our search. */
2600 /* The block index in which to search. */
2601 enum block_enum block_index
;
2603 /* The field where the callback should store the symbol if found.
2604 It should be initialized to {NULL, NULL} before the search is started. */
2605 struct block_symbol result
;
2608 /* A callback function for gdbarch_iterate_over_objfiles_in_search_order.
2609 It searches by name for a symbol in the block given by BLOCK_INDEX of the
2610 given OBJFILE. The arguments for the search are passed via CB_DATA, which
2611 in reality is a pointer to struct global_or_static_sym_lookup_data. */
2614 lookup_symbol_global_or_static_iterator_cb (struct objfile
*objfile
,
2617 struct global_or_static_sym_lookup_data
*data
=
2618 (struct global_or_static_sym_lookup_data
*) cb_data
;
2620 gdb_assert (data
->result
.symbol
== NULL
2621 && data
->result
.block
== NULL
);
2623 data
->result
= lookup_symbol_in_objfile (objfile
, data
->block_index
,
2624 data
->name
, data
->domain
);
2626 /* If we found a match, tell the iterator to stop. Otherwise,
2628 return (data
->result
.symbol
!= NULL
);
2631 /* This function contains the common code of lookup_{global,static}_symbol.
2632 OBJFILE is only used if BLOCK_INDEX is GLOBAL_SCOPE, in which case it is
2633 the objfile to start the lookup in. */
2635 static struct block_symbol
2636 lookup_global_or_static_symbol (const char *name
,
2637 enum block_enum block_index
,
2638 struct objfile
*objfile
,
2639 const domain_enum domain
)
2641 struct symbol_cache
*cache
= get_symbol_cache (current_program_space
);
2642 struct block_symbol result
;
2643 struct global_or_static_sym_lookup_data lookup_data
;
2644 struct block_symbol_cache
*bsc
;
2645 struct symbol_cache_slot
*slot
;
2647 gdb_assert (block_index
== GLOBAL_BLOCK
|| block_index
== STATIC_BLOCK
);
2648 gdb_assert (objfile
== nullptr || block_index
== GLOBAL_BLOCK
);
2650 /* First see if we can find the symbol in the cache.
2651 This works because we use the current objfile to qualify the lookup. */
2652 result
= symbol_cache_lookup (cache
, objfile
, block_index
, name
, domain
,
2654 if (result
.symbol
!= NULL
)
2656 if (SYMBOL_LOOKUP_FAILED_P (result
))
2661 /* Do a global search (of global blocks, heh). */
2662 if (result
.symbol
== NULL
)
2664 memset (&lookup_data
, 0, sizeof (lookup_data
));
2665 lookup_data
.name
= name
;
2666 lookup_data
.block_index
= block_index
;
2667 lookup_data
.domain
= domain
;
2668 gdbarch_iterate_over_objfiles_in_search_order
2669 (objfile
!= NULL
? get_objfile_arch (objfile
) : target_gdbarch (),
2670 lookup_symbol_global_or_static_iterator_cb
, &lookup_data
, objfile
);
2671 result
= lookup_data
.result
;
2674 if (result
.symbol
!= NULL
)
2675 symbol_cache_mark_found (bsc
, slot
, objfile
, result
.symbol
, result
.block
);
2677 symbol_cache_mark_not_found (bsc
, slot
, objfile
, name
, domain
);
2685 lookup_static_symbol (const char *name
, const domain_enum domain
)
2687 return lookup_global_or_static_symbol (name
, STATIC_BLOCK
, nullptr, domain
);
2693 lookup_global_symbol (const char *name
,
2694 const struct block
*block
,
2695 const domain_enum domain
)
2697 /* If a block was passed in, we want to search the corresponding
2698 global block first. This yields "more expected" behavior, and is
2699 needed to support 'FILENAME'::VARIABLE lookups. */
2700 const struct block
*global_block
= block_global_block (block
);
2701 if (global_block
!= nullptr)
2703 symbol
*sym
= lookup_symbol_in_block (name
,
2704 symbol_name_match_type::FULL
,
2705 global_block
, domain
);
2707 return { sym
, global_block
};
2710 struct objfile
*objfile
= lookup_objfile_from_block (block
);
2711 return lookup_global_or_static_symbol (name
, GLOBAL_BLOCK
, objfile
, domain
);
2715 symbol_matches_domain (enum language symbol_language
,
2716 domain_enum symbol_domain
,
2719 /* For C++ "struct foo { ... }" also defines a typedef for "foo".
2720 Similarly, any Ada type declaration implicitly defines a typedef. */
2721 if (symbol_language
== language_cplus
2722 || symbol_language
== language_d
2723 || symbol_language
== language_ada
2724 || symbol_language
== language_rust
)
2726 if ((domain
== VAR_DOMAIN
|| domain
== STRUCT_DOMAIN
)
2727 && symbol_domain
== STRUCT_DOMAIN
)
2730 /* For all other languages, strict match is required. */
2731 return (symbol_domain
== domain
);
2737 lookup_transparent_type (const char *name
)
2739 return current_language
->la_lookup_transparent_type (name
);
2742 /* A helper for basic_lookup_transparent_type that interfaces with the
2743 "quick" symbol table functions. */
2745 static struct type
*
2746 basic_lookup_transparent_type_quick (struct objfile
*objfile
,
2747 enum block_enum block_index
,
2750 struct compunit_symtab
*cust
;
2751 const struct blockvector
*bv
;
2752 const struct block
*block
;
2757 cust
= objfile
->sf
->qf
->lookup_symbol (objfile
, block_index
, name
,
2762 bv
= COMPUNIT_BLOCKVECTOR (cust
);
2763 block
= BLOCKVECTOR_BLOCK (bv
, block_index
);
2764 sym
= block_find_symbol (block
, name
, STRUCT_DOMAIN
,
2765 block_find_non_opaque_type
, NULL
);
2767 error_in_psymtab_expansion (block_index
, name
, cust
);
2768 gdb_assert (!TYPE_IS_OPAQUE (SYMBOL_TYPE (sym
)));
2769 return SYMBOL_TYPE (sym
);
2772 /* Subroutine of basic_lookup_transparent_type to simplify it.
2773 Look up the non-opaque definition of NAME in BLOCK_INDEX of OBJFILE.
2774 BLOCK_INDEX is either GLOBAL_BLOCK or STATIC_BLOCK. */
2776 static struct type
*
2777 basic_lookup_transparent_type_1 (struct objfile
*objfile
,
2778 enum block_enum block_index
,
2781 const struct blockvector
*bv
;
2782 const struct block
*block
;
2783 const struct symbol
*sym
;
2785 for (compunit_symtab
*cust
: objfile
->compunits ())
2787 bv
= COMPUNIT_BLOCKVECTOR (cust
);
2788 block
= BLOCKVECTOR_BLOCK (bv
, block_index
);
2789 sym
= block_find_symbol (block
, name
, STRUCT_DOMAIN
,
2790 block_find_non_opaque_type
, NULL
);
2793 gdb_assert (!TYPE_IS_OPAQUE (SYMBOL_TYPE (sym
)));
2794 return SYMBOL_TYPE (sym
);
2801 /* The standard implementation of lookup_transparent_type. This code
2802 was modeled on lookup_symbol -- the parts not relevant to looking
2803 up types were just left out. In particular it's assumed here that
2804 types are available in STRUCT_DOMAIN and only in file-static or
2808 basic_lookup_transparent_type (const char *name
)
2812 /* Now search all the global symbols. Do the symtab's first, then
2813 check the psymtab's. If a psymtab indicates the existence
2814 of the desired name as a global, then do psymtab-to-symtab
2815 conversion on the fly and return the found symbol. */
2817 for (objfile
*objfile
: current_program_space
->objfiles ())
2819 t
= basic_lookup_transparent_type_1 (objfile
, GLOBAL_BLOCK
, name
);
2824 for (objfile
*objfile
: current_program_space
->objfiles ())
2826 t
= basic_lookup_transparent_type_quick (objfile
, GLOBAL_BLOCK
, name
);
2831 /* Now search the static file-level symbols.
2832 Not strictly correct, but more useful than an error.
2833 Do the symtab's first, then
2834 check the psymtab's. If a psymtab indicates the existence
2835 of the desired name as a file-level static, then do psymtab-to-symtab
2836 conversion on the fly and return the found symbol. */
2838 for (objfile
*objfile
: current_program_space
->objfiles ())
2840 t
= basic_lookup_transparent_type_1 (objfile
, STATIC_BLOCK
, name
);
2845 for (objfile
*objfile
: current_program_space
->objfiles ())
2847 t
= basic_lookup_transparent_type_quick (objfile
, STATIC_BLOCK
, name
);
2852 return (struct type
*) 0;
2858 iterate_over_symbols (const struct block
*block
,
2859 const lookup_name_info
&name
,
2860 const domain_enum domain
,
2861 gdb::function_view
<symbol_found_callback_ftype
> callback
)
2863 struct block_iterator iter
;
2866 ALL_BLOCK_SYMBOLS_WITH_NAME (block
, name
, iter
, sym
)
2868 if (symbol_matches_domain (sym
->language (), SYMBOL_DOMAIN (sym
), domain
))
2870 struct block_symbol block_sym
= {sym
, block
};
2872 if (!callback (&block_sym
))
2882 iterate_over_symbols_terminated
2883 (const struct block
*block
,
2884 const lookup_name_info
&name
,
2885 const domain_enum domain
,
2886 gdb::function_view
<symbol_found_callback_ftype
> callback
)
2888 if (!iterate_over_symbols (block
, name
, domain
, callback
))
2890 struct block_symbol block_sym
= {nullptr, block
};
2891 return callback (&block_sym
);
2894 /* Find the compunit symtab associated with PC and SECTION.
2895 This will read in debug info as necessary. */
2897 struct compunit_symtab
*
2898 find_pc_sect_compunit_symtab (CORE_ADDR pc
, struct obj_section
*section
)
2900 struct compunit_symtab
*best_cust
= NULL
;
2901 CORE_ADDR distance
= 0;
2902 struct bound_minimal_symbol msymbol
;
2904 /* If we know that this is not a text address, return failure. This is
2905 necessary because we loop based on the block's high and low code
2906 addresses, which do not include the data ranges, and because
2907 we call find_pc_sect_psymtab which has a similar restriction based
2908 on the partial_symtab's texthigh and textlow. */
2909 msymbol
= lookup_minimal_symbol_by_pc_section (pc
, section
);
2910 if (msymbol
.minsym
&& msymbol
.minsym
->data_p ())
2913 /* Search all symtabs for the one whose file contains our address, and which
2914 is the smallest of all the ones containing the address. This is designed
2915 to deal with a case like symtab a is at 0x1000-0x2000 and 0x3000-0x4000
2916 and symtab b is at 0x2000-0x3000. So the GLOBAL_BLOCK for a is from
2917 0x1000-0x4000, but for address 0x2345 we want to return symtab b.
2919 This happens for native ecoff format, where code from included files
2920 gets its own symtab. The symtab for the included file should have
2921 been read in already via the dependency mechanism.
2922 It might be swifter to create several symtabs with the same name
2923 like xcoff does (I'm not sure).
2925 It also happens for objfiles that have their functions reordered.
2926 For these, the symtab we are looking for is not necessarily read in. */
2928 for (objfile
*obj_file
: current_program_space
->objfiles ())
2930 for (compunit_symtab
*cust
: obj_file
->compunits ())
2932 const struct block
*b
;
2933 const struct blockvector
*bv
;
2935 bv
= COMPUNIT_BLOCKVECTOR (cust
);
2936 b
= BLOCKVECTOR_BLOCK (bv
, GLOBAL_BLOCK
);
2938 if (BLOCK_START (b
) <= pc
2939 && BLOCK_END (b
) > pc
2941 || BLOCK_END (b
) - BLOCK_START (b
) < distance
))
2943 /* For an objfile that has its functions reordered,
2944 find_pc_psymtab will find the proper partial symbol table
2945 and we simply return its corresponding symtab. */
2946 /* In order to better support objfiles that contain both
2947 stabs and coff debugging info, we continue on if a psymtab
2949 if ((obj_file
->flags
& OBJF_REORDERED
) && obj_file
->sf
)
2951 struct compunit_symtab
*result
;
2954 = obj_file
->sf
->qf
->find_pc_sect_compunit_symtab (obj_file
,
2964 struct block_iterator iter
;
2965 struct symbol
*sym
= NULL
;
2967 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
2969 fixup_symbol_section (sym
, obj_file
);
2970 if (matching_obj_sections (SYMBOL_OBJ_SECTION (obj_file
,
2976 continue; /* No symbol in this symtab matches
2979 distance
= BLOCK_END (b
) - BLOCK_START (b
);
2985 if (best_cust
!= NULL
)
2988 /* Not found in symtabs, search the "quick" symtabs (e.g. psymtabs). */
2990 for (objfile
*objf
: current_program_space
->objfiles ())
2992 struct compunit_symtab
*result
;
2996 result
= objf
->sf
->qf
->find_pc_sect_compunit_symtab (objf
,
3007 /* Find the compunit symtab associated with PC.
3008 This will read in debug info as necessary.
3009 Backward compatibility, no section. */
3011 struct compunit_symtab
*
3012 find_pc_compunit_symtab (CORE_ADDR pc
)
3014 return find_pc_sect_compunit_symtab (pc
, find_pc_mapped_section (pc
));
3020 find_symbol_at_address (CORE_ADDR address
)
3022 for (objfile
*objfile
: current_program_space
->objfiles ())
3024 if (objfile
->sf
== NULL
3025 || objfile
->sf
->qf
->find_compunit_symtab_by_address
== NULL
)
3028 struct compunit_symtab
*symtab
3029 = objfile
->sf
->qf
->find_compunit_symtab_by_address (objfile
, address
);
3032 const struct blockvector
*bv
= COMPUNIT_BLOCKVECTOR (symtab
);
3034 for (int i
= GLOBAL_BLOCK
; i
<= STATIC_BLOCK
; ++i
)
3036 const struct block
*b
= BLOCKVECTOR_BLOCK (bv
, i
);
3037 struct block_iterator iter
;
3040 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
3042 if (SYMBOL_CLASS (sym
) == LOC_STATIC
3043 && SYMBOL_VALUE_ADDRESS (sym
) == address
)
3055 /* Find the source file and line number for a given PC value and SECTION.
3056 Return a structure containing a symtab pointer, a line number,
3057 and a pc range for the entire source line.
3058 The value's .pc field is NOT the specified pc.
3059 NOTCURRENT nonzero means, if specified pc is on a line boundary,
3060 use the line that ends there. Otherwise, in that case, the line
3061 that begins there is used. */
3063 /* The big complication here is that a line may start in one file, and end just
3064 before the start of another file. This usually occurs when you #include
3065 code in the middle of a subroutine. To properly find the end of a line's PC
3066 range, we must search all symtabs associated with this compilation unit, and
3067 find the one whose first PC is closer than that of the next line in this
3070 struct symtab_and_line
3071 find_pc_sect_line (CORE_ADDR pc
, struct obj_section
*section
, int notcurrent
)
3073 struct compunit_symtab
*cust
;
3074 struct linetable
*l
;
3076 struct linetable_entry
*item
;
3077 const struct blockvector
*bv
;
3078 struct bound_minimal_symbol msymbol
;
3080 /* Info on best line seen so far, and where it starts, and its file. */
3082 struct linetable_entry
*best
= NULL
;
3083 CORE_ADDR best_end
= 0;
3084 struct symtab
*best_symtab
= 0;
3086 /* Store here the first line number
3087 of a file which contains the line at the smallest pc after PC.
3088 If we don't find a line whose range contains PC,
3089 we will use a line one less than this,
3090 with a range from the start of that file to the first line's pc. */
3091 struct linetable_entry
*alt
= NULL
;
3093 /* Info on best line seen in this file. */
3095 struct linetable_entry
*prev
;
3097 /* If this pc is not from the current frame,
3098 it is the address of the end of a call instruction.
3099 Quite likely that is the start of the following statement.
3100 But what we want is the statement containing the instruction.
3101 Fudge the pc to make sure we get that. */
3103 /* It's tempting to assume that, if we can't find debugging info for
3104 any function enclosing PC, that we shouldn't search for line
3105 number info, either. However, GAS can emit line number info for
3106 assembly files --- very helpful when debugging hand-written
3107 assembly code. In such a case, we'd have no debug info for the
3108 function, but we would have line info. */
3113 /* elz: added this because this function returned the wrong
3114 information if the pc belongs to a stub (import/export)
3115 to call a shlib function. This stub would be anywhere between
3116 two functions in the target, and the line info was erroneously
3117 taken to be the one of the line before the pc. */
3119 /* RT: Further explanation:
3121 * We have stubs (trampolines) inserted between procedures.
3123 * Example: "shr1" exists in a shared library, and a "shr1" stub also
3124 * exists in the main image.
3126 * In the minimal symbol table, we have a bunch of symbols
3127 * sorted by start address. The stubs are marked as "trampoline",
3128 * the others appear as text. E.g.:
3130 * Minimal symbol table for main image
3131 * main: code for main (text symbol)
3132 * shr1: stub (trampoline symbol)
3133 * foo: code for foo (text symbol)
3135 * Minimal symbol table for "shr1" image:
3137 * shr1: code for shr1 (text symbol)
3140 * So the code below is trying to detect if we are in the stub
3141 * ("shr1" stub), and if so, find the real code ("shr1" trampoline),
3142 * and if found, do the symbolization from the real-code address
3143 * rather than the stub address.
3145 * Assumptions being made about the minimal symbol table:
3146 * 1. lookup_minimal_symbol_by_pc() will return a trampoline only
3147 * if we're really in the trampoline.s If we're beyond it (say
3148 * we're in "foo" in the above example), it'll have a closer
3149 * symbol (the "foo" text symbol for example) and will not
3150 * return the trampoline.
3151 * 2. lookup_minimal_symbol_text() will find a real text symbol
3152 * corresponding to the trampoline, and whose address will
3153 * be different than the trampoline address. I put in a sanity
3154 * check for the address being the same, to avoid an
3155 * infinite recursion.
3157 msymbol
= lookup_minimal_symbol_by_pc (pc
);
3158 if (msymbol
.minsym
!= NULL
)
3159 if (MSYMBOL_TYPE (msymbol
.minsym
) == mst_solib_trampoline
)
3161 struct bound_minimal_symbol mfunsym
3162 = lookup_minimal_symbol_text (msymbol
.minsym
->linkage_name (),
3165 if (mfunsym
.minsym
== NULL
)
3166 /* I eliminated this warning since it is coming out
3167 * in the following situation:
3168 * gdb shmain // test program with shared libraries
3169 * (gdb) break shr1 // function in shared lib
3170 * Warning: In stub for ...
3171 * In the above situation, the shared lib is not loaded yet,
3172 * so of course we can't find the real func/line info,
3173 * but the "break" still works, and the warning is annoying.
3174 * So I commented out the warning. RT */
3175 /* warning ("In stub for %s; unable to find real function/line info",
3176 msymbol->linkage_name ()); */
3179 else if (BMSYMBOL_VALUE_ADDRESS (mfunsym
)
3180 == BMSYMBOL_VALUE_ADDRESS (msymbol
))
3181 /* Avoid infinite recursion */
3182 /* See above comment about why warning is commented out. */
3183 /* warning ("In stub for %s; unable to find real function/line info",
3184 msymbol->linkage_name ()); */
3189 /* Detect an obvious case of infinite recursion. If this
3190 should occur, we'd like to know about it, so error out,
3192 if (BMSYMBOL_VALUE_ADDRESS (mfunsym
) == pc
)
3193 internal_error (__FILE__
, __LINE__
,
3194 _("Infinite recursion detected in find_pc_sect_line;"
3195 "please file a bug report"));
3197 return find_pc_line (BMSYMBOL_VALUE_ADDRESS (mfunsym
), 0);
3201 symtab_and_line val
;
3202 val
.pspace
= current_program_space
;
3204 cust
= find_pc_sect_compunit_symtab (pc
, section
);
3207 /* If no symbol information, return previous pc. */
3214 bv
= COMPUNIT_BLOCKVECTOR (cust
);
3216 /* Look at all the symtabs that share this blockvector.
3217 They all have the same apriori range, that we found was right;
3218 but they have different line tables. */
3220 for (symtab
*iter_s
: compunit_filetabs (cust
))
3222 /* Find the best line in this symtab. */
3223 l
= SYMTAB_LINETABLE (iter_s
);
3229 /* I think len can be zero if the symtab lacks line numbers
3230 (e.g. gcc -g1). (Either that or the LINETABLE is NULL;
3231 I'm not sure which, and maybe it depends on the symbol
3237 item
= l
->item
; /* Get first line info. */
3239 /* Is this file's first line closer than the first lines of other files?
3240 If so, record this file, and its first line, as best alternate. */
3241 if (item
->pc
> pc
&& (!alt
|| item
->pc
< alt
->pc
))
3244 auto pc_compare
= [](const CORE_ADDR
& comp_pc
,
3245 const struct linetable_entry
& lhs
)->bool
3247 return comp_pc
< lhs
.pc
;
3250 struct linetable_entry
*first
= item
;
3251 struct linetable_entry
*last
= item
+ len
;
3252 item
= std::upper_bound (first
, last
, pc
, pc_compare
);
3255 /* Found a matching item. Skip backwards over any end of
3256 sequence markers. */
3257 for (prev
= item
- 1; prev
->line
== 0 && prev
!= first
; prev
--)
3261 /* At this point, prev points at the line whose start addr is <= pc, and
3262 item points at the next line. If we ran off the end of the linetable
3263 (pc >= start of the last line), then prev == item. If pc < start of
3264 the first line, prev will not be set. */
3266 /* Is this file's best line closer than the best in the other files?
3267 If so, record this file, and its best line, as best so far. Don't
3268 save prev if it represents the end of a function (i.e. line number
3269 0) instead of a real line. */
3271 if (prev
&& prev
->line
&& (!best
|| prev
->pc
> best
->pc
))
3274 best_symtab
= iter_s
;
3276 /* If during the binary search we land on a non-statement entry,
3277 scan backward through entries at the same address to see if
3278 there is an entry marked as is-statement. In theory this
3279 duplication should have been removed from the line table
3280 during construction, this is just a double check. If the line
3281 table has had the duplication removed then this should be
3285 struct linetable_entry
*tmp
= best
;
3286 while (tmp
> first
&& (tmp
- 1)->pc
== tmp
->pc
3287 && (tmp
- 1)->line
!= 0 && !tmp
->is_stmt
)
3293 /* Discard BEST_END if it's before the PC of the current BEST. */
3294 if (best_end
<= best
->pc
)
3298 /* If another line (denoted by ITEM) is in the linetable and its
3299 PC is after BEST's PC, but before the current BEST_END, then
3300 use ITEM's PC as the new best_end. */
3301 if (best
&& item
< last
&& item
->pc
> best
->pc
3302 && (best_end
== 0 || best_end
> item
->pc
))
3303 best_end
= item
->pc
;
3308 /* If we didn't find any line number info, just return zeros.
3309 We used to return alt->line - 1 here, but that could be
3310 anywhere; if we don't have line number info for this PC,
3311 don't make some up. */
3314 else if (best
->line
== 0)
3316 /* If our best fit is in a range of PC's for which no line
3317 number info is available (line number is zero) then we didn't
3318 find any valid line information. */
3323 val
.is_stmt
= best
->is_stmt
;
3324 val
.symtab
= best_symtab
;
3325 val
.line
= best
->line
;
3327 if (best_end
&& (!alt
|| best_end
< alt
->pc
))
3332 val
.end
= BLOCK_END (BLOCKVECTOR_BLOCK (bv
, GLOBAL_BLOCK
));
3334 val
.section
= section
;
3338 /* Backward compatibility (no section). */
3340 struct symtab_and_line
3341 find_pc_line (CORE_ADDR pc
, int notcurrent
)
3343 struct obj_section
*section
;
3345 section
= find_pc_overlay (pc
);
3346 if (pc_in_unmapped_range (pc
, section
))
3347 pc
= overlay_mapped_address (pc
, section
);
3348 return find_pc_sect_line (pc
, section
, notcurrent
);
3354 find_pc_line_symtab (CORE_ADDR pc
)
3356 struct symtab_and_line sal
;
3358 /* This always passes zero for NOTCURRENT to find_pc_line.
3359 There are currently no callers that ever pass non-zero. */
3360 sal
= find_pc_line (pc
, 0);
3364 /* Find line number LINE in any symtab whose name is the same as
3367 If found, return the symtab that contains the linetable in which it was
3368 found, set *INDEX to the index in the linetable of the best entry
3369 found, and set *EXACT_MATCH to true if the value returned is an
3372 If not found, return NULL. */
3375 find_line_symtab (struct symtab
*sym_tab
, int line
,
3376 int *index
, bool *exact_match
)
3378 int exact
= 0; /* Initialized here to avoid a compiler warning. */
3380 /* BEST_INDEX and BEST_LINETABLE identify the smallest linenumber > LINE
3384 struct linetable
*best_linetable
;
3385 struct symtab
*best_symtab
;
3387 /* First try looking it up in the given symtab. */
3388 best_linetable
= SYMTAB_LINETABLE (sym_tab
);
3389 best_symtab
= sym_tab
;
3390 best_index
= find_line_common (best_linetable
, line
, &exact
, 0);
3391 if (best_index
< 0 || !exact
)
3393 /* Didn't find an exact match. So we better keep looking for
3394 another symtab with the same name. In the case of xcoff,
3395 multiple csects for one source file (produced by IBM's FORTRAN
3396 compiler) produce multiple symtabs (this is unavoidable
3397 assuming csects can be at arbitrary places in memory and that
3398 the GLOBAL_BLOCK of a symtab has a begin and end address). */
3400 /* BEST is the smallest linenumber > LINE so far seen,
3401 or 0 if none has been seen so far.
3402 BEST_INDEX and BEST_LINETABLE identify the item for it. */
3405 if (best_index
>= 0)
3406 best
= best_linetable
->item
[best_index
].line
;
3410 for (objfile
*objfile
: current_program_space
->objfiles ())
3413 objfile
->sf
->qf
->expand_symtabs_with_fullname
3414 (objfile
, symtab_to_fullname (sym_tab
));
3417 for (objfile
*objfile
: current_program_space
->objfiles ())
3419 for (compunit_symtab
*cu
: objfile
->compunits ())
3421 for (symtab
*s
: compunit_filetabs (cu
))
3423 struct linetable
*l
;
3426 if (FILENAME_CMP (sym_tab
->filename
, s
->filename
) != 0)
3428 if (FILENAME_CMP (symtab_to_fullname (sym_tab
),
3429 symtab_to_fullname (s
)) != 0)
3431 l
= SYMTAB_LINETABLE (s
);
3432 ind
= find_line_common (l
, line
, &exact
, 0);
3442 if (best
== 0 || l
->item
[ind
].line
< best
)
3444 best
= l
->item
[ind
].line
;
3459 *index
= best_index
;
3461 *exact_match
= (exact
!= 0);
3466 /* Given SYMTAB, returns all the PCs function in the symtab that
3467 exactly match LINE. Returns an empty vector if there are no exact
3468 matches, but updates BEST_ITEM in this case. */
3470 std::vector
<CORE_ADDR
>
3471 find_pcs_for_symtab_line (struct symtab
*symtab
, int line
,
3472 struct linetable_entry
**best_item
)
3475 std::vector
<CORE_ADDR
> result
;
3477 /* First, collect all the PCs that are at this line. */
3483 idx
= find_line_common (SYMTAB_LINETABLE (symtab
), line
, &was_exact
,
3490 struct linetable_entry
*item
= &SYMTAB_LINETABLE (symtab
)->item
[idx
];
3492 if (*best_item
== NULL
3493 || (item
->line
< (*best_item
)->line
&& item
->is_stmt
))
3499 result
.push_back (SYMTAB_LINETABLE (symtab
)->item
[idx
].pc
);
3507 /* Set the PC value for a given source file and line number and return true.
3508 Returns false for invalid line number (and sets the PC to 0).
3509 The source file is specified with a struct symtab. */
3512 find_line_pc (struct symtab
*symtab
, int line
, CORE_ADDR
*pc
)
3514 struct linetable
*l
;
3521 symtab
= find_line_symtab (symtab
, line
, &ind
, NULL
);
3524 l
= SYMTAB_LINETABLE (symtab
);
3525 *pc
= l
->item
[ind
].pc
;
3532 /* Find the range of pc values in a line.
3533 Store the starting pc of the line into *STARTPTR
3534 and the ending pc (start of next line) into *ENDPTR.
3535 Returns true to indicate success.
3536 Returns false if could not find the specified line. */
3539 find_line_pc_range (struct symtab_and_line sal
, CORE_ADDR
*startptr
,
3542 CORE_ADDR startaddr
;
3543 struct symtab_and_line found_sal
;
3546 if (startaddr
== 0 && !find_line_pc (sal
.symtab
, sal
.line
, &startaddr
))
3549 /* This whole function is based on address. For example, if line 10 has
3550 two parts, one from 0x100 to 0x200 and one from 0x300 to 0x400, then
3551 "info line *0x123" should say the line goes from 0x100 to 0x200
3552 and "info line *0x355" should say the line goes from 0x300 to 0x400.
3553 This also insures that we never give a range like "starts at 0x134
3554 and ends at 0x12c". */
3556 found_sal
= find_pc_sect_line (startaddr
, sal
.section
, 0);
3557 if (found_sal
.line
!= sal
.line
)
3559 /* The specified line (sal) has zero bytes. */
3560 *startptr
= found_sal
.pc
;
3561 *endptr
= found_sal
.pc
;
3565 *startptr
= found_sal
.pc
;
3566 *endptr
= found_sal
.end
;
3571 /* Given a line table and a line number, return the index into the line
3572 table for the pc of the nearest line whose number is >= the specified one.
3573 Return -1 if none is found. The value is >= 0 if it is an index.
3574 START is the index at which to start searching the line table.
3576 Set *EXACT_MATCH nonzero if the value returned is an exact match. */
3579 find_line_common (struct linetable
*l
, int lineno
,
3580 int *exact_match
, int start
)
3585 /* BEST is the smallest linenumber > LINENO so far seen,
3586 or 0 if none has been seen so far.
3587 BEST_INDEX identifies the item for it. */
3589 int best_index
= -1;
3600 for (i
= start
; i
< len
; i
++)
3602 struct linetable_entry
*item
= &(l
->item
[i
]);
3604 /* Ignore non-statements. */
3608 if (item
->line
== lineno
)
3610 /* Return the first (lowest address) entry which matches. */
3615 if (item
->line
> lineno
&& (best
== 0 || item
->line
< best
))
3622 /* If we got here, we didn't get an exact match. */
3627 find_pc_line_pc_range (CORE_ADDR pc
, CORE_ADDR
*startptr
, CORE_ADDR
*endptr
)
3629 struct symtab_and_line sal
;
3631 sal
= find_pc_line (pc
, 0);
3634 return sal
.symtab
!= 0;
3637 /* Helper for find_function_start_sal. Does most of the work, except
3638 setting the sal's symbol. */
3640 static symtab_and_line
3641 find_function_start_sal_1 (CORE_ADDR func_addr
, obj_section
*section
,
3644 symtab_and_line sal
= find_pc_sect_line (func_addr
, section
, 0);
3646 if (funfirstline
&& sal
.symtab
!= NULL
3647 && (COMPUNIT_LOCATIONS_VALID (SYMTAB_COMPUNIT (sal
.symtab
))
3648 || SYMTAB_LANGUAGE (sal
.symtab
) == language_asm
))
3650 struct gdbarch
*gdbarch
= get_objfile_arch (SYMTAB_OBJFILE (sal
.symtab
));
3653 if (gdbarch_skip_entrypoint_p (gdbarch
))
3654 sal
.pc
= gdbarch_skip_entrypoint (gdbarch
, sal
.pc
);
3658 /* We always should have a line for the function start address.
3659 If we don't, something is odd. Create a plain SAL referring
3660 just the PC and hope that skip_prologue_sal (if requested)
3661 can find a line number for after the prologue. */
3662 if (sal
.pc
< func_addr
)
3665 sal
.pspace
= current_program_space
;
3667 sal
.section
= section
;
3671 skip_prologue_sal (&sal
);
3679 find_function_start_sal (CORE_ADDR func_addr
, obj_section
*section
,
3683 = find_function_start_sal_1 (func_addr
, section
, funfirstline
);
3685 /* find_function_start_sal_1 does a linetable search, so it finds
3686 the symtab and linenumber, but not a symbol. Fill in the
3687 function symbol too. */
3688 sal
.symbol
= find_pc_sect_containing_function (sal
.pc
, sal
.section
);
3696 find_function_start_sal (symbol
*sym
, bool funfirstline
)
3698 fixup_symbol_section (sym
, NULL
);
3700 = find_function_start_sal_1 (BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
)),
3701 SYMBOL_OBJ_SECTION (symbol_objfile (sym
), sym
),
3708 /* Given a function start address FUNC_ADDR and SYMTAB, find the first
3709 address for that function that has an entry in SYMTAB's line info
3710 table. If such an entry cannot be found, return FUNC_ADDR
3714 skip_prologue_using_lineinfo (CORE_ADDR func_addr
, struct symtab
*symtab
)
3716 CORE_ADDR func_start
, func_end
;
3717 struct linetable
*l
;
3720 /* Give up if this symbol has no lineinfo table. */
3721 l
= SYMTAB_LINETABLE (symtab
);
3725 /* Get the range for the function's PC values, or give up if we
3726 cannot, for some reason. */
3727 if (!find_pc_partial_function (func_addr
, NULL
, &func_start
, &func_end
))
3730 /* Linetable entries are ordered by PC values, see the commentary in
3731 symtab.h where `struct linetable' is defined. Thus, the first
3732 entry whose PC is in the range [FUNC_START..FUNC_END[ is the
3733 address we are looking for. */
3734 for (i
= 0; i
< l
->nitems
; i
++)
3736 struct linetable_entry
*item
= &(l
->item
[i
]);
3738 /* Don't use line numbers of zero, they mark special entries in
3739 the table. See the commentary on symtab.h before the
3740 definition of struct linetable. */
3741 if (item
->line
> 0 && func_start
<= item
->pc
&& item
->pc
< func_end
)
3748 /* Adjust SAL to the first instruction past the function prologue.
3749 If the PC was explicitly specified, the SAL is not changed.
3750 If the line number was explicitly specified then the SAL can still be
3751 updated, unless the language for SAL is assembler, in which case the SAL
3752 will be left unchanged.
3753 If SAL is already past the prologue, then do nothing. */
3756 skip_prologue_sal (struct symtab_and_line
*sal
)
3759 struct symtab_and_line start_sal
;
3760 CORE_ADDR pc
, saved_pc
;
3761 struct obj_section
*section
;
3763 struct objfile
*objfile
;
3764 struct gdbarch
*gdbarch
;
3765 const struct block
*b
, *function_block
;
3766 int force_skip
, skip
;
3768 /* Do not change the SAL if PC was specified explicitly. */
3769 if (sal
->explicit_pc
)
3772 /* In assembly code, if the user asks for a specific line then we should
3773 not adjust the SAL. The user already has instruction level
3774 visibility in this case, so selecting a line other than one requested
3775 is likely to be the wrong choice. */
3776 if (sal
->symtab
!= nullptr
3777 && sal
->explicit_line
3778 && SYMTAB_LANGUAGE (sal
->symtab
) == language_asm
)
3781 scoped_restore_current_pspace_and_thread restore_pspace_thread
;
3783 switch_to_program_space_and_thread (sal
->pspace
);
3785 sym
= find_pc_sect_function (sal
->pc
, sal
->section
);
3788 fixup_symbol_section (sym
, NULL
);
3790 objfile
= symbol_objfile (sym
);
3791 pc
= BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
));
3792 section
= SYMBOL_OBJ_SECTION (objfile
, sym
);
3793 name
= sym
->linkage_name ();
3797 struct bound_minimal_symbol msymbol
3798 = lookup_minimal_symbol_by_pc_section (sal
->pc
, sal
->section
);
3800 if (msymbol
.minsym
== NULL
)
3803 objfile
= msymbol
.objfile
;
3804 pc
= BMSYMBOL_VALUE_ADDRESS (msymbol
);
3805 section
= MSYMBOL_OBJ_SECTION (objfile
, msymbol
.minsym
);
3806 name
= msymbol
.minsym
->linkage_name ();
3809 gdbarch
= get_objfile_arch (objfile
);
3811 /* Process the prologue in two passes. In the first pass try to skip the
3812 prologue (SKIP is true) and verify there is a real need for it (indicated
3813 by FORCE_SKIP). If no such reason was found run a second pass where the
3814 prologue is not skipped (SKIP is false). */
3819 /* Be conservative - allow direct PC (without skipping prologue) only if we
3820 have proven the CU (Compilation Unit) supports it. sal->SYMTAB does not
3821 have to be set by the caller so we use SYM instead. */
3823 && COMPUNIT_LOCATIONS_VALID (SYMTAB_COMPUNIT (symbol_symtab (sym
))))
3831 /* If the function is in an unmapped overlay, use its unmapped LMA address,
3832 so that gdbarch_skip_prologue has something unique to work on. */
3833 if (section_is_overlay (section
) && !section_is_mapped (section
))
3834 pc
= overlay_unmapped_address (pc
, section
);
3836 /* Skip "first line" of function (which is actually its prologue). */
3837 pc
+= gdbarch_deprecated_function_start_offset (gdbarch
);
3838 if (gdbarch_skip_entrypoint_p (gdbarch
))
3839 pc
= gdbarch_skip_entrypoint (gdbarch
, pc
);
3841 pc
= gdbarch_skip_prologue_noexcept (gdbarch
, pc
);
3843 /* For overlays, map pc back into its mapped VMA range. */
3844 pc
= overlay_mapped_address (pc
, section
);
3846 /* Calculate line number. */
3847 start_sal
= find_pc_sect_line (pc
, section
, 0);
3849 /* Check if gdbarch_skip_prologue left us in mid-line, and the next
3850 line is still part of the same function. */
3851 if (skip
&& start_sal
.pc
!= pc
3852 && (sym
? (BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
)) <= start_sal
.end
3853 && start_sal
.end
< BLOCK_END (SYMBOL_BLOCK_VALUE (sym
)))
3854 : (lookup_minimal_symbol_by_pc_section (start_sal
.end
, section
).minsym
3855 == lookup_minimal_symbol_by_pc_section (pc
, section
).minsym
)))
3857 /* First pc of next line */
3859 /* Recalculate the line number (might not be N+1). */
3860 start_sal
= find_pc_sect_line (pc
, section
, 0);
3863 /* On targets with executable formats that don't have a concept of
3864 constructors (ELF with .init has, PE doesn't), gcc emits a call
3865 to `__main' in `main' between the prologue and before user
3867 if (gdbarch_skip_main_prologue_p (gdbarch
)
3868 && name
&& strcmp_iw (name
, "main") == 0)
3870 pc
= gdbarch_skip_main_prologue (gdbarch
, pc
);
3871 /* Recalculate the line number (might not be N+1). */
3872 start_sal
= find_pc_sect_line (pc
, section
, 0);
3876 while (!force_skip
&& skip
--);
3878 /* If we still don't have a valid source line, try to find the first
3879 PC in the lineinfo table that belongs to the same function. This
3880 happens with COFF debug info, which does not seem to have an
3881 entry in lineinfo table for the code after the prologue which has
3882 no direct relation to source. For example, this was found to be
3883 the case with the DJGPP target using "gcc -gcoff" when the
3884 compiler inserted code after the prologue to make sure the stack
3886 if (!force_skip
&& sym
&& start_sal
.symtab
== NULL
)
3888 pc
= skip_prologue_using_lineinfo (pc
, symbol_symtab (sym
));
3889 /* Recalculate the line number. */
3890 start_sal
= find_pc_sect_line (pc
, section
, 0);
3893 /* If we're already past the prologue, leave SAL unchanged. Otherwise
3894 forward SAL to the end of the prologue. */
3899 sal
->section
= section
;
3900 sal
->symtab
= start_sal
.symtab
;
3901 sal
->line
= start_sal
.line
;
3902 sal
->end
= start_sal
.end
;
3904 /* Check if we are now inside an inlined function. If we can,
3905 use the call site of the function instead. */
3906 b
= block_for_pc_sect (sal
->pc
, sal
->section
);
3907 function_block
= NULL
;
3910 if (BLOCK_FUNCTION (b
) != NULL
&& block_inlined_p (b
))
3912 else if (BLOCK_FUNCTION (b
) != NULL
)
3914 b
= BLOCK_SUPERBLOCK (b
);
3916 if (function_block
!= NULL
3917 && SYMBOL_LINE (BLOCK_FUNCTION (function_block
)) != 0)
3919 sal
->line
= SYMBOL_LINE (BLOCK_FUNCTION (function_block
));
3920 sal
->symtab
= symbol_symtab (BLOCK_FUNCTION (function_block
));
3924 /* Given PC at the function's start address, attempt to find the
3925 prologue end using SAL information. Return zero if the skip fails.
3927 A non-optimized prologue traditionally has one SAL for the function
3928 and a second for the function body. A single line function has
3929 them both pointing at the same line.
3931 An optimized prologue is similar but the prologue may contain
3932 instructions (SALs) from the instruction body. Need to skip those
3933 while not getting into the function body.
3935 The functions end point and an increasing SAL line are used as
3936 indicators of the prologue's endpoint.
3938 This code is based on the function refine_prologue_limit
3942 skip_prologue_using_sal (struct gdbarch
*gdbarch
, CORE_ADDR func_addr
)
3944 struct symtab_and_line prologue_sal
;
3947 const struct block
*bl
;
3949 /* Get an initial range for the function. */
3950 find_pc_partial_function (func_addr
, NULL
, &start_pc
, &end_pc
);
3951 start_pc
+= gdbarch_deprecated_function_start_offset (gdbarch
);
3953 prologue_sal
= find_pc_line (start_pc
, 0);
3954 if (prologue_sal
.line
!= 0)
3956 /* For languages other than assembly, treat two consecutive line
3957 entries at the same address as a zero-instruction prologue.
3958 The GNU assembler emits separate line notes for each instruction
3959 in a multi-instruction macro, but compilers generally will not
3961 if (prologue_sal
.symtab
->language
!= language_asm
)
3963 struct linetable
*linetable
= SYMTAB_LINETABLE (prologue_sal
.symtab
);
3966 /* Skip any earlier lines, and any end-of-sequence marker
3967 from a previous function. */
3968 while (linetable
->item
[idx
].pc
!= prologue_sal
.pc
3969 || linetable
->item
[idx
].line
== 0)
3972 if (idx
+1 < linetable
->nitems
3973 && linetable
->item
[idx
+1].line
!= 0
3974 && linetable
->item
[idx
+1].pc
== start_pc
)
3978 /* If there is only one sal that covers the entire function,
3979 then it is probably a single line function, like
3981 if (prologue_sal
.end
>= end_pc
)
3984 while (prologue_sal
.end
< end_pc
)
3986 struct symtab_and_line sal
;
3988 sal
= find_pc_line (prologue_sal
.end
, 0);
3991 /* Assume that a consecutive SAL for the same (or larger)
3992 line mark the prologue -> body transition. */
3993 if (sal
.line
>= prologue_sal
.line
)
3995 /* Likewise if we are in a different symtab altogether
3996 (e.g. within a file included via #include). */
3997 if (sal
.symtab
!= prologue_sal
.symtab
)
4000 /* The line number is smaller. Check that it's from the
4001 same function, not something inlined. If it's inlined,
4002 then there is no point comparing the line numbers. */
4003 bl
= block_for_pc (prologue_sal
.end
);
4006 if (block_inlined_p (bl
))
4008 if (BLOCK_FUNCTION (bl
))
4013 bl
= BLOCK_SUPERBLOCK (bl
);
4018 /* The case in which compiler's optimizer/scheduler has
4019 moved instructions into the prologue. We look ahead in
4020 the function looking for address ranges whose
4021 corresponding line number is less the first one that we
4022 found for the function. This is more conservative then
4023 refine_prologue_limit which scans a large number of SALs
4024 looking for any in the prologue. */
4029 if (prologue_sal
.end
< end_pc
)
4030 /* Return the end of this line, or zero if we could not find a
4032 return prologue_sal
.end
;
4034 /* Don't return END_PC, which is past the end of the function. */
4035 return prologue_sal
.pc
;
4041 find_function_alias_target (bound_minimal_symbol msymbol
)
4043 CORE_ADDR func_addr
;
4044 if (!msymbol_is_function (msymbol
.objfile
, msymbol
.minsym
, &func_addr
))
4047 symbol
*sym
= find_pc_function (func_addr
);
4049 && SYMBOL_CLASS (sym
) == LOC_BLOCK
4050 && BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
)) == func_addr
)
4057 /* If P is of the form "operator[ \t]+..." where `...' is
4058 some legitimate operator text, return a pointer to the
4059 beginning of the substring of the operator text.
4060 Otherwise, return "". */
4063 operator_chars (const char *p
, const char **end
)
4066 if (!startswith (p
, CP_OPERATOR_STR
))
4068 p
+= CP_OPERATOR_LEN
;
4070 /* Don't get faked out by `operator' being part of a longer
4072 if (isalpha (*p
) || *p
== '_' || *p
== '$' || *p
== '\0')
4075 /* Allow some whitespace between `operator' and the operator symbol. */
4076 while (*p
== ' ' || *p
== '\t')
4079 /* Recognize 'operator TYPENAME'. */
4081 if (isalpha (*p
) || *p
== '_' || *p
== '$')
4083 const char *q
= p
+ 1;
4085 while (isalnum (*q
) || *q
== '_' || *q
== '$')
4094 case '\\': /* regexp quoting */
4097 if (p
[2] == '=') /* 'operator\*=' */
4099 else /* 'operator\*' */
4103 else if (p
[1] == '[')
4106 error (_("mismatched quoting on brackets, "
4107 "try 'operator\\[\\]'"));
4108 else if (p
[2] == '\\' && p
[3] == ']')
4110 *end
= p
+ 4; /* 'operator\[\]' */
4114 error (_("nothing is allowed between '[' and ']'"));
4118 /* Gratuitous quote: skip it and move on. */
4140 if (p
[0] == '-' && p
[1] == '>')
4142 /* Struct pointer member operator 'operator->'. */
4145 *end
= p
+ 3; /* 'operator->*' */
4148 else if (p
[2] == '\\')
4150 *end
= p
+ 4; /* Hopefully 'operator->\*' */
4155 *end
= p
+ 2; /* 'operator->' */
4159 if (p
[1] == '=' || p
[1] == p
[0])
4170 error (_("`operator ()' must be specified "
4171 "without whitespace in `()'"));
4176 error (_("`operator ?:' must be specified "
4177 "without whitespace in `?:'"));
4182 error (_("`operator []' must be specified "
4183 "without whitespace in `[]'"));
4187 error (_("`operator %s' not supported"), p
);
4196 /* What part to match in a file name. */
4198 struct filename_partial_match_opts
4200 /* Only match the directory name part. */
4201 bool dirname
= false;
4203 /* Only match the basename part. */
4204 bool basename
= false;
4207 /* Data structure to maintain printing state for output_source_filename. */
4209 struct output_source_filename_data
4211 /* Output only filenames matching REGEXP. */
4213 gdb::optional
<compiled_regex
> c_regexp
;
4214 /* Possibly only match a part of the filename. */
4215 filename_partial_match_opts partial_match
;
4218 /* Cache of what we've seen so far. */
4219 struct filename_seen_cache
*filename_seen_cache
;
4221 /* Flag of whether we're printing the first one. */
4225 /* Slave routine for sources_info. Force line breaks at ,'s.
4226 NAME is the name to print.
4227 DATA contains the state for printing and watching for duplicates. */
4230 output_source_filename (const char *name
,
4231 struct output_source_filename_data
*data
)
4233 /* Since a single source file can result in several partial symbol
4234 tables, we need to avoid printing it more than once. Note: if
4235 some of the psymtabs are read in and some are not, it gets
4236 printed both under "Source files for which symbols have been
4237 read" and "Source files for which symbols will be read in on
4238 demand". I consider this a reasonable way to deal with the
4239 situation. I'm not sure whether this can also happen for
4240 symtabs; it doesn't hurt to check. */
4242 /* Was NAME already seen? */
4243 if (data
->filename_seen_cache
->seen (name
))
4245 /* Yes; don't print it again. */
4249 /* Does it match data->regexp? */
4250 if (data
->c_regexp
.has_value ())
4252 const char *to_match
;
4253 std::string dirname
;
4255 if (data
->partial_match
.dirname
)
4257 dirname
= ldirname (name
);
4258 to_match
= dirname
.c_str ();
4260 else if (data
->partial_match
.basename
)
4261 to_match
= lbasename (name
);
4265 if (data
->c_regexp
->exec (to_match
, 0, NULL
, 0) != 0)
4269 /* Print it and reset *FIRST. */
4271 printf_filtered (", ");
4275 fputs_styled (name
, file_name_style
.style (), gdb_stdout
);
4278 /* A callback for map_partial_symbol_filenames. */
4281 output_partial_symbol_filename (const char *filename
, const char *fullname
,
4284 output_source_filename (fullname
? fullname
: filename
,
4285 (struct output_source_filename_data
*) data
);
4288 using isrc_flag_option_def
4289 = gdb::option::flag_option_def
<filename_partial_match_opts
>;
4291 static const gdb::option::option_def info_sources_option_defs
[] = {
4293 isrc_flag_option_def
{
4295 [] (filename_partial_match_opts
*opts
) { return &opts
->dirname
; },
4296 N_("Show only the files having a dirname matching REGEXP."),
4299 isrc_flag_option_def
{
4301 [] (filename_partial_match_opts
*opts
) { return &opts
->basename
; },
4302 N_("Show only the files having a basename matching REGEXP."),
4307 /* Create an option_def_group for the "info sources" options, with
4308 ISRC_OPTS as context. */
4310 static inline gdb::option::option_def_group
4311 make_info_sources_options_def_group (filename_partial_match_opts
*isrc_opts
)
4313 return {{info_sources_option_defs
}, isrc_opts
};
4316 /* Prints the header message for the source files that will be printed
4317 with the matching info present in DATA. SYMBOL_MSG is a message
4318 that tells what will or has been done with the symbols of the
4319 matching source files. */
4322 print_info_sources_header (const char *symbol_msg
,
4323 const struct output_source_filename_data
*data
)
4325 puts_filtered (symbol_msg
);
4326 if (!data
->regexp
.empty ())
4328 if (data
->partial_match
.dirname
)
4329 printf_filtered (_("(dirname matching regular expression \"%s\")"),
4330 data
->regexp
.c_str ());
4331 else if (data
->partial_match
.basename
)
4332 printf_filtered (_("(basename matching regular expression \"%s\")"),
4333 data
->regexp
.c_str ());
4335 printf_filtered (_("(filename matching regular expression \"%s\")"),
4336 data
->regexp
.c_str ());
4338 puts_filtered ("\n");
4341 /* Completer for "info sources". */
4344 info_sources_command_completer (cmd_list_element
*ignore
,
4345 completion_tracker
&tracker
,
4346 const char *text
, const char *word
)
4348 const auto group
= make_info_sources_options_def_group (nullptr);
4349 if (gdb::option::complete_options
4350 (tracker
, &text
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, group
))
4355 info_sources_command (const char *args
, int from_tty
)
4357 struct output_source_filename_data data
;
4359 if (!have_full_symbols () && !have_partial_symbols ())
4361 error (_("No symbol table is loaded. Use the \"file\" command."));
4364 filename_seen_cache filenames_seen
;
4366 auto group
= make_info_sources_options_def_group (&data
.partial_match
);
4368 gdb::option::process_options
4369 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_ERROR
, group
);
4371 if (args
!= NULL
&& *args
!= '\000')
4374 data
.filename_seen_cache
= &filenames_seen
;
4377 if (data
.partial_match
.dirname
&& data
.partial_match
.basename
)
4378 error (_("You cannot give both -basename and -dirname to 'info sources'."));
4379 if ((data
.partial_match
.dirname
|| data
.partial_match
.basename
)
4380 && data
.regexp
.empty ())
4381 error (_("Missing REGEXP for 'info sources'."));
4383 if (data
.regexp
.empty ())
4384 data
.c_regexp
.reset ();
4387 int cflags
= REG_NOSUB
;
4388 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
4389 cflags
|= REG_ICASE
;
4391 data
.c_regexp
.emplace (data
.regexp
.c_str (), cflags
,
4392 _("Invalid regexp"));
4395 print_info_sources_header
4396 (_("Source files for which symbols have been read in:\n"), &data
);
4398 for (objfile
*objfile
: current_program_space
->objfiles ())
4400 for (compunit_symtab
*cu
: objfile
->compunits ())
4402 for (symtab
*s
: compunit_filetabs (cu
))
4404 const char *fullname
= symtab_to_fullname (s
);
4406 output_source_filename (fullname
, &data
);
4410 printf_filtered ("\n\n");
4412 print_info_sources_header
4413 (_("Source files for which symbols will be read in on demand:\n"), &data
);
4415 filenames_seen
.clear ();
4417 map_symbol_filenames (output_partial_symbol_filename
, &data
,
4418 1 /*need_fullname*/);
4419 printf_filtered ("\n");
4422 /* Compare FILE against all the entries of FILENAMES. If BASENAMES is
4423 true compare only lbasename of FILENAMES. */
4426 file_matches (const char *file
, const std::vector
<const char *> &filenames
,
4429 if (filenames
.empty ())
4432 for (const char *name
: filenames
)
4434 name
= (basenames
? lbasename (name
) : name
);
4435 if (compare_filenames_for_search (file
, name
))
4442 /* Helper function for std::sort on symbol_search objects. Can only sort
4443 symbols, not minimal symbols. */
4446 symbol_search::compare_search_syms (const symbol_search
&sym_a
,
4447 const symbol_search
&sym_b
)
4451 c
= FILENAME_CMP (symbol_symtab (sym_a
.symbol
)->filename
,
4452 symbol_symtab (sym_b
.symbol
)->filename
);
4456 if (sym_a
.block
!= sym_b
.block
)
4457 return sym_a
.block
- sym_b
.block
;
4459 return strcmp (sym_a
.symbol
->print_name (), sym_b
.symbol
->print_name ());
4462 /* Returns true if the type_name of symbol_type of SYM matches TREG.
4463 If SYM has no symbol_type or symbol_name, returns false. */
4466 treg_matches_sym_type_name (const compiled_regex
&treg
,
4467 const struct symbol
*sym
)
4469 struct type
*sym_type
;
4470 std::string printed_sym_type_name
;
4472 if (symbol_lookup_debug
> 1)
4474 fprintf_unfiltered (gdb_stdlog
,
4475 "treg_matches_sym_type_name\n sym %s\n",
4476 sym
->natural_name ());
4479 sym_type
= SYMBOL_TYPE (sym
);
4480 if (sym_type
== NULL
)
4484 scoped_switch_to_sym_language_if_auto
l (sym
);
4486 printed_sym_type_name
= type_to_string (sym_type
);
4490 if (symbol_lookup_debug
> 1)
4492 fprintf_unfiltered (gdb_stdlog
,
4493 " sym_type_name %s\n",
4494 printed_sym_type_name
.c_str ());
4498 if (printed_sym_type_name
.empty ())
4501 return treg
.exec (printed_sym_type_name
.c_str (), 0, NULL
, 0) == 0;
4507 global_symbol_searcher::is_suitable_msymbol
4508 (const enum search_domain kind
, const minimal_symbol
*msymbol
)
4510 switch (MSYMBOL_TYPE (msymbol
))
4516 return kind
== VARIABLES_DOMAIN
;
4519 case mst_solib_trampoline
:
4520 case mst_text_gnu_ifunc
:
4521 return kind
== FUNCTIONS_DOMAIN
;
4530 global_symbol_searcher::expand_symtabs
4531 (objfile
*objfile
, const gdb::optional
<compiled_regex
> &preg
) const
4533 enum search_domain kind
= m_kind
;
4534 bool found_msymbol
= false;
4537 objfile
->sf
->qf
->expand_symtabs_matching
4539 [&] (const char *filename
, bool basenames
)
4541 return file_matches (filename
, filenames
, basenames
);
4543 &lookup_name_info::match_any (),
4544 [&] (const char *symname
)
4546 return (!preg
.has_value ()
4547 || preg
->exec (symname
, 0, NULL
, 0) == 0);
4552 /* Here, we search through the minimal symbol tables for functions and
4553 variables that match, and force their symbols to be read. This is in
4554 particular necessary for demangled variable names, which are no longer
4555 put into the partial symbol tables. The symbol will then be found
4556 during the scan of symtabs later.
4558 For functions, find_pc_symtab should succeed if we have debug info for
4559 the function, for variables we have to call
4560 lookup_symbol_in_objfile_from_linkage_name to determine if the
4561 variable has debug info. If the lookup fails, set found_msymbol so
4562 that we will rescan to print any matching symbols without debug info.
4563 We only search the objfile the msymbol came from, we no longer search
4564 all objfiles. In large programs (1000s of shared libs) searching all
4565 objfiles is not worth the pain. */
4566 if (filenames
.empty ()
4567 && (kind
== VARIABLES_DOMAIN
|| kind
== FUNCTIONS_DOMAIN
))
4569 for (minimal_symbol
*msymbol
: objfile
->msymbols ())
4573 if (msymbol
->created_by_gdb
)
4576 if (is_suitable_msymbol (kind
, msymbol
))
4578 if (!preg
.has_value ()
4579 || preg
->exec (msymbol
->natural_name (), 0,
4582 /* An important side-effect of these lookup functions is
4583 to expand the symbol table if msymbol is found, later
4584 in the process we will add matching symbols or
4585 msymbols to the results list, and that requires that
4586 the symbols tables are expanded. */
4587 if (kind
== FUNCTIONS_DOMAIN
4588 ? (find_pc_compunit_symtab
4589 (MSYMBOL_VALUE_ADDRESS (objfile
, msymbol
))
4591 : (lookup_symbol_in_objfile_from_linkage_name
4592 (objfile
, msymbol
->linkage_name (),
4595 found_msymbol
= true;
4601 return found_msymbol
;
4607 global_symbol_searcher::add_matching_symbols
4609 const gdb::optional
<compiled_regex
> &preg
,
4610 const gdb::optional
<compiled_regex
> &treg
,
4611 std::set
<symbol_search
> *result_set
) const
4613 enum search_domain kind
= m_kind
;
4615 /* Add matching symbols (if not already present). */
4616 for (compunit_symtab
*cust
: objfile
->compunits ())
4618 const struct blockvector
*bv
= COMPUNIT_BLOCKVECTOR (cust
);
4620 for (block_enum block
: { GLOBAL_BLOCK
, STATIC_BLOCK
})
4622 struct block_iterator iter
;
4624 const struct block
*b
= BLOCKVECTOR_BLOCK (bv
, block
);
4626 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
4628 struct symtab
*real_symtab
= symbol_symtab (sym
);
4632 /* Check first sole REAL_SYMTAB->FILENAME. It does
4633 not need to be a substring of symtab_to_fullname as
4634 it may contain "./" etc. */
4635 if ((file_matches (real_symtab
->filename
, filenames
, false)
4636 || ((basenames_may_differ
4637 || file_matches (lbasename (real_symtab
->filename
),
4639 && file_matches (symtab_to_fullname (real_symtab
),
4641 && ((!preg
.has_value ()
4642 || preg
->exec (sym
->natural_name (), 0,
4644 && ((kind
== VARIABLES_DOMAIN
4645 && SYMBOL_CLASS (sym
) != LOC_TYPEDEF
4646 && SYMBOL_CLASS (sym
) != LOC_UNRESOLVED
4647 && SYMBOL_CLASS (sym
) != LOC_BLOCK
4648 /* LOC_CONST can be used for more than
4649 just enums, e.g., c++ static const
4650 members. We only want to skip enums
4652 && !(SYMBOL_CLASS (sym
) == LOC_CONST
4653 && (TYPE_CODE (SYMBOL_TYPE (sym
))
4655 && (!treg
.has_value ()
4656 || treg_matches_sym_type_name (*treg
, sym
)))
4657 || (kind
== FUNCTIONS_DOMAIN
4658 && SYMBOL_CLASS (sym
) == LOC_BLOCK
4659 && (!treg
.has_value ()
4660 || treg_matches_sym_type_name (*treg
,
4662 || (kind
== TYPES_DOMAIN
4663 && SYMBOL_CLASS (sym
) == LOC_TYPEDEF
4664 && SYMBOL_DOMAIN (sym
) != MODULE_DOMAIN
)
4665 || (kind
== MODULES_DOMAIN
4666 && SYMBOL_DOMAIN (sym
) == MODULE_DOMAIN
4667 && SYMBOL_LINE (sym
) != 0))))
4669 if (result_set
->size () < m_max_search_results
)
4671 /* Match, insert if not already in the results. */
4672 symbol_search
ss (block
, sym
);
4673 if (result_set
->find (ss
) == result_set
->end ())
4674 result_set
->insert (ss
);
4689 global_symbol_searcher::add_matching_msymbols
4690 (objfile
*objfile
, const gdb::optional
<compiled_regex
> &preg
,
4691 std::vector
<symbol_search
> *results
) const
4693 enum search_domain kind
= m_kind
;
4695 for (minimal_symbol
*msymbol
: objfile
->msymbols ())
4699 if (msymbol
->created_by_gdb
)
4702 if (is_suitable_msymbol (kind
, msymbol
))
4704 if (!preg
.has_value ()
4705 || preg
->exec (msymbol
->natural_name (), 0,
4708 /* For functions we can do a quick check of whether the
4709 symbol might be found via find_pc_symtab. */
4710 if (kind
!= FUNCTIONS_DOMAIN
4711 || (find_pc_compunit_symtab
4712 (MSYMBOL_VALUE_ADDRESS (objfile
, msymbol
))
4715 if (lookup_symbol_in_objfile_from_linkage_name
4716 (objfile
, msymbol
->linkage_name (),
4717 VAR_DOMAIN
).symbol
== NULL
)
4719 /* Matching msymbol, add it to the results list. */
4720 if (results
->size () < m_max_search_results
)
4721 results
->emplace_back (GLOBAL_BLOCK
, msymbol
, objfile
);
4735 std::vector
<symbol_search
>
4736 global_symbol_searcher::search () const
4738 gdb::optional
<compiled_regex
> preg
;
4739 gdb::optional
<compiled_regex
> treg
;
4741 gdb_assert (m_kind
!= ALL_DOMAIN
);
4743 if (m_symbol_name_regexp
!= NULL
)
4745 const char *symbol_name_regexp
= m_symbol_name_regexp
;
4747 /* Make sure spacing is right for C++ operators.
4748 This is just a courtesy to make the matching less sensitive
4749 to how many spaces the user leaves between 'operator'
4750 and <TYPENAME> or <OPERATOR>. */
4752 const char *opname
= operator_chars (symbol_name_regexp
, &opend
);
4756 int fix
= -1; /* -1 means ok; otherwise number of
4759 if (isalpha (*opname
) || *opname
== '_' || *opname
== '$')
4761 /* There should 1 space between 'operator' and 'TYPENAME'. */
4762 if (opname
[-1] != ' ' || opname
[-2] == ' ')
4767 /* There should 0 spaces between 'operator' and 'OPERATOR'. */
4768 if (opname
[-1] == ' ')
4771 /* If wrong number of spaces, fix it. */
4774 char *tmp
= (char *) alloca (8 + fix
+ strlen (opname
) + 1);
4776 sprintf (tmp
, "operator%.*s%s", fix
, " ", opname
);
4777 symbol_name_regexp
= tmp
;
4781 int cflags
= REG_NOSUB
| (case_sensitivity
== case_sensitive_off
4783 preg
.emplace (symbol_name_regexp
, cflags
,
4784 _("Invalid regexp"));
4787 if (m_symbol_type_regexp
!= NULL
)
4789 int cflags
= REG_NOSUB
| (case_sensitivity
== case_sensitive_off
4791 treg
.emplace (m_symbol_type_regexp
, cflags
,
4792 _("Invalid regexp"));
4795 bool found_msymbol
= false;
4796 std::set
<symbol_search
> result_set
;
4797 for (objfile
*objfile
: current_program_space
->objfiles ())
4799 /* Expand symtabs within objfile that possibly contain matching
4801 found_msymbol
|= expand_symtabs (objfile
, preg
);
4803 /* Find matching symbols within OBJFILE and add them in to the
4804 RESULT_SET set. Use a set here so that we can easily detect
4805 duplicates as we go, and can therefore track how many unique
4806 matches we have found so far. */
4807 if (!add_matching_symbols (objfile
, preg
, treg
, &result_set
))
4811 /* Convert the result set into a sorted result list, as std::set is
4812 defined to be sorted then no explicit call to std::sort is needed. */
4813 std::vector
<symbol_search
> result (result_set
.begin (), result_set
.end ());
4815 /* If there are no debug symbols, then add matching minsyms. But if the
4816 user wants to see symbols matching a type regexp, then never give a
4817 minimal symbol, as we assume that a minimal symbol does not have a
4819 if ((found_msymbol
|| (filenames
.empty () && m_kind
== VARIABLES_DOMAIN
))
4820 && !m_exclude_minsyms
4821 && !treg
.has_value ())
4823 gdb_assert (m_kind
== VARIABLES_DOMAIN
|| m_kind
== FUNCTIONS_DOMAIN
);
4824 for (objfile
*objfile
: current_program_space
->objfiles ())
4825 if (!add_matching_msymbols (objfile
, preg
, &result
))
4835 symbol_to_info_string (struct symbol
*sym
, int block
,
4836 enum search_domain kind
)
4840 gdb_assert (block
== GLOBAL_BLOCK
|| block
== STATIC_BLOCK
);
4842 if (kind
!= TYPES_DOMAIN
&& block
== STATIC_BLOCK
)
4845 /* Typedef that is not a C++ class. */
4846 if (kind
== TYPES_DOMAIN
4847 && SYMBOL_DOMAIN (sym
) != STRUCT_DOMAIN
)
4849 string_file tmp_stream
;
4851 /* FIXME: For C (and C++) we end up with a difference in output here
4852 between how a typedef is printed, and non-typedefs are printed.
4853 The TYPEDEF_PRINT code places a ";" at the end in an attempt to
4854 appear C-like, while TYPE_PRINT doesn't.
4856 For the struct printing case below, things are worse, we force
4857 printing of the ";" in this function, which is going to be wrong
4858 for languages that don't require a ";" between statements. */
4859 if (TYPE_CODE (SYMBOL_TYPE (sym
)) == TYPE_CODE_TYPEDEF
)
4860 typedef_print (SYMBOL_TYPE (sym
), sym
, &tmp_stream
);
4862 type_print (SYMBOL_TYPE (sym
), "", &tmp_stream
, -1);
4863 str
+= tmp_stream
.string ();
4865 /* variable, func, or typedef-that-is-c++-class. */
4866 else if (kind
< TYPES_DOMAIN
4867 || (kind
== TYPES_DOMAIN
4868 && SYMBOL_DOMAIN (sym
) == STRUCT_DOMAIN
))
4870 string_file tmp_stream
;
4872 type_print (SYMBOL_TYPE (sym
),
4873 (SYMBOL_CLASS (sym
) == LOC_TYPEDEF
4874 ? "" : sym
->print_name ()),
4877 str
+= tmp_stream
.string ();
4880 /* Printing of modules is currently done here, maybe at some future
4881 point we might want a language specific method to print the module
4882 symbol so that we can customise the output more. */
4883 else if (kind
== MODULES_DOMAIN
)
4884 str
+= sym
->print_name ();
4889 /* Helper function for symbol info commands, for example 'info functions',
4890 'info variables', etc. KIND is the kind of symbol we searched for, and
4891 BLOCK is the type of block the symbols was found in, either GLOBAL_BLOCK
4892 or STATIC_BLOCK. SYM is the symbol we found. If LAST is not NULL,
4893 print file and line number information for the symbol as well. Skip
4894 printing the filename if it matches LAST. */
4897 print_symbol_info (enum search_domain kind
,
4899 int block
, const char *last
)
4901 scoped_switch_to_sym_language_if_auto
l (sym
);
4902 struct symtab
*s
= symbol_symtab (sym
);
4906 const char *s_filename
= symtab_to_filename_for_display (s
);
4908 if (filename_cmp (last
, s_filename
) != 0)
4910 printf_filtered (_("\nFile %ps:\n"),
4911 styled_string (file_name_style
.style (),
4915 if (SYMBOL_LINE (sym
) != 0)
4916 printf_filtered ("%d:\t", SYMBOL_LINE (sym
));
4918 puts_filtered ("\t");
4921 std::string str
= symbol_to_info_string (sym
, block
, kind
);
4922 printf_filtered ("%s\n", str
.c_str ());
4925 /* This help function for symtab_symbol_info() prints information
4926 for non-debugging symbols to gdb_stdout. */
4929 print_msymbol_info (struct bound_minimal_symbol msymbol
)
4931 struct gdbarch
*gdbarch
= get_objfile_arch (msymbol
.objfile
);
4934 if (gdbarch_addr_bit (gdbarch
) <= 32)
4935 tmp
= hex_string_custom (BMSYMBOL_VALUE_ADDRESS (msymbol
)
4936 & (CORE_ADDR
) 0xffffffff,
4939 tmp
= hex_string_custom (BMSYMBOL_VALUE_ADDRESS (msymbol
),
4942 ui_file_style sym_style
= (msymbol
.minsym
->text_p ()
4943 ? function_name_style
.style ()
4944 : ui_file_style ());
4946 printf_filtered (_("%ps %ps\n"),
4947 styled_string (address_style
.style (), tmp
),
4948 styled_string (sym_style
, msymbol
.minsym
->print_name ()));
4951 /* This is the guts of the commands "info functions", "info types", and
4952 "info variables". It calls search_symbols to find all matches and then
4953 print_[m]symbol_info to print out some useful information about the
4957 symtab_symbol_info (bool quiet
, bool exclude_minsyms
,
4958 const char *regexp
, enum search_domain kind
,
4959 const char *t_regexp
, int from_tty
)
4961 static const char * const classnames
[] =
4962 {"variable", "function", "type", "module"};
4963 const char *last_filename
= "";
4966 gdb_assert (kind
!= ALL_DOMAIN
);
4968 if (regexp
!= nullptr && *regexp
== '\0')
4971 global_symbol_searcher
spec (kind
, regexp
);
4972 spec
.set_symbol_type_regexp (t_regexp
);
4973 spec
.set_exclude_minsyms (exclude_minsyms
);
4974 std::vector
<symbol_search
> symbols
= spec
.search ();
4980 if (t_regexp
!= NULL
)
4982 (_("All %ss matching regular expression \"%s\""
4983 " with type matching regular expression \"%s\":\n"),
4984 classnames
[kind
], regexp
, t_regexp
);
4986 printf_filtered (_("All %ss matching regular expression \"%s\":\n"),
4987 classnames
[kind
], regexp
);
4991 if (t_regexp
!= NULL
)
4993 (_("All defined %ss"
4994 " with type matching regular expression \"%s\" :\n"),
4995 classnames
[kind
], t_regexp
);
4997 printf_filtered (_("All defined %ss:\n"), classnames
[kind
]);
5001 for (const symbol_search
&p
: symbols
)
5005 if (p
.msymbol
.minsym
!= NULL
)
5010 printf_filtered (_("\nNon-debugging symbols:\n"));
5013 print_msymbol_info (p
.msymbol
);
5017 print_symbol_info (kind
,
5022 = symtab_to_filename_for_display (symbol_symtab (p
.symbol
));
5027 /* Structure to hold the values of the options used by the 'info variables'
5028 and 'info functions' commands. These correspond to the -q, -t, and -n
5031 struct info_vars_funcs_options
5034 bool exclude_minsyms
= false;
5035 char *type_regexp
= nullptr;
5037 ~info_vars_funcs_options ()
5039 xfree (type_regexp
);
5043 /* The options used by the 'info variables' and 'info functions'
5046 static const gdb::option::option_def info_vars_funcs_options_defs
[] = {
5047 gdb::option::boolean_option_def
<info_vars_funcs_options
> {
5049 [] (info_vars_funcs_options
*opt
) { return &opt
->quiet
; },
5050 nullptr, /* show_cmd_cb */
5051 nullptr /* set_doc */
5054 gdb::option::boolean_option_def
<info_vars_funcs_options
> {
5056 [] (info_vars_funcs_options
*opt
) { return &opt
->exclude_minsyms
; },
5057 nullptr, /* show_cmd_cb */
5058 nullptr /* set_doc */
5061 gdb::option::string_option_def
<info_vars_funcs_options
> {
5063 [] (info_vars_funcs_options
*opt
) { return &opt
->type_regexp
;
5065 nullptr, /* show_cmd_cb */
5066 nullptr /* set_doc */
5070 /* Returns the option group used by 'info variables' and 'info
5073 static gdb::option::option_def_group
5074 make_info_vars_funcs_options_def_group (info_vars_funcs_options
*opts
)
5076 return {{info_vars_funcs_options_defs
}, opts
};
5079 /* Command completer for 'info variables' and 'info functions'. */
5082 info_vars_funcs_command_completer (struct cmd_list_element
*ignore
,
5083 completion_tracker
&tracker
,
5084 const char *text
, const char * /* word */)
5087 = make_info_vars_funcs_options_def_group (nullptr);
5088 if (gdb::option::complete_options
5089 (tracker
, &text
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, group
))
5092 const char *word
= advance_to_expression_complete_word_point (tracker
, text
);
5093 symbol_completer (ignore
, tracker
, text
, word
);
5096 /* Implement the 'info variables' command. */
5099 info_variables_command (const char *args
, int from_tty
)
5101 info_vars_funcs_options opts
;
5102 auto grp
= make_info_vars_funcs_options_def_group (&opts
);
5103 gdb::option::process_options
5104 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
5105 if (args
!= nullptr && *args
== '\0')
5108 symtab_symbol_info (opts
.quiet
, opts
.exclude_minsyms
, args
, VARIABLES_DOMAIN
,
5109 opts
.type_regexp
, from_tty
);
5112 /* Implement the 'info functions' command. */
5115 info_functions_command (const char *args
, int from_tty
)
5117 info_vars_funcs_options opts
;
5119 auto grp
= make_info_vars_funcs_options_def_group (&opts
);
5120 gdb::option::process_options
5121 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
5122 if (args
!= nullptr && *args
== '\0')
5125 symtab_symbol_info (opts
.quiet
, opts
.exclude_minsyms
, args
,
5126 FUNCTIONS_DOMAIN
, opts
.type_regexp
, from_tty
);
5129 /* Holds the -q option for the 'info types' command. */
5131 struct info_types_options
5136 /* The options used by the 'info types' command. */
5138 static const gdb::option::option_def info_types_options_defs
[] = {
5139 gdb::option::boolean_option_def
<info_types_options
> {
5141 [] (info_types_options
*opt
) { return &opt
->quiet
; },
5142 nullptr, /* show_cmd_cb */
5143 nullptr /* set_doc */
5147 /* Returns the option group used by 'info types'. */
5149 static gdb::option::option_def_group
5150 make_info_types_options_def_group (info_types_options
*opts
)
5152 return {{info_types_options_defs
}, opts
};
5155 /* Implement the 'info types' command. */
5158 info_types_command (const char *args
, int from_tty
)
5160 info_types_options opts
;
5162 auto grp
= make_info_types_options_def_group (&opts
);
5163 gdb::option::process_options
5164 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
5165 if (args
!= nullptr && *args
== '\0')
5167 symtab_symbol_info (opts
.quiet
, false, args
, TYPES_DOMAIN
, NULL
, from_tty
);
5170 /* Command completer for 'info types' command. */
5173 info_types_command_completer (struct cmd_list_element
*ignore
,
5174 completion_tracker
&tracker
,
5175 const char *text
, const char * /* word */)
5178 = make_info_types_options_def_group (nullptr);
5179 if (gdb::option::complete_options
5180 (tracker
, &text
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, group
))
5183 const char *word
= advance_to_expression_complete_word_point (tracker
, text
);
5184 symbol_completer (ignore
, tracker
, text
, word
);
5187 /* Implement the 'info modules' command. */
5190 info_modules_command (const char *args
, int from_tty
)
5192 info_types_options opts
;
5194 auto grp
= make_info_types_options_def_group (&opts
);
5195 gdb::option::process_options
5196 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
5197 if (args
!= nullptr && *args
== '\0')
5199 symtab_symbol_info (opts
.quiet
, true, args
, MODULES_DOMAIN
, NULL
,
5204 rbreak_command (const char *regexp
, int from_tty
)
5207 const char *file_name
= nullptr;
5209 if (regexp
!= nullptr)
5211 const char *colon
= strchr (regexp
, ':');
5213 if (colon
&& *(colon
+ 1) != ':')
5218 colon_index
= colon
- regexp
;
5219 local_name
= (char *) alloca (colon_index
+ 1);
5220 memcpy (local_name
, regexp
, colon_index
);
5221 local_name
[colon_index
--] = 0;
5222 while (isspace (local_name
[colon_index
]))
5223 local_name
[colon_index
--] = 0;
5224 file_name
= local_name
;
5225 regexp
= skip_spaces (colon
+ 1);
5229 global_symbol_searcher
spec (FUNCTIONS_DOMAIN
, regexp
);
5230 if (file_name
!= nullptr)
5231 spec
.filenames
.push_back (file_name
);
5232 std::vector
<symbol_search
> symbols
= spec
.search ();
5234 scoped_rbreak_breakpoints finalize
;
5235 for (const symbol_search
&p
: symbols
)
5237 if (p
.msymbol
.minsym
== NULL
)
5239 struct symtab
*symtab
= symbol_symtab (p
.symbol
);
5240 const char *fullname
= symtab_to_fullname (symtab
);
5242 string
= string_printf ("%s:'%s'", fullname
,
5243 p
.symbol
->linkage_name ());
5244 break_command (&string
[0], from_tty
);
5245 print_symbol_info (FUNCTIONS_DOMAIN
, p
.symbol
, p
.block
, NULL
);
5249 string
= string_printf ("'%s'",
5250 p
.msymbol
.minsym
->linkage_name ());
5252 break_command (&string
[0], from_tty
);
5253 printf_filtered ("<function, no debug info> %s;\n",
5254 p
.msymbol
.minsym
->print_name ());
5260 /* Evaluate if SYMNAME matches LOOKUP_NAME. */
5263 compare_symbol_name (const char *symbol_name
, language symbol_language
,
5264 const lookup_name_info
&lookup_name
,
5265 completion_match_result
&match_res
)
5267 const language_defn
*lang
= language_def (symbol_language
);
5269 symbol_name_matcher_ftype
*name_match
5270 = get_symbol_name_matcher (lang
, lookup_name
);
5272 return name_match (symbol_name
, lookup_name
, &match_res
);
5278 completion_list_add_name (completion_tracker
&tracker
,
5279 language symbol_language
,
5280 const char *symname
,
5281 const lookup_name_info
&lookup_name
,
5282 const char *text
, const char *word
)
5284 completion_match_result
&match_res
5285 = tracker
.reset_completion_match_result ();
5287 /* Clip symbols that cannot match. */
5288 if (!compare_symbol_name (symname
, symbol_language
, lookup_name
, match_res
))
5291 /* Refresh SYMNAME from the match string. It's potentially
5292 different depending on language. (E.g., on Ada, the match may be
5293 the encoded symbol name wrapped in "<>"). */
5294 symname
= match_res
.match
.match ();
5295 gdb_assert (symname
!= NULL
);
5297 /* We have a match for a completion, so add SYMNAME to the current list
5298 of matches. Note that the name is moved to freshly malloc'd space. */
5301 gdb::unique_xmalloc_ptr
<char> completion
5302 = make_completion_match_str (symname
, text
, word
);
5304 /* Here we pass the match-for-lcd object to add_completion. Some
5305 languages match the user text against substrings of symbol
5306 names in some cases. E.g., in C++, "b push_ba" completes to
5307 "std::vector::push_back", "std::string::push_back", etc., and
5308 in this case we want the completion lowest common denominator
5309 to be "push_back" instead of "std::". */
5310 tracker
.add_completion (std::move (completion
),
5311 &match_res
.match_for_lcd
, text
, word
);
5315 /* completion_list_add_name wrapper for struct symbol. */
5318 completion_list_add_symbol (completion_tracker
&tracker
,
5320 const lookup_name_info
&lookup_name
,
5321 const char *text
, const char *word
)
5323 completion_list_add_name (tracker
, sym
->language (),
5324 sym
->natural_name (),
5325 lookup_name
, text
, word
);
5327 /* C++ function symbols include the parameters within both the msymbol
5328 name and the symbol name. The problem is that the msymbol name will
5329 describe the parameters in the most basic way, with typedefs stripped
5330 out, while the symbol name will represent the types as they appear in
5331 the program. This means we will see duplicate entries in the
5332 completion tracker. The following converts the symbol name back to
5333 the msymbol name and removes the msymbol name from the completion
5335 if (sym
->language () == language_cplus
5336 && SYMBOL_DOMAIN (sym
) == VAR_DOMAIN
5337 && SYMBOL_CLASS (sym
) == LOC_BLOCK
)
5339 /* The call to canonicalize returns the empty string if the input
5340 string is already in canonical form, thanks to this we don't
5341 remove the symbol we just added above. */
5343 = cp_canonicalize_string_no_typedefs (sym
->natural_name ());
5345 tracker
.remove_completion (str
.c_str ());
5349 /* completion_list_add_name wrapper for struct minimal_symbol. */
5352 completion_list_add_msymbol (completion_tracker
&tracker
,
5353 minimal_symbol
*sym
,
5354 const lookup_name_info
&lookup_name
,
5355 const char *text
, const char *word
)
5357 completion_list_add_name (tracker
, sym
->language (),
5358 sym
->natural_name (),
5359 lookup_name
, text
, word
);
5363 /* ObjC: In case we are completing on a selector, look as the msymbol
5364 again and feed all the selectors into the mill. */
5367 completion_list_objc_symbol (completion_tracker
&tracker
,
5368 struct minimal_symbol
*msymbol
,
5369 const lookup_name_info
&lookup_name
,
5370 const char *text
, const char *word
)
5372 static char *tmp
= NULL
;
5373 static unsigned int tmplen
= 0;
5375 const char *method
, *category
, *selector
;
5378 method
= msymbol
->natural_name ();
5380 /* Is it a method? */
5381 if ((method
[0] != '-') && (method
[0] != '+'))
5385 /* Complete on shortened method method. */
5386 completion_list_add_name (tracker
, language_objc
,
5391 while ((strlen (method
) + 1) >= tmplen
)
5397 tmp
= (char *) xrealloc (tmp
, tmplen
);
5399 selector
= strchr (method
, ' ');
5400 if (selector
!= NULL
)
5403 category
= strchr (method
, '(');
5405 if ((category
!= NULL
) && (selector
!= NULL
))
5407 memcpy (tmp
, method
, (category
- method
));
5408 tmp
[category
- method
] = ' ';
5409 memcpy (tmp
+ (category
- method
) + 1, selector
, strlen (selector
) + 1);
5410 completion_list_add_name (tracker
, language_objc
, tmp
,
5411 lookup_name
, text
, word
);
5413 completion_list_add_name (tracker
, language_objc
, tmp
+ 1,
5414 lookup_name
, text
, word
);
5417 if (selector
!= NULL
)
5419 /* Complete on selector only. */
5420 strcpy (tmp
, selector
);
5421 tmp2
= strchr (tmp
, ']');
5425 completion_list_add_name (tracker
, language_objc
, tmp
,
5426 lookup_name
, text
, word
);
5430 /* Break the non-quoted text based on the characters which are in
5431 symbols. FIXME: This should probably be language-specific. */
5434 language_search_unquoted_string (const char *text
, const char *p
)
5436 for (; p
> text
; --p
)
5438 if (isalnum (p
[-1]) || p
[-1] == '_' || p
[-1] == '\0')
5442 if ((current_language
->la_language
== language_objc
))
5444 if (p
[-1] == ':') /* Might be part of a method name. */
5446 else if (p
[-1] == '[' && (p
[-2] == '-' || p
[-2] == '+'))
5447 p
-= 2; /* Beginning of a method name. */
5448 else if (p
[-1] == ' ' || p
[-1] == '(' || p
[-1] == ')')
5449 { /* Might be part of a method name. */
5452 /* Seeing a ' ' or a '(' is not conclusive evidence
5453 that we are in the middle of a method name. However,
5454 finding "-[" or "+[" should be pretty un-ambiguous.
5455 Unfortunately we have to find it now to decide. */
5458 if (isalnum (t
[-1]) || t
[-1] == '_' ||
5459 t
[-1] == ' ' || t
[-1] == ':' ||
5460 t
[-1] == '(' || t
[-1] == ')')
5465 if (t
[-1] == '[' && (t
[-2] == '-' || t
[-2] == '+'))
5466 p
= t
- 2; /* Method name detected. */
5467 /* Else we leave with p unchanged. */
5477 completion_list_add_fields (completion_tracker
&tracker
,
5479 const lookup_name_info
&lookup_name
,
5480 const char *text
, const char *word
)
5482 if (SYMBOL_CLASS (sym
) == LOC_TYPEDEF
)
5484 struct type
*t
= SYMBOL_TYPE (sym
);
5485 enum type_code c
= TYPE_CODE (t
);
5488 if (c
== TYPE_CODE_UNION
|| c
== TYPE_CODE_STRUCT
)
5489 for (j
= TYPE_N_BASECLASSES (t
); j
< TYPE_NFIELDS (t
); j
++)
5490 if (TYPE_FIELD_NAME (t
, j
))
5491 completion_list_add_name (tracker
, sym
->language (),
5492 TYPE_FIELD_NAME (t
, j
),
5493 lookup_name
, text
, word
);
5500 symbol_is_function_or_method (symbol
*sym
)
5502 switch (TYPE_CODE (SYMBOL_TYPE (sym
)))
5504 case TYPE_CODE_FUNC
:
5505 case TYPE_CODE_METHOD
:
5515 symbol_is_function_or_method (minimal_symbol
*msymbol
)
5517 switch (MSYMBOL_TYPE (msymbol
))
5520 case mst_text_gnu_ifunc
:
5521 case mst_solib_trampoline
:
5531 bound_minimal_symbol
5532 find_gnu_ifunc (const symbol
*sym
)
5534 if (SYMBOL_CLASS (sym
) != LOC_BLOCK
)
5537 lookup_name_info
lookup_name (sym
->search_name (),
5538 symbol_name_match_type::SEARCH_NAME
);
5539 struct objfile
*objfile
= symbol_objfile (sym
);
5541 CORE_ADDR address
= BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
));
5542 minimal_symbol
*ifunc
= NULL
;
5544 iterate_over_minimal_symbols (objfile
, lookup_name
,
5545 [&] (minimal_symbol
*minsym
)
5547 if (MSYMBOL_TYPE (minsym
) == mst_text_gnu_ifunc
5548 || MSYMBOL_TYPE (minsym
) == mst_data_gnu_ifunc
)
5550 CORE_ADDR msym_addr
= MSYMBOL_VALUE_ADDRESS (objfile
, minsym
);
5551 if (MSYMBOL_TYPE (minsym
) == mst_data_gnu_ifunc
)
5553 struct gdbarch
*gdbarch
= get_objfile_arch (objfile
);
5555 = gdbarch_convert_from_func_ptr_addr (gdbarch
,
5557 current_top_target ());
5559 if (msym_addr
== address
)
5569 return {ifunc
, objfile
};
5573 /* Add matching symbols from SYMTAB to the current completion list. */
5576 add_symtab_completions (struct compunit_symtab
*cust
,
5577 completion_tracker
&tracker
,
5578 complete_symbol_mode mode
,
5579 const lookup_name_info
&lookup_name
,
5580 const char *text
, const char *word
,
5581 enum type_code code
)
5584 const struct block
*b
;
5585 struct block_iterator iter
;
5591 for (i
= GLOBAL_BLOCK
; i
<= STATIC_BLOCK
; i
++)
5594 b
= BLOCKVECTOR_BLOCK (COMPUNIT_BLOCKVECTOR (cust
), i
);
5595 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
5597 if (completion_skip_symbol (mode
, sym
))
5600 if (code
== TYPE_CODE_UNDEF
5601 || (SYMBOL_DOMAIN (sym
) == STRUCT_DOMAIN
5602 && TYPE_CODE (SYMBOL_TYPE (sym
)) == code
))
5603 completion_list_add_symbol (tracker
, sym
,
5611 default_collect_symbol_completion_matches_break_on
5612 (completion_tracker
&tracker
, complete_symbol_mode mode
,
5613 symbol_name_match_type name_match_type
,
5614 const char *text
, const char *word
,
5615 const char *break_on
, enum type_code code
)
5617 /* Problem: All of the symbols have to be copied because readline
5618 frees them. I'm not going to worry about this; hopefully there
5619 won't be that many. */
5622 const struct block
*b
;
5623 const struct block
*surrounding_static_block
, *surrounding_global_block
;
5624 struct block_iterator iter
;
5625 /* The symbol we are completing on. Points in same buffer as text. */
5626 const char *sym_text
;
5628 /* Now look for the symbol we are supposed to complete on. */
5629 if (mode
== complete_symbol_mode::LINESPEC
)
5635 const char *quote_pos
= NULL
;
5637 /* First see if this is a quoted string. */
5639 for (p
= text
; *p
!= '\0'; ++p
)
5641 if (quote_found
!= '\0')
5643 if (*p
== quote_found
)
5644 /* Found close quote. */
5646 else if (*p
== '\\' && p
[1] == quote_found
)
5647 /* A backslash followed by the quote character
5648 doesn't end the string. */
5651 else if (*p
== '\'' || *p
== '"')
5657 if (quote_found
== '\'')
5658 /* A string within single quotes can be a symbol, so complete on it. */
5659 sym_text
= quote_pos
+ 1;
5660 else if (quote_found
== '"')
5661 /* A double-quoted string is never a symbol, nor does it make sense
5662 to complete it any other way. */
5668 /* It is not a quoted string. Break it based on the characters
5669 which are in symbols. */
5672 if (isalnum (p
[-1]) || p
[-1] == '_' || p
[-1] == '\0'
5673 || p
[-1] == ':' || strchr (break_on
, p
[-1]) != NULL
)
5682 lookup_name_info
lookup_name (sym_text
, name_match_type
, true);
5684 /* At this point scan through the misc symbol vectors and add each
5685 symbol you find to the list. Eventually we want to ignore
5686 anything that isn't a text symbol (everything else will be
5687 handled by the psymtab code below). */
5689 if (code
== TYPE_CODE_UNDEF
)
5691 for (objfile
*objfile
: current_program_space
->objfiles ())
5693 for (minimal_symbol
*msymbol
: objfile
->msymbols ())
5697 if (completion_skip_symbol (mode
, msymbol
))
5700 completion_list_add_msymbol (tracker
, msymbol
, lookup_name
,
5703 completion_list_objc_symbol (tracker
, msymbol
, lookup_name
,
5709 /* Add completions for all currently loaded symbol tables. */
5710 for (objfile
*objfile
: current_program_space
->objfiles ())
5712 for (compunit_symtab
*cust
: objfile
->compunits ())
5713 add_symtab_completions (cust
, tracker
, mode
, lookup_name
,
5714 sym_text
, word
, code
);
5717 /* Look through the partial symtabs for all symbols which begin by
5718 matching SYM_TEXT. Expand all CUs that you find to the list. */
5719 expand_symtabs_matching (NULL
,
5722 [&] (compunit_symtab
*symtab
) /* expansion notify */
5724 add_symtab_completions (symtab
,
5725 tracker
, mode
, lookup_name
,
5726 sym_text
, word
, code
);
5730 /* Search upwards from currently selected frame (so that we can
5731 complete on local vars). Also catch fields of types defined in
5732 this places which match our text string. Only complete on types
5733 visible from current context. */
5735 b
= get_selected_block (0);
5736 surrounding_static_block
= block_static_block (b
);
5737 surrounding_global_block
= block_global_block (b
);
5738 if (surrounding_static_block
!= NULL
)
5739 while (b
!= surrounding_static_block
)
5743 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
5745 if (code
== TYPE_CODE_UNDEF
)
5747 completion_list_add_symbol (tracker
, sym
, lookup_name
,
5749 completion_list_add_fields (tracker
, sym
, lookup_name
,
5752 else if (SYMBOL_DOMAIN (sym
) == STRUCT_DOMAIN
5753 && TYPE_CODE (SYMBOL_TYPE (sym
)) == code
)
5754 completion_list_add_symbol (tracker
, sym
, lookup_name
,
5758 /* Stop when we encounter an enclosing function. Do not stop for
5759 non-inlined functions - the locals of the enclosing function
5760 are in scope for a nested function. */
5761 if (BLOCK_FUNCTION (b
) != NULL
&& block_inlined_p (b
))
5763 b
= BLOCK_SUPERBLOCK (b
);
5766 /* Add fields from the file's types; symbols will be added below. */
5768 if (code
== TYPE_CODE_UNDEF
)
5770 if (surrounding_static_block
!= NULL
)
5771 ALL_BLOCK_SYMBOLS (surrounding_static_block
, iter
, sym
)
5772 completion_list_add_fields (tracker
, sym
, lookup_name
,
5775 if (surrounding_global_block
!= NULL
)
5776 ALL_BLOCK_SYMBOLS (surrounding_global_block
, iter
, sym
)
5777 completion_list_add_fields (tracker
, sym
, lookup_name
,
5781 /* Skip macros if we are completing a struct tag -- arguable but
5782 usually what is expected. */
5783 if (current_language
->la_macro_expansion
== macro_expansion_c
5784 && code
== TYPE_CODE_UNDEF
)
5786 gdb::unique_xmalloc_ptr
<struct macro_scope
> scope
;
5788 /* This adds a macro's name to the current completion list. */
5789 auto add_macro_name
= [&] (const char *macro_name
,
5790 const macro_definition
*,
5791 macro_source_file
*,
5794 completion_list_add_name (tracker
, language_c
, macro_name
,
5795 lookup_name
, sym_text
, word
);
5798 /* Add any macros visible in the default scope. Note that this
5799 may yield the occasional wrong result, because an expression
5800 might be evaluated in a scope other than the default. For
5801 example, if the user types "break file:line if <TAB>", the
5802 resulting expression will be evaluated at "file:line" -- but
5803 at there does not seem to be a way to detect this at
5805 scope
= default_macro_scope ();
5807 macro_for_each_in_scope (scope
->file
, scope
->line
,
5810 /* User-defined macros are always visible. */
5811 macro_for_each (macro_user_macros
, add_macro_name
);
5816 default_collect_symbol_completion_matches (completion_tracker
&tracker
,
5817 complete_symbol_mode mode
,
5818 symbol_name_match_type name_match_type
,
5819 const char *text
, const char *word
,
5820 enum type_code code
)
5822 return default_collect_symbol_completion_matches_break_on (tracker
, mode
,
5828 /* Collect all symbols (regardless of class) which begin by matching
5832 collect_symbol_completion_matches (completion_tracker
&tracker
,
5833 complete_symbol_mode mode
,
5834 symbol_name_match_type name_match_type
,
5835 const char *text
, const char *word
)
5837 current_language
->la_collect_symbol_completion_matches (tracker
, mode
,
5843 /* Like collect_symbol_completion_matches, but only collect
5844 STRUCT_DOMAIN symbols whose type code is CODE. */
5847 collect_symbol_completion_matches_type (completion_tracker
&tracker
,
5848 const char *text
, const char *word
,
5849 enum type_code code
)
5851 complete_symbol_mode mode
= complete_symbol_mode::EXPRESSION
;
5852 symbol_name_match_type name_match_type
= symbol_name_match_type::EXPRESSION
;
5854 gdb_assert (code
== TYPE_CODE_UNION
5855 || code
== TYPE_CODE_STRUCT
5856 || code
== TYPE_CODE_ENUM
);
5857 current_language
->la_collect_symbol_completion_matches (tracker
, mode
,
5862 /* Like collect_symbol_completion_matches, but collects a list of
5863 symbols defined in all source files named SRCFILE. */
5866 collect_file_symbol_completion_matches (completion_tracker
&tracker
,
5867 complete_symbol_mode mode
,
5868 symbol_name_match_type name_match_type
,
5869 const char *text
, const char *word
,
5870 const char *srcfile
)
5872 /* The symbol we are completing on. Points in same buffer as text. */
5873 const char *sym_text
;
5875 /* Now look for the symbol we are supposed to complete on.
5876 FIXME: This should be language-specific. */
5877 if (mode
== complete_symbol_mode::LINESPEC
)
5883 const char *quote_pos
= NULL
;
5885 /* First see if this is a quoted string. */
5887 for (p
= text
; *p
!= '\0'; ++p
)
5889 if (quote_found
!= '\0')
5891 if (*p
== quote_found
)
5892 /* Found close quote. */
5894 else if (*p
== '\\' && p
[1] == quote_found
)
5895 /* A backslash followed by the quote character
5896 doesn't end the string. */
5899 else if (*p
== '\'' || *p
== '"')
5905 if (quote_found
== '\'')
5906 /* A string within single quotes can be a symbol, so complete on it. */
5907 sym_text
= quote_pos
+ 1;
5908 else if (quote_found
== '"')
5909 /* A double-quoted string is never a symbol, nor does it make sense
5910 to complete it any other way. */
5916 /* Not a quoted string. */
5917 sym_text
= language_search_unquoted_string (text
, p
);
5921 lookup_name_info
lookup_name (sym_text
, name_match_type
, true);
5923 /* Go through symtabs for SRCFILE and check the externs and statics
5924 for symbols which match. */
5925 iterate_over_symtabs (srcfile
, [&] (symtab
*s
)
5927 add_symtab_completions (SYMTAB_COMPUNIT (s
),
5928 tracker
, mode
, lookup_name
,
5929 sym_text
, word
, TYPE_CODE_UNDEF
);
5934 /* A helper function for make_source_files_completion_list. It adds
5935 another file name to a list of possible completions, growing the
5936 list as necessary. */
5939 add_filename_to_list (const char *fname
, const char *text
, const char *word
,
5940 completion_list
*list
)
5942 list
->emplace_back (make_completion_match_str (fname
, text
, word
));
5946 not_interesting_fname (const char *fname
)
5948 static const char *illegal_aliens
[] = {
5949 "_globals_", /* inserted by coff_symtab_read */
5954 for (i
= 0; illegal_aliens
[i
]; i
++)
5956 if (filename_cmp (fname
, illegal_aliens
[i
]) == 0)
5962 /* An object of this type is passed as the user_data argument to
5963 map_partial_symbol_filenames. */
5964 struct add_partial_filename_data
5966 struct filename_seen_cache
*filename_seen_cache
;
5970 completion_list
*list
;
5973 /* A callback for map_partial_symbol_filenames. */
5976 maybe_add_partial_symtab_filename (const char *filename
, const char *fullname
,
5979 struct add_partial_filename_data
*data
5980 = (struct add_partial_filename_data
*) user_data
;
5982 if (not_interesting_fname (filename
))
5984 if (!data
->filename_seen_cache
->seen (filename
)
5985 && filename_ncmp (filename
, data
->text
, data
->text_len
) == 0)
5987 /* This file matches for a completion; add it to the
5988 current list of matches. */
5989 add_filename_to_list (filename
, data
->text
, data
->word
, data
->list
);
5993 const char *base_name
= lbasename (filename
);
5995 if (base_name
!= filename
5996 && !data
->filename_seen_cache
->seen (base_name
)
5997 && filename_ncmp (base_name
, data
->text
, data
->text_len
) == 0)
5998 add_filename_to_list (base_name
, data
->text
, data
->word
, data
->list
);
6002 /* Return a list of all source files whose names begin with matching
6003 TEXT. The file names are looked up in the symbol tables of this
6007 make_source_files_completion_list (const char *text
, const char *word
)
6009 size_t text_len
= strlen (text
);
6010 completion_list list
;
6011 const char *base_name
;
6012 struct add_partial_filename_data datum
;
6014 if (!have_full_symbols () && !have_partial_symbols ())
6017 filename_seen_cache filenames_seen
;
6019 for (objfile
*objfile
: current_program_space
->objfiles ())
6021 for (compunit_symtab
*cu
: objfile
->compunits ())
6023 for (symtab
*s
: compunit_filetabs (cu
))
6025 if (not_interesting_fname (s
->filename
))
6027 if (!filenames_seen
.seen (s
->filename
)
6028 && filename_ncmp (s
->filename
, text
, text_len
) == 0)
6030 /* This file matches for a completion; add it to the current
6032 add_filename_to_list (s
->filename
, text
, word
, &list
);
6036 /* NOTE: We allow the user to type a base name when the
6037 debug info records leading directories, but not the other
6038 way around. This is what subroutines of breakpoint
6039 command do when they parse file names. */
6040 base_name
= lbasename (s
->filename
);
6041 if (base_name
!= s
->filename
6042 && !filenames_seen
.seen (base_name
)
6043 && filename_ncmp (base_name
, text
, text_len
) == 0)
6044 add_filename_to_list (base_name
, text
, word
, &list
);
6050 datum
.filename_seen_cache
= &filenames_seen
;
6053 datum
.text_len
= text_len
;
6055 map_symbol_filenames (maybe_add_partial_symtab_filename
, &datum
,
6056 0 /*need_fullname*/);
6063 /* Return the "main_info" object for the current program space. If
6064 the object has not yet been created, create it and fill in some
6067 static struct main_info
*
6068 get_main_info (void)
6070 struct main_info
*info
= main_progspace_key
.get (current_program_space
);
6074 /* It may seem strange to store the main name in the progspace
6075 and also in whatever objfile happens to see a main name in
6076 its debug info. The reason for this is mainly historical:
6077 gdb returned "main" as the name even if no function named
6078 "main" was defined the program; and this approach lets us
6079 keep compatibility. */
6080 info
= main_progspace_key
.emplace (current_program_space
);
6087 set_main_name (const char *name
, enum language lang
)
6089 struct main_info
*info
= get_main_info ();
6091 if (info
->name_of_main
!= NULL
)
6093 xfree (info
->name_of_main
);
6094 info
->name_of_main
= NULL
;
6095 info
->language_of_main
= language_unknown
;
6099 info
->name_of_main
= xstrdup (name
);
6100 info
->language_of_main
= lang
;
6104 /* Deduce the name of the main procedure, and set NAME_OF_MAIN
6108 find_main_name (void)
6110 const char *new_main_name
;
6112 /* First check the objfiles to see whether a debuginfo reader has
6113 picked up the appropriate main name. Historically the main name
6114 was found in a more or less random way; this approach instead
6115 relies on the order of objfile creation -- which still isn't
6116 guaranteed to get the correct answer, but is just probably more
6118 for (objfile
*objfile
: current_program_space
->objfiles ())
6120 if (objfile
->per_bfd
->name_of_main
!= NULL
)
6122 set_main_name (objfile
->per_bfd
->name_of_main
,
6123 objfile
->per_bfd
->language_of_main
);
6128 /* Try to see if the main procedure is in Ada. */
6129 /* FIXME: brobecker/2005-03-07: Another way of doing this would
6130 be to add a new method in the language vector, and call this
6131 method for each language until one of them returns a non-empty
6132 name. This would allow us to remove this hard-coded call to
6133 an Ada function. It is not clear that this is a better approach
6134 at this point, because all methods need to be written in a way
6135 such that false positives never be returned. For instance, it is
6136 important that a method does not return a wrong name for the main
6137 procedure if the main procedure is actually written in a different
6138 language. It is easy to guaranty this with Ada, since we use a
6139 special symbol generated only when the main in Ada to find the name
6140 of the main procedure. It is difficult however to see how this can
6141 be guarantied for languages such as C, for instance. This suggests
6142 that order of call for these methods becomes important, which means
6143 a more complicated approach. */
6144 new_main_name
= ada_main_name ();
6145 if (new_main_name
!= NULL
)
6147 set_main_name (new_main_name
, language_ada
);
6151 new_main_name
= d_main_name ();
6152 if (new_main_name
!= NULL
)
6154 set_main_name (new_main_name
, language_d
);
6158 new_main_name
= go_main_name ();
6159 if (new_main_name
!= NULL
)
6161 set_main_name (new_main_name
, language_go
);
6165 new_main_name
= pascal_main_name ();
6166 if (new_main_name
!= NULL
)
6168 set_main_name (new_main_name
, language_pascal
);
6172 /* The languages above didn't identify the name of the main procedure.
6173 Fallback to "main". */
6175 /* Try to find language for main in psymtabs. */
6177 = find_quick_global_symbol_language ("main", VAR_DOMAIN
);
6178 if (lang
!= language_unknown
)
6180 set_main_name ("main", lang
);
6184 set_main_name ("main", language_unknown
);
6192 struct main_info
*info
= get_main_info ();
6194 if (info
->name_of_main
== NULL
)
6197 return info
->name_of_main
;
6200 /* Return the language of the main function. If it is not known,
6201 return language_unknown. */
6204 main_language (void)
6206 struct main_info
*info
= get_main_info ();
6208 if (info
->name_of_main
== NULL
)
6211 return info
->language_of_main
;
6214 /* Handle ``executable_changed'' events for the symtab module. */
6217 symtab_observer_executable_changed (void)
6219 /* NAME_OF_MAIN may no longer be the same, so reset it for now. */
6220 set_main_name (NULL
, language_unknown
);
6223 /* Return 1 if the supplied producer string matches the ARM RealView
6224 compiler (armcc). */
6227 producer_is_realview (const char *producer
)
6229 static const char *const arm_idents
[] = {
6230 "ARM C Compiler, ADS",
6231 "Thumb C Compiler, ADS",
6232 "ARM C++ Compiler, ADS",
6233 "Thumb C++ Compiler, ADS",
6234 "ARM/Thumb C/C++ Compiler, RVCT",
6235 "ARM C/C++ Compiler, RVCT"
6239 if (producer
== NULL
)
6242 for (i
= 0; i
< ARRAY_SIZE (arm_idents
); i
++)
6243 if (startswith (producer
, arm_idents
[i
]))
6251 /* The next index to hand out in response to a registration request. */
6253 static int next_aclass_value
= LOC_FINAL_VALUE
;
6255 /* The maximum number of "aclass" registrations we support. This is
6256 constant for convenience. */
6257 #define MAX_SYMBOL_IMPLS (LOC_FINAL_VALUE + 10)
6259 /* The objects representing the various "aclass" values. The elements
6260 from 0 up to LOC_FINAL_VALUE-1 represent themselves, and subsequent
6261 elements are those registered at gdb initialization time. */
6263 static struct symbol_impl symbol_impl
[MAX_SYMBOL_IMPLS
];
6265 /* The globally visible pointer. This is separate from 'symbol_impl'
6266 so that it can be const. */
6268 const struct symbol_impl
*symbol_impls
= &symbol_impl
[0];
6270 /* Make sure we saved enough room in struct symbol. */
6272 gdb_static_assert (MAX_SYMBOL_IMPLS
<= (1 << SYMBOL_ACLASS_BITS
));
6274 /* Register a computed symbol type. ACLASS must be LOC_COMPUTED. OPS
6275 is the ops vector associated with this index. This returns the new
6276 index, which should be used as the aclass_index field for symbols
6280 register_symbol_computed_impl (enum address_class aclass
,
6281 const struct symbol_computed_ops
*ops
)
6283 int result
= next_aclass_value
++;
6285 gdb_assert (aclass
== LOC_COMPUTED
);
6286 gdb_assert (result
< MAX_SYMBOL_IMPLS
);
6287 symbol_impl
[result
].aclass
= aclass
;
6288 symbol_impl
[result
].ops_computed
= ops
;
6290 /* Sanity check OPS. */
6291 gdb_assert (ops
!= NULL
);
6292 gdb_assert (ops
->tracepoint_var_ref
!= NULL
);
6293 gdb_assert (ops
->describe_location
!= NULL
);
6294 gdb_assert (ops
->get_symbol_read_needs
!= NULL
);
6295 gdb_assert (ops
->read_variable
!= NULL
);
6300 /* Register a function with frame base type. ACLASS must be LOC_BLOCK.
6301 OPS is the ops vector associated with this index. This returns the
6302 new index, which should be used as the aclass_index field for symbols
6306 register_symbol_block_impl (enum address_class aclass
,
6307 const struct symbol_block_ops
*ops
)
6309 int result
= next_aclass_value
++;
6311 gdb_assert (aclass
== LOC_BLOCK
);
6312 gdb_assert (result
< MAX_SYMBOL_IMPLS
);
6313 symbol_impl
[result
].aclass
= aclass
;
6314 symbol_impl
[result
].ops_block
= ops
;
6316 /* Sanity check OPS. */
6317 gdb_assert (ops
!= NULL
);
6318 gdb_assert (ops
->find_frame_base_location
!= NULL
);
6323 /* Register a register symbol type. ACLASS must be LOC_REGISTER or
6324 LOC_REGPARM_ADDR. OPS is the register ops vector associated with
6325 this index. This returns the new index, which should be used as
6326 the aclass_index field for symbols of this type. */
6329 register_symbol_register_impl (enum address_class aclass
,
6330 const struct symbol_register_ops
*ops
)
6332 int result
= next_aclass_value
++;
6334 gdb_assert (aclass
== LOC_REGISTER
|| aclass
== LOC_REGPARM_ADDR
);
6335 gdb_assert (result
< MAX_SYMBOL_IMPLS
);
6336 symbol_impl
[result
].aclass
= aclass
;
6337 symbol_impl
[result
].ops_register
= ops
;
6342 /* Initialize elements of 'symbol_impl' for the constants in enum
6346 initialize_ordinary_address_classes (void)
6350 for (i
= 0; i
< LOC_FINAL_VALUE
; ++i
)
6351 symbol_impl
[i
].aclass
= (enum address_class
) i
;
6356 /* Initialize the symbol SYM, and mark it as being owned by an objfile. */
6359 initialize_objfile_symbol (struct symbol
*sym
)
6361 SYMBOL_OBJFILE_OWNED (sym
) = 1;
6362 SYMBOL_SECTION (sym
) = -1;
6365 /* Allocate and initialize a new 'struct symbol' on OBJFILE's
6369 allocate_symbol (struct objfile
*objfile
)
6371 struct symbol
*result
= new (&objfile
->objfile_obstack
) symbol ();
6373 initialize_objfile_symbol (result
);
6378 /* Allocate and initialize a new 'struct template_symbol' on OBJFILE's
6381 struct template_symbol
*
6382 allocate_template_symbol (struct objfile
*objfile
)
6384 struct template_symbol
*result
;
6386 result
= new (&objfile
->objfile_obstack
) template_symbol ();
6387 initialize_objfile_symbol (result
);
6395 symbol_objfile (const struct symbol
*symbol
)
6397 gdb_assert (SYMBOL_OBJFILE_OWNED (symbol
));
6398 return SYMTAB_OBJFILE (symbol
->owner
.symtab
);
6404 symbol_arch (const struct symbol
*symbol
)
6406 if (!SYMBOL_OBJFILE_OWNED (symbol
))
6407 return symbol
->owner
.arch
;
6408 return get_objfile_arch (SYMTAB_OBJFILE (symbol
->owner
.symtab
));
6414 symbol_symtab (const struct symbol
*symbol
)
6416 gdb_assert (SYMBOL_OBJFILE_OWNED (symbol
));
6417 return symbol
->owner
.symtab
;
6423 symbol_set_symtab (struct symbol
*symbol
, struct symtab
*symtab
)
6425 gdb_assert (SYMBOL_OBJFILE_OWNED (symbol
));
6426 symbol
->owner
.symtab
= symtab
;
6432 get_symbol_address (const struct symbol
*sym
)
6434 gdb_assert (sym
->maybe_copied
);
6435 gdb_assert (SYMBOL_CLASS (sym
) == LOC_STATIC
);
6437 const char *linkage_name
= sym
->linkage_name ();
6439 for (objfile
*objfile
: current_program_space
->objfiles ())
6441 if (objfile
->separate_debug_objfile_backlink
!= nullptr)
6444 bound_minimal_symbol minsym
6445 = lookup_minimal_symbol_linkage (linkage_name
, objfile
);
6446 if (minsym
.minsym
!= nullptr)
6447 return BMSYMBOL_VALUE_ADDRESS (minsym
);
6449 return sym
->value
.address
;
6455 get_msymbol_address (struct objfile
*objf
, const struct minimal_symbol
*minsym
)
6457 gdb_assert (minsym
->maybe_copied
);
6458 gdb_assert ((objf
->flags
& OBJF_MAINLINE
) == 0);
6460 const char *linkage_name
= minsym
->linkage_name ();
6462 for (objfile
*objfile
: current_program_space
->objfiles ())
6464 if (objfile
->separate_debug_objfile_backlink
== nullptr
6465 && (objfile
->flags
& OBJF_MAINLINE
) != 0)
6467 bound_minimal_symbol found
6468 = lookup_minimal_symbol_linkage (linkage_name
, objfile
);
6469 if (found
.minsym
!= nullptr)
6470 return BMSYMBOL_VALUE_ADDRESS (found
);
6473 return minsym
->value
.address
+ objf
->section_offsets
[minsym
->section
];
6478 /* Hold the sub-commands of 'info module'. */
6480 static struct cmd_list_element
*info_module_cmdlist
= NULL
;
6484 std::vector
<module_symbol_search
>
6485 search_module_symbols (const char *module_regexp
, const char *regexp
,
6486 const char *type_regexp
, search_domain kind
)
6488 std::vector
<module_symbol_search
> results
;
6490 /* Search for all modules matching MODULE_REGEXP. */
6491 global_symbol_searcher
spec1 (MODULES_DOMAIN
, module_regexp
);
6492 spec1
.set_exclude_minsyms (true);
6493 std::vector
<symbol_search
> modules
= spec1
.search ();
6495 /* Now search for all symbols of the required KIND matching the required
6496 regular expressions. We figure out which ones are in which modules
6498 global_symbol_searcher
spec2 (kind
, regexp
);
6499 spec2
.set_symbol_type_regexp (type_regexp
);
6500 spec2
.set_exclude_minsyms (true);
6501 std::vector
<symbol_search
> symbols
= spec2
.search ();
6503 /* Now iterate over all MODULES, checking to see which items from
6504 SYMBOLS are in each module. */
6505 for (const symbol_search
&p
: modules
)
6509 /* This is a module. */
6510 gdb_assert (p
.symbol
!= nullptr);
6512 std::string prefix
= p
.symbol
->print_name ();
6515 for (const symbol_search
&q
: symbols
)
6517 if (q
.symbol
== nullptr)
6520 if (strncmp (q
.symbol
->print_name (), prefix
.c_str (),
6521 prefix
.size ()) != 0)
6524 results
.push_back ({p
, q
});
6531 /* Implement the core of both 'info module functions' and 'info module
6535 info_module_subcommand (bool quiet
, const char *module_regexp
,
6536 const char *regexp
, const char *type_regexp
,
6539 /* Print a header line. Don't build the header line bit by bit as this
6540 prevents internationalisation. */
6543 if (module_regexp
== nullptr)
6545 if (type_regexp
== nullptr)
6547 if (regexp
== nullptr)
6548 printf_filtered ((kind
== VARIABLES_DOMAIN
6549 ? _("All variables in all modules:")
6550 : _("All functions in all modules:")));
6553 ((kind
== VARIABLES_DOMAIN
6554 ? _("All variables matching regular expression"
6555 " \"%s\" in all modules:")
6556 : _("All functions matching regular expression"
6557 " \"%s\" in all modules:")),
6562 if (regexp
== nullptr)
6564 ((kind
== VARIABLES_DOMAIN
6565 ? _("All variables with type matching regular "
6566 "expression \"%s\" in all modules:")
6567 : _("All functions with type matching regular "
6568 "expression \"%s\" in all modules:")),
6572 ((kind
== VARIABLES_DOMAIN
6573 ? _("All variables matching regular expression "
6574 "\"%s\",\n\twith type matching regular "
6575 "expression \"%s\" in all modules:")
6576 : _("All functions matching regular expression "
6577 "\"%s\",\n\twith type matching regular "
6578 "expression \"%s\" in all modules:")),
6579 regexp
, type_regexp
);
6584 if (type_regexp
== nullptr)
6586 if (regexp
== nullptr)
6588 ((kind
== VARIABLES_DOMAIN
6589 ? _("All variables in all modules matching regular "
6590 "expression \"%s\":")
6591 : _("All functions in all modules matching regular "
6592 "expression \"%s\":")),
6596 ((kind
== VARIABLES_DOMAIN
6597 ? _("All variables matching regular expression "
6598 "\"%s\",\n\tin all modules matching regular "
6599 "expression \"%s\":")
6600 : _("All functions matching regular expression "
6601 "\"%s\",\n\tin all modules matching regular "
6602 "expression \"%s\":")),
6603 regexp
, module_regexp
);
6607 if (regexp
== nullptr)
6609 ((kind
== VARIABLES_DOMAIN
6610 ? _("All variables with type matching regular "
6611 "expression \"%s\"\n\tin all modules matching "
6612 "regular expression \"%s\":")
6613 : _("All functions with type matching regular "
6614 "expression \"%s\"\n\tin all modules matching "
6615 "regular expression \"%s\":")),
6616 type_regexp
, module_regexp
);
6619 ((kind
== VARIABLES_DOMAIN
6620 ? _("All variables matching regular expression "
6621 "\"%s\",\n\twith type matching regular expression "
6622 "\"%s\",\n\tin all modules matching regular "
6623 "expression \"%s\":")
6624 : _("All functions matching regular expression "
6625 "\"%s\",\n\twith type matching regular expression "
6626 "\"%s\",\n\tin all modules matching regular "
6627 "expression \"%s\":")),
6628 regexp
, type_regexp
, module_regexp
);
6631 printf_filtered ("\n");
6634 /* Find all symbols of type KIND matching the given regular expressions
6635 along with the symbols for the modules in which those symbols
6637 std::vector
<module_symbol_search
> module_symbols
6638 = search_module_symbols (module_regexp
, regexp
, type_regexp
, kind
);
6640 std::sort (module_symbols
.begin (), module_symbols
.end (),
6641 [] (const module_symbol_search
&a
, const module_symbol_search
&b
)
6643 if (a
.first
< b
.first
)
6645 else if (a
.first
== b
.first
)
6646 return a
.second
< b
.second
;
6651 const char *last_filename
= "";
6652 const symbol
*last_module_symbol
= nullptr;
6653 for (const module_symbol_search
&ms
: module_symbols
)
6655 const symbol_search
&p
= ms
.first
;
6656 const symbol_search
&q
= ms
.second
;
6658 gdb_assert (q
.symbol
!= nullptr);
6660 if (last_module_symbol
!= p
.symbol
)
6662 printf_filtered ("\n");
6663 printf_filtered (_("Module \"%s\":\n"), p
.symbol
->print_name ());
6664 last_module_symbol
= p
.symbol
;
6668 print_symbol_info (FUNCTIONS_DOMAIN
, q
.symbol
, q
.block
,
6671 = symtab_to_filename_for_display (symbol_symtab (q
.symbol
));
6675 /* Hold the option values for the 'info module .....' sub-commands. */
6677 struct info_modules_var_func_options
6680 char *type_regexp
= nullptr;
6681 char *module_regexp
= nullptr;
6683 ~info_modules_var_func_options ()
6685 xfree (type_regexp
);
6686 xfree (module_regexp
);
6690 /* The options used by 'info module variables' and 'info module functions'
6693 static const gdb::option::option_def info_modules_var_func_options_defs
[] = {
6694 gdb::option::boolean_option_def
<info_modules_var_func_options
> {
6696 [] (info_modules_var_func_options
*opt
) { return &opt
->quiet
; },
6697 nullptr, /* show_cmd_cb */
6698 nullptr /* set_doc */
6701 gdb::option::string_option_def
<info_modules_var_func_options
> {
6703 [] (info_modules_var_func_options
*opt
) { return &opt
->type_regexp
; },
6704 nullptr, /* show_cmd_cb */
6705 nullptr /* set_doc */
6708 gdb::option::string_option_def
<info_modules_var_func_options
> {
6710 [] (info_modules_var_func_options
*opt
) { return &opt
->module_regexp
; },
6711 nullptr, /* show_cmd_cb */
6712 nullptr /* set_doc */
6716 /* Return the option group used by the 'info module ...' sub-commands. */
6718 static inline gdb::option::option_def_group
6719 make_info_modules_var_func_options_def_group
6720 (info_modules_var_func_options
*opts
)
6722 return {{info_modules_var_func_options_defs
}, opts
};
6725 /* Implements the 'info module functions' command. */
6728 info_module_functions_command (const char *args
, int from_tty
)
6730 info_modules_var_func_options opts
;
6731 auto grp
= make_info_modules_var_func_options_def_group (&opts
);
6732 gdb::option::process_options
6733 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
6734 if (args
!= nullptr && *args
== '\0')
6737 info_module_subcommand (opts
.quiet
, opts
.module_regexp
, args
,
6738 opts
.type_regexp
, FUNCTIONS_DOMAIN
);
6741 /* Implements the 'info module variables' command. */
6744 info_module_variables_command (const char *args
, int from_tty
)
6746 info_modules_var_func_options opts
;
6747 auto grp
= make_info_modules_var_func_options_def_group (&opts
);
6748 gdb::option::process_options
6749 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
6750 if (args
!= nullptr && *args
== '\0')
6753 info_module_subcommand (opts
.quiet
, opts
.module_regexp
, args
,
6754 opts
.type_regexp
, VARIABLES_DOMAIN
);
6757 /* Command completer for 'info module ...' sub-commands. */
6760 info_module_var_func_command_completer (struct cmd_list_element
*ignore
,
6761 completion_tracker
&tracker
,
6763 const char * /* word */)
6766 const auto group
= make_info_modules_var_func_options_def_group (nullptr);
6767 if (gdb::option::complete_options
6768 (tracker
, &text
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, group
))
6771 const char *word
= advance_to_expression_complete_word_point (tracker
, text
);
6772 symbol_completer (ignore
, tracker
, text
, word
);
6777 void _initialize_symtab ();
6779 _initialize_symtab ()
6781 cmd_list_element
*c
;
6783 initialize_ordinary_address_classes ();
6785 c
= add_info ("variables", info_variables_command
,
6786 info_print_args_help (_("\
6787 All global and static variable names or those matching REGEXPs.\n\
6788 Usage: info variables [-q] [-n] [-t TYPEREGEXP] [NAMEREGEXP]\n\
6789 Prints the global and static variables.\n"),
6790 _("global and static variables"),
6792 set_cmd_completer_handle_brkchars (c
, info_vars_funcs_command_completer
);
6795 c
= add_com ("whereis", class_info
, info_variables_command
,
6796 info_print_args_help (_("\
6797 All global and static variable names, or those matching REGEXPs.\n\
6798 Usage: whereis [-q] [-n] [-t TYPEREGEXP] [NAMEREGEXP]\n\
6799 Prints the global and static variables.\n"),
6800 _("global and static variables"),
6802 set_cmd_completer_handle_brkchars (c
, info_vars_funcs_command_completer
);
6805 c
= add_info ("functions", info_functions_command
,
6806 info_print_args_help (_("\
6807 All function names or those matching REGEXPs.\n\
6808 Usage: info functions [-q] [-n] [-t TYPEREGEXP] [NAMEREGEXP]\n\
6809 Prints the functions.\n"),
6812 set_cmd_completer_handle_brkchars (c
, info_vars_funcs_command_completer
);
6814 c
= add_info ("types", info_types_command
, _("\
6815 All type names, or those matching REGEXP.\n\
6816 Usage: info types [-q] [REGEXP]\n\
6817 Print information about all types matching REGEXP, or all types if no\n\
6818 REGEXP is given. The optional flag -q disables printing of headers."));
6819 set_cmd_completer_handle_brkchars (c
, info_types_command_completer
);
6821 const auto info_sources_opts
= make_info_sources_options_def_group (nullptr);
6823 static std::string info_sources_help
6824 = gdb::option::build_help (_("\
6825 All source files in the program or those matching REGEXP.\n\
6826 Usage: info sources [OPTION]... [REGEXP]\n\
6827 By default, REGEXP is used to match anywhere in the filename.\n\
6833 c
= add_info ("sources", info_sources_command
, info_sources_help
.c_str ());
6834 set_cmd_completer_handle_brkchars (c
, info_sources_command_completer
);
6836 c
= add_info ("modules", info_modules_command
,
6837 _("All module names, or those matching REGEXP."));
6838 set_cmd_completer_handle_brkchars (c
, info_types_command_completer
);
6840 add_basic_prefix_cmd ("module", class_info
, _("\
6841 Print information about modules."),
6842 &info_module_cmdlist
, "info module ",
6845 c
= add_cmd ("functions", class_info
, info_module_functions_command
, _("\
6846 Display functions arranged by modules.\n\
6847 Usage: info module functions [-q] [-m MODREGEXP] [-t TYPEREGEXP] [REGEXP]\n\
6848 Print a summary of all functions within each Fortran module, grouped by\n\
6849 module and file. For each function the line on which the function is\n\
6850 defined is given along with the type signature and name of the function.\n\
6852 If REGEXP is provided then only functions whose name matches REGEXP are\n\
6853 listed. If MODREGEXP is provided then only functions in modules matching\n\
6854 MODREGEXP are listed. If TYPEREGEXP is given then only functions whose\n\
6855 type signature matches TYPEREGEXP are listed.\n\
6857 The -q flag suppresses printing some header information."),
6858 &info_module_cmdlist
);
6859 set_cmd_completer_handle_brkchars
6860 (c
, info_module_var_func_command_completer
);
6862 c
= add_cmd ("variables", class_info
, info_module_variables_command
, _("\
6863 Display variables arranged by modules.\n\
6864 Usage: info module variables [-q] [-m MODREGEXP] [-t TYPEREGEXP] [REGEXP]\n\
6865 Print a summary of all variables within each Fortran module, grouped by\n\
6866 module and file. For each variable the line on which the variable is\n\
6867 defined is given along with the type and name of the variable.\n\
6869 If REGEXP is provided then only variables whose name matches REGEXP are\n\
6870 listed. If MODREGEXP is provided then only variables in modules matching\n\
6871 MODREGEXP are listed. If TYPEREGEXP is given then only variables whose\n\
6872 type matches TYPEREGEXP are listed.\n\
6874 The -q flag suppresses printing some header information."),
6875 &info_module_cmdlist
);
6876 set_cmd_completer_handle_brkchars
6877 (c
, info_module_var_func_command_completer
);
6879 add_com ("rbreak", class_breakpoint
, rbreak_command
,
6880 _("Set a breakpoint for all functions matching REGEXP."));
6882 add_setshow_enum_cmd ("multiple-symbols", no_class
,
6883 multiple_symbols_modes
, &multiple_symbols_mode
,
6885 Set how the debugger handles ambiguities in expressions."), _("\
6886 Show how the debugger handles ambiguities in expressions."), _("\
6887 Valid values are \"ask\", \"all\", \"cancel\", and the default is \"all\"."),
6888 NULL
, NULL
, &setlist
, &showlist
);
6890 add_setshow_boolean_cmd ("basenames-may-differ", class_obscure
,
6891 &basenames_may_differ
, _("\
6892 Set whether a source file may have multiple base names."), _("\
6893 Show whether a source file may have multiple base names."), _("\
6894 (A \"base name\" is the name of a file with the directory part removed.\n\
6895 Example: The base name of \"/home/user/hello.c\" is \"hello.c\".)\n\
6896 If set, GDB will canonicalize file names (e.g., expand symlinks)\n\
6897 before comparing them. Canonicalization is an expensive operation,\n\
6898 but it allows the same file be known by more than one base name.\n\
6899 If not set (the default), all source files are assumed to have just\n\
6900 one base name, and gdb will do file name comparisons more efficiently."),
6902 &setlist
, &showlist
);
6904 add_setshow_zuinteger_cmd ("symtab-create", no_class
, &symtab_create_debug
,
6905 _("Set debugging of symbol table creation."),
6906 _("Show debugging of symbol table creation."), _("\
6907 When enabled (non-zero), debugging messages are printed when building\n\
6908 symbol tables. A value of 1 (one) normally provides enough information.\n\
6909 A value greater than 1 provides more verbose information."),
6912 &setdebuglist
, &showdebuglist
);
6914 add_setshow_zuinteger_cmd ("symbol-lookup", no_class
, &symbol_lookup_debug
,
6916 Set debugging of symbol lookup."), _("\
6917 Show debugging of symbol lookup."), _("\
6918 When enabled (non-zero), symbol lookups are logged."),
6920 &setdebuglist
, &showdebuglist
);
6922 add_setshow_zuinteger_cmd ("symbol-cache-size", no_class
,
6923 &new_symbol_cache_size
,
6924 _("Set the size of the symbol cache."),
6925 _("Show the size of the symbol cache."), _("\
6926 The size of the symbol cache.\n\
6927 If zero then the symbol cache is disabled."),
6928 set_symbol_cache_size_handler
, NULL
,
6929 &maintenance_set_cmdlist
,
6930 &maintenance_show_cmdlist
);
6932 add_cmd ("symbol-cache", class_maintenance
, maintenance_print_symbol_cache
,
6933 _("Dump the symbol cache for each program space."),
6934 &maintenanceprintlist
);
6936 add_cmd ("symbol-cache-statistics", class_maintenance
,
6937 maintenance_print_symbol_cache_statistics
,
6938 _("Print symbol cache statistics for each program space."),
6939 &maintenanceprintlist
);
6941 add_cmd ("flush-symbol-cache", class_maintenance
,
6942 maintenance_flush_symbol_cache
,
6943 _("Flush the symbol cache for each program space."),
6946 gdb::observers::executable_changed
.attach (symtab_observer_executable_changed
);
6947 gdb::observers::new_objfile
.attach (symtab_new_objfile_observer
);
6948 gdb::observers::free_objfile
.attach (symtab_free_objfile_observer
);