1 /* Symbol table lookup for the GNU debugger, GDB.
3 Copyright (C) 1986-2015 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"
47 #include "gdb_obstack.h"
49 #include "dictionary.h"
51 #include <sys/types.h>
56 #include "cp-support.h"
60 #include "macroscope.h"
62 #include "parser-defs.h"
63 #include "completer.h"
65 /* Forward declarations for local functions. */
67 static void rbreak_command (char *, int);
69 static int find_line_common (struct linetable *, int, int *, int);
71 static struct block_symbol
72 lookup_symbol_aux (const char *name,
73 const struct block *block,
74 const domain_enum domain,
75 enum language language,
76 struct field_of_this_result *);
79 struct block_symbol lookup_local_symbol (const char *name,
80 const struct block *block,
81 const domain_enum domain,
82 enum language language);
84 static struct block_symbol
85 lookup_symbol_in_objfile (struct objfile *objfile, int block_index,
86 const char *name, const domain_enum domain);
88 extern initialize_file_ftype _initialize_symtab;
90 /* Program space key for finding name and language of "main". */
92 static const struct program_space_data *main_progspace_key;
94 /* Type of the data stored on the program space. */
102 /* Language of "main". */
104 enum language language_of_main;
107 /* Program space key for finding its symbol cache. */
109 static const struct program_space_data *symbol_cache_key;
111 /* The default symbol cache size.
112 There is no extra cpu cost for large N (except when flushing the cache,
113 which is rare). The value here is just a first attempt. A better default
114 value may be higher or lower. A prime number can make up for a bad hash
115 computation, so that's why the number is what it is. */
116 #define DEFAULT_SYMBOL_CACHE_SIZE 1021
118 /* The maximum symbol cache size.
119 There's no method to the decision of what value to use here, other than
120 there's no point in allowing a user typo to make gdb consume all memory. */
121 #define MAX_SYMBOL_CACHE_SIZE (1024*1024)
123 /* symbol_cache_lookup returns this if a previous lookup failed to find the
124 symbol in any objfile. */
125 #define SYMBOL_LOOKUP_FAILED \
126 ((struct block_symbol) {(struct symbol *) 1, NULL})
127 #define SYMBOL_LOOKUP_FAILED_P(SIB) (SIB.symbol == (struct symbol *) 1)
129 /* Recording lookups that don't find the symbol is just as important, if not
130 more so, than recording found symbols. */
132 enum symbol_cache_slot_state
135 SYMBOL_SLOT_NOT_FOUND,
139 struct symbol_cache_slot
141 enum symbol_cache_slot_state state;
143 /* The objfile that was current when the symbol was looked up.
144 This is only needed for global blocks, but for simplicity's sake
145 we allocate the space for both. If data shows the extra space used
146 for static blocks is a problem, we can split things up then.
148 Global blocks need cache lookup to include the objfile context because
149 we need to account for gdbarch_iterate_over_objfiles_in_search_order
150 which can traverse objfiles in, effectively, any order, depending on
151 the current objfile, thus affecting which symbol is found. Normally,
152 only the current objfile is searched first, and then the rest are
153 searched in recorded order; but putting cache lookup inside
154 gdbarch_iterate_over_objfiles_in_search_order would be awkward.
155 Instead we just make the current objfile part of the context of
156 cache lookup. This means we can record the same symbol multiple times,
157 each with a different "current objfile" that was in effect when the
158 lookup was saved in the cache, but cache space is pretty cheap. */
159 const struct objfile *objfile_context;
163 struct block_symbol found;
172 /* Symbols don't specify global vs static block.
173 So keep them in separate caches. */
175 struct block_symbol_cache
179 unsigned int collisions;
181 /* SYMBOLS is a variable length array of this size.
182 One can imagine that in general one cache (global/static) should be a
183 fraction of the size of the other, but there's no data at the moment
184 on which to decide. */
187 struct symbol_cache_slot symbols[1];
192 Searching for symbols in the static and global blocks over multiple objfiles
193 again and again can be slow, as can searching very big objfiles. This is a
194 simple cache to improve symbol lookup performance, which is critical to
195 overall gdb performance.
197 Symbols are hashed on the name, its domain, and block.
198 They are also hashed on their objfile for objfile-specific lookups. */
202 struct block_symbol_cache *global_symbols;
203 struct block_symbol_cache *static_symbols;
206 /* When non-zero, print debugging messages related to symtab creation. */
207 unsigned int symtab_create_debug = 0;
209 /* When non-zero, print debugging messages related to symbol lookup. */
210 unsigned int symbol_lookup_debug = 0;
212 /* The size of the cache is staged here. */
213 static unsigned int new_symbol_cache_size = DEFAULT_SYMBOL_CACHE_SIZE;
215 /* The current value of the symbol cache size.
216 This is saved so that if the user enters a value too big we can restore
217 the original value from here. */
218 static unsigned int symbol_cache_size = DEFAULT_SYMBOL_CACHE_SIZE;
220 /* Non-zero if a file may be known by two different basenames.
221 This is the uncommon case, and significantly slows down gdb.
222 Default set to "off" to not slow down the common case. */
223 int basenames_may_differ = 0;
225 /* Allow the user to configure the debugger behavior with respect
226 to multiple-choice menus when more than one symbol matches during
229 const char multiple_symbols_ask[] = "ask";
230 const char multiple_symbols_all[] = "all";
231 const char multiple_symbols_cancel[] = "cancel";
232 static const char *const multiple_symbols_modes[] =
234 multiple_symbols_ask,
235 multiple_symbols_all,
236 multiple_symbols_cancel,
239 static const char *multiple_symbols_mode = multiple_symbols_all;
241 /* Read-only accessor to AUTO_SELECT_MODE. */
244 multiple_symbols_select_mode (void)
246 return multiple_symbols_mode;
249 /* Return the name of a domain_enum. */
252 domain_name (domain_enum e)
256 case UNDEF_DOMAIN: return "UNDEF_DOMAIN";
257 case VAR_DOMAIN: return "VAR_DOMAIN";
258 case STRUCT_DOMAIN: return "STRUCT_DOMAIN";
259 case MODULE_DOMAIN: return "MODULE_DOMAIN";
260 case LABEL_DOMAIN: return "LABEL_DOMAIN";
261 case COMMON_BLOCK_DOMAIN: return "COMMON_BLOCK_DOMAIN";
262 default: gdb_assert_not_reached ("bad domain_enum");
266 /* Return the name of a search_domain . */
269 search_domain_name (enum search_domain e)
273 case VARIABLES_DOMAIN: return "VARIABLES_DOMAIN";
274 case FUNCTIONS_DOMAIN: return "FUNCTIONS_DOMAIN";
275 case TYPES_DOMAIN: return "TYPES_DOMAIN";
276 case ALL_DOMAIN: return "ALL_DOMAIN";
277 default: gdb_assert_not_reached ("bad search_domain");
284 compunit_primary_filetab (const struct compunit_symtab *cust)
286 gdb_assert (COMPUNIT_FILETABS (cust) != NULL);
288 /* The primary file symtab is the first one in the list. */
289 return COMPUNIT_FILETABS (cust);
295 compunit_language (const struct compunit_symtab *cust)
297 struct symtab *symtab = compunit_primary_filetab (cust);
299 /* The language of the compunit symtab is the language of its primary
301 return SYMTAB_LANGUAGE (symtab);
304 /* See whether FILENAME matches SEARCH_NAME using the rule that we
305 advertise to the user. (The manual's description of linespecs
306 describes what we advertise). Returns true if they match, false
310 compare_filenames_for_search (const char *filename, const char *search_name)
312 int len = strlen (filename);
313 size_t search_len = strlen (search_name);
315 if (len < search_len)
318 /* The tail of FILENAME must match. */
319 if (FILENAME_CMP (filename + len - search_len, search_name) != 0)
322 /* Either the names must completely match, or the character
323 preceding the trailing SEARCH_NAME segment of FILENAME must be a
326 The check !IS_ABSOLUTE_PATH ensures SEARCH_NAME "/dir/file.c"
327 cannot match FILENAME "/path//dir/file.c" - as user has requested
328 absolute path. The sama applies for "c:\file.c" possibly
329 incorrectly hypothetically matching "d:\dir\c:\file.c".
331 The HAS_DRIVE_SPEC purpose is to make FILENAME "c:file.c"
332 compatible with SEARCH_NAME "file.c". In such case a compiler had
333 to put the "c:file.c" name into debug info. Such compatibility
334 works only on GDB built for DOS host. */
335 return (len == search_len
336 || (!IS_ABSOLUTE_PATH (search_name)
337 && IS_DIR_SEPARATOR (filename[len - search_len - 1]))
338 || (HAS_DRIVE_SPEC (filename)
339 && STRIP_DRIVE_SPEC (filename) == &filename[len - search_len]));
342 /* Check for a symtab of a specific name by searching some symtabs.
343 This is a helper function for callbacks of iterate_over_symtabs.
345 If NAME is not absolute, then REAL_PATH is NULL
346 If NAME is absolute, then REAL_PATH is the gdb_realpath form of NAME.
348 The return value, NAME, REAL_PATH, CALLBACK, and DATA
349 are identical to the `map_symtabs_matching_filename' method of
350 quick_symbol_functions.
352 FIRST and AFTER_LAST indicate the range of compunit symtabs to search.
353 Each symtab within the specified compunit symtab is also searched.
354 AFTER_LAST is one past the last compunit symtab to search; NULL means to
355 search until the end of the list. */
358 iterate_over_some_symtabs (const char *name,
359 const char *real_path,
360 int (*callback) (struct symtab *symtab,
363 struct compunit_symtab *first,
364 struct compunit_symtab *after_last)
366 struct compunit_symtab *cust;
368 const char* base_name = lbasename (name);
370 for (cust = first; cust != NULL && cust != after_last; cust = cust->next)
372 ALL_COMPUNIT_FILETABS (cust, s)
374 if (compare_filenames_for_search (s->filename, name))
376 if (callback (s, data))
381 /* Before we invoke realpath, which can get expensive when many
382 files are involved, do a quick comparison of the basenames. */
383 if (! basenames_may_differ
384 && FILENAME_CMP (base_name, lbasename (s->filename)) != 0)
387 if (compare_filenames_for_search (symtab_to_fullname (s), name))
389 if (callback (s, data))
394 /* If the user gave us an absolute path, try to find the file in
395 this symtab and use its absolute path. */
396 if (real_path != NULL)
398 const char *fullname = symtab_to_fullname (s);
400 gdb_assert (IS_ABSOLUTE_PATH (real_path));
401 gdb_assert (IS_ABSOLUTE_PATH (name));
402 if (FILENAME_CMP (real_path, fullname) == 0)
404 if (callback (s, data))
415 /* Check for a symtab of a specific name; first in symtabs, then in
416 psymtabs. *If* there is no '/' in the name, a match after a '/'
417 in the symtab filename will also work.
419 Calls CALLBACK with each symtab that is found and with the supplied
420 DATA. If CALLBACK returns true, the search stops. */
423 iterate_over_symtabs (const char *name,
424 int (*callback) (struct symtab *symtab,
428 struct objfile *objfile;
429 char *real_path = NULL;
430 struct cleanup *cleanups = make_cleanup (null_cleanup, NULL);
432 /* Here we are interested in canonicalizing an absolute path, not
433 absolutizing a relative path. */
434 if (IS_ABSOLUTE_PATH (name))
436 real_path = gdb_realpath (name);
437 make_cleanup (xfree, real_path);
438 gdb_assert (IS_ABSOLUTE_PATH (real_path));
441 ALL_OBJFILES (objfile)
443 if (iterate_over_some_symtabs (name, real_path, callback, data,
444 objfile->compunit_symtabs, NULL))
446 do_cleanups (cleanups);
451 /* Same search rules as above apply here, but now we look thru the
454 ALL_OBJFILES (objfile)
457 && objfile->sf->qf->map_symtabs_matching_filename (objfile,
463 do_cleanups (cleanups);
468 do_cleanups (cleanups);
471 /* The callback function used by lookup_symtab. */
474 lookup_symtab_callback (struct symtab *symtab, void *data)
476 struct symtab **result_ptr = data;
478 *result_ptr = symtab;
482 /* A wrapper for iterate_over_symtabs that returns the first matching
486 lookup_symtab (const char *name)
488 struct symtab *result = NULL;
490 iterate_over_symtabs (name, lookup_symtab_callback, &result);
495 /* Mangle a GDB method stub type. This actually reassembles the pieces of the
496 full method name, which consist of the class name (from T), the unadorned
497 method name from METHOD_ID, and the signature for the specific overload,
498 specified by SIGNATURE_ID. Note that this function is g++ specific. */
501 gdb_mangle_name (struct type *type, int method_id, int signature_id)
503 int mangled_name_len;
505 struct fn_field *f = TYPE_FN_FIELDLIST1 (type, method_id);
506 struct fn_field *method = &f[signature_id];
507 const char *field_name = TYPE_FN_FIELDLIST_NAME (type, method_id);
508 const char *physname = TYPE_FN_FIELD_PHYSNAME (f, signature_id);
509 const char *newname = type_name_no_tag (type);
511 /* Does the form of physname indicate that it is the full mangled name
512 of a constructor (not just the args)? */
513 int is_full_physname_constructor;
516 int is_destructor = is_destructor_name (physname);
517 /* Need a new type prefix. */
518 char *const_prefix = method->is_const ? "C" : "";
519 char *volatile_prefix = method->is_volatile ? "V" : "";
521 int len = (newname == NULL ? 0 : strlen (newname));
523 /* Nothing to do if physname already contains a fully mangled v3 abi name
524 or an operator name. */
525 if ((physname[0] == '_' && physname[1] == 'Z')
526 || is_operator_name (field_name))
527 return xstrdup (physname);
529 is_full_physname_constructor = is_constructor_name (physname);
531 is_constructor = is_full_physname_constructor
532 || (newname && strcmp (field_name, newname) == 0);
535 is_destructor = (startswith (physname, "__dt"));
537 if (is_destructor || is_full_physname_constructor)
539 mangled_name = (char *) xmalloc (strlen (physname) + 1);
540 strcpy (mangled_name, physname);
546 xsnprintf (buf, sizeof (buf), "__%s%s", const_prefix, volatile_prefix);
548 else if (physname[0] == 't' || physname[0] == 'Q')
550 /* The physname for template and qualified methods already includes
552 xsnprintf (buf, sizeof (buf), "__%s%s", const_prefix, volatile_prefix);
558 xsnprintf (buf, sizeof (buf), "__%s%s%d", const_prefix,
559 volatile_prefix, len);
561 mangled_name_len = ((is_constructor ? 0 : strlen (field_name))
562 + strlen (buf) + len + strlen (physname) + 1);
564 mangled_name = (char *) xmalloc (mangled_name_len);
566 mangled_name[0] = '\0';
568 strcpy (mangled_name, field_name);
570 strcat (mangled_name, buf);
571 /* If the class doesn't have a name, i.e. newname NULL, then we just
572 mangle it using 0 for the length of the class. Thus it gets mangled
573 as something starting with `::' rather than `classname::'. */
575 strcat (mangled_name, newname);
577 strcat (mangled_name, physname);
578 return (mangled_name);
581 /* Set the demangled name of GSYMBOL to NAME. NAME must be already
582 correctly allocated. */
585 symbol_set_demangled_name (struct general_symbol_info *gsymbol,
587 struct obstack *obstack)
589 if (gsymbol->language == language_ada)
593 gsymbol->ada_mangled = 0;
594 gsymbol->language_specific.obstack = obstack;
598 gsymbol->ada_mangled = 1;
599 gsymbol->language_specific.mangled_lang.demangled_name = name;
603 gsymbol->language_specific.mangled_lang.demangled_name = name;
606 /* Return the demangled name of GSYMBOL. */
609 symbol_get_demangled_name (const struct general_symbol_info *gsymbol)
611 if (gsymbol->language == language_ada)
613 if (!gsymbol->ada_mangled)
618 return gsymbol->language_specific.mangled_lang.demangled_name;
622 /* Initialize the language dependent portion of a symbol
623 depending upon the language for the symbol. */
626 symbol_set_language (struct general_symbol_info *gsymbol,
627 enum language language,
628 struct obstack *obstack)
630 gsymbol->language = language;
631 if (gsymbol->language == language_cplus
632 || gsymbol->language == language_d
633 || gsymbol->language == language_go
634 || gsymbol->language == language_java
635 || gsymbol->language == language_objc
636 || gsymbol->language == language_fortran)
638 symbol_set_demangled_name (gsymbol, NULL, obstack);
640 else if (gsymbol->language == language_ada)
642 gdb_assert (gsymbol->ada_mangled == 0);
643 gsymbol->language_specific.obstack = obstack;
647 memset (&gsymbol->language_specific, 0,
648 sizeof (gsymbol->language_specific));
652 /* Functions to initialize a symbol's mangled name. */
654 /* Objects of this type are stored in the demangled name hash table. */
655 struct demangled_name_entry
661 /* Hash function for the demangled name hash. */
664 hash_demangled_name_entry (const void *data)
666 const struct demangled_name_entry *e = data;
668 return htab_hash_string (e->mangled);
671 /* Equality function for the demangled name hash. */
674 eq_demangled_name_entry (const void *a, const void *b)
676 const struct demangled_name_entry *da = a;
677 const struct demangled_name_entry *db = b;
679 return strcmp (da->mangled, db->mangled) == 0;
682 /* Create the hash table used for demangled names. Each hash entry is
683 a pair of strings; one for the mangled name and one for the demangled
684 name. The entry is hashed via just the mangled name. */
687 create_demangled_names_hash (struct objfile *objfile)
689 /* Choose 256 as the starting size of the hash table, somewhat arbitrarily.
690 The hash table code will round this up to the next prime number.
691 Choosing a much larger table size wastes memory, and saves only about
692 1% in symbol reading. */
694 objfile->per_bfd->demangled_names_hash = htab_create_alloc
695 (256, hash_demangled_name_entry, eq_demangled_name_entry,
696 NULL, xcalloc, xfree);
699 /* Try to determine the demangled name for a symbol, based on the
700 language of that symbol. If the language is set to language_auto,
701 it will attempt to find any demangling algorithm that works and
702 then set the language appropriately. The returned name is allocated
703 by the demangler and should be xfree'd. */
706 symbol_find_demangled_name (struct general_symbol_info *gsymbol,
709 char *demangled = NULL;
711 if (gsymbol->language == language_unknown)
712 gsymbol->language = language_auto;
714 if (gsymbol->language == language_objc
715 || gsymbol->language == language_auto)
718 objc_demangle (mangled, 0);
719 if (demangled != NULL)
721 gsymbol->language = language_objc;
725 if (gsymbol->language == language_cplus
726 || gsymbol->language == language_auto)
729 gdb_demangle (mangled, DMGL_PARAMS | DMGL_ANSI);
730 if (demangled != NULL)
732 gsymbol->language = language_cplus;
736 if (gsymbol->language == language_java)
739 gdb_demangle (mangled,
740 DMGL_PARAMS | DMGL_ANSI | DMGL_JAVA);
741 if (demangled != NULL)
743 gsymbol->language = language_java;
747 if (gsymbol->language == language_d
748 || gsymbol->language == language_auto)
750 demangled = d_demangle(mangled, 0);
751 if (demangled != NULL)
753 gsymbol->language = language_d;
757 /* FIXME(dje): Continually adding languages here is clumsy.
758 Better to just call la_demangle if !auto, and if auto then call
759 a utility routine that tries successive languages in turn and reports
760 which one it finds. I realize the la_demangle options may be different
761 for different languages but there's already a FIXME for that. */
762 if (gsymbol->language == language_go
763 || gsymbol->language == language_auto)
765 demangled = go_demangle (mangled, 0);
766 if (demangled != NULL)
768 gsymbol->language = language_go;
773 /* We could support `gsymbol->language == language_fortran' here to provide
774 module namespaces also for inferiors with only minimal symbol table (ELF
775 symbols). Just the mangling standard is not standardized across compilers
776 and there is no DW_AT_producer available for inferiors with only the ELF
777 symbols to check the mangling kind. */
779 /* Check for Ada symbols last. See comment below explaining why. */
781 if (gsymbol->language == language_auto)
783 const char *demangled = ada_decode (mangled);
785 if (demangled != mangled && demangled != NULL && demangled[0] != '<')
787 /* Set the gsymbol language to Ada, but still return NULL.
788 Two reasons for that:
790 1. For Ada, we prefer computing the symbol's decoded name
791 on the fly rather than pre-compute it, in order to save
792 memory (Ada projects are typically very large).
794 2. There are some areas in the definition of the GNAT
795 encoding where, with a bit of bad luck, we might be able
796 to decode a non-Ada symbol, generating an incorrect
797 demangled name (Eg: names ending with "TB" for instance
798 are identified as task bodies and so stripped from
799 the decoded name returned).
801 Returning NULL, here, helps us get a little bit of
802 the best of both worlds. Because we're last, we should
803 not affect any of the other languages that were able to
804 demangle the symbol before us; we get to correctly tag
805 Ada symbols as such; and even if we incorrectly tagged
806 a non-Ada symbol, which should be rare, any routing
807 through the Ada language should be transparent (Ada
808 tries to behave much like C/C++ with non-Ada symbols). */
809 gsymbol->language = language_ada;
817 /* Set both the mangled and demangled (if any) names for GSYMBOL based
818 on LINKAGE_NAME and LEN. Ordinarily, NAME is copied onto the
819 objfile's obstack; but if COPY_NAME is 0 and if NAME is
820 NUL-terminated, then this function assumes that NAME is already
821 correctly saved (either permanently or with a lifetime tied to the
822 objfile), and it will not be copied.
824 The hash table corresponding to OBJFILE is used, and the memory
825 comes from the per-BFD storage_obstack. LINKAGE_NAME is copied,
826 so the pointer can be discarded after calling this function. */
828 /* We have to be careful when dealing with Java names: when we run
829 into a Java minimal symbol, we don't know it's a Java symbol, so it
830 gets demangled as a C++ name. This is unfortunate, but there's not
831 much we can do about it: but when demangling partial symbols and
832 regular symbols, we'd better not reuse the wrong demangled name.
833 (See PR gdb/1039.) We solve this by putting a distinctive prefix
834 on Java names when storing them in the hash table. */
836 /* FIXME: carlton/2003-03-13: This is an unfortunate situation. I
837 don't mind the Java prefix so much: different languages have
838 different demangling requirements, so it's only natural that we
839 need to keep language data around in our demangling cache. But
840 it's not good that the minimal symbol has the wrong demangled name.
841 Unfortunately, I can't think of any easy solution to that
844 #define JAVA_PREFIX "##JAVA$$"
845 #define JAVA_PREFIX_LEN 8
848 symbol_set_names (struct general_symbol_info *gsymbol,
849 const char *linkage_name, int len, int copy_name,
850 struct objfile *objfile)
852 struct demangled_name_entry **slot;
853 /* A 0-terminated copy of the linkage name. */
854 const char *linkage_name_copy;
855 /* A copy of the linkage name that might have a special Java prefix
856 added to it, for use when looking names up in the hash table. */
857 const char *lookup_name;
858 /* The length of lookup_name. */
860 struct demangled_name_entry entry;
861 struct objfile_per_bfd_storage *per_bfd = objfile->per_bfd;
863 if (gsymbol->language == language_ada)
865 /* In Ada, we do the symbol lookups using the mangled name, so
866 we can save some space by not storing the demangled name.
868 As a side note, we have also observed some overlap between
869 the C++ mangling and Ada mangling, similarly to what has
870 been observed with Java. Because we don't store the demangled
871 name with the symbol, we don't need to use the same trick
874 gsymbol->name = linkage_name;
877 char *name = obstack_alloc (&per_bfd->storage_obstack, len + 1);
879 memcpy (name, linkage_name, len);
881 gsymbol->name = name;
883 symbol_set_demangled_name (gsymbol, NULL, &per_bfd->storage_obstack);
888 if (per_bfd->demangled_names_hash == NULL)
889 create_demangled_names_hash (objfile);
891 /* The stabs reader generally provides names that are not
892 NUL-terminated; most of the other readers don't do this, so we
893 can just use the given copy, unless we're in the Java case. */
894 if (gsymbol->language == language_java)
898 lookup_len = len + JAVA_PREFIX_LEN;
899 alloc_name = alloca (lookup_len + 1);
900 memcpy (alloc_name, JAVA_PREFIX, JAVA_PREFIX_LEN);
901 memcpy (alloc_name + JAVA_PREFIX_LEN, linkage_name, len);
902 alloc_name[lookup_len] = '\0';
904 lookup_name = alloc_name;
905 linkage_name_copy = alloc_name + JAVA_PREFIX_LEN;
907 else if (linkage_name[len] != '\0')
912 alloc_name = alloca (lookup_len + 1);
913 memcpy (alloc_name, linkage_name, len);
914 alloc_name[lookup_len] = '\0';
916 lookup_name = alloc_name;
917 linkage_name_copy = alloc_name;
922 lookup_name = linkage_name;
923 linkage_name_copy = linkage_name;
926 entry.mangled = lookup_name;
927 slot = ((struct demangled_name_entry **)
928 htab_find_slot (per_bfd->demangled_names_hash,
931 /* If this name is not in the hash table, add it. */
933 /* A C version of the symbol may have already snuck into the table.
934 This happens to, e.g., main.init (__go_init_main). Cope. */
935 || (gsymbol->language == language_go
936 && (*slot)->demangled[0] == '\0'))
938 char *demangled_name = symbol_find_demangled_name (gsymbol,
940 int demangled_len = demangled_name ? strlen (demangled_name) : 0;
942 /* Suppose we have demangled_name==NULL, copy_name==0, and
943 lookup_name==linkage_name. In this case, we already have the
944 mangled name saved, and we don't have a demangled name. So,
945 you might think we could save a little space by not recording
946 this in the hash table at all.
948 It turns out that it is actually important to still save such
949 an entry in the hash table, because storing this name gives
950 us better bcache hit rates for partial symbols. */
951 if (!copy_name && lookup_name == linkage_name)
953 *slot = obstack_alloc (&per_bfd->storage_obstack,
954 offsetof (struct demangled_name_entry,
956 + demangled_len + 1);
957 (*slot)->mangled = lookup_name;
963 /* If we must copy the mangled name, put it directly after
964 the demangled name so we can have a single
966 *slot = obstack_alloc (&per_bfd->storage_obstack,
967 offsetof (struct demangled_name_entry,
969 + lookup_len + demangled_len + 2);
970 mangled_ptr = &((*slot)->demangled[demangled_len + 1]);
971 strcpy (mangled_ptr, lookup_name);
972 (*slot)->mangled = mangled_ptr;
975 if (demangled_name != NULL)
977 strcpy ((*slot)->demangled, demangled_name);
978 xfree (demangled_name);
981 (*slot)->demangled[0] = '\0';
984 gsymbol->name = (*slot)->mangled + lookup_len - len;
985 if ((*slot)->demangled[0] != '\0')
986 symbol_set_demangled_name (gsymbol, (*slot)->demangled,
987 &per_bfd->storage_obstack);
989 symbol_set_demangled_name (gsymbol, NULL, &per_bfd->storage_obstack);
992 /* Return the source code name of a symbol. In languages where
993 demangling is necessary, this is the demangled name. */
996 symbol_natural_name (const struct general_symbol_info *gsymbol)
998 switch (gsymbol->language)
1000 case language_cplus:
1005 case language_fortran:
1006 if (symbol_get_demangled_name (gsymbol) != NULL)
1007 return symbol_get_demangled_name (gsymbol);
1010 return ada_decode_symbol (gsymbol);
1014 return gsymbol->name;
1017 /* Return the demangled name for a symbol based on the language for
1018 that symbol. If no demangled name exists, return NULL. */
1021 symbol_demangled_name (const struct general_symbol_info *gsymbol)
1023 const char *dem_name = NULL;
1025 switch (gsymbol->language)
1027 case language_cplus:
1032 case language_fortran:
1033 dem_name = symbol_get_demangled_name (gsymbol);
1036 dem_name = ada_decode_symbol (gsymbol);
1044 /* Return the search name of a symbol---generally the demangled or
1045 linkage name of the symbol, depending on how it will be searched for.
1046 If there is no distinct demangled name, then returns the same value
1047 (same pointer) as SYMBOL_LINKAGE_NAME. */
1050 symbol_search_name (const struct general_symbol_info *gsymbol)
1052 if (gsymbol->language == language_ada)
1053 return gsymbol->name;
1055 return symbol_natural_name (gsymbol);
1058 /* Initialize the structure fields to zero values. */
1061 init_sal (struct symtab_and_line *sal)
1063 memset (sal, 0, sizeof (*sal));
1067 /* Return 1 if the two sections are the same, or if they could
1068 plausibly be copies of each other, one in an original object
1069 file and another in a separated debug file. */
1072 matching_obj_sections (struct obj_section *obj_first,
1073 struct obj_section *obj_second)
1075 asection *first = obj_first? obj_first->the_bfd_section : NULL;
1076 asection *second = obj_second? obj_second->the_bfd_section : NULL;
1077 struct objfile *obj;
1079 /* If they're the same section, then they match. */
1080 if (first == second)
1083 /* If either is NULL, give up. */
1084 if (first == NULL || second == NULL)
1087 /* This doesn't apply to absolute symbols. */
1088 if (first->owner == NULL || second->owner == NULL)
1091 /* If they're in the same object file, they must be different sections. */
1092 if (first->owner == second->owner)
1095 /* Check whether the two sections are potentially corresponding. They must
1096 have the same size, address, and name. We can't compare section indexes,
1097 which would be more reliable, because some sections may have been
1099 if (bfd_get_section_size (first) != bfd_get_section_size (second))
1102 /* In-memory addresses may start at a different offset, relativize them. */
1103 if (bfd_get_section_vma (first->owner, first)
1104 - bfd_get_start_address (first->owner)
1105 != bfd_get_section_vma (second->owner, second)
1106 - bfd_get_start_address (second->owner))
1109 if (bfd_get_section_name (first->owner, first) == NULL
1110 || bfd_get_section_name (second->owner, second) == NULL
1111 || strcmp (bfd_get_section_name (first->owner, first),
1112 bfd_get_section_name (second->owner, second)) != 0)
1115 /* Otherwise check that they are in corresponding objfiles. */
1118 if (obj->obfd == first->owner)
1120 gdb_assert (obj != NULL);
1122 if (obj->separate_debug_objfile != NULL
1123 && obj->separate_debug_objfile->obfd == second->owner)
1125 if (obj->separate_debug_objfile_backlink != NULL
1126 && obj->separate_debug_objfile_backlink->obfd == second->owner)
1135 expand_symtab_containing_pc (CORE_ADDR pc, struct obj_section *section)
1137 struct objfile *objfile;
1138 struct bound_minimal_symbol msymbol;
1140 /* If we know that this is not a text address, return failure. This is
1141 necessary because we loop based on texthigh and textlow, which do
1142 not include the data ranges. */
1143 msymbol = lookup_minimal_symbol_by_pc_section (pc, section);
1145 && (MSYMBOL_TYPE (msymbol.minsym) == mst_data
1146 || MSYMBOL_TYPE (msymbol.minsym) == mst_bss
1147 || MSYMBOL_TYPE (msymbol.minsym) == mst_abs
1148 || MSYMBOL_TYPE (msymbol.minsym) == mst_file_data
1149 || MSYMBOL_TYPE (msymbol.minsym) == mst_file_bss))
1152 ALL_OBJFILES (objfile)
1154 struct compunit_symtab *cust = NULL;
1157 cust = objfile->sf->qf->find_pc_sect_compunit_symtab (objfile, msymbol,
1164 /* Hash function for the symbol cache. */
1167 hash_symbol_entry (const struct objfile *objfile_context,
1168 const char *name, domain_enum domain)
1170 unsigned int hash = (uintptr_t) objfile_context;
1173 hash += htab_hash_string (name);
1175 /* Because of symbol_matches_domain we need VAR_DOMAIN and STRUCT_DOMAIN
1176 to map to the same slot. */
1177 if (domain == STRUCT_DOMAIN)
1178 hash += VAR_DOMAIN * 7;
1185 /* Equality function for the symbol cache. */
1188 eq_symbol_entry (const struct symbol_cache_slot *slot,
1189 const struct objfile *objfile_context,
1190 const char *name, domain_enum domain)
1192 const char *slot_name;
1193 domain_enum slot_domain;
1195 if (slot->state == SYMBOL_SLOT_UNUSED)
1198 if (slot->objfile_context != objfile_context)
1201 if (slot->state == SYMBOL_SLOT_NOT_FOUND)
1203 slot_name = slot->value.not_found.name;
1204 slot_domain = slot->value.not_found.domain;
1208 slot_name = SYMBOL_SEARCH_NAME (slot->value.found.symbol);
1209 slot_domain = SYMBOL_DOMAIN (slot->value.found.symbol);
1212 /* NULL names match. */
1213 if (slot_name == NULL && name == NULL)
1215 /* But there's no point in calling symbol_matches_domain in the
1216 SYMBOL_SLOT_FOUND case. */
1217 if (slot_domain != domain)
1220 else if (slot_name != NULL && name != NULL)
1222 /* It's important that we use the same comparison that was done the
1223 first time through. If the slot records a found symbol, then this
1224 means using strcmp_iw on SYMBOL_SEARCH_NAME. See dictionary.c.
1225 It also means using symbol_matches_domain for found symbols.
1228 If the slot records a not-found symbol, then require a precise match.
1229 We could still be lax with whitespace like strcmp_iw though. */
1231 if (slot->state == SYMBOL_SLOT_NOT_FOUND)
1233 if (strcmp (slot_name, name) != 0)
1235 if (slot_domain != domain)
1240 struct symbol *sym = slot->value.found.symbol;
1242 if (strcmp_iw (slot_name, name) != 0)
1244 if (!symbol_matches_domain (SYMBOL_LANGUAGE (sym),
1245 slot_domain, domain))
1251 /* Only one name is NULL. */
1258 /* Given a cache of size SIZE, return the size of the struct (with variable
1259 length array) in bytes. */
1262 symbol_cache_byte_size (unsigned int size)
1264 return (sizeof (struct block_symbol_cache)
1265 + ((size - 1) * sizeof (struct symbol_cache_slot)));
1271 resize_symbol_cache (struct symbol_cache *cache, unsigned int new_size)
1273 /* If there's no change in size, don't do anything.
1274 All caches have the same size, so we can just compare with the size
1275 of the global symbols cache. */
1276 if ((cache->global_symbols != NULL
1277 && cache->global_symbols->size == new_size)
1278 || (cache->global_symbols == NULL
1282 xfree (cache->global_symbols);
1283 xfree (cache->static_symbols);
1287 cache->global_symbols = NULL;
1288 cache->static_symbols = NULL;
1292 size_t total_size = symbol_cache_byte_size (new_size);
1294 cache->global_symbols = xcalloc (1, total_size);
1295 cache->static_symbols = xcalloc (1, total_size);
1296 cache->global_symbols->size = new_size;
1297 cache->static_symbols->size = new_size;
1301 /* Make a symbol cache of size SIZE. */
1303 static struct symbol_cache *
1304 make_symbol_cache (unsigned int size)
1306 struct symbol_cache *cache;
1308 cache = XCNEW (struct symbol_cache);
1309 resize_symbol_cache (cache, symbol_cache_size);
1313 /* Free the space used by CACHE. */
1316 free_symbol_cache (struct symbol_cache *cache)
1318 xfree (cache->global_symbols);
1319 xfree (cache->static_symbols);
1323 /* Return the symbol cache of PSPACE.
1324 Create one if it doesn't exist yet. */
1326 static struct symbol_cache *
1327 get_symbol_cache (struct program_space *pspace)
1329 struct symbol_cache *cache = program_space_data (pspace, symbol_cache_key);
1333 cache = make_symbol_cache (symbol_cache_size);
1334 set_program_space_data (pspace, symbol_cache_key, cache);
1340 /* Delete the symbol cache of PSPACE.
1341 Called when PSPACE is destroyed. */
1344 symbol_cache_cleanup (struct program_space *pspace, void *data)
1346 struct symbol_cache *cache = data;
1348 free_symbol_cache (cache);
1351 /* Set the size of the symbol cache in all program spaces. */
1354 set_symbol_cache_size (unsigned int new_size)
1356 struct program_space *pspace;
1358 ALL_PSPACES (pspace)
1360 struct symbol_cache *cache
1361 = program_space_data (pspace, symbol_cache_key);
1363 /* The pspace could have been created but not have a cache yet. */
1365 resize_symbol_cache (cache, new_size);
1369 /* Called when symbol-cache-size is set. */
1372 set_symbol_cache_size_handler (char *args, int from_tty,
1373 struct cmd_list_element *c)
1375 if (new_symbol_cache_size > MAX_SYMBOL_CACHE_SIZE)
1377 /* Restore the previous value.
1378 This is the value the "show" command prints. */
1379 new_symbol_cache_size = symbol_cache_size;
1381 error (_("Symbol cache size is too large, max is %u."),
1382 MAX_SYMBOL_CACHE_SIZE);
1384 symbol_cache_size = new_symbol_cache_size;
1386 set_symbol_cache_size (symbol_cache_size);
1389 /* Lookup symbol NAME,DOMAIN in BLOCK in the symbol cache of PSPACE.
1390 OBJFILE_CONTEXT is the current objfile, which may be NULL.
1391 The result is the symbol if found, SYMBOL_LOOKUP_FAILED if a previous lookup
1392 failed (and thus this one will too), or NULL if the symbol is not present
1394 If the symbol is not present in the cache, then *BSC_PTR and *SLOT_PTR are
1395 set to the cache and slot of the symbol to save the result of a full lookup
1398 static struct block_symbol
1399 symbol_cache_lookup (struct symbol_cache *cache,
1400 struct objfile *objfile_context, int block,
1401 const char *name, domain_enum domain,
1402 struct block_symbol_cache **bsc_ptr,
1403 struct symbol_cache_slot **slot_ptr)
1405 struct block_symbol_cache *bsc;
1407 struct symbol_cache_slot *slot;
1409 if (block == GLOBAL_BLOCK)
1410 bsc = cache->global_symbols;
1412 bsc = cache->static_symbols;
1417 return (struct block_symbol) {NULL, NULL};
1420 hash = hash_symbol_entry (objfile_context, name, domain);
1421 slot = bsc->symbols + hash % bsc->size;
1423 if (eq_symbol_entry (slot, objfile_context, name, domain))
1425 if (symbol_lookup_debug)
1426 fprintf_unfiltered (gdb_stdlog,
1427 "%s block symbol cache hit%s for %s, %s\n",
1428 block == GLOBAL_BLOCK ? "Global" : "Static",
1429 slot->state == SYMBOL_SLOT_NOT_FOUND
1430 ? " (not found)" : "",
1431 name, domain_name (domain));
1433 if (slot->state == SYMBOL_SLOT_NOT_FOUND)
1434 return SYMBOL_LOOKUP_FAILED;
1435 return slot->value.found;
1438 /* Symbol is not present in the cache. */
1443 if (symbol_lookup_debug)
1445 fprintf_unfiltered (gdb_stdlog,
1446 "%s block symbol cache miss for %s, %s\n",
1447 block == GLOBAL_BLOCK ? "Global" : "Static",
1448 name, domain_name (domain));
1451 return (struct block_symbol) {NULL, NULL};
1454 /* Clear out SLOT. */
1457 symbol_cache_clear_slot (struct symbol_cache_slot *slot)
1459 if (slot->state == SYMBOL_SLOT_NOT_FOUND)
1460 xfree (slot->value.not_found.name);
1461 slot->state = SYMBOL_SLOT_UNUSED;
1464 /* Mark SYMBOL as found in SLOT.
1465 OBJFILE_CONTEXT is the current objfile when the lookup was done, or NULL
1466 if it's not needed to distinguish lookups (STATIC_BLOCK). It is *not*
1467 necessarily the objfile the symbol was found in. */
1470 symbol_cache_mark_found (struct block_symbol_cache *bsc,
1471 struct symbol_cache_slot *slot,
1472 struct objfile *objfile_context,
1473 struct symbol *symbol,
1474 const struct block *block)
1478 if (slot->state != SYMBOL_SLOT_UNUSED)
1481 symbol_cache_clear_slot (slot);
1483 slot->state = SYMBOL_SLOT_FOUND;
1484 slot->objfile_context = objfile_context;
1485 slot->value.found.symbol = symbol;
1486 slot->value.found.block = block;
1489 /* Mark symbol NAME, DOMAIN as not found in SLOT.
1490 OBJFILE_CONTEXT is the current objfile when the lookup was done, or NULL
1491 if it's not needed to distinguish lookups (STATIC_BLOCK). */
1494 symbol_cache_mark_not_found (struct block_symbol_cache *bsc,
1495 struct symbol_cache_slot *slot,
1496 struct objfile *objfile_context,
1497 const char *name, domain_enum domain)
1501 if (slot->state != SYMBOL_SLOT_UNUSED)
1504 symbol_cache_clear_slot (slot);
1506 slot->state = SYMBOL_SLOT_NOT_FOUND;
1507 slot->objfile_context = objfile_context;
1508 slot->value.not_found.name = xstrdup (name);
1509 slot->value.not_found.domain = domain;
1512 /* Flush the symbol cache of PSPACE. */
1515 symbol_cache_flush (struct program_space *pspace)
1517 struct symbol_cache *cache = program_space_data (pspace, symbol_cache_key);
1523 if (cache->global_symbols == NULL)
1525 gdb_assert (symbol_cache_size == 0);
1526 gdb_assert (cache->static_symbols == NULL);
1530 /* If the cache is untouched since the last flush, early exit.
1531 This is important for performance during the startup of a program linked
1532 with 100s (or 1000s) of shared libraries. */
1533 if (cache->global_symbols->misses == 0
1534 && cache->static_symbols->misses == 0)
1537 gdb_assert (cache->global_symbols->size == symbol_cache_size);
1538 gdb_assert (cache->static_symbols->size == symbol_cache_size);
1540 for (pass = 0; pass < 2; ++pass)
1542 struct block_symbol_cache *bsc
1543 = pass == 0 ? cache->global_symbols : cache->static_symbols;
1546 for (i = 0; i < bsc->size; ++i)
1547 symbol_cache_clear_slot (&bsc->symbols[i]);
1550 cache->global_symbols->hits = 0;
1551 cache->global_symbols->misses = 0;
1552 cache->global_symbols->collisions = 0;
1553 cache->static_symbols->hits = 0;
1554 cache->static_symbols->misses = 0;
1555 cache->static_symbols->collisions = 0;
1561 symbol_cache_dump (const struct symbol_cache *cache)
1565 if (cache->global_symbols == NULL)
1567 printf_filtered (" <disabled>\n");
1571 for (pass = 0; pass < 2; ++pass)
1573 const struct block_symbol_cache *bsc
1574 = pass == 0 ? cache->global_symbols : cache->static_symbols;
1578 printf_filtered ("Global symbols:\n");
1580 printf_filtered ("Static symbols:\n");
1582 for (i = 0; i < bsc->size; ++i)
1584 const struct symbol_cache_slot *slot = &bsc->symbols[i];
1588 switch (slot->state)
1590 case SYMBOL_SLOT_UNUSED:
1592 case SYMBOL_SLOT_NOT_FOUND:
1593 printf_filtered (" [%4u] = %s, %s %s (not found)\n", i,
1594 host_address_to_string (slot->objfile_context),
1595 slot->value.not_found.name,
1596 domain_name (slot->value.not_found.domain));
1598 case SYMBOL_SLOT_FOUND:
1600 struct symbol *found = slot->value.found.symbol;
1601 const struct objfile *context = slot->objfile_context;
1603 printf_filtered (" [%4u] = %s, %s %s\n", i,
1604 host_address_to_string (context),
1605 SYMBOL_PRINT_NAME (found),
1606 domain_name (SYMBOL_DOMAIN (found)));
1614 /* The "mt print symbol-cache" command. */
1617 maintenance_print_symbol_cache (char *args, int from_tty)
1619 struct program_space *pspace;
1621 ALL_PSPACES (pspace)
1623 struct symbol_cache *cache;
1625 printf_filtered (_("Symbol cache for pspace %d\n%s:\n"),
1627 pspace->symfile_object_file != NULL
1628 ? objfile_name (pspace->symfile_object_file)
1629 : "(no object file)");
1631 /* If the cache hasn't been created yet, avoid creating one. */
1632 cache = program_space_data (pspace, symbol_cache_key);
1634 printf_filtered (" <empty>\n");
1636 symbol_cache_dump (cache);
1640 /* The "mt flush-symbol-cache" command. */
1643 maintenance_flush_symbol_cache (char *args, int from_tty)
1645 struct program_space *pspace;
1647 ALL_PSPACES (pspace)
1649 symbol_cache_flush (pspace);
1653 /* Print usage statistics of CACHE. */
1656 symbol_cache_stats (struct symbol_cache *cache)
1660 if (cache->global_symbols == NULL)
1662 printf_filtered (" <disabled>\n");
1666 for (pass = 0; pass < 2; ++pass)
1668 const struct block_symbol_cache *bsc
1669 = pass == 0 ? cache->global_symbols : cache->static_symbols;
1674 printf_filtered ("Global block cache stats:\n");
1676 printf_filtered ("Static block cache stats:\n");
1678 printf_filtered (" size: %u\n", bsc->size);
1679 printf_filtered (" hits: %u\n", bsc->hits);
1680 printf_filtered (" misses: %u\n", bsc->misses);
1681 printf_filtered (" collisions: %u\n", bsc->collisions);
1685 /* The "mt print symbol-cache-statistics" command. */
1688 maintenance_print_symbol_cache_statistics (char *args, int from_tty)
1690 struct program_space *pspace;
1692 ALL_PSPACES (pspace)
1694 struct symbol_cache *cache;
1696 printf_filtered (_("Symbol cache statistics for pspace %d\n%s:\n"),
1698 pspace->symfile_object_file != NULL
1699 ? objfile_name (pspace->symfile_object_file)
1700 : "(no object file)");
1702 /* If the cache hasn't been created yet, avoid creating one. */
1703 cache = program_space_data (pspace, symbol_cache_key);
1705 printf_filtered (" empty, no stats available\n");
1707 symbol_cache_stats (cache);
1711 /* This module's 'new_objfile' observer. */
1714 symtab_new_objfile_observer (struct objfile *objfile)
1716 /* Ideally we'd use OBJFILE->pspace, but OBJFILE may be NULL. */
1717 symbol_cache_flush (current_program_space);
1720 /* This module's 'free_objfile' observer. */
1723 symtab_free_objfile_observer (struct objfile *objfile)
1725 symbol_cache_flush (objfile->pspace);
1728 /* Debug symbols usually don't have section information. We need to dig that
1729 out of the minimal symbols and stash that in the debug symbol. */
1732 fixup_section (struct general_symbol_info *ginfo,
1733 CORE_ADDR addr, struct objfile *objfile)
1735 struct minimal_symbol *msym;
1737 /* First, check whether a minimal symbol with the same name exists
1738 and points to the same address. The address check is required
1739 e.g. on PowerPC64, where the minimal symbol for a function will
1740 point to the function descriptor, while the debug symbol will
1741 point to the actual function code. */
1742 msym = lookup_minimal_symbol_by_pc_name (addr, ginfo->name, objfile);
1744 ginfo->section = MSYMBOL_SECTION (msym);
1747 /* Static, function-local variables do appear in the linker
1748 (minimal) symbols, but are frequently given names that won't
1749 be found via lookup_minimal_symbol(). E.g., it has been
1750 observed in frv-uclinux (ELF) executables that a static,
1751 function-local variable named "foo" might appear in the
1752 linker symbols as "foo.6" or "foo.3". Thus, there is no
1753 point in attempting to extend the lookup-by-name mechanism to
1754 handle this case due to the fact that there can be multiple
1757 So, instead, search the section table when lookup by name has
1758 failed. The ``addr'' and ``endaddr'' fields may have already
1759 been relocated. If so, the relocation offset (i.e. the
1760 ANOFFSET value) needs to be subtracted from these values when
1761 performing the comparison. We unconditionally subtract it,
1762 because, when no relocation has been performed, the ANOFFSET
1763 value will simply be zero.
1765 The address of the symbol whose section we're fixing up HAS
1766 NOT BEEN adjusted (relocated) yet. It can't have been since
1767 the section isn't yet known and knowing the section is
1768 necessary in order to add the correct relocation value. In
1769 other words, we wouldn't even be in this function (attempting
1770 to compute the section) if it were already known.
1772 Note that it is possible to search the minimal symbols
1773 (subtracting the relocation value if necessary) to find the
1774 matching minimal symbol, but this is overkill and much less
1775 efficient. It is not necessary to find the matching minimal
1776 symbol, only its section.
1778 Note that this technique (of doing a section table search)
1779 can fail when unrelocated section addresses overlap. For
1780 this reason, we still attempt a lookup by name prior to doing
1781 a search of the section table. */
1783 struct obj_section *s;
1786 ALL_OBJFILE_OSECTIONS (objfile, s)
1788 int idx = s - objfile->sections;
1789 CORE_ADDR offset = ANOFFSET (objfile->section_offsets, idx);
1794 if (obj_section_addr (s) - offset <= addr
1795 && addr < obj_section_endaddr (s) - offset)
1797 ginfo->section = idx;
1802 /* If we didn't find the section, assume it is in the first
1803 section. If there is no allocated section, then it hardly
1804 matters what we pick, so just pick zero. */
1808 ginfo->section = fallback;
1813 fixup_symbol_section (struct symbol *sym, struct objfile *objfile)
1820 if (!SYMBOL_OBJFILE_OWNED (sym))
1823 /* We either have an OBJFILE, or we can get at it from the sym's
1824 symtab. Anything else is a bug. */
1825 gdb_assert (objfile || symbol_symtab (sym));
1827 if (objfile == NULL)
1828 objfile = symbol_objfile (sym);
1830 if (SYMBOL_OBJ_SECTION (objfile, sym))
1833 /* We should have an objfile by now. */
1834 gdb_assert (objfile);
1836 switch (SYMBOL_CLASS (sym))
1840 addr = SYMBOL_VALUE_ADDRESS (sym);
1843 addr = BLOCK_START (SYMBOL_BLOCK_VALUE (sym));
1847 /* Nothing else will be listed in the minsyms -- no use looking
1852 fixup_section (&sym->ginfo, addr, objfile);
1857 /* Compute the demangled form of NAME as used by the various symbol
1858 lookup functions. The result is stored in *RESULT_NAME. Returns a
1859 cleanup which can be used to clean up the result.
1861 For Ada, this function just sets *RESULT_NAME to NAME, unmodified.
1862 Normally, Ada symbol lookups are performed using the encoded name
1863 rather than the demangled name, and so it might seem to make sense
1864 for this function to return an encoded version of NAME.
1865 Unfortunately, we cannot do this, because this function is used in
1866 circumstances where it is not appropriate to try to encode NAME.
1867 For instance, when displaying the frame info, we demangle the name
1868 of each parameter, and then perform a symbol lookup inside our
1869 function using that demangled name. In Ada, certain functions
1870 have internally-generated parameters whose name contain uppercase
1871 characters. Encoding those name would result in those uppercase
1872 characters to become lowercase, and thus cause the symbol lookup
1876 demangle_for_lookup (const char *name, enum language lang,
1877 const char **result_name)
1879 char *demangled_name = NULL;
1880 const char *modified_name = NULL;
1881 struct cleanup *cleanup = make_cleanup (null_cleanup, 0);
1883 modified_name = name;
1885 /* If we are using C++, D, Go, or Java, demangle the name before doing a
1886 lookup, so we can always binary search. */
1887 if (lang == language_cplus)
1889 demangled_name = gdb_demangle (name, DMGL_ANSI | DMGL_PARAMS);
1892 modified_name = demangled_name;
1893 make_cleanup (xfree, demangled_name);
1897 /* If we were given a non-mangled name, canonicalize it
1898 according to the language (so far only for C++). */
1899 demangled_name = cp_canonicalize_string (name);
1902 modified_name = demangled_name;
1903 make_cleanup (xfree, demangled_name);
1907 else if (lang == language_java)
1909 demangled_name = gdb_demangle (name,
1910 DMGL_ANSI | DMGL_PARAMS | DMGL_JAVA);
1913 modified_name = demangled_name;
1914 make_cleanup (xfree, demangled_name);
1917 else if (lang == language_d)
1919 demangled_name = d_demangle (name, 0);
1922 modified_name = demangled_name;
1923 make_cleanup (xfree, demangled_name);
1926 else if (lang == language_go)
1928 demangled_name = go_demangle (name, 0);
1931 modified_name = demangled_name;
1932 make_cleanup (xfree, demangled_name);
1936 *result_name = modified_name;
1942 This function (or rather its subordinates) have a bunch of loops and
1943 it would seem to be attractive to put in some QUIT's (though I'm not really
1944 sure whether it can run long enough to be really important). But there
1945 are a few calls for which it would appear to be bad news to quit
1946 out of here: e.g., find_proc_desc in alpha-mdebug-tdep.c. (Note
1947 that there is C++ code below which can error(), but that probably
1948 doesn't affect these calls since they are looking for a known
1949 variable and thus can probably assume it will never hit the C++
1953 lookup_symbol_in_language (const char *name, const struct block *block,
1954 const domain_enum domain, enum language lang,
1955 struct field_of_this_result *is_a_field_of_this)
1957 const char *modified_name;
1958 struct block_symbol returnval;
1959 struct cleanup *cleanup = demangle_for_lookup (name, lang, &modified_name);
1961 returnval = lookup_symbol_aux (modified_name, block, domain, lang,
1962 is_a_field_of_this);
1963 do_cleanups (cleanup);
1971 lookup_symbol (const char *name, const struct block *block,
1973 struct field_of_this_result *is_a_field_of_this)
1975 return lookup_symbol_in_language (name, block, domain,
1976 current_language->la_language,
1977 is_a_field_of_this);
1983 lookup_language_this (const struct language_defn *lang,
1984 const struct block *block)
1986 if (lang->la_name_of_this == NULL || block == NULL)
1987 return (struct block_symbol) {NULL, NULL};
1989 if (symbol_lookup_debug > 1)
1991 struct objfile *objfile = lookup_objfile_from_block (block);
1993 fprintf_unfiltered (gdb_stdlog,
1994 "lookup_language_this (%s, %s (objfile %s))",
1995 lang->la_name, host_address_to_string (block),
1996 objfile_debug_name (objfile));
2003 sym = block_lookup_symbol (block, lang->la_name_of_this, VAR_DOMAIN);
2006 if (symbol_lookup_debug > 1)
2008 fprintf_unfiltered (gdb_stdlog, " = %s (%s, block %s)\n",
2009 SYMBOL_PRINT_NAME (sym),
2010 host_address_to_string (sym),
2011 host_address_to_string (block));
2013 return (struct block_symbol) {sym, block};
2015 if (BLOCK_FUNCTION (block))
2017 block = BLOCK_SUPERBLOCK (block);
2020 if (symbol_lookup_debug > 1)
2021 fprintf_unfiltered (gdb_stdlog, " = NULL\n");
2022 return (struct block_symbol) {NULL, NULL};
2025 /* Given TYPE, a structure/union,
2026 return 1 if the component named NAME from the ultimate target
2027 structure/union is defined, otherwise, return 0. */
2030 check_field (struct type *type, const char *name,
2031 struct field_of_this_result *is_a_field_of_this)
2035 /* The type may be a stub. */
2036 type = check_typedef (type);
2038 for (i = TYPE_NFIELDS (type) - 1; i >= TYPE_N_BASECLASSES (type); i--)
2040 const char *t_field_name = TYPE_FIELD_NAME (type, i);
2042 if (t_field_name && (strcmp_iw (t_field_name, name) == 0))
2044 is_a_field_of_this->type = type;
2045 is_a_field_of_this->field = &TYPE_FIELD (type, i);
2050 /* C++: If it was not found as a data field, then try to return it
2051 as a pointer to a method. */
2053 for (i = TYPE_NFN_FIELDS (type) - 1; i >= 0; --i)
2055 if (strcmp_iw (TYPE_FN_FIELDLIST_NAME (type, i), name) == 0)
2057 is_a_field_of_this->type = type;
2058 is_a_field_of_this->fn_field = &TYPE_FN_FIELDLIST (type, i);
2063 for (i = TYPE_N_BASECLASSES (type) - 1; i >= 0; i--)
2064 if (check_field (TYPE_BASECLASS (type, i), name, is_a_field_of_this))
2070 /* Behave like lookup_symbol except that NAME is the natural name
2071 (e.g., demangled name) of the symbol that we're looking for. */
2073 static struct block_symbol
2074 lookup_symbol_aux (const char *name, const struct block *block,
2075 const domain_enum domain, enum language language,
2076 struct field_of_this_result *is_a_field_of_this)
2078 struct block_symbol result;
2079 const struct language_defn *langdef;
2081 if (symbol_lookup_debug)
2083 struct objfile *objfile = lookup_objfile_from_block (block);
2085 fprintf_unfiltered (gdb_stdlog,
2086 "lookup_symbol_aux (%s, %s (objfile %s), %s, %s)\n",
2087 name, host_address_to_string (block),
2089 ? objfile_debug_name (objfile) : "NULL",
2090 domain_name (domain), language_str (language));
2093 /* Make sure we do something sensible with is_a_field_of_this, since
2094 the callers that set this parameter to some non-null value will
2095 certainly use it later. If we don't set it, the contents of
2096 is_a_field_of_this are undefined. */
2097 if (is_a_field_of_this != NULL)
2098 memset (is_a_field_of_this, 0, sizeof (*is_a_field_of_this));
2100 /* Search specified block and its superiors. Don't search
2101 STATIC_BLOCK or GLOBAL_BLOCK. */
2103 result = lookup_local_symbol (name, block, domain, language);
2104 if (result.symbol != NULL)
2106 if (symbol_lookup_debug)
2108 fprintf_unfiltered (gdb_stdlog, "lookup_symbol_aux (...) = %s\n",
2109 host_address_to_string (result.symbol));
2114 /* If requested to do so by the caller and if appropriate for LANGUAGE,
2115 check to see if NAME is a field of `this'. */
2117 langdef = language_def (language);
2119 /* Don't do this check if we are searching for a struct. It will
2120 not be found by check_field, but will be found by other
2122 if (is_a_field_of_this != NULL && domain != STRUCT_DOMAIN)
2124 result = lookup_language_this (langdef, block);
2128 struct type *t = result.symbol->type;
2130 /* I'm not really sure that type of this can ever
2131 be typedefed; just be safe. */
2132 t = check_typedef (t);
2133 if (TYPE_CODE (t) == TYPE_CODE_PTR
2134 || TYPE_CODE (t) == TYPE_CODE_REF)
2135 t = TYPE_TARGET_TYPE (t);
2137 if (TYPE_CODE (t) != TYPE_CODE_STRUCT
2138 && TYPE_CODE (t) != TYPE_CODE_UNION)
2139 error (_("Internal error: `%s' is not an aggregate"),
2140 langdef->la_name_of_this);
2142 if (check_field (t, name, is_a_field_of_this))
2144 if (symbol_lookup_debug)
2146 fprintf_unfiltered (gdb_stdlog,
2147 "lookup_symbol_aux (...) = NULL\n");
2149 return (struct block_symbol) {NULL, NULL};
2154 /* Now do whatever is appropriate for LANGUAGE to look
2155 up static and global variables. */
2157 result = langdef->la_lookup_symbol_nonlocal (langdef, name, block, domain);
2158 if (result.symbol != NULL)
2160 if (symbol_lookup_debug)
2162 fprintf_unfiltered (gdb_stdlog, "lookup_symbol_aux (...) = %s\n",
2163 host_address_to_string (result.symbol));
2168 /* Now search all static file-level symbols. Not strictly correct,
2169 but more useful than an error. */
2171 result = lookup_static_symbol (name, domain);
2172 if (symbol_lookup_debug)
2174 fprintf_unfiltered (gdb_stdlog, "lookup_symbol_aux (...) = %s\n",
2175 result.symbol != NULL
2176 ? host_address_to_string (result.symbol)
2182 /* Check to see if the symbol is defined in BLOCK or its superiors.
2183 Don't search STATIC_BLOCK or GLOBAL_BLOCK. */
2185 static struct block_symbol
2186 lookup_local_symbol (const char *name, const struct block *block,
2187 const domain_enum domain,
2188 enum language language)
2191 const struct block *static_block = block_static_block (block);
2192 const char *scope = block_scope (block);
2194 /* Check if either no block is specified or it's a global block. */
2196 if (static_block == NULL)
2197 return (struct block_symbol) {NULL, NULL};
2199 while (block != static_block)
2201 sym = lookup_symbol_in_block (name, block, domain);
2203 return (struct block_symbol) {sym, block};
2205 if (language == language_cplus || language == language_fortran)
2207 struct block_symbol sym
2208 = cp_lookup_symbol_imports_or_template (scope, name, block,
2211 if (sym.symbol != NULL)
2215 if (BLOCK_FUNCTION (block) != NULL && block_inlined_p (block))
2217 block = BLOCK_SUPERBLOCK (block);
2220 /* We've reached the end of the function without finding a result. */
2222 return (struct block_symbol) {NULL, NULL};
2228 lookup_objfile_from_block (const struct block *block)
2230 struct objfile *obj;
2231 struct compunit_symtab *cust;
2236 block = block_global_block (block);
2237 /* Look through all blockvectors. */
2238 ALL_COMPUNITS (obj, cust)
2239 if (block == BLOCKVECTOR_BLOCK (COMPUNIT_BLOCKVECTOR (cust),
2242 if (obj->separate_debug_objfile_backlink)
2243 obj = obj->separate_debug_objfile_backlink;
2254 lookup_symbol_in_block (const char *name, const struct block *block,
2255 const domain_enum domain)
2259 if (symbol_lookup_debug > 1)
2261 struct objfile *objfile = lookup_objfile_from_block (block);
2263 fprintf_unfiltered (gdb_stdlog,
2264 "lookup_symbol_in_block (%s, %s (objfile %s), %s)",
2265 name, host_address_to_string (block),
2266 objfile_debug_name (objfile),
2267 domain_name (domain));
2270 sym = block_lookup_symbol (block, name, domain);
2273 if (symbol_lookup_debug > 1)
2275 fprintf_unfiltered (gdb_stdlog, " = %s\n",
2276 host_address_to_string (sym));
2278 return fixup_symbol_section (sym, NULL);
2281 if (symbol_lookup_debug > 1)
2282 fprintf_unfiltered (gdb_stdlog, " = NULL\n");
2289 lookup_global_symbol_from_objfile (struct objfile *main_objfile,
2291 const domain_enum domain)
2293 struct objfile *objfile;
2295 for (objfile = main_objfile;
2297 objfile = objfile_separate_debug_iterate (main_objfile, objfile))
2299 struct block_symbol result
2300 = lookup_symbol_in_objfile (objfile, GLOBAL_BLOCK, name, domain);
2302 if (result.symbol != NULL)
2306 return (struct block_symbol) {NULL, NULL};
2309 /* Check to see if the symbol is defined in one of the OBJFILE's
2310 symtabs. BLOCK_INDEX should be either GLOBAL_BLOCK or STATIC_BLOCK,
2311 depending on whether or not we want to search global symbols or
2314 static struct block_symbol
2315 lookup_symbol_in_objfile_symtabs (struct objfile *objfile, int block_index,
2316 const char *name, const domain_enum domain)
2318 struct compunit_symtab *cust;
2320 gdb_assert (block_index == GLOBAL_BLOCK || block_index == STATIC_BLOCK);
2322 if (symbol_lookup_debug > 1)
2324 fprintf_unfiltered (gdb_stdlog,
2325 "lookup_symbol_in_objfile_symtabs (%s, %s, %s, %s)",
2326 objfile_debug_name (objfile),
2327 block_index == GLOBAL_BLOCK
2328 ? "GLOBAL_BLOCK" : "STATIC_BLOCK",
2329 name, domain_name (domain));
2332 ALL_OBJFILE_COMPUNITS (objfile, cust)
2334 const struct blockvector *bv;
2335 const struct block *block;
2336 struct block_symbol result;
2338 bv = COMPUNIT_BLOCKVECTOR (cust);
2339 block = BLOCKVECTOR_BLOCK (bv, block_index);
2340 result.symbol = block_lookup_symbol_primary (block, name, domain);
2341 result.block = block;
2342 if (result.symbol != NULL)
2344 if (symbol_lookup_debug > 1)
2346 fprintf_unfiltered (gdb_stdlog, " = %s (block %s)\n",
2347 host_address_to_string (result.symbol),
2348 host_address_to_string (block));
2350 result.symbol = fixup_symbol_section (result.symbol, objfile);
2356 if (symbol_lookup_debug > 1)
2357 fprintf_unfiltered (gdb_stdlog, " = NULL\n");
2358 return (struct block_symbol) {NULL, NULL};
2361 /* Wrapper around lookup_symbol_in_objfile_symtabs for search_symbols.
2362 Look up LINKAGE_NAME in DOMAIN in the global and static blocks of OBJFILE
2363 and all associated separate debug objfiles.
2365 Normally we only look in OBJFILE, and not any separate debug objfiles
2366 because the outer loop will cause them to be searched too. This case is
2367 different. Here we're called from search_symbols where it will only
2368 call us for the the objfile that contains a matching minsym. */
2370 static struct block_symbol
2371 lookup_symbol_in_objfile_from_linkage_name (struct objfile *objfile,
2372 const char *linkage_name,
2375 enum language lang = current_language->la_language;
2376 const char *modified_name;
2377 struct cleanup *cleanup = demangle_for_lookup (linkage_name, lang,
2379 struct objfile *main_objfile, *cur_objfile;
2381 if (objfile->separate_debug_objfile_backlink)
2382 main_objfile = objfile->separate_debug_objfile_backlink;
2384 main_objfile = objfile;
2386 for (cur_objfile = main_objfile;
2388 cur_objfile = objfile_separate_debug_iterate (main_objfile, cur_objfile))
2390 struct block_symbol result;
2392 result = lookup_symbol_in_objfile_symtabs (cur_objfile, GLOBAL_BLOCK,
2393 modified_name, domain);
2394 if (result.symbol == NULL)
2395 result = lookup_symbol_in_objfile_symtabs (cur_objfile, STATIC_BLOCK,
2396 modified_name, domain);
2397 if (result.symbol != NULL)
2399 do_cleanups (cleanup);
2404 do_cleanups (cleanup);
2405 return (struct block_symbol) {NULL, NULL};
2408 /* A helper function that throws an exception when a symbol was found
2409 in a psymtab but not in a symtab. */
2411 static void ATTRIBUTE_NORETURN
2412 error_in_psymtab_expansion (int block_index, const char *name,
2413 struct compunit_symtab *cust)
2416 Internal: %s symbol `%s' found in %s psymtab but not in symtab.\n\
2417 %s may be an inlined function, or may be a template function\n \
2418 (if a template, try specifying an instantiation: %s<type>)."),
2419 block_index == GLOBAL_BLOCK ? "global" : "static",
2421 symtab_to_filename_for_display (compunit_primary_filetab (cust)),
2425 /* A helper function for various lookup routines that interfaces with
2426 the "quick" symbol table functions. */
2428 static struct block_symbol
2429 lookup_symbol_via_quick_fns (struct objfile *objfile, int block_index,
2430 const char *name, const domain_enum domain)
2432 struct compunit_symtab *cust;
2433 const struct blockvector *bv;
2434 const struct block *block;
2435 struct block_symbol result;
2438 return (struct block_symbol) {NULL, NULL};
2440 if (symbol_lookup_debug > 1)
2442 fprintf_unfiltered (gdb_stdlog,
2443 "lookup_symbol_via_quick_fns (%s, %s, %s, %s)\n",
2444 objfile_debug_name (objfile),
2445 block_index == GLOBAL_BLOCK
2446 ? "GLOBAL_BLOCK" : "STATIC_BLOCK",
2447 name, domain_name (domain));
2450 cust = objfile->sf->qf->lookup_symbol (objfile, block_index, name, domain);
2453 if (symbol_lookup_debug > 1)
2455 fprintf_unfiltered (gdb_stdlog,
2456 "lookup_symbol_via_quick_fns (...) = NULL\n");
2458 return (struct block_symbol) {NULL, NULL};
2461 bv = COMPUNIT_BLOCKVECTOR (cust);
2462 block = BLOCKVECTOR_BLOCK (bv, block_index);
2463 result.symbol = block_lookup_symbol (block, name, domain);
2464 if (result.symbol == NULL)
2465 error_in_psymtab_expansion (block_index, name, cust);
2467 if (symbol_lookup_debug > 1)
2469 fprintf_unfiltered (gdb_stdlog,
2470 "lookup_symbol_via_quick_fns (...) = %s (block %s)\n",
2471 host_address_to_string (result.symbol),
2472 host_address_to_string (block));
2475 result.symbol = fixup_symbol_section (result.symbol, objfile);
2476 result.block = block;
2483 basic_lookup_symbol_nonlocal (const struct language_defn *langdef,
2485 const struct block *block,
2486 const domain_enum domain)
2488 struct block_symbol result;
2490 /* NOTE: carlton/2003-05-19: The comments below were written when
2491 this (or what turned into this) was part of lookup_symbol_aux;
2492 I'm much less worried about these questions now, since these
2493 decisions have turned out well, but I leave these comments here
2496 /* NOTE: carlton/2002-12-05: There is a question as to whether or
2497 not it would be appropriate to search the current global block
2498 here as well. (That's what this code used to do before the
2499 is_a_field_of_this check was moved up.) On the one hand, it's
2500 redundant with the lookup in all objfiles search that happens
2501 next. On the other hand, if decode_line_1 is passed an argument
2502 like filename:var, then the user presumably wants 'var' to be
2503 searched for in filename. On the third hand, there shouldn't be
2504 multiple global variables all of which are named 'var', and it's
2505 not like decode_line_1 has ever restricted its search to only
2506 global variables in a single filename. All in all, only
2507 searching the static block here seems best: it's correct and it's
2510 /* NOTE: carlton/2002-12-05: There's also a possible performance
2511 issue here: if you usually search for global symbols in the
2512 current file, then it would be slightly better to search the
2513 current global block before searching all the symtabs. But there
2514 are other factors that have a much greater effect on performance
2515 than that one, so I don't think we should worry about that for
2518 /* NOTE: dje/2014-10-26: The lookup in all objfiles search could skip
2519 the current objfile. Searching the current objfile first is useful
2520 for both matching user expectations as well as performance. */
2522 result = lookup_symbol_in_static_block (name, block, domain);
2523 if (result.symbol != NULL)
2526 /* If we didn't find a definition for a builtin type in the static block,
2527 search for it now. This is actually the right thing to do and can be
2528 a massive performance win. E.g., when debugging a program with lots of
2529 shared libraries we could search all of them only to find out the
2530 builtin type isn't defined in any of them. This is common for types
2532 if (domain == VAR_DOMAIN)
2534 struct gdbarch *gdbarch;
2537 gdbarch = target_gdbarch ();
2539 gdbarch = block_gdbarch (block);
2540 result.symbol = language_lookup_primitive_type_as_symbol (langdef,
2542 result.block = NULL;
2543 if (result.symbol != NULL)
2547 return lookup_global_symbol (name, block, domain);
2553 lookup_symbol_in_static_block (const char *name,
2554 const struct block *block,
2555 const domain_enum domain)
2557 const struct block *static_block = block_static_block (block);
2560 if (static_block == NULL)
2561 return (struct block_symbol) {NULL, NULL};
2563 if (symbol_lookup_debug)
2565 struct objfile *objfile = lookup_objfile_from_block (static_block);
2567 fprintf_unfiltered (gdb_stdlog,
2568 "lookup_symbol_in_static_block (%s, %s (objfile %s),"
2571 host_address_to_string (block),
2572 objfile_debug_name (objfile),
2573 domain_name (domain));
2576 sym = lookup_symbol_in_block (name, static_block, domain);
2577 if (symbol_lookup_debug)
2579 fprintf_unfiltered (gdb_stdlog,
2580 "lookup_symbol_in_static_block (...) = %s\n",
2581 sym != NULL ? host_address_to_string (sym) : "NULL");
2583 return (struct block_symbol) {sym, static_block};
2586 /* Perform the standard symbol lookup of NAME in OBJFILE:
2587 1) First search expanded symtabs, and if not found
2588 2) Search the "quick" symtabs (partial or .gdb_index).
2589 BLOCK_INDEX is one of GLOBAL_BLOCK or STATIC_BLOCK. */
2591 static struct block_symbol
2592 lookup_symbol_in_objfile (struct objfile *objfile, int block_index,
2593 const char *name, const domain_enum domain)
2595 struct block_symbol result;
2597 if (symbol_lookup_debug)
2599 fprintf_unfiltered (gdb_stdlog,
2600 "lookup_symbol_in_objfile (%s, %s, %s, %s)\n",
2601 objfile_debug_name (objfile),
2602 block_index == GLOBAL_BLOCK
2603 ? "GLOBAL_BLOCK" : "STATIC_BLOCK",
2604 name, domain_name (domain));
2607 result = lookup_symbol_in_objfile_symtabs (objfile, block_index,
2609 if (result.symbol != NULL)
2611 if (symbol_lookup_debug)
2613 fprintf_unfiltered (gdb_stdlog,
2614 "lookup_symbol_in_objfile (...) = %s"
2616 host_address_to_string (result.symbol));
2621 result = lookup_symbol_via_quick_fns (objfile, block_index,
2623 if (symbol_lookup_debug)
2625 fprintf_unfiltered (gdb_stdlog,
2626 "lookup_symbol_in_objfile (...) = %s%s\n",
2627 result.symbol != NULL
2628 ? host_address_to_string (result.symbol)
2630 result.symbol != NULL ? " (via quick fns)" : "");
2638 lookup_static_symbol (const char *name, const domain_enum domain)
2640 struct symbol_cache *cache = get_symbol_cache (current_program_space);
2641 struct objfile *objfile;
2642 struct block_symbol result;
2643 struct block_symbol_cache *bsc;
2644 struct symbol_cache_slot *slot;
2646 /* Lookup in STATIC_BLOCK is not current-objfile-dependent, so just pass
2647 NULL for OBJFILE_CONTEXT. */
2648 result = symbol_cache_lookup (cache, NULL, STATIC_BLOCK, name, domain,
2650 if (result.symbol != NULL)
2652 if (SYMBOL_LOOKUP_FAILED_P (result))
2653 return (struct block_symbol) {NULL, NULL};
2657 ALL_OBJFILES (objfile)
2659 result = lookup_symbol_in_objfile (objfile, STATIC_BLOCK, name, domain);
2660 if (result.symbol != NULL)
2662 /* Still pass NULL for OBJFILE_CONTEXT here. */
2663 symbol_cache_mark_found (bsc, slot, NULL, result.symbol,
2669 /* Still pass NULL for OBJFILE_CONTEXT here. */
2670 symbol_cache_mark_not_found (bsc, slot, NULL, name, domain);
2671 return (struct block_symbol) {NULL, NULL};
2674 /* Private data to be used with lookup_symbol_global_iterator_cb. */
2676 struct global_sym_lookup_data
2678 /* The name of the symbol we are searching for. */
2681 /* The domain to use for our search. */
2684 /* The field where the callback should store the symbol if found.
2685 It should be initialized to {NULL, NULL} before the search is started. */
2686 struct block_symbol result;
2689 /* A callback function for gdbarch_iterate_over_objfiles_in_search_order.
2690 It searches by name for a symbol in the GLOBAL_BLOCK of the given
2691 OBJFILE. The arguments for the search are passed via CB_DATA,
2692 which in reality is a pointer to struct global_sym_lookup_data. */
2695 lookup_symbol_global_iterator_cb (struct objfile *objfile,
2698 struct global_sym_lookup_data *data =
2699 (struct global_sym_lookup_data *) cb_data;
2701 gdb_assert (data->result.symbol == NULL
2702 && data->result.block == NULL);
2704 data->result = lookup_symbol_in_objfile (objfile, GLOBAL_BLOCK,
2705 data->name, data->domain);
2707 /* If we found a match, tell the iterator to stop. Otherwise,
2709 return (data->result.symbol != NULL);
2715 lookup_global_symbol (const char *name,
2716 const struct block *block,
2717 const domain_enum domain)
2719 struct symbol_cache *cache = get_symbol_cache (current_program_space);
2720 struct block_symbol result;
2721 struct objfile *objfile;
2722 struct global_sym_lookup_data lookup_data;
2723 struct block_symbol_cache *bsc;
2724 struct symbol_cache_slot *slot;
2726 objfile = lookup_objfile_from_block (block);
2728 /* First see if we can find the symbol in the cache.
2729 This works because we use the current objfile to qualify the lookup. */
2730 result = symbol_cache_lookup (cache, objfile, GLOBAL_BLOCK, name, domain,
2732 if (result.symbol != NULL)
2734 if (SYMBOL_LOOKUP_FAILED_P (result))
2735 return (struct block_symbol) {NULL, NULL};
2739 /* Call library-specific lookup procedure. */
2740 if (objfile != NULL)
2741 result = solib_global_lookup (objfile, name, domain);
2743 /* If that didn't work go a global search (of global blocks, heh). */
2744 if (result.symbol == NULL)
2746 memset (&lookup_data, 0, sizeof (lookup_data));
2747 lookup_data.name = name;
2748 lookup_data.domain = domain;
2749 gdbarch_iterate_over_objfiles_in_search_order
2750 (objfile != NULL ? get_objfile_arch (objfile) : target_gdbarch (),
2751 lookup_symbol_global_iterator_cb, &lookup_data, objfile);
2752 result = lookup_data.result;
2755 if (result.symbol != NULL)
2756 symbol_cache_mark_found (bsc, slot, objfile, result.symbol, result.block);
2758 symbol_cache_mark_not_found (bsc, slot, objfile, name, domain);
2764 symbol_matches_domain (enum language symbol_language,
2765 domain_enum symbol_domain,
2768 /* For C++ "struct foo { ... }" also defines a typedef for "foo".
2769 A Java class declaration also defines a typedef for the class.
2770 Similarly, any Ada type declaration implicitly defines a typedef. */
2771 if (symbol_language == language_cplus
2772 || symbol_language == language_d
2773 || symbol_language == language_java
2774 || symbol_language == language_ada)
2776 if ((domain == VAR_DOMAIN || domain == STRUCT_DOMAIN)
2777 && symbol_domain == STRUCT_DOMAIN)
2780 /* For all other languages, strict match is required. */
2781 return (symbol_domain == domain);
2787 lookup_transparent_type (const char *name)
2789 return current_language->la_lookup_transparent_type (name);
2792 /* A helper for basic_lookup_transparent_type that interfaces with the
2793 "quick" symbol table functions. */
2795 static struct type *
2796 basic_lookup_transparent_type_quick (struct objfile *objfile, int block_index,
2799 struct compunit_symtab *cust;
2800 const struct blockvector *bv;
2801 struct block *block;
2806 cust = objfile->sf->qf->lookup_symbol (objfile, block_index, name,
2811 bv = COMPUNIT_BLOCKVECTOR (cust);
2812 block = BLOCKVECTOR_BLOCK (bv, block_index);
2813 sym = block_find_symbol (block, name, STRUCT_DOMAIN,
2814 block_find_non_opaque_type, NULL);
2816 error_in_psymtab_expansion (block_index, name, cust);
2817 gdb_assert (!TYPE_IS_OPAQUE (SYMBOL_TYPE (sym)));
2818 return SYMBOL_TYPE (sym);
2821 /* Subroutine of basic_lookup_transparent_type to simplify it.
2822 Look up the non-opaque definition of NAME in BLOCK_INDEX of OBJFILE.
2823 BLOCK_INDEX is either GLOBAL_BLOCK or STATIC_BLOCK. */
2825 static struct type *
2826 basic_lookup_transparent_type_1 (struct objfile *objfile, int block_index,
2829 const struct compunit_symtab *cust;
2830 const struct blockvector *bv;
2831 const struct block *block;
2832 const struct symbol *sym;
2834 ALL_OBJFILE_COMPUNITS (objfile, cust)
2836 bv = COMPUNIT_BLOCKVECTOR (cust);
2837 block = BLOCKVECTOR_BLOCK (bv, block_index);
2838 sym = block_find_symbol (block, name, STRUCT_DOMAIN,
2839 block_find_non_opaque_type, NULL);
2842 gdb_assert (!TYPE_IS_OPAQUE (SYMBOL_TYPE (sym)));
2843 return SYMBOL_TYPE (sym);
2850 /* The standard implementation of lookup_transparent_type. This code
2851 was modeled on lookup_symbol -- the parts not relevant to looking
2852 up types were just left out. In particular it's assumed here that
2853 types are available in STRUCT_DOMAIN and only in file-static or
2857 basic_lookup_transparent_type (const char *name)
2860 struct compunit_symtab *cust;
2861 const struct blockvector *bv;
2862 struct objfile *objfile;
2863 struct block *block;
2866 /* Now search all the global symbols. Do the symtab's first, then
2867 check the psymtab's. If a psymtab indicates the existence
2868 of the desired name as a global, then do psymtab-to-symtab
2869 conversion on the fly and return the found symbol. */
2871 ALL_OBJFILES (objfile)
2873 t = basic_lookup_transparent_type_1 (objfile, GLOBAL_BLOCK, name);
2878 ALL_OBJFILES (objfile)
2880 t = basic_lookup_transparent_type_quick (objfile, GLOBAL_BLOCK, name);
2885 /* Now search the static file-level symbols.
2886 Not strictly correct, but more useful than an error.
2887 Do the symtab's first, then
2888 check the psymtab's. If a psymtab indicates the existence
2889 of the desired name as a file-level static, then do psymtab-to-symtab
2890 conversion on the fly and return the found symbol. */
2892 ALL_OBJFILES (objfile)
2894 t = basic_lookup_transparent_type_1 (objfile, STATIC_BLOCK, name);
2899 ALL_OBJFILES (objfile)
2901 t = basic_lookup_transparent_type_quick (objfile, STATIC_BLOCK, name);
2906 return (struct type *) 0;
2909 /* Iterate over the symbols named NAME, matching DOMAIN, in BLOCK.
2911 For each symbol that matches, CALLBACK is called. The symbol and
2912 DATA are passed to the callback.
2914 If CALLBACK returns zero, the iteration ends. Otherwise, the
2915 search continues. */
2918 iterate_over_symbols (const struct block *block, const char *name,
2919 const domain_enum domain,
2920 symbol_found_callback_ftype *callback,
2923 struct block_iterator iter;
2926 ALL_BLOCK_SYMBOLS_WITH_NAME (block, name, iter, sym)
2928 if (symbol_matches_domain (SYMBOL_LANGUAGE (sym),
2929 SYMBOL_DOMAIN (sym), domain))
2931 if (!callback (sym, data))
2937 /* Find the compunit symtab associated with PC and SECTION.
2938 This will read in debug info as necessary. */
2940 struct compunit_symtab *
2941 find_pc_sect_compunit_symtab (CORE_ADDR pc, struct obj_section *section)
2943 struct compunit_symtab *cust;
2944 struct compunit_symtab *best_cust = NULL;
2945 struct objfile *objfile;
2946 CORE_ADDR distance = 0;
2947 struct bound_minimal_symbol msymbol;
2949 /* If we know that this is not a text address, return failure. This is
2950 necessary because we loop based on the block's high and low code
2951 addresses, which do not include the data ranges, and because
2952 we call find_pc_sect_psymtab which has a similar restriction based
2953 on the partial_symtab's texthigh and textlow. */
2954 msymbol = lookup_minimal_symbol_by_pc_section (pc, section);
2956 && (MSYMBOL_TYPE (msymbol.minsym) == mst_data
2957 || MSYMBOL_TYPE (msymbol.minsym) == mst_bss
2958 || MSYMBOL_TYPE (msymbol.minsym) == mst_abs
2959 || MSYMBOL_TYPE (msymbol.minsym) == mst_file_data
2960 || MSYMBOL_TYPE (msymbol.minsym) == mst_file_bss))
2963 /* Search all symtabs for the one whose file contains our address, and which
2964 is the smallest of all the ones containing the address. This is designed
2965 to deal with a case like symtab a is at 0x1000-0x2000 and 0x3000-0x4000
2966 and symtab b is at 0x2000-0x3000. So the GLOBAL_BLOCK for a is from
2967 0x1000-0x4000, but for address 0x2345 we want to return symtab b.
2969 This happens for native ecoff format, where code from included files
2970 gets its own symtab. The symtab for the included file should have
2971 been read in already via the dependency mechanism.
2972 It might be swifter to create several symtabs with the same name
2973 like xcoff does (I'm not sure).
2975 It also happens for objfiles that have their functions reordered.
2976 For these, the symtab we are looking for is not necessarily read in. */
2978 ALL_COMPUNITS (objfile, cust)
2981 const struct blockvector *bv;
2983 bv = COMPUNIT_BLOCKVECTOR (cust);
2984 b = BLOCKVECTOR_BLOCK (bv, GLOBAL_BLOCK);
2986 if (BLOCK_START (b) <= pc
2987 && BLOCK_END (b) > pc
2989 || BLOCK_END (b) - BLOCK_START (b) < distance))
2991 /* For an objfile that has its functions reordered,
2992 find_pc_psymtab will find the proper partial symbol table
2993 and we simply return its corresponding symtab. */
2994 /* In order to better support objfiles that contain both
2995 stabs and coff debugging info, we continue on if a psymtab
2997 if ((objfile->flags & OBJF_REORDERED) && objfile->sf)
2999 struct compunit_symtab *result;
3002 = objfile->sf->qf->find_pc_sect_compunit_symtab (objfile,
3011 struct block_iterator iter;
3012 struct symbol *sym = NULL;
3014 ALL_BLOCK_SYMBOLS (b, iter, sym)
3016 fixup_symbol_section (sym, objfile);
3017 if (matching_obj_sections (SYMBOL_OBJ_SECTION (objfile, sym),
3022 continue; /* No symbol in this symtab matches
3025 distance = BLOCK_END (b) - BLOCK_START (b);
3030 if (best_cust != NULL)
3033 /* Not found in symtabs, search the "quick" symtabs (e.g. psymtabs). */
3035 ALL_OBJFILES (objfile)
3037 struct compunit_symtab *result;
3041 result = objfile->sf->qf->find_pc_sect_compunit_symtab (objfile,
3052 /* Find the compunit symtab associated with PC.
3053 This will read in debug info as necessary.
3054 Backward compatibility, no section. */
3056 struct compunit_symtab *
3057 find_pc_compunit_symtab (CORE_ADDR pc)
3059 return find_pc_sect_compunit_symtab (pc, find_pc_mapped_section (pc));
3063 /* Find the source file and line number for a given PC value and SECTION.
3064 Return a structure containing a symtab pointer, a line number,
3065 and a pc range for the entire source line.
3066 The value's .pc field is NOT the specified pc.
3067 NOTCURRENT nonzero means, if specified pc is on a line boundary,
3068 use the line that ends there. Otherwise, in that case, the line
3069 that begins there is used. */
3071 /* The big complication here is that a line may start in one file, and end just
3072 before the start of another file. This usually occurs when you #include
3073 code in the middle of a subroutine. To properly find the end of a line's PC
3074 range, we must search all symtabs associated with this compilation unit, and
3075 find the one whose first PC is closer than that of the next line in this
3078 /* If it's worth the effort, we could be using a binary search. */
3080 struct symtab_and_line
3081 find_pc_sect_line (CORE_ADDR pc, struct obj_section *section, int notcurrent)
3083 struct compunit_symtab *cust;
3084 struct symtab *iter_s;
3085 struct linetable *l;
3088 struct linetable_entry *item;
3089 struct symtab_and_line val;
3090 const struct blockvector *bv;
3091 struct bound_minimal_symbol msymbol;
3093 /* Info on best line seen so far, and where it starts, and its file. */
3095 struct linetable_entry *best = NULL;
3096 CORE_ADDR best_end = 0;
3097 struct symtab *best_symtab = 0;
3099 /* Store here the first line number
3100 of a file which contains the line at the smallest pc after PC.
3101 If we don't find a line whose range contains PC,
3102 we will use a line one less than this,
3103 with a range from the start of that file to the first line's pc. */
3104 struct linetable_entry *alt = NULL;
3106 /* Info on best line seen in this file. */
3108 struct linetable_entry *prev;
3110 /* If this pc is not from the current frame,
3111 it is the address of the end of a call instruction.
3112 Quite likely that is the start of the following statement.
3113 But what we want is the statement containing the instruction.
3114 Fudge the pc to make sure we get that. */
3116 init_sal (&val); /* initialize to zeroes */
3118 val.pspace = current_program_space;
3120 /* It's tempting to assume that, if we can't find debugging info for
3121 any function enclosing PC, that we shouldn't search for line
3122 number info, either. However, GAS can emit line number info for
3123 assembly files --- very helpful when debugging hand-written
3124 assembly code. In such a case, we'd have no debug info for the
3125 function, but we would have line info. */
3130 /* elz: added this because this function returned the wrong
3131 information if the pc belongs to a stub (import/export)
3132 to call a shlib function. This stub would be anywhere between
3133 two functions in the target, and the line info was erroneously
3134 taken to be the one of the line before the pc. */
3136 /* RT: Further explanation:
3138 * We have stubs (trampolines) inserted between procedures.
3140 * Example: "shr1" exists in a shared library, and a "shr1" stub also
3141 * exists in the main image.
3143 * In the minimal symbol table, we have a bunch of symbols
3144 * sorted by start address. The stubs are marked as "trampoline",
3145 * the others appear as text. E.g.:
3147 * Minimal symbol table for main image
3148 * main: code for main (text symbol)
3149 * shr1: stub (trampoline symbol)
3150 * foo: code for foo (text symbol)
3152 * Minimal symbol table for "shr1" image:
3154 * shr1: code for shr1 (text symbol)
3157 * So the code below is trying to detect if we are in the stub
3158 * ("shr1" stub), and if so, find the real code ("shr1" trampoline),
3159 * and if found, do the symbolization from the real-code address
3160 * rather than the stub address.
3162 * Assumptions being made about the minimal symbol table:
3163 * 1. lookup_minimal_symbol_by_pc() will return a trampoline only
3164 * if we're really in the trampoline.s If we're beyond it (say
3165 * we're in "foo" in the above example), it'll have a closer
3166 * symbol (the "foo" text symbol for example) and will not
3167 * return the trampoline.
3168 * 2. lookup_minimal_symbol_text() will find a real text symbol
3169 * corresponding to the trampoline, and whose address will
3170 * be different than the trampoline address. I put in a sanity
3171 * check for the address being the same, to avoid an
3172 * infinite recursion.
3174 msymbol = lookup_minimal_symbol_by_pc (pc);
3175 if (msymbol.minsym != NULL)
3176 if (MSYMBOL_TYPE (msymbol.minsym) == mst_solib_trampoline)
3178 struct bound_minimal_symbol mfunsym
3179 = lookup_minimal_symbol_text (MSYMBOL_LINKAGE_NAME (msymbol.minsym),
3182 if (mfunsym.minsym == NULL)
3183 /* I eliminated this warning since it is coming out
3184 * in the following situation:
3185 * gdb shmain // test program with shared libraries
3186 * (gdb) break shr1 // function in shared lib
3187 * Warning: In stub for ...
3188 * In the above situation, the shared lib is not loaded yet,
3189 * so of course we can't find the real func/line info,
3190 * but the "break" still works, and the warning is annoying.
3191 * So I commented out the warning. RT */
3192 /* warning ("In stub for %s; unable to find real function/line info",
3193 SYMBOL_LINKAGE_NAME (msymbol)); */
3196 else if (BMSYMBOL_VALUE_ADDRESS (mfunsym)
3197 == BMSYMBOL_VALUE_ADDRESS (msymbol))
3198 /* Avoid infinite recursion */
3199 /* See above comment about why warning is commented out. */
3200 /* warning ("In stub for %s; unable to find real function/line info",
3201 SYMBOL_LINKAGE_NAME (msymbol)); */
3205 return find_pc_line (BMSYMBOL_VALUE_ADDRESS (mfunsym), 0);
3209 cust = find_pc_sect_compunit_symtab (pc, section);
3212 /* If no symbol information, return previous pc. */
3219 bv = COMPUNIT_BLOCKVECTOR (cust);
3221 /* Look at all the symtabs that share this blockvector.
3222 They all have the same apriori range, that we found was right;
3223 but they have different line tables. */
3225 ALL_COMPUNIT_FILETABS (cust, iter_s)
3227 /* Find the best line in this symtab. */
3228 l = SYMTAB_LINETABLE (iter_s);
3234 /* I think len can be zero if the symtab lacks line numbers
3235 (e.g. gcc -g1). (Either that or the LINETABLE is NULL;
3236 I'm not sure which, and maybe it depends on the symbol
3242 item = l->item; /* Get first line info. */
3244 /* Is this file's first line closer than the first lines of other files?
3245 If so, record this file, and its first line, as best alternate. */
3246 if (item->pc > pc && (!alt || item->pc < alt->pc))
3249 for (i = 0; i < len; i++, item++)
3251 /* Leave prev pointing to the linetable entry for the last line
3252 that started at or before PC. */
3259 /* At this point, prev points at the line whose start addr is <= pc, and
3260 item points at the next line. If we ran off the end of the linetable
3261 (pc >= start of the last line), then prev == item. If pc < start of
3262 the first line, prev will not be set. */
3264 /* Is this file's best line closer than the best in the other files?
3265 If so, record this file, and its best line, as best so far. Don't
3266 save prev if it represents the end of a function (i.e. line number
3267 0) instead of a real line. */
3269 if (prev && prev->line && (!best || prev->pc > best->pc))
3272 best_symtab = iter_s;
3274 /* Discard BEST_END if it's before the PC of the current BEST. */
3275 if (best_end <= best->pc)
3279 /* If another line (denoted by ITEM) is in the linetable and its
3280 PC is after BEST's PC, but before the current BEST_END, then
3281 use ITEM's PC as the new best_end. */
3282 if (best && i < len && item->pc > best->pc
3283 && (best_end == 0 || best_end > item->pc))
3284 best_end = item->pc;
3289 /* If we didn't find any line number info, just return zeros.
3290 We used to return alt->line - 1 here, but that could be
3291 anywhere; if we don't have line number info for this PC,
3292 don't make some up. */
3295 else if (best->line == 0)
3297 /* If our best fit is in a range of PC's for which no line
3298 number info is available (line number is zero) then we didn't
3299 find any valid line information. */
3304 val.symtab = best_symtab;
3305 val.line = best->line;
3307 if (best_end && (!alt || best_end < alt->pc))
3312 val.end = BLOCK_END (BLOCKVECTOR_BLOCK (bv, GLOBAL_BLOCK));
3314 val.section = section;
3318 /* Backward compatibility (no section). */
3320 struct symtab_and_line
3321 find_pc_line (CORE_ADDR pc, int notcurrent)
3323 struct obj_section *section;
3325 section = find_pc_overlay (pc);
3326 if (pc_in_unmapped_range (pc, section))
3327 pc = overlay_mapped_address (pc, section);
3328 return find_pc_sect_line (pc, section, notcurrent);
3334 find_pc_line_symtab (CORE_ADDR pc)
3336 struct symtab_and_line sal;
3338 /* This always passes zero for NOTCURRENT to find_pc_line.
3339 There are currently no callers that ever pass non-zero. */
3340 sal = find_pc_line (pc, 0);
3344 /* Find line number LINE in any symtab whose name is the same as
3347 If found, return the symtab that contains the linetable in which it was
3348 found, set *INDEX to the index in the linetable of the best entry
3349 found, and set *EXACT_MATCH nonzero if the value returned is an
3352 If not found, return NULL. */
3355 find_line_symtab (struct symtab *symtab, int line,
3356 int *index, int *exact_match)
3358 int exact = 0; /* Initialized here to avoid a compiler warning. */
3360 /* BEST_INDEX and BEST_LINETABLE identify the smallest linenumber > LINE
3364 struct linetable *best_linetable;
3365 struct symtab *best_symtab;
3367 /* First try looking it up in the given symtab. */
3368 best_linetable = SYMTAB_LINETABLE (symtab);
3369 best_symtab = symtab;
3370 best_index = find_line_common (best_linetable, line, &exact, 0);
3371 if (best_index < 0 || !exact)
3373 /* Didn't find an exact match. So we better keep looking for
3374 another symtab with the same name. In the case of xcoff,
3375 multiple csects for one source file (produced by IBM's FORTRAN
3376 compiler) produce multiple symtabs (this is unavoidable
3377 assuming csects can be at arbitrary places in memory and that
3378 the GLOBAL_BLOCK of a symtab has a begin and end address). */
3380 /* BEST is the smallest linenumber > LINE so far seen,
3381 or 0 if none has been seen so far.
3382 BEST_INDEX and BEST_LINETABLE identify the item for it. */
3385 struct objfile *objfile;
3386 struct compunit_symtab *cu;
3389 if (best_index >= 0)
3390 best = best_linetable->item[best_index].line;
3394 ALL_OBJFILES (objfile)
3397 objfile->sf->qf->expand_symtabs_with_fullname (objfile,
3398 symtab_to_fullname (symtab));
3401 ALL_FILETABS (objfile, cu, s)
3403 struct linetable *l;
3406 if (FILENAME_CMP (symtab->filename, s->filename) != 0)
3408 if (FILENAME_CMP (symtab_to_fullname (symtab),
3409 symtab_to_fullname (s)) != 0)
3411 l = SYMTAB_LINETABLE (s);
3412 ind = find_line_common (l, line, &exact, 0);
3422 if (best == 0 || l->item[ind].line < best)
3424 best = l->item[ind].line;
3437 *index = best_index;
3439 *exact_match = exact;
3444 /* Given SYMTAB, returns all the PCs function in the symtab that
3445 exactly match LINE. Returns NULL if there are no exact matches,
3446 but updates BEST_ITEM in this case. */
3449 find_pcs_for_symtab_line (struct symtab *symtab, int line,
3450 struct linetable_entry **best_item)
3453 VEC (CORE_ADDR) *result = NULL;
3455 /* First, collect all the PCs that are at this line. */
3461 idx = find_line_common (SYMTAB_LINETABLE (symtab), line, &was_exact,
3468 struct linetable_entry *item = &SYMTAB_LINETABLE (symtab)->item[idx];
3470 if (*best_item == NULL || item->line < (*best_item)->line)
3476 VEC_safe_push (CORE_ADDR, result,
3477 SYMTAB_LINETABLE (symtab)->item[idx].pc);
3485 /* Set the PC value for a given source file and line number and return true.
3486 Returns zero for invalid line number (and sets the PC to 0).
3487 The source file is specified with a struct symtab. */
3490 find_line_pc (struct symtab *symtab, int line, CORE_ADDR *pc)
3492 struct linetable *l;
3499 symtab = find_line_symtab (symtab, line, &ind, NULL);
3502 l = SYMTAB_LINETABLE (symtab);
3503 *pc = l->item[ind].pc;
3510 /* Find the range of pc values in a line.
3511 Store the starting pc of the line into *STARTPTR
3512 and the ending pc (start of next line) into *ENDPTR.
3513 Returns 1 to indicate success.
3514 Returns 0 if could not find the specified line. */
3517 find_line_pc_range (struct symtab_and_line sal, CORE_ADDR *startptr,
3520 CORE_ADDR startaddr;
3521 struct symtab_and_line found_sal;
3524 if (startaddr == 0 && !find_line_pc (sal.symtab, sal.line, &startaddr))
3527 /* This whole function is based on address. For example, if line 10 has
3528 two parts, one from 0x100 to 0x200 and one from 0x300 to 0x400, then
3529 "info line *0x123" should say the line goes from 0x100 to 0x200
3530 and "info line *0x355" should say the line goes from 0x300 to 0x400.
3531 This also insures that we never give a range like "starts at 0x134
3532 and ends at 0x12c". */
3534 found_sal = find_pc_sect_line (startaddr, sal.section, 0);
3535 if (found_sal.line != sal.line)
3537 /* The specified line (sal) has zero bytes. */
3538 *startptr = found_sal.pc;
3539 *endptr = found_sal.pc;
3543 *startptr = found_sal.pc;
3544 *endptr = found_sal.end;
3549 /* Given a line table and a line number, return the index into the line
3550 table for the pc of the nearest line whose number is >= the specified one.
3551 Return -1 if none is found. The value is >= 0 if it is an index.
3552 START is the index at which to start searching the line table.
3554 Set *EXACT_MATCH nonzero if the value returned is an exact match. */
3557 find_line_common (struct linetable *l, int lineno,
3558 int *exact_match, int start)
3563 /* BEST is the smallest linenumber > LINENO so far seen,
3564 or 0 if none has been seen so far.
3565 BEST_INDEX identifies the item for it. */
3567 int best_index = -1;
3578 for (i = start; i < len; i++)
3580 struct linetable_entry *item = &(l->item[i]);
3582 if (item->line == lineno)
3584 /* Return the first (lowest address) entry which matches. */
3589 if (item->line > lineno && (best == 0 || item->line < best))
3596 /* If we got here, we didn't get an exact match. */
3601 find_pc_line_pc_range (CORE_ADDR pc, CORE_ADDR *startptr, CORE_ADDR *endptr)
3603 struct symtab_and_line sal;
3605 sal = find_pc_line (pc, 0);
3608 return sal.symtab != 0;
3611 /* Given a function symbol SYM, find the symtab and line for the start
3613 If the argument FUNFIRSTLINE is nonzero, we want the first line
3614 of real code inside the function.
3615 This function should return SALs matching those from minsym_found,
3616 otherwise false multiple-locations breakpoints could be placed. */
3618 struct symtab_and_line
3619 find_function_start_sal (struct symbol *sym, int funfirstline)
3621 struct symtab_and_line sal;
3622 struct obj_section *section;
3624 fixup_symbol_section (sym, NULL);
3625 section = SYMBOL_OBJ_SECTION (symbol_objfile (sym), sym);
3626 sal = find_pc_sect_line (BLOCK_START (SYMBOL_BLOCK_VALUE (sym)), section, 0);
3628 if (funfirstline && sal.symtab != NULL
3629 && (COMPUNIT_LOCATIONS_VALID (SYMTAB_COMPUNIT (sal.symtab))
3630 || SYMTAB_LANGUAGE (sal.symtab) == language_asm))
3632 struct gdbarch *gdbarch = symbol_arch (sym);
3634 sal.pc = BLOCK_START (SYMBOL_BLOCK_VALUE (sym));
3635 if (gdbarch_skip_entrypoint_p (gdbarch))
3636 sal.pc = gdbarch_skip_entrypoint (gdbarch, sal.pc);
3640 /* We always should have a line for the function start address.
3641 If we don't, something is odd. Create a plain SAL refering
3642 just the PC and hope that skip_prologue_sal (if requested)
3643 can find a line number for after the prologue. */
3644 if (sal.pc < BLOCK_START (SYMBOL_BLOCK_VALUE (sym)))
3647 sal.pspace = current_program_space;
3648 sal.pc = BLOCK_START (SYMBOL_BLOCK_VALUE (sym));
3649 sal.section = section;
3653 skip_prologue_sal (&sal);
3658 /* Given a function start address FUNC_ADDR and SYMTAB, find the first
3659 address for that function that has an entry in SYMTAB's line info
3660 table. If such an entry cannot be found, return FUNC_ADDR
3664 skip_prologue_using_lineinfo (CORE_ADDR func_addr, struct symtab *symtab)
3666 CORE_ADDR func_start, func_end;
3667 struct linetable *l;
3670 /* Give up if this symbol has no lineinfo table. */
3671 l = SYMTAB_LINETABLE (symtab);
3675 /* Get the range for the function's PC values, or give up if we
3676 cannot, for some reason. */
3677 if (!find_pc_partial_function (func_addr, NULL, &func_start, &func_end))
3680 /* Linetable entries are ordered by PC values, see the commentary in
3681 symtab.h where `struct linetable' is defined. Thus, the first
3682 entry whose PC is in the range [FUNC_START..FUNC_END[ is the
3683 address we are looking for. */
3684 for (i = 0; i < l->nitems; i++)
3686 struct linetable_entry *item = &(l->item[i]);
3688 /* Don't use line numbers of zero, they mark special entries in
3689 the table. See the commentary on symtab.h before the
3690 definition of struct linetable. */
3691 if (item->line > 0 && func_start <= item->pc && item->pc < func_end)
3698 /* Adjust SAL to the first instruction past the function prologue.
3699 If the PC was explicitly specified, the SAL is not changed.
3700 If the line number was explicitly specified, at most the SAL's PC
3701 is updated. If SAL is already past the prologue, then do nothing. */
3704 skip_prologue_sal (struct symtab_and_line *sal)
3707 struct symtab_and_line start_sal;
3708 struct cleanup *old_chain;
3709 CORE_ADDR pc, saved_pc;
3710 struct obj_section *section;
3712 struct objfile *objfile;
3713 struct gdbarch *gdbarch;
3714 const struct block *b, *function_block;
3715 int force_skip, skip;
3717 /* Do not change the SAL if PC was specified explicitly. */
3718 if (sal->explicit_pc)
3721 old_chain = save_current_space_and_thread ();
3722 switch_to_program_space_and_thread (sal->pspace);
3724 sym = find_pc_sect_function (sal->pc, sal->section);
3727 fixup_symbol_section (sym, NULL);
3729 objfile = symbol_objfile (sym);
3730 pc = BLOCK_START (SYMBOL_BLOCK_VALUE (sym));
3731 section = SYMBOL_OBJ_SECTION (objfile, sym);
3732 name = SYMBOL_LINKAGE_NAME (sym);
3736 struct bound_minimal_symbol msymbol
3737 = lookup_minimal_symbol_by_pc_section (sal->pc, sal->section);
3739 if (msymbol.minsym == NULL)
3741 do_cleanups (old_chain);
3745 objfile = msymbol.objfile;
3746 pc = BMSYMBOL_VALUE_ADDRESS (msymbol);
3747 section = MSYMBOL_OBJ_SECTION (objfile, msymbol.minsym);
3748 name = MSYMBOL_LINKAGE_NAME (msymbol.minsym);
3751 gdbarch = get_objfile_arch (objfile);
3753 /* Process the prologue in two passes. In the first pass try to skip the
3754 prologue (SKIP is true) and verify there is a real need for it (indicated
3755 by FORCE_SKIP). If no such reason was found run a second pass where the
3756 prologue is not skipped (SKIP is false). */
3761 /* Be conservative - allow direct PC (without skipping prologue) only if we
3762 have proven the CU (Compilation Unit) supports it. sal->SYMTAB does not
3763 have to be set by the caller so we use SYM instead. */
3765 && COMPUNIT_LOCATIONS_VALID (SYMTAB_COMPUNIT (symbol_symtab (sym))))
3773 /* If the function is in an unmapped overlay, use its unmapped LMA address,
3774 so that gdbarch_skip_prologue has something unique to work on. */
3775 if (section_is_overlay (section) && !section_is_mapped (section))
3776 pc = overlay_unmapped_address (pc, section);
3778 /* Skip "first line" of function (which is actually its prologue). */
3779 pc += gdbarch_deprecated_function_start_offset (gdbarch);
3780 if (gdbarch_skip_entrypoint_p (gdbarch))
3781 pc = gdbarch_skip_entrypoint (gdbarch, pc);
3783 pc = gdbarch_skip_prologue (gdbarch, pc);
3785 /* For overlays, map pc back into its mapped VMA range. */
3786 pc = overlay_mapped_address (pc, section);
3788 /* Calculate line number. */
3789 start_sal = find_pc_sect_line (pc, section, 0);
3791 /* Check if gdbarch_skip_prologue left us in mid-line, and the next
3792 line is still part of the same function. */
3793 if (skip && start_sal.pc != pc
3794 && (sym ? (BLOCK_START (SYMBOL_BLOCK_VALUE (sym)) <= start_sal.end
3795 && start_sal.end < BLOCK_END (SYMBOL_BLOCK_VALUE (sym)))
3796 : (lookup_minimal_symbol_by_pc_section (start_sal.end, section).minsym
3797 == lookup_minimal_symbol_by_pc_section (pc, section).minsym)))
3799 /* First pc of next line */
3801 /* Recalculate the line number (might not be N+1). */
3802 start_sal = find_pc_sect_line (pc, section, 0);
3805 /* On targets with executable formats that don't have a concept of
3806 constructors (ELF with .init has, PE doesn't), gcc emits a call
3807 to `__main' in `main' between the prologue and before user
3809 if (gdbarch_skip_main_prologue_p (gdbarch)
3810 && name && strcmp_iw (name, "main") == 0)
3812 pc = gdbarch_skip_main_prologue (gdbarch, pc);
3813 /* Recalculate the line number (might not be N+1). */
3814 start_sal = find_pc_sect_line (pc, section, 0);
3818 while (!force_skip && skip--);
3820 /* If we still don't have a valid source line, try to find the first
3821 PC in the lineinfo table that belongs to the same function. This
3822 happens with COFF debug info, which does not seem to have an
3823 entry in lineinfo table for the code after the prologue which has
3824 no direct relation to source. For example, this was found to be
3825 the case with the DJGPP target using "gcc -gcoff" when the
3826 compiler inserted code after the prologue to make sure the stack
3828 if (!force_skip && sym && start_sal.symtab == NULL)
3830 pc = skip_prologue_using_lineinfo (pc, symbol_symtab (sym));
3831 /* Recalculate the line number. */
3832 start_sal = find_pc_sect_line (pc, section, 0);
3835 do_cleanups (old_chain);
3837 /* If we're already past the prologue, leave SAL unchanged. Otherwise
3838 forward SAL to the end of the prologue. */
3843 sal->section = section;
3845 /* Unless the explicit_line flag was set, update the SAL line
3846 and symtab to correspond to the modified PC location. */
3847 if (sal->explicit_line)
3850 sal->symtab = start_sal.symtab;
3851 sal->line = start_sal.line;
3852 sal->end = start_sal.end;
3854 /* Check if we are now inside an inlined function. If we can,
3855 use the call site of the function instead. */
3856 b = block_for_pc_sect (sal->pc, sal->section);
3857 function_block = NULL;
3860 if (BLOCK_FUNCTION (b) != NULL && block_inlined_p (b))
3862 else if (BLOCK_FUNCTION (b) != NULL)
3864 b = BLOCK_SUPERBLOCK (b);
3866 if (function_block != NULL
3867 && SYMBOL_LINE (BLOCK_FUNCTION (function_block)) != 0)
3869 sal->line = SYMBOL_LINE (BLOCK_FUNCTION (function_block));
3870 sal->symtab = symbol_symtab (BLOCK_FUNCTION (function_block));
3874 /* Given PC at the function's start address, attempt to find the
3875 prologue end using SAL information. Return zero if the skip fails.
3877 A non-optimized prologue traditionally has one SAL for the function
3878 and a second for the function body. A single line function has
3879 them both pointing at the same line.
3881 An optimized prologue is similar but the prologue may contain
3882 instructions (SALs) from the instruction body. Need to skip those
3883 while not getting into the function body.
3885 The functions end point and an increasing SAL line are used as
3886 indicators of the prologue's endpoint.
3888 This code is based on the function refine_prologue_limit
3892 skip_prologue_using_sal (struct gdbarch *gdbarch, CORE_ADDR func_addr)
3894 struct symtab_and_line prologue_sal;
3897 const struct block *bl;
3899 /* Get an initial range for the function. */
3900 find_pc_partial_function (func_addr, NULL, &start_pc, &end_pc);
3901 start_pc += gdbarch_deprecated_function_start_offset (gdbarch);
3903 prologue_sal = find_pc_line (start_pc, 0);
3904 if (prologue_sal.line != 0)
3906 /* For languages other than assembly, treat two consecutive line
3907 entries at the same address as a zero-instruction prologue.
3908 The GNU assembler emits separate line notes for each instruction
3909 in a multi-instruction macro, but compilers generally will not
3911 if (prologue_sal.symtab->language != language_asm)
3913 struct linetable *linetable = SYMTAB_LINETABLE (prologue_sal.symtab);
3916 /* Skip any earlier lines, and any end-of-sequence marker
3917 from a previous function. */
3918 while (linetable->item[idx].pc != prologue_sal.pc
3919 || linetable->item[idx].line == 0)
3922 if (idx+1 < linetable->nitems
3923 && linetable->item[idx+1].line != 0
3924 && linetable->item[idx+1].pc == start_pc)
3928 /* If there is only one sal that covers the entire function,
3929 then it is probably a single line function, like
3931 if (prologue_sal.end >= end_pc)
3934 while (prologue_sal.end < end_pc)
3936 struct symtab_and_line sal;
3938 sal = find_pc_line (prologue_sal.end, 0);
3941 /* Assume that a consecutive SAL for the same (or larger)
3942 line mark the prologue -> body transition. */
3943 if (sal.line >= prologue_sal.line)
3945 /* Likewise if we are in a different symtab altogether
3946 (e.g. within a file included via #include). */
3947 if (sal.symtab != prologue_sal.symtab)
3950 /* The line number is smaller. Check that it's from the
3951 same function, not something inlined. If it's inlined,
3952 then there is no point comparing the line numbers. */
3953 bl = block_for_pc (prologue_sal.end);
3956 if (block_inlined_p (bl))
3958 if (BLOCK_FUNCTION (bl))
3963 bl = BLOCK_SUPERBLOCK (bl);
3968 /* The case in which compiler's optimizer/scheduler has
3969 moved instructions into the prologue. We look ahead in
3970 the function looking for address ranges whose
3971 corresponding line number is less the first one that we
3972 found for the function. This is more conservative then
3973 refine_prologue_limit which scans a large number of SALs
3974 looking for any in the prologue. */
3979 if (prologue_sal.end < end_pc)
3980 /* Return the end of this line, or zero if we could not find a
3982 return prologue_sal.end;
3984 /* Don't return END_PC, which is past the end of the function. */
3985 return prologue_sal.pc;
3988 /* If P is of the form "operator[ \t]+..." where `...' is
3989 some legitimate operator text, return a pointer to the
3990 beginning of the substring of the operator text.
3991 Otherwise, return "". */
3994 operator_chars (const char *p, const char **end)
3997 if (!startswith (p, "operator"))
4001 /* Don't get faked out by `operator' being part of a longer
4003 if (isalpha (*p) || *p == '_' || *p == '$' || *p == '\0')
4006 /* Allow some whitespace between `operator' and the operator symbol. */
4007 while (*p == ' ' || *p == '\t')
4010 /* Recognize 'operator TYPENAME'. */
4012 if (isalpha (*p) || *p == '_' || *p == '$')
4014 const char *q = p + 1;
4016 while (isalnum (*q) || *q == '_' || *q == '$')
4025 case '\\': /* regexp quoting */
4028 if (p[2] == '=') /* 'operator\*=' */
4030 else /* 'operator\*' */
4034 else if (p[1] == '[')
4037 error (_("mismatched quoting on brackets, "
4038 "try 'operator\\[\\]'"));
4039 else if (p[2] == '\\' && p[3] == ']')
4041 *end = p + 4; /* 'operator\[\]' */
4045 error (_("nothing is allowed between '[' and ']'"));
4049 /* Gratuitous qoute: skip it and move on. */
4071 if (p[0] == '-' && p[1] == '>')
4073 /* Struct pointer member operator 'operator->'. */
4076 *end = p + 3; /* 'operator->*' */
4079 else if (p[2] == '\\')
4081 *end = p + 4; /* Hopefully 'operator->\*' */
4086 *end = p + 2; /* 'operator->' */
4090 if (p[1] == '=' || p[1] == p[0])
4101 error (_("`operator ()' must be specified "
4102 "without whitespace in `()'"));
4107 error (_("`operator ?:' must be specified "
4108 "without whitespace in `?:'"));
4113 error (_("`operator []' must be specified "
4114 "without whitespace in `[]'"));
4118 error (_("`operator %s' not supported"), p);
4127 /* Cache to watch for file names already seen by filename_seen. */
4129 struct filename_seen_cache
4131 /* Table of files seen so far. */
4133 /* Initial size of the table. It automagically grows from here. */
4134 #define INITIAL_FILENAME_SEEN_CACHE_SIZE 100
4137 /* filename_seen_cache constructor. */
4139 static struct filename_seen_cache *
4140 create_filename_seen_cache (void)
4142 struct filename_seen_cache *cache = XNEW (struct filename_seen_cache);
4144 cache->tab = htab_create_alloc (INITIAL_FILENAME_SEEN_CACHE_SIZE,
4145 filename_hash, filename_eq,
4146 NULL, xcalloc, xfree);
4151 /* Empty the cache, but do not delete it. */
4154 clear_filename_seen_cache (struct filename_seen_cache *cache)
4156 htab_empty (cache->tab);
4159 /* filename_seen_cache destructor.
4160 This takes a void * argument as it is generally used as a cleanup. */
4163 delete_filename_seen_cache (void *ptr)
4165 struct filename_seen_cache *cache = ptr;
4167 htab_delete (cache->tab);
4171 /* If FILE is not already in the table of files in CACHE, return zero;
4172 otherwise return non-zero. Optionally add FILE to the table if ADD
4175 NOTE: We don't manage space for FILE, we assume FILE lives as long
4176 as the caller needs. */
4179 filename_seen (struct filename_seen_cache *cache, const char *file, int add)
4183 /* Is FILE in tab? */
4184 slot = htab_find_slot (cache->tab, file, add ? INSERT : NO_INSERT);
4188 /* No; maybe add it to tab. */
4190 *slot = (char *) file;
4195 /* Data structure to maintain printing state for output_source_filename. */
4197 struct output_source_filename_data
4199 /* Cache of what we've seen so far. */
4200 struct filename_seen_cache *filename_seen_cache;
4202 /* Flag of whether we're printing the first one. */
4206 /* Slave routine for sources_info. Force line breaks at ,'s.
4207 NAME is the name to print.
4208 DATA contains the state for printing and watching for duplicates. */
4211 output_source_filename (const char *name,
4212 struct output_source_filename_data *data)
4214 /* Since a single source file can result in several partial symbol
4215 tables, we need to avoid printing it more than once. Note: if
4216 some of the psymtabs are read in and some are not, it gets
4217 printed both under "Source files for which symbols have been
4218 read" and "Source files for which symbols will be read in on
4219 demand". I consider this a reasonable way to deal with the
4220 situation. I'm not sure whether this can also happen for
4221 symtabs; it doesn't hurt to check. */
4223 /* Was NAME already seen? */
4224 if (filename_seen (data->filename_seen_cache, name, 1))
4226 /* Yes; don't print it again. */
4230 /* No; print it and reset *FIRST. */
4232 printf_filtered (", ");
4236 fputs_filtered (name, gdb_stdout);
4239 /* A callback for map_partial_symbol_filenames. */
4242 output_partial_symbol_filename (const char *filename, const char *fullname,
4245 output_source_filename (fullname ? fullname : filename, data);
4249 sources_info (char *ignore, int from_tty)
4251 struct compunit_symtab *cu;
4253 struct objfile *objfile;
4254 struct output_source_filename_data data;
4255 struct cleanup *cleanups;
4257 if (!have_full_symbols () && !have_partial_symbols ())
4259 error (_("No symbol table is loaded. Use the \"file\" command."));
4262 data.filename_seen_cache = create_filename_seen_cache ();
4263 cleanups = make_cleanup (delete_filename_seen_cache,
4264 data.filename_seen_cache);
4266 printf_filtered ("Source files for which symbols have been read in:\n\n");
4269 ALL_FILETABS (objfile, cu, s)
4271 const char *fullname = symtab_to_fullname (s);
4273 output_source_filename (fullname, &data);
4275 printf_filtered ("\n\n");
4277 printf_filtered ("Source files for which symbols "
4278 "will be read in on demand:\n\n");
4280 clear_filename_seen_cache (data.filename_seen_cache);
4282 map_symbol_filenames (output_partial_symbol_filename, &data,
4283 1 /*need_fullname*/);
4284 printf_filtered ("\n");
4286 do_cleanups (cleanups);
4289 /* Compare FILE against all the NFILES entries of FILES. If BASENAMES is
4290 non-zero compare only lbasename of FILES. */
4293 file_matches (const char *file, const char *files[], int nfiles, int basenames)
4297 if (file != NULL && nfiles != 0)
4299 for (i = 0; i < nfiles; i++)
4301 if (compare_filenames_for_search (file, (basenames
4302 ? lbasename (files[i])
4307 else if (nfiles == 0)
4312 /* Free any memory associated with a search. */
4315 free_search_symbols (struct symbol_search *symbols)
4317 struct symbol_search *p;
4318 struct symbol_search *next;
4320 for (p = symbols; p != NULL; p = next)
4328 do_free_search_symbols_cleanup (void *symbolsp)
4330 struct symbol_search *symbols = *(struct symbol_search **) symbolsp;
4332 free_search_symbols (symbols);
4336 make_cleanup_free_search_symbols (struct symbol_search **symbolsp)
4338 return make_cleanup (do_free_search_symbols_cleanup, symbolsp);
4341 /* Helper function for sort_search_symbols_remove_dups and qsort. Can only
4342 sort symbols, not minimal symbols. */
4345 compare_search_syms (const void *sa, const void *sb)
4347 struct symbol_search *sym_a = *(struct symbol_search **) sa;
4348 struct symbol_search *sym_b = *(struct symbol_search **) sb;
4351 c = FILENAME_CMP (symbol_symtab (sym_a->symbol)->filename,
4352 symbol_symtab (sym_b->symbol)->filename);
4356 if (sym_a->block != sym_b->block)
4357 return sym_a->block - sym_b->block;
4359 return strcmp (SYMBOL_PRINT_NAME (sym_a->symbol),
4360 SYMBOL_PRINT_NAME (sym_b->symbol));
4363 /* Sort the NFOUND symbols in list FOUND and remove duplicates.
4364 The duplicates are freed, and the new list is returned in
4365 *NEW_HEAD, *NEW_TAIL. */
4368 sort_search_symbols_remove_dups (struct symbol_search *found, int nfound,
4369 struct symbol_search **new_head,
4370 struct symbol_search **new_tail)
4372 struct symbol_search **symbols, *symp, *old_next;
4375 gdb_assert (found != NULL && nfound > 0);
4377 /* Build an array out of the list so we can easily sort them. */
4378 symbols = XNEWVEC (struct symbol_search *, nfound);
4381 for (i = 0; i < nfound; i++)
4383 gdb_assert (symp != NULL);
4384 gdb_assert (symp->block >= 0 && symp->block <= 1);
4388 gdb_assert (symp == NULL);
4390 qsort (symbols, nfound, sizeof (struct symbol_search *),
4391 compare_search_syms);
4393 /* Collapse out the dups. */
4394 for (i = 1, j = 1; i < nfound; ++i)
4396 if (compare_search_syms (&symbols[j - 1], &symbols[i]) != 0)
4397 symbols[j++] = symbols[i];
4402 symbols[j - 1]->next = NULL;
4404 /* Rebuild the linked list. */
4405 for (i = 0; i < nunique - 1; i++)
4406 symbols[i]->next = symbols[i + 1];
4407 symbols[nunique - 1]->next = NULL;
4409 *new_head = symbols[0];
4410 *new_tail = symbols[nunique - 1];
4414 /* An object of this type is passed as the user_data to the
4415 expand_symtabs_matching method. */
4416 struct search_symbols_data
4421 /* It is true if PREG contains valid data, false otherwise. */
4422 unsigned preg_p : 1;
4426 /* A callback for expand_symtabs_matching. */
4429 search_symbols_file_matches (const char *filename, void *user_data,
4432 struct search_symbols_data *data = user_data;
4434 return file_matches (filename, data->files, data->nfiles, basenames);
4437 /* A callback for expand_symtabs_matching. */
4440 search_symbols_name_matches (const char *symname, void *user_data)
4442 struct search_symbols_data *data = user_data;
4444 return !data->preg_p || regexec (&data->preg, symname, 0, NULL, 0) == 0;
4447 /* Search the symbol table for matches to the regular expression REGEXP,
4448 returning the results in *MATCHES.
4450 Only symbols of KIND are searched:
4451 VARIABLES_DOMAIN - search all symbols, excluding functions, type names,
4452 and constants (enums)
4453 FUNCTIONS_DOMAIN - search all functions
4454 TYPES_DOMAIN - search all type names
4455 ALL_DOMAIN - an internal error for this function
4457 free_search_symbols should be called when *MATCHES is no longer needed.
4459 Within each file the results are sorted locally; each symtab's global and
4460 static blocks are separately alphabetized.
4461 Duplicate entries are removed. */
4464 search_symbols (const char *regexp, enum search_domain kind,
4465 int nfiles, const char *files[],
4466 struct symbol_search **matches)
4468 struct compunit_symtab *cust;
4469 const struct blockvector *bv;
4472 struct block_iterator iter;
4474 struct objfile *objfile;
4475 struct minimal_symbol *msymbol;
4477 static const enum minimal_symbol_type types[]
4478 = {mst_data, mst_text, mst_abs};
4479 static const enum minimal_symbol_type types2[]
4480 = {mst_bss, mst_file_text, mst_abs};
4481 static const enum minimal_symbol_type types3[]
4482 = {mst_file_data, mst_solib_trampoline, mst_abs};
4483 static const enum minimal_symbol_type types4[]
4484 = {mst_file_bss, mst_text_gnu_ifunc, mst_abs};
4485 enum minimal_symbol_type ourtype;
4486 enum minimal_symbol_type ourtype2;
4487 enum minimal_symbol_type ourtype3;
4488 enum minimal_symbol_type ourtype4;
4489 struct symbol_search *found;
4490 struct symbol_search *tail;
4491 struct search_symbols_data datum;
4494 /* OLD_CHAIN .. RETVAL_CHAIN is always freed, RETVAL_CHAIN .. current
4495 CLEANUP_CHAIN is freed only in the case of an error. */
4496 struct cleanup *old_chain = make_cleanup (null_cleanup, NULL);
4497 struct cleanup *retval_chain;
4499 gdb_assert (kind <= TYPES_DOMAIN);
4501 ourtype = types[kind];
4502 ourtype2 = types2[kind];
4503 ourtype3 = types3[kind];
4504 ourtype4 = types4[kind];
4511 /* Make sure spacing is right for C++ operators.
4512 This is just a courtesy to make the matching less sensitive
4513 to how many spaces the user leaves between 'operator'
4514 and <TYPENAME> or <OPERATOR>. */
4516 const char *opname = operator_chars (regexp, &opend);
4521 int fix = -1; /* -1 means ok; otherwise number of
4524 if (isalpha (*opname) || *opname == '_' || *opname == '$')
4526 /* There should 1 space between 'operator' and 'TYPENAME'. */
4527 if (opname[-1] != ' ' || opname[-2] == ' ')
4532 /* There should 0 spaces between 'operator' and 'OPERATOR'. */
4533 if (opname[-1] == ' ')
4536 /* If wrong number of spaces, fix it. */
4539 char *tmp = (char *) alloca (8 + fix + strlen (opname) + 1);
4541 sprintf (tmp, "operator%.*s%s", fix, " ", opname);
4546 errcode = regcomp (&datum.preg, regexp,
4547 REG_NOSUB | (case_sensitivity == case_sensitive_off
4551 char *err = get_regcomp_error (errcode, &datum.preg);
4553 make_cleanup (xfree, err);
4554 error (_("Invalid regexp (%s): %s"), err, regexp);
4557 make_regfree_cleanup (&datum.preg);
4560 /* Search through the partial symtabs *first* for all symbols
4561 matching the regexp. That way we don't have to reproduce all of
4562 the machinery below. */
4564 datum.nfiles = nfiles;
4565 datum.files = files;
4566 expand_symtabs_matching ((nfiles == 0
4568 : search_symbols_file_matches),
4569 search_symbols_name_matches,
4570 NULL, kind, &datum);
4572 /* Here, we search through the minimal symbol tables for functions
4573 and variables that match, and force their symbols to be read.
4574 This is in particular necessary for demangled variable names,
4575 which are no longer put into the partial symbol tables.
4576 The symbol will then be found during the scan of symtabs below.
4578 For functions, find_pc_symtab should succeed if we have debug info
4579 for the function, for variables we have to call
4580 lookup_symbol_in_objfile_from_linkage_name to determine if the variable
4582 If the lookup fails, set found_misc so that we will rescan to print
4583 any matching symbols without debug info.
4584 We only search the objfile the msymbol came from, we no longer search
4585 all objfiles. In large programs (1000s of shared libs) searching all
4586 objfiles is not worth the pain. */
4588 if (nfiles == 0 && (kind == VARIABLES_DOMAIN || kind == FUNCTIONS_DOMAIN))
4590 ALL_MSYMBOLS (objfile, msymbol)
4594 if (msymbol->created_by_gdb)
4597 if (MSYMBOL_TYPE (msymbol) == ourtype
4598 || MSYMBOL_TYPE (msymbol) == ourtype2
4599 || MSYMBOL_TYPE (msymbol) == ourtype3
4600 || MSYMBOL_TYPE (msymbol) == ourtype4)
4603 || regexec (&datum.preg, MSYMBOL_NATURAL_NAME (msymbol), 0,
4606 /* Note: An important side-effect of these lookup functions
4607 is to expand the symbol table if msymbol is found, for the
4608 benefit of the next loop on ALL_COMPUNITS. */
4609 if (kind == FUNCTIONS_DOMAIN
4610 ? (find_pc_compunit_symtab
4611 (MSYMBOL_VALUE_ADDRESS (objfile, msymbol)) == NULL)
4612 : (lookup_symbol_in_objfile_from_linkage_name
4613 (objfile, MSYMBOL_LINKAGE_NAME (msymbol), VAR_DOMAIN)
4624 retval_chain = make_cleanup_free_search_symbols (&found);
4626 ALL_COMPUNITS (objfile, cust)
4628 bv = COMPUNIT_BLOCKVECTOR (cust);
4629 for (i = GLOBAL_BLOCK; i <= STATIC_BLOCK; i++)
4631 b = BLOCKVECTOR_BLOCK (bv, i);
4632 ALL_BLOCK_SYMBOLS (b, iter, sym)
4634 struct symtab *real_symtab = symbol_symtab (sym);
4638 /* Check first sole REAL_SYMTAB->FILENAME. It does not need to be
4639 a substring of symtab_to_fullname as it may contain "./" etc. */
4640 if ((file_matches (real_symtab->filename, files, nfiles, 0)
4641 || ((basenames_may_differ
4642 || file_matches (lbasename (real_symtab->filename),
4644 && file_matches (symtab_to_fullname (real_symtab),
4647 || regexec (&datum.preg, SYMBOL_NATURAL_NAME (sym), 0,
4649 && ((kind == VARIABLES_DOMAIN
4650 && SYMBOL_CLASS (sym) != LOC_TYPEDEF
4651 && SYMBOL_CLASS (sym) != LOC_UNRESOLVED
4652 && SYMBOL_CLASS (sym) != LOC_BLOCK
4653 /* LOC_CONST can be used for more than just enums,
4654 e.g., c++ static const members.
4655 We only want to skip enums here. */
4656 && !(SYMBOL_CLASS (sym) == LOC_CONST
4657 && (TYPE_CODE (SYMBOL_TYPE (sym))
4658 == TYPE_CODE_ENUM)))
4659 || (kind == FUNCTIONS_DOMAIN
4660 && SYMBOL_CLASS (sym) == LOC_BLOCK)
4661 || (kind == TYPES_DOMAIN
4662 && SYMBOL_CLASS (sym) == LOC_TYPEDEF))))
4665 struct symbol_search *psr = XCNEW (struct symbol_search);
4683 sort_search_symbols_remove_dups (found, nfound, &found, &tail);
4684 /* Note: nfound is no longer useful beyond this point. */
4687 /* If there are no eyes, avoid all contact. I mean, if there are
4688 no debug symbols, then add matching minsyms. */
4690 if (found_misc || (nfiles == 0 && kind != FUNCTIONS_DOMAIN))
4692 ALL_MSYMBOLS (objfile, msymbol)
4696 if (msymbol->created_by_gdb)
4699 if (MSYMBOL_TYPE (msymbol) == ourtype
4700 || MSYMBOL_TYPE (msymbol) == ourtype2
4701 || MSYMBOL_TYPE (msymbol) == ourtype3
4702 || MSYMBOL_TYPE (msymbol) == ourtype4)
4705 || regexec (&datum.preg, MSYMBOL_NATURAL_NAME (msymbol), 0,
4708 /* For functions we can do a quick check of whether the
4709 symbol might be found via find_pc_symtab. */
4710 if (kind != FUNCTIONS_DOMAIN
4711 || (find_pc_compunit_symtab
4712 (MSYMBOL_VALUE_ADDRESS (objfile, msymbol)) == NULL))
4714 if (lookup_symbol_in_objfile_from_linkage_name
4715 (objfile, MSYMBOL_LINKAGE_NAME (msymbol), VAR_DOMAIN)
4719 struct symbol_search *psr = XNEW (struct symbol_search);
4721 psr->msymbol.minsym = msymbol;
4722 psr->msymbol.objfile = objfile;
4737 discard_cleanups (retval_chain);
4738 do_cleanups (old_chain);
4742 /* Helper function for symtab_symbol_info, this function uses
4743 the data returned from search_symbols() to print information
4744 regarding the match to gdb_stdout. */
4747 print_symbol_info (enum search_domain kind,
4749 int block, const char *last)
4751 struct symtab *s = symbol_symtab (sym);
4752 const char *s_filename = symtab_to_filename_for_display (s);
4754 if (last == NULL || filename_cmp (last, s_filename) != 0)
4756 fputs_filtered ("\nFile ", gdb_stdout);
4757 fputs_filtered (s_filename, gdb_stdout);
4758 fputs_filtered (":\n", gdb_stdout);
4761 if (kind != TYPES_DOMAIN && block == STATIC_BLOCK)
4762 printf_filtered ("static ");
4764 /* Typedef that is not a C++ class. */
4765 if (kind == TYPES_DOMAIN
4766 && SYMBOL_DOMAIN (sym) != STRUCT_DOMAIN)
4767 typedef_print (SYMBOL_TYPE (sym), sym, gdb_stdout);
4768 /* variable, func, or typedef-that-is-c++-class. */
4769 else if (kind < TYPES_DOMAIN
4770 || (kind == TYPES_DOMAIN
4771 && SYMBOL_DOMAIN (sym) == STRUCT_DOMAIN))
4773 type_print (SYMBOL_TYPE (sym),
4774 (SYMBOL_CLASS (sym) == LOC_TYPEDEF
4775 ? "" : SYMBOL_PRINT_NAME (sym)),
4778 printf_filtered (";\n");
4782 /* This help function for symtab_symbol_info() prints information
4783 for non-debugging symbols to gdb_stdout. */
4786 print_msymbol_info (struct bound_minimal_symbol msymbol)
4788 struct gdbarch *gdbarch = get_objfile_arch (msymbol.objfile);
4791 if (gdbarch_addr_bit (gdbarch) <= 32)
4792 tmp = hex_string_custom (BMSYMBOL_VALUE_ADDRESS (msymbol)
4793 & (CORE_ADDR) 0xffffffff,
4796 tmp = hex_string_custom (BMSYMBOL_VALUE_ADDRESS (msymbol),
4798 printf_filtered ("%s %s\n",
4799 tmp, MSYMBOL_PRINT_NAME (msymbol.minsym));
4802 /* This is the guts of the commands "info functions", "info types", and
4803 "info variables". It calls search_symbols to find all matches and then
4804 print_[m]symbol_info to print out some useful information about the
4808 symtab_symbol_info (char *regexp, enum search_domain kind, int from_tty)
4810 static const char * const classnames[] =
4811 {"variable", "function", "type"};
4812 struct symbol_search *symbols;
4813 struct symbol_search *p;
4814 struct cleanup *old_chain;
4815 const char *last_filename = NULL;
4818 gdb_assert (kind <= TYPES_DOMAIN);
4820 /* Must make sure that if we're interrupted, symbols gets freed. */
4821 search_symbols (regexp, kind, 0, NULL, &symbols);
4822 old_chain = make_cleanup_free_search_symbols (&symbols);
4825 printf_filtered (_("All %ss matching regular expression \"%s\":\n"),
4826 classnames[kind], regexp);
4828 printf_filtered (_("All defined %ss:\n"), classnames[kind]);
4830 for (p = symbols; p != NULL; p = p->next)
4834 if (p->msymbol.minsym != NULL)
4838 printf_filtered (_("\nNon-debugging symbols:\n"));
4841 print_msymbol_info (p->msymbol);
4845 print_symbol_info (kind,
4850 = symtab_to_filename_for_display (symbol_symtab (p->symbol));
4854 do_cleanups (old_chain);
4858 variables_info (char *regexp, int from_tty)
4860 symtab_symbol_info (regexp, VARIABLES_DOMAIN, from_tty);
4864 functions_info (char *regexp, int from_tty)
4866 symtab_symbol_info (regexp, FUNCTIONS_DOMAIN, from_tty);
4871 types_info (char *regexp, int from_tty)
4873 symtab_symbol_info (regexp, TYPES_DOMAIN, from_tty);
4876 /* Breakpoint all functions matching regular expression. */
4879 rbreak_command_wrapper (char *regexp, int from_tty)
4881 rbreak_command (regexp, from_tty);
4884 /* A cleanup function that calls end_rbreak_breakpoints. */
4887 do_end_rbreak_breakpoints (void *ignore)
4889 end_rbreak_breakpoints ();
4893 rbreak_command (char *regexp, int from_tty)
4895 struct symbol_search *ss;
4896 struct symbol_search *p;
4897 struct cleanup *old_chain;
4898 char *string = NULL;
4900 const char **files = NULL;
4901 const char *file_name;
4906 char *colon = strchr (regexp, ':');
4908 if (colon && *(colon + 1) != ':')
4913 colon_index = colon - regexp;
4914 local_name = alloca (colon_index + 1);
4915 memcpy (local_name, regexp, colon_index);
4916 local_name[colon_index--] = 0;
4917 while (isspace (local_name[colon_index]))
4918 local_name[colon_index--] = 0;
4919 file_name = local_name;
4922 regexp = skip_spaces (colon + 1);
4926 search_symbols (regexp, FUNCTIONS_DOMAIN, nfiles, files, &ss);
4927 old_chain = make_cleanup_free_search_symbols (&ss);
4928 make_cleanup (free_current_contents, &string);
4930 start_rbreak_breakpoints ();
4931 make_cleanup (do_end_rbreak_breakpoints, NULL);
4932 for (p = ss; p != NULL; p = p->next)
4934 if (p->msymbol.minsym == NULL)
4936 struct symtab *symtab = symbol_symtab (p->symbol);
4937 const char *fullname = symtab_to_fullname (symtab);
4939 int newlen = (strlen (fullname)
4940 + strlen (SYMBOL_LINKAGE_NAME (p->symbol))
4945 string = xrealloc (string, newlen);
4948 strcpy (string, fullname);
4949 strcat (string, ":'");
4950 strcat (string, SYMBOL_LINKAGE_NAME (p->symbol));
4951 strcat (string, "'");
4952 break_command (string, from_tty);
4953 print_symbol_info (FUNCTIONS_DOMAIN,
4956 symtab_to_filename_for_display (symtab));
4960 int newlen = (strlen (MSYMBOL_LINKAGE_NAME (p->msymbol.minsym)) + 3);
4964 string = xrealloc (string, newlen);
4967 strcpy (string, "'");
4968 strcat (string, MSYMBOL_LINKAGE_NAME (p->msymbol.minsym));
4969 strcat (string, "'");
4971 break_command (string, from_tty);
4972 printf_filtered ("<function, no debug info> %s;\n",
4973 MSYMBOL_PRINT_NAME (p->msymbol.minsym));
4977 do_cleanups (old_chain);
4981 /* Evaluate if NAME matches SYM_TEXT and SYM_TEXT_LEN.
4983 Either sym_text[sym_text_len] != '(' and then we search for any
4984 symbol starting with SYM_TEXT text.
4986 Otherwise sym_text[sym_text_len] == '(' and then we require symbol name to
4987 be terminated at that point. Partial symbol tables do not have parameters
4991 compare_symbol_name (const char *name, const char *sym_text, int sym_text_len)
4993 int (*ncmp) (const char *, const char *, size_t);
4995 ncmp = (case_sensitivity == case_sensitive_on ? strncmp : strncasecmp);
4997 if (ncmp (name, sym_text, sym_text_len) != 0)
5000 if (sym_text[sym_text_len] == '(')
5002 /* User searches for `name(someth...'. Require NAME to be terminated.
5003 Normally psymtabs and gdbindex have no parameter types so '\0' will be
5004 present but accept even parameters presence. In this case this
5005 function is in fact strcmp_iw but whitespace skipping is not supported
5006 for tab completion. */
5008 if (name[sym_text_len] != '\0' && name[sym_text_len] != '(')
5015 /* Free any memory associated with a completion list. */
5018 free_completion_list (VEC (char_ptr) **list_ptr)
5023 for (i = 0; VEC_iterate (char_ptr, *list_ptr, i, p); ++i)
5025 VEC_free (char_ptr, *list_ptr);
5028 /* Callback for make_cleanup. */
5031 do_free_completion_list (void *list)
5033 free_completion_list (list);
5036 /* Helper routine for make_symbol_completion_list. */
5038 static VEC (char_ptr) *return_val;
5040 #define COMPLETION_LIST_ADD_SYMBOL(symbol, sym_text, len, text, word) \
5041 completion_list_add_name \
5042 (SYMBOL_NATURAL_NAME (symbol), (sym_text), (len), (text), (word))
5044 #define MCOMPLETION_LIST_ADD_SYMBOL(symbol, sym_text, len, text, word) \
5045 completion_list_add_name \
5046 (MSYMBOL_NATURAL_NAME (symbol), (sym_text), (len), (text), (word))
5048 /* Tracker for how many unique completions have been generated. Used
5049 to terminate completion list generation early if the list has grown
5050 to a size so large as to be useless. This helps avoid GDB seeming
5051 to lock up in the event the user requests to complete on something
5052 vague that necessitates the time consuming expansion of many symbol
5055 static completion_tracker_t completion_tracker;
5057 /* Test to see if the symbol specified by SYMNAME (which is already
5058 demangled for C++ symbols) matches SYM_TEXT in the first SYM_TEXT_LEN
5059 characters. If so, add it to the current completion list. */
5062 completion_list_add_name (const char *symname,
5063 const char *sym_text, int sym_text_len,
5064 const char *text, const char *word)
5066 /* Clip symbols that cannot match. */
5067 if (!compare_symbol_name (symname, sym_text, sym_text_len))
5070 /* We have a match for a completion, so add SYMNAME to the current list
5071 of matches. Note that the name is moved to freshly malloc'd space. */
5075 enum maybe_add_completion_enum add_status;
5077 if (word == sym_text)
5079 newobj = xmalloc (strlen (symname) + 5);
5080 strcpy (newobj, symname);
5082 else if (word > sym_text)
5084 /* Return some portion of symname. */
5085 newobj = xmalloc (strlen (symname) + 5);
5086 strcpy (newobj, symname + (word - sym_text));
5090 /* Return some of SYM_TEXT plus symname. */
5091 newobj = xmalloc (strlen (symname) + (sym_text - word) + 5);
5092 strncpy (newobj, word, sym_text - word);
5093 newobj[sym_text - word] = '\0';
5094 strcat (newobj, symname);
5097 add_status = maybe_add_completion (completion_tracker, newobj);
5101 case MAYBE_ADD_COMPLETION_OK:
5102 VEC_safe_push (char_ptr, return_val, newobj);
5104 case MAYBE_ADD_COMPLETION_OK_MAX_REACHED:
5105 VEC_safe_push (char_ptr, return_val, newobj);
5106 throw_max_completions_reached_error ();
5107 case MAYBE_ADD_COMPLETION_MAX_REACHED:
5109 throw_max_completions_reached_error ();
5110 case MAYBE_ADD_COMPLETION_DUPLICATE:
5117 /* ObjC: In case we are completing on a selector, look as the msymbol
5118 again and feed all the selectors into the mill. */
5121 completion_list_objc_symbol (struct minimal_symbol *msymbol,
5122 const char *sym_text, int sym_text_len,
5123 const char *text, const char *word)
5125 static char *tmp = NULL;
5126 static unsigned int tmplen = 0;
5128 const char *method, *category, *selector;
5131 method = MSYMBOL_NATURAL_NAME (msymbol);
5133 /* Is it a method? */
5134 if ((method[0] != '-') && (method[0] != '+'))
5137 if (sym_text[0] == '[')
5138 /* Complete on shortened method method. */
5139 completion_list_add_name (method + 1, sym_text, sym_text_len, text, word);
5141 while ((strlen (method) + 1) >= tmplen)
5147 tmp = xrealloc (tmp, tmplen);
5149 selector = strchr (method, ' ');
5150 if (selector != NULL)
5153 category = strchr (method, '(');
5155 if ((category != NULL) && (selector != NULL))
5157 memcpy (tmp, method, (category - method));
5158 tmp[category - method] = ' ';
5159 memcpy (tmp + (category - method) + 1, selector, strlen (selector) + 1);
5160 completion_list_add_name (tmp, sym_text, sym_text_len, text, word);
5161 if (sym_text[0] == '[')
5162 completion_list_add_name (tmp + 1, sym_text, sym_text_len, text, word);
5165 if (selector != NULL)
5167 /* Complete on selector only. */
5168 strcpy (tmp, selector);
5169 tmp2 = strchr (tmp, ']');
5173 completion_list_add_name (tmp, sym_text, sym_text_len, text, word);
5177 /* Break the non-quoted text based on the characters which are in
5178 symbols. FIXME: This should probably be language-specific. */
5181 language_search_unquoted_string (const char *text, const char *p)
5183 for (; p > text; --p)
5185 if (isalnum (p[-1]) || p[-1] == '_' || p[-1] == '\0')
5189 if ((current_language->la_language == language_objc))
5191 if (p[-1] == ':') /* Might be part of a method name. */
5193 else if (p[-1] == '[' && (p[-2] == '-' || p[-2] == '+'))
5194 p -= 2; /* Beginning of a method name. */
5195 else if (p[-1] == ' ' || p[-1] == '(' || p[-1] == ')')
5196 { /* Might be part of a method name. */
5199 /* Seeing a ' ' or a '(' is not conclusive evidence
5200 that we are in the middle of a method name. However,
5201 finding "-[" or "+[" should be pretty un-ambiguous.
5202 Unfortunately we have to find it now to decide. */
5205 if (isalnum (t[-1]) || t[-1] == '_' ||
5206 t[-1] == ' ' || t[-1] == ':' ||
5207 t[-1] == '(' || t[-1] == ')')
5212 if (t[-1] == '[' && (t[-2] == '-' || t[-2] == '+'))
5213 p = t - 2; /* Method name detected. */
5214 /* Else we leave with p unchanged. */
5224 completion_list_add_fields (struct symbol *sym, const char *sym_text,
5225 int sym_text_len, const char *text,
5228 if (SYMBOL_CLASS (sym) == LOC_TYPEDEF)
5230 struct type *t = SYMBOL_TYPE (sym);
5231 enum type_code c = TYPE_CODE (t);
5234 if (c == TYPE_CODE_UNION || c == TYPE_CODE_STRUCT)
5235 for (j = TYPE_N_BASECLASSES (t); j < TYPE_NFIELDS (t); j++)
5236 if (TYPE_FIELD_NAME (t, j))
5237 completion_list_add_name (TYPE_FIELD_NAME (t, j),
5238 sym_text, sym_text_len, text, word);
5242 /* Type of the user_data argument passed to add_macro_name,
5243 symbol_completion_matcher and symtab_expansion_callback. */
5245 struct add_name_data
5247 /* Arguments required by completion_list_add_name. */
5248 const char *sym_text;
5253 /* Extra argument required for add_symtab_completions. */
5254 enum type_code code;
5257 /* A callback used with macro_for_each and macro_for_each_in_scope.
5258 This adds a macro's name to the current completion list. */
5261 add_macro_name (const char *name, const struct macro_definition *ignore,
5262 struct macro_source_file *ignore2, int ignore3,
5265 struct add_name_data *datum = (struct add_name_data *) user_data;
5267 completion_list_add_name (name,
5268 datum->sym_text, datum->sym_text_len,
5269 datum->text, datum->word);
5272 /* A callback for expand_symtabs_matching. */
5275 symbol_completion_matcher (const char *name, void *user_data)
5277 struct add_name_data *datum = (struct add_name_data *) user_data;
5279 return compare_symbol_name (name, datum->sym_text, datum->sym_text_len);
5282 /* Add matching symbols from SYMTAB to the current completion list. */
5285 add_symtab_completions (struct compunit_symtab *cust,
5286 const char *sym_text, int sym_text_len,
5287 const char *text, const char *word,
5288 enum type_code code)
5291 const struct block *b;
5292 struct block_iterator iter;
5295 for (i = GLOBAL_BLOCK; i <= STATIC_BLOCK; i++)
5298 b = BLOCKVECTOR_BLOCK (COMPUNIT_BLOCKVECTOR (cust), i);
5299 ALL_BLOCK_SYMBOLS (b, iter, sym)
5301 if (code == TYPE_CODE_UNDEF
5302 || (SYMBOL_DOMAIN (sym) == STRUCT_DOMAIN
5303 && TYPE_CODE (SYMBOL_TYPE (sym)) == code))
5304 COMPLETION_LIST_ADD_SYMBOL (sym,
5305 sym_text, sym_text_len,
5311 /* Callback to add completions to the current list when symbol tables
5312 are expanded during completion list generation. */
5315 symtab_expansion_callback (struct compunit_symtab *symtab,
5318 struct add_name_data *datum = (struct add_name_data *) user_data;
5320 add_symtab_completions (symtab,
5321 datum->sym_text, datum->sym_text_len,
5322 datum->text, datum->word,
5327 default_make_symbol_completion_list_break_on_1 (const char *text,
5329 const char *break_on,
5330 enum type_code code)
5332 /* Problem: All of the symbols have to be copied because readline
5333 frees them. I'm not going to worry about this; hopefully there
5334 won't be that many. */
5337 struct compunit_symtab *cust;
5338 struct minimal_symbol *msymbol;
5339 struct objfile *objfile;
5340 const struct block *b;
5341 const struct block *surrounding_static_block, *surrounding_global_block;
5342 struct block_iterator iter;
5343 /* The symbol we are completing on. Points in same buffer as text. */
5344 const char *sym_text;
5345 /* Length of sym_text. */
5347 struct add_name_data datum;
5348 struct cleanup *cleanups;
5350 /* Now look for the symbol we are supposed to complete on. */
5354 const char *quote_pos = NULL;
5356 /* First see if this is a quoted string. */
5358 for (p = text; *p != '\0'; ++p)
5360 if (quote_found != '\0')
5362 if (*p == quote_found)
5363 /* Found close quote. */
5365 else if (*p == '\\' && p[1] == quote_found)
5366 /* A backslash followed by the quote character
5367 doesn't end the string. */
5370 else if (*p == '\'' || *p == '"')
5376 if (quote_found == '\'')
5377 /* A string within single quotes can be a symbol, so complete on it. */
5378 sym_text = quote_pos + 1;
5379 else if (quote_found == '"')
5380 /* A double-quoted string is never a symbol, nor does it make sense
5381 to complete it any other way. */
5387 /* It is not a quoted string. Break it based on the characters
5388 which are in symbols. */
5391 if (isalnum (p[-1]) || p[-1] == '_' || p[-1] == '\0'
5392 || p[-1] == ':' || strchr (break_on, p[-1]) != NULL)
5401 sym_text_len = strlen (sym_text);
5403 /* Prepare SYM_TEXT_LEN for compare_symbol_name. */
5405 if (current_language->la_language == language_cplus
5406 || current_language->la_language == language_java
5407 || current_language->la_language == language_fortran)
5409 /* These languages may have parameters entered by user but they are never
5410 present in the partial symbol tables. */
5412 const char *cs = memchr (sym_text, '(', sym_text_len);
5415 sym_text_len = cs - sym_text;
5417 gdb_assert (sym_text[sym_text_len] == '\0' || sym_text[sym_text_len] == '(');
5419 completion_tracker = new_completion_tracker ();
5420 cleanups = make_cleanup_free_completion_tracker (&completion_tracker);
5422 datum.sym_text = sym_text;
5423 datum.sym_text_len = sym_text_len;
5428 /* At this point scan through the misc symbol vectors and add each
5429 symbol you find to the list. Eventually we want to ignore
5430 anything that isn't a text symbol (everything else will be
5431 handled by the psymtab code below). */
5433 if (code == TYPE_CODE_UNDEF)
5435 ALL_MSYMBOLS (objfile, msymbol)
5438 MCOMPLETION_LIST_ADD_SYMBOL (msymbol, sym_text, sym_text_len, text,
5441 completion_list_objc_symbol (msymbol, sym_text, sym_text_len, text,
5446 /* Add completions for all currently loaded symbol tables. */
5447 ALL_COMPUNITS (objfile, cust)
5448 add_symtab_completions (cust, sym_text, sym_text_len, text, word,
5451 /* Look through the partial symtabs for all symbols which begin
5452 by matching SYM_TEXT. Expand all CUs that you find to the list.
5453 symtab_expansion_callback is called for each expanded symtab,
5454 causing those symtab's completions to be added to the list too. */
5455 expand_symtabs_matching (NULL, symbol_completion_matcher,
5456 symtab_expansion_callback, ALL_DOMAIN,
5459 /* Search upwards from currently selected frame (so that we can
5460 complete on local vars). Also catch fields of types defined in
5461 this places which match our text string. Only complete on types
5462 visible from current context. */
5464 b = get_selected_block (0);
5465 surrounding_static_block = block_static_block (b);
5466 surrounding_global_block = block_global_block (b);
5467 if (surrounding_static_block != NULL)
5468 while (b != surrounding_static_block)
5472 ALL_BLOCK_SYMBOLS (b, iter, sym)
5474 if (code == TYPE_CODE_UNDEF)
5476 COMPLETION_LIST_ADD_SYMBOL (sym, sym_text, sym_text_len, text,
5478 completion_list_add_fields (sym, sym_text, sym_text_len, text,
5481 else if (SYMBOL_DOMAIN (sym) == STRUCT_DOMAIN
5482 && TYPE_CODE (SYMBOL_TYPE (sym)) == code)
5483 COMPLETION_LIST_ADD_SYMBOL (sym, sym_text, sym_text_len, text,
5487 /* Stop when we encounter an enclosing function. Do not stop for
5488 non-inlined functions - the locals of the enclosing function
5489 are in scope for a nested function. */
5490 if (BLOCK_FUNCTION (b) != NULL && block_inlined_p (b))
5492 b = BLOCK_SUPERBLOCK (b);
5495 /* Add fields from the file's types; symbols will be added below. */
5497 if (code == TYPE_CODE_UNDEF)
5499 if (surrounding_static_block != NULL)
5500 ALL_BLOCK_SYMBOLS (surrounding_static_block, iter, sym)
5501 completion_list_add_fields (sym, sym_text, sym_text_len, text, word);
5503 if (surrounding_global_block != NULL)
5504 ALL_BLOCK_SYMBOLS (surrounding_global_block, iter, sym)
5505 completion_list_add_fields (sym, sym_text, sym_text_len, text, word);
5508 /* Skip macros if we are completing a struct tag -- arguable but
5509 usually what is expected. */
5510 if (current_language->la_macro_expansion == macro_expansion_c
5511 && code == TYPE_CODE_UNDEF)
5513 struct macro_scope *scope;
5515 /* Add any macros visible in the default scope. Note that this
5516 may yield the occasional wrong result, because an expression
5517 might be evaluated in a scope other than the default. For
5518 example, if the user types "break file:line if <TAB>", the
5519 resulting expression will be evaluated at "file:line" -- but
5520 at there does not seem to be a way to detect this at
5522 scope = default_macro_scope ();
5525 macro_for_each_in_scope (scope->file, scope->line,
5526 add_macro_name, &datum);
5530 /* User-defined macros are always visible. */
5531 macro_for_each (macro_user_macros, add_macro_name, &datum);
5534 do_cleanups (cleanups);
5538 default_make_symbol_completion_list_break_on (const char *text,
5540 const char *break_on,
5541 enum type_code code)
5543 struct cleanup *back_to;
5546 back_to = make_cleanup (do_free_completion_list, &return_val);
5550 default_make_symbol_completion_list_break_on_1 (text, word,
5553 CATCH (except, RETURN_MASK_ERROR)
5555 if (except.error != MAX_COMPLETIONS_REACHED_ERROR)
5556 throw_exception (except);
5560 discard_cleanups (back_to);
5565 default_make_symbol_completion_list (const char *text, const char *word,
5566 enum type_code code)
5568 return default_make_symbol_completion_list_break_on (text, word, "", code);
5571 /* Return a vector of all symbols (regardless of class) which begin by
5572 matching TEXT. If the answer is no symbols, then the return value
5576 make_symbol_completion_list (const char *text, const char *word)
5578 return current_language->la_make_symbol_completion_list (text, word,
5582 /* Like make_symbol_completion_list, but only return STRUCT_DOMAIN
5583 symbols whose type code is CODE. */
5586 make_symbol_completion_type (const char *text, const char *word,
5587 enum type_code code)
5589 gdb_assert (code == TYPE_CODE_UNION
5590 || code == TYPE_CODE_STRUCT
5591 || code == TYPE_CODE_ENUM);
5592 return current_language->la_make_symbol_completion_list (text, word, code);
5595 /* Like make_symbol_completion_list, but suitable for use as a
5596 completion function. */
5599 make_symbol_completion_list_fn (struct cmd_list_element *ignore,
5600 const char *text, const char *word)
5602 return make_symbol_completion_list (text, word);
5605 /* Like make_symbol_completion_list, but returns a list of symbols
5606 defined in a source file FILE. */
5608 static VEC (char_ptr) *
5609 make_file_symbol_completion_list_1 (const char *text, const char *word,
5610 const char *srcfile)
5615 struct block_iterator iter;
5616 /* The symbol we are completing on. Points in same buffer as text. */
5617 const char *sym_text;
5618 /* Length of sym_text. */
5621 /* Now look for the symbol we are supposed to complete on.
5622 FIXME: This should be language-specific. */
5626 const char *quote_pos = NULL;
5628 /* First see if this is a quoted string. */
5630 for (p = text; *p != '\0'; ++p)
5632 if (quote_found != '\0')
5634 if (*p == quote_found)
5635 /* Found close quote. */
5637 else if (*p == '\\' && p[1] == quote_found)
5638 /* A backslash followed by the quote character
5639 doesn't end the string. */
5642 else if (*p == '\'' || *p == '"')
5648 if (quote_found == '\'')
5649 /* A string within single quotes can be a symbol, so complete on it. */
5650 sym_text = quote_pos + 1;
5651 else if (quote_found == '"')
5652 /* A double-quoted string is never a symbol, nor does it make sense
5653 to complete it any other way. */
5659 /* Not a quoted string. */
5660 sym_text = language_search_unquoted_string (text, p);
5664 sym_text_len = strlen (sym_text);
5666 /* Find the symtab for SRCFILE (this loads it if it was not yet read
5668 s = lookup_symtab (srcfile);
5671 /* Maybe they typed the file with leading directories, while the
5672 symbol tables record only its basename. */
5673 const char *tail = lbasename (srcfile);
5676 s = lookup_symtab (tail);
5679 /* If we have no symtab for that file, return an empty list. */
5681 return (return_val);
5683 /* Go through this symtab and check the externs and statics for
5684 symbols which match. */
5686 b = BLOCKVECTOR_BLOCK (SYMTAB_BLOCKVECTOR (s), GLOBAL_BLOCK);
5687 ALL_BLOCK_SYMBOLS (b, iter, sym)
5689 COMPLETION_LIST_ADD_SYMBOL (sym, sym_text, sym_text_len, text, word);
5692 b = BLOCKVECTOR_BLOCK (SYMTAB_BLOCKVECTOR (s), STATIC_BLOCK);
5693 ALL_BLOCK_SYMBOLS (b, iter, sym)
5695 COMPLETION_LIST_ADD_SYMBOL (sym, sym_text, sym_text_len, text, word);
5698 return (return_val);
5701 /* Wrapper around make_file_symbol_completion_list_1
5702 to handle MAX_COMPLETIONS_REACHED_ERROR. */
5705 make_file_symbol_completion_list (const char *text, const char *word,
5706 const char *srcfile)
5708 struct cleanup *back_to, *cleanups;
5710 completion_tracker = new_completion_tracker ();
5711 cleanups = make_cleanup_free_completion_tracker (&completion_tracker);
5713 back_to = make_cleanup (do_free_completion_list, &return_val);
5717 make_file_symbol_completion_list_1 (text, word, srcfile);
5719 CATCH (except, RETURN_MASK_ERROR)
5721 if (except.error != MAX_COMPLETIONS_REACHED_ERROR)
5722 throw_exception (except);
5726 discard_cleanups (back_to);
5727 do_cleanups (cleanups);
5731 /* A helper function for make_source_files_completion_list. It adds
5732 another file name to a list of possible completions, growing the
5733 list as necessary. */
5736 add_filename_to_list (const char *fname, const char *text, const char *word,
5737 VEC (char_ptr) **list)
5740 size_t fnlen = strlen (fname);
5744 /* Return exactly fname. */
5745 newobj = xmalloc (fnlen + 5);
5746 strcpy (newobj, fname);
5748 else if (word > text)
5750 /* Return some portion of fname. */
5751 newobj = xmalloc (fnlen + 5);
5752 strcpy (newobj, fname + (word - text));
5756 /* Return some of TEXT plus fname. */
5757 newobj = xmalloc (fnlen + (text - word) + 5);
5758 strncpy (newobj, word, text - word);
5759 newobj[text - word] = '\0';
5760 strcat (newobj, fname);
5762 VEC_safe_push (char_ptr, *list, newobj);
5766 not_interesting_fname (const char *fname)
5768 static const char *illegal_aliens[] = {
5769 "_globals_", /* inserted by coff_symtab_read */
5774 for (i = 0; illegal_aliens[i]; i++)
5776 if (filename_cmp (fname, illegal_aliens[i]) == 0)
5782 /* An object of this type is passed as the user_data argument to
5783 map_partial_symbol_filenames. */
5784 struct add_partial_filename_data
5786 struct filename_seen_cache *filename_seen_cache;
5790 VEC (char_ptr) **list;
5793 /* A callback for map_partial_symbol_filenames. */
5796 maybe_add_partial_symtab_filename (const char *filename, const char *fullname,
5799 struct add_partial_filename_data *data = user_data;
5801 if (not_interesting_fname (filename))
5803 if (!filename_seen (data->filename_seen_cache, filename, 1)
5804 && filename_ncmp (filename, data->text, data->text_len) == 0)
5806 /* This file matches for a completion; add it to the
5807 current list of matches. */
5808 add_filename_to_list (filename, data->text, data->word, data->list);
5812 const char *base_name = lbasename (filename);
5814 if (base_name != filename
5815 && !filename_seen (data->filename_seen_cache, base_name, 1)
5816 && filename_ncmp (base_name, data->text, data->text_len) == 0)
5817 add_filename_to_list (base_name, data->text, data->word, data->list);
5821 /* Return a vector of all source files whose names begin with matching
5822 TEXT. The file names are looked up in the symbol tables of this
5823 program. If the answer is no matchess, then the return value is
5827 make_source_files_completion_list (const char *text, const char *word)
5829 struct compunit_symtab *cu;
5831 struct objfile *objfile;
5832 size_t text_len = strlen (text);
5833 VEC (char_ptr) *list = NULL;
5834 const char *base_name;
5835 struct add_partial_filename_data datum;
5836 struct filename_seen_cache *filename_seen_cache;
5837 struct cleanup *back_to, *cache_cleanup;
5839 if (!have_full_symbols () && !have_partial_symbols ())
5842 back_to = make_cleanup (do_free_completion_list, &list);
5844 filename_seen_cache = create_filename_seen_cache ();
5845 cache_cleanup = make_cleanup (delete_filename_seen_cache,
5846 filename_seen_cache);
5848 ALL_FILETABS (objfile, cu, s)
5850 if (not_interesting_fname (s->filename))
5852 if (!filename_seen (filename_seen_cache, s->filename, 1)
5853 && filename_ncmp (s->filename, text, text_len) == 0)
5855 /* This file matches for a completion; add it to the current
5857 add_filename_to_list (s->filename, text, word, &list);
5861 /* NOTE: We allow the user to type a base name when the
5862 debug info records leading directories, but not the other
5863 way around. This is what subroutines of breakpoint
5864 command do when they parse file names. */
5865 base_name = lbasename (s->filename);
5866 if (base_name != s->filename
5867 && !filename_seen (filename_seen_cache, base_name, 1)
5868 && filename_ncmp (base_name, text, text_len) == 0)
5869 add_filename_to_list (base_name, text, word, &list);
5873 datum.filename_seen_cache = filename_seen_cache;
5876 datum.text_len = text_len;
5878 map_symbol_filenames (maybe_add_partial_symtab_filename, &datum,
5879 0 /*need_fullname*/);
5881 do_cleanups (cache_cleanup);
5882 discard_cleanups (back_to);
5889 /* Return the "main_info" object for the current program space. If
5890 the object has not yet been created, create it and fill in some
5893 static struct main_info *
5894 get_main_info (void)
5896 struct main_info *info = program_space_data (current_program_space,
5897 main_progspace_key);
5901 /* It may seem strange to store the main name in the progspace
5902 and also in whatever objfile happens to see a main name in
5903 its debug info. The reason for this is mainly historical:
5904 gdb returned "main" as the name even if no function named
5905 "main" was defined the program; and this approach lets us
5906 keep compatibility. */
5907 info = XCNEW (struct main_info);
5908 info->language_of_main = language_unknown;
5909 set_program_space_data (current_program_space, main_progspace_key,
5916 /* A cleanup to destroy a struct main_info when a progspace is
5920 main_info_cleanup (struct program_space *pspace, void *data)
5922 struct main_info *info = data;
5925 xfree (info->name_of_main);
5930 set_main_name (const char *name, enum language lang)
5932 struct main_info *info = get_main_info ();
5934 if (info->name_of_main != NULL)
5936 xfree (info->name_of_main);
5937 info->name_of_main = NULL;
5938 info->language_of_main = language_unknown;
5942 info->name_of_main = xstrdup (name);
5943 info->language_of_main = lang;
5947 /* Deduce the name of the main procedure, and set NAME_OF_MAIN
5951 find_main_name (void)
5953 const char *new_main_name;
5954 struct objfile *objfile;
5956 /* First check the objfiles to see whether a debuginfo reader has
5957 picked up the appropriate main name. Historically the main name
5958 was found in a more or less random way; this approach instead
5959 relies on the order of objfile creation -- which still isn't
5960 guaranteed to get the correct answer, but is just probably more
5962 ALL_OBJFILES (objfile)
5964 if (objfile->per_bfd->name_of_main != NULL)
5966 set_main_name (objfile->per_bfd->name_of_main,
5967 objfile->per_bfd->language_of_main);
5972 /* Try to see if the main procedure is in Ada. */
5973 /* FIXME: brobecker/2005-03-07: Another way of doing this would
5974 be to add a new method in the language vector, and call this
5975 method for each language until one of them returns a non-empty
5976 name. This would allow us to remove this hard-coded call to
5977 an Ada function. It is not clear that this is a better approach
5978 at this point, because all methods need to be written in a way
5979 such that false positives never be returned. For instance, it is
5980 important that a method does not return a wrong name for the main
5981 procedure if the main procedure is actually written in a different
5982 language. It is easy to guaranty this with Ada, since we use a
5983 special symbol generated only when the main in Ada to find the name
5984 of the main procedure. It is difficult however to see how this can
5985 be guarantied for languages such as C, for instance. This suggests
5986 that order of call for these methods becomes important, which means
5987 a more complicated approach. */
5988 new_main_name = ada_main_name ();
5989 if (new_main_name != NULL)
5991 set_main_name (new_main_name, language_ada);
5995 new_main_name = d_main_name ();
5996 if (new_main_name != NULL)
5998 set_main_name (new_main_name, language_d);
6002 new_main_name = go_main_name ();
6003 if (new_main_name != NULL)
6005 set_main_name (new_main_name, language_go);
6009 new_main_name = pascal_main_name ();
6010 if (new_main_name != NULL)
6012 set_main_name (new_main_name, language_pascal);
6016 /* The languages above didn't identify the name of the main procedure.
6017 Fallback to "main". */
6018 set_main_name ("main", language_unknown);
6024 struct main_info *info = get_main_info ();
6026 if (info->name_of_main == NULL)
6029 return info->name_of_main;
6032 /* Return the language of the main function. If it is not known,
6033 return language_unknown. */
6036 main_language (void)
6038 struct main_info *info = get_main_info ();
6040 if (info->name_of_main == NULL)
6043 return info->language_of_main;
6046 /* Handle ``executable_changed'' events for the symtab module. */
6049 symtab_observer_executable_changed (void)
6051 /* NAME_OF_MAIN may no longer be the same, so reset it for now. */
6052 set_main_name (NULL, language_unknown);
6055 /* Return 1 if the supplied producer string matches the ARM RealView
6056 compiler (armcc). */
6059 producer_is_realview (const char *producer)
6061 static const char *const arm_idents[] = {
6062 "ARM C Compiler, ADS",
6063 "Thumb C Compiler, ADS",
6064 "ARM C++ Compiler, ADS",
6065 "Thumb C++ Compiler, ADS",
6066 "ARM/Thumb C/C++ Compiler, RVCT",
6067 "ARM C/C++ Compiler, RVCT"
6071 if (producer == NULL)
6074 for (i = 0; i < ARRAY_SIZE (arm_idents); i++)
6075 if (startswith (producer, arm_idents[i]))
6083 /* The next index to hand out in response to a registration request. */
6085 static int next_aclass_value = LOC_FINAL_VALUE;
6087 /* The maximum number of "aclass" registrations we support. This is
6088 constant for convenience. */
6089 #define MAX_SYMBOL_IMPLS (LOC_FINAL_VALUE + 10)
6091 /* The objects representing the various "aclass" values. The elements
6092 from 0 up to LOC_FINAL_VALUE-1 represent themselves, and subsequent
6093 elements are those registered at gdb initialization time. */
6095 static struct symbol_impl symbol_impl[MAX_SYMBOL_IMPLS];
6097 /* The globally visible pointer. This is separate from 'symbol_impl'
6098 so that it can be const. */
6100 const struct symbol_impl *symbol_impls = &symbol_impl[0];
6102 /* Make sure we saved enough room in struct symbol. */
6104 gdb_static_assert (MAX_SYMBOL_IMPLS <= (1 << SYMBOL_ACLASS_BITS));
6106 /* Register a computed symbol type. ACLASS must be LOC_COMPUTED. OPS
6107 is the ops vector associated with this index. This returns the new
6108 index, which should be used as the aclass_index field for symbols
6112 register_symbol_computed_impl (enum address_class aclass,
6113 const struct symbol_computed_ops *ops)
6115 int result = next_aclass_value++;
6117 gdb_assert (aclass == LOC_COMPUTED);
6118 gdb_assert (result < MAX_SYMBOL_IMPLS);
6119 symbol_impl[result].aclass = aclass;
6120 symbol_impl[result].ops_computed = ops;
6122 /* Sanity check OPS. */
6123 gdb_assert (ops != NULL);
6124 gdb_assert (ops->tracepoint_var_ref != NULL);
6125 gdb_assert (ops->describe_location != NULL);
6126 gdb_assert (ops->read_needs_frame != NULL);
6127 gdb_assert (ops->read_variable != NULL);
6132 /* Register a function with frame base type. ACLASS must be LOC_BLOCK.
6133 OPS is the ops vector associated with this index. This returns the
6134 new index, which should be used as the aclass_index field for symbols
6138 register_symbol_block_impl (enum address_class aclass,
6139 const struct symbol_block_ops *ops)
6141 int result = next_aclass_value++;
6143 gdb_assert (aclass == LOC_BLOCK);
6144 gdb_assert (result < MAX_SYMBOL_IMPLS);
6145 symbol_impl[result].aclass = aclass;
6146 symbol_impl[result].ops_block = ops;
6148 /* Sanity check OPS. */
6149 gdb_assert (ops != NULL);
6150 gdb_assert (ops->find_frame_base_location != NULL);
6155 /* Register a register symbol type. ACLASS must be LOC_REGISTER or
6156 LOC_REGPARM_ADDR. OPS is the register ops vector associated with
6157 this index. This returns the new index, which should be used as
6158 the aclass_index field for symbols of this type. */
6161 register_symbol_register_impl (enum address_class aclass,
6162 const struct symbol_register_ops *ops)
6164 int result = next_aclass_value++;
6166 gdb_assert (aclass == LOC_REGISTER || aclass == LOC_REGPARM_ADDR);
6167 gdb_assert (result < MAX_SYMBOL_IMPLS);
6168 symbol_impl[result].aclass = aclass;
6169 symbol_impl[result].ops_register = ops;
6174 /* Initialize elements of 'symbol_impl' for the constants in enum
6178 initialize_ordinary_address_classes (void)
6182 for (i = 0; i < LOC_FINAL_VALUE; ++i)
6183 symbol_impl[i].aclass = (enum address_class) i;
6188 /* Helper function to initialize the fields of an objfile-owned symbol.
6189 It assumed that *SYM is already all zeroes. */
6192 initialize_objfile_symbol_1 (struct symbol *sym)
6194 SYMBOL_OBJFILE_OWNED (sym) = 1;
6195 SYMBOL_SECTION (sym) = -1;
6198 /* Initialize the symbol SYM, and mark it as being owned by an objfile. */
6201 initialize_objfile_symbol (struct symbol *sym)
6203 memset (sym, 0, sizeof (*sym));
6204 initialize_objfile_symbol_1 (sym);
6207 /* Allocate and initialize a new 'struct symbol' on OBJFILE's
6211 allocate_symbol (struct objfile *objfile)
6213 struct symbol *result;
6215 result = OBSTACK_ZALLOC (&objfile->objfile_obstack, struct symbol);
6216 initialize_objfile_symbol_1 (result);
6221 /* Allocate and initialize a new 'struct template_symbol' on OBJFILE's
6224 struct template_symbol *
6225 allocate_template_symbol (struct objfile *objfile)
6227 struct template_symbol *result;
6229 result = OBSTACK_ZALLOC (&objfile->objfile_obstack, struct template_symbol);
6230 initialize_objfile_symbol_1 (&result->base);
6238 symbol_objfile (const struct symbol *symbol)
6240 gdb_assert (SYMBOL_OBJFILE_OWNED (symbol));
6241 return SYMTAB_OBJFILE (symbol->owner.symtab);
6247 symbol_arch (const struct symbol *symbol)
6249 if (!SYMBOL_OBJFILE_OWNED (symbol))
6250 return symbol->owner.arch;
6251 return get_objfile_arch (SYMTAB_OBJFILE (symbol->owner.symtab));
6257 symbol_symtab (const struct symbol *symbol)
6259 gdb_assert (SYMBOL_OBJFILE_OWNED (symbol));
6260 return symbol->owner.symtab;
6266 symbol_set_symtab (struct symbol *symbol, struct symtab *symtab)
6268 gdb_assert (SYMBOL_OBJFILE_OWNED (symbol));
6269 symbol->owner.symtab = symtab;
6275 _initialize_symtab (void)
6277 initialize_ordinary_address_classes ();
6280 = register_program_space_data_with_cleanup (NULL, main_info_cleanup);
6283 = register_program_space_data_with_cleanup (NULL, symbol_cache_cleanup);
6285 add_info ("variables", variables_info, _("\
6286 All global and static variable names, or those matching REGEXP."));
6288 add_com ("whereis", class_info, variables_info, _("\
6289 All global and static variable names, or those matching REGEXP."));
6291 add_info ("functions", functions_info,
6292 _("All function names, or those matching REGEXP."));
6294 /* FIXME: This command has at least the following problems:
6295 1. It prints builtin types (in a very strange and confusing fashion).
6296 2. It doesn't print right, e.g. with
6297 typedef struct foo *FOO
6298 type_print prints "FOO" when we want to make it (in this situation)
6299 print "struct foo *".
6300 I also think "ptype" or "whatis" is more likely to be useful (but if
6301 there is much disagreement "info types" can be fixed). */
6302 add_info ("types", types_info,
6303 _("All type names, or those matching REGEXP."));
6305 add_info ("sources", sources_info,
6306 _("Source files in the program."));
6308 add_com ("rbreak", class_breakpoint, rbreak_command,
6309 _("Set a breakpoint for all functions matching REGEXP."));
6311 add_setshow_enum_cmd ("multiple-symbols", no_class,
6312 multiple_symbols_modes, &multiple_symbols_mode,
6314 Set the debugger behavior when more than one symbol are possible matches\n\
6315 in an expression."), _("\
6316 Show how the debugger handles ambiguities in expressions."), _("\
6317 Valid values are \"ask\", \"all\", \"cancel\", and the default is \"all\"."),
6318 NULL, NULL, &setlist, &showlist);
6320 add_setshow_boolean_cmd ("basenames-may-differ", class_obscure,
6321 &basenames_may_differ, _("\
6322 Set whether a source file may have multiple base names."), _("\
6323 Show whether a source file may have multiple base names."), _("\
6324 (A \"base name\" is the name of a file with the directory part removed.\n\
6325 Example: The base name of \"/home/user/hello.c\" is \"hello.c\".)\n\
6326 If set, GDB will canonicalize file names (e.g., expand symlinks)\n\
6327 before comparing them. Canonicalization is an expensive operation,\n\
6328 but it allows the same file be known by more than one base name.\n\
6329 If not set (the default), all source files are assumed to have just\n\
6330 one base name, and gdb will do file name comparisons more efficiently."),
6332 &setlist, &showlist);
6334 add_setshow_zuinteger_cmd ("symtab-create", no_class, &symtab_create_debug,
6335 _("Set debugging of symbol table creation."),
6336 _("Show debugging of symbol table creation."), _("\
6337 When enabled (non-zero), debugging messages are printed when building\n\
6338 symbol tables. A value of 1 (one) normally provides enough information.\n\
6339 A value greater than 1 provides more verbose information."),
6342 &setdebuglist, &showdebuglist);
6344 add_setshow_zuinteger_cmd ("symbol-lookup", no_class, &symbol_lookup_debug,
6346 Set debugging of symbol lookup."), _("\
6347 Show debugging of symbol lookup."), _("\
6348 When enabled (non-zero), symbol lookups are logged."),
6350 &setdebuglist, &showdebuglist);
6352 add_setshow_zuinteger_cmd ("symbol-cache-size", no_class,
6353 &new_symbol_cache_size,
6354 _("Set the size of the symbol cache."),
6355 _("Show the size of the symbol cache."), _("\
6356 The size of the symbol cache.\n\
6357 If zero then the symbol cache is disabled."),
6358 set_symbol_cache_size_handler, NULL,
6359 &maintenance_set_cmdlist,
6360 &maintenance_show_cmdlist);
6362 add_cmd ("symbol-cache", class_maintenance, maintenance_print_symbol_cache,
6363 _("Dump the symbol cache for each program space."),
6364 &maintenanceprintlist);
6366 add_cmd ("symbol-cache-statistics", class_maintenance,
6367 maintenance_print_symbol_cache_statistics,
6368 _("Print symbol cache statistics for each program space."),
6369 &maintenanceprintlist);
6371 add_cmd ("flush-symbol-cache", class_maintenance,
6372 maintenance_flush_symbol_cache,
6373 _("Flush the symbol cache for each program space."),
6376 observer_attach_executable_changed (symtab_observer_executable_changed);
6377 observer_attach_new_objfile (symtab_new_objfile_observer);
6378 observer_attach_free_objfile (symtab_free_objfile_observer);