1 /* Symbol table lookup for the GNU debugger, GDB.
3 Copyright (C) 1986-2019 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 /* Symbols don't specify global vs static block.
187 So keep them in separate caches. */
189 struct block_symbol_cache
193 unsigned int collisions
;
195 /* SYMBOLS is a variable length array of this size.
196 One can imagine that in general one cache (global/static) should be a
197 fraction of the size of the other, but there's no data at the moment
198 on which to decide. */
201 struct symbol_cache_slot symbols
[1];
206 Searching for symbols in the static and global blocks over multiple objfiles
207 again and again can be slow, as can searching very big objfiles. This is a
208 simple cache to improve symbol lookup performance, which is critical to
209 overall gdb performance.
211 Symbols are hashed on the name, its domain, and block.
212 They are also hashed on their objfile for objfile-specific lookups. */
216 symbol_cache () = default;
220 xfree (global_symbols
);
221 xfree (static_symbols
);
224 struct block_symbol_cache
*global_symbols
= nullptr;
225 struct block_symbol_cache
*static_symbols
= nullptr;
228 /* Program space key for finding its symbol cache. */
230 static const program_space_key
<symbol_cache
> symbol_cache_key
;
232 /* When non-zero, print debugging messages related to symtab creation. */
233 unsigned int symtab_create_debug
= 0;
235 /* When non-zero, print debugging messages related to symbol lookup. */
236 unsigned int symbol_lookup_debug
= 0;
238 /* The size of the cache is staged here. */
239 static unsigned int new_symbol_cache_size
= DEFAULT_SYMBOL_CACHE_SIZE
;
241 /* The current value of the symbol cache size.
242 This is saved so that if the user enters a value too big we can restore
243 the original value from here. */
244 static unsigned int symbol_cache_size
= DEFAULT_SYMBOL_CACHE_SIZE
;
246 /* True if a file may be known by two different basenames.
247 This is the uncommon case, and significantly slows down gdb.
248 Default set to "off" to not slow down the common case. */
249 bool basenames_may_differ
= false;
251 /* Allow the user to configure the debugger behavior with respect
252 to multiple-choice menus when more than one symbol matches during
255 const char multiple_symbols_ask
[] = "ask";
256 const char multiple_symbols_all
[] = "all";
257 const char multiple_symbols_cancel
[] = "cancel";
258 static const char *const multiple_symbols_modes
[] =
260 multiple_symbols_ask
,
261 multiple_symbols_all
,
262 multiple_symbols_cancel
,
265 static const char *multiple_symbols_mode
= multiple_symbols_all
;
267 /* Read-only accessor to AUTO_SELECT_MODE. */
270 multiple_symbols_select_mode (void)
272 return multiple_symbols_mode
;
275 /* Return the name of a domain_enum. */
278 domain_name (domain_enum e
)
282 case UNDEF_DOMAIN
: return "UNDEF_DOMAIN";
283 case VAR_DOMAIN
: return "VAR_DOMAIN";
284 case STRUCT_DOMAIN
: return "STRUCT_DOMAIN";
285 case MODULE_DOMAIN
: return "MODULE_DOMAIN";
286 case LABEL_DOMAIN
: return "LABEL_DOMAIN";
287 case COMMON_BLOCK_DOMAIN
: return "COMMON_BLOCK_DOMAIN";
288 default: gdb_assert_not_reached ("bad domain_enum");
292 /* Return the name of a search_domain . */
295 search_domain_name (enum search_domain e
)
299 case VARIABLES_DOMAIN
: return "VARIABLES_DOMAIN";
300 case FUNCTIONS_DOMAIN
: return "FUNCTIONS_DOMAIN";
301 case TYPES_DOMAIN
: return "TYPES_DOMAIN";
302 case ALL_DOMAIN
: return "ALL_DOMAIN";
303 default: gdb_assert_not_reached ("bad search_domain");
310 compunit_primary_filetab (const struct compunit_symtab
*cust
)
312 gdb_assert (COMPUNIT_FILETABS (cust
) != NULL
);
314 /* The primary file symtab is the first one in the list. */
315 return COMPUNIT_FILETABS (cust
);
321 compunit_language (const struct compunit_symtab
*cust
)
323 struct symtab
*symtab
= compunit_primary_filetab (cust
);
325 /* The language of the compunit symtab is the language of its primary
327 return SYMTAB_LANGUAGE (symtab
);
333 minimal_symbol::data_p () const
335 return type
== mst_data
338 || type
== mst_file_data
339 || type
== mst_file_bss
;
345 minimal_symbol::text_p () const
347 return type
== mst_text
348 || type
== mst_text_gnu_ifunc
349 || type
== mst_data_gnu_ifunc
350 || type
== mst_slot_got_plt
351 || type
== mst_solib_trampoline
352 || type
== mst_file_text
;
355 /* See whether FILENAME matches SEARCH_NAME using the rule that we
356 advertise to the user. (The manual's description of linespecs
357 describes what we advertise). Returns true if they match, false
361 compare_filenames_for_search (const char *filename
, const char *search_name
)
363 int len
= strlen (filename
);
364 size_t search_len
= strlen (search_name
);
366 if (len
< search_len
)
369 /* The tail of FILENAME must match. */
370 if (FILENAME_CMP (filename
+ len
- search_len
, search_name
) != 0)
373 /* Either the names must completely match, or the character
374 preceding the trailing SEARCH_NAME segment of FILENAME must be a
377 The check !IS_ABSOLUTE_PATH ensures SEARCH_NAME "/dir/file.c"
378 cannot match FILENAME "/path//dir/file.c" - as user has requested
379 absolute path. The sama applies for "c:\file.c" possibly
380 incorrectly hypothetically matching "d:\dir\c:\file.c".
382 The HAS_DRIVE_SPEC purpose is to make FILENAME "c:file.c"
383 compatible with SEARCH_NAME "file.c". In such case a compiler had
384 to put the "c:file.c" name into debug info. Such compatibility
385 works only on GDB built for DOS host. */
386 return (len
== search_len
387 || (!IS_ABSOLUTE_PATH (search_name
)
388 && IS_DIR_SEPARATOR (filename
[len
- search_len
- 1]))
389 || (HAS_DRIVE_SPEC (filename
)
390 && STRIP_DRIVE_SPEC (filename
) == &filename
[len
- search_len
]));
393 /* Same as compare_filenames_for_search, but for glob-style patterns.
394 Heads up on the order of the arguments. They match the order of
395 compare_filenames_for_search, but it's the opposite of the order of
396 arguments to gdb_filename_fnmatch. */
399 compare_glob_filenames_for_search (const char *filename
,
400 const char *search_name
)
402 /* We rely on the property of glob-style patterns with FNM_FILE_NAME that
403 all /s have to be explicitly specified. */
404 int file_path_elements
= count_path_elements (filename
);
405 int search_path_elements
= count_path_elements (search_name
);
407 if (search_path_elements
> file_path_elements
)
410 if (IS_ABSOLUTE_PATH (search_name
))
412 return (search_path_elements
== file_path_elements
413 && gdb_filename_fnmatch (search_name
, filename
,
414 FNM_FILE_NAME
| FNM_NOESCAPE
) == 0);
418 const char *file_to_compare
419 = strip_leading_path_elements (filename
,
420 file_path_elements
- search_path_elements
);
422 return gdb_filename_fnmatch (search_name
, file_to_compare
,
423 FNM_FILE_NAME
| FNM_NOESCAPE
) == 0;
427 /* Check for a symtab of a specific name by searching some symtabs.
428 This is a helper function for callbacks of iterate_over_symtabs.
430 If NAME is not absolute, then REAL_PATH is NULL
431 If NAME is absolute, then REAL_PATH is the gdb_realpath form of NAME.
433 The return value, NAME, REAL_PATH and CALLBACK are identical to the
434 `map_symtabs_matching_filename' method of quick_symbol_functions.
436 FIRST and AFTER_LAST indicate the range of compunit symtabs to search.
437 Each symtab within the specified compunit symtab is also searched.
438 AFTER_LAST is one past the last compunit symtab to search; NULL means to
439 search until the end of the list. */
442 iterate_over_some_symtabs (const char *name
,
443 const char *real_path
,
444 struct compunit_symtab
*first
,
445 struct compunit_symtab
*after_last
,
446 gdb::function_view
<bool (symtab
*)> callback
)
448 struct compunit_symtab
*cust
;
449 const char* base_name
= lbasename (name
);
451 for (cust
= first
; cust
!= NULL
&& cust
!= after_last
; cust
= cust
->next
)
453 for (symtab
*s
: compunit_filetabs (cust
))
455 if (compare_filenames_for_search (s
->filename
, name
))
462 /* Before we invoke realpath, which can get expensive when many
463 files are involved, do a quick comparison of the basenames. */
464 if (! basenames_may_differ
465 && FILENAME_CMP (base_name
, lbasename (s
->filename
)) != 0)
468 if (compare_filenames_for_search (symtab_to_fullname (s
), name
))
475 /* If the user gave us an absolute path, try to find the file in
476 this symtab and use its absolute path. */
477 if (real_path
!= NULL
)
479 const char *fullname
= symtab_to_fullname (s
);
481 gdb_assert (IS_ABSOLUTE_PATH (real_path
));
482 gdb_assert (IS_ABSOLUTE_PATH (name
));
483 if (FILENAME_CMP (real_path
, fullname
) == 0)
496 /* Check for a symtab of a specific name; first in symtabs, then in
497 psymtabs. *If* there is no '/' in the name, a match after a '/'
498 in the symtab filename will also work.
500 Calls CALLBACK with each symtab that is found. If CALLBACK returns
501 true, the search stops. */
504 iterate_over_symtabs (const char *name
,
505 gdb::function_view
<bool (symtab
*)> callback
)
507 gdb::unique_xmalloc_ptr
<char> real_path
;
509 /* Here we are interested in canonicalizing an absolute path, not
510 absolutizing a relative path. */
511 if (IS_ABSOLUTE_PATH (name
))
513 real_path
= gdb_realpath (name
);
514 gdb_assert (IS_ABSOLUTE_PATH (real_path
.get ()));
517 for (objfile
*objfile
: current_program_space
->objfiles ())
519 if (iterate_over_some_symtabs (name
, real_path
.get (),
520 objfile
->compunit_symtabs
, NULL
,
525 /* Same search rules as above apply here, but now we look thru the
528 for (objfile
*objfile
: current_program_space
->objfiles ())
531 && objfile
->sf
->qf
->map_symtabs_matching_filename (objfile
,
539 /* A wrapper for iterate_over_symtabs that returns the first matching
543 lookup_symtab (const char *name
)
545 struct symtab
*result
= NULL
;
547 iterate_over_symtabs (name
, [&] (symtab
*symtab
)
557 /* Mangle a GDB method stub type. This actually reassembles the pieces of the
558 full method name, which consist of the class name (from T), the unadorned
559 method name from METHOD_ID, and the signature for the specific overload,
560 specified by SIGNATURE_ID. Note that this function is g++ specific. */
563 gdb_mangle_name (struct type
*type
, int method_id
, int signature_id
)
565 int mangled_name_len
;
567 struct fn_field
*f
= TYPE_FN_FIELDLIST1 (type
, method_id
);
568 struct fn_field
*method
= &f
[signature_id
];
569 const char *field_name
= TYPE_FN_FIELDLIST_NAME (type
, method_id
);
570 const char *physname
= TYPE_FN_FIELD_PHYSNAME (f
, signature_id
);
571 const char *newname
= TYPE_NAME (type
);
573 /* Does the form of physname indicate that it is the full mangled name
574 of a constructor (not just the args)? */
575 int is_full_physname_constructor
;
578 int is_destructor
= is_destructor_name (physname
);
579 /* Need a new type prefix. */
580 const char *const_prefix
= method
->is_const
? "C" : "";
581 const char *volatile_prefix
= method
->is_volatile
? "V" : "";
583 int len
= (newname
== NULL
? 0 : strlen (newname
));
585 /* Nothing to do if physname already contains a fully mangled v3 abi name
586 or an operator name. */
587 if ((physname
[0] == '_' && physname
[1] == 'Z')
588 || is_operator_name (field_name
))
589 return xstrdup (physname
);
591 is_full_physname_constructor
= is_constructor_name (physname
);
593 is_constructor
= is_full_physname_constructor
594 || (newname
&& strcmp (field_name
, newname
) == 0);
597 is_destructor
= (startswith (physname
, "__dt"));
599 if (is_destructor
|| is_full_physname_constructor
)
601 mangled_name
= (char *) xmalloc (strlen (physname
) + 1);
602 strcpy (mangled_name
, physname
);
608 xsnprintf (buf
, sizeof (buf
), "__%s%s", const_prefix
, volatile_prefix
);
610 else if (physname
[0] == 't' || physname
[0] == 'Q')
612 /* The physname for template and qualified methods already includes
614 xsnprintf (buf
, sizeof (buf
), "__%s%s", const_prefix
, volatile_prefix
);
620 xsnprintf (buf
, sizeof (buf
), "__%s%s%d", const_prefix
,
621 volatile_prefix
, len
);
623 mangled_name_len
= ((is_constructor
? 0 : strlen (field_name
))
624 + strlen (buf
) + len
+ strlen (physname
) + 1);
626 mangled_name
= (char *) xmalloc (mangled_name_len
);
628 mangled_name
[0] = '\0';
630 strcpy (mangled_name
, field_name
);
632 strcat (mangled_name
, buf
);
633 /* If the class doesn't have a name, i.e. newname NULL, then we just
634 mangle it using 0 for the length of the class. Thus it gets mangled
635 as something starting with `::' rather than `classname::'. */
637 strcat (mangled_name
, newname
);
639 strcat (mangled_name
, physname
);
640 return (mangled_name
);
643 /* Set the demangled name of GSYMBOL to NAME. NAME must be already
644 correctly allocated. */
647 symbol_set_demangled_name (struct general_symbol_info
*gsymbol
,
649 struct obstack
*obstack
)
651 if (gsymbol
->language
== language_ada
)
655 gsymbol
->ada_mangled
= 0;
656 gsymbol
->language_specific
.obstack
= obstack
;
660 gsymbol
->ada_mangled
= 1;
661 gsymbol
->language_specific
.demangled_name
= name
;
665 gsymbol
->language_specific
.demangled_name
= name
;
668 /* Return the demangled name of GSYMBOL. */
671 symbol_get_demangled_name (const struct general_symbol_info
*gsymbol
)
673 if (gsymbol
->language
== language_ada
)
675 if (!gsymbol
->ada_mangled
)
680 return gsymbol
->language_specific
.demangled_name
;
684 /* Initialize the language dependent portion of a symbol
685 depending upon the language for the symbol. */
688 symbol_set_language (struct general_symbol_info
*gsymbol
,
689 enum language language
,
690 struct obstack
*obstack
)
692 gsymbol
->language
= language
;
693 if (gsymbol
->language
== language_cplus
694 || gsymbol
->language
== language_d
695 || gsymbol
->language
== language_go
696 || gsymbol
->language
== language_objc
697 || gsymbol
->language
== language_fortran
)
699 symbol_set_demangled_name (gsymbol
, NULL
, obstack
);
701 else if (gsymbol
->language
== language_ada
)
703 gdb_assert (gsymbol
->ada_mangled
== 0);
704 gsymbol
->language_specific
.obstack
= obstack
;
708 memset (&gsymbol
->language_specific
, 0,
709 sizeof (gsymbol
->language_specific
));
713 /* Functions to initialize a symbol's mangled name. */
715 /* Objects of this type are stored in the demangled name hash table. */
716 struct demangled_name_entry
718 demangled_name_entry (gdb::string_view mangled_name
)
719 : mangled (mangled_name
) {}
721 gdb::string_view mangled
;
722 ENUM_BITFIELD(language
) language
: LANGUAGE_BITS
;
726 /* Hash function for the demangled name hash. */
729 hash_demangled_name_entry (const void *data
)
731 const struct demangled_name_entry
*e
732 = (const struct demangled_name_entry
*) data
;
734 return fast_hash (e
->mangled
.data (), e
->mangled
.length ());
737 /* Equality function for the demangled name hash. */
740 eq_demangled_name_entry (const void *a
, const void *b
)
742 const struct demangled_name_entry
*da
743 = (const struct demangled_name_entry
*) a
;
744 const struct demangled_name_entry
*db
745 = (const struct demangled_name_entry
*) b
;
747 return da
->mangled
== db
->mangled
;
751 free_demangled_name_entry (void *data
)
753 struct demangled_name_entry
*e
754 = (struct demangled_name_entry
*) data
;
756 e
->~demangled_name_entry();
759 /* Create the hash table used for demangled names. Each hash entry is
760 a pair of strings; one for the mangled name and one for the demangled
761 name. The entry is hashed via just the mangled name. */
764 create_demangled_names_hash (struct objfile_per_bfd_storage
*per_bfd
)
766 /* Choose 256 as the starting size of the hash table, somewhat arbitrarily.
767 The hash table code will round this up to the next prime number.
768 Choosing a much larger table size wastes memory, and saves only about
769 1% in symbol reading. */
771 per_bfd
->demangled_names_hash
.reset (htab_create_alloc
772 (256, hash_demangled_name_entry
, eq_demangled_name_entry
,
773 free_demangled_name_entry
, xcalloc
, xfree
));
776 /* Try to determine the demangled name for a symbol, based on the
777 language of that symbol. If the language is set to language_auto,
778 it will attempt to find any demangling algorithm that works and
779 then set the language appropriately. The returned name is allocated
780 by the demangler and should be xfree'd. */
783 symbol_find_demangled_name (struct general_symbol_info
*gsymbol
,
786 char *demangled
= NULL
;
789 if (gsymbol
->language
== language_unknown
)
790 gsymbol
->language
= language_auto
;
792 if (gsymbol
->language
!= language_auto
)
794 const struct language_defn
*lang
= language_def (gsymbol
->language
);
796 language_sniff_from_mangled_name (lang
, mangled
, &demangled
);
800 for (i
= language_unknown
; i
< nr_languages
; ++i
)
802 enum language l
= (enum language
) i
;
803 const struct language_defn
*lang
= language_def (l
);
805 if (language_sniff_from_mangled_name (lang
, mangled
, &demangled
))
807 gsymbol
->language
= l
;
815 /* Set both the mangled and demangled (if any) names for GSYMBOL based
816 on LINKAGE_NAME and LEN. Ordinarily, NAME is copied onto the
817 objfile's obstack; but if COPY_NAME is 0 and if NAME is
818 NUL-terminated, then this function assumes that NAME is already
819 correctly saved (either permanently or with a lifetime tied to the
820 objfile), and it will not be copied.
822 The hash table corresponding to OBJFILE is used, and the memory
823 comes from the per-BFD storage_obstack. LINKAGE_NAME is copied,
824 so the pointer can be discarded after calling this function. */
827 symbol_set_names (struct general_symbol_info
*gsymbol
,
828 const char *linkage_name
, int len
, bool copy_name
,
829 struct objfile_per_bfd_storage
*per_bfd
)
831 struct demangled_name_entry
**slot
;
832 /* A 0-terminated copy of the linkage name. */
833 const char *linkage_name_copy
;
835 if (gsymbol
->language
== language_ada
)
837 /* In Ada, we do the symbol lookups using the mangled name, so
838 we can save some space by not storing the demangled name. */
840 gsymbol
->name
= linkage_name
;
843 char *name
= (char *) obstack_alloc (&per_bfd
->storage_obstack
,
846 memcpy (name
, linkage_name
, len
);
848 gsymbol
->name
= name
;
850 symbol_set_demangled_name (gsymbol
, NULL
, &per_bfd
->storage_obstack
);
855 if (per_bfd
->demangled_names_hash
== NULL
)
856 create_demangled_names_hash (per_bfd
);
858 if (linkage_name
[len
] != '\0')
862 alloc_name
= (char *) alloca (len
+ 1);
863 memcpy (alloc_name
, linkage_name
, len
);
864 alloc_name
[len
] = '\0';
866 linkage_name_copy
= alloc_name
;
869 linkage_name_copy
= linkage_name
;
871 struct demangled_name_entry
entry (gdb::string_view (linkage_name_copy
, len
));
872 slot
= ((struct demangled_name_entry
**)
873 htab_find_slot (per_bfd
->demangled_names_hash
.get (),
876 /* If this name is not in the hash table, add it. */
878 /* A C version of the symbol may have already snuck into the table.
879 This happens to, e.g., main.init (__go_init_main). Cope. */
880 || (gsymbol
->language
== language_go
881 && (*slot
)->demangled
[0] == '\0'))
883 char *demangled_name_ptr
884 = symbol_find_demangled_name (gsymbol
, linkage_name_copy
);
885 gdb::unique_xmalloc_ptr
<char> demangled_name (demangled_name_ptr
);
886 int demangled_len
= demangled_name
? strlen (demangled_name
.get ()) : 0;
888 /* Suppose we have demangled_name==NULL, copy_name==0, and
889 linkage_name_copy==linkage_name. In this case, we already have the
890 mangled name saved, and we don't have a demangled name. So,
891 you might think we could save a little space by not recording
892 this in the hash table at all.
894 It turns out that it is actually important to still save such
895 an entry in the hash table, because storing this name gives
896 us better bcache hit rates for partial symbols. */
897 if (!copy_name
&& linkage_name_copy
== linkage_name
)
900 = ((struct demangled_name_entry
*)
901 obstack_alloc (&per_bfd
->storage_obstack
,
902 offsetof (struct demangled_name_entry
, demangled
)
903 + demangled_len
+ 1));
904 new (*slot
) demangled_name_entry
905 (gdb::string_view (linkage_name
, len
));
911 /* If we must copy the mangled name, put it directly after
912 the demangled name so we can have a single
915 = ((struct demangled_name_entry
*)
916 obstack_alloc (&per_bfd
->storage_obstack
,
917 offsetof (struct demangled_name_entry
, demangled
)
918 + len
+ demangled_len
+ 2));
919 mangled_ptr
= &((*slot
)->demangled
[demangled_len
+ 1]);
920 strcpy (mangled_ptr
, linkage_name_copy
);
921 new (*slot
) demangled_name_entry
922 (gdb::string_view (mangled_ptr
, len
));
924 (*slot
)->language
= gsymbol
->language
;
926 if (demangled_name
!= NULL
)
927 strcpy ((*slot
)->demangled
, demangled_name
.get ());
929 (*slot
)->demangled
[0] = '\0';
931 else if (gsymbol
->language
== language_unknown
932 || gsymbol
->language
== language_auto
)
933 gsymbol
->language
= (*slot
)->language
;
935 gsymbol
->name
= (*slot
)->mangled
.data ();
936 if ((*slot
)->demangled
[0] != '\0')
937 symbol_set_demangled_name (gsymbol
, (*slot
)->demangled
,
938 &per_bfd
->storage_obstack
);
940 symbol_set_demangled_name (gsymbol
, NULL
, &per_bfd
->storage_obstack
);
943 /* Return the source code name of a symbol. In languages where
944 demangling is necessary, this is the demangled name. */
947 symbol_natural_name (const struct general_symbol_info
*gsymbol
)
949 switch (gsymbol
->language
)
955 case language_fortran
:
956 if (symbol_get_demangled_name (gsymbol
) != NULL
)
957 return symbol_get_demangled_name (gsymbol
);
960 return ada_decode_symbol (gsymbol
);
964 return gsymbol
->name
;
967 /* Return the demangled name for a symbol based on the language for
968 that symbol. If no demangled name exists, return NULL. */
971 symbol_demangled_name (const struct general_symbol_info
*gsymbol
)
973 const char *dem_name
= NULL
;
975 switch (gsymbol
->language
)
981 case language_fortran
:
982 dem_name
= symbol_get_demangled_name (gsymbol
);
985 dem_name
= ada_decode_symbol (gsymbol
);
993 /* Return the search name of a symbol---generally the demangled or
994 linkage name of the symbol, depending on how it will be searched for.
995 If there is no distinct demangled name, then returns the same value
996 (same pointer) as SYMBOL_LINKAGE_NAME. */
999 symbol_search_name (const struct general_symbol_info
*gsymbol
)
1001 if (gsymbol
->language
== language_ada
)
1002 return gsymbol
->name
;
1004 return symbol_natural_name (gsymbol
);
1010 symbol_matches_search_name (const struct general_symbol_info
*gsymbol
,
1011 const lookup_name_info
&name
)
1013 symbol_name_matcher_ftype
*name_match
1014 = get_symbol_name_matcher (language_def (gsymbol
->language
), name
);
1015 return name_match (symbol_search_name (gsymbol
), name
, NULL
);
1020 /* Return true if the two sections are the same, or if they could
1021 plausibly be copies of each other, one in an original object
1022 file and another in a separated debug file. */
1025 matching_obj_sections (struct obj_section
*obj_first
,
1026 struct obj_section
*obj_second
)
1028 asection
*first
= obj_first
? obj_first
->the_bfd_section
: NULL
;
1029 asection
*second
= obj_second
? obj_second
->the_bfd_section
: NULL
;
1031 /* If they're the same section, then they match. */
1032 if (first
== second
)
1035 /* If either is NULL, give up. */
1036 if (first
== NULL
|| second
== NULL
)
1039 /* This doesn't apply to absolute symbols. */
1040 if (first
->owner
== NULL
|| second
->owner
== NULL
)
1043 /* If they're in the same object file, they must be different sections. */
1044 if (first
->owner
== second
->owner
)
1047 /* Check whether the two sections are potentially corresponding. They must
1048 have the same size, address, and name. We can't compare section indexes,
1049 which would be more reliable, because some sections may have been
1051 if (bfd_section_size (first
) != bfd_section_size (second
))
1054 /* In-memory addresses may start at a different offset, relativize them. */
1055 if (bfd_section_vma (first
) - bfd_get_start_address (first
->owner
)
1056 != bfd_section_vma (second
) - bfd_get_start_address (second
->owner
))
1059 if (bfd_section_name (first
) == NULL
1060 || bfd_section_name (second
) == NULL
1061 || strcmp (bfd_section_name (first
), bfd_section_name (second
)) != 0)
1064 /* Otherwise check that they are in corresponding objfiles. */
1066 struct objfile
*obj
= NULL
;
1067 for (objfile
*objfile
: current_program_space
->objfiles ())
1068 if (objfile
->obfd
== first
->owner
)
1073 gdb_assert (obj
!= NULL
);
1075 if (obj
->separate_debug_objfile
!= NULL
1076 && obj
->separate_debug_objfile
->obfd
== second
->owner
)
1078 if (obj
->separate_debug_objfile_backlink
!= NULL
1079 && obj
->separate_debug_objfile_backlink
->obfd
== second
->owner
)
1088 expand_symtab_containing_pc (CORE_ADDR pc
, struct obj_section
*section
)
1090 struct bound_minimal_symbol msymbol
;
1092 /* If we know that this is not a text address, return failure. This is
1093 necessary because we loop based on texthigh and textlow, which do
1094 not include the data ranges. */
1095 msymbol
= lookup_minimal_symbol_by_pc_section (pc
, section
);
1096 if (msymbol
.minsym
&& msymbol
.minsym
->data_p ())
1099 for (objfile
*objfile
: current_program_space
->objfiles ())
1101 struct compunit_symtab
*cust
= NULL
;
1104 cust
= objfile
->sf
->qf
->find_pc_sect_compunit_symtab (objfile
, msymbol
,
1111 /* Hash function for the symbol cache. */
1114 hash_symbol_entry (const struct objfile
*objfile_context
,
1115 const char *name
, domain_enum domain
)
1117 unsigned int hash
= (uintptr_t) objfile_context
;
1120 hash
+= htab_hash_string (name
);
1122 /* Because of symbol_matches_domain we need VAR_DOMAIN and STRUCT_DOMAIN
1123 to map to the same slot. */
1124 if (domain
== STRUCT_DOMAIN
)
1125 hash
+= VAR_DOMAIN
* 7;
1132 /* Equality function for the symbol cache. */
1135 eq_symbol_entry (const struct symbol_cache_slot
*slot
,
1136 const struct objfile
*objfile_context
,
1137 const char *name
, domain_enum domain
)
1139 const char *slot_name
;
1140 domain_enum slot_domain
;
1142 if (slot
->state
== SYMBOL_SLOT_UNUSED
)
1145 if (slot
->objfile_context
!= objfile_context
)
1148 if (slot
->state
== SYMBOL_SLOT_NOT_FOUND
)
1150 slot_name
= slot
->value
.not_found
.name
;
1151 slot_domain
= slot
->value
.not_found
.domain
;
1155 slot_name
= SYMBOL_SEARCH_NAME (slot
->value
.found
.symbol
);
1156 slot_domain
= SYMBOL_DOMAIN (slot
->value
.found
.symbol
);
1159 /* NULL names match. */
1160 if (slot_name
== NULL
&& name
== NULL
)
1162 /* But there's no point in calling symbol_matches_domain in the
1163 SYMBOL_SLOT_FOUND case. */
1164 if (slot_domain
!= domain
)
1167 else if (slot_name
!= NULL
&& name
!= NULL
)
1169 /* It's important that we use the same comparison that was done
1170 the first time through. If the slot records a found symbol,
1171 then this means using the symbol name comparison function of
1172 the symbol's language with SYMBOL_SEARCH_NAME. See
1173 dictionary.c. It also means using symbol_matches_domain for
1174 found symbols. See block.c.
1176 If the slot records a not-found symbol, then require a precise match.
1177 We could still be lax with whitespace like strcmp_iw though. */
1179 if (slot
->state
== SYMBOL_SLOT_NOT_FOUND
)
1181 if (strcmp (slot_name
, name
) != 0)
1183 if (slot_domain
!= domain
)
1188 struct symbol
*sym
= slot
->value
.found
.symbol
;
1189 lookup_name_info
lookup_name (name
, symbol_name_match_type::FULL
);
1191 if (!SYMBOL_MATCHES_SEARCH_NAME (sym
, lookup_name
))
1194 if (!symbol_matches_domain (SYMBOL_LANGUAGE (sym
),
1195 slot_domain
, domain
))
1201 /* Only one name is NULL. */
1208 /* Given a cache of size SIZE, return the size of the struct (with variable
1209 length array) in bytes. */
1212 symbol_cache_byte_size (unsigned int size
)
1214 return (sizeof (struct block_symbol_cache
)
1215 + ((size
- 1) * sizeof (struct symbol_cache_slot
)));
1221 resize_symbol_cache (struct symbol_cache
*cache
, unsigned int new_size
)
1223 /* If there's no change in size, don't do anything.
1224 All caches have the same size, so we can just compare with the size
1225 of the global symbols cache. */
1226 if ((cache
->global_symbols
!= NULL
1227 && cache
->global_symbols
->size
== new_size
)
1228 || (cache
->global_symbols
== NULL
1232 xfree (cache
->global_symbols
);
1233 xfree (cache
->static_symbols
);
1237 cache
->global_symbols
= NULL
;
1238 cache
->static_symbols
= NULL
;
1242 size_t total_size
= symbol_cache_byte_size (new_size
);
1244 cache
->global_symbols
1245 = (struct block_symbol_cache
*) xcalloc (1, total_size
);
1246 cache
->static_symbols
1247 = (struct block_symbol_cache
*) xcalloc (1, total_size
);
1248 cache
->global_symbols
->size
= new_size
;
1249 cache
->static_symbols
->size
= new_size
;
1253 /* Return the symbol cache of PSPACE.
1254 Create one if it doesn't exist yet. */
1256 static struct symbol_cache
*
1257 get_symbol_cache (struct program_space
*pspace
)
1259 struct symbol_cache
*cache
= symbol_cache_key
.get (pspace
);
1263 cache
= symbol_cache_key
.emplace (pspace
);
1264 resize_symbol_cache (cache
, symbol_cache_size
);
1270 /* Set the size of the symbol cache in all program spaces. */
1273 set_symbol_cache_size (unsigned int new_size
)
1275 struct program_space
*pspace
;
1277 ALL_PSPACES (pspace
)
1279 struct symbol_cache
*cache
= symbol_cache_key
.get (pspace
);
1281 /* The pspace could have been created but not have a cache yet. */
1283 resize_symbol_cache (cache
, new_size
);
1287 /* Called when symbol-cache-size is set. */
1290 set_symbol_cache_size_handler (const char *args
, int from_tty
,
1291 struct cmd_list_element
*c
)
1293 if (new_symbol_cache_size
> MAX_SYMBOL_CACHE_SIZE
)
1295 /* Restore the previous value.
1296 This is the value the "show" command prints. */
1297 new_symbol_cache_size
= symbol_cache_size
;
1299 error (_("Symbol cache size is too large, max is %u."),
1300 MAX_SYMBOL_CACHE_SIZE
);
1302 symbol_cache_size
= new_symbol_cache_size
;
1304 set_symbol_cache_size (symbol_cache_size
);
1307 /* Lookup symbol NAME,DOMAIN in BLOCK in the symbol cache of PSPACE.
1308 OBJFILE_CONTEXT is the current objfile, which may be NULL.
1309 The result is the symbol if found, SYMBOL_LOOKUP_FAILED if a previous lookup
1310 failed (and thus this one will too), or NULL if the symbol is not present
1312 *BSC_PTR and *SLOT_PTR are set to the cache and slot of the symbol, which
1313 can be used to save the result of a full lookup attempt. */
1315 static struct block_symbol
1316 symbol_cache_lookup (struct symbol_cache
*cache
,
1317 struct objfile
*objfile_context
, enum block_enum block
,
1318 const char *name
, domain_enum domain
,
1319 struct block_symbol_cache
**bsc_ptr
,
1320 struct symbol_cache_slot
**slot_ptr
)
1322 struct block_symbol_cache
*bsc
;
1324 struct symbol_cache_slot
*slot
;
1326 if (block
== GLOBAL_BLOCK
)
1327 bsc
= cache
->global_symbols
;
1329 bsc
= cache
->static_symbols
;
1337 hash
= hash_symbol_entry (objfile_context
, name
, domain
);
1338 slot
= bsc
->symbols
+ hash
% bsc
->size
;
1343 if (eq_symbol_entry (slot
, objfile_context
, name
, domain
))
1345 if (symbol_lookup_debug
)
1346 fprintf_unfiltered (gdb_stdlog
,
1347 "%s block symbol cache hit%s for %s, %s\n",
1348 block
== GLOBAL_BLOCK
? "Global" : "Static",
1349 slot
->state
== SYMBOL_SLOT_NOT_FOUND
1350 ? " (not found)" : "",
1351 name
, domain_name (domain
));
1353 if (slot
->state
== SYMBOL_SLOT_NOT_FOUND
)
1354 return SYMBOL_LOOKUP_FAILED
;
1355 return slot
->value
.found
;
1358 /* Symbol is not present in the cache. */
1360 if (symbol_lookup_debug
)
1362 fprintf_unfiltered (gdb_stdlog
,
1363 "%s block symbol cache miss for %s, %s\n",
1364 block
== GLOBAL_BLOCK
? "Global" : "Static",
1365 name
, domain_name (domain
));
1371 /* Clear out SLOT. */
1374 symbol_cache_clear_slot (struct symbol_cache_slot
*slot
)
1376 if (slot
->state
== SYMBOL_SLOT_NOT_FOUND
)
1377 xfree (slot
->value
.not_found
.name
);
1378 slot
->state
= SYMBOL_SLOT_UNUSED
;
1381 /* Mark SYMBOL as found in SLOT.
1382 OBJFILE_CONTEXT is the current objfile when the lookup was done, or NULL
1383 if it's not needed to distinguish lookups (STATIC_BLOCK). It is *not*
1384 necessarily the objfile the symbol was found in. */
1387 symbol_cache_mark_found (struct block_symbol_cache
*bsc
,
1388 struct symbol_cache_slot
*slot
,
1389 struct objfile
*objfile_context
,
1390 struct symbol
*symbol
,
1391 const struct block
*block
)
1395 if (slot
->state
!= SYMBOL_SLOT_UNUSED
)
1398 symbol_cache_clear_slot (slot
);
1400 slot
->state
= SYMBOL_SLOT_FOUND
;
1401 slot
->objfile_context
= objfile_context
;
1402 slot
->value
.found
.symbol
= symbol
;
1403 slot
->value
.found
.block
= block
;
1406 /* Mark symbol NAME, DOMAIN as not found in SLOT.
1407 OBJFILE_CONTEXT is the current objfile when the lookup was done, or NULL
1408 if it's not needed to distinguish lookups (STATIC_BLOCK). */
1411 symbol_cache_mark_not_found (struct block_symbol_cache
*bsc
,
1412 struct symbol_cache_slot
*slot
,
1413 struct objfile
*objfile_context
,
1414 const char *name
, domain_enum domain
)
1418 if (slot
->state
!= SYMBOL_SLOT_UNUSED
)
1421 symbol_cache_clear_slot (slot
);
1423 slot
->state
= SYMBOL_SLOT_NOT_FOUND
;
1424 slot
->objfile_context
= objfile_context
;
1425 slot
->value
.not_found
.name
= xstrdup (name
);
1426 slot
->value
.not_found
.domain
= domain
;
1429 /* Flush the symbol cache of PSPACE. */
1432 symbol_cache_flush (struct program_space
*pspace
)
1434 struct symbol_cache
*cache
= symbol_cache_key
.get (pspace
);
1439 if (cache
->global_symbols
== NULL
)
1441 gdb_assert (symbol_cache_size
== 0);
1442 gdb_assert (cache
->static_symbols
== NULL
);
1446 /* If the cache is untouched since the last flush, early exit.
1447 This is important for performance during the startup of a program linked
1448 with 100s (or 1000s) of shared libraries. */
1449 if (cache
->global_symbols
->misses
== 0
1450 && cache
->static_symbols
->misses
== 0)
1453 gdb_assert (cache
->global_symbols
->size
== symbol_cache_size
);
1454 gdb_assert (cache
->static_symbols
->size
== symbol_cache_size
);
1456 for (pass
= 0; pass
< 2; ++pass
)
1458 struct block_symbol_cache
*bsc
1459 = pass
== 0 ? cache
->global_symbols
: cache
->static_symbols
;
1462 for (i
= 0; i
< bsc
->size
; ++i
)
1463 symbol_cache_clear_slot (&bsc
->symbols
[i
]);
1466 cache
->global_symbols
->hits
= 0;
1467 cache
->global_symbols
->misses
= 0;
1468 cache
->global_symbols
->collisions
= 0;
1469 cache
->static_symbols
->hits
= 0;
1470 cache
->static_symbols
->misses
= 0;
1471 cache
->static_symbols
->collisions
= 0;
1477 symbol_cache_dump (const struct symbol_cache
*cache
)
1481 if (cache
->global_symbols
== NULL
)
1483 printf_filtered (" <disabled>\n");
1487 for (pass
= 0; pass
< 2; ++pass
)
1489 const struct block_symbol_cache
*bsc
1490 = pass
== 0 ? cache
->global_symbols
: cache
->static_symbols
;
1494 printf_filtered ("Global symbols:\n");
1496 printf_filtered ("Static symbols:\n");
1498 for (i
= 0; i
< bsc
->size
; ++i
)
1500 const struct symbol_cache_slot
*slot
= &bsc
->symbols
[i
];
1504 switch (slot
->state
)
1506 case SYMBOL_SLOT_UNUSED
:
1508 case SYMBOL_SLOT_NOT_FOUND
:
1509 printf_filtered (" [%4u] = %s, %s %s (not found)\n", i
,
1510 host_address_to_string (slot
->objfile_context
),
1511 slot
->value
.not_found
.name
,
1512 domain_name (slot
->value
.not_found
.domain
));
1514 case SYMBOL_SLOT_FOUND
:
1516 struct symbol
*found
= slot
->value
.found
.symbol
;
1517 const struct objfile
*context
= slot
->objfile_context
;
1519 printf_filtered (" [%4u] = %s, %s %s\n", i
,
1520 host_address_to_string (context
),
1521 SYMBOL_PRINT_NAME (found
),
1522 domain_name (SYMBOL_DOMAIN (found
)));
1530 /* The "mt print symbol-cache" command. */
1533 maintenance_print_symbol_cache (const char *args
, int from_tty
)
1535 struct program_space
*pspace
;
1537 ALL_PSPACES (pspace
)
1539 struct symbol_cache
*cache
;
1541 printf_filtered (_("Symbol cache for pspace %d\n%s:\n"),
1543 pspace
->symfile_object_file
!= NULL
1544 ? objfile_name (pspace
->symfile_object_file
)
1545 : "(no object file)");
1547 /* If the cache hasn't been created yet, avoid creating one. */
1548 cache
= symbol_cache_key
.get (pspace
);
1550 printf_filtered (" <empty>\n");
1552 symbol_cache_dump (cache
);
1556 /* The "mt flush-symbol-cache" command. */
1559 maintenance_flush_symbol_cache (const char *args
, int from_tty
)
1561 struct program_space
*pspace
;
1563 ALL_PSPACES (pspace
)
1565 symbol_cache_flush (pspace
);
1569 /* Print usage statistics of CACHE. */
1572 symbol_cache_stats (struct symbol_cache
*cache
)
1576 if (cache
->global_symbols
== NULL
)
1578 printf_filtered (" <disabled>\n");
1582 for (pass
= 0; pass
< 2; ++pass
)
1584 const struct block_symbol_cache
*bsc
1585 = pass
== 0 ? cache
->global_symbols
: cache
->static_symbols
;
1590 printf_filtered ("Global block cache stats:\n");
1592 printf_filtered ("Static block cache stats:\n");
1594 printf_filtered (" size: %u\n", bsc
->size
);
1595 printf_filtered (" hits: %u\n", bsc
->hits
);
1596 printf_filtered (" misses: %u\n", bsc
->misses
);
1597 printf_filtered (" collisions: %u\n", bsc
->collisions
);
1601 /* The "mt print symbol-cache-statistics" command. */
1604 maintenance_print_symbol_cache_statistics (const char *args
, int from_tty
)
1606 struct program_space
*pspace
;
1608 ALL_PSPACES (pspace
)
1610 struct symbol_cache
*cache
;
1612 printf_filtered (_("Symbol cache statistics for pspace %d\n%s:\n"),
1614 pspace
->symfile_object_file
!= NULL
1615 ? objfile_name (pspace
->symfile_object_file
)
1616 : "(no object file)");
1618 /* If the cache hasn't been created yet, avoid creating one. */
1619 cache
= symbol_cache_key
.get (pspace
);
1621 printf_filtered (" empty, no stats available\n");
1623 symbol_cache_stats (cache
);
1627 /* This module's 'new_objfile' observer. */
1630 symtab_new_objfile_observer (struct objfile
*objfile
)
1632 /* Ideally we'd use OBJFILE->pspace, but OBJFILE may be NULL. */
1633 symbol_cache_flush (current_program_space
);
1636 /* This module's 'free_objfile' observer. */
1639 symtab_free_objfile_observer (struct objfile
*objfile
)
1641 symbol_cache_flush (objfile
->pspace
);
1644 /* Debug symbols usually don't have section information. We need to dig that
1645 out of the minimal symbols and stash that in the debug symbol. */
1648 fixup_section (struct general_symbol_info
*ginfo
,
1649 CORE_ADDR addr
, struct objfile
*objfile
)
1651 struct minimal_symbol
*msym
;
1653 /* First, check whether a minimal symbol with the same name exists
1654 and points to the same address. The address check is required
1655 e.g. on PowerPC64, where the minimal symbol for a function will
1656 point to the function descriptor, while the debug symbol will
1657 point to the actual function code. */
1658 msym
= lookup_minimal_symbol_by_pc_name (addr
, ginfo
->name
, objfile
);
1660 ginfo
->section
= MSYMBOL_SECTION (msym
);
1663 /* Static, function-local variables do appear in the linker
1664 (minimal) symbols, but are frequently given names that won't
1665 be found via lookup_minimal_symbol(). E.g., it has been
1666 observed in frv-uclinux (ELF) executables that a static,
1667 function-local variable named "foo" might appear in the
1668 linker symbols as "foo.6" or "foo.3". Thus, there is no
1669 point in attempting to extend the lookup-by-name mechanism to
1670 handle this case due to the fact that there can be multiple
1673 So, instead, search the section table when lookup by name has
1674 failed. The ``addr'' and ``endaddr'' fields may have already
1675 been relocated. If so, the relocation offset (i.e. the
1676 ANOFFSET value) needs to be subtracted from these values when
1677 performing the comparison. We unconditionally subtract it,
1678 because, when no relocation has been performed, the ANOFFSET
1679 value will simply be zero.
1681 The address of the symbol whose section we're fixing up HAS
1682 NOT BEEN adjusted (relocated) yet. It can't have been since
1683 the section isn't yet known and knowing the section is
1684 necessary in order to add the correct relocation value. In
1685 other words, we wouldn't even be in this function (attempting
1686 to compute the section) if it were already known.
1688 Note that it is possible to search the minimal symbols
1689 (subtracting the relocation value if necessary) to find the
1690 matching minimal symbol, but this is overkill and much less
1691 efficient. It is not necessary to find the matching minimal
1692 symbol, only its section.
1694 Note that this technique (of doing a section table search)
1695 can fail when unrelocated section addresses overlap. For
1696 this reason, we still attempt a lookup by name prior to doing
1697 a search of the section table. */
1699 struct obj_section
*s
;
1702 ALL_OBJFILE_OSECTIONS (objfile
, s
)
1704 int idx
= s
- objfile
->sections
;
1705 CORE_ADDR offset
= ANOFFSET (objfile
->section_offsets
, idx
);
1710 if (obj_section_addr (s
) - offset
<= addr
1711 && addr
< obj_section_endaddr (s
) - offset
)
1713 ginfo
->section
= idx
;
1718 /* If we didn't find the section, assume it is in the first
1719 section. If there is no allocated section, then it hardly
1720 matters what we pick, so just pick zero. */
1724 ginfo
->section
= fallback
;
1729 fixup_symbol_section (struct symbol
*sym
, struct objfile
*objfile
)
1736 if (!SYMBOL_OBJFILE_OWNED (sym
))
1739 /* We either have an OBJFILE, or we can get at it from the sym's
1740 symtab. Anything else is a bug. */
1741 gdb_assert (objfile
|| symbol_symtab (sym
));
1743 if (objfile
== NULL
)
1744 objfile
= symbol_objfile (sym
);
1746 if (SYMBOL_OBJ_SECTION (objfile
, sym
))
1749 /* We should have an objfile by now. */
1750 gdb_assert (objfile
);
1752 switch (SYMBOL_CLASS (sym
))
1756 addr
= SYMBOL_VALUE_ADDRESS (sym
);
1759 addr
= BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
));
1763 /* Nothing else will be listed in the minsyms -- no use looking
1768 fixup_section (&sym
->ginfo
, addr
, objfile
);
1775 demangle_for_lookup_info::demangle_for_lookup_info
1776 (const lookup_name_info
&lookup_name
, language lang
)
1778 demangle_result_storage storage
;
1780 if (lookup_name
.ignore_parameters () && lang
== language_cplus
)
1782 gdb::unique_xmalloc_ptr
<char> without_params
1783 = cp_remove_params_if_any (lookup_name
.name ().c_str (),
1784 lookup_name
.completion_mode ());
1786 if (without_params
!= NULL
)
1788 if (lookup_name
.match_type () != symbol_name_match_type::SEARCH_NAME
)
1789 m_demangled_name
= demangle_for_lookup (without_params
.get (),
1795 if (lookup_name
.match_type () == symbol_name_match_type::SEARCH_NAME
)
1796 m_demangled_name
= lookup_name
.name ();
1798 m_demangled_name
= demangle_for_lookup (lookup_name
.name ().c_str (),
1804 const lookup_name_info
&
1805 lookup_name_info::match_any ()
1807 /* Lookup any symbol that "" would complete. I.e., this matches all
1809 static const lookup_name_info
lookup_name ({}, symbol_name_match_type::FULL
,
1815 /* Compute the demangled form of NAME as used by the various symbol
1816 lookup functions. The result can either be the input NAME
1817 directly, or a pointer to a buffer owned by the STORAGE object.
1819 For Ada, this function just returns NAME, unmodified.
1820 Normally, Ada symbol lookups are performed using the encoded name
1821 rather than the demangled name, and so it might seem to make sense
1822 for this function to return an encoded version of NAME.
1823 Unfortunately, we cannot do this, because this function is used in
1824 circumstances where it is not appropriate to try to encode NAME.
1825 For instance, when displaying the frame info, we demangle the name
1826 of each parameter, and then perform a symbol lookup inside our
1827 function using that demangled name. In Ada, certain functions
1828 have internally-generated parameters whose name contain uppercase
1829 characters. Encoding those name would result in those uppercase
1830 characters to become lowercase, and thus cause the symbol lookup
1834 demangle_for_lookup (const char *name
, enum language lang
,
1835 demangle_result_storage
&storage
)
1837 /* If we are using C++, D, or Go, demangle the name before doing a
1838 lookup, so we can always binary search. */
1839 if (lang
== language_cplus
)
1841 char *demangled_name
= gdb_demangle (name
, DMGL_ANSI
| DMGL_PARAMS
);
1842 if (demangled_name
!= NULL
)
1843 return storage
.set_malloc_ptr (demangled_name
);
1845 /* If we were given a non-mangled name, canonicalize it
1846 according to the language (so far only for C++). */
1847 std::string canon
= cp_canonicalize_string (name
);
1848 if (!canon
.empty ())
1849 return storage
.swap_string (canon
);
1851 else if (lang
== language_d
)
1853 char *demangled_name
= d_demangle (name
, 0);
1854 if (demangled_name
!= NULL
)
1855 return storage
.set_malloc_ptr (demangled_name
);
1857 else if (lang
== language_go
)
1859 char *demangled_name
= go_demangle (name
, 0);
1860 if (demangled_name
!= NULL
)
1861 return storage
.set_malloc_ptr (demangled_name
);
1870 search_name_hash (enum language language
, const char *search_name
)
1872 return language_def (language
)->la_search_name_hash (search_name
);
1877 This function (or rather its subordinates) have a bunch of loops and
1878 it would seem to be attractive to put in some QUIT's (though I'm not really
1879 sure whether it can run long enough to be really important). But there
1880 are a few calls for which it would appear to be bad news to quit
1881 out of here: e.g., find_proc_desc in alpha-mdebug-tdep.c. (Note
1882 that there is C++ code below which can error(), but that probably
1883 doesn't affect these calls since they are looking for a known
1884 variable and thus can probably assume it will never hit the C++
1888 lookup_symbol_in_language (const char *name
, const struct block
*block
,
1889 const domain_enum domain
, enum language lang
,
1890 struct field_of_this_result
*is_a_field_of_this
)
1892 demangle_result_storage storage
;
1893 const char *modified_name
= demangle_for_lookup (name
, lang
, storage
);
1895 return lookup_symbol_aux (modified_name
,
1896 symbol_name_match_type::FULL
,
1897 block
, domain
, lang
,
1898 is_a_field_of_this
);
1904 lookup_symbol (const char *name
, const struct block
*block
,
1906 struct field_of_this_result
*is_a_field_of_this
)
1908 return lookup_symbol_in_language (name
, block
, domain
,
1909 current_language
->la_language
,
1910 is_a_field_of_this
);
1916 lookup_symbol_search_name (const char *search_name
, const struct block
*block
,
1919 return lookup_symbol_aux (search_name
, symbol_name_match_type::SEARCH_NAME
,
1920 block
, domain
, language_asm
, NULL
);
1926 lookup_language_this (const struct language_defn
*lang
,
1927 const struct block
*block
)
1929 if (lang
->la_name_of_this
== NULL
|| block
== NULL
)
1932 if (symbol_lookup_debug
> 1)
1934 struct objfile
*objfile
= lookup_objfile_from_block (block
);
1936 fprintf_unfiltered (gdb_stdlog
,
1937 "lookup_language_this (%s, %s (objfile %s))",
1938 lang
->la_name
, host_address_to_string (block
),
1939 objfile_debug_name (objfile
));
1946 sym
= block_lookup_symbol (block
, lang
->la_name_of_this
,
1947 symbol_name_match_type::SEARCH_NAME
,
1951 if (symbol_lookup_debug
> 1)
1953 fprintf_unfiltered (gdb_stdlog
, " = %s (%s, block %s)\n",
1954 SYMBOL_PRINT_NAME (sym
),
1955 host_address_to_string (sym
),
1956 host_address_to_string (block
));
1958 return (struct block_symbol
) {sym
, block
};
1960 if (BLOCK_FUNCTION (block
))
1962 block
= BLOCK_SUPERBLOCK (block
);
1965 if (symbol_lookup_debug
> 1)
1966 fprintf_unfiltered (gdb_stdlog
, " = NULL\n");
1970 /* Given TYPE, a structure/union,
1971 return 1 if the component named NAME from the ultimate target
1972 structure/union is defined, otherwise, return 0. */
1975 check_field (struct type
*type
, const char *name
,
1976 struct field_of_this_result
*is_a_field_of_this
)
1980 /* The type may be a stub. */
1981 type
= check_typedef (type
);
1983 for (i
= TYPE_NFIELDS (type
) - 1; i
>= TYPE_N_BASECLASSES (type
); i
--)
1985 const char *t_field_name
= TYPE_FIELD_NAME (type
, i
);
1987 if (t_field_name
&& (strcmp_iw (t_field_name
, name
) == 0))
1989 is_a_field_of_this
->type
= type
;
1990 is_a_field_of_this
->field
= &TYPE_FIELD (type
, i
);
1995 /* C++: If it was not found as a data field, then try to return it
1996 as a pointer to a method. */
1998 for (i
= TYPE_NFN_FIELDS (type
) - 1; i
>= 0; --i
)
2000 if (strcmp_iw (TYPE_FN_FIELDLIST_NAME (type
, i
), name
) == 0)
2002 is_a_field_of_this
->type
= type
;
2003 is_a_field_of_this
->fn_field
= &TYPE_FN_FIELDLIST (type
, i
);
2008 for (i
= TYPE_N_BASECLASSES (type
) - 1; i
>= 0; i
--)
2009 if (check_field (TYPE_BASECLASS (type
, i
), name
, is_a_field_of_this
))
2015 /* Behave like lookup_symbol except that NAME is the natural name
2016 (e.g., demangled name) of the symbol that we're looking for. */
2018 static struct block_symbol
2019 lookup_symbol_aux (const char *name
, symbol_name_match_type match_type
,
2020 const struct block
*block
,
2021 const domain_enum domain
, enum language language
,
2022 struct field_of_this_result
*is_a_field_of_this
)
2024 struct block_symbol result
;
2025 const struct language_defn
*langdef
;
2027 if (symbol_lookup_debug
)
2029 struct objfile
*objfile
= lookup_objfile_from_block (block
);
2031 fprintf_unfiltered (gdb_stdlog
,
2032 "lookup_symbol_aux (%s, %s (objfile %s), %s, %s)\n",
2033 name
, host_address_to_string (block
),
2035 ? objfile_debug_name (objfile
) : "NULL",
2036 domain_name (domain
), language_str (language
));
2039 /* Make sure we do something sensible with is_a_field_of_this, since
2040 the callers that set this parameter to some non-null value will
2041 certainly use it later. If we don't set it, the contents of
2042 is_a_field_of_this are undefined. */
2043 if (is_a_field_of_this
!= NULL
)
2044 memset (is_a_field_of_this
, 0, sizeof (*is_a_field_of_this
));
2046 /* Search specified block and its superiors. Don't search
2047 STATIC_BLOCK or GLOBAL_BLOCK. */
2049 result
= lookup_local_symbol (name
, match_type
, block
, domain
, language
);
2050 if (result
.symbol
!= NULL
)
2052 if (symbol_lookup_debug
)
2054 fprintf_unfiltered (gdb_stdlog
, "lookup_symbol_aux (...) = %s\n",
2055 host_address_to_string (result
.symbol
));
2060 /* If requested to do so by the caller and if appropriate for LANGUAGE,
2061 check to see if NAME is a field of `this'. */
2063 langdef
= language_def (language
);
2065 /* Don't do this check if we are searching for a struct. It will
2066 not be found by check_field, but will be found by other
2068 if (is_a_field_of_this
!= NULL
&& domain
!= STRUCT_DOMAIN
)
2070 result
= lookup_language_this (langdef
, block
);
2074 struct type
*t
= result
.symbol
->type
;
2076 /* I'm not really sure that type of this can ever
2077 be typedefed; just be safe. */
2078 t
= check_typedef (t
);
2079 if (TYPE_CODE (t
) == TYPE_CODE_PTR
|| TYPE_IS_REFERENCE (t
))
2080 t
= TYPE_TARGET_TYPE (t
);
2082 if (TYPE_CODE (t
) != TYPE_CODE_STRUCT
2083 && TYPE_CODE (t
) != TYPE_CODE_UNION
)
2084 error (_("Internal error: `%s' is not an aggregate"),
2085 langdef
->la_name_of_this
);
2087 if (check_field (t
, name
, is_a_field_of_this
))
2089 if (symbol_lookup_debug
)
2091 fprintf_unfiltered (gdb_stdlog
,
2092 "lookup_symbol_aux (...) = NULL\n");
2099 /* Now do whatever is appropriate for LANGUAGE to look
2100 up static and global variables. */
2102 result
= langdef
->la_lookup_symbol_nonlocal (langdef
, name
, block
, domain
);
2103 if (result
.symbol
!= NULL
)
2105 if (symbol_lookup_debug
)
2107 fprintf_unfiltered (gdb_stdlog
, "lookup_symbol_aux (...) = %s\n",
2108 host_address_to_string (result
.symbol
));
2113 /* Now search all static file-level symbols. Not strictly correct,
2114 but more useful than an error. */
2116 result
= lookup_static_symbol (name
, domain
);
2117 if (symbol_lookup_debug
)
2119 fprintf_unfiltered (gdb_stdlog
, "lookup_symbol_aux (...) = %s\n",
2120 result
.symbol
!= NULL
2121 ? host_address_to_string (result
.symbol
)
2127 /* Check to see if the symbol is defined in BLOCK or its superiors.
2128 Don't search STATIC_BLOCK or GLOBAL_BLOCK. */
2130 static struct block_symbol
2131 lookup_local_symbol (const char *name
,
2132 symbol_name_match_type match_type
,
2133 const struct block
*block
,
2134 const domain_enum domain
,
2135 enum language language
)
2138 const struct block
*static_block
= block_static_block (block
);
2139 const char *scope
= block_scope (block
);
2141 /* Check if either no block is specified or it's a global block. */
2143 if (static_block
== NULL
)
2146 while (block
!= static_block
)
2148 sym
= lookup_symbol_in_block (name
, match_type
, block
, domain
);
2150 return (struct block_symbol
) {sym
, block
};
2152 if (language
== language_cplus
|| language
== language_fortran
)
2154 struct block_symbol blocksym
2155 = cp_lookup_symbol_imports_or_template (scope
, name
, block
,
2158 if (blocksym
.symbol
!= NULL
)
2162 if (BLOCK_FUNCTION (block
) != NULL
&& block_inlined_p (block
))
2164 block
= BLOCK_SUPERBLOCK (block
);
2167 /* We've reached the end of the function without finding a result. */
2175 lookup_objfile_from_block (const struct block
*block
)
2180 block
= block_global_block (block
);
2181 /* Look through all blockvectors. */
2182 for (objfile
*obj
: current_program_space
->objfiles ())
2184 for (compunit_symtab
*cust
: obj
->compunits ())
2185 if (block
== BLOCKVECTOR_BLOCK (COMPUNIT_BLOCKVECTOR (cust
),
2188 if (obj
->separate_debug_objfile_backlink
)
2189 obj
= obj
->separate_debug_objfile_backlink
;
2201 lookup_symbol_in_block (const char *name
, symbol_name_match_type match_type
,
2202 const struct block
*block
,
2203 const domain_enum domain
)
2207 if (symbol_lookup_debug
> 1)
2209 struct objfile
*objfile
= lookup_objfile_from_block (block
);
2211 fprintf_unfiltered (gdb_stdlog
,
2212 "lookup_symbol_in_block (%s, %s (objfile %s), %s)",
2213 name
, host_address_to_string (block
),
2214 objfile_debug_name (objfile
),
2215 domain_name (domain
));
2218 sym
= block_lookup_symbol (block
, name
, match_type
, domain
);
2221 if (symbol_lookup_debug
> 1)
2223 fprintf_unfiltered (gdb_stdlog
, " = %s\n",
2224 host_address_to_string (sym
));
2226 return fixup_symbol_section (sym
, NULL
);
2229 if (symbol_lookup_debug
> 1)
2230 fprintf_unfiltered (gdb_stdlog
, " = NULL\n");
2237 lookup_global_symbol_from_objfile (struct objfile
*main_objfile
,
2238 enum block_enum block_index
,
2240 const domain_enum domain
)
2242 gdb_assert (block_index
== GLOBAL_BLOCK
|| block_index
== STATIC_BLOCK
);
2244 for (objfile
*objfile
: main_objfile
->separate_debug_objfiles ())
2246 struct block_symbol result
2247 = lookup_symbol_in_objfile (objfile
, block_index
, name
, domain
);
2249 if (result
.symbol
!= nullptr)
2256 /* Check to see if the symbol is defined in one of the OBJFILE's
2257 symtabs. BLOCK_INDEX should be either GLOBAL_BLOCK or STATIC_BLOCK,
2258 depending on whether or not we want to search global symbols or
2261 static struct block_symbol
2262 lookup_symbol_in_objfile_symtabs (struct objfile
*objfile
,
2263 enum block_enum block_index
, const char *name
,
2264 const domain_enum domain
)
2266 gdb_assert (block_index
== GLOBAL_BLOCK
|| block_index
== STATIC_BLOCK
);
2268 if (symbol_lookup_debug
> 1)
2270 fprintf_unfiltered (gdb_stdlog
,
2271 "lookup_symbol_in_objfile_symtabs (%s, %s, %s, %s)",
2272 objfile_debug_name (objfile
),
2273 block_index
== GLOBAL_BLOCK
2274 ? "GLOBAL_BLOCK" : "STATIC_BLOCK",
2275 name
, domain_name (domain
));
2278 for (compunit_symtab
*cust
: objfile
->compunits ())
2280 const struct blockvector
*bv
;
2281 const struct block
*block
;
2282 struct block_symbol result
;
2284 bv
= COMPUNIT_BLOCKVECTOR (cust
);
2285 block
= BLOCKVECTOR_BLOCK (bv
, block_index
);
2286 result
.symbol
= block_lookup_symbol_primary (block
, name
, domain
);
2287 result
.block
= block
;
2288 if (result
.symbol
!= NULL
)
2290 if (symbol_lookup_debug
> 1)
2292 fprintf_unfiltered (gdb_stdlog
, " = %s (block %s)\n",
2293 host_address_to_string (result
.symbol
),
2294 host_address_to_string (block
));
2296 result
.symbol
= fixup_symbol_section (result
.symbol
, objfile
);
2302 if (symbol_lookup_debug
> 1)
2303 fprintf_unfiltered (gdb_stdlog
, " = NULL\n");
2307 /* Wrapper around lookup_symbol_in_objfile_symtabs for search_symbols.
2308 Look up LINKAGE_NAME in DOMAIN in the global and static blocks of OBJFILE
2309 and all associated separate debug objfiles.
2311 Normally we only look in OBJFILE, and not any separate debug objfiles
2312 because the outer loop will cause them to be searched too. This case is
2313 different. Here we're called from search_symbols where it will only
2314 call us for the objfile that contains a matching minsym. */
2316 static struct block_symbol
2317 lookup_symbol_in_objfile_from_linkage_name (struct objfile
*objfile
,
2318 const char *linkage_name
,
2321 enum language lang
= current_language
->la_language
;
2322 struct objfile
*main_objfile
;
2324 demangle_result_storage storage
;
2325 const char *modified_name
= demangle_for_lookup (linkage_name
, lang
, storage
);
2327 if (objfile
->separate_debug_objfile_backlink
)
2328 main_objfile
= objfile
->separate_debug_objfile_backlink
;
2330 main_objfile
= objfile
;
2332 for (::objfile
*cur_objfile
: main_objfile
->separate_debug_objfiles ())
2334 struct block_symbol result
;
2336 result
= lookup_symbol_in_objfile_symtabs (cur_objfile
, GLOBAL_BLOCK
,
2337 modified_name
, domain
);
2338 if (result
.symbol
== NULL
)
2339 result
= lookup_symbol_in_objfile_symtabs (cur_objfile
, STATIC_BLOCK
,
2340 modified_name
, domain
);
2341 if (result
.symbol
!= NULL
)
2348 /* A helper function that throws an exception when a symbol was found
2349 in a psymtab but not in a symtab. */
2351 static void ATTRIBUTE_NORETURN
2352 error_in_psymtab_expansion (enum block_enum block_index
, const char *name
,
2353 struct compunit_symtab
*cust
)
2356 Internal: %s symbol `%s' found in %s psymtab but not in symtab.\n\
2357 %s may be an inlined function, or may be a template function\n \
2358 (if a template, try specifying an instantiation: %s<type>)."),
2359 block_index
== GLOBAL_BLOCK
? "global" : "static",
2361 symtab_to_filename_for_display (compunit_primary_filetab (cust
)),
2365 /* A helper function for various lookup routines that interfaces with
2366 the "quick" symbol table functions. */
2368 static struct block_symbol
2369 lookup_symbol_via_quick_fns (struct objfile
*objfile
,
2370 enum block_enum block_index
, const char *name
,
2371 const domain_enum domain
)
2373 struct compunit_symtab
*cust
;
2374 const struct blockvector
*bv
;
2375 const struct block
*block
;
2376 struct block_symbol result
;
2381 if (symbol_lookup_debug
> 1)
2383 fprintf_unfiltered (gdb_stdlog
,
2384 "lookup_symbol_via_quick_fns (%s, %s, %s, %s)\n",
2385 objfile_debug_name (objfile
),
2386 block_index
== GLOBAL_BLOCK
2387 ? "GLOBAL_BLOCK" : "STATIC_BLOCK",
2388 name
, domain_name (domain
));
2391 cust
= objfile
->sf
->qf
->lookup_symbol (objfile
, block_index
, name
, domain
);
2394 if (symbol_lookup_debug
> 1)
2396 fprintf_unfiltered (gdb_stdlog
,
2397 "lookup_symbol_via_quick_fns (...) = NULL\n");
2402 bv
= COMPUNIT_BLOCKVECTOR (cust
);
2403 block
= BLOCKVECTOR_BLOCK (bv
, block_index
);
2404 result
.symbol
= block_lookup_symbol (block
, name
,
2405 symbol_name_match_type::FULL
, domain
);
2406 if (result
.symbol
== NULL
)
2407 error_in_psymtab_expansion (block_index
, name
, cust
);
2409 if (symbol_lookup_debug
> 1)
2411 fprintf_unfiltered (gdb_stdlog
,
2412 "lookup_symbol_via_quick_fns (...) = %s (block %s)\n",
2413 host_address_to_string (result
.symbol
),
2414 host_address_to_string (block
));
2417 result
.symbol
= fixup_symbol_section (result
.symbol
, objfile
);
2418 result
.block
= block
;
2425 basic_lookup_symbol_nonlocal (const struct language_defn
*langdef
,
2427 const struct block
*block
,
2428 const domain_enum domain
)
2430 struct block_symbol result
;
2432 /* NOTE: dje/2014-10-26: The lookup in all objfiles search could skip
2433 the current objfile. Searching the current objfile first is useful
2434 for both matching user expectations as well as performance. */
2436 result
= lookup_symbol_in_static_block (name
, block
, domain
);
2437 if (result
.symbol
!= NULL
)
2440 /* If we didn't find a definition for a builtin type in the static block,
2441 search for it now. This is actually the right thing to do and can be
2442 a massive performance win. E.g., when debugging a program with lots of
2443 shared libraries we could search all of them only to find out the
2444 builtin type isn't defined in any of them. This is common for types
2446 if (domain
== VAR_DOMAIN
)
2448 struct gdbarch
*gdbarch
;
2451 gdbarch
= target_gdbarch ();
2453 gdbarch
= block_gdbarch (block
);
2454 result
.symbol
= language_lookup_primitive_type_as_symbol (langdef
,
2456 result
.block
= NULL
;
2457 if (result
.symbol
!= NULL
)
2461 return lookup_global_symbol (name
, block
, domain
);
2467 lookup_symbol_in_static_block (const char *name
,
2468 const struct block
*block
,
2469 const domain_enum domain
)
2471 const struct block
*static_block
= block_static_block (block
);
2474 if (static_block
== NULL
)
2477 if (symbol_lookup_debug
)
2479 struct objfile
*objfile
= lookup_objfile_from_block (static_block
);
2481 fprintf_unfiltered (gdb_stdlog
,
2482 "lookup_symbol_in_static_block (%s, %s (objfile %s),"
2485 host_address_to_string (block
),
2486 objfile_debug_name (objfile
),
2487 domain_name (domain
));
2490 sym
= lookup_symbol_in_block (name
,
2491 symbol_name_match_type::FULL
,
2492 static_block
, domain
);
2493 if (symbol_lookup_debug
)
2495 fprintf_unfiltered (gdb_stdlog
,
2496 "lookup_symbol_in_static_block (...) = %s\n",
2497 sym
!= NULL
? host_address_to_string (sym
) : "NULL");
2499 return (struct block_symbol
) {sym
, static_block
};
2502 /* Perform the standard symbol lookup of NAME in OBJFILE:
2503 1) First search expanded symtabs, and if not found
2504 2) Search the "quick" symtabs (partial or .gdb_index).
2505 BLOCK_INDEX is one of GLOBAL_BLOCK or STATIC_BLOCK. */
2507 static struct block_symbol
2508 lookup_symbol_in_objfile (struct objfile
*objfile
, enum block_enum block_index
,
2509 const char *name
, const domain_enum domain
)
2511 struct block_symbol result
;
2513 gdb_assert (block_index
== GLOBAL_BLOCK
|| block_index
== STATIC_BLOCK
);
2515 if (symbol_lookup_debug
)
2517 fprintf_unfiltered (gdb_stdlog
,
2518 "lookup_symbol_in_objfile (%s, %s, %s, %s)\n",
2519 objfile_debug_name (objfile
),
2520 block_index
== GLOBAL_BLOCK
2521 ? "GLOBAL_BLOCK" : "STATIC_BLOCK",
2522 name
, domain_name (domain
));
2525 result
= lookup_symbol_in_objfile_symtabs (objfile
, block_index
,
2527 if (result
.symbol
!= NULL
)
2529 if (symbol_lookup_debug
)
2531 fprintf_unfiltered (gdb_stdlog
,
2532 "lookup_symbol_in_objfile (...) = %s"
2534 host_address_to_string (result
.symbol
));
2539 result
= lookup_symbol_via_quick_fns (objfile
, block_index
,
2541 if (symbol_lookup_debug
)
2543 fprintf_unfiltered (gdb_stdlog
,
2544 "lookup_symbol_in_objfile (...) = %s%s\n",
2545 result
.symbol
!= NULL
2546 ? host_address_to_string (result
.symbol
)
2548 result
.symbol
!= NULL
? " (via quick fns)" : "");
2553 /* Private data to be used with lookup_symbol_global_iterator_cb. */
2555 struct global_or_static_sym_lookup_data
2557 /* The name of the symbol we are searching for. */
2560 /* The domain to use for our search. */
2563 /* The block index in which to search. */
2564 enum block_enum block_index
;
2566 /* The field where the callback should store the symbol if found.
2567 It should be initialized to {NULL, NULL} before the search is started. */
2568 struct block_symbol result
;
2571 /* A callback function for gdbarch_iterate_over_objfiles_in_search_order.
2572 It searches by name for a symbol in the block given by BLOCK_INDEX of the
2573 given OBJFILE. The arguments for the search are passed via CB_DATA, which
2574 in reality is a pointer to struct global_or_static_sym_lookup_data. */
2577 lookup_symbol_global_or_static_iterator_cb (struct objfile
*objfile
,
2580 struct global_or_static_sym_lookup_data
*data
=
2581 (struct global_or_static_sym_lookup_data
*) cb_data
;
2583 gdb_assert (data
->result
.symbol
== NULL
2584 && data
->result
.block
== NULL
);
2586 data
->result
= lookup_symbol_in_objfile (objfile
, data
->block_index
,
2587 data
->name
, data
->domain
);
2589 /* If we found a match, tell the iterator to stop. Otherwise,
2591 return (data
->result
.symbol
!= NULL
);
2594 /* This function contains the common code of lookup_{global,static}_symbol.
2595 OBJFILE is only used if BLOCK_INDEX is GLOBAL_SCOPE, in which case it is
2596 the objfile to start the lookup in. */
2598 static struct block_symbol
2599 lookup_global_or_static_symbol (const char *name
,
2600 enum block_enum block_index
,
2601 struct objfile
*objfile
,
2602 const domain_enum domain
)
2604 struct symbol_cache
*cache
= get_symbol_cache (current_program_space
);
2605 struct block_symbol result
;
2606 struct global_or_static_sym_lookup_data lookup_data
;
2607 struct block_symbol_cache
*bsc
;
2608 struct symbol_cache_slot
*slot
;
2610 gdb_assert (block_index
== GLOBAL_BLOCK
|| block_index
== STATIC_BLOCK
);
2611 gdb_assert (objfile
== nullptr || block_index
== GLOBAL_BLOCK
);
2613 /* First see if we can find the symbol in the cache.
2614 This works because we use the current objfile to qualify the lookup. */
2615 result
= symbol_cache_lookup (cache
, objfile
, block_index
, name
, domain
,
2617 if (result
.symbol
!= NULL
)
2619 if (SYMBOL_LOOKUP_FAILED_P (result
))
2624 /* Do a global search (of global blocks, heh). */
2625 if (result
.symbol
== NULL
)
2627 memset (&lookup_data
, 0, sizeof (lookup_data
));
2628 lookup_data
.name
= name
;
2629 lookup_data
.block_index
= block_index
;
2630 lookup_data
.domain
= domain
;
2631 gdbarch_iterate_over_objfiles_in_search_order
2632 (objfile
!= NULL
? get_objfile_arch (objfile
) : target_gdbarch (),
2633 lookup_symbol_global_or_static_iterator_cb
, &lookup_data
, objfile
);
2634 result
= lookup_data
.result
;
2637 if (result
.symbol
!= NULL
)
2638 symbol_cache_mark_found (bsc
, slot
, objfile
, result
.symbol
, result
.block
);
2640 symbol_cache_mark_not_found (bsc
, slot
, objfile
, name
, domain
);
2648 lookup_static_symbol (const char *name
, const domain_enum domain
)
2650 return lookup_global_or_static_symbol (name
, STATIC_BLOCK
, nullptr, domain
);
2656 lookup_global_symbol (const char *name
,
2657 const struct block
*block
,
2658 const domain_enum domain
)
2660 /* If a block was passed in, we want to search the corresponding
2661 global block first. This yields "more expected" behavior, and is
2662 needed to support 'FILENAME'::VARIABLE lookups. */
2663 const struct block
*global_block
= block_global_block (block
);
2664 if (global_block
!= nullptr)
2666 symbol
*sym
= lookup_symbol_in_block (name
,
2667 symbol_name_match_type::FULL
,
2668 global_block
, domain
);
2670 return { sym
, global_block
};
2673 struct objfile
*objfile
= lookup_objfile_from_block (block
);
2674 return lookup_global_or_static_symbol (name
, GLOBAL_BLOCK
, objfile
, domain
);
2678 symbol_matches_domain (enum language symbol_language
,
2679 domain_enum symbol_domain
,
2682 /* For C++ "struct foo { ... }" also defines a typedef for "foo".
2683 Similarly, any Ada type declaration implicitly defines a typedef. */
2684 if (symbol_language
== language_cplus
2685 || symbol_language
== language_d
2686 || symbol_language
== language_ada
2687 || symbol_language
== language_rust
)
2689 if ((domain
== VAR_DOMAIN
|| domain
== STRUCT_DOMAIN
)
2690 && symbol_domain
== STRUCT_DOMAIN
)
2693 /* For all other languages, strict match is required. */
2694 return (symbol_domain
== domain
);
2700 lookup_transparent_type (const char *name
)
2702 return current_language
->la_lookup_transparent_type (name
);
2705 /* A helper for basic_lookup_transparent_type that interfaces with the
2706 "quick" symbol table functions. */
2708 static struct type
*
2709 basic_lookup_transparent_type_quick (struct objfile
*objfile
,
2710 enum block_enum block_index
,
2713 struct compunit_symtab
*cust
;
2714 const struct blockvector
*bv
;
2715 const struct block
*block
;
2720 cust
= objfile
->sf
->qf
->lookup_symbol (objfile
, block_index
, name
,
2725 bv
= COMPUNIT_BLOCKVECTOR (cust
);
2726 block
= BLOCKVECTOR_BLOCK (bv
, block_index
);
2727 sym
= block_find_symbol (block
, name
, STRUCT_DOMAIN
,
2728 block_find_non_opaque_type
, NULL
);
2730 error_in_psymtab_expansion (block_index
, name
, cust
);
2731 gdb_assert (!TYPE_IS_OPAQUE (SYMBOL_TYPE (sym
)));
2732 return SYMBOL_TYPE (sym
);
2735 /* Subroutine of basic_lookup_transparent_type to simplify it.
2736 Look up the non-opaque definition of NAME in BLOCK_INDEX of OBJFILE.
2737 BLOCK_INDEX is either GLOBAL_BLOCK or STATIC_BLOCK. */
2739 static struct type
*
2740 basic_lookup_transparent_type_1 (struct objfile
*objfile
,
2741 enum block_enum block_index
,
2744 const struct blockvector
*bv
;
2745 const struct block
*block
;
2746 const struct symbol
*sym
;
2748 for (compunit_symtab
*cust
: objfile
->compunits ())
2750 bv
= COMPUNIT_BLOCKVECTOR (cust
);
2751 block
= BLOCKVECTOR_BLOCK (bv
, block_index
);
2752 sym
= block_find_symbol (block
, name
, STRUCT_DOMAIN
,
2753 block_find_non_opaque_type
, NULL
);
2756 gdb_assert (!TYPE_IS_OPAQUE (SYMBOL_TYPE (sym
)));
2757 return SYMBOL_TYPE (sym
);
2764 /* The standard implementation of lookup_transparent_type. This code
2765 was modeled on lookup_symbol -- the parts not relevant to looking
2766 up types were just left out. In particular it's assumed here that
2767 types are available in STRUCT_DOMAIN and only in file-static or
2771 basic_lookup_transparent_type (const char *name
)
2775 /* Now search all the global symbols. Do the symtab's first, then
2776 check the psymtab's. If a psymtab indicates the existence
2777 of the desired name as a global, then do psymtab-to-symtab
2778 conversion on the fly and return the found symbol. */
2780 for (objfile
*objfile
: current_program_space
->objfiles ())
2782 t
= basic_lookup_transparent_type_1 (objfile
, GLOBAL_BLOCK
, name
);
2787 for (objfile
*objfile
: current_program_space
->objfiles ())
2789 t
= basic_lookup_transparent_type_quick (objfile
, GLOBAL_BLOCK
, name
);
2794 /* Now search the static file-level symbols.
2795 Not strictly correct, but more useful than an error.
2796 Do the symtab's first, then
2797 check the psymtab's. If a psymtab indicates the existence
2798 of the desired name as a file-level static, then do psymtab-to-symtab
2799 conversion on the fly and return the found symbol. */
2801 for (objfile
*objfile
: current_program_space
->objfiles ())
2803 t
= basic_lookup_transparent_type_1 (objfile
, STATIC_BLOCK
, name
);
2808 for (objfile
*objfile
: current_program_space
->objfiles ())
2810 t
= basic_lookup_transparent_type_quick (objfile
, STATIC_BLOCK
, name
);
2815 return (struct type
*) 0;
2821 iterate_over_symbols (const struct block
*block
,
2822 const lookup_name_info
&name
,
2823 const domain_enum domain
,
2824 gdb::function_view
<symbol_found_callback_ftype
> callback
)
2826 struct block_iterator iter
;
2829 ALL_BLOCK_SYMBOLS_WITH_NAME (block
, name
, iter
, sym
)
2831 if (symbol_matches_domain (SYMBOL_LANGUAGE (sym
),
2832 SYMBOL_DOMAIN (sym
), domain
))
2834 struct block_symbol block_sym
= {sym
, block
};
2836 if (!callback (&block_sym
))
2846 iterate_over_symbols_terminated
2847 (const struct block
*block
,
2848 const lookup_name_info
&name
,
2849 const domain_enum domain
,
2850 gdb::function_view
<symbol_found_callback_ftype
> callback
)
2852 if (!iterate_over_symbols (block
, name
, domain
, callback
))
2854 struct block_symbol block_sym
= {nullptr, block
};
2855 return callback (&block_sym
);
2858 /* Find the compunit symtab associated with PC and SECTION.
2859 This will read in debug info as necessary. */
2861 struct compunit_symtab
*
2862 find_pc_sect_compunit_symtab (CORE_ADDR pc
, struct obj_section
*section
)
2864 struct compunit_symtab
*best_cust
= NULL
;
2865 CORE_ADDR distance
= 0;
2866 struct bound_minimal_symbol msymbol
;
2868 /* If we know that this is not a text address, return failure. This is
2869 necessary because we loop based on the block's high and low code
2870 addresses, which do not include the data ranges, and because
2871 we call find_pc_sect_psymtab which has a similar restriction based
2872 on the partial_symtab's texthigh and textlow. */
2873 msymbol
= lookup_minimal_symbol_by_pc_section (pc
, section
);
2874 if (msymbol
.minsym
&& msymbol
.minsym
->data_p ())
2877 /* Search all symtabs for the one whose file contains our address, and which
2878 is the smallest of all the ones containing the address. This is designed
2879 to deal with a case like symtab a is at 0x1000-0x2000 and 0x3000-0x4000
2880 and symtab b is at 0x2000-0x3000. So the GLOBAL_BLOCK for a is from
2881 0x1000-0x4000, but for address 0x2345 we want to return symtab b.
2883 This happens for native ecoff format, where code from included files
2884 gets its own symtab. The symtab for the included file should have
2885 been read in already via the dependency mechanism.
2886 It might be swifter to create several symtabs with the same name
2887 like xcoff does (I'm not sure).
2889 It also happens for objfiles that have their functions reordered.
2890 For these, the symtab we are looking for is not necessarily read in. */
2892 for (objfile
*obj_file
: current_program_space
->objfiles ())
2894 for (compunit_symtab
*cust
: obj_file
->compunits ())
2896 const struct block
*b
;
2897 const struct blockvector
*bv
;
2899 bv
= COMPUNIT_BLOCKVECTOR (cust
);
2900 b
= BLOCKVECTOR_BLOCK (bv
, GLOBAL_BLOCK
);
2902 if (BLOCK_START (b
) <= pc
2903 && BLOCK_END (b
) > pc
2905 || BLOCK_END (b
) - BLOCK_START (b
) < distance
))
2907 /* For an objfile that has its functions reordered,
2908 find_pc_psymtab will find the proper partial symbol table
2909 and we simply return its corresponding symtab. */
2910 /* In order to better support objfiles that contain both
2911 stabs and coff debugging info, we continue on if a psymtab
2913 if ((obj_file
->flags
& OBJF_REORDERED
) && obj_file
->sf
)
2915 struct compunit_symtab
*result
;
2918 = obj_file
->sf
->qf
->find_pc_sect_compunit_symtab (obj_file
,
2928 struct block_iterator iter
;
2929 struct symbol
*sym
= NULL
;
2931 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
2933 fixup_symbol_section (sym
, obj_file
);
2934 if (matching_obj_sections (SYMBOL_OBJ_SECTION (obj_file
,
2940 continue; /* No symbol in this symtab matches
2943 distance
= BLOCK_END (b
) - BLOCK_START (b
);
2949 if (best_cust
!= NULL
)
2952 /* Not found in symtabs, search the "quick" symtabs (e.g. psymtabs). */
2954 for (objfile
*objf
: current_program_space
->objfiles ())
2956 struct compunit_symtab
*result
;
2960 result
= objf
->sf
->qf
->find_pc_sect_compunit_symtab (objf
,
2971 /* Find the compunit symtab associated with PC.
2972 This will read in debug info as necessary.
2973 Backward compatibility, no section. */
2975 struct compunit_symtab
*
2976 find_pc_compunit_symtab (CORE_ADDR pc
)
2978 return find_pc_sect_compunit_symtab (pc
, find_pc_mapped_section (pc
));
2984 find_symbol_at_address (CORE_ADDR address
)
2986 for (objfile
*objfile
: current_program_space
->objfiles ())
2988 if (objfile
->sf
== NULL
2989 || objfile
->sf
->qf
->find_compunit_symtab_by_address
== NULL
)
2992 struct compunit_symtab
*symtab
2993 = objfile
->sf
->qf
->find_compunit_symtab_by_address (objfile
, address
);
2996 const struct blockvector
*bv
= COMPUNIT_BLOCKVECTOR (symtab
);
2998 for (int i
= GLOBAL_BLOCK
; i
<= STATIC_BLOCK
; ++i
)
3000 const struct block
*b
= BLOCKVECTOR_BLOCK (bv
, i
);
3001 struct block_iterator iter
;
3004 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
3006 if (SYMBOL_CLASS (sym
) == LOC_STATIC
3007 && SYMBOL_VALUE_ADDRESS (sym
) == address
)
3019 /* Find the source file and line number for a given PC value and SECTION.
3020 Return a structure containing a symtab pointer, a line number,
3021 and a pc range for the entire source line.
3022 The value's .pc field is NOT the specified pc.
3023 NOTCURRENT nonzero means, if specified pc is on a line boundary,
3024 use the line that ends there. Otherwise, in that case, the line
3025 that begins there is used. */
3027 /* The big complication here is that a line may start in one file, and end just
3028 before the start of another file. This usually occurs when you #include
3029 code in the middle of a subroutine. To properly find the end of a line's PC
3030 range, we must search all symtabs associated with this compilation unit, and
3031 find the one whose first PC is closer than that of the next line in this
3034 struct symtab_and_line
3035 find_pc_sect_line (CORE_ADDR pc
, struct obj_section
*section
, int notcurrent
)
3037 struct compunit_symtab
*cust
;
3038 struct linetable
*l
;
3040 struct linetable_entry
*item
;
3041 const struct blockvector
*bv
;
3042 struct bound_minimal_symbol msymbol
;
3044 /* Info on best line seen so far, and where it starts, and its file. */
3046 struct linetable_entry
*best
= NULL
;
3047 CORE_ADDR best_end
= 0;
3048 struct symtab
*best_symtab
= 0;
3050 /* Store here the first line number
3051 of a file which contains the line at the smallest pc after PC.
3052 If we don't find a line whose range contains PC,
3053 we will use a line one less than this,
3054 with a range from the start of that file to the first line's pc. */
3055 struct linetable_entry
*alt
= NULL
;
3057 /* Info on best line seen in this file. */
3059 struct linetable_entry
*prev
;
3061 /* If this pc is not from the current frame,
3062 it is the address of the end of a call instruction.
3063 Quite likely that is the start of the following statement.
3064 But what we want is the statement containing the instruction.
3065 Fudge the pc to make sure we get that. */
3067 /* It's tempting to assume that, if we can't find debugging info for
3068 any function enclosing PC, that we shouldn't search for line
3069 number info, either. However, GAS can emit line number info for
3070 assembly files --- very helpful when debugging hand-written
3071 assembly code. In such a case, we'd have no debug info for the
3072 function, but we would have line info. */
3077 /* elz: added this because this function returned the wrong
3078 information if the pc belongs to a stub (import/export)
3079 to call a shlib function. This stub would be anywhere between
3080 two functions in the target, and the line info was erroneously
3081 taken to be the one of the line before the pc. */
3083 /* RT: Further explanation:
3085 * We have stubs (trampolines) inserted between procedures.
3087 * Example: "shr1" exists in a shared library, and a "shr1" stub also
3088 * exists in the main image.
3090 * In the minimal symbol table, we have a bunch of symbols
3091 * sorted by start address. The stubs are marked as "trampoline",
3092 * the others appear as text. E.g.:
3094 * Minimal symbol table for main image
3095 * main: code for main (text symbol)
3096 * shr1: stub (trampoline symbol)
3097 * foo: code for foo (text symbol)
3099 * Minimal symbol table for "shr1" image:
3101 * shr1: code for shr1 (text symbol)
3104 * So the code below is trying to detect if we are in the stub
3105 * ("shr1" stub), and if so, find the real code ("shr1" trampoline),
3106 * and if found, do the symbolization from the real-code address
3107 * rather than the stub address.
3109 * Assumptions being made about the minimal symbol table:
3110 * 1. lookup_minimal_symbol_by_pc() will return a trampoline only
3111 * if we're really in the trampoline.s If we're beyond it (say
3112 * we're in "foo" in the above example), it'll have a closer
3113 * symbol (the "foo" text symbol for example) and will not
3114 * return the trampoline.
3115 * 2. lookup_minimal_symbol_text() will find a real text symbol
3116 * corresponding to the trampoline, and whose address will
3117 * be different than the trampoline address. I put in a sanity
3118 * check for the address being the same, to avoid an
3119 * infinite recursion.
3121 msymbol
= lookup_minimal_symbol_by_pc (pc
);
3122 if (msymbol
.minsym
!= NULL
)
3123 if (MSYMBOL_TYPE (msymbol
.minsym
) == mst_solib_trampoline
)
3125 struct bound_minimal_symbol mfunsym
3126 = lookup_minimal_symbol_text (MSYMBOL_LINKAGE_NAME (msymbol
.minsym
),
3129 if (mfunsym
.minsym
== NULL
)
3130 /* I eliminated this warning since it is coming out
3131 * in the following situation:
3132 * gdb shmain // test program with shared libraries
3133 * (gdb) break shr1 // function in shared lib
3134 * Warning: In stub for ...
3135 * In the above situation, the shared lib is not loaded yet,
3136 * so of course we can't find the real func/line info,
3137 * but the "break" still works, and the warning is annoying.
3138 * So I commented out the warning. RT */
3139 /* warning ("In stub for %s; unable to find real function/line info",
3140 SYMBOL_LINKAGE_NAME (msymbol)); */
3143 else if (BMSYMBOL_VALUE_ADDRESS (mfunsym
)
3144 == BMSYMBOL_VALUE_ADDRESS (msymbol
))
3145 /* Avoid infinite recursion */
3146 /* See above comment about why warning is commented out. */
3147 /* warning ("In stub for %s; unable to find real function/line info",
3148 SYMBOL_LINKAGE_NAME (msymbol)); */
3152 return find_pc_line (BMSYMBOL_VALUE_ADDRESS (mfunsym
), 0);
3155 symtab_and_line val
;
3156 val
.pspace
= current_program_space
;
3158 cust
= find_pc_sect_compunit_symtab (pc
, section
);
3161 /* If no symbol information, return previous pc. */
3168 bv
= COMPUNIT_BLOCKVECTOR (cust
);
3170 /* Look at all the symtabs that share this blockvector.
3171 They all have the same apriori range, that we found was right;
3172 but they have different line tables. */
3174 for (symtab
*iter_s
: compunit_filetabs (cust
))
3176 /* Find the best line in this symtab. */
3177 l
= SYMTAB_LINETABLE (iter_s
);
3183 /* I think len can be zero if the symtab lacks line numbers
3184 (e.g. gcc -g1). (Either that or the LINETABLE is NULL;
3185 I'm not sure which, and maybe it depends on the symbol
3191 item
= l
->item
; /* Get first line info. */
3193 /* Is this file's first line closer than the first lines of other files?
3194 If so, record this file, and its first line, as best alternate. */
3195 if (item
->pc
> pc
&& (!alt
|| item
->pc
< alt
->pc
))
3198 auto pc_compare
= [](const CORE_ADDR
& comp_pc
,
3199 const struct linetable_entry
& lhs
)->bool
3201 return comp_pc
< lhs
.pc
;
3204 struct linetable_entry
*first
= item
;
3205 struct linetable_entry
*last
= item
+ len
;
3206 item
= std::upper_bound (first
, last
, pc
, pc_compare
);
3208 prev
= item
- 1; /* Found a matching item. */
3210 /* At this point, prev points at the line whose start addr is <= pc, and
3211 item points at the next line. If we ran off the end of the linetable
3212 (pc >= start of the last line), then prev == item. If pc < start of
3213 the first line, prev will not be set. */
3215 /* Is this file's best line closer than the best in the other files?
3216 If so, record this file, and its best line, as best so far. Don't
3217 save prev if it represents the end of a function (i.e. line number
3218 0) instead of a real line. */
3220 if (prev
&& prev
->line
&& (!best
|| prev
->pc
> best
->pc
))
3223 best_symtab
= iter_s
;
3225 /* Discard BEST_END if it's before the PC of the current BEST. */
3226 if (best_end
<= best
->pc
)
3230 /* If another line (denoted by ITEM) is in the linetable and its
3231 PC is after BEST's PC, but before the current BEST_END, then
3232 use ITEM's PC as the new best_end. */
3233 if (best
&& item
< last
&& item
->pc
> best
->pc
3234 && (best_end
== 0 || best_end
> item
->pc
))
3235 best_end
= item
->pc
;
3240 /* If we didn't find any line number info, just return zeros.
3241 We used to return alt->line - 1 here, but that could be
3242 anywhere; if we don't have line number info for this PC,
3243 don't make some up. */
3246 else if (best
->line
== 0)
3248 /* If our best fit is in a range of PC's for which no line
3249 number info is available (line number is zero) then we didn't
3250 find any valid line information. */
3255 val
.symtab
= best_symtab
;
3256 val
.line
= best
->line
;
3258 if (best_end
&& (!alt
|| best_end
< alt
->pc
))
3263 val
.end
= BLOCK_END (BLOCKVECTOR_BLOCK (bv
, GLOBAL_BLOCK
));
3265 val
.section
= section
;
3269 /* Backward compatibility (no section). */
3271 struct symtab_and_line
3272 find_pc_line (CORE_ADDR pc
, int notcurrent
)
3274 struct obj_section
*section
;
3276 section
= find_pc_overlay (pc
);
3277 if (pc_in_unmapped_range (pc
, section
))
3278 pc
= overlay_mapped_address (pc
, section
);
3279 return find_pc_sect_line (pc
, section
, notcurrent
);
3285 find_pc_line_symtab (CORE_ADDR pc
)
3287 struct symtab_and_line sal
;
3289 /* This always passes zero for NOTCURRENT to find_pc_line.
3290 There are currently no callers that ever pass non-zero. */
3291 sal
= find_pc_line (pc
, 0);
3295 /* Find line number LINE in any symtab whose name is the same as
3298 If found, return the symtab that contains the linetable in which it was
3299 found, set *INDEX to the index in the linetable of the best entry
3300 found, and set *EXACT_MATCH to true if the value returned is an
3303 If not found, return NULL. */
3306 find_line_symtab (struct symtab
*sym_tab
, int line
,
3307 int *index
, bool *exact_match
)
3309 int exact
= 0; /* Initialized here to avoid a compiler warning. */
3311 /* BEST_INDEX and BEST_LINETABLE identify the smallest linenumber > LINE
3315 struct linetable
*best_linetable
;
3316 struct symtab
*best_symtab
;
3318 /* First try looking it up in the given symtab. */
3319 best_linetable
= SYMTAB_LINETABLE (sym_tab
);
3320 best_symtab
= sym_tab
;
3321 best_index
= find_line_common (best_linetable
, line
, &exact
, 0);
3322 if (best_index
< 0 || !exact
)
3324 /* Didn't find an exact match. So we better keep looking for
3325 another symtab with the same name. In the case of xcoff,
3326 multiple csects for one source file (produced by IBM's FORTRAN
3327 compiler) produce multiple symtabs (this is unavoidable
3328 assuming csects can be at arbitrary places in memory and that
3329 the GLOBAL_BLOCK of a symtab has a begin and end address). */
3331 /* BEST is the smallest linenumber > LINE so far seen,
3332 or 0 if none has been seen so far.
3333 BEST_INDEX and BEST_LINETABLE identify the item for it. */
3336 if (best_index
>= 0)
3337 best
= best_linetable
->item
[best_index
].line
;
3341 for (objfile
*objfile
: current_program_space
->objfiles ())
3344 objfile
->sf
->qf
->expand_symtabs_with_fullname
3345 (objfile
, symtab_to_fullname (sym_tab
));
3348 for (objfile
*objfile
: current_program_space
->objfiles ())
3350 for (compunit_symtab
*cu
: objfile
->compunits ())
3352 for (symtab
*s
: compunit_filetabs (cu
))
3354 struct linetable
*l
;
3357 if (FILENAME_CMP (sym_tab
->filename
, s
->filename
) != 0)
3359 if (FILENAME_CMP (symtab_to_fullname (sym_tab
),
3360 symtab_to_fullname (s
)) != 0)
3362 l
= SYMTAB_LINETABLE (s
);
3363 ind
= find_line_common (l
, line
, &exact
, 0);
3373 if (best
== 0 || l
->item
[ind
].line
< best
)
3375 best
= l
->item
[ind
].line
;
3390 *index
= best_index
;
3392 *exact_match
= (exact
!= 0);
3397 /* Given SYMTAB, returns all the PCs function in the symtab that
3398 exactly match LINE. Returns an empty vector if there are no exact
3399 matches, but updates BEST_ITEM in this case. */
3401 std::vector
<CORE_ADDR
>
3402 find_pcs_for_symtab_line (struct symtab
*symtab
, int line
,
3403 struct linetable_entry
**best_item
)
3406 std::vector
<CORE_ADDR
> result
;
3408 /* First, collect all the PCs that are at this line. */
3414 idx
= find_line_common (SYMTAB_LINETABLE (symtab
), line
, &was_exact
,
3421 struct linetable_entry
*item
= &SYMTAB_LINETABLE (symtab
)->item
[idx
];
3423 if (*best_item
== NULL
|| item
->line
< (*best_item
)->line
)
3429 result
.push_back (SYMTAB_LINETABLE (symtab
)->item
[idx
].pc
);
3437 /* Set the PC value for a given source file and line number and return true.
3438 Returns false for invalid line number (and sets the PC to 0).
3439 The source file is specified with a struct symtab. */
3442 find_line_pc (struct symtab
*symtab
, int line
, CORE_ADDR
*pc
)
3444 struct linetable
*l
;
3451 symtab
= find_line_symtab (symtab
, line
, &ind
, NULL
);
3454 l
= SYMTAB_LINETABLE (symtab
);
3455 *pc
= l
->item
[ind
].pc
;
3462 /* Find the range of pc values in a line.
3463 Store the starting pc of the line into *STARTPTR
3464 and the ending pc (start of next line) into *ENDPTR.
3465 Returns true to indicate success.
3466 Returns false if could not find the specified line. */
3469 find_line_pc_range (struct symtab_and_line sal
, CORE_ADDR
*startptr
,
3472 CORE_ADDR startaddr
;
3473 struct symtab_and_line found_sal
;
3476 if (startaddr
== 0 && !find_line_pc (sal
.symtab
, sal
.line
, &startaddr
))
3479 /* This whole function is based on address. For example, if line 10 has
3480 two parts, one from 0x100 to 0x200 and one from 0x300 to 0x400, then
3481 "info line *0x123" should say the line goes from 0x100 to 0x200
3482 and "info line *0x355" should say the line goes from 0x300 to 0x400.
3483 This also insures that we never give a range like "starts at 0x134
3484 and ends at 0x12c". */
3486 found_sal
= find_pc_sect_line (startaddr
, sal
.section
, 0);
3487 if (found_sal
.line
!= sal
.line
)
3489 /* The specified line (sal) has zero bytes. */
3490 *startptr
= found_sal
.pc
;
3491 *endptr
= found_sal
.pc
;
3495 *startptr
= found_sal
.pc
;
3496 *endptr
= found_sal
.end
;
3501 /* Given a line table and a line number, return the index into the line
3502 table for the pc of the nearest line whose number is >= the specified one.
3503 Return -1 if none is found. The value is >= 0 if it is an index.
3504 START is the index at which to start searching the line table.
3506 Set *EXACT_MATCH nonzero if the value returned is an exact match. */
3509 find_line_common (struct linetable
*l
, int lineno
,
3510 int *exact_match
, int start
)
3515 /* BEST is the smallest linenumber > LINENO so far seen,
3516 or 0 if none has been seen so far.
3517 BEST_INDEX identifies the item for it. */
3519 int best_index
= -1;
3530 for (i
= start
; i
< len
; i
++)
3532 struct linetable_entry
*item
= &(l
->item
[i
]);
3534 if (item
->line
== lineno
)
3536 /* Return the first (lowest address) entry which matches. */
3541 if (item
->line
> lineno
&& (best
== 0 || item
->line
< best
))
3548 /* If we got here, we didn't get an exact match. */
3553 find_pc_line_pc_range (CORE_ADDR pc
, CORE_ADDR
*startptr
, CORE_ADDR
*endptr
)
3555 struct symtab_and_line sal
;
3557 sal
= find_pc_line (pc
, 0);
3560 return sal
.symtab
!= 0;
3563 /* Helper for find_function_start_sal. Does most of the work, except
3564 setting the sal's symbol. */
3566 static symtab_and_line
3567 find_function_start_sal_1 (CORE_ADDR func_addr
, obj_section
*section
,
3570 symtab_and_line sal
= find_pc_sect_line (func_addr
, section
, 0);
3572 if (funfirstline
&& sal
.symtab
!= NULL
3573 && (COMPUNIT_LOCATIONS_VALID (SYMTAB_COMPUNIT (sal
.symtab
))
3574 || SYMTAB_LANGUAGE (sal
.symtab
) == language_asm
))
3576 struct gdbarch
*gdbarch
= get_objfile_arch (SYMTAB_OBJFILE (sal
.symtab
));
3579 if (gdbarch_skip_entrypoint_p (gdbarch
))
3580 sal
.pc
= gdbarch_skip_entrypoint (gdbarch
, sal
.pc
);
3584 /* We always should have a line for the function start address.
3585 If we don't, something is odd. Create a plain SAL referring
3586 just the PC and hope that skip_prologue_sal (if requested)
3587 can find a line number for after the prologue. */
3588 if (sal
.pc
< func_addr
)
3591 sal
.pspace
= current_program_space
;
3593 sal
.section
= section
;
3597 skip_prologue_sal (&sal
);
3605 find_function_start_sal (CORE_ADDR func_addr
, obj_section
*section
,
3609 = find_function_start_sal_1 (func_addr
, section
, funfirstline
);
3611 /* find_function_start_sal_1 does a linetable search, so it finds
3612 the symtab and linenumber, but not a symbol. Fill in the
3613 function symbol too. */
3614 sal
.symbol
= find_pc_sect_containing_function (sal
.pc
, sal
.section
);
3622 find_function_start_sal (symbol
*sym
, bool funfirstline
)
3624 fixup_symbol_section (sym
, NULL
);
3626 = find_function_start_sal_1 (BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
)),
3627 SYMBOL_OBJ_SECTION (symbol_objfile (sym
), sym
),
3634 /* Given a function start address FUNC_ADDR and SYMTAB, find the first
3635 address for that function that has an entry in SYMTAB's line info
3636 table. If such an entry cannot be found, return FUNC_ADDR
3640 skip_prologue_using_lineinfo (CORE_ADDR func_addr
, struct symtab
*symtab
)
3642 CORE_ADDR func_start
, func_end
;
3643 struct linetable
*l
;
3646 /* Give up if this symbol has no lineinfo table. */
3647 l
= SYMTAB_LINETABLE (symtab
);
3651 /* Get the range for the function's PC values, or give up if we
3652 cannot, for some reason. */
3653 if (!find_pc_partial_function (func_addr
, NULL
, &func_start
, &func_end
))
3656 /* Linetable entries are ordered by PC values, see the commentary in
3657 symtab.h where `struct linetable' is defined. Thus, the first
3658 entry whose PC is in the range [FUNC_START..FUNC_END[ is the
3659 address we are looking for. */
3660 for (i
= 0; i
< l
->nitems
; i
++)
3662 struct linetable_entry
*item
= &(l
->item
[i
]);
3664 /* Don't use line numbers of zero, they mark special entries in
3665 the table. See the commentary on symtab.h before the
3666 definition of struct linetable. */
3667 if (item
->line
> 0 && func_start
<= item
->pc
&& item
->pc
< func_end
)
3674 /* Adjust SAL to the first instruction past the function prologue.
3675 If the PC was explicitly specified, the SAL is not changed.
3676 If the line number was explicitly specified then the SAL can still be
3677 updated, unless the language for SAL is assembler, in which case the SAL
3678 will be left unchanged.
3679 If SAL is already past the prologue, then do nothing. */
3682 skip_prologue_sal (struct symtab_and_line
*sal
)
3685 struct symtab_and_line start_sal
;
3686 CORE_ADDR pc
, saved_pc
;
3687 struct obj_section
*section
;
3689 struct objfile
*objfile
;
3690 struct gdbarch
*gdbarch
;
3691 const struct block
*b
, *function_block
;
3692 int force_skip
, skip
;
3694 /* Do not change the SAL if PC was specified explicitly. */
3695 if (sal
->explicit_pc
)
3698 /* In assembly code, if the user asks for a specific line then we should
3699 not adjust the SAL. The user already has instruction level
3700 visibility in this case, so selecting a line other than one requested
3701 is likely to be the wrong choice. */
3702 if (sal
->symtab
!= nullptr
3703 && sal
->explicit_line
3704 && SYMTAB_LANGUAGE (sal
->symtab
) == language_asm
)
3707 scoped_restore_current_pspace_and_thread restore_pspace_thread
;
3709 switch_to_program_space_and_thread (sal
->pspace
);
3711 sym
= find_pc_sect_function (sal
->pc
, sal
->section
);
3714 fixup_symbol_section (sym
, NULL
);
3716 objfile
= symbol_objfile (sym
);
3717 pc
= BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
));
3718 section
= SYMBOL_OBJ_SECTION (objfile
, sym
);
3719 name
= SYMBOL_LINKAGE_NAME (sym
);
3723 struct bound_minimal_symbol msymbol
3724 = lookup_minimal_symbol_by_pc_section (sal
->pc
, sal
->section
);
3726 if (msymbol
.minsym
== NULL
)
3729 objfile
= msymbol
.objfile
;
3730 pc
= BMSYMBOL_VALUE_ADDRESS (msymbol
);
3731 section
= MSYMBOL_OBJ_SECTION (objfile
, msymbol
.minsym
);
3732 name
= MSYMBOL_LINKAGE_NAME (msymbol
.minsym
);
3735 gdbarch
= get_objfile_arch (objfile
);
3737 /* Process the prologue in two passes. In the first pass try to skip the
3738 prologue (SKIP is true) and verify there is a real need for it (indicated
3739 by FORCE_SKIP). If no such reason was found run a second pass where the
3740 prologue is not skipped (SKIP is false). */
3745 /* Be conservative - allow direct PC (without skipping prologue) only if we
3746 have proven the CU (Compilation Unit) supports it. sal->SYMTAB does not
3747 have to be set by the caller so we use SYM instead. */
3749 && COMPUNIT_LOCATIONS_VALID (SYMTAB_COMPUNIT (symbol_symtab (sym
))))
3757 /* If the function is in an unmapped overlay, use its unmapped LMA address,
3758 so that gdbarch_skip_prologue has something unique to work on. */
3759 if (section_is_overlay (section
) && !section_is_mapped (section
))
3760 pc
= overlay_unmapped_address (pc
, section
);
3762 /* Skip "first line" of function (which is actually its prologue). */
3763 pc
+= gdbarch_deprecated_function_start_offset (gdbarch
);
3764 if (gdbarch_skip_entrypoint_p (gdbarch
))
3765 pc
= gdbarch_skip_entrypoint (gdbarch
, pc
);
3767 pc
= gdbarch_skip_prologue_noexcept (gdbarch
, pc
);
3769 /* For overlays, map pc back into its mapped VMA range. */
3770 pc
= overlay_mapped_address (pc
, section
);
3772 /* Calculate line number. */
3773 start_sal
= find_pc_sect_line (pc
, section
, 0);
3775 /* Check if gdbarch_skip_prologue left us in mid-line, and the next
3776 line is still part of the same function. */
3777 if (skip
&& start_sal
.pc
!= pc
3778 && (sym
? (BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
)) <= start_sal
.end
3779 && start_sal
.end
< BLOCK_END (SYMBOL_BLOCK_VALUE (sym
)))
3780 : (lookup_minimal_symbol_by_pc_section (start_sal
.end
, section
).minsym
3781 == lookup_minimal_symbol_by_pc_section (pc
, section
).minsym
)))
3783 /* First pc of next line */
3785 /* Recalculate the line number (might not be N+1). */
3786 start_sal
= find_pc_sect_line (pc
, section
, 0);
3789 /* On targets with executable formats that don't have a concept of
3790 constructors (ELF with .init has, PE doesn't), gcc emits a call
3791 to `__main' in `main' between the prologue and before user
3793 if (gdbarch_skip_main_prologue_p (gdbarch
)
3794 && name
&& strcmp_iw (name
, "main") == 0)
3796 pc
= gdbarch_skip_main_prologue (gdbarch
, pc
);
3797 /* Recalculate the line number (might not be N+1). */
3798 start_sal
= find_pc_sect_line (pc
, section
, 0);
3802 while (!force_skip
&& skip
--);
3804 /* If we still don't have a valid source line, try to find the first
3805 PC in the lineinfo table that belongs to the same function. This
3806 happens with COFF debug info, which does not seem to have an
3807 entry in lineinfo table for the code after the prologue which has
3808 no direct relation to source. For example, this was found to be
3809 the case with the DJGPP target using "gcc -gcoff" when the
3810 compiler inserted code after the prologue to make sure the stack
3812 if (!force_skip
&& sym
&& start_sal
.symtab
== NULL
)
3814 pc
= skip_prologue_using_lineinfo (pc
, symbol_symtab (sym
));
3815 /* Recalculate the line number. */
3816 start_sal
= find_pc_sect_line (pc
, section
, 0);
3819 /* If we're already past the prologue, leave SAL unchanged. Otherwise
3820 forward SAL to the end of the prologue. */
3825 sal
->section
= section
;
3826 sal
->symtab
= start_sal
.symtab
;
3827 sal
->line
= start_sal
.line
;
3828 sal
->end
= start_sal
.end
;
3830 /* Check if we are now inside an inlined function. If we can,
3831 use the call site of the function instead. */
3832 b
= block_for_pc_sect (sal
->pc
, sal
->section
);
3833 function_block
= NULL
;
3836 if (BLOCK_FUNCTION (b
) != NULL
&& block_inlined_p (b
))
3838 else if (BLOCK_FUNCTION (b
) != NULL
)
3840 b
= BLOCK_SUPERBLOCK (b
);
3842 if (function_block
!= NULL
3843 && SYMBOL_LINE (BLOCK_FUNCTION (function_block
)) != 0)
3845 sal
->line
= SYMBOL_LINE (BLOCK_FUNCTION (function_block
));
3846 sal
->symtab
= symbol_symtab (BLOCK_FUNCTION (function_block
));
3850 /* Given PC at the function's start address, attempt to find the
3851 prologue end using SAL information. Return zero if the skip fails.
3853 A non-optimized prologue traditionally has one SAL for the function
3854 and a second for the function body. A single line function has
3855 them both pointing at the same line.
3857 An optimized prologue is similar but the prologue may contain
3858 instructions (SALs) from the instruction body. Need to skip those
3859 while not getting into the function body.
3861 The functions end point and an increasing SAL line are used as
3862 indicators of the prologue's endpoint.
3864 This code is based on the function refine_prologue_limit
3868 skip_prologue_using_sal (struct gdbarch
*gdbarch
, CORE_ADDR func_addr
)
3870 struct symtab_and_line prologue_sal
;
3873 const struct block
*bl
;
3875 /* Get an initial range for the function. */
3876 find_pc_partial_function (func_addr
, NULL
, &start_pc
, &end_pc
);
3877 start_pc
+= gdbarch_deprecated_function_start_offset (gdbarch
);
3879 prologue_sal
= find_pc_line (start_pc
, 0);
3880 if (prologue_sal
.line
!= 0)
3882 /* For languages other than assembly, treat two consecutive line
3883 entries at the same address as a zero-instruction prologue.
3884 The GNU assembler emits separate line notes for each instruction
3885 in a multi-instruction macro, but compilers generally will not
3887 if (prologue_sal
.symtab
->language
!= language_asm
)
3889 struct linetable
*linetable
= SYMTAB_LINETABLE (prologue_sal
.symtab
);
3892 /* Skip any earlier lines, and any end-of-sequence marker
3893 from a previous function. */
3894 while (linetable
->item
[idx
].pc
!= prologue_sal
.pc
3895 || linetable
->item
[idx
].line
== 0)
3898 if (idx
+1 < linetable
->nitems
3899 && linetable
->item
[idx
+1].line
!= 0
3900 && linetable
->item
[idx
+1].pc
== start_pc
)
3904 /* If there is only one sal that covers the entire function,
3905 then it is probably a single line function, like
3907 if (prologue_sal
.end
>= end_pc
)
3910 while (prologue_sal
.end
< end_pc
)
3912 struct symtab_and_line sal
;
3914 sal
= find_pc_line (prologue_sal
.end
, 0);
3917 /* Assume that a consecutive SAL for the same (or larger)
3918 line mark the prologue -> body transition. */
3919 if (sal
.line
>= prologue_sal
.line
)
3921 /* Likewise if we are in a different symtab altogether
3922 (e.g. within a file included via #include). */
3923 if (sal
.symtab
!= prologue_sal
.symtab
)
3926 /* The line number is smaller. Check that it's from the
3927 same function, not something inlined. If it's inlined,
3928 then there is no point comparing the line numbers. */
3929 bl
= block_for_pc (prologue_sal
.end
);
3932 if (block_inlined_p (bl
))
3934 if (BLOCK_FUNCTION (bl
))
3939 bl
= BLOCK_SUPERBLOCK (bl
);
3944 /* The case in which compiler's optimizer/scheduler has
3945 moved instructions into the prologue. We look ahead in
3946 the function looking for address ranges whose
3947 corresponding line number is less the first one that we
3948 found for the function. This is more conservative then
3949 refine_prologue_limit which scans a large number of SALs
3950 looking for any in the prologue. */
3955 if (prologue_sal
.end
< end_pc
)
3956 /* Return the end of this line, or zero if we could not find a
3958 return prologue_sal
.end
;
3960 /* Don't return END_PC, which is past the end of the function. */
3961 return prologue_sal
.pc
;
3967 find_function_alias_target (bound_minimal_symbol msymbol
)
3969 CORE_ADDR func_addr
;
3970 if (!msymbol_is_function (msymbol
.objfile
, msymbol
.minsym
, &func_addr
))
3973 symbol
*sym
= find_pc_function (func_addr
);
3975 && SYMBOL_CLASS (sym
) == LOC_BLOCK
3976 && BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
)) == func_addr
)
3983 /* If P is of the form "operator[ \t]+..." where `...' is
3984 some legitimate operator text, return a pointer to the
3985 beginning of the substring of the operator text.
3986 Otherwise, return "". */
3989 operator_chars (const char *p
, const char **end
)
3992 if (!startswith (p
, CP_OPERATOR_STR
))
3994 p
+= CP_OPERATOR_LEN
;
3996 /* Don't get faked out by `operator' being part of a longer
3998 if (isalpha (*p
) || *p
== '_' || *p
== '$' || *p
== '\0')
4001 /* Allow some whitespace between `operator' and the operator symbol. */
4002 while (*p
== ' ' || *p
== '\t')
4005 /* Recognize 'operator TYPENAME'. */
4007 if (isalpha (*p
) || *p
== '_' || *p
== '$')
4009 const char *q
= p
+ 1;
4011 while (isalnum (*q
) || *q
== '_' || *q
== '$')
4020 case '\\': /* regexp quoting */
4023 if (p
[2] == '=') /* 'operator\*=' */
4025 else /* 'operator\*' */
4029 else if (p
[1] == '[')
4032 error (_("mismatched quoting on brackets, "
4033 "try 'operator\\[\\]'"));
4034 else if (p
[2] == '\\' && p
[3] == ']')
4036 *end
= p
+ 4; /* 'operator\[\]' */
4040 error (_("nothing is allowed between '[' and ']'"));
4044 /* Gratuitous quote: skip it and move on. */
4066 if (p
[0] == '-' && p
[1] == '>')
4068 /* Struct pointer member operator 'operator->'. */
4071 *end
= p
+ 3; /* 'operator->*' */
4074 else if (p
[2] == '\\')
4076 *end
= p
+ 4; /* Hopefully 'operator->\*' */
4081 *end
= p
+ 2; /* 'operator->' */
4085 if (p
[1] == '=' || p
[1] == p
[0])
4096 error (_("`operator ()' must be specified "
4097 "without whitespace in `()'"));
4102 error (_("`operator ?:' must be specified "
4103 "without whitespace in `?:'"));
4108 error (_("`operator []' must be specified "
4109 "without whitespace in `[]'"));
4113 error (_("`operator %s' not supported"), p
);
4122 /* What part to match in a file name. */
4124 struct filename_partial_match_opts
4126 /* Only match the directory name part. */
4127 bool dirname
= false;
4129 /* Only match the basename part. */
4130 bool basename
= false;
4133 /* Data structure to maintain printing state for output_source_filename. */
4135 struct output_source_filename_data
4137 /* Output only filenames matching REGEXP. */
4139 gdb::optional
<compiled_regex
> c_regexp
;
4140 /* Possibly only match a part of the filename. */
4141 filename_partial_match_opts partial_match
;
4144 /* Cache of what we've seen so far. */
4145 struct filename_seen_cache
*filename_seen_cache
;
4147 /* Flag of whether we're printing the first one. */
4151 /* Slave routine for sources_info. Force line breaks at ,'s.
4152 NAME is the name to print.
4153 DATA contains the state for printing and watching for duplicates. */
4156 output_source_filename (const char *name
,
4157 struct output_source_filename_data
*data
)
4159 /* Since a single source file can result in several partial symbol
4160 tables, we need to avoid printing it more than once. Note: if
4161 some of the psymtabs are read in and some are not, it gets
4162 printed both under "Source files for which symbols have been
4163 read" and "Source files for which symbols will be read in on
4164 demand". I consider this a reasonable way to deal with the
4165 situation. I'm not sure whether this can also happen for
4166 symtabs; it doesn't hurt to check. */
4168 /* Was NAME already seen? */
4169 if (data
->filename_seen_cache
->seen (name
))
4171 /* Yes; don't print it again. */
4175 /* Does it match data->regexp? */
4176 if (data
->c_regexp
.has_value ())
4178 const char *to_match
;
4179 std::string dirname
;
4181 if (data
->partial_match
.dirname
)
4183 dirname
= ldirname (name
);
4184 to_match
= dirname
.c_str ();
4186 else if (data
->partial_match
.basename
)
4187 to_match
= lbasename (name
);
4191 if (data
->c_regexp
->exec (to_match
, 0, NULL
, 0) != 0)
4195 /* Print it and reset *FIRST. */
4197 printf_filtered (", ");
4201 fputs_styled (name
, file_name_style
.style (), gdb_stdout
);
4204 /* A callback for map_partial_symbol_filenames. */
4207 output_partial_symbol_filename (const char *filename
, const char *fullname
,
4210 output_source_filename (fullname
? fullname
: filename
,
4211 (struct output_source_filename_data
*) data
);
4214 using isrc_flag_option_def
4215 = gdb::option::flag_option_def
<filename_partial_match_opts
>;
4217 static const gdb::option::option_def info_sources_option_defs
[] = {
4219 isrc_flag_option_def
{
4221 [] (filename_partial_match_opts
*opts
) { return &opts
->dirname
; },
4222 N_("Show only the files having a dirname matching REGEXP."),
4225 isrc_flag_option_def
{
4227 [] (filename_partial_match_opts
*opts
) { return &opts
->basename
; },
4228 N_("Show only the files having a basename matching REGEXP."),
4233 /* Create an option_def_group for the "info sources" options, with
4234 ISRC_OPTS as context. */
4236 static inline gdb::option::option_def_group
4237 make_info_sources_options_def_group (filename_partial_match_opts
*isrc_opts
)
4239 return {{info_sources_option_defs
}, isrc_opts
};
4242 /* Prints the header message for the source files that will be printed
4243 with the matching info present in DATA. SYMBOL_MSG is a message
4244 that tells what will or has been done with the symbols of the
4245 matching source files. */
4248 print_info_sources_header (const char *symbol_msg
,
4249 const struct output_source_filename_data
*data
)
4251 puts_filtered (symbol_msg
);
4252 if (!data
->regexp
.empty ())
4254 if (data
->partial_match
.dirname
)
4255 printf_filtered (_("(dirname matching regular expression \"%s\")"),
4256 data
->regexp
.c_str ());
4257 else if (data
->partial_match
.basename
)
4258 printf_filtered (_("(basename matching regular expression \"%s\")"),
4259 data
->regexp
.c_str ());
4261 printf_filtered (_("(filename matching regular expression \"%s\")"),
4262 data
->regexp
.c_str ());
4264 puts_filtered ("\n");
4267 /* Completer for "info sources". */
4270 info_sources_command_completer (cmd_list_element
*ignore
,
4271 completion_tracker
&tracker
,
4272 const char *text
, const char *word
)
4274 const auto group
= make_info_sources_options_def_group (nullptr);
4275 if (gdb::option::complete_options
4276 (tracker
, &text
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, group
))
4281 info_sources_command (const char *args
, int from_tty
)
4283 struct output_source_filename_data data
;
4285 if (!have_full_symbols () && !have_partial_symbols ())
4287 error (_("No symbol table is loaded. Use the \"file\" command."));
4290 filename_seen_cache filenames_seen
;
4292 auto group
= make_info_sources_options_def_group (&data
.partial_match
);
4294 gdb::option::process_options
4295 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_ERROR
, group
);
4297 if (args
!= NULL
&& *args
!= '\000')
4300 data
.filename_seen_cache
= &filenames_seen
;
4303 if (data
.partial_match
.dirname
&& data
.partial_match
.basename
)
4304 error (_("You cannot give both -basename and -dirname to 'info sources'."));
4305 if ((data
.partial_match
.dirname
|| data
.partial_match
.basename
)
4306 && data
.regexp
.empty ())
4307 error (_("Missing REGEXP for 'info sources'."));
4309 if (data
.regexp
.empty ())
4310 data
.c_regexp
.reset ();
4313 int cflags
= REG_NOSUB
;
4314 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
4315 cflags
|= REG_ICASE
;
4317 data
.c_regexp
.emplace (data
.regexp
.c_str (), cflags
,
4318 _("Invalid regexp"));
4321 print_info_sources_header
4322 (_("Source files for which symbols have been read in:\n"), &data
);
4324 for (objfile
*objfile
: current_program_space
->objfiles ())
4326 for (compunit_symtab
*cu
: objfile
->compunits ())
4328 for (symtab
*s
: compunit_filetabs (cu
))
4330 const char *fullname
= symtab_to_fullname (s
);
4332 output_source_filename (fullname
, &data
);
4336 printf_filtered ("\n\n");
4338 print_info_sources_header
4339 (_("Source files for which symbols will be read in on demand:\n"), &data
);
4341 filenames_seen
.clear ();
4343 map_symbol_filenames (output_partial_symbol_filename
, &data
,
4344 1 /*need_fullname*/);
4345 printf_filtered ("\n");
4348 /* Compare FILE against all the NFILES entries of FILES. If BASENAMES is
4349 non-zero compare only lbasename of FILES. */
4352 file_matches (const char *file
, const char *files
[], int nfiles
, int basenames
)
4356 if (file
!= NULL
&& nfiles
!= 0)
4358 for (i
= 0; i
< nfiles
; i
++)
4360 if (compare_filenames_for_search (file
, (basenames
4361 ? lbasename (files
[i
])
4366 else if (nfiles
== 0)
4371 /* Helper function for sort_search_symbols_remove_dups and qsort. Can only
4372 sort symbols, not minimal symbols. */
4375 symbol_search::compare_search_syms (const symbol_search
&sym_a
,
4376 const symbol_search
&sym_b
)
4380 c
= FILENAME_CMP (symbol_symtab (sym_a
.symbol
)->filename
,
4381 symbol_symtab (sym_b
.symbol
)->filename
);
4385 if (sym_a
.block
!= sym_b
.block
)
4386 return sym_a
.block
- sym_b
.block
;
4388 return strcmp (SYMBOL_PRINT_NAME (sym_a
.symbol
),
4389 SYMBOL_PRINT_NAME (sym_b
.symbol
));
4392 /* Returns true if the type_name of symbol_type of SYM matches TREG.
4393 If SYM has no symbol_type or symbol_name, returns false. */
4396 treg_matches_sym_type_name (const compiled_regex
&treg
,
4397 const struct symbol
*sym
)
4399 struct type
*sym_type
;
4400 std::string printed_sym_type_name
;
4402 if (symbol_lookup_debug
> 1)
4404 fprintf_unfiltered (gdb_stdlog
,
4405 "treg_matches_sym_type_name\n sym %s\n",
4406 SYMBOL_NATURAL_NAME (sym
));
4409 sym_type
= SYMBOL_TYPE (sym
);
4410 if (sym_type
== NULL
)
4414 scoped_switch_to_sym_language_if_auto
l (sym
);
4416 printed_sym_type_name
= type_to_string (sym_type
);
4420 if (symbol_lookup_debug
> 1)
4422 fprintf_unfiltered (gdb_stdlog
,
4423 " sym_type_name %s\n",
4424 printed_sym_type_name
.c_str ());
4428 if (printed_sym_type_name
.empty ())
4431 return treg
.exec (printed_sym_type_name
.c_str (), 0, NULL
, 0) == 0;
4435 /* Sort the symbols in RESULT and remove duplicates. */
4438 sort_search_symbols_remove_dups (std::vector
<symbol_search
> *result
)
4440 std::sort (result
->begin (), result
->end ());
4441 result
->erase (std::unique (result
->begin (), result
->end ()),
4445 /* Search the symbol table for matches to the regular expression REGEXP,
4446 returning the results.
4448 Only symbols of KIND are searched:
4449 VARIABLES_DOMAIN - search all symbols, excluding functions, type names,
4450 and constants (enums).
4451 if T_REGEXP is not NULL, only returns var that have
4452 a type matching regular expression T_REGEXP.
4453 FUNCTIONS_DOMAIN - search all functions
4454 TYPES_DOMAIN - search all type names
4455 ALL_DOMAIN - an internal error for this function
4457 Within each file the results are sorted locally; each symtab's global and
4458 static blocks are separately alphabetized.
4459 Duplicate entries are removed.
4461 When EXCLUDE_MINSYMS is false then matching minsyms are also returned,
4462 otherwise they are excluded. */
4464 std::vector
<symbol_search
>
4465 search_symbols (const char *regexp
, enum search_domain kind
,
4466 const char *t_regexp
,
4467 int nfiles
, const char *files
[],
4468 bool exclude_minsyms
)
4470 const struct blockvector
*bv
;
4471 const struct block
*b
;
4473 struct block_iterator iter
;
4476 static const enum minimal_symbol_type types
[]
4477 = {mst_data
, mst_text
, mst_unknown
};
4478 static const enum minimal_symbol_type types2
[]
4479 = {mst_bss
, mst_file_text
, mst_unknown
};
4480 static const enum minimal_symbol_type types3
[]
4481 = {mst_file_data
, mst_solib_trampoline
, mst_unknown
};
4482 static const enum minimal_symbol_type types4
[]
4483 = {mst_file_bss
, mst_text_gnu_ifunc
, mst_unknown
};
4484 enum minimal_symbol_type ourtype
;
4485 enum minimal_symbol_type ourtype2
;
4486 enum minimal_symbol_type ourtype3
;
4487 enum minimal_symbol_type ourtype4
;
4488 std::vector
<symbol_search
> result
;
4489 gdb::optional
<compiled_regex
> preg
;
4490 gdb::optional
<compiled_regex
> treg
;
4492 gdb_assert (kind
<= TYPES_DOMAIN
);
4494 ourtype
= types
[kind
];
4495 ourtype2
= types2
[kind
];
4496 ourtype3
= types3
[kind
];
4497 ourtype4
= types4
[kind
];
4501 /* Make sure spacing is right for C++ operators.
4502 This is just a courtesy to make the matching less sensitive
4503 to how many spaces the user leaves between 'operator'
4504 and <TYPENAME> or <OPERATOR>. */
4506 const char *opname
= operator_chars (regexp
, &opend
);
4510 int fix
= -1; /* -1 means ok; otherwise number of
4513 if (isalpha (*opname
) || *opname
== '_' || *opname
== '$')
4515 /* There should 1 space between 'operator' and 'TYPENAME'. */
4516 if (opname
[-1] != ' ' || opname
[-2] == ' ')
4521 /* There should 0 spaces between 'operator' and 'OPERATOR'. */
4522 if (opname
[-1] == ' ')
4525 /* If wrong number of spaces, fix it. */
4528 char *tmp
= (char *) alloca (8 + fix
+ strlen (opname
) + 1);
4530 sprintf (tmp
, "operator%.*s%s", fix
, " ", opname
);
4535 int cflags
= REG_NOSUB
| (case_sensitivity
== case_sensitive_off
4537 preg
.emplace (regexp
, cflags
, _("Invalid regexp"));
4540 if (t_regexp
!= NULL
)
4542 int cflags
= REG_NOSUB
| (case_sensitivity
== case_sensitive_off
4544 treg
.emplace (t_regexp
, cflags
, _("Invalid regexp"));
4547 /* Search through the partial symtabs *first* for all symbols
4548 matching the regexp. That way we don't have to reproduce all of
4549 the machinery below. */
4550 expand_symtabs_matching ([&] (const char *filename
, bool basenames
)
4552 return file_matches (filename
, files
, nfiles
,
4555 lookup_name_info::match_any (),
4556 [&] (const char *symname
)
4558 return (!preg
.has_value ()
4559 || preg
->exec (symname
,
4565 /* Here, we search through the minimal symbol tables for functions
4566 and variables that match, and force their symbols to be read.
4567 This is in particular necessary for demangled variable names,
4568 which are no longer put into the partial symbol tables.
4569 The symbol will then be found during the scan of symtabs below.
4571 For functions, find_pc_symtab should succeed if we have debug info
4572 for the function, for variables we have to call
4573 lookup_symbol_in_objfile_from_linkage_name to determine if the variable
4575 If the lookup fails, set found_misc so that we will rescan to print
4576 any matching symbols without debug info.
4577 We only search the objfile the msymbol came from, we no longer search
4578 all objfiles. In large programs (1000s of shared libs) searching all
4579 objfiles is not worth the pain. */
4581 if (nfiles
== 0 && (kind
== VARIABLES_DOMAIN
|| kind
== FUNCTIONS_DOMAIN
))
4583 for (objfile
*objfile
: current_program_space
->objfiles ())
4585 for (minimal_symbol
*msymbol
: objfile
->msymbols ())
4589 if (msymbol
->created_by_gdb
)
4592 if (MSYMBOL_TYPE (msymbol
) == ourtype
4593 || MSYMBOL_TYPE (msymbol
) == ourtype2
4594 || MSYMBOL_TYPE (msymbol
) == ourtype3
4595 || MSYMBOL_TYPE (msymbol
) == ourtype4
)
4597 if (!preg
.has_value ()
4598 || preg
->exec (MSYMBOL_NATURAL_NAME (msymbol
), 0,
4601 /* Note: An important side-effect of these
4602 lookup functions is to expand the symbol
4603 table if msymbol is found, for the benefit of
4604 the next loop on compunits. */
4605 if (kind
== FUNCTIONS_DOMAIN
4606 ? (find_pc_compunit_symtab
4607 (MSYMBOL_VALUE_ADDRESS (objfile
, msymbol
))
4609 : (lookup_symbol_in_objfile_from_linkage_name
4610 (objfile
, MSYMBOL_LINKAGE_NAME (msymbol
),
4620 for (objfile
*objfile
: current_program_space
->objfiles ())
4622 for (compunit_symtab
*cust
: objfile
->compunits ())
4624 bv
= COMPUNIT_BLOCKVECTOR (cust
);
4625 for (i
= GLOBAL_BLOCK
; i
<= STATIC_BLOCK
; i
++)
4627 b
= BLOCKVECTOR_BLOCK (bv
, i
);
4628 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
4630 struct symtab
*real_symtab
= symbol_symtab (sym
);
4634 /* Check first sole REAL_SYMTAB->FILENAME. It does
4635 not need to be a substring of symtab_to_fullname as
4636 it may contain "./" etc. */
4637 if ((file_matches (real_symtab
->filename
, files
, nfiles
, 0)
4638 || ((basenames_may_differ
4639 || file_matches (lbasename (real_symtab
->filename
),
4641 && file_matches (symtab_to_fullname (real_symtab
),
4643 && ((!preg
.has_value ()
4644 || preg
->exec (SYMBOL_NATURAL_NAME (sym
), 0,
4646 && ((kind
== VARIABLES_DOMAIN
4647 && SYMBOL_CLASS (sym
) != LOC_TYPEDEF
4648 && SYMBOL_CLASS (sym
) != LOC_UNRESOLVED
4649 && SYMBOL_CLASS (sym
) != LOC_BLOCK
4650 /* LOC_CONST can be used for more than
4651 just enums, e.g., c++ static const
4652 members. We only want to skip enums
4654 && !(SYMBOL_CLASS (sym
) == LOC_CONST
4655 && (TYPE_CODE (SYMBOL_TYPE (sym
))
4657 && (!treg
.has_value ()
4658 || treg_matches_sym_type_name (*treg
, sym
)))
4659 || (kind
== FUNCTIONS_DOMAIN
4660 && SYMBOL_CLASS (sym
) == LOC_BLOCK
4661 && (!treg
.has_value ()
4662 || treg_matches_sym_type_name (*treg
,
4664 || (kind
== TYPES_DOMAIN
4665 && SYMBOL_CLASS (sym
) == LOC_TYPEDEF
4666 && SYMBOL_DOMAIN (sym
) != MODULE_DOMAIN
))))
4669 result
.emplace_back (i
, sym
);
4676 if (!result
.empty ())
4677 sort_search_symbols_remove_dups (&result
);
4679 /* If there are no eyes, avoid all contact. I mean, if there are
4680 no debug symbols, then add matching minsyms. But if the user wants
4681 to see symbols matching a type regexp, then never give a minimal symbol,
4682 as we assume that a minimal symbol does not have a type. */
4684 if ((found_misc
|| (nfiles
== 0 && kind
!= FUNCTIONS_DOMAIN
))
4686 && !treg
.has_value ())
4688 for (objfile
*objfile
: current_program_space
->objfiles ())
4690 for (minimal_symbol
*msymbol
: objfile
->msymbols ())
4694 if (msymbol
->created_by_gdb
)
4697 if (MSYMBOL_TYPE (msymbol
) == ourtype
4698 || MSYMBOL_TYPE (msymbol
) == ourtype2
4699 || MSYMBOL_TYPE (msymbol
) == ourtype3
4700 || MSYMBOL_TYPE (msymbol
) == ourtype4
)
4702 if (!preg
.has_value ()
4703 || preg
->exec (MSYMBOL_NATURAL_NAME (msymbol
), 0,
4706 /* For functions we can do a quick check of whether the
4707 symbol might be found via find_pc_symtab. */
4708 if (kind
!= FUNCTIONS_DOMAIN
4709 || (find_pc_compunit_symtab
4710 (MSYMBOL_VALUE_ADDRESS (objfile
, msymbol
))
4713 if (lookup_symbol_in_objfile_from_linkage_name
4714 (objfile
, MSYMBOL_LINKAGE_NAME (msymbol
),
4719 result
.emplace_back (i
, msymbol
, objfile
);
4731 /* Helper function for symtab_symbol_info, this function uses
4732 the data returned from search_symbols() to print information
4733 regarding the match to gdb_stdout. If LAST is not NULL,
4734 print file and line number information for the symbol as
4735 well. Skip printing the filename if it matches LAST. */
4738 print_symbol_info (enum search_domain kind
,
4740 int block
, const char *last
)
4742 scoped_switch_to_sym_language_if_auto
l (sym
);
4743 struct symtab
*s
= symbol_symtab (sym
);
4747 const char *s_filename
= symtab_to_filename_for_display (s
);
4749 if (filename_cmp (last
, s_filename
) != 0)
4751 printf_filtered (_("\nFile %ps:\n"),
4752 styled_string (file_name_style
.style (),
4756 if (SYMBOL_LINE (sym
) != 0)
4757 printf_filtered ("%d:\t", SYMBOL_LINE (sym
));
4759 puts_filtered ("\t");
4762 if (kind
!= TYPES_DOMAIN
&& block
== STATIC_BLOCK
)
4763 printf_filtered ("static ");
4765 /* Typedef that is not a C++ class. */
4766 if (kind
== TYPES_DOMAIN
4767 && SYMBOL_DOMAIN (sym
) != STRUCT_DOMAIN
)
4769 /* FIXME: For C (and C++) we end up with a difference in output here
4770 between how a typedef is printed, and non-typedefs are printed.
4771 The TYPEDEF_PRINT code places a ";" at the end in an attempt to
4772 appear C-like, while TYPE_PRINT doesn't.
4774 For the struct printing case below, things are worse, we force
4775 printing of the ";" in this function, which is going to be wrong
4776 for languages that don't require a ";" between statements. */
4777 if (TYPE_CODE (SYMBOL_TYPE (sym
)) == TYPE_CODE_TYPEDEF
)
4778 typedef_print (SYMBOL_TYPE (sym
), sym
, gdb_stdout
);
4781 type_print (SYMBOL_TYPE (sym
), "", gdb_stdout
, -1);
4782 printf_filtered ("\n");
4785 /* variable, func, or typedef-that-is-c++-class. */
4786 else if (kind
< TYPES_DOMAIN
4787 || (kind
== TYPES_DOMAIN
4788 && SYMBOL_DOMAIN (sym
) == STRUCT_DOMAIN
))
4790 type_print (SYMBOL_TYPE (sym
),
4791 (SYMBOL_CLASS (sym
) == LOC_TYPEDEF
4792 ? "" : SYMBOL_PRINT_NAME (sym
)),
4795 printf_filtered (";\n");
4799 /* This help function for symtab_symbol_info() prints information
4800 for non-debugging symbols to gdb_stdout. */
4803 print_msymbol_info (struct bound_minimal_symbol msymbol
)
4805 struct gdbarch
*gdbarch
= get_objfile_arch (msymbol
.objfile
);
4808 if (gdbarch_addr_bit (gdbarch
) <= 32)
4809 tmp
= hex_string_custom (BMSYMBOL_VALUE_ADDRESS (msymbol
)
4810 & (CORE_ADDR
) 0xffffffff,
4813 tmp
= hex_string_custom (BMSYMBOL_VALUE_ADDRESS (msymbol
),
4816 ui_file_style sym_style
= (msymbol
.minsym
->text_p ()
4817 ? function_name_style
.style ()
4818 : ui_file_style ());
4820 printf_filtered (_("%ps %ps\n"),
4821 styled_string (address_style
.style (), tmp
),
4822 styled_string (sym_style
,
4823 MSYMBOL_PRINT_NAME (msymbol
.minsym
)));
4826 /* This is the guts of the commands "info functions", "info types", and
4827 "info variables". It calls search_symbols to find all matches and then
4828 print_[m]symbol_info to print out some useful information about the
4832 symtab_symbol_info (bool quiet
, bool exclude_minsyms
,
4833 const char *regexp
, enum search_domain kind
,
4834 const char *t_regexp
, int from_tty
)
4836 static const char * const classnames
[] =
4837 {"variable", "function", "type"};
4838 const char *last_filename
= "";
4841 gdb_assert (kind
<= TYPES_DOMAIN
);
4843 if (regexp
!= nullptr && *regexp
== '\0')
4846 /* Must make sure that if we're interrupted, symbols gets freed. */
4847 std::vector
<symbol_search
> symbols
= search_symbols (regexp
, kind
,
4855 if (t_regexp
!= NULL
)
4857 (_("All %ss matching regular expression \"%s\""
4858 " with type matching regular expression \"%s\":\n"),
4859 classnames
[kind
], regexp
, t_regexp
);
4861 printf_filtered (_("All %ss matching regular expression \"%s\":\n"),
4862 classnames
[kind
], regexp
);
4866 if (t_regexp
!= NULL
)
4868 (_("All defined %ss"
4869 " with type matching regular expression \"%s\" :\n"),
4870 classnames
[kind
], t_regexp
);
4872 printf_filtered (_("All defined %ss:\n"), classnames
[kind
]);
4876 for (const symbol_search
&p
: symbols
)
4880 if (p
.msymbol
.minsym
!= NULL
)
4885 printf_filtered (_("\nNon-debugging symbols:\n"));
4888 print_msymbol_info (p
.msymbol
);
4892 print_symbol_info (kind
,
4897 = symtab_to_filename_for_display (symbol_symtab (p
.symbol
));
4902 /* Structure to hold the values of the options used by the 'info variables'
4903 and 'info functions' commands. These correspond to the -q, -t, and -n
4906 struct info_print_options
4909 bool exclude_minsyms
= false;
4910 char *type_regexp
= nullptr;
4912 ~info_print_options ()
4914 xfree (type_regexp
);
4918 /* The options used by the 'info variables' and 'info functions'
4921 static const gdb::option::option_def info_print_options_defs
[] = {
4922 gdb::option::boolean_option_def
<info_print_options
> {
4924 [] (info_print_options
*opt
) { return &opt
->quiet
; },
4925 nullptr, /* show_cmd_cb */
4926 nullptr /* set_doc */
4929 gdb::option::boolean_option_def
<info_print_options
> {
4931 [] (info_print_options
*opt
) { return &opt
->exclude_minsyms
; },
4932 nullptr, /* show_cmd_cb */
4933 nullptr /* set_doc */
4936 gdb::option::string_option_def
<info_print_options
> {
4938 [] (info_print_options
*opt
) { return &opt
->type_regexp
; },
4939 nullptr, /* show_cmd_cb */
4940 nullptr /* set_doc */
4944 /* Returns the option group used by 'info variables' and 'info
4947 static gdb::option::option_def_group
4948 make_info_print_options_def_group (info_print_options
*opts
)
4950 return {{info_print_options_defs
}, opts
};
4953 /* Command completer for 'info variables' and 'info functions'. */
4956 info_print_command_completer (struct cmd_list_element
*ignore
,
4957 completion_tracker
&tracker
,
4958 const char *text
, const char * /* word */)
4961 = make_info_print_options_def_group (nullptr);
4962 if (gdb::option::complete_options
4963 (tracker
, &text
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, group
))
4966 const char *word
= advance_to_expression_complete_word_point (tracker
, text
);
4967 symbol_completer (ignore
, tracker
, text
, word
);
4970 /* Implement the 'info variables' command. */
4973 info_variables_command (const char *args
, int from_tty
)
4975 info_print_options opts
;
4976 auto grp
= make_info_print_options_def_group (&opts
);
4977 gdb::option::process_options
4978 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
4979 if (args
!= nullptr && *args
== '\0')
4982 symtab_symbol_info (opts
.quiet
, opts
.exclude_minsyms
, args
, VARIABLES_DOMAIN
,
4983 opts
.type_regexp
, from_tty
);
4986 /* Implement the 'info functions' command. */
4989 info_functions_command (const char *args
, int from_tty
)
4991 info_print_options opts
;
4992 auto grp
= make_info_print_options_def_group (&opts
);
4993 gdb::option::process_options
4994 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
4995 if (args
!= nullptr && *args
== '\0')
4998 symtab_symbol_info (opts
.quiet
, opts
.exclude_minsyms
, args
,
4999 FUNCTIONS_DOMAIN
, opts
.type_regexp
, from_tty
);
5002 /* Holds the -q option for the 'info types' command. */
5004 struct info_types_options
5009 /* The options used by the 'info types' command. */
5011 static const gdb::option::option_def info_types_options_defs
[] = {
5012 gdb::option::boolean_option_def
<info_types_options
> {
5014 [] (info_types_options
*opt
) { return &opt
->quiet
; },
5015 nullptr, /* show_cmd_cb */
5016 nullptr /* set_doc */
5020 /* Returns the option group used by 'info types'. */
5022 static gdb::option::option_def_group
5023 make_info_types_options_def_group (info_types_options
*opts
)
5025 return {{info_types_options_defs
}, opts
};
5028 /* Implement the 'info types' command. */
5031 info_types_command (const char *args
, int from_tty
)
5033 info_types_options opts
;
5035 auto grp
= make_info_types_options_def_group (&opts
);
5036 gdb::option::process_options
5037 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
5038 if (args
!= nullptr && *args
== '\0')
5040 symtab_symbol_info (opts
.quiet
, false, args
, TYPES_DOMAIN
, NULL
, from_tty
);
5043 /* Command completer for 'info types' command. */
5046 info_types_command_completer (struct cmd_list_element
*ignore
,
5047 completion_tracker
&tracker
,
5048 const char *text
, const char * /* word */)
5051 = make_info_types_options_def_group (nullptr);
5052 if (gdb::option::complete_options
5053 (tracker
, &text
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, group
))
5056 const char *word
= advance_to_expression_complete_word_point (tracker
, text
);
5057 symbol_completer (ignore
, tracker
, text
, word
);
5060 /* Breakpoint all functions matching regular expression. */
5063 rbreak_command_wrapper (char *regexp
, int from_tty
)
5065 rbreak_command (regexp
, from_tty
);
5069 rbreak_command (const char *regexp
, int from_tty
)
5072 const char **files
= NULL
;
5073 const char *file_name
;
5078 const char *colon
= strchr (regexp
, ':');
5080 if (colon
&& *(colon
+ 1) != ':')
5085 colon_index
= colon
- regexp
;
5086 local_name
= (char *) alloca (colon_index
+ 1);
5087 memcpy (local_name
, regexp
, colon_index
);
5088 local_name
[colon_index
--] = 0;
5089 while (isspace (local_name
[colon_index
]))
5090 local_name
[colon_index
--] = 0;
5091 file_name
= local_name
;
5094 regexp
= skip_spaces (colon
+ 1);
5098 std::vector
<symbol_search
> symbols
= search_symbols (regexp
,
5104 scoped_rbreak_breakpoints finalize
;
5105 for (const symbol_search
&p
: symbols
)
5107 if (p
.msymbol
.minsym
== NULL
)
5109 struct symtab
*symtab
= symbol_symtab (p
.symbol
);
5110 const char *fullname
= symtab_to_fullname (symtab
);
5112 string
= string_printf ("%s:'%s'", fullname
,
5113 SYMBOL_LINKAGE_NAME (p
.symbol
));
5114 break_command (&string
[0], from_tty
);
5115 print_symbol_info (FUNCTIONS_DOMAIN
, p
.symbol
, p
.block
, NULL
);
5119 string
= string_printf ("'%s'",
5120 MSYMBOL_LINKAGE_NAME (p
.msymbol
.minsym
));
5122 break_command (&string
[0], from_tty
);
5123 printf_filtered ("<function, no debug info> %s;\n",
5124 MSYMBOL_PRINT_NAME (p
.msymbol
.minsym
));
5130 /* Evaluate if SYMNAME matches LOOKUP_NAME. */
5133 compare_symbol_name (const char *symbol_name
, language symbol_language
,
5134 const lookup_name_info
&lookup_name
,
5135 completion_match_result
&match_res
)
5137 const language_defn
*lang
= language_def (symbol_language
);
5139 symbol_name_matcher_ftype
*name_match
5140 = get_symbol_name_matcher (lang
, lookup_name
);
5142 return name_match (symbol_name
, lookup_name
, &match_res
);
5148 completion_list_add_name (completion_tracker
&tracker
,
5149 language symbol_language
,
5150 const char *symname
,
5151 const lookup_name_info
&lookup_name
,
5152 const char *text
, const char *word
)
5154 completion_match_result
&match_res
5155 = tracker
.reset_completion_match_result ();
5157 /* Clip symbols that cannot match. */
5158 if (!compare_symbol_name (symname
, symbol_language
, lookup_name
, match_res
))
5161 /* Refresh SYMNAME from the match string. It's potentially
5162 different depending on language. (E.g., on Ada, the match may be
5163 the encoded symbol name wrapped in "<>"). */
5164 symname
= match_res
.match
.match ();
5165 gdb_assert (symname
!= NULL
);
5167 /* We have a match for a completion, so add SYMNAME to the current list
5168 of matches. Note that the name is moved to freshly malloc'd space. */
5171 gdb::unique_xmalloc_ptr
<char> completion
5172 = make_completion_match_str (symname
, text
, word
);
5174 /* Here we pass the match-for-lcd object to add_completion. Some
5175 languages match the user text against substrings of symbol
5176 names in some cases. E.g., in C++, "b push_ba" completes to
5177 "std::vector::push_back", "std::string::push_back", etc., and
5178 in this case we want the completion lowest common denominator
5179 to be "push_back" instead of "std::". */
5180 tracker
.add_completion (std::move (completion
),
5181 &match_res
.match_for_lcd
, text
, word
);
5185 /* completion_list_add_name wrapper for struct symbol. */
5188 completion_list_add_symbol (completion_tracker
&tracker
,
5190 const lookup_name_info
&lookup_name
,
5191 const char *text
, const char *word
)
5193 completion_list_add_name (tracker
, SYMBOL_LANGUAGE (sym
),
5194 SYMBOL_NATURAL_NAME (sym
),
5195 lookup_name
, text
, word
);
5198 /* completion_list_add_name wrapper for struct minimal_symbol. */
5201 completion_list_add_msymbol (completion_tracker
&tracker
,
5202 minimal_symbol
*sym
,
5203 const lookup_name_info
&lookup_name
,
5204 const char *text
, const char *word
)
5206 completion_list_add_name (tracker
, MSYMBOL_LANGUAGE (sym
),
5207 MSYMBOL_NATURAL_NAME (sym
),
5208 lookup_name
, text
, word
);
5212 /* ObjC: In case we are completing on a selector, look as the msymbol
5213 again and feed all the selectors into the mill. */
5216 completion_list_objc_symbol (completion_tracker
&tracker
,
5217 struct minimal_symbol
*msymbol
,
5218 const lookup_name_info
&lookup_name
,
5219 const char *text
, const char *word
)
5221 static char *tmp
= NULL
;
5222 static unsigned int tmplen
= 0;
5224 const char *method
, *category
, *selector
;
5227 method
= MSYMBOL_NATURAL_NAME (msymbol
);
5229 /* Is it a method? */
5230 if ((method
[0] != '-') && (method
[0] != '+'))
5234 /* Complete on shortened method method. */
5235 completion_list_add_name (tracker
, language_objc
,
5240 while ((strlen (method
) + 1) >= tmplen
)
5246 tmp
= (char *) xrealloc (tmp
, tmplen
);
5248 selector
= strchr (method
, ' ');
5249 if (selector
!= NULL
)
5252 category
= strchr (method
, '(');
5254 if ((category
!= NULL
) && (selector
!= NULL
))
5256 memcpy (tmp
, method
, (category
- method
));
5257 tmp
[category
- method
] = ' ';
5258 memcpy (tmp
+ (category
- method
) + 1, selector
, strlen (selector
) + 1);
5259 completion_list_add_name (tracker
, language_objc
, tmp
,
5260 lookup_name
, text
, word
);
5262 completion_list_add_name (tracker
, language_objc
, tmp
+ 1,
5263 lookup_name
, text
, word
);
5266 if (selector
!= NULL
)
5268 /* Complete on selector only. */
5269 strcpy (tmp
, selector
);
5270 tmp2
= strchr (tmp
, ']');
5274 completion_list_add_name (tracker
, language_objc
, tmp
,
5275 lookup_name
, text
, word
);
5279 /* Break the non-quoted text based on the characters which are in
5280 symbols. FIXME: This should probably be language-specific. */
5283 language_search_unquoted_string (const char *text
, const char *p
)
5285 for (; p
> text
; --p
)
5287 if (isalnum (p
[-1]) || p
[-1] == '_' || p
[-1] == '\0')
5291 if ((current_language
->la_language
== language_objc
))
5293 if (p
[-1] == ':') /* Might be part of a method name. */
5295 else if (p
[-1] == '[' && (p
[-2] == '-' || p
[-2] == '+'))
5296 p
-= 2; /* Beginning of a method name. */
5297 else if (p
[-1] == ' ' || p
[-1] == '(' || p
[-1] == ')')
5298 { /* Might be part of a method name. */
5301 /* Seeing a ' ' or a '(' is not conclusive evidence
5302 that we are in the middle of a method name. However,
5303 finding "-[" or "+[" should be pretty un-ambiguous.
5304 Unfortunately we have to find it now to decide. */
5307 if (isalnum (t
[-1]) || t
[-1] == '_' ||
5308 t
[-1] == ' ' || t
[-1] == ':' ||
5309 t
[-1] == '(' || t
[-1] == ')')
5314 if (t
[-1] == '[' && (t
[-2] == '-' || t
[-2] == '+'))
5315 p
= t
- 2; /* Method name detected. */
5316 /* Else we leave with p unchanged. */
5326 completion_list_add_fields (completion_tracker
&tracker
,
5328 const lookup_name_info
&lookup_name
,
5329 const char *text
, const char *word
)
5331 if (SYMBOL_CLASS (sym
) == LOC_TYPEDEF
)
5333 struct type
*t
= SYMBOL_TYPE (sym
);
5334 enum type_code c
= TYPE_CODE (t
);
5337 if (c
== TYPE_CODE_UNION
|| c
== TYPE_CODE_STRUCT
)
5338 for (j
= TYPE_N_BASECLASSES (t
); j
< TYPE_NFIELDS (t
); j
++)
5339 if (TYPE_FIELD_NAME (t
, j
))
5340 completion_list_add_name (tracker
, SYMBOL_LANGUAGE (sym
),
5341 TYPE_FIELD_NAME (t
, j
),
5342 lookup_name
, text
, word
);
5349 symbol_is_function_or_method (symbol
*sym
)
5351 switch (TYPE_CODE (SYMBOL_TYPE (sym
)))
5353 case TYPE_CODE_FUNC
:
5354 case TYPE_CODE_METHOD
:
5364 symbol_is_function_or_method (minimal_symbol
*msymbol
)
5366 switch (MSYMBOL_TYPE (msymbol
))
5369 case mst_text_gnu_ifunc
:
5370 case mst_solib_trampoline
:
5380 bound_minimal_symbol
5381 find_gnu_ifunc (const symbol
*sym
)
5383 if (SYMBOL_CLASS (sym
) != LOC_BLOCK
)
5386 lookup_name_info
lookup_name (SYMBOL_SEARCH_NAME (sym
),
5387 symbol_name_match_type::SEARCH_NAME
);
5388 struct objfile
*objfile
= symbol_objfile (sym
);
5390 CORE_ADDR address
= BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
));
5391 minimal_symbol
*ifunc
= NULL
;
5393 iterate_over_minimal_symbols (objfile
, lookup_name
,
5394 [&] (minimal_symbol
*minsym
)
5396 if (MSYMBOL_TYPE (minsym
) == mst_text_gnu_ifunc
5397 || MSYMBOL_TYPE (minsym
) == mst_data_gnu_ifunc
)
5399 CORE_ADDR msym_addr
= MSYMBOL_VALUE_ADDRESS (objfile
, minsym
);
5400 if (MSYMBOL_TYPE (minsym
) == mst_data_gnu_ifunc
)
5402 struct gdbarch
*gdbarch
= get_objfile_arch (objfile
);
5404 = gdbarch_convert_from_func_ptr_addr (gdbarch
,
5406 current_top_target ());
5408 if (msym_addr
== address
)
5418 return {ifunc
, objfile
};
5422 /* Add matching symbols from SYMTAB to the current completion list. */
5425 add_symtab_completions (struct compunit_symtab
*cust
,
5426 completion_tracker
&tracker
,
5427 complete_symbol_mode mode
,
5428 const lookup_name_info
&lookup_name
,
5429 const char *text
, const char *word
,
5430 enum type_code code
)
5433 const struct block
*b
;
5434 struct block_iterator iter
;
5440 for (i
= GLOBAL_BLOCK
; i
<= STATIC_BLOCK
; i
++)
5443 b
= BLOCKVECTOR_BLOCK (COMPUNIT_BLOCKVECTOR (cust
), i
);
5444 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
5446 if (completion_skip_symbol (mode
, sym
))
5449 if (code
== TYPE_CODE_UNDEF
5450 || (SYMBOL_DOMAIN (sym
) == STRUCT_DOMAIN
5451 && TYPE_CODE (SYMBOL_TYPE (sym
)) == code
))
5452 completion_list_add_symbol (tracker
, sym
,
5460 default_collect_symbol_completion_matches_break_on
5461 (completion_tracker
&tracker
, complete_symbol_mode mode
,
5462 symbol_name_match_type name_match_type
,
5463 const char *text
, const char *word
,
5464 const char *break_on
, enum type_code code
)
5466 /* Problem: All of the symbols have to be copied because readline
5467 frees them. I'm not going to worry about this; hopefully there
5468 won't be that many. */
5471 const struct block
*b
;
5472 const struct block
*surrounding_static_block
, *surrounding_global_block
;
5473 struct block_iterator iter
;
5474 /* The symbol we are completing on. Points in same buffer as text. */
5475 const char *sym_text
;
5477 /* Now look for the symbol we are supposed to complete on. */
5478 if (mode
== complete_symbol_mode::LINESPEC
)
5484 const char *quote_pos
= NULL
;
5486 /* First see if this is a quoted string. */
5488 for (p
= text
; *p
!= '\0'; ++p
)
5490 if (quote_found
!= '\0')
5492 if (*p
== quote_found
)
5493 /* Found close quote. */
5495 else if (*p
== '\\' && p
[1] == quote_found
)
5496 /* A backslash followed by the quote character
5497 doesn't end the string. */
5500 else if (*p
== '\'' || *p
== '"')
5506 if (quote_found
== '\'')
5507 /* A string within single quotes can be a symbol, so complete on it. */
5508 sym_text
= quote_pos
+ 1;
5509 else if (quote_found
== '"')
5510 /* A double-quoted string is never a symbol, nor does it make sense
5511 to complete it any other way. */
5517 /* It is not a quoted string. Break it based on the characters
5518 which are in symbols. */
5521 if (isalnum (p
[-1]) || p
[-1] == '_' || p
[-1] == '\0'
5522 || p
[-1] == ':' || strchr (break_on
, p
[-1]) != NULL
)
5531 lookup_name_info
lookup_name (sym_text
, name_match_type
, true);
5533 /* At this point scan through the misc symbol vectors and add each
5534 symbol you find to the list. Eventually we want to ignore
5535 anything that isn't a text symbol (everything else will be
5536 handled by the psymtab code below). */
5538 if (code
== TYPE_CODE_UNDEF
)
5540 for (objfile
*objfile
: current_program_space
->objfiles ())
5542 for (minimal_symbol
*msymbol
: objfile
->msymbols ())
5546 if (completion_skip_symbol (mode
, msymbol
))
5549 completion_list_add_msymbol (tracker
, msymbol
, lookup_name
,
5552 completion_list_objc_symbol (tracker
, msymbol
, lookup_name
,
5558 /* Add completions for all currently loaded symbol tables. */
5559 for (objfile
*objfile
: current_program_space
->objfiles ())
5561 for (compunit_symtab
*cust
: objfile
->compunits ())
5562 add_symtab_completions (cust
, tracker
, mode
, lookup_name
,
5563 sym_text
, word
, code
);
5566 /* Look through the partial symtabs for all symbols which begin by
5567 matching SYM_TEXT. Expand all CUs that you find to the list. */
5568 expand_symtabs_matching (NULL
,
5571 [&] (compunit_symtab
*symtab
) /* expansion notify */
5573 add_symtab_completions (symtab
,
5574 tracker
, mode
, lookup_name
,
5575 sym_text
, word
, code
);
5579 /* Search upwards from currently selected frame (so that we can
5580 complete on local vars). Also catch fields of types defined in
5581 this places which match our text string. Only complete on types
5582 visible from current context. */
5584 b
= get_selected_block (0);
5585 surrounding_static_block
= block_static_block (b
);
5586 surrounding_global_block
= block_global_block (b
);
5587 if (surrounding_static_block
!= NULL
)
5588 while (b
!= surrounding_static_block
)
5592 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
5594 if (code
== TYPE_CODE_UNDEF
)
5596 completion_list_add_symbol (tracker
, sym
, lookup_name
,
5598 completion_list_add_fields (tracker
, sym
, lookup_name
,
5601 else if (SYMBOL_DOMAIN (sym
) == STRUCT_DOMAIN
5602 && TYPE_CODE (SYMBOL_TYPE (sym
)) == code
)
5603 completion_list_add_symbol (tracker
, sym
, lookup_name
,
5607 /* Stop when we encounter an enclosing function. Do not stop for
5608 non-inlined functions - the locals of the enclosing function
5609 are in scope for a nested function. */
5610 if (BLOCK_FUNCTION (b
) != NULL
&& block_inlined_p (b
))
5612 b
= BLOCK_SUPERBLOCK (b
);
5615 /* Add fields from the file's types; symbols will be added below. */
5617 if (code
== TYPE_CODE_UNDEF
)
5619 if (surrounding_static_block
!= NULL
)
5620 ALL_BLOCK_SYMBOLS (surrounding_static_block
, iter
, sym
)
5621 completion_list_add_fields (tracker
, sym
, lookup_name
,
5624 if (surrounding_global_block
!= NULL
)
5625 ALL_BLOCK_SYMBOLS (surrounding_global_block
, iter
, sym
)
5626 completion_list_add_fields (tracker
, sym
, lookup_name
,
5630 /* Skip macros if we are completing a struct tag -- arguable but
5631 usually what is expected. */
5632 if (current_language
->la_macro_expansion
== macro_expansion_c
5633 && code
== TYPE_CODE_UNDEF
)
5635 gdb::unique_xmalloc_ptr
<struct macro_scope
> scope
;
5637 /* This adds a macro's name to the current completion list. */
5638 auto add_macro_name
= [&] (const char *macro_name
,
5639 const macro_definition
*,
5640 macro_source_file
*,
5643 completion_list_add_name (tracker
, language_c
, macro_name
,
5644 lookup_name
, sym_text
, word
);
5647 /* Add any macros visible in the default scope. Note that this
5648 may yield the occasional wrong result, because an expression
5649 might be evaluated in a scope other than the default. For
5650 example, if the user types "break file:line if <TAB>", the
5651 resulting expression will be evaluated at "file:line" -- but
5652 at there does not seem to be a way to detect this at
5654 scope
= default_macro_scope ();
5656 macro_for_each_in_scope (scope
->file
, scope
->line
,
5659 /* User-defined macros are always visible. */
5660 macro_for_each (macro_user_macros
, add_macro_name
);
5665 default_collect_symbol_completion_matches (completion_tracker
&tracker
,
5666 complete_symbol_mode mode
,
5667 symbol_name_match_type name_match_type
,
5668 const char *text
, const char *word
,
5669 enum type_code code
)
5671 return default_collect_symbol_completion_matches_break_on (tracker
, mode
,
5677 /* Collect all symbols (regardless of class) which begin by matching
5681 collect_symbol_completion_matches (completion_tracker
&tracker
,
5682 complete_symbol_mode mode
,
5683 symbol_name_match_type name_match_type
,
5684 const char *text
, const char *word
)
5686 current_language
->la_collect_symbol_completion_matches (tracker
, mode
,
5692 /* Like collect_symbol_completion_matches, but only collect
5693 STRUCT_DOMAIN symbols whose type code is CODE. */
5696 collect_symbol_completion_matches_type (completion_tracker
&tracker
,
5697 const char *text
, const char *word
,
5698 enum type_code code
)
5700 complete_symbol_mode mode
= complete_symbol_mode::EXPRESSION
;
5701 symbol_name_match_type name_match_type
= symbol_name_match_type::EXPRESSION
;
5703 gdb_assert (code
== TYPE_CODE_UNION
5704 || code
== TYPE_CODE_STRUCT
5705 || code
== TYPE_CODE_ENUM
);
5706 current_language
->la_collect_symbol_completion_matches (tracker
, mode
,
5711 /* Like collect_symbol_completion_matches, but collects a list of
5712 symbols defined in all source files named SRCFILE. */
5715 collect_file_symbol_completion_matches (completion_tracker
&tracker
,
5716 complete_symbol_mode mode
,
5717 symbol_name_match_type name_match_type
,
5718 const char *text
, const char *word
,
5719 const char *srcfile
)
5721 /* The symbol we are completing on. Points in same buffer as text. */
5722 const char *sym_text
;
5724 /* Now look for the symbol we are supposed to complete on.
5725 FIXME: This should be language-specific. */
5726 if (mode
== complete_symbol_mode::LINESPEC
)
5732 const char *quote_pos
= NULL
;
5734 /* First see if this is a quoted string. */
5736 for (p
= text
; *p
!= '\0'; ++p
)
5738 if (quote_found
!= '\0')
5740 if (*p
== quote_found
)
5741 /* Found close quote. */
5743 else if (*p
== '\\' && p
[1] == quote_found
)
5744 /* A backslash followed by the quote character
5745 doesn't end the string. */
5748 else if (*p
== '\'' || *p
== '"')
5754 if (quote_found
== '\'')
5755 /* A string within single quotes can be a symbol, so complete on it. */
5756 sym_text
= quote_pos
+ 1;
5757 else if (quote_found
== '"')
5758 /* A double-quoted string is never a symbol, nor does it make sense
5759 to complete it any other way. */
5765 /* Not a quoted string. */
5766 sym_text
= language_search_unquoted_string (text
, p
);
5770 lookup_name_info
lookup_name (sym_text
, name_match_type
, true);
5772 /* Go through symtabs for SRCFILE and check the externs and statics
5773 for symbols which match. */
5774 iterate_over_symtabs (srcfile
, [&] (symtab
*s
)
5776 add_symtab_completions (SYMTAB_COMPUNIT (s
),
5777 tracker
, mode
, lookup_name
,
5778 sym_text
, word
, TYPE_CODE_UNDEF
);
5783 /* A helper function for make_source_files_completion_list. It adds
5784 another file name to a list of possible completions, growing the
5785 list as necessary. */
5788 add_filename_to_list (const char *fname
, const char *text
, const char *word
,
5789 completion_list
*list
)
5791 list
->emplace_back (make_completion_match_str (fname
, text
, word
));
5795 not_interesting_fname (const char *fname
)
5797 static const char *illegal_aliens
[] = {
5798 "_globals_", /* inserted by coff_symtab_read */
5803 for (i
= 0; illegal_aliens
[i
]; i
++)
5805 if (filename_cmp (fname
, illegal_aliens
[i
]) == 0)
5811 /* An object of this type is passed as the user_data argument to
5812 map_partial_symbol_filenames. */
5813 struct add_partial_filename_data
5815 struct filename_seen_cache
*filename_seen_cache
;
5819 completion_list
*list
;
5822 /* A callback for map_partial_symbol_filenames. */
5825 maybe_add_partial_symtab_filename (const char *filename
, const char *fullname
,
5828 struct add_partial_filename_data
*data
5829 = (struct add_partial_filename_data
*) user_data
;
5831 if (not_interesting_fname (filename
))
5833 if (!data
->filename_seen_cache
->seen (filename
)
5834 && filename_ncmp (filename
, data
->text
, data
->text_len
) == 0)
5836 /* This file matches for a completion; add it to the
5837 current list of matches. */
5838 add_filename_to_list (filename
, data
->text
, data
->word
, data
->list
);
5842 const char *base_name
= lbasename (filename
);
5844 if (base_name
!= filename
5845 && !data
->filename_seen_cache
->seen (base_name
)
5846 && filename_ncmp (base_name
, data
->text
, data
->text_len
) == 0)
5847 add_filename_to_list (base_name
, data
->text
, data
->word
, data
->list
);
5851 /* Return a list of all source files whose names begin with matching
5852 TEXT. The file names are looked up in the symbol tables of this
5856 make_source_files_completion_list (const char *text
, const char *word
)
5858 size_t text_len
= strlen (text
);
5859 completion_list list
;
5860 const char *base_name
;
5861 struct add_partial_filename_data datum
;
5863 if (!have_full_symbols () && !have_partial_symbols ())
5866 filename_seen_cache filenames_seen
;
5868 for (objfile
*objfile
: current_program_space
->objfiles ())
5870 for (compunit_symtab
*cu
: objfile
->compunits ())
5872 for (symtab
*s
: compunit_filetabs (cu
))
5874 if (not_interesting_fname (s
->filename
))
5876 if (!filenames_seen
.seen (s
->filename
)
5877 && filename_ncmp (s
->filename
, text
, text_len
) == 0)
5879 /* This file matches for a completion; add it to the current
5881 add_filename_to_list (s
->filename
, text
, word
, &list
);
5885 /* NOTE: We allow the user to type a base name when the
5886 debug info records leading directories, but not the other
5887 way around. This is what subroutines of breakpoint
5888 command do when they parse file names. */
5889 base_name
= lbasename (s
->filename
);
5890 if (base_name
!= s
->filename
5891 && !filenames_seen
.seen (base_name
)
5892 && filename_ncmp (base_name
, text
, text_len
) == 0)
5893 add_filename_to_list (base_name
, text
, word
, &list
);
5899 datum
.filename_seen_cache
= &filenames_seen
;
5902 datum
.text_len
= text_len
;
5904 map_symbol_filenames (maybe_add_partial_symtab_filename
, &datum
,
5905 0 /*need_fullname*/);
5912 /* Return the "main_info" object for the current program space. If
5913 the object has not yet been created, create it and fill in some
5916 static struct main_info
*
5917 get_main_info (void)
5919 struct main_info
*info
= main_progspace_key
.get (current_program_space
);
5923 /* It may seem strange to store the main name in the progspace
5924 and also in whatever objfile happens to see a main name in
5925 its debug info. The reason for this is mainly historical:
5926 gdb returned "main" as the name even if no function named
5927 "main" was defined the program; and this approach lets us
5928 keep compatibility. */
5929 info
= main_progspace_key
.emplace (current_program_space
);
5936 set_main_name (const char *name
, enum language lang
)
5938 struct main_info
*info
= get_main_info ();
5940 if (info
->name_of_main
!= NULL
)
5942 xfree (info
->name_of_main
);
5943 info
->name_of_main
= NULL
;
5944 info
->language_of_main
= language_unknown
;
5948 info
->name_of_main
= xstrdup (name
);
5949 info
->language_of_main
= lang
;
5953 /* Deduce the name of the main procedure, and set NAME_OF_MAIN
5957 find_main_name (void)
5959 const char *new_main_name
;
5961 /* First check the objfiles to see whether a debuginfo reader has
5962 picked up the appropriate main name. Historically the main name
5963 was found in a more or less random way; this approach instead
5964 relies on the order of objfile creation -- which still isn't
5965 guaranteed to get the correct answer, but is just probably more
5967 for (objfile
*objfile
: current_program_space
->objfiles ())
5969 if (objfile
->per_bfd
->name_of_main
!= NULL
)
5971 set_main_name (objfile
->per_bfd
->name_of_main
,
5972 objfile
->per_bfd
->language_of_main
);
5977 /* Try to see if the main procedure is in Ada. */
5978 /* FIXME: brobecker/2005-03-07: Another way of doing this would
5979 be to add a new method in the language vector, and call this
5980 method for each language until one of them returns a non-empty
5981 name. This would allow us to remove this hard-coded call to
5982 an Ada function. It is not clear that this is a better approach
5983 at this point, because all methods need to be written in a way
5984 such that false positives never be returned. For instance, it is
5985 important that a method does not return a wrong name for the main
5986 procedure if the main procedure is actually written in a different
5987 language. It is easy to guaranty this with Ada, since we use a
5988 special symbol generated only when the main in Ada to find the name
5989 of the main procedure. It is difficult however to see how this can
5990 be guarantied for languages such as C, for instance. This suggests
5991 that order of call for these methods becomes important, which means
5992 a more complicated approach. */
5993 new_main_name
= ada_main_name ();
5994 if (new_main_name
!= NULL
)
5996 set_main_name (new_main_name
, language_ada
);
6000 new_main_name
= d_main_name ();
6001 if (new_main_name
!= NULL
)
6003 set_main_name (new_main_name
, language_d
);
6007 new_main_name
= go_main_name ();
6008 if (new_main_name
!= NULL
)
6010 set_main_name (new_main_name
, language_go
);
6014 new_main_name
= pascal_main_name ();
6015 if (new_main_name
!= NULL
)
6017 set_main_name (new_main_name
, language_pascal
);
6021 /* The languages above didn't identify the name of the main procedure.
6022 Fallback to "main". */
6023 set_main_name ("main", language_unknown
);
6031 struct main_info
*info
= get_main_info ();
6033 if (info
->name_of_main
== NULL
)
6036 return info
->name_of_main
;
6039 /* Return the language of the main function. If it is not known,
6040 return language_unknown. */
6043 main_language (void)
6045 struct main_info
*info
= get_main_info ();
6047 if (info
->name_of_main
== NULL
)
6050 return info
->language_of_main
;
6053 /* Handle ``executable_changed'' events for the symtab module. */
6056 symtab_observer_executable_changed (void)
6058 /* NAME_OF_MAIN may no longer be the same, so reset it for now. */
6059 set_main_name (NULL
, language_unknown
);
6062 /* Return 1 if the supplied producer string matches the ARM RealView
6063 compiler (armcc). */
6066 producer_is_realview (const char *producer
)
6068 static const char *const arm_idents
[] = {
6069 "ARM C Compiler, ADS",
6070 "Thumb C Compiler, ADS",
6071 "ARM C++ Compiler, ADS",
6072 "Thumb C++ Compiler, ADS",
6073 "ARM/Thumb C/C++ Compiler, RVCT",
6074 "ARM C/C++ Compiler, RVCT"
6078 if (producer
== NULL
)
6081 for (i
= 0; i
< ARRAY_SIZE (arm_idents
); i
++)
6082 if (startswith (producer
, arm_idents
[i
]))
6090 /* The next index to hand out in response to a registration request. */
6092 static int next_aclass_value
= LOC_FINAL_VALUE
;
6094 /* The maximum number of "aclass" registrations we support. This is
6095 constant for convenience. */
6096 #define MAX_SYMBOL_IMPLS (LOC_FINAL_VALUE + 10)
6098 /* The objects representing the various "aclass" values. The elements
6099 from 0 up to LOC_FINAL_VALUE-1 represent themselves, and subsequent
6100 elements are those registered at gdb initialization time. */
6102 static struct symbol_impl symbol_impl
[MAX_SYMBOL_IMPLS
];
6104 /* The globally visible pointer. This is separate from 'symbol_impl'
6105 so that it can be const. */
6107 const struct symbol_impl
*symbol_impls
= &symbol_impl
[0];
6109 /* Make sure we saved enough room in struct symbol. */
6111 gdb_static_assert (MAX_SYMBOL_IMPLS
<= (1 << SYMBOL_ACLASS_BITS
));
6113 /* Register a computed symbol type. ACLASS must be LOC_COMPUTED. OPS
6114 is the ops vector associated with this index. This returns the new
6115 index, which should be used as the aclass_index field for symbols
6119 register_symbol_computed_impl (enum address_class aclass
,
6120 const struct symbol_computed_ops
*ops
)
6122 int result
= next_aclass_value
++;
6124 gdb_assert (aclass
== LOC_COMPUTED
);
6125 gdb_assert (result
< MAX_SYMBOL_IMPLS
);
6126 symbol_impl
[result
].aclass
= aclass
;
6127 symbol_impl
[result
].ops_computed
= ops
;
6129 /* Sanity check OPS. */
6130 gdb_assert (ops
!= NULL
);
6131 gdb_assert (ops
->tracepoint_var_ref
!= NULL
);
6132 gdb_assert (ops
->describe_location
!= NULL
);
6133 gdb_assert (ops
->get_symbol_read_needs
!= NULL
);
6134 gdb_assert (ops
->read_variable
!= NULL
);
6139 /* Register a function with frame base type. ACLASS must be LOC_BLOCK.
6140 OPS is the ops vector associated with this index. This returns the
6141 new index, which should be used as the aclass_index field for symbols
6145 register_symbol_block_impl (enum address_class aclass
,
6146 const struct symbol_block_ops
*ops
)
6148 int result
= next_aclass_value
++;
6150 gdb_assert (aclass
== LOC_BLOCK
);
6151 gdb_assert (result
< MAX_SYMBOL_IMPLS
);
6152 symbol_impl
[result
].aclass
= aclass
;
6153 symbol_impl
[result
].ops_block
= ops
;
6155 /* Sanity check OPS. */
6156 gdb_assert (ops
!= NULL
);
6157 gdb_assert (ops
->find_frame_base_location
!= NULL
);
6162 /* Register a register symbol type. ACLASS must be LOC_REGISTER or
6163 LOC_REGPARM_ADDR. OPS is the register ops vector associated with
6164 this index. This returns the new index, which should be used as
6165 the aclass_index field for symbols of this type. */
6168 register_symbol_register_impl (enum address_class aclass
,
6169 const struct symbol_register_ops
*ops
)
6171 int result
= next_aclass_value
++;
6173 gdb_assert (aclass
== LOC_REGISTER
|| aclass
== LOC_REGPARM_ADDR
);
6174 gdb_assert (result
< MAX_SYMBOL_IMPLS
);
6175 symbol_impl
[result
].aclass
= aclass
;
6176 symbol_impl
[result
].ops_register
= ops
;
6181 /* Initialize elements of 'symbol_impl' for the constants in enum
6185 initialize_ordinary_address_classes (void)
6189 for (i
= 0; i
< LOC_FINAL_VALUE
; ++i
)
6190 symbol_impl
[i
].aclass
= (enum address_class
) i
;
6195 /* Helper function to initialize the fields of an objfile-owned symbol.
6196 It assumed that *SYM is already all zeroes. */
6199 initialize_objfile_symbol_1 (struct symbol
*sym
)
6201 SYMBOL_OBJFILE_OWNED (sym
) = 1;
6202 SYMBOL_SECTION (sym
) = -1;
6205 /* Initialize the symbol SYM, and mark it as being owned by an objfile. */
6208 initialize_objfile_symbol (struct symbol
*sym
)
6210 memset (sym
, 0, sizeof (*sym
));
6211 initialize_objfile_symbol_1 (sym
);
6214 /* Allocate and initialize a new 'struct symbol' on OBJFILE's
6218 allocate_symbol (struct objfile
*objfile
)
6220 struct symbol
*result
;
6222 result
= OBSTACK_ZALLOC (&objfile
->objfile_obstack
, struct symbol
);
6223 initialize_objfile_symbol_1 (result
);
6228 /* Allocate and initialize a new 'struct template_symbol' on OBJFILE's
6231 struct template_symbol
*
6232 allocate_template_symbol (struct objfile
*objfile
)
6234 struct template_symbol
*result
;
6236 result
= OBSTACK_ZALLOC (&objfile
->objfile_obstack
, struct template_symbol
);
6237 initialize_objfile_symbol_1 (result
);
6245 symbol_objfile (const struct symbol
*symbol
)
6247 gdb_assert (SYMBOL_OBJFILE_OWNED (symbol
));
6248 return SYMTAB_OBJFILE (symbol
->owner
.symtab
);
6254 symbol_arch (const struct symbol
*symbol
)
6256 if (!SYMBOL_OBJFILE_OWNED (symbol
))
6257 return symbol
->owner
.arch
;
6258 return get_objfile_arch (SYMTAB_OBJFILE (symbol
->owner
.symtab
));
6264 symbol_symtab (const struct symbol
*symbol
)
6266 gdb_assert (SYMBOL_OBJFILE_OWNED (symbol
));
6267 return symbol
->owner
.symtab
;
6273 symbol_set_symtab (struct symbol
*symbol
, struct symtab
*symtab
)
6275 gdb_assert (SYMBOL_OBJFILE_OWNED (symbol
));
6276 symbol
->owner
.symtab
= symtab
;
6282 get_symbol_address (const struct symbol
*sym
)
6284 gdb_assert (sym
->maybe_copied
);
6285 gdb_assert (SYMBOL_CLASS (sym
) == LOC_STATIC
);
6287 const char *linkage_name
= SYMBOL_LINKAGE_NAME (sym
);
6289 for (objfile
*objfile
: current_program_space
->objfiles ())
6291 bound_minimal_symbol minsym
6292 = lookup_minimal_symbol_linkage (linkage_name
, objfile
);
6293 if (minsym
.minsym
!= nullptr)
6294 return BMSYMBOL_VALUE_ADDRESS (minsym
);
6296 return sym
->ginfo
.value
.address
;
6302 get_msymbol_address (struct objfile
*objf
, const struct minimal_symbol
*minsym
)
6304 gdb_assert (minsym
->maybe_copied
);
6305 gdb_assert ((objf
->flags
& OBJF_MAINLINE
) == 0);
6307 const char *linkage_name
= MSYMBOL_LINKAGE_NAME (minsym
);
6309 for (objfile
*objfile
: current_program_space
->objfiles ())
6311 if ((objfile
->flags
& OBJF_MAINLINE
) != 0)
6313 bound_minimal_symbol found
6314 = lookup_minimal_symbol_linkage (linkage_name
, objfile
);
6315 if (found
.minsym
!= nullptr)
6316 return BMSYMBOL_VALUE_ADDRESS (found
);
6319 return (minsym
->value
.address
6320 + ANOFFSET (objf
->section_offsets
, minsym
->section
));
6326 _initialize_symtab (void)
6328 cmd_list_element
*c
;
6330 initialize_ordinary_address_classes ();
6332 c
= add_info ("variables", info_variables_command
,
6333 info_print_args_help (_("\
6334 All global and static variable names or those matching REGEXPs.\n\
6335 Usage: info variables [-q] [-n] [-t TYPEREGEXP] [NAMEREGEXP]\n\
6336 Prints the global and static variables.\n"),
6337 _("global and static variables"),
6339 set_cmd_completer_handle_brkchars (c
, info_print_command_completer
);
6342 c
= add_com ("whereis", class_info
, info_variables_command
,
6343 info_print_args_help (_("\
6344 All global and static variable names, or those matching REGEXPs.\n\
6345 Usage: whereis [-q] [-n] [-t TYPEREGEXP] [NAMEREGEXP]\n\
6346 Prints the global and static variables.\n"),
6347 _("global and static variables"),
6349 set_cmd_completer_handle_brkchars (c
, info_print_command_completer
);
6352 c
= add_info ("functions", info_functions_command
,
6353 info_print_args_help (_("\
6354 All function names or those matching REGEXPs.\n\
6355 Usage: info functions [-q] [-n] [-t TYPEREGEXP] [NAMEREGEXP]\n\
6356 Prints the functions.\n"),
6359 set_cmd_completer_handle_brkchars (c
, info_print_command_completer
);
6361 c
= add_info ("types", info_types_command
, _("\
6362 All type names, or those matching REGEXP.\n\
6363 Usage: info types [-q] [REGEXP]\n\
6364 Print information about all types matching REGEXP, or all types if no\n\
6365 REGEXP is given. The optional flag -q disables printing of headers."));
6366 set_cmd_completer_handle_brkchars (c
, info_types_command_completer
);
6368 const auto info_sources_opts
= make_info_sources_options_def_group (nullptr);
6370 static std::string info_sources_help
6371 = gdb::option::build_help (_("\
6372 All source files in the program or those matching REGEXP.\n\
6373 Usage: info sources [OPTION]... [REGEXP]\n\
6374 By default, REGEXP is used to match anywhere in the filename.\n\
6380 c
= add_info ("sources", info_sources_command
, info_sources_help
.c_str ());
6381 set_cmd_completer_handle_brkchars (c
, info_sources_command_completer
);
6383 add_com ("rbreak", class_breakpoint
, rbreak_command
,
6384 _("Set a breakpoint for all functions matching REGEXP."));
6386 add_setshow_enum_cmd ("multiple-symbols", no_class
,
6387 multiple_symbols_modes
, &multiple_symbols_mode
,
6389 Set how the debugger handles ambiguities in expressions."), _("\
6390 Show how the debugger handles ambiguities in expressions."), _("\
6391 Valid values are \"ask\", \"all\", \"cancel\", and the default is \"all\"."),
6392 NULL
, NULL
, &setlist
, &showlist
);
6394 add_setshow_boolean_cmd ("basenames-may-differ", class_obscure
,
6395 &basenames_may_differ
, _("\
6396 Set whether a source file may have multiple base names."), _("\
6397 Show whether a source file may have multiple base names."), _("\
6398 (A \"base name\" is the name of a file with the directory part removed.\n\
6399 Example: The base name of \"/home/user/hello.c\" is \"hello.c\".)\n\
6400 If set, GDB will canonicalize file names (e.g., expand symlinks)\n\
6401 before comparing them. Canonicalization is an expensive operation,\n\
6402 but it allows the same file be known by more than one base name.\n\
6403 If not set (the default), all source files are assumed to have just\n\
6404 one base name, and gdb will do file name comparisons more efficiently."),
6406 &setlist
, &showlist
);
6408 add_setshow_zuinteger_cmd ("symtab-create", no_class
, &symtab_create_debug
,
6409 _("Set debugging of symbol table creation."),
6410 _("Show debugging of symbol table creation."), _("\
6411 When enabled (non-zero), debugging messages are printed when building\n\
6412 symbol tables. A value of 1 (one) normally provides enough information.\n\
6413 A value greater than 1 provides more verbose information."),
6416 &setdebuglist
, &showdebuglist
);
6418 add_setshow_zuinteger_cmd ("symbol-lookup", no_class
, &symbol_lookup_debug
,
6420 Set debugging of symbol lookup."), _("\
6421 Show debugging of symbol lookup."), _("\
6422 When enabled (non-zero), symbol lookups are logged."),
6424 &setdebuglist
, &showdebuglist
);
6426 add_setshow_zuinteger_cmd ("symbol-cache-size", no_class
,
6427 &new_symbol_cache_size
,
6428 _("Set the size of the symbol cache."),
6429 _("Show the size of the symbol cache."), _("\
6430 The size of the symbol cache.\n\
6431 If zero then the symbol cache is disabled."),
6432 set_symbol_cache_size_handler
, NULL
,
6433 &maintenance_set_cmdlist
,
6434 &maintenance_show_cmdlist
);
6436 add_cmd ("symbol-cache", class_maintenance
, maintenance_print_symbol_cache
,
6437 _("Dump the symbol cache for each program space."),
6438 &maintenanceprintlist
);
6440 add_cmd ("symbol-cache-statistics", class_maintenance
,
6441 maintenance_print_symbol_cache_statistics
,
6442 _("Print symbol cache statistics for each program space."),
6443 &maintenanceprintlist
);
6445 add_cmd ("flush-symbol-cache", class_maintenance
,
6446 maintenance_flush_symbol_cache
,
6447 _("Flush the symbol cache for each program space."),
6450 gdb::observers::executable_changed
.attach (symtab_observer_executable_changed
);
6451 gdb::observers::new_objfile
.attach (symtab_new_objfile_observer
);
6452 gdb::observers::free_objfile
.attach (symtab_free_objfile_observer
);