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 = (struct symtab **) 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 const char *const_prefix = method->is_const ? "C" : "";
519 const 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.demangled_name = name;
603 gsymbol->language_specific.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.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
667 = (const struct demangled_name_entry *) data;
669 return htab_hash_string (e->mangled);
672 /* Equality function for the demangled name hash. */
675 eq_demangled_name_entry (const void *a, const void *b)
677 const struct demangled_name_entry *da
678 = (const struct demangled_name_entry *) a;
679 const struct demangled_name_entry *db
680 = (const struct demangled_name_entry *) b;
682 return strcmp (da->mangled, db->mangled) == 0;
685 /* Create the hash table used for demangled names. Each hash entry is
686 a pair of strings; one for the mangled name and one for the demangled
687 name. The entry is hashed via just the mangled name. */
690 create_demangled_names_hash (struct objfile *objfile)
692 /* Choose 256 as the starting size of the hash table, somewhat arbitrarily.
693 The hash table code will round this up to the next prime number.
694 Choosing a much larger table size wastes memory, and saves only about
695 1% in symbol reading. */
697 objfile->per_bfd->demangled_names_hash = htab_create_alloc
698 (256, hash_demangled_name_entry, eq_demangled_name_entry,
699 NULL, xcalloc, xfree);
702 /* Try to determine the demangled name for a symbol, based on the
703 language of that symbol. If the language is set to language_auto,
704 it will attempt to find any demangling algorithm that works and
705 then set the language appropriately. The returned name is allocated
706 by the demangler and should be xfree'd. */
709 symbol_find_demangled_name (struct general_symbol_info *gsymbol,
712 char *demangled = NULL;
714 if (gsymbol->language == language_unknown)
715 gsymbol->language = language_auto;
717 if (gsymbol->language == language_objc
718 || gsymbol->language == language_auto)
721 objc_demangle (mangled, 0);
722 if (demangled != NULL)
724 gsymbol->language = language_objc;
728 if (gsymbol->language == language_cplus
729 || gsymbol->language == language_auto)
732 gdb_demangle (mangled, DMGL_PARAMS | DMGL_ANSI);
733 if (demangled != NULL)
735 gsymbol->language = language_cplus;
739 if (gsymbol->language == language_java)
742 gdb_demangle (mangled,
743 DMGL_PARAMS | DMGL_ANSI | DMGL_JAVA);
744 if (demangled != NULL)
746 gsymbol->language = language_java;
750 if (gsymbol->language == language_d
751 || gsymbol->language == language_auto)
753 demangled = d_demangle(mangled, 0);
754 if (demangled != NULL)
756 gsymbol->language = language_d;
760 /* FIXME(dje): Continually adding languages here is clumsy.
761 Better to just call la_demangle if !auto, and if auto then call
762 a utility routine that tries successive languages in turn and reports
763 which one it finds. I realize the la_demangle options may be different
764 for different languages but there's already a FIXME for that. */
765 if (gsymbol->language == language_go
766 || gsymbol->language == language_auto)
768 demangled = go_demangle (mangled, 0);
769 if (demangled != NULL)
771 gsymbol->language = language_go;
776 /* We could support `gsymbol->language == language_fortran' here to provide
777 module namespaces also for inferiors with only minimal symbol table (ELF
778 symbols). Just the mangling standard is not standardized across compilers
779 and there is no DW_AT_producer available for inferiors with only the ELF
780 symbols to check the mangling kind. */
782 /* Check for Ada symbols last. See comment below explaining why. */
784 if (gsymbol->language == language_auto)
786 const char *demangled = ada_decode (mangled);
788 if (demangled != mangled && demangled != NULL && demangled[0] != '<')
790 /* Set the gsymbol language to Ada, but still return NULL.
791 Two reasons for that:
793 1. For Ada, we prefer computing the symbol's decoded name
794 on the fly rather than pre-compute it, in order to save
795 memory (Ada projects are typically very large).
797 2. There are some areas in the definition of the GNAT
798 encoding where, with a bit of bad luck, we might be able
799 to decode a non-Ada symbol, generating an incorrect
800 demangled name (Eg: names ending with "TB" for instance
801 are identified as task bodies and so stripped from
802 the decoded name returned).
804 Returning NULL, here, helps us get a little bit of
805 the best of both worlds. Because we're last, we should
806 not affect any of the other languages that were able to
807 demangle the symbol before us; we get to correctly tag
808 Ada symbols as such; and even if we incorrectly tagged
809 a non-Ada symbol, which should be rare, any routing
810 through the Ada language should be transparent (Ada
811 tries to behave much like C/C++ with non-Ada symbols). */
812 gsymbol->language = language_ada;
820 /* Set both the mangled and demangled (if any) names for GSYMBOL based
821 on LINKAGE_NAME and LEN. Ordinarily, NAME is copied onto the
822 objfile's obstack; but if COPY_NAME is 0 and if NAME is
823 NUL-terminated, then this function assumes that NAME is already
824 correctly saved (either permanently or with a lifetime tied to the
825 objfile), and it will not be copied.
827 The hash table corresponding to OBJFILE is used, and the memory
828 comes from the per-BFD storage_obstack. LINKAGE_NAME is copied,
829 so the pointer can be discarded after calling this function. */
831 /* We have to be careful when dealing with Java names: when we run
832 into a Java minimal symbol, we don't know it's a Java symbol, so it
833 gets demangled as a C++ name. This is unfortunate, but there's not
834 much we can do about it: but when demangling partial symbols and
835 regular symbols, we'd better not reuse the wrong demangled name.
836 (See PR gdb/1039.) We solve this by putting a distinctive prefix
837 on Java names when storing them in the hash table. */
839 /* FIXME: carlton/2003-03-13: This is an unfortunate situation. I
840 don't mind the Java prefix so much: different languages have
841 different demangling requirements, so it's only natural that we
842 need to keep language data around in our demangling cache. But
843 it's not good that the minimal symbol has the wrong demangled name.
844 Unfortunately, I can't think of any easy solution to that
847 #define JAVA_PREFIX "##JAVA$$"
848 #define JAVA_PREFIX_LEN 8
851 symbol_set_names (struct general_symbol_info *gsymbol,
852 const char *linkage_name, int len, int copy_name,
853 struct objfile *objfile)
855 struct demangled_name_entry **slot;
856 /* A 0-terminated copy of the linkage name. */
857 const char *linkage_name_copy;
858 /* A copy of the linkage name that might have a special Java prefix
859 added to it, for use when looking names up in the hash table. */
860 const char *lookup_name;
861 /* The length of lookup_name. */
863 struct demangled_name_entry entry;
864 struct objfile_per_bfd_storage *per_bfd = objfile->per_bfd;
866 if (gsymbol->language == language_ada)
868 /* In Ada, we do the symbol lookups using the mangled name, so
869 we can save some space by not storing the demangled name.
871 As a side note, we have also observed some overlap between
872 the C++ mangling and Ada mangling, similarly to what has
873 been observed with Java. Because we don't store the demangled
874 name with the symbol, we don't need to use the same trick
877 gsymbol->name = linkage_name;
880 char *name = (char *) obstack_alloc (&per_bfd->storage_obstack,
883 memcpy (name, linkage_name, len);
885 gsymbol->name = name;
887 symbol_set_demangled_name (gsymbol, NULL, &per_bfd->storage_obstack);
892 if (per_bfd->demangled_names_hash == NULL)
893 create_demangled_names_hash (objfile);
895 /* The stabs reader generally provides names that are not
896 NUL-terminated; most of the other readers don't do this, so we
897 can just use the given copy, unless we're in the Java case. */
898 if (gsymbol->language == language_java)
902 lookup_len = len + JAVA_PREFIX_LEN;
903 alloc_name = (char *) alloca (lookup_len + 1);
904 memcpy (alloc_name, JAVA_PREFIX, JAVA_PREFIX_LEN);
905 memcpy (alloc_name + JAVA_PREFIX_LEN, linkage_name, len);
906 alloc_name[lookup_len] = '\0';
908 lookup_name = alloc_name;
909 linkage_name_copy = alloc_name + JAVA_PREFIX_LEN;
911 else if (linkage_name[len] != '\0')
916 alloc_name = (char *) alloca (lookup_len + 1);
917 memcpy (alloc_name, linkage_name, len);
918 alloc_name[lookup_len] = '\0';
920 lookup_name = alloc_name;
921 linkage_name_copy = alloc_name;
926 lookup_name = linkage_name;
927 linkage_name_copy = linkage_name;
930 entry.mangled = lookup_name;
931 slot = ((struct demangled_name_entry **)
932 htab_find_slot (per_bfd->demangled_names_hash,
935 /* If this name is not in the hash table, add it. */
937 /* A C version of the symbol may have already snuck into the table.
938 This happens to, e.g., main.init (__go_init_main). Cope. */
939 || (gsymbol->language == language_go
940 && (*slot)->demangled[0] == '\0'))
942 char *demangled_name = symbol_find_demangled_name (gsymbol,
944 int demangled_len = demangled_name ? strlen (demangled_name) : 0;
946 /* Suppose we have demangled_name==NULL, copy_name==0, and
947 lookup_name==linkage_name. In this case, we already have the
948 mangled name saved, and we don't have a demangled name. So,
949 you might think we could save a little space by not recording
950 this in the hash table at all.
952 It turns out that it is actually important to still save such
953 an entry in the hash table, because storing this name gives
954 us better bcache hit rates for partial symbols. */
955 if (!copy_name && lookup_name == linkage_name)
958 = ((struct demangled_name_entry *)
959 obstack_alloc (&per_bfd->storage_obstack,
960 offsetof (struct demangled_name_entry, demangled)
961 + demangled_len + 1));
962 (*slot)->mangled = lookup_name;
968 /* If we must copy the mangled name, put it directly after
969 the demangled name so we can have a single
972 = ((struct demangled_name_entry *)
973 obstack_alloc (&per_bfd->storage_obstack,
974 offsetof (struct demangled_name_entry, demangled)
975 + lookup_len + demangled_len + 2));
976 mangled_ptr = &((*slot)->demangled[demangled_len + 1]);
977 strcpy (mangled_ptr, lookup_name);
978 (*slot)->mangled = mangled_ptr;
981 if (demangled_name != NULL)
983 strcpy ((*slot)->demangled, demangled_name);
984 xfree (demangled_name);
987 (*slot)->demangled[0] = '\0';
990 gsymbol->name = (*slot)->mangled + lookup_len - len;
991 if ((*slot)->demangled[0] != '\0')
992 symbol_set_demangled_name (gsymbol, (*slot)->demangled,
993 &per_bfd->storage_obstack);
995 symbol_set_demangled_name (gsymbol, NULL, &per_bfd->storage_obstack);
998 /* Return the source code name of a symbol. In languages where
999 demangling is necessary, this is the demangled name. */
1002 symbol_natural_name (const struct general_symbol_info *gsymbol)
1004 switch (gsymbol->language)
1006 case language_cplus:
1011 case language_fortran:
1012 if (symbol_get_demangled_name (gsymbol) != NULL)
1013 return symbol_get_demangled_name (gsymbol);
1016 return ada_decode_symbol (gsymbol);
1020 return gsymbol->name;
1023 /* Return the demangled name for a symbol based on the language for
1024 that symbol. If no demangled name exists, return NULL. */
1027 symbol_demangled_name (const struct general_symbol_info *gsymbol)
1029 const char *dem_name = NULL;
1031 switch (gsymbol->language)
1033 case language_cplus:
1038 case language_fortran:
1039 dem_name = symbol_get_demangled_name (gsymbol);
1042 dem_name = ada_decode_symbol (gsymbol);
1050 /* Return the search name of a symbol---generally the demangled or
1051 linkage name of the symbol, depending on how it will be searched for.
1052 If there is no distinct demangled name, then returns the same value
1053 (same pointer) as SYMBOL_LINKAGE_NAME. */
1056 symbol_search_name (const struct general_symbol_info *gsymbol)
1058 if (gsymbol->language == language_ada)
1059 return gsymbol->name;
1061 return symbol_natural_name (gsymbol);
1064 /* Initialize the structure fields to zero values. */
1067 init_sal (struct symtab_and_line *sal)
1069 memset (sal, 0, sizeof (*sal));
1073 /* Return 1 if the two sections are the same, or if they could
1074 plausibly be copies of each other, one in an original object
1075 file and another in a separated debug file. */
1078 matching_obj_sections (struct obj_section *obj_first,
1079 struct obj_section *obj_second)
1081 asection *first = obj_first? obj_first->the_bfd_section : NULL;
1082 asection *second = obj_second? obj_second->the_bfd_section : NULL;
1083 struct objfile *obj;
1085 /* If they're the same section, then they match. */
1086 if (first == second)
1089 /* If either is NULL, give up. */
1090 if (first == NULL || second == NULL)
1093 /* This doesn't apply to absolute symbols. */
1094 if (first->owner == NULL || second->owner == NULL)
1097 /* If they're in the same object file, they must be different sections. */
1098 if (first->owner == second->owner)
1101 /* Check whether the two sections are potentially corresponding. They must
1102 have the same size, address, and name. We can't compare section indexes,
1103 which would be more reliable, because some sections may have been
1105 if (bfd_get_section_size (first) != bfd_get_section_size (second))
1108 /* In-memory addresses may start at a different offset, relativize them. */
1109 if (bfd_get_section_vma (first->owner, first)
1110 - bfd_get_start_address (first->owner)
1111 != bfd_get_section_vma (second->owner, second)
1112 - bfd_get_start_address (second->owner))
1115 if (bfd_get_section_name (first->owner, first) == NULL
1116 || bfd_get_section_name (second->owner, second) == NULL
1117 || strcmp (bfd_get_section_name (first->owner, first),
1118 bfd_get_section_name (second->owner, second)) != 0)
1121 /* Otherwise check that they are in corresponding objfiles. */
1124 if (obj->obfd == first->owner)
1126 gdb_assert (obj != NULL);
1128 if (obj->separate_debug_objfile != NULL
1129 && obj->separate_debug_objfile->obfd == second->owner)
1131 if (obj->separate_debug_objfile_backlink != NULL
1132 && obj->separate_debug_objfile_backlink->obfd == second->owner)
1141 expand_symtab_containing_pc (CORE_ADDR pc, struct obj_section *section)
1143 struct objfile *objfile;
1144 struct bound_minimal_symbol msymbol;
1146 /* If we know that this is not a text address, return failure. This is
1147 necessary because we loop based on texthigh and textlow, which do
1148 not include the data ranges. */
1149 msymbol = lookup_minimal_symbol_by_pc_section (pc, section);
1151 && (MSYMBOL_TYPE (msymbol.minsym) == mst_data
1152 || MSYMBOL_TYPE (msymbol.minsym) == mst_bss
1153 || MSYMBOL_TYPE (msymbol.minsym) == mst_abs
1154 || MSYMBOL_TYPE (msymbol.minsym) == mst_file_data
1155 || MSYMBOL_TYPE (msymbol.minsym) == mst_file_bss))
1158 ALL_OBJFILES (objfile)
1160 struct compunit_symtab *cust = NULL;
1163 cust = objfile->sf->qf->find_pc_sect_compunit_symtab (objfile, msymbol,
1170 /* Hash function for the symbol cache. */
1173 hash_symbol_entry (const struct objfile *objfile_context,
1174 const char *name, domain_enum domain)
1176 unsigned int hash = (uintptr_t) objfile_context;
1179 hash += htab_hash_string (name);
1181 /* Because of symbol_matches_domain we need VAR_DOMAIN and STRUCT_DOMAIN
1182 to map to the same slot. */
1183 if (domain == STRUCT_DOMAIN)
1184 hash += VAR_DOMAIN * 7;
1191 /* Equality function for the symbol cache. */
1194 eq_symbol_entry (const struct symbol_cache_slot *slot,
1195 const struct objfile *objfile_context,
1196 const char *name, domain_enum domain)
1198 const char *slot_name;
1199 domain_enum slot_domain;
1201 if (slot->state == SYMBOL_SLOT_UNUSED)
1204 if (slot->objfile_context != objfile_context)
1207 if (slot->state == SYMBOL_SLOT_NOT_FOUND)
1209 slot_name = slot->value.not_found.name;
1210 slot_domain = slot->value.not_found.domain;
1214 slot_name = SYMBOL_SEARCH_NAME (slot->value.found.symbol);
1215 slot_domain = SYMBOL_DOMAIN (slot->value.found.symbol);
1218 /* NULL names match. */
1219 if (slot_name == NULL && name == NULL)
1221 /* But there's no point in calling symbol_matches_domain in the
1222 SYMBOL_SLOT_FOUND case. */
1223 if (slot_domain != domain)
1226 else if (slot_name != NULL && name != NULL)
1228 /* It's important that we use the same comparison that was done the
1229 first time through. If the slot records a found symbol, then this
1230 means using strcmp_iw on SYMBOL_SEARCH_NAME. See dictionary.c.
1231 It also means using symbol_matches_domain for found symbols.
1234 If the slot records a not-found symbol, then require a precise match.
1235 We could still be lax with whitespace like strcmp_iw though. */
1237 if (slot->state == SYMBOL_SLOT_NOT_FOUND)
1239 if (strcmp (slot_name, name) != 0)
1241 if (slot_domain != domain)
1246 struct symbol *sym = slot->value.found.symbol;
1248 if (strcmp_iw (slot_name, name) != 0)
1250 if (!symbol_matches_domain (SYMBOL_LANGUAGE (sym),
1251 slot_domain, domain))
1257 /* Only one name is NULL. */
1264 /* Given a cache of size SIZE, return the size of the struct (with variable
1265 length array) in bytes. */
1268 symbol_cache_byte_size (unsigned int size)
1270 return (sizeof (struct block_symbol_cache)
1271 + ((size - 1) * sizeof (struct symbol_cache_slot)));
1277 resize_symbol_cache (struct symbol_cache *cache, unsigned int new_size)
1279 /* If there's no change in size, don't do anything.
1280 All caches have the same size, so we can just compare with the size
1281 of the global symbols cache. */
1282 if ((cache->global_symbols != NULL
1283 && cache->global_symbols->size == new_size)
1284 || (cache->global_symbols == NULL
1288 xfree (cache->global_symbols);
1289 xfree (cache->static_symbols);
1293 cache->global_symbols = NULL;
1294 cache->static_symbols = NULL;
1298 size_t total_size = symbol_cache_byte_size (new_size);
1300 cache->global_symbols
1301 = (struct block_symbol_cache *) xcalloc (1, total_size);
1302 cache->static_symbols
1303 = (struct block_symbol_cache *) xcalloc (1, total_size);
1304 cache->global_symbols->size = new_size;
1305 cache->static_symbols->size = new_size;
1309 /* Make a symbol cache of size SIZE. */
1311 static struct symbol_cache *
1312 make_symbol_cache (unsigned int size)
1314 struct symbol_cache *cache;
1316 cache = XCNEW (struct symbol_cache);
1317 resize_symbol_cache (cache, symbol_cache_size);
1321 /* Free the space used by CACHE. */
1324 free_symbol_cache (struct symbol_cache *cache)
1326 xfree (cache->global_symbols);
1327 xfree (cache->static_symbols);
1331 /* Return the symbol cache of PSPACE.
1332 Create one if it doesn't exist yet. */
1334 static struct symbol_cache *
1335 get_symbol_cache (struct program_space *pspace)
1337 struct symbol_cache *cache
1338 = (struct symbol_cache *) program_space_data (pspace, symbol_cache_key);
1342 cache = make_symbol_cache (symbol_cache_size);
1343 set_program_space_data (pspace, symbol_cache_key, cache);
1349 /* Delete the symbol cache of PSPACE.
1350 Called when PSPACE is destroyed. */
1353 symbol_cache_cleanup (struct program_space *pspace, void *data)
1355 struct symbol_cache *cache = (struct symbol_cache *) data;
1357 free_symbol_cache (cache);
1360 /* Set the size of the symbol cache in all program spaces. */
1363 set_symbol_cache_size (unsigned int new_size)
1365 struct program_space *pspace;
1367 ALL_PSPACES (pspace)
1369 struct symbol_cache *cache
1370 = (struct symbol_cache *) program_space_data (pspace, symbol_cache_key);
1372 /* The pspace could have been created but not have a cache yet. */
1374 resize_symbol_cache (cache, new_size);
1378 /* Called when symbol-cache-size is set. */
1381 set_symbol_cache_size_handler (char *args, int from_tty,
1382 struct cmd_list_element *c)
1384 if (new_symbol_cache_size > MAX_SYMBOL_CACHE_SIZE)
1386 /* Restore the previous value.
1387 This is the value the "show" command prints. */
1388 new_symbol_cache_size = symbol_cache_size;
1390 error (_("Symbol cache size is too large, max is %u."),
1391 MAX_SYMBOL_CACHE_SIZE);
1393 symbol_cache_size = new_symbol_cache_size;
1395 set_symbol_cache_size (symbol_cache_size);
1398 /* Lookup symbol NAME,DOMAIN in BLOCK in the symbol cache of PSPACE.
1399 OBJFILE_CONTEXT is the current objfile, which may be NULL.
1400 The result is the symbol if found, SYMBOL_LOOKUP_FAILED if a previous lookup
1401 failed (and thus this one will too), or NULL if the symbol is not present
1403 If the symbol is not present in the cache, then *BSC_PTR and *SLOT_PTR are
1404 set to the cache and slot of the symbol to save the result of a full lookup
1407 static struct block_symbol
1408 symbol_cache_lookup (struct symbol_cache *cache,
1409 struct objfile *objfile_context, int block,
1410 const char *name, domain_enum domain,
1411 struct block_symbol_cache **bsc_ptr,
1412 struct symbol_cache_slot **slot_ptr)
1414 struct block_symbol_cache *bsc;
1416 struct symbol_cache_slot *slot;
1418 if (block == GLOBAL_BLOCK)
1419 bsc = cache->global_symbols;
1421 bsc = cache->static_symbols;
1426 return (struct block_symbol) {NULL, NULL};
1429 hash = hash_symbol_entry (objfile_context, name, domain);
1430 slot = bsc->symbols + hash % bsc->size;
1432 if (eq_symbol_entry (slot, objfile_context, name, domain))
1434 if (symbol_lookup_debug)
1435 fprintf_unfiltered (gdb_stdlog,
1436 "%s block symbol cache hit%s for %s, %s\n",
1437 block == GLOBAL_BLOCK ? "Global" : "Static",
1438 slot->state == SYMBOL_SLOT_NOT_FOUND
1439 ? " (not found)" : "",
1440 name, domain_name (domain));
1442 if (slot->state == SYMBOL_SLOT_NOT_FOUND)
1443 return SYMBOL_LOOKUP_FAILED;
1444 return slot->value.found;
1447 /* Symbol is not present in the cache. */
1452 if (symbol_lookup_debug)
1454 fprintf_unfiltered (gdb_stdlog,
1455 "%s block symbol cache miss for %s, %s\n",
1456 block == GLOBAL_BLOCK ? "Global" : "Static",
1457 name, domain_name (domain));
1460 return (struct block_symbol) {NULL, NULL};
1463 /* Clear out SLOT. */
1466 symbol_cache_clear_slot (struct symbol_cache_slot *slot)
1468 if (slot->state == SYMBOL_SLOT_NOT_FOUND)
1469 xfree (slot->value.not_found.name);
1470 slot->state = SYMBOL_SLOT_UNUSED;
1473 /* Mark SYMBOL as found in SLOT.
1474 OBJFILE_CONTEXT is the current objfile when the lookup was done, or NULL
1475 if it's not needed to distinguish lookups (STATIC_BLOCK). It is *not*
1476 necessarily the objfile the symbol was found in. */
1479 symbol_cache_mark_found (struct block_symbol_cache *bsc,
1480 struct symbol_cache_slot *slot,
1481 struct objfile *objfile_context,
1482 struct symbol *symbol,
1483 const struct block *block)
1487 if (slot->state != SYMBOL_SLOT_UNUSED)
1490 symbol_cache_clear_slot (slot);
1492 slot->state = SYMBOL_SLOT_FOUND;
1493 slot->objfile_context = objfile_context;
1494 slot->value.found.symbol = symbol;
1495 slot->value.found.block = block;
1498 /* Mark symbol NAME, DOMAIN as not found in SLOT.
1499 OBJFILE_CONTEXT is the current objfile when the lookup was done, or NULL
1500 if it's not needed to distinguish lookups (STATIC_BLOCK). */
1503 symbol_cache_mark_not_found (struct block_symbol_cache *bsc,
1504 struct symbol_cache_slot *slot,
1505 struct objfile *objfile_context,
1506 const char *name, domain_enum domain)
1510 if (slot->state != SYMBOL_SLOT_UNUSED)
1513 symbol_cache_clear_slot (slot);
1515 slot->state = SYMBOL_SLOT_NOT_FOUND;
1516 slot->objfile_context = objfile_context;
1517 slot->value.not_found.name = xstrdup (name);
1518 slot->value.not_found.domain = domain;
1521 /* Flush the symbol cache of PSPACE. */
1524 symbol_cache_flush (struct program_space *pspace)
1526 struct symbol_cache *cache
1527 = (struct symbol_cache *) program_space_data (pspace, symbol_cache_key);
1533 if (cache->global_symbols == NULL)
1535 gdb_assert (symbol_cache_size == 0);
1536 gdb_assert (cache->static_symbols == NULL);
1540 /* If the cache is untouched since the last flush, early exit.
1541 This is important for performance during the startup of a program linked
1542 with 100s (or 1000s) of shared libraries. */
1543 if (cache->global_symbols->misses == 0
1544 && cache->static_symbols->misses == 0)
1547 gdb_assert (cache->global_symbols->size == symbol_cache_size);
1548 gdb_assert (cache->static_symbols->size == symbol_cache_size);
1550 for (pass = 0; pass < 2; ++pass)
1552 struct block_symbol_cache *bsc
1553 = pass == 0 ? cache->global_symbols : cache->static_symbols;
1556 for (i = 0; i < bsc->size; ++i)
1557 symbol_cache_clear_slot (&bsc->symbols[i]);
1560 cache->global_symbols->hits = 0;
1561 cache->global_symbols->misses = 0;
1562 cache->global_symbols->collisions = 0;
1563 cache->static_symbols->hits = 0;
1564 cache->static_symbols->misses = 0;
1565 cache->static_symbols->collisions = 0;
1571 symbol_cache_dump (const struct symbol_cache *cache)
1575 if (cache->global_symbols == NULL)
1577 printf_filtered (" <disabled>\n");
1581 for (pass = 0; pass < 2; ++pass)
1583 const struct block_symbol_cache *bsc
1584 = pass == 0 ? cache->global_symbols : cache->static_symbols;
1588 printf_filtered ("Global symbols:\n");
1590 printf_filtered ("Static symbols:\n");
1592 for (i = 0; i < bsc->size; ++i)
1594 const struct symbol_cache_slot *slot = &bsc->symbols[i];
1598 switch (slot->state)
1600 case SYMBOL_SLOT_UNUSED:
1602 case SYMBOL_SLOT_NOT_FOUND:
1603 printf_filtered (" [%4u] = %s, %s %s (not found)\n", i,
1604 host_address_to_string (slot->objfile_context),
1605 slot->value.not_found.name,
1606 domain_name (slot->value.not_found.domain));
1608 case SYMBOL_SLOT_FOUND:
1610 struct symbol *found = slot->value.found.symbol;
1611 const struct objfile *context = slot->objfile_context;
1613 printf_filtered (" [%4u] = %s, %s %s\n", i,
1614 host_address_to_string (context),
1615 SYMBOL_PRINT_NAME (found),
1616 domain_name (SYMBOL_DOMAIN (found)));
1624 /* The "mt print symbol-cache" command. */
1627 maintenance_print_symbol_cache (char *args, int from_tty)
1629 struct program_space *pspace;
1631 ALL_PSPACES (pspace)
1633 struct symbol_cache *cache;
1635 printf_filtered (_("Symbol cache for pspace %d\n%s:\n"),
1637 pspace->symfile_object_file != NULL
1638 ? objfile_name (pspace->symfile_object_file)
1639 : "(no object file)");
1641 /* If the cache hasn't been created yet, avoid creating one. */
1643 = (struct symbol_cache *) program_space_data (pspace, symbol_cache_key);
1645 printf_filtered (" <empty>\n");
1647 symbol_cache_dump (cache);
1651 /* The "mt flush-symbol-cache" command. */
1654 maintenance_flush_symbol_cache (char *args, int from_tty)
1656 struct program_space *pspace;
1658 ALL_PSPACES (pspace)
1660 symbol_cache_flush (pspace);
1664 /* Print usage statistics of CACHE. */
1667 symbol_cache_stats (struct symbol_cache *cache)
1671 if (cache->global_symbols == NULL)
1673 printf_filtered (" <disabled>\n");
1677 for (pass = 0; pass < 2; ++pass)
1679 const struct block_symbol_cache *bsc
1680 = pass == 0 ? cache->global_symbols : cache->static_symbols;
1685 printf_filtered ("Global block cache stats:\n");
1687 printf_filtered ("Static block cache stats:\n");
1689 printf_filtered (" size: %u\n", bsc->size);
1690 printf_filtered (" hits: %u\n", bsc->hits);
1691 printf_filtered (" misses: %u\n", bsc->misses);
1692 printf_filtered (" collisions: %u\n", bsc->collisions);
1696 /* The "mt print symbol-cache-statistics" command. */
1699 maintenance_print_symbol_cache_statistics (char *args, int from_tty)
1701 struct program_space *pspace;
1703 ALL_PSPACES (pspace)
1705 struct symbol_cache *cache;
1707 printf_filtered (_("Symbol cache statistics for pspace %d\n%s:\n"),
1709 pspace->symfile_object_file != NULL
1710 ? objfile_name (pspace->symfile_object_file)
1711 : "(no object file)");
1713 /* If the cache hasn't been created yet, avoid creating one. */
1715 = (struct symbol_cache *) program_space_data (pspace, symbol_cache_key);
1717 printf_filtered (" empty, no stats available\n");
1719 symbol_cache_stats (cache);
1723 /* This module's 'new_objfile' observer. */
1726 symtab_new_objfile_observer (struct objfile *objfile)
1728 /* Ideally we'd use OBJFILE->pspace, but OBJFILE may be NULL. */
1729 symbol_cache_flush (current_program_space);
1732 /* This module's 'free_objfile' observer. */
1735 symtab_free_objfile_observer (struct objfile *objfile)
1737 symbol_cache_flush (objfile->pspace);
1740 /* Debug symbols usually don't have section information. We need to dig that
1741 out of the minimal symbols and stash that in the debug symbol. */
1744 fixup_section (struct general_symbol_info *ginfo,
1745 CORE_ADDR addr, struct objfile *objfile)
1747 struct minimal_symbol *msym;
1749 /* First, check whether a minimal symbol with the same name exists
1750 and points to the same address. The address check is required
1751 e.g. on PowerPC64, where the minimal symbol for a function will
1752 point to the function descriptor, while the debug symbol will
1753 point to the actual function code. */
1754 msym = lookup_minimal_symbol_by_pc_name (addr, ginfo->name, objfile);
1756 ginfo->section = MSYMBOL_SECTION (msym);
1759 /* Static, function-local variables do appear in the linker
1760 (minimal) symbols, but are frequently given names that won't
1761 be found via lookup_minimal_symbol(). E.g., it has been
1762 observed in frv-uclinux (ELF) executables that a static,
1763 function-local variable named "foo" might appear in the
1764 linker symbols as "foo.6" or "foo.3". Thus, there is no
1765 point in attempting to extend the lookup-by-name mechanism to
1766 handle this case due to the fact that there can be multiple
1769 So, instead, search the section table when lookup by name has
1770 failed. The ``addr'' and ``endaddr'' fields may have already
1771 been relocated. If so, the relocation offset (i.e. the
1772 ANOFFSET value) needs to be subtracted from these values when
1773 performing the comparison. We unconditionally subtract it,
1774 because, when no relocation has been performed, the ANOFFSET
1775 value will simply be zero.
1777 The address of the symbol whose section we're fixing up HAS
1778 NOT BEEN adjusted (relocated) yet. It can't have been since
1779 the section isn't yet known and knowing the section is
1780 necessary in order to add the correct relocation value. In
1781 other words, we wouldn't even be in this function (attempting
1782 to compute the section) if it were already known.
1784 Note that it is possible to search the minimal symbols
1785 (subtracting the relocation value if necessary) to find the
1786 matching minimal symbol, but this is overkill and much less
1787 efficient. It is not necessary to find the matching minimal
1788 symbol, only its section.
1790 Note that this technique (of doing a section table search)
1791 can fail when unrelocated section addresses overlap. For
1792 this reason, we still attempt a lookup by name prior to doing
1793 a search of the section table. */
1795 struct obj_section *s;
1798 ALL_OBJFILE_OSECTIONS (objfile, s)
1800 int idx = s - objfile->sections;
1801 CORE_ADDR offset = ANOFFSET (objfile->section_offsets, idx);
1806 if (obj_section_addr (s) - offset <= addr
1807 && addr < obj_section_endaddr (s) - offset)
1809 ginfo->section = idx;
1814 /* If we didn't find the section, assume it is in the first
1815 section. If there is no allocated section, then it hardly
1816 matters what we pick, so just pick zero. */
1820 ginfo->section = fallback;
1825 fixup_symbol_section (struct symbol *sym, struct objfile *objfile)
1832 if (!SYMBOL_OBJFILE_OWNED (sym))
1835 /* We either have an OBJFILE, or we can get at it from the sym's
1836 symtab. Anything else is a bug. */
1837 gdb_assert (objfile || symbol_symtab (sym));
1839 if (objfile == NULL)
1840 objfile = symbol_objfile (sym);
1842 if (SYMBOL_OBJ_SECTION (objfile, sym))
1845 /* We should have an objfile by now. */
1846 gdb_assert (objfile);
1848 switch (SYMBOL_CLASS (sym))
1852 addr = SYMBOL_VALUE_ADDRESS (sym);
1855 addr = BLOCK_START (SYMBOL_BLOCK_VALUE (sym));
1859 /* Nothing else will be listed in the minsyms -- no use looking
1864 fixup_section (&sym->ginfo, addr, objfile);
1869 /* Compute the demangled form of NAME as used by the various symbol
1870 lookup functions. The result is stored in *RESULT_NAME. Returns a
1871 cleanup which can be used to clean up the result.
1873 For Ada, this function just sets *RESULT_NAME to NAME, unmodified.
1874 Normally, Ada symbol lookups are performed using the encoded name
1875 rather than the demangled name, and so it might seem to make sense
1876 for this function to return an encoded version of NAME.
1877 Unfortunately, we cannot do this, because this function is used in
1878 circumstances where it is not appropriate to try to encode NAME.
1879 For instance, when displaying the frame info, we demangle the name
1880 of each parameter, and then perform a symbol lookup inside our
1881 function using that demangled name. In Ada, certain functions
1882 have internally-generated parameters whose name contain uppercase
1883 characters. Encoding those name would result in those uppercase
1884 characters to become lowercase, and thus cause the symbol lookup
1888 demangle_for_lookup (const char *name, enum language lang,
1889 const char **result_name)
1891 char *demangled_name = NULL;
1892 const char *modified_name = NULL;
1893 struct cleanup *cleanup = make_cleanup (null_cleanup, 0);
1895 modified_name = name;
1897 /* If we are using C++, D, Go, or Java, demangle the name before doing a
1898 lookup, so we can always binary search. */
1899 if (lang == language_cplus)
1901 demangled_name = gdb_demangle (name, DMGL_ANSI | DMGL_PARAMS);
1904 modified_name = demangled_name;
1905 make_cleanup (xfree, demangled_name);
1909 /* If we were given a non-mangled name, canonicalize it
1910 according to the language (so far only for C++). */
1911 demangled_name = cp_canonicalize_string (name);
1914 modified_name = demangled_name;
1915 make_cleanup (xfree, demangled_name);
1919 else if (lang == language_java)
1921 demangled_name = gdb_demangle (name,
1922 DMGL_ANSI | DMGL_PARAMS | DMGL_JAVA);
1925 modified_name = demangled_name;
1926 make_cleanup (xfree, demangled_name);
1929 else if (lang == language_d)
1931 demangled_name = d_demangle (name, 0);
1934 modified_name = demangled_name;
1935 make_cleanup (xfree, demangled_name);
1938 else if (lang == language_go)
1940 demangled_name = go_demangle (name, 0);
1943 modified_name = demangled_name;
1944 make_cleanup (xfree, demangled_name);
1948 *result_name = modified_name;
1954 This function (or rather its subordinates) have a bunch of loops and
1955 it would seem to be attractive to put in some QUIT's (though I'm not really
1956 sure whether it can run long enough to be really important). But there
1957 are a few calls for which it would appear to be bad news to quit
1958 out of here: e.g., find_proc_desc in alpha-mdebug-tdep.c. (Note
1959 that there is C++ code below which can error(), but that probably
1960 doesn't affect these calls since they are looking for a known
1961 variable and thus can probably assume it will never hit the C++
1965 lookup_symbol_in_language (const char *name, const struct block *block,
1966 const domain_enum domain, enum language lang,
1967 struct field_of_this_result *is_a_field_of_this)
1969 const char *modified_name;
1970 struct block_symbol returnval;
1971 struct cleanup *cleanup = demangle_for_lookup (name, lang, &modified_name);
1973 returnval = lookup_symbol_aux (modified_name, block, domain, lang,
1974 is_a_field_of_this);
1975 do_cleanups (cleanup);
1983 lookup_symbol (const char *name, const struct block *block,
1985 struct field_of_this_result *is_a_field_of_this)
1987 return lookup_symbol_in_language (name, block, domain,
1988 current_language->la_language,
1989 is_a_field_of_this);
1995 lookup_language_this (const struct language_defn *lang,
1996 const struct block *block)
1998 if (lang->la_name_of_this == NULL || block == NULL)
1999 return (struct block_symbol) {NULL, NULL};
2001 if (symbol_lookup_debug > 1)
2003 struct objfile *objfile = lookup_objfile_from_block (block);
2005 fprintf_unfiltered (gdb_stdlog,
2006 "lookup_language_this (%s, %s (objfile %s))",
2007 lang->la_name, host_address_to_string (block),
2008 objfile_debug_name (objfile));
2015 sym = block_lookup_symbol (block, lang->la_name_of_this, VAR_DOMAIN);
2018 if (symbol_lookup_debug > 1)
2020 fprintf_unfiltered (gdb_stdlog, " = %s (%s, block %s)\n",
2021 SYMBOL_PRINT_NAME (sym),
2022 host_address_to_string (sym),
2023 host_address_to_string (block));
2025 return (struct block_symbol) {sym, block};
2027 if (BLOCK_FUNCTION (block))
2029 block = BLOCK_SUPERBLOCK (block);
2032 if (symbol_lookup_debug > 1)
2033 fprintf_unfiltered (gdb_stdlog, " = NULL\n");
2034 return (struct block_symbol) {NULL, NULL};
2037 /* Given TYPE, a structure/union,
2038 return 1 if the component named NAME from the ultimate target
2039 structure/union is defined, otherwise, return 0. */
2042 check_field (struct type *type, const char *name,
2043 struct field_of_this_result *is_a_field_of_this)
2047 /* The type may be a stub. */
2048 type = check_typedef (type);
2050 for (i = TYPE_NFIELDS (type) - 1; i >= TYPE_N_BASECLASSES (type); i--)
2052 const char *t_field_name = TYPE_FIELD_NAME (type, i);
2054 if (t_field_name && (strcmp_iw (t_field_name, name) == 0))
2056 is_a_field_of_this->type = type;
2057 is_a_field_of_this->field = &TYPE_FIELD (type, i);
2062 /* C++: If it was not found as a data field, then try to return it
2063 as a pointer to a method. */
2065 for (i = TYPE_NFN_FIELDS (type) - 1; i >= 0; --i)
2067 if (strcmp_iw (TYPE_FN_FIELDLIST_NAME (type, i), name) == 0)
2069 is_a_field_of_this->type = type;
2070 is_a_field_of_this->fn_field = &TYPE_FN_FIELDLIST (type, i);
2075 for (i = TYPE_N_BASECLASSES (type) - 1; i >= 0; i--)
2076 if (check_field (TYPE_BASECLASS (type, i), name, is_a_field_of_this))
2082 /* Behave like lookup_symbol except that NAME is the natural name
2083 (e.g., demangled name) of the symbol that we're looking for. */
2085 static struct block_symbol
2086 lookup_symbol_aux (const char *name, const struct block *block,
2087 const domain_enum domain, enum language language,
2088 struct field_of_this_result *is_a_field_of_this)
2090 struct block_symbol result;
2091 const struct language_defn *langdef;
2093 if (symbol_lookup_debug)
2095 struct objfile *objfile = lookup_objfile_from_block (block);
2097 fprintf_unfiltered (gdb_stdlog,
2098 "lookup_symbol_aux (%s, %s (objfile %s), %s, %s)\n",
2099 name, host_address_to_string (block),
2101 ? objfile_debug_name (objfile) : "NULL",
2102 domain_name (domain), language_str (language));
2105 /* Make sure we do something sensible with is_a_field_of_this, since
2106 the callers that set this parameter to some non-null value will
2107 certainly use it later. If we don't set it, the contents of
2108 is_a_field_of_this are undefined. */
2109 if (is_a_field_of_this != NULL)
2110 memset (is_a_field_of_this, 0, sizeof (*is_a_field_of_this));
2112 /* Search specified block and its superiors. Don't search
2113 STATIC_BLOCK or GLOBAL_BLOCK. */
2115 result = lookup_local_symbol (name, block, domain, language);
2116 if (result.symbol != NULL)
2118 if (symbol_lookup_debug)
2120 fprintf_unfiltered (gdb_stdlog, "lookup_symbol_aux (...) = %s\n",
2121 host_address_to_string (result.symbol));
2126 /* If requested to do so by the caller and if appropriate for LANGUAGE,
2127 check to see if NAME is a field of `this'. */
2129 langdef = language_def (language);
2131 /* Don't do this check if we are searching for a struct. It will
2132 not be found by check_field, but will be found by other
2134 if (is_a_field_of_this != NULL && domain != STRUCT_DOMAIN)
2136 result = lookup_language_this (langdef, block);
2140 struct type *t = result.symbol->type;
2142 /* I'm not really sure that type of this can ever
2143 be typedefed; just be safe. */
2144 t = check_typedef (t);
2145 if (TYPE_CODE (t) == TYPE_CODE_PTR
2146 || TYPE_CODE (t) == TYPE_CODE_REF)
2147 t = TYPE_TARGET_TYPE (t);
2149 if (TYPE_CODE (t) != TYPE_CODE_STRUCT
2150 && TYPE_CODE (t) != TYPE_CODE_UNION)
2151 error (_("Internal error: `%s' is not an aggregate"),
2152 langdef->la_name_of_this);
2154 if (check_field (t, name, is_a_field_of_this))
2156 if (symbol_lookup_debug)
2158 fprintf_unfiltered (gdb_stdlog,
2159 "lookup_symbol_aux (...) = NULL\n");
2161 return (struct block_symbol) {NULL, NULL};
2166 /* Now do whatever is appropriate for LANGUAGE to look
2167 up static and global variables. */
2169 result = langdef->la_lookup_symbol_nonlocal (langdef, name, block, domain);
2170 if (result.symbol != NULL)
2172 if (symbol_lookup_debug)
2174 fprintf_unfiltered (gdb_stdlog, "lookup_symbol_aux (...) = %s\n",
2175 host_address_to_string (result.symbol));
2180 /* Now search all static file-level symbols. Not strictly correct,
2181 but more useful than an error. */
2183 result = lookup_static_symbol (name, domain);
2184 if (symbol_lookup_debug)
2186 fprintf_unfiltered (gdb_stdlog, "lookup_symbol_aux (...) = %s\n",
2187 result.symbol != NULL
2188 ? host_address_to_string (result.symbol)
2194 /* Check to see if the symbol is defined in BLOCK or its superiors.
2195 Don't search STATIC_BLOCK or GLOBAL_BLOCK. */
2197 static struct block_symbol
2198 lookup_local_symbol (const char *name, const struct block *block,
2199 const domain_enum domain,
2200 enum language language)
2203 const struct block *static_block = block_static_block (block);
2204 const char *scope = block_scope (block);
2206 /* Check if either no block is specified or it's a global block. */
2208 if (static_block == NULL)
2209 return (struct block_symbol) {NULL, NULL};
2211 while (block != static_block)
2213 sym = lookup_symbol_in_block (name, block, domain);
2215 return (struct block_symbol) {sym, block};
2217 if (language == language_cplus || language == language_fortran)
2219 struct block_symbol sym
2220 = cp_lookup_symbol_imports_or_template (scope, name, block,
2223 if (sym.symbol != NULL)
2227 if (BLOCK_FUNCTION (block) != NULL && block_inlined_p (block))
2229 block = BLOCK_SUPERBLOCK (block);
2232 /* We've reached the end of the function without finding a result. */
2234 return (struct block_symbol) {NULL, NULL};
2240 lookup_objfile_from_block (const struct block *block)
2242 struct objfile *obj;
2243 struct compunit_symtab *cust;
2248 block = block_global_block (block);
2249 /* Look through all blockvectors. */
2250 ALL_COMPUNITS (obj, cust)
2251 if (block == BLOCKVECTOR_BLOCK (COMPUNIT_BLOCKVECTOR (cust),
2254 if (obj->separate_debug_objfile_backlink)
2255 obj = obj->separate_debug_objfile_backlink;
2266 lookup_symbol_in_block (const char *name, const struct block *block,
2267 const domain_enum domain)
2271 if (symbol_lookup_debug > 1)
2273 struct objfile *objfile = lookup_objfile_from_block (block);
2275 fprintf_unfiltered (gdb_stdlog,
2276 "lookup_symbol_in_block (%s, %s (objfile %s), %s)",
2277 name, host_address_to_string (block),
2278 objfile_debug_name (objfile),
2279 domain_name (domain));
2282 sym = block_lookup_symbol (block, name, domain);
2285 if (symbol_lookup_debug > 1)
2287 fprintf_unfiltered (gdb_stdlog, " = %s\n",
2288 host_address_to_string (sym));
2290 return fixup_symbol_section (sym, NULL);
2293 if (symbol_lookup_debug > 1)
2294 fprintf_unfiltered (gdb_stdlog, " = NULL\n");
2301 lookup_global_symbol_from_objfile (struct objfile *main_objfile,
2303 const domain_enum domain)
2305 struct objfile *objfile;
2307 for (objfile = main_objfile;
2309 objfile = objfile_separate_debug_iterate (main_objfile, objfile))
2311 struct block_symbol result
2312 = lookup_symbol_in_objfile (objfile, GLOBAL_BLOCK, name, domain);
2314 if (result.symbol != NULL)
2318 return (struct block_symbol) {NULL, NULL};
2321 /* Check to see if the symbol is defined in one of the OBJFILE's
2322 symtabs. BLOCK_INDEX should be either GLOBAL_BLOCK or STATIC_BLOCK,
2323 depending on whether or not we want to search global symbols or
2326 static struct block_symbol
2327 lookup_symbol_in_objfile_symtabs (struct objfile *objfile, int block_index,
2328 const char *name, const domain_enum domain)
2330 struct compunit_symtab *cust;
2332 gdb_assert (block_index == GLOBAL_BLOCK || block_index == STATIC_BLOCK);
2334 if (symbol_lookup_debug > 1)
2336 fprintf_unfiltered (gdb_stdlog,
2337 "lookup_symbol_in_objfile_symtabs (%s, %s, %s, %s)",
2338 objfile_debug_name (objfile),
2339 block_index == GLOBAL_BLOCK
2340 ? "GLOBAL_BLOCK" : "STATIC_BLOCK",
2341 name, domain_name (domain));
2344 ALL_OBJFILE_COMPUNITS (objfile, cust)
2346 const struct blockvector *bv;
2347 const struct block *block;
2348 struct block_symbol result;
2350 bv = COMPUNIT_BLOCKVECTOR (cust);
2351 block = BLOCKVECTOR_BLOCK (bv, block_index);
2352 result.symbol = block_lookup_symbol_primary (block, name, domain);
2353 result.block = block;
2354 if (result.symbol != NULL)
2356 if (symbol_lookup_debug > 1)
2358 fprintf_unfiltered (gdb_stdlog, " = %s (block %s)\n",
2359 host_address_to_string (result.symbol),
2360 host_address_to_string (block));
2362 result.symbol = fixup_symbol_section (result.symbol, objfile);
2368 if (symbol_lookup_debug > 1)
2369 fprintf_unfiltered (gdb_stdlog, " = NULL\n");
2370 return (struct block_symbol) {NULL, NULL};
2373 /* Wrapper around lookup_symbol_in_objfile_symtabs for search_symbols.
2374 Look up LINKAGE_NAME in DOMAIN in the global and static blocks of OBJFILE
2375 and all associated separate debug objfiles.
2377 Normally we only look in OBJFILE, and not any separate debug objfiles
2378 because the outer loop will cause them to be searched too. This case is
2379 different. Here we're called from search_symbols where it will only
2380 call us for the the objfile that contains a matching minsym. */
2382 static struct block_symbol
2383 lookup_symbol_in_objfile_from_linkage_name (struct objfile *objfile,
2384 const char *linkage_name,
2387 enum language lang = current_language->la_language;
2388 const char *modified_name;
2389 struct cleanup *cleanup = demangle_for_lookup (linkage_name, lang,
2391 struct objfile *main_objfile, *cur_objfile;
2393 if (objfile->separate_debug_objfile_backlink)
2394 main_objfile = objfile->separate_debug_objfile_backlink;
2396 main_objfile = objfile;
2398 for (cur_objfile = main_objfile;
2400 cur_objfile = objfile_separate_debug_iterate (main_objfile, cur_objfile))
2402 struct block_symbol result;
2404 result = lookup_symbol_in_objfile_symtabs (cur_objfile, GLOBAL_BLOCK,
2405 modified_name, domain);
2406 if (result.symbol == NULL)
2407 result = lookup_symbol_in_objfile_symtabs (cur_objfile, STATIC_BLOCK,
2408 modified_name, domain);
2409 if (result.symbol != NULL)
2411 do_cleanups (cleanup);
2416 do_cleanups (cleanup);
2417 return (struct block_symbol) {NULL, NULL};
2420 /* A helper function that throws an exception when a symbol was found
2421 in a psymtab but not in a symtab. */
2423 static void ATTRIBUTE_NORETURN
2424 error_in_psymtab_expansion (int block_index, const char *name,
2425 struct compunit_symtab *cust)
2428 Internal: %s symbol `%s' found in %s psymtab but not in symtab.\n\
2429 %s may be an inlined function, or may be a template function\n \
2430 (if a template, try specifying an instantiation: %s<type>)."),
2431 block_index == GLOBAL_BLOCK ? "global" : "static",
2433 symtab_to_filename_for_display (compunit_primary_filetab (cust)),
2437 /* A helper function for various lookup routines that interfaces with
2438 the "quick" symbol table functions. */
2440 static struct block_symbol
2441 lookup_symbol_via_quick_fns (struct objfile *objfile, int block_index,
2442 const char *name, const domain_enum domain)
2444 struct compunit_symtab *cust;
2445 const struct blockvector *bv;
2446 const struct block *block;
2447 struct block_symbol result;
2450 return (struct block_symbol) {NULL, NULL};
2452 if (symbol_lookup_debug > 1)
2454 fprintf_unfiltered (gdb_stdlog,
2455 "lookup_symbol_via_quick_fns (%s, %s, %s, %s)\n",
2456 objfile_debug_name (objfile),
2457 block_index == GLOBAL_BLOCK
2458 ? "GLOBAL_BLOCK" : "STATIC_BLOCK",
2459 name, domain_name (domain));
2462 cust = objfile->sf->qf->lookup_symbol (objfile, block_index, name, domain);
2465 if (symbol_lookup_debug > 1)
2467 fprintf_unfiltered (gdb_stdlog,
2468 "lookup_symbol_via_quick_fns (...) = NULL\n");
2470 return (struct block_symbol) {NULL, NULL};
2473 bv = COMPUNIT_BLOCKVECTOR (cust);
2474 block = BLOCKVECTOR_BLOCK (bv, block_index);
2475 result.symbol = block_lookup_symbol (block, name, domain);
2476 if (result.symbol == NULL)
2477 error_in_psymtab_expansion (block_index, name, cust);
2479 if (symbol_lookup_debug > 1)
2481 fprintf_unfiltered (gdb_stdlog,
2482 "lookup_symbol_via_quick_fns (...) = %s (block %s)\n",
2483 host_address_to_string (result.symbol),
2484 host_address_to_string (block));
2487 result.symbol = fixup_symbol_section (result.symbol, objfile);
2488 result.block = block;
2495 basic_lookup_symbol_nonlocal (const struct language_defn *langdef,
2497 const struct block *block,
2498 const domain_enum domain)
2500 struct block_symbol result;
2502 /* NOTE: carlton/2003-05-19: The comments below were written when
2503 this (or what turned into this) was part of lookup_symbol_aux;
2504 I'm much less worried about these questions now, since these
2505 decisions have turned out well, but I leave these comments here
2508 /* NOTE: carlton/2002-12-05: There is a question as to whether or
2509 not it would be appropriate to search the current global block
2510 here as well. (That's what this code used to do before the
2511 is_a_field_of_this check was moved up.) On the one hand, it's
2512 redundant with the lookup in all objfiles search that happens
2513 next. On the other hand, if decode_line_1 is passed an argument
2514 like filename:var, then the user presumably wants 'var' to be
2515 searched for in filename. On the third hand, there shouldn't be
2516 multiple global variables all of which are named 'var', and it's
2517 not like decode_line_1 has ever restricted its search to only
2518 global variables in a single filename. All in all, only
2519 searching the static block here seems best: it's correct and it's
2522 /* NOTE: carlton/2002-12-05: There's also a possible performance
2523 issue here: if you usually search for global symbols in the
2524 current file, then it would be slightly better to search the
2525 current global block before searching all the symtabs. But there
2526 are other factors that have a much greater effect on performance
2527 than that one, so I don't think we should worry about that for
2530 /* NOTE: dje/2014-10-26: The lookup in all objfiles search could skip
2531 the current objfile. Searching the current objfile first is useful
2532 for both matching user expectations as well as performance. */
2534 result = lookup_symbol_in_static_block (name, block, domain);
2535 if (result.symbol != NULL)
2538 /* If we didn't find a definition for a builtin type in the static block,
2539 search for it now. This is actually the right thing to do and can be
2540 a massive performance win. E.g., when debugging a program with lots of
2541 shared libraries we could search all of them only to find out the
2542 builtin type isn't defined in any of them. This is common for types
2544 if (domain == VAR_DOMAIN)
2546 struct gdbarch *gdbarch;
2549 gdbarch = target_gdbarch ();
2551 gdbarch = block_gdbarch (block);
2552 result.symbol = language_lookup_primitive_type_as_symbol (langdef,
2554 result.block = NULL;
2555 if (result.symbol != NULL)
2559 return lookup_global_symbol (name, block, domain);
2565 lookup_symbol_in_static_block (const char *name,
2566 const struct block *block,
2567 const domain_enum domain)
2569 const struct block *static_block = block_static_block (block);
2572 if (static_block == NULL)
2573 return (struct block_symbol) {NULL, NULL};
2575 if (symbol_lookup_debug)
2577 struct objfile *objfile = lookup_objfile_from_block (static_block);
2579 fprintf_unfiltered (gdb_stdlog,
2580 "lookup_symbol_in_static_block (%s, %s (objfile %s),"
2583 host_address_to_string (block),
2584 objfile_debug_name (objfile),
2585 domain_name (domain));
2588 sym = lookup_symbol_in_block (name, static_block, domain);
2589 if (symbol_lookup_debug)
2591 fprintf_unfiltered (gdb_stdlog,
2592 "lookup_symbol_in_static_block (...) = %s\n",
2593 sym != NULL ? host_address_to_string (sym) : "NULL");
2595 return (struct block_symbol) {sym, static_block};
2598 /* Perform the standard symbol lookup of NAME in OBJFILE:
2599 1) First search expanded symtabs, and if not found
2600 2) Search the "quick" symtabs (partial or .gdb_index).
2601 BLOCK_INDEX is one of GLOBAL_BLOCK or STATIC_BLOCK. */
2603 static struct block_symbol
2604 lookup_symbol_in_objfile (struct objfile *objfile, int block_index,
2605 const char *name, const domain_enum domain)
2607 struct block_symbol result;
2609 if (symbol_lookup_debug)
2611 fprintf_unfiltered (gdb_stdlog,
2612 "lookup_symbol_in_objfile (%s, %s, %s, %s)\n",
2613 objfile_debug_name (objfile),
2614 block_index == GLOBAL_BLOCK
2615 ? "GLOBAL_BLOCK" : "STATIC_BLOCK",
2616 name, domain_name (domain));
2619 result = lookup_symbol_in_objfile_symtabs (objfile, block_index,
2621 if (result.symbol != NULL)
2623 if (symbol_lookup_debug)
2625 fprintf_unfiltered (gdb_stdlog,
2626 "lookup_symbol_in_objfile (...) = %s"
2628 host_address_to_string (result.symbol));
2633 result = lookup_symbol_via_quick_fns (objfile, block_index,
2635 if (symbol_lookup_debug)
2637 fprintf_unfiltered (gdb_stdlog,
2638 "lookup_symbol_in_objfile (...) = %s%s\n",
2639 result.symbol != NULL
2640 ? host_address_to_string (result.symbol)
2642 result.symbol != NULL ? " (via quick fns)" : "");
2650 lookup_static_symbol (const char *name, const domain_enum domain)
2652 struct symbol_cache *cache = get_symbol_cache (current_program_space);
2653 struct objfile *objfile;
2654 struct block_symbol result;
2655 struct block_symbol_cache *bsc;
2656 struct symbol_cache_slot *slot;
2658 /* Lookup in STATIC_BLOCK is not current-objfile-dependent, so just pass
2659 NULL for OBJFILE_CONTEXT. */
2660 result = symbol_cache_lookup (cache, NULL, STATIC_BLOCK, name, domain,
2662 if (result.symbol != NULL)
2664 if (SYMBOL_LOOKUP_FAILED_P (result))
2665 return (struct block_symbol) {NULL, NULL};
2669 ALL_OBJFILES (objfile)
2671 result = lookup_symbol_in_objfile (objfile, STATIC_BLOCK, name, domain);
2672 if (result.symbol != NULL)
2674 /* Still pass NULL for OBJFILE_CONTEXT here. */
2675 symbol_cache_mark_found (bsc, slot, NULL, result.symbol,
2681 /* Still pass NULL for OBJFILE_CONTEXT here. */
2682 symbol_cache_mark_not_found (bsc, slot, NULL, name, domain);
2683 return (struct block_symbol) {NULL, NULL};
2686 /* Private data to be used with lookup_symbol_global_iterator_cb. */
2688 struct global_sym_lookup_data
2690 /* The name of the symbol we are searching for. */
2693 /* The domain to use for our search. */
2696 /* The field where the callback should store the symbol if found.
2697 It should be initialized to {NULL, NULL} before the search is started. */
2698 struct block_symbol result;
2701 /* A callback function for gdbarch_iterate_over_objfiles_in_search_order.
2702 It searches by name for a symbol in the GLOBAL_BLOCK of the given
2703 OBJFILE. The arguments for the search are passed via CB_DATA,
2704 which in reality is a pointer to struct global_sym_lookup_data. */
2707 lookup_symbol_global_iterator_cb (struct objfile *objfile,
2710 struct global_sym_lookup_data *data =
2711 (struct global_sym_lookup_data *) cb_data;
2713 gdb_assert (data->result.symbol == NULL
2714 && data->result.block == NULL);
2716 data->result = lookup_symbol_in_objfile (objfile, GLOBAL_BLOCK,
2717 data->name, data->domain);
2719 /* If we found a match, tell the iterator to stop. Otherwise,
2721 return (data->result.symbol != NULL);
2727 lookup_global_symbol (const char *name,
2728 const struct block *block,
2729 const domain_enum domain)
2731 struct symbol_cache *cache = get_symbol_cache (current_program_space);
2732 struct block_symbol result;
2733 struct objfile *objfile;
2734 struct global_sym_lookup_data lookup_data;
2735 struct block_symbol_cache *bsc;
2736 struct symbol_cache_slot *slot;
2738 objfile = lookup_objfile_from_block (block);
2740 /* First see if we can find the symbol in the cache.
2741 This works because we use the current objfile to qualify the lookup. */
2742 result = symbol_cache_lookup (cache, objfile, GLOBAL_BLOCK, name, domain,
2744 if (result.symbol != NULL)
2746 if (SYMBOL_LOOKUP_FAILED_P (result))
2747 return (struct block_symbol) {NULL, NULL};
2751 /* Call library-specific lookup procedure. */
2752 if (objfile != NULL)
2753 result = solib_global_lookup (objfile, name, domain);
2755 /* If that didn't work go a global search (of global blocks, heh). */
2756 if (result.symbol == NULL)
2758 memset (&lookup_data, 0, sizeof (lookup_data));
2759 lookup_data.name = name;
2760 lookup_data.domain = domain;
2761 gdbarch_iterate_over_objfiles_in_search_order
2762 (objfile != NULL ? get_objfile_arch (objfile) : target_gdbarch (),
2763 lookup_symbol_global_iterator_cb, &lookup_data, objfile);
2764 result = lookup_data.result;
2767 if (result.symbol != NULL)
2768 symbol_cache_mark_found (bsc, slot, objfile, result.symbol, result.block);
2770 symbol_cache_mark_not_found (bsc, slot, objfile, name, domain);
2776 symbol_matches_domain (enum language symbol_language,
2777 domain_enum symbol_domain,
2780 /* For C++ "struct foo { ... }" also defines a typedef for "foo".
2781 A Java class declaration also defines a typedef for the class.
2782 Similarly, any Ada type declaration implicitly defines a typedef. */
2783 if (symbol_language == language_cplus
2784 || symbol_language == language_d
2785 || symbol_language == language_java
2786 || symbol_language == language_ada)
2788 if ((domain == VAR_DOMAIN || domain == STRUCT_DOMAIN)
2789 && symbol_domain == STRUCT_DOMAIN)
2792 /* For all other languages, strict match is required. */
2793 return (symbol_domain == domain);
2799 lookup_transparent_type (const char *name)
2801 return current_language->la_lookup_transparent_type (name);
2804 /* A helper for basic_lookup_transparent_type that interfaces with the
2805 "quick" symbol table functions. */
2807 static struct type *
2808 basic_lookup_transparent_type_quick (struct objfile *objfile, int block_index,
2811 struct compunit_symtab *cust;
2812 const struct blockvector *bv;
2813 struct block *block;
2818 cust = objfile->sf->qf->lookup_symbol (objfile, block_index, name,
2823 bv = COMPUNIT_BLOCKVECTOR (cust);
2824 block = BLOCKVECTOR_BLOCK (bv, block_index);
2825 sym = block_find_symbol (block, name, STRUCT_DOMAIN,
2826 block_find_non_opaque_type, NULL);
2828 error_in_psymtab_expansion (block_index, name, cust);
2829 gdb_assert (!TYPE_IS_OPAQUE (SYMBOL_TYPE (sym)));
2830 return SYMBOL_TYPE (sym);
2833 /* Subroutine of basic_lookup_transparent_type to simplify it.
2834 Look up the non-opaque definition of NAME in BLOCK_INDEX of OBJFILE.
2835 BLOCK_INDEX is either GLOBAL_BLOCK or STATIC_BLOCK. */
2837 static struct type *
2838 basic_lookup_transparent_type_1 (struct objfile *objfile, int block_index,
2841 const struct compunit_symtab *cust;
2842 const struct blockvector *bv;
2843 const struct block *block;
2844 const struct symbol *sym;
2846 ALL_OBJFILE_COMPUNITS (objfile, cust)
2848 bv = COMPUNIT_BLOCKVECTOR (cust);
2849 block = BLOCKVECTOR_BLOCK (bv, block_index);
2850 sym = block_find_symbol (block, name, STRUCT_DOMAIN,
2851 block_find_non_opaque_type, NULL);
2854 gdb_assert (!TYPE_IS_OPAQUE (SYMBOL_TYPE (sym)));
2855 return SYMBOL_TYPE (sym);
2862 /* The standard implementation of lookup_transparent_type. This code
2863 was modeled on lookup_symbol -- the parts not relevant to looking
2864 up types were just left out. In particular it's assumed here that
2865 types are available in STRUCT_DOMAIN and only in file-static or
2869 basic_lookup_transparent_type (const char *name)
2872 struct compunit_symtab *cust;
2873 const struct blockvector *bv;
2874 struct objfile *objfile;
2875 struct block *block;
2878 /* Now search all the global symbols. Do the symtab's first, then
2879 check the psymtab's. If a psymtab indicates the existence
2880 of the desired name as a global, then do psymtab-to-symtab
2881 conversion on the fly and return the found symbol. */
2883 ALL_OBJFILES (objfile)
2885 t = basic_lookup_transparent_type_1 (objfile, GLOBAL_BLOCK, name);
2890 ALL_OBJFILES (objfile)
2892 t = basic_lookup_transparent_type_quick (objfile, GLOBAL_BLOCK, name);
2897 /* Now search the static file-level symbols.
2898 Not strictly correct, but more useful than an error.
2899 Do the symtab's first, then
2900 check the psymtab's. If a psymtab indicates the existence
2901 of the desired name as a file-level static, then do psymtab-to-symtab
2902 conversion on the fly and return the found symbol. */
2904 ALL_OBJFILES (objfile)
2906 t = basic_lookup_transparent_type_1 (objfile, STATIC_BLOCK, name);
2911 ALL_OBJFILES (objfile)
2913 t = basic_lookup_transparent_type_quick (objfile, STATIC_BLOCK, name);
2918 return (struct type *) 0;
2921 /* Iterate over the symbols named NAME, matching DOMAIN, in BLOCK.
2923 For each symbol that matches, CALLBACK is called. The symbol and
2924 DATA are passed to the callback.
2926 If CALLBACK returns zero, the iteration ends. Otherwise, the
2927 search continues. */
2930 iterate_over_symbols (const struct block *block, const char *name,
2931 const domain_enum domain,
2932 symbol_found_callback_ftype *callback,
2935 struct block_iterator iter;
2938 ALL_BLOCK_SYMBOLS_WITH_NAME (block, name, iter, sym)
2940 if (symbol_matches_domain (SYMBOL_LANGUAGE (sym),
2941 SYMBOL_DOMAIN (sym), domain))
2943 if (!callback (sym, data))
2949 /* Find the compunit symtab associated with PC and SECTION.
2950 This will read in debug info as necessary. */
2952 struct compunit_symtab *
2953 find_pc_sect_compunit_symtab (CORE_ADDR pc, struct obj_section *section)
2955 struct compunit_symtab *cust;
2956 struct compunit_symtab *best_cust = NULL;
2957 struct objfile *objfile;
2958 CORE_ADDR distance = 0;
2959 struct bound_minimal_symbol msymbol;
2961 /* If we know that this is not a text address, return failure. This is
2962 necessary because we loop based on the block's high and low code
2963 addresses, which do not include the data ranges, and because
2964 we call find_pc_sect_psymtab which has a similar restriction based
2965 on the partial_symtab's texthigh and textlow. */
2966 msymbol = lookup_minimal_symbol_by_pc_section (pc, section);
2968 && (MSYMBOL_TYPE (msymbol.minsym) == mst_data
2969 || MSYMBOL_TYPE (msymbol.minsym) == mst_bss
2970 || MSYMBOL_TYPE (msymbol.minsym) == mst_abs
2971 || MSYMBOL_TYPE (msymbol.minsym) == mst_file_data
2972 || MSYMBOL_TYPE (msymbol.minsym) == mst_file_bss))
2975 /* Search all symtabs for the one whose file contains our address, and which
2976 is the smallest of all the ones containing the address. This is designed
2977 to deal with a case like symtab a is at 0x1000-0x2000 and 0x3000-0x4000
2978 and symtab b is at 0x2000-0x3000. So the GLOBAL_BLOCK for a is from
2979 0x1000-0x4000, but for address 0x2345 we want to return symtab b.
2981 This happens for native ecoff format, where code from included files
2982 gets its own symtab. The symtab for the included file should have
2983 been read in already via the dependency mechanism.
2984 It might be swifter to create several symtabs with the same name
2985 like xcoff does (I'm not sure).
2987 It also happens for objfiles that have their functions reordered.
2988 For these, the symtab we are looking for is not necessarily read in. */
2990 ALL_COMPUNITS (objfile, cust)
2993 const struct blockvector *bv;
2995 bv = COMPUNIT_BLOCKVECTOR (cust);
2996 b = BLOCKVECTOR_BLOCK (bv, GLOBAL_BLOCK);
2998 if (BLOCK_START (b) <= pc
2999 && BLOCK_END (b) > pc
3001 || BLOCK_END (b) - BLOCK_START (b) < distance))
3003 /* For an objfile that has its functions reordered,
3004 find_pc_psymtab will find the proper partial symbol table
3005 and we simply return its corresponding symtab. */
3006 /* In order to better support objfiles that contain both
3007 stabs and coff debugging info, we continue on if a psymtab
3009 if ((objfile->flags & OBJF_REORDERED) && objfile->sf)
3011 struct compunit_symtab *result;
3014 = objfile->sf->qf->find_pc_sect_compunit_symtab (objfile,
3023 struct block_iterator iter;
3024 struct symbol *sym = NULL;
3026 ALL_BLOCK_SYMBOLS (b, iter, sym)
3028 fixup_symbol_section (sym, objfile);
3029 if (matching_obj_sections (SYMBOL_OBJ_SECTION (objfile, sym),
3034 continue; /* No symbol in this symtab matches
3037 distance = BLOCK_END (b) - BLOCK_START (b);
3042 if (best_cust != NULL)
3045 /* Not found in symtabs, search the "quick" symtabs (e.g. psymtabs). */
3047 ALL_OBJFILES (objfile)
3049 struct compunit_symtab *result;
3053 result = objfile->sf->qf->find_pc_sect_compunit_symtab (objfile,
3064 /* Find the compunit symtab associated with PC.
3065 This will read in debug info as necessary.
3066 Backward compatibility, no section. */
3068 struct compunit_symtab *
3069 find_pc_compunit_symtab (CORE_ADDR pc)
3071 return find_pc_sect_compunit_symtab (pc, find_pc_mapped_section (pc));
3075 /* Find the source file and line number for a given PC value and SECTION.
3076 Return a structure containing a symtab pointer, a line number,
3077 and a pc range for the entire source line.
3078 The value's .pc field is NOT the specified pc.
3079 NOTCURRENT nonzero means, if specified pc is on a line boundary,
3080 use the line that ends there. Otherwise, in that case, the line
3081 that begins there is used. */
3083 /* The big complication here is that a line may start in one file, and end just
3084 before the start of another file. This usually occurs when you #include
3085 code in the middle of a subroutine. To properly find the end of a line's PC
3086 range, we must search all symtabs associated with this compilation unit, and
3087 find the one whose first PC is closer than that of the next line in this
3090 /* If it's worth the effort, we could be using a binary search. */
3092 struct symtab_and_line
3093 find_pc_sect_line (CORE_ADDR pc, struct obj_section *section, int notcurrent)
3095 struct compunit_symtab *cust;
3096 struct symtab *iter_s;
3097 struct linetable *l;
3100 struct linetable_entry *item;
3101 struct symtab_and_line val;
3102 const struct blockvector *bv;
3103 struct bound_minimal_symbol msymbol;
3105 /* Info on best line seen so far, and where it starts, and its file. */
3107 struct linetable_entry *best = NULL;
3108 CORE_ADDR best_end = 0;
3109 struct symtab *best_symtab = 0;
3111 /* Store here the first line number
3112 of a file which contains the line at the smallest pc after PC.
3113 If we don't find a line whose range contains PC,
3114 we will use a line one less than this,
3115 with a range from the start of that file to the first line's pc. */
3116 struct linetable_entry *alt = NULL;
3118 /* Info on best line seen in this file. */
3120 struct linetable_entry *prev;
3122 /* If this pc is not from the current frame,
3123 it is the address of the end of a call instruction.
3124 Quite likely that is the start of the following statement.
3125 But what we want is the statement containing the instruction.
3126 Fudge the pc to make sure we get that. */
3128 init_sal (&val); /* initialize to zeroes */
3130 val.pspace = current_program_space;
3132 /* It's tempting to assume that, if we can't find debugging info for
3133 any function enclosing PC, that we shouldn't search for line
3134 number info, either. However, GAS can emit line number info for
3135 assembly files --- very helpful when debugging hand-written
3136 assembly code. In such a case, we'd have no debug info for the
3137 function, but we would have line info. */
3142 /* elz: added this because this function returned the wrong
3143 information if the pc belongs to a stub (import/export)
3144 to call a shlib function. This stub would be anywhere between
3145 two functions in the target, and the line info was erroneously
3146 taken to be the one of the line before the pc. */
3148 /* RT: Further explanation:
3150 * We have stubs (trampolines) inserted between procedures.
3152 * Example: "shr1" exists in a shared library, and a "shr1" stub also
3153 * exists in the main image.
3155 * In the minimal symbol table, we have a bunch of symbols
3156 * sorted by start address. The stubs are marked as "trampoline",
3157 * the others appear as text. E.g.:
3159 * Minimal symbol table for main image
3160 * main: code for main (text symbol)
3161 * shr1: stub (trampoline symbol)
3162 * foo: code for foo (text symbol)
3164 * Minimal symbol table for "shr1" image:
3166 * shr1: code for shr1 (text symbol)
3169 * So the code below is trying to detect if we are in the stub
3170 * ("shr1" stub), and if so, find the real code ("shr1" trampoline),
3171 * and if found, do the symbolization from the real-code address
3172 * rather than the stub address.
3174 * Assumptions being made about the minimal symbol table:
3175 * 1. lookup_minimal_symbol_by_pc() will return a trampoline only
3176 * if we're really in the trampoline.s If we're beyond it (say
3177 * we're in "foo" in the above example), it'll have a closer
3178 * symbol (the "foo" text symbol for example) and will not
3179 * return the trampoline.
3180 * 2. lookup_minimal_symbol_text() will find a real text symbol
3181 * corresponding to the trampoline, and whose address will
3182 * be different than the trampoline address. I put in a sanity
3183 * check for the address being the same, to avoid an
3184 * infinite recursion.
3186 msymbol = lookup_minimal_symbol_by_pc (pc);
3187 if (msymbol.minsym != NULL)
3188 if (MSYMBOL_TYPE (msymbol.minsym) == mst_solib_trampoline)
3190 struct bound_minimal_symbol mfunsym
3191 = lookup_minimal_symbol_text (MSYMBOL_LINKAGE_NAME (msymbol.minsym),
3194 if (mfunsym.minsym == NULL)
3195 /* I eliminated this warning since it is coming out
3196 * in the following situation:
3197 * gdb shmain // test program with shared libraries
3198 * (gdb) break shr1 // function in shared lib
3199 * Warning: In stub for ...
3200 * In the above situation, the shared lib is not loaded yet,
3201 * so of course we can't find the real func/line info,
3202 * but the "break" still works, and the warning is annoying.
3203 * So I commented out the warning. RT */
3204 /* warning ("In stub for %s; unable to find real function/line info",
3205 SYMBOL_LINKAGE_NAME (msymbol)); */
3208 else if (BMSYMBOL_VALUE_ADDRESS (mfunsym)
3209 == BMSYMBOL_VALUE_ADDRESS (msymbol))
3210 /* Avoid infinite recursion */
3211 /* See above comment about why warning is commented out. */
3212 /* warning ("In stub for %s; unable to find real function/line info",
3213 SYMBOL_LINKAGE_NAME (msymbol)); */
3217 return find_pc_line (BMSYMBOL_VALUE_ADDRESS (mfunsym), 0);
3221 cust = find_pc_sect_compunit_symtab (pc, section);
3224 /* If no symbol information, return previous pc. */
3231 bv = COMPUNIT_BLOCKVECTOR (cust);
3233 /* Look at all the symtabs that share this blockvector.
3234 They all have the same apriori range, that we found was right;
3235 but they have different line tables. */
3237 ALL_COMPUNIT_FILETABS (cust, iter_s)
3239 /* Find the best line in this symtab. */
3240 l = SYMTAB_LINETABLE (iter_s);
3246 /* I think len can be zero if the symtab lacks line numbers
3247 (e.g. gcc -g1). (Either that or the LINETABLE is NULL;
3248 I'm not sure which, and maybe it depends on the symbol
3254 item = l->item; /* Get first line info. */
3256 /* Is this file's first line closer than the first lines of other files?
3257 If so, record this file, and its first line, as best alternate. */
3258 if (item->pc > pc && (!alt || item->pc < alt->pc))
3261 for (i = 0; i < len; i++, item++)
3263 /* Leave prev pointing to the linetable entry for the last line
3264 that started at or before PC. */
3271 /* At this point, prev points at the line whose start addr is <= pc, and
3272 item points at the next line. If we ran off the end of the linetable
3273 (pc >= start of the last line), then prev == item. If pc < start of
3274 the first line, prev will not be set. */
3276 /* Is this file's best line closer than the best in the other files?
3277 If so, record this file, and its best line, as best so far. Don't
3278 save prev if it represents the end of a function (i.e. line number
3279 0) instead of a real line. */
3281 if (prev && prev->line && (!best || prev->pc > best->pc))
3284 best_symtab = iter_s;
3286 /* Discard BEST_END if it's before the PC of the current BEST. */
3287 if (best_end <= best->pc)
3291 /* If another line (denoted by ITEM) is in the linetable and its
3292 PC is after BEST's PC, but before the current BEST_END, then
3293 use ITEM's PC as the new best_end. */
3294 if (best && i < len && item->pc > best->pc
3295 && (best_end == 0 || best_end > item->pc))
3296 best_end = item->pc;
3301 /* If we didn't find any line number info, just return zeros.
3302 We used to return alt->line - 1 here, but that could be
3303 anywhere; if we don't have line number info for this PC,
3304 don't make some up. */
3307 else if (best->line == 0)
3309 /* If our best fit is in a range of PC's for which no line
3310 number info is available (line number is zero) then we didn't
3311 find any valid line information. */
3316 val.symtab = best_symtab;
3317 val.line = best->line;
3319 if (best_end && (!alt || best_end < alt->pc))
3324 val.end = BLOCK_END (BLOCKVECTOR_BLOCK (bv, GLOBAL_BLOCK));
3326 val.section = section;
3330 /* Backward compatibility (no section). */
3332 struct symtab_and_line
3333 find_pc_line (CORE_ADDR pc, int notcurrent)
3335 struct obj_section *section;
3337 section = find_pc_overlay (pc);
3338 if (pc_in_unmapped_range (pc, section))
3339 pc = overlay_mapped_address (pc, section);
3340 return find_pc_sect_line (pc, section, notcurrent);
3346 find_pc_line_symtab (CORE_ADDR pc)
3348 struct symtab_and_line sal;
3350 /* This always passes zero for NOTCURRENT to find_pc_line.
3351 There are currently no callers that ever pass non-zero. */
3352 sal = find_pc_line (pc, 0);
3356 /* Find line number LINE in any symtab whose name is the same as
3359 If found, return the symtab that contains the linetable in which it was
3360 found, set *INDEX to the index in the linetable of the best entry
3361 found, and set *EXACT_MATCH nonzero if the value returned is an
3364 If not found, return NULL. */
3367 find_line_symtab (struct symtab *symtab, int line,
3368 int *index, int *exact_match)
3370 int exact = 0; /* Initialized here to avoid a compiler warning. */
3372 /* BEST_INDEX and BEST_LINETABLE identify the smallest linenumber > LINE
3376 struct linetable *best_linetable;
3377 struct symtab *best_symtab;
3379 /* First try looking it up in the given symtab. */
3380 best_linetable = SYMTAB_LINETABLE (symtab);
3381 best_symtab = symtab;
3382 best_index = find_line_common (best_linetable, line, &exact, 0);
3383 if (best_index < 0 || !exact)
3385 /* Didn't find an exact match. So we better keep looking for
3386 another symtab with the same name. In the case of xcoff,
3387 multiple csects for one source file (produced by IBM's FORTRAN
3388 compiler) produce multiple symtabs (this is unavoidable
3389 assuming csects can be at arbitrary places in memory and that
3390 the GLOBAL_BLOCK of a symtab has a begin and end address). */
3392 /* BEST is the smallest linenumber > LINE so far seen,
3393 or 0 if none has been seen so far.
3394 BEST_INDEX and BEST_LINETABLE identify the item for it. */
3397 struct objfile *objfile;
3398 struct compunit_symtab *cu;
3401 if (best_index >= 0)
3402 best = best_linetable->item[best_index].line;
3406 ALL_OBJFILES (objfile)
3409 objfile->sf->qf->expand_symtabs_with_fullname (objfile,
3410 symtab_to_fullname (symtab));
3413 ALL_FILETABS (objfile, cu, s)
3415 struct linetable *l;
3418 if (FILENAME_CMP (symtab->filename, s->filename) != 0)
3420 if (FILENAME_CMP (symtab_to_fullname (symtab),
3421 symtab_to_fullname (s)) != 0)
3423 l = SYMTAB_LINETABLE (s);
3424 ind = find_line_common (l, line, &exact, 0);
3434 if (best == 0 || l->item[ind].line < best)
3436 best = l->item[ind].line;
3449 *index = best_index;
3451 *exact_match = exact;
3456 /* Given SYMTAB, returns all the PCs function in the symtab that
3457 exactly match LINE. Returns NULL if there are no exact matches,
3458 but updates BEST_ITEM in this case. */
3461 find_pcs_for_symtab_line (struct symtab *symtab, int line,
3462 struct linetable_entry **best_item)
3465 VEC (CORE_ADDR) *result = NULL;
3467 /* First, collect all the PCs that are at this line. */
3473 idx = find_line_common (SYMTAB_LINETABLE (symtab), line, &was_exact,
3480 struct linetable_entry *item = &SYMTAB_LINETABLE (symtab)->item[idx];
3482 if (*best_item == NULL || item->line < (*best_item)->line)
3488 VEC_safe_push (CORE_ADDR, result,
3489 SYMTAB_LINETABLE (symtab)->item[idx].pc);
3497 /* Set the PC value for a given source file and line number and return true.
3498 Returns zero for invalid line number (and sets the PC to 0).
3499 The source file is specified with a struct symtab. */
3502 find_line_pc (struct symtab *symtab, int line, CORE_ADDR *pc)
3504 struct linetable *l;
3511 symtab = find_line_symtab (symtab, line, &ind, NULL);
3514 l = SYMTAB_LINETABLE (symtab);
3515 *pc = l->item[ind].pc;
3522 /* Find the range of pc values in a line.
3523 Store the starting pc of the line into *STARTPTR
3524 and the ending pc (start of next line) into *ENDPTR.
3525 Returns 1 to indicate success.
3526 Returns 0 if could not find the specified line. */
3529 find_line_pc_range (struct symtab_and_line sal, CORE_ADDR *startptr,
3532 CORE_ADDR startaddr;
3533 struct symtab_and_line found_sal;
3536 if (startaddr == 0 && !find_line_pc (sal.symtab, sal.line, &startaddr))
3539 /* This whole function is based on address. For example, if line 10 has
3540 two parts, one from 0x100 to 0x200 and one from 0x300 to 0x400, then
3541 "info line *0x123" should say the line goes from 0x100 to 0x200
3542 and "info line *0x355" should say the line goes from 0x300 to 0x400.
3543 This also insures that we never give a range like "starts at 0x134
3544 and ends at 0x12c". */
3546 found_sal = find_pc_sect_line (startaddr, sal.section, 0);
3547 if (found_sal.line != sal.line)
3549 /* The specified line (sal) has zero bytes. */
3550 *startptr = found_sal.pc;
3551 *endptr = found_sal.pc;
3555 *startptr = found_sal.pc;
3556 *endptr = found_sal.end;
3561 /* Given a line table and a line number, return the index into the line
3562 table for the pc of the nearest line whose number is >= the specified one.
3563 Return -1 if none is found. The value is >= 0 if it is an index.
3564 START is the index at which to start searching the line table.
3566 Set *EXACT_MATCH nonzero if the value returned is an exact match. */
3569 find_line_common (struct linetable *l, int lineno,
3570 int *exact_match, int start)
3575 /* BEST is the smallest linenumber > LINENO so far seen,
3576 or 0 if none has been seen so far.
3577 BEST_INDEX identifies the item for it. */
3579 int best_index = -1;
3590 for (i = start; i < len; i++)
3592 struct linetable_entry *item = &(l->item[i]);
3594 if (item->line == lineno)
3596 /* Return the first (lowest address) entry which matches. */
3601 if (item->line > lineno && (best == 0 || item->line < best))
3608 /* If we got here, we didn't get an exact match. */
3613 find_pc_line_pc_range (CORE_ADDR pc, CORE_ADDR *startptr, CORE_ADDR *endptr)
3615 struct symtab_and_line sal;
3617 sal = find_pc_line (pc, 0);
3620 return sal.symtab != 0;
3623 /* Given a function symbol SYM, find the symtab and line for the start
3625 If the argument FUNFIRSTLINE is nonzero, we want the first line
3626 of real code inside the function.
3627 This function should return SALs matching those from minsym_found,
3628 otherwise false multiple-locations breakpoints could be placed. */
3630 struct symtab_and_line
3631 find_function_start_sal (struct symbol *sym, int funfirstline)
3633 struct symtab_and_line sal;
3634 struct obj_section *section;
3636 fixup_symbol_section (sym, NULL);
3637 section = SYMBOL_OBJ_SECTION (symbol_objfile (sym), sym);
3638 sal = find_pc_sect_line (BLOCK_START (SYMBOL_BLOCK_VALUE (sym)), section, 0);
3640 if (funfirstline && sal.symtab != NULL
3641 && (COMPUNIT_LOCATIONS_VALID (SYMTAB_COMPUNIT (sal.symtab))
3642 || SYMTAB_LANGUAGE (sal.symtab) == language_asm))
3644 struct gdbarch *gdbarch = symbol_arch (sym);
3646 sal.pc = BLOCK_START (SYMBOL_BLOCK_VALUE (sym));
3647 if (gdbarch_skip_entrypoint_p (gdbarch))
3648 sal.pc = gdbarch_skip_entrypoint (gdbarch, sal.pc);
3652 /* We always should have a line for the function start address.
3653 If we don't, something is odd. Create a plain SAL refering
3654 just the PC and hope that skip_prologue_sal (if requested)
3655 can find a line number for after the prologue. */
3656 if (sal.pc < BLOCK_START (SYMBOL_BLOCK_VALUE (sym)))
3659 sal.pspace = current_program_space;
3660 sal.pc = BLOCK_START (SYMBOL_BLOCK_VALUE (sym));
3661 sal.section = section;
3665 skip_prologue_sal (&sal);
3670 /* Given a function start address FUNC_ADDR and SYMTAB, find the first
3671 address for that function that has an entry in SYMTAB's line info
3672 table. If such an entry cannot be found, return FUNC_ADDR
3676 skip_prologue_using_lineinfo (CORE_ADDR func_addr, struct symtab *symtab)
3678 CORE_ADDR func_start, func_end;
3679 struct linetable *l;
3682 /* Give up if this symbol has no lineinfo table. */
3683 l = SYMTAB_LINETABLE (symtab);
3687 /* Get the range for the function's PC values, or give up if we
3688 cannot, for some reason. */
3689 if (!find_pc_partial_function (func_addr, NULL, &func_start, &func_end))
3692 /* Linetable entries are ordered by PC values, see the commentary in
3693 symtab.h where `struct linetable' is defined. Thus, the first
3694 entry whose PC is in the range [FUNC_START..FUNC_END[ is the
3695 address we are looking for. */
3696 for (i = 0; i < l->nitems; i++)
3698 struct linetable_entry *item = &(l->item[i]);
3700 /* Don't use line numbers of zero, they mark special entries in
3701 the table. See the commentary on symtab.h before the
3702 definition of struct linetable. */
3703 if (item->line > 0 && func_start <= item->pc && item->pc < func_end)
3710 /* Adjust SAL to the first instruction past the function prologue.
3711 If the PC was explicitly specified, the SAL is not changed.
3712 If the line number was explicitly specified, at most the SAL's PC
3713 is updated. If SAL is already past the prologue, then do nothing. */
3716 skip_prologue_sal (struct symtab_and_line *sal)
3719 struct symtab_and_line start_sal;
3720 struct cleanup *old_chain;
3721 CORE_ADDR pc, saved_pc;
3722 struct obj_section *section;
3724 struct objfile *objfile;
3725 struct gdbarch *gdbarch;
3726 const struct block *b, *function_block;
3727 int force_skip, skip;
3729 /* Do not change the SAL if PC was specified explicitly. */
3730 if (sal->explicit_pc)
3733 old_chain = save_current_space_and_thread ();
3734 switch_to_program_space_and_thread (sal->pspace);
3736 sym = find_pc_sect_function (sal->pc, sal->section);
3739 fixup_symbol_section (sym, NULL);
3741 objfile = symbol_objfile (sym);
3742 pc = BLOCK_START (SYMBOL_BLOCK_VALUE (sym));
3743 section = SYMBOL_OBJ_SECTION (objfile, sym);
3744 name = SYMBOL_LINKAGE_NAME (sym);
3748 struct bound_minimal_symbol msymbol
3749 = lookup_minimal_symbol_by_pc_section (sal->pc, sal->section);
3751 if (msymbol.minsym == NULL)
3753 do_cleanups (old_chain);
3757 objfile = msymbol.objfile;
3758 pc = BMSYMBOL_VALUE_ADDRESS (msymbol);
3759 section = MSYMBOL_OBJ_SECTION (objfile, msymbol.minsym);
3760 name = MSYMBOL_LINKAGE_NAME (msymbol.minsym);
3763 gdbarch = get_objfile_arch (objfile);
3765 /* Process the prologue in two passes. In the first pass try to skip the
3766 prologue (SKIP is true) and verify there is a real need for it (indicated
3767 by FORCE_SKIP). If no such reason was found run a second pass where the
3768 prologue is not skipped (SKIP is false). */
3773 /* Be conservative - allow direct PC (without skipping prologue) only if we
3774 have proven the CU (Compilation Unit) supports it. sal->SYMTAB does not
3775 have to be set by the caller so we use SYM instead. */
3777 && COMPUNIT_LOCATIONS_VALID (SYMTAB_COMPUNIT (symbol_symtab (sym))))
3785 /* If the function is in an unmapped overlay, use its unmapped LMA address,
3786 so that gdbarch_skip_prologue has something unique to work on. */
3787 if (section_is_overlay (section) && !section_is_mapped (section))
3788 pc = overlay_unmapped_address (pc, section);
3790 /* Skip "first line" of function (which is actually its prologue). */
3791 pc += gdbarch_deprecated_function_start_offset (gdbarch);
3792 if (gdbarch_skip_entrypoint_p (gdbarch))
3793 pc = gdbarch_skip_entrypoint (gdbarch, pc);
3795 pc = gdbarch_skip_prologue (gdbarch, pc);
3797 /* For overlays, map pc back into its mapped VMA range. */
3798 pc = overlay_mapped_address (pc, section);
3800 /* Calculate line number. */
3801 start_sal = find_pc_sect_line (pc, section, 0);
3803 /* Check if gdbarch_skip_prologue left us in mid-line, and the next
3804 line is still part of the same function. */
3805 if (skip && start_sal.pc != pc
3806 && (sym ? (BLOCK_START (SYMBOL_BLOCK_VALUE (sym)) <= start_sal.end
3807 && start_sal.end < BLOCK_END (SYMBOL_BLOCK_VALUE (sym)))
3808 : (lookup_minimal_symbol_by_pc_section (start_sal.end, section).minsym
3809 == lookup_minimal_symbol_by_pc_section (pc, section).minsym)))
3811 /* First pc of next line */
3813 /* Recalculate the line number (might not be N+1). */
3814 start_sal = find_pc_sect_line (pc, section, 0);
3817 /* On targets with executable formats that don't have a concept of
3818 constructors (ELF with .init has, PE doesn't), gcc emits a call
3819 to `__main' in `main' between the prologue and before user
3821 if (gdbarch_skip_main_prologue_p (gdbarch)
3822 && name && strcmp_iw (name, "main") == 0)
3824 pc = gdbarch_skip_main_prologue (gdbarch, pc);
3825 /* Recalculate the line number (might not be N+1). */
3826 start_sal = find_pc_sect_line (pc, section, 0);
3830 while (!force_skip && skip--);
3832 /* If we still don't have a valid source line, try to find the first
3833 PC in the lineinfo table that belongs to the same function. This
3834 happens with COFF debug info, which does not seem to have an
3835 entry in lineinfo table for the code after the prologue which has
3836 no direct relation to source. For example, this was found to be
3837 the case with the DJGPP target using "gcc -gcoff" when the
3838 compiler inserted code after the prologue to make sure the stack
3840 if (!force_skip && sym && start_sal.symtab == NULL)
3842 pc = skip_prologue_using_lineinfo (pc, symbol_symtab (sym));
3843 /* Recalculate the line number. */
3844 start_sal = find_pc_sect_line (pc, section, 0);
3847 do_cleanups (old_chain);
3849 /* If we're already past the prologue, leave SAL unchanged. Otherwise
3850 forward SAL to the end of the prologue. */
3855 sal->section = section;
3857 /* Unless the explicit_line flag was set, update the SAL line
3858 and symtab to correspond to the modified PC location. */
3859 if (sal->explicit_line)
3862 sal->symtab = start_sal.symtab;
3863 sal->line = start_sal.line;
3864 sal->end = start_sal.end;
3866 /* Check if we are now inside an inlined function. If we can,
3867 use the call site of the function instead. */
3868 b = block_for_pc_sect (sal->pc, sal->section);
3869 function_block = NULL;
3872 if (BLOCK_FUNCTION (b) != NULL && block_inlined_p (b))
3874 else if (BLOCK_FUNCTION (b) != NULL)
3876 b = BLOCK_SUPERBLOCK (b);
3878 if (function_block != NULL
3879 && SYMBOL_LINE (BLOCK_FUNCTION (function_block)) != 0)
3881 sal->line = SYMBOL_LINE (BLOCK_FUNCTION (function_block));
3882 sal->symtab = symbol_symtab (BLOCK_FUNCTION (function_block));
3886 /* Given PC at the function's start address, attempt to find the
3887 prologue end using SAL information. Return zero if the skip fails.
3889 A non-optimized prologue traditionally has one SAL for the function
3890 and a second for the function body. A single line function has
3891 them both pointing at the same line.
3893 An optimized prologue is similar but the prologue may contain
3894 instructions (SALs) from the instruction body. Need to skip those
3895 while not getting into the function body.
3897 The functions end point and an increasing SAL line are used as
3898 indicators of the prologue's endpoint.
3900 This code is based on the function refine_prologue_limit
3904 skip_prologue_using_sal (struct gdbarch *gdbarch, CORE_ADDR func_addr)
3906 struct symtab_and_line prologue_sal;
3909 const struct block *bl;
3911 /* Get an initial range for the function. */
3912 find_pc_partial_function (func_addr, NULL, &start_pc, &end_pc);
3913 start_pc += gdbarch_deprecated_function_start_offset (gdbarch);
3915 prologue_sal = find_pc_line (start_pc, 0);
3916 if (prologue_sal.line != 0)
3918 /* For languages other than assembly, treat two consecutive line
3919 entries at the same address as a zero-instruction prologue.
3920 The GNU assembler emits separate line notes for each instruction
3921 in a multi-instruction macro, but compilers generally will not
3923 if (prologue_sal.symtab->language != language_asm)
3925 struct linetable *linetable = SYMTAB_LINETABLE (prologue_sal.symtab);
3928 /* Skip any earlier lines, and any end-of-sequence marker
3929 from a previous function. */
3930 while (linetable->item[idx].pc != prologue_sal.pc
3931 || linetable->item[idx].line == 0)
3934 if (idx+1 < linetable->nitems
3935 && linetable->item[idx+1].line != 0
3936 && linetable->item[idx+1].pc == start_pc)
3940 /* If there is only one sal that covers the entire function,
3941 then it is probably a single line function, like
3943 if (prologue_sal.end >= end_pc)
3946 while (prologue_sal.end < end_pc)
3948 struct symtab_and_line sal;
3950 sal = find_pc_line (prologue_sal.end, 0);
3953 /* Assume that a consecutive SAL for the same (or larger)
3954 line mark the prologue -> body transition. */
3955 if (sal.line >= prologue_sal.line)
3957 /* Likewise if we are in a different symtab altogether
3958 (e.g. within a file included via #include). */
3959 if (sal.symtab != prologue_sal.symtab)
3962 /* The line number is smaller. Check that it's from the
3963 same function, not something inlined. If it's inlined,
3964 then there is no point comparing the line numbers. */
3965 bl = block_for_pc (prologue_sal.end);
3968 if (block_inlined_p (bl))
3970 if (BLOCK_FUNCTION (bl))
3975 bl = BLOCK_SUPERBLOCK (bl);
3980 /* The case in which compiler's optimizer/scheduler has
3981 moved instructions into the prologue. We look ahead in
3982 the function looking for address ranges whose
3983 corresponding line number is less the first one that we
3984 found for the function. This is more conservative then
3985 refine_prologue_limit which scans a large number of SALs
3986 looking for any in the prologue. */
3991 if (prologue_sal.end < end_pc)
3992 /* Return the end of this line, or zero if we could not find a
3994 return prologue_sal.end;
3996 /* Don't return END_PC, which is past the end of the function. */
3997 return prologue_sal.pc;
4000 /* If P is of the form "operator[ \t]+..." where `...' is
4001 some legitimate operator text, return a pointer to the
4002 beginning of the substring of the operator text.
4003 Otherwise, return "". */
4006 operator_chars (const char *p, const char **end)
4009 if (!startswith (p, "operator"))
4013 /* Don't get faked out by `operator' being part of a longer
4015 if (isalpha (*p) || *p == '_' || *p == '$' || *p == '\0')
4018 /* Allow some whitespace between `operator' and the operator symbol. */
4019 while (*p == ' ' || *p == '\t')
4022 /* Recognize 'operator TYPENAME'. */
4024 if (isalpha (*p) || *p == '_' || *p == '$')
4026 const char *q = p + 1;
4028 while (isalnum (*q) || *q == '_' || *q == '$')
4037 case '\\': /* regexp quoting */
4040 if (p[2] == '=') /* 'operator\*=' */
4042 else /* 'operator\*' */
4046 else if (p[1] == '[')
4049 error (_("mismatched quoting on brackets, "
4050 "try 'operator\\[\\]'"));
4051 else if (p[2] == '\\' && p[3] == ']')
4053 *end = p + 4; /* 'operator\[\]' */
4057 error (_("nothing is allowed between '[' and ']'"));
4061 /* Gratuitous qoute: skip it and move on. */
4083 if (p[0] == '-' && p[1] == '>')
4085 /* Struct pointer member operator 'operator->'. */
4088 *end = p + 3; /* 'operator->*' */
4091 else if (p[2] == '\\')
4093 *end = p + 4; /* Hopefully 'operator->\*' */
4098 *end = p + 2; /* 'operator->' */
4102 if (p[1] == '=' || p[1] == p[0])
4113 error (_("`operator ()' must be specified "
4114 "without whitespace in `()'"));
4119 error (_("`operator ?:' must be specified "
4120 "without whitespace in `?:'"));
4125 error (_("`operator []' must be specified "
4126 "without whitespace in `[]'"));
4130 error (_("`operator %s' not supported"), p);
4139 /* Cache to watch for file names already seen by filename_seen. */
4141 struct filename_seen_cache
4143 /* Table of files seen so far. */
4145 /* Initial size of the table. It automagically grows from here. */
4146 #define INITIAL_FILENAME_SEEN_CACHE_SIZE 100
4149 /* filename_seen_cache constructor. */
4151 static struct filename_seen_cache *
4152 create_filename_seen_cache (void)
4154 struct filename_seen_cache *cache = XNEW (struct filename_seen_cache);
4156 cache->tab = htab_create_alloc (INITIAL_FILENAME_SEEN_CACHE_SIZE,
4157 filename_hash, filename_eq,
4158 NULL, xcalloc, xfree);
4163 /* Empty the cache, but do not delete it. */
4166 clear_filename_seen_cache (struct filename_seen_cache *cache)
4168 htab_empty (cache->tab);
4171 /* filename_seen_cache destructor.
4172 This takes a void * argument as it is generally used as a cleanup. */
4175 delete_filename_seen_cache (void *ptr)
4177 struct filename_seen_cache *cache = (struct filename_seen_cache *) ptr;
4179 htab_delete (cache->tab);
4183 /* If FILE is not already in the table of files in CACHE, return zero;
4184 otherwise return non-zero. Optionally add FILE to the table if ADD
4187 NOTE: We don't manage space for FILE, we assume FILE lives as long
4188 as the caller needs. */
4191 filename_seen (struct filename_seen_cache *cache, const char *file, int add)
4195 /* Is FILE in tab? */
4196 slot = htab_find_slot (cache->tab, file, add ? INSERT : NO_INSERT);
4200 /* No; maybe add it to tab. */
4202 *slot = (char *) file;
4207 /* Data structure to maintain printing state for output_source_filename. */
4209 struct output_source_filename_data
4211 /* Cache of what we've seen so far. */
4212 struct filename_seen_cache *filename_seen_cache;
4214 /* Flag of whether we're printing the first one. */
4218 /* Slave routine for sources_info. Force line breaks at ,'s.
4219 NAME is the name to print.
4220 DATA contains the state for printing and watching for duplicates. */
4223 output_source_filename (const char *name,
4224 struct output_source_filename_data *data)
4226 /* Since a single source file can result in several partial symbol
4227 tables, we need to avoid printing it more than once. Note: if
4228 some of the psymtabs are read in and some are not, it gets
4229 printed both under "Source files for which symbols have been
4230 read" and "Source files for which symbols will be read in on
4231 demand". I consider this a reasonable way to deal with the
4232 situation. I'm not sure whether this can also happen for
4233 symtabs; it doesn't hurt to check. */
4235 /* Was NAME already seen? */
4236 if (filename_seen (data->filename_seen_cache, name, 1))
4238 /* Yes; don't print it again. */
4242 /* No; print it and reset *FIRST. */
4244 printf_filtered (", ");
4248 fputs_filtered (name, gdb_stdout);
4251 /* A callback for map_partial_symbol_filenames. */
4254 output_partial_symbol_filename (const char *filename, const char *fullname,
4257 output_source_filename (fullname ? fullname : filename,
4258 (struct output_source_filename_data *) data);
4262 sources_info (char *ignore, int from_tty)
4264 struct compunit_symtab *cu;
4266 struct objfile *objfile;
4267 struct output_source_filename_data data;
4268 struct cleanup *cleanups;
4270 if (!have_full_symbols () && !have_partial_symbols ())
4272 error (_("No symbol table is loaded. Use the \"file\" command."));
4275 data.filename_seen_cache = create_filename_seen_cache ();
4276 cleanups = make_cleanup (delete_filename_seen_cache,
4277 data.filename_seen_cache);
4279 printf_filtered ("Source files for which symbols have been read in:\n\n");
4282 ALL_FILETABS (objfile, cu, s)
4284 const char *fullname = symtab_to_fullname (s);
4286 output_source_filename (fullname, &data);
4288 printf_filtered ("\n\n");
4290 printf_filtered ("Source files for which symbols "
4291 "will be read in on demand:\n\n");
4293 clear_filename_seen_cache (data.filename_seen_cache);
4295 map_symbol_filenames (output_partial_symbol_filename, &data,
4296 1 /*need_fullname*/);
4297 printf_filtered ("\n");
4299 do_cleanups (cleanups);
4302 /* Compare FILE against all the NFILES entries of FILES. If BASENAMES is
4303 non-zero compare only lbasename of FILES. */
4306 file_matches (const char *file, const char *files[], int nfiles, int basenames)
4310 if (file != NULL && nfiles != 0)
4312 for (i = 0; i < nfiles; i++)
4314 if (compare_filenames_for_search (file, (basenames
4315 ? lbasename (files[i])
4320 else if (nfiles == 0)
4325 /* Free any memory associated with a search. */
4328 free_search_symbols (struct symbol_search *symbols)
4330 struct symbol_search *p;
4331 struct symbol_search *next;
4333 for (p = symbols; p != NULL; p = next)
4341 do_free_search_symbols_cleanup (void *symbolsp)
4343 struct symbol_search *symbols = *(struct symbol_search **) symbolsp;
4345 free_search_symbols (symbols);
4349 make_cleanup_free_search_symbols (struct symbol_search **symbolsp)
4351 return make_cleanup (do_free_search_symbols_cleanup, symbolsp);
4354 /* Helper function for sort_search_symbols_remove_dups and qsort. Can only
4355 sort symbols, not minimal symbols. */
4358 compare_search_syms (const void *sa, const void *sb)
4360 struct symbol_search *sym_a = *(struct symbol_search **) sa;
4361 struct symbol_search *sym_b = *(struct symbol_search **) sb;
4364 c = FILENAME_CMP (symbol_symtab (sym_a->symbol)->filename,
4365 symbol_symtab (sym_b->symbol)->filename);
4369 if (sym_a->block != sym_b->block)
4370 return sym_a->block - sym_b->block;
4372 return strcmp (SYMBOL_PRINT_NAME (sym_a->symbol),
4373 SYMBOL_PRINT_NAME (sym_b->symbol));
4376 /* Sort the NFOUND symbols in list FOUND and remove duplicates.
4377 The duplicates are freed, and the new list is returned in
4378 *NEW_HEAD, *NEW_TAIL. */
4381 sort_search_symbols_remove_dups (struct symbol_search *found, int nfound,
4382 struct symbol_search **new_head,
4383 struct symbol_search **new_tail)
4385 struct symbol_search **symbols, *symp, *old_next;
4388 gdb_assert (found != NULL && nfound > 0);
4390 /* Build an array out of the list so we can easily sort them. */
4391 symbols = XNEWVEC (struct symbol_search *, nfound);
4394 for (i = 0; i < nfound; i++)
4396 gdb_assert (symp != NULL);
4397 gdb_assert (symp->block >= 0 && symp->block <= 1);
4401 gdb_assert (symp == NULL);
4403 qsort (symbols, nfound, sizeof (struct symbol_search *),
4404 compare_search_syms);
4406 /* Collapse out the dups. */
4407 for (i = 1, j = 1; i < nfound; ++i)
4409 if (compare_search_syms (&symbols[j - 1], &symbols[i]) != 0)
4410 symbols[j++] = symbols[i];
4415 symbols[j - 1]->next = NULL;
4417 /* Rebuild the linked list. */
4418 for (i = 0; i < nunique - 1; i++)
4419 symbols[i]->next = symbols[i + 1];
4420 symbols[nunique - 1]->next = NULL;
4422 *new_head = symbols[0];
4423 *new_tail = symbols[nunique - 1];
4427 /* An object of this type is passed as the user_data to the
4428 expand_symtabs_matching method. */
4429 struct search_symbols_data
4434 /* It is true if PREG contains valid data, false otherwise. */
4435 unsigned preg_p : 1;
4439 /* A callback for expand_symtabs_matching. */
4442 search_symbols_file_matches (const char *filename, void *user_data,
4445 struct search_symbols_data *data = (struct search_symbols_data *) user_data;
4447 return file_matches (filename, data->files, data->nfiles, basenames);
4450 /* A callback for expand_symtabs_matching. */
4453 search_symbols_name_matches (const char *symname, void *user_data)
4455 struct search_symbols_data *data = (struct search_symbols_data *) user_data;
4457 return !data->preg_p || regexec (&data->preg, symname, 0, NULL, 0) == 0;
4460 /* Search the symbol table for matches to the regular expression REGEXP,
4461 returning the results in *MATCHES.
4463 Only symbols of KIND are searched:
4464 VARIABLES_DOMAIN - search all symbols, excluding functions, type names,
4465 and constants (enums)
4466 FUNCTIONS_DOMAIN - search all functions
4467 TYPES_DOMAIN - search all type names
4468 ALL_DOMAIN - an internal error for this function
4470 free_search_symbols should be called when *MATCHES is no longer needed.
4472 Within each file the results are sorted locally; each symtab's global and
4473 static blocks are separately alphabetized.
4474 Duplicate entries are removed. */
4477 search_symbols (const char *regexp, enum search_domain kind,
4478 int nfiles, const char *files[],
4479 struct symbol_search **matches)
4481 struct compunit_symtab *cust;
4482 const struct blockvector *bv;
4485 struct block_iterator iter;
4487 struct objfile *objfile;
4488 struct minimal_symbol *msymbol;
4490 static const enum minimal_symbol_type types[]
4491 = {mst_data, mst_text, mst_abs};
4492 static const enum minimal_symbol_type types2[]
4493 = {mst_bss, mst_file_text, mst_abs};
4494 static const enum minimal_symbol_type types3[]
4495 = {mst_file_data, mst_solib_trampoline, mst_abs};
4496 static const enum minimal_symbol_type types4[]
4497 = {mst_file_bss, mst_text_gnu_ifunc, mst_abs};
4498 enum minimal_symbol_type ourtype;
4499 enum minimal_symbol_type ourtype2;
4500 enum minimal_symbol_type ourtype3;
4501 enum minimal_symbol_type ourtype4;
4502 struct symbol_search *found;
4503 struct symbol_search *tail;
4504 struct search_symbols_data datum;
4507 /* OLD_CHAIN .. RETVAL_CHAIN is always freed, RETVAL_CHAIN .. current
4508 CLEANUP_CHAIN is freed only in the case of an error. */
4509 struct cleanup *old_chain = make_cleanup (null_cleanup, NULL);
4510 struct cleanup *retval_chain;
4512 gdb_assert (kind <= TYPES_DOMAIN);
4514 ourtype = types[kind];
4515 ourtype2 = types2[kind];
4516 ourtype3 = types3[kind];
4517 ourtype4 = types4[kind];
4524 /* Make sure spacing is right for C++ operators.
4525 This is just a courtesy to make the matching less sensitive
4526 to how many spaces the user leaves between 'operator'
4527 and <TYPENAME> or <OPERATOR>. */
4529 const char *opname = operator_chars (regexp, &opend);
4534 int fix = -1; /* -1 means ok; otherwise number of
4537 if (isalpha (*opname) || *opname == '_' || *opname == '$')
4539 /* There should 1 space between 'operator' and 'TYPENAME'. */
4540 if (opname[-1] != ' ' || opname[-2] == ' ')
4545 /* There should 0 spaces between 'operator' and 'OPERATOR'. */
4546 if (opname[-1] == ' ')
4549 /* If wrong number of spaces, fix it. */
4552 char *tmp = (char *) alloca (8 + fix + strlen (opname) + 1);
4554 sprintf (tmp, "operator%.*s%s", fix, " ", opname);
4559 errcode = regcomp (&datum.preg, regexp,
4560 REG_NOSUB | (case_sensitivity == case_sensitive_off
4564 char *err = get_regcomp_error (errcode, &datum.preg);
4566 make_cleanup (xfree, err);
4567 error (_("Invalid regexp (%s): %s"), err, regexp);
4570 make_regfree_cleanup (&datum.preg);
4573 /* Search through the partial symtabs *first* for all symbols
4574 matching the regexp. That way we don't have to reproduce all of
4575 the machinery below. */
4577 datum.nfiles = nfiles;
4578 datum.files = files;
4579 expand_symtabs_matching ((nfiles == 0
4581 : search_symbols_file_matches),
4582 search_symbols_name_matches,
4583 NULL, kind, &datum);
4585 /* Here, we search through the minimal symbol tables for functions
4586 and variables that match, and force their symbols to be read.
4587 This is in particular necessary for demangled variable names,
4588 which are no longer put into the partial symbol tables.
4589 The symbol will then be found during the scan of symtabs below.
4591 For functions, find_pc_symtab should succeed if we have debug info
4592 for the function, for variables we have to call
4593 lookup_symbol_in_objfile_from_linkage_name to determine if the variable
4595 If the lookup fails, set found_misc so that we will rescan to print
4596 any matching symbols without debug info.
4597 We only search the objfile the msymbol came from, we no longer search
4598 all objfiles. In large programs (1000s of shared libs) searching all
4599 objfiles is not worth the pain. */
4601 if (nfiles == 0 && (kind == VARIABLES_DOMAIN || kind == FUNCTIONS_DOMAIN))
4603 ALL_MSYMBOLS (objfile, msymbol)
4607 if (msymbol->created_by_gdb)
4610 if (MSYMBOL_TYPE (msymbol) == ourtype
4611 || MSYMBOL_TYPE (msymbol) == ourtype2
4612 || MSYMBOL_TYPE (msymbol) == ourtype3
4613 || MSYMBOL_TYPE (msymbol) == ourtype4)
4616 || regexec (&datum.preg, MSYMBOL_NATURAL_NAME (msymbol), 0,
4619 /* Note: An important side-effect of these lookup functions
4620 is to expand the symbol table if msymbol is found, for the
4621 benefit of the next loop on ALL_COMPUNITS. */
4622 if (kind == FUNCTIONS_DOMAIN
4623 ? (find_pc_compunit_symtab
4624 (MSYMBOL_VALUE_ADDRESS (objfile, msymbol)) == NULL)
4625 : (lookup_symbol_in_objfile_from_linkage_name
4626 (objfile, MSYMBOL_LINKAGE_NAME (msymbol), VAR_DOMAIN)
4637 retval_chain = make_cleanup_free_search_symbols (&found);
4639 ALL_COMPUNITS (objfile, cust)
4641 bv = COMPUNIT_BLOCKVECTOR (cust);
4642 for (i = GLOBAL_BLOCK; i <= STATIC_BLOCK; i++)
4644 b = BLOCKVECTOR_BLOCK (bv, i);
4645 ALL_BLOCK_SYMBOLS (b, iter, sym)
4647 struct symtab *real_symtab = symbol_symtab (sym);
4651 /* Check first sole REAL_SYMTAB->FILENAME. It does not need to be
4652 a substring of symtab_to_fullname as it may contain "./" etc. */
4653 if ((file_matches (real_symtab->filename, files, nfiles, 0)
4654 || ((basenames_may_differ
4655 || file_matches (lbasename (real_symtab->filename),
4657 && file_matches (symtab_to_fullname (real_symtab),
4660 || regexec (&datum.preg, SYMBOL_NATURAL_NAME (sym), 0,
4662 && ((kind == VARIABLES_DOMAIN
4663 && SYMBOL_CLASS (sym) != LOC_TYPEDEF
4664 && SYMBOL_CLASS (sym) != LOC_UNRESOLVED
4665 && SYMBOL_CLASS (sym) != LOC_BLOCK
4666 /* LOC_CONST can be used for more than just enums,
4667 e.g., c++ static const members.
4668 We only want to skip enums here. */
4669 && !(SYMBOL_CLASS (sym) == LOC_CONST
4670 && (TYPE_CODE (SYMBOL_TYPE (sym))
4671 == TYPE_CODE_ENUM)))
4672 || (kind == FUNCTIONS_DOMAIN
4673 && SYMBOL_CLASS (sym) == LOC_BLOCK)
4674 || (kind == TYPES_DOMAIN
4675 && SYMBOL_CLASS (sym) == LOC_TYPEDEF))))
4678 struct symbol_search *psr = XCNEW (struct symbol_search);
4696 sort_search_symbols_remove_dups (found, nfound, &found, &tail);
4697 /* Note: nfound is no longer useful beyond this point. */
4700 /* If there are no eyes, avoid all contact. I mean, if there are
4701 no debug symbols, then add matching minsyms. */
4703 if (found_misc || (nfiles == 0 && kind != FUNCTIONS_DOMAIN))
4705 ALL_MSYMBOLS (objfile, msymbol)
4709 if (msymbol->created_by_gdb)
4712 if (MSYMBOL_TYPE (msymbol) == ourtype
4713 || MSYMBOL_TYPE (msymbol) == ourtype2
4714 || MSYMBOL_TYPE (msymbol) == ourtype3
4715 || MSYMBOL_TYPE (msymbol) == ourtype4)
4718 || regexec (&datum.preg, MSYMBOL_NATURAL_NAME (msymbol), 0,
4721 /* For functions we can do a quick check of whether the
4722 symbol might be found via find_pc_symtab. */
4723 if (kind != FUNCTIONS_DOMAIN
4724 || (find_pc_compunit_symtab
4725 (MSYMBOL_VALUE_ADDRESS (objfile, msymbol)) == NULL))
4727 if (lookup_symbol_in_objfile_from_linkage_name
4728 (objfile, MSYMBOL_LINKAGE_NAME (msymbol), VAR_DOMAIN)
4732 struct symbol_search *psr = XNEW (struct symbol_search);
4734 psr->msymbol.minsym = msymbol;
4735 psr->msymbol.objfile = objfile;
4750 discard_cleanups (retval_chain);
4751 do_cleanups (old_chain);
4755 /* Helper function for symtab_symbol_info, this function uses
4756 the data returned from search_symbols() to print information
4757 regarding the match to gdb_stdout. */
4760 print_symbol_info (enum search_domain kind,
4762 int block, const char *last)
4764 struct symtab *s = symbol_symtab (sym);
4765 const char *s_filename = symtab_to_filename_for_display (s);
4767 if (last == NULL || filename_cmp (last, s_filename) != 0)
4769 fputs_filtered ("\nFile ", gdb_stdout);
4770 fputs_filtered (s_filename, gdb_stdout);
4771 fputs_filtered (":\n", gdb_stdout);
4774 if (kind != TYPES_DOMAIN && block == STATIC_BLOCK)
4775 printf_filtered ("static ");
4777 /* Typedef that is not a C++ class. */
4778 if (kind == TYPES_DOMAIN
4779 && SYMBOL_DOMAIN (sym) != STRUCT_DOMAIN)
4780 typedef_print (SYMBOL_TYPE (sym), sym, gdb_stdout);
4781 /* variable, func, or typedef-that-is-c++-class. */
4782 else if (kind < TYPES_DOMAIN
4783 || (kind == TYPES_DOMAIN
4784 && SYMBOL_DOMAIN (sym) == STRUCT_DOMAIN))
4786 type_print (SYMBOL_TYPE (sym),
4787 (SYMBOL_CLASS (sym) == LOC_TYPEDEF
4788 ? "" : SYMBOL_PRINT_NAME (sym)),
4791 printf_filtered (";\n");
4795 /* This help function for symtab_symbol_info() prints information
4796 for non-debugging symbols to gdb_stdout. */
4799 print_msymbol_info (struct bound_minimal_symbol msymbol)
4801 struct gdbarch *gdbarch = get_objfile_arch (msymbol.objfile);
4804 if (gdbarch_addr_bit (gdbarch) <= 32)
4805 tmp = hex_string_custom (BMSYMBOL_VALUE_ADDRESS (msymbol)
4806 & (CORE_ADDR) 0xffffffff,
4809 tmp = hex_string_custom (BMSYMBOL_VALUE_ADDRESS (msymbol),
4811 printf_filtered ("%s %s\n",
4812 tmp, MSYMBOL_PRINT_NAME (msymbol.minsym));
4815 /* This is the guts of the commands "info functions", "info types", and
4816 "info variables". It calls search_symbols to find all matches and then
4817 print_[m]symbol_info to print out some useful information about the
4821 symtab_symbol_info (char *regexp, enum search_domain kind, int from_tty)
4823 static const char * const classnames[] =
4824 {"variable", "function", "type"};
4825 struct symbol_search *symbols;
4826 struct symbol_search *p;
4827 struct cleanup *old_chain;
4828 const char *last_filename = NULL;
4831 gdb_assert (kind <= TYPES_DOMAIN);
4833 /* Must make sure that if we're interrupted, symbols gets freed. */
4834 search_symbols (regexp, kind, 0, NULL, &symbols);
4835 old_chain = make_cleanup_free_search_symbols (&symbols);
4838 printf_filtered (_("All %ss matching regular expression \"%s\":\n"),
4839 classnames[kind], regexp);
4841 printf_filtered (_("All defined %ss:\n"), classnames[kind]);
4843 for (p = symbols; p != NULL; p = p->next)
4847 if (p->msymbol.minsym != NULL)
4851 printf_filtered (_("\nNon-debugging symbols:\n"));
4854 print_msymbol_info (p->msymbol);
4858 print_symbol_info (kind,
4863 = symtab_to_filename_for_display (symbol_symtab (p->symbol));
4867 do_cleanups (old_chain);
4871 variables_info (char *regexp, int from_tty)
4873 symtab_symbol_info (regexp, VARIABLES_DOMAIN, from_tty);
4877 functions_info (char *regexp, int from_tty)
4879 symtab_symbol_info (regexp, FUNCTIONS_DOMAIN, from_tty);
4884 types_info (char *regexp, int from_tty)
4886 symtab_symbol_info (regexp, TYPES_DOMAIN, from_tty);
4889 /* Breakpoint all functions matching regular expression. */
4892 rbreak_command_wrapper (char *regexp, int from_tty)
4894 rbreak_command (regexp, from_tty);
4897 /* A cleanup function that calls end_rbreak_breakpoints. */
4900 do_end_rbreak_breakpoints (void *ignore)
4902 end_rbreak_breakpoints ();
4906 rbreak_command (char *regexp, int from_tty)
4908 struct symbol_search *ss;
4909 struct symbol_search *p;
4910 struct cleanup *old_chain;
4911 char *string = NULL;
4913 const char **files = NULL;
4914 const char *file_name;
4919 char *colon = strchr (regexp, ':');
4921 if (colon && *(colon + 1) != ':')
4926 colon_index = colon - regexp;
4927 local_name = (char *) alloca (colon_index + 1);
4928 memcpy (local_name, regexp, colon_index);
4929 local_name[colon_index--] = 0;
4930 while (isspace (local_name[colon_index]))
4931 local_name[colon_index--] = 0;
4932 file_name = local_name;
4935 regexp = skip_spaces (colon + 1);
4939 search_symbols (regexp, FUNCTIONS_DOMAIN, nfiles, files, &ss);
4940 old_chain = make_cleanup_free_search_symbols (&ss);
4941 make_cleanup (free_current_contents, &string);
4943 start_rbreak_breakpoints ();
4944 make_cleanup (do_end_rbreak_breakpoints, NULL);
4945 for (p = ss; p != NULL; p = p->next)
4947 if (p->msymbol.minsym == NULL)
4949 struct symtab *symtab = symbol_symtab (p->symbol);
4950 const char *fullname = symtab_to_fullname (symtab);
4952 int newlen = (strlen (fullname)
4953 + strlen (SYMBOL_LINKAGE_NAME (p->symbol))
4958 string = (char *) xrealloc (string, newlen);
4961 strcpy (string, fullname);
4962 strcat (string, ":'");
4963 strcat (string, SYMBOL_LINKAGE_NAME (p->symbol));
4964 strcat (string, "'");
4965 break_command (string, from_tty);
4966 print_symbol_info (FUNCTIONS_DOMAIN,
4969 symtab_to_filename_for_display (symtab));
4973 int newlen = (strlen (MSYMBOL_LINKAGE_NAME (p->msymbol.minsym)) + 3);
4977 string = (char *) xrealloc (string, newlen);
4980 strcpy (string, "'");
4981 strcat (string, MSYMBOL_LINKAGE_NAME (p->msymbol.minsym));
4982 strcat (string, "'");
4984 break_command (string, from_tty);
4985 printf_filtered ("<function, no debug info> %s;\n",
4986 MSYMBOL_PRINT_NAME (p->msymbol.minsym));
4990 do_cleanups (old_chain);
4994 /* Evaluate if NAME matches SYM_TEXT and SYM_TEXT_LEN.
4996 Either sym_text[sym_text_len] != '(' and then we search for any
4997 symbol starting with SYM_TEXT text.
4999 Otherwise sym_text[sym_text_len] == '(' and then we require symbol name to
5000 be terminated at that point. Partial symbol tables do not have parameters
5004 compare_symbol_name (const char *name, const char *sym_text, int sym_text_len)
5006 int (*ncmp) (const char *, const char *, size_t);
5008 ncmp = (case_sensitivity == case_sensitive_on ? strncmp : strncasecmp);
5010 if (ncmp (name, sym_text, sym_text_len) != 0)
5013 if (sym_text[sym_text_len] == '(')
5015 /* User searches for `name(someth...'. Require NAME to be terminated.
5016 Normally psymtabs and gdbindex have no parameter types so '\0' will be
5017 present but accept even parameters presence. In this case this
5018 function is in fact strcmp_iw but whitespace skipping is not supported
5019 for tab completion. */
5021 if (name[sym_text_len] != '\0' && name[sym_text_len] != '(')
5028 /* Free any memory associated with a completion list. */
5031 free_completion_list (VEC (char_ptr) **list_ptr)
5036 for (i = 0; VEC_iterate (char_ptr, *list_ptr, i, p); ++i)
5038 VEC_free (char_ptr, *list_ptr);
5041 /* Callback for make_cleanup. */
5044 do_free_completion_list (void *list)
5046 free_completion_list ((VEC (char_ptr) **) list);
5049 /* Helper routine for make_symbol_completion_list. */
5051 static VEC (char_ptr) *return_val;
5053 #define COMPLETION_LIST_ADD_SYMBOL(symbol, sym_text, len, text, word) \
5054 completion_list_add_name \
5055 (SYMBOL_NATURAL_NAME (symbol), (sym_text), (len), (text), (word))
5057 #define MCOMPLETION_LIST_ADD_SYMBOL(symbol, sym_text, len, text, word) \
5058 completion_list_add_name \
5059 (MSYMBOL_NATURAL_NAME (symbol), (sym_text), (len), (text), (word))
5061 /* Tracker for how many unique completions have been generated. Used
5062 to terminate completion list generation early if the list has grown
5063 to a size so large as to be useless. This helps avoid GDB seeming
5064 to lock up in the event the user requests to complete on something
5065 vague that necessitates the time consuming expansion of many symbol
5068 static completion_tracker_t completion_tracker;
5070 /* Test to see if the symbol specified by SYMNAME (which is already
5071 demangled for C++ symbols) matches SYM_TEXT in the first SYM_TEXT_LEN
5072 characters. If so, add it to the current completion list. */
5075 completion_list_add_name (const char *symname,
5076 const char *sym_text, int sym_text_len,
5077 const char *text, const char *word)
5079 /* Clip symbols that cannot match. */
5080 if (!compare_symbol_name (symname, sym_text, sym_text_len))
5083 /* We have a match for a completion, so add SYMNAME to the current list
5084 of matches. Note that the name is moved to freshly malloc'd space. */
5088 enum maybe_add_completion_enum add_status;
5090 if (word == sym_text)
5092 newobj = (char *) xmalloc (strlen (symname) + 5);
5093 strcpy (newobj, symname);
5095 else if (word > sym_text)
5097 /* Return some portion of symname. */
5098 newobj = (char *) xmalloc (strlen (symname) + 5);
5099 strcpy (newobj, symname + (word - sym_text));
5103 /* Return some of SYM_TEXT plus symname. */
5104 newobj = (char *) xmalloc (strlen (symname) + (sym_text - word) + 5);
5105 strncpy (newobj, word, sym_text - word);
5106 newobj[sym_text - word] = '\0';
5107 strcat (newobj, symname);
5110 add_status = maybe_add_completion (completion_tracker, newobj);
5114 case MAYBE_ADD_COMPLETION_OK:
5115 VEC_safe_push (char_ptr, return_val, newobj);
5117 case MAYBE_ADD_COMPLETION_OK_MAX_REACHED:
5118 VEC_safe_push (char_ptr, return_val, newobj);
5119 throw_max_completions_reached_error ();
5120 case MAYBE_ADD_COMPLETION_MAX_REACHED:
5122 throw_max_completions_reached_error ();
5123 case MAYBE_ADD_COMPLETION_DUPLICATE:
5130 /* ObjC: In case we are completing on a selector, look as the msymbol
5131 again and feed all the selectors into the mill. */
5134 completion_list_objc_symbol (struct minimal_symbol *msymbol,
5135 const char *sym_text, int sym_text_len,
5136 const char *text, const char *word)
5138 static char *tmp = NULL;
5139 static unsigned int tmplen = 0;
5141 const char *method, *category, *selector;
5144 method = MSYMBOL_NATURAL_NAME (msymbol);
5146 /* Is it a method? */
5147 if ((method[0] != '-') && (method[0] != '+'))
5150 if (sym_text[0] == '[')
5151 /* Complete on shortened method method. */
5152 completion_list_add_name (method + 1, sym_text, sym_text_len, text, word);
5154 while ((strlen (method) + 1) >= tmplen)
5160 tmp = (char *) xrealloc (tmp, tmplen);
5162 selector = strchr (method, ' ');
5163 if (selector != NULL)
5166 category = strchr (method, '(');
5168 if ((category != NULL) && (selector != NULL))
5170 memcpy (tmp, method, (category - method));
5171 tmp[category - method] = ' ';
5172 memcpy (tmp + (category - method) + 1, selector, strlen (selector) + 1);
5173 completion_list_add_name (tmp, sym_text, sym_text_len, text, word);
5174 if (sym_text[0] == '[')
5175 completion_list_add_name (tmp + 1, sym_text, sym_text_len, text, word);
5178 if (selector != NULL)
5180 /* Complete on selector only. */
5181 strcpy (tmp, selector);
5182 tmp2 = strchr (tmp, ']');
5186 completion_list_add_name (tmp, sym_text, sym_text_len, text, word);
5190 /* Break the non-quoted text based on the characters which are in
5191 symbols. FIXME: This should probably be language-specific. */
5194 language_search_unquoted_string (const char *text, const char *p)
5196 for (; p > text; --p)
5198 if (isalnum (p[-1]) || p[-1] == '_' || p[-1] == '\0')
5202 if ((current_language->la_language == language_objc))
5204 if (p[-1] == ':') /* Might be part of a method name. */
5206 else if (p[-1] == '[' && (p[-2] == '-' || p[-2] == '+'))
5207 p -= 2; /* Beginning of a method name. */
5208 else if (p[-1] == ' ' || p[-1] == '(' || p[-1] == ')')
5209 { /* Might be part of a method name. */
5212 /* Seeing a ' ' or a '(' is not conclusive evidence
5213 that we are in the middle of a method name. However,
5214 finding "-[" or "+[" should be pretty un-ambiguous.
5215 Unfortunately we have to find it now to decide. */
5218 if (isalnum (t[-1]) || t[-1] == '_' ||
5219 t[-1] == ' ' || t[-1] == ':' ||
5220 t[-1] == '(' || t[-1] == ')')
5225 if (t[-1] == '[' && (t[-2] == '-' || t[-2] == '+'))
5226 p = t - 2; /* Method name detected. */
5227 /* Else we leave with p unchanged. */
5237 completion_list_add_fields (struct symbol *sym, const char *sym_text,
5238 int sym_text_len, const char *text,
5241 if (SYMBOL_CLASS (sym) == LOC_TYPEDEF)
5243 struct type *t = SYMBOL_TYPE (sym);
5244 enum type_code c = TYPE_CODE (t);
5247 if (c == TYPE_CODE_UNION || c == TYPE_CODE_STRUCT)
5248 for (j = TYPE_N_BASECLASSES (t); j < TYPE_NFIELDS (t); j++)
5249 if (TYPE_FIELD_NAME (t, j))
5250 completion_list_add_name (TYPE_FIELD_NAME (t, j),
5251 sym_text, sym_text_len, text, word);
5255 /* Type of the user_data argument passed to add_macro_name,
5256 symbol_completion_matcher and symtab_expansion_callback. */
5258 struct add_name_data
5260 /* Arguments required by completion_list_add_name. */
5261 const char *sym_text;
5266 /* Extra argument required for add_symtab_completions. */
5267 enum type_code code;
5270 /* A callback used with macro_for_each and macro_for_each_in_scope.
5271 This adds a macro's name to the current completion list. */
5274 add_macro_name (const char *name, const struct macro_definition *ignore,
5275 struct macro_source_file *ignore2, int ignore3,
5278 struct add_name_data *datum = (struct add_name_data *) user_data;
5280 completion_list_add_name (name,
5281 datum->sym_text, datum->sym_text_len,
5282 datum->text, datum->word);
5285 /* A callback for expand_symtabs_matching. */
5288 symbol_completion_matcher (const char *name, void *user_data)
5290 struct add_name_data *datum = (struct add_name_data *) user_data;
5292 return compare_symbol_name (name, datum->sym_text, datum->sym_text_len);
5295 /* Add matching symbols from SYMTAB to the current completion list. */
5298 add_symtab_completions (struct compunit_symtab *cust,
5299 const char *sym_text, int sym_text_len,
5300 const char *text, const char *word,
5301 enum type_code code)
5304 const struct block *b;
5305 struct block_iterator iter;
5308 for (i = GLOBAL_BLOCK; i <= STATIC_BLOCK; i++)
5311 b = BLOCKVECTOR_BLOCK (COMPUNIT_BLOCKVECTOR (cust), i);
5312 ALL_BLOCK_SYMBOLS (b, iter, sym)
5314 if (code == TYPE_CODE_UNDEF
5315 || (SYMBOL_DOMAIN (sym) == STRUCT_DOMAIN
5316 && TYPE_CODE (SYMBOL_TYPE (sym)) == code))
5317 COMPLETION_LIST_ADD_SYMBOL (sym,
5318 sym_text, sym_text_len,
5324 /* Callback to add completions to the current list when symbol tables
5325 are expanded during completion list generation. */
5328 symtab_expansion_callback (struct compunit_symtab *symtab,
5331 struct add_name_data *datum = (struct add_name_data *) user_data;
5333 add_symtab_completions (symtab,
5334 datum->sym_text, datum->sym_text_len,
5335 datum->text, datum->word,
5340 default_make_symbol_completion_list_break_on_1 (const char *text,
5342 const char *break_on,
5343 enum type_code code)
5345 /* Problem: All of the symbols have to be copied because readline
5346 frees them. I'm not going to worry about this; hopefully there
5347 won't be that many. */
5350 struct compunit_symtab *cust;
5351 struct minimal_symbol *msymbol;
5352 struct objfile *objfile;
5353 const struct block *b;
5354 const struct block *surrounding_static_block, *surrounding_global_block;
5355 struct block_iterator iter;
5356 /* The symbol we are completing on. Points in same buffer as text. */
5357 const char *sym_text;
5358 /* Length of sym_text. */
5360 struct add_name_data datum;
5361 struct cleanup *cleanups;
5363 /* Now look for the symbol we are supposed to complete on. */
5367 const char *quote_pos = NULL;
5369 /* First see if this is a quoted string. */
5371 for (p = text; *p != '\0'; ++p)
5373 if (quote_found != '\0')
5375 if (*p == quote_found)
5376 /* Found close quote. */
5378 else if (*p == '\\' && p[1] == quote_found)
5379 /* A backslash followed by the quote character
5380 doesn't end the string. */
5383 else if (*p == '\'' || *p == '"')
5389 if (quote_found == '\'')
5390 /* A string within single quotes can be a symbol, so complete on it. */
5391 sym_text = quote_pos + 1;
5392 else if (quote_found == '"')
5393 /* A double-quoted string is never a symbol, nor does it make sense
5394 to complete it any other way. */
5400 /* It is not a quoted string. Break it based on the characters
5401 which are in symbols. */
5404 if (isalnum (p[-1]) || p[-1] == '_' || p[-1] == '\0'
5405 || p[-1] == ':' || strchr (break_on, p[-1]) != NULL)
5414 sym_text_len = strlen (sym_text);
5416 /* Prepare SYM_TEXT_LEN for compare_symbol_name. */
5418 if (current_language->la_language == language_cplus
5419 || current_language->la_language == language_java
5420 || current_language->la_language == language_fortran)
5422 /* These languages may have parameters entered by user but they are never
5423 present in the partial symbol tables. */
5425 const char *cs = memchr (sym_text, '(', sym_text_len);
5428 sym_text_len = cs - sym_text;
5430 gdb_assert (sym_text[sym_text_len] == '\0' || sym_text[sym_text_len] == '(');
5432 completion_tracker = new_completion_tracker ();
5433 cleanups = make_cleanup_free_completion_tracker (&completion_tracker);
5435 datum.sym_text = sym_text;
5436 datum.sym_text_len = sym_text_len;
5441 /* At this point scan through the misc symbol vectors and add each
5442 symbol you find to the list. Eventually we want to ignore
5443 anything that isn't a text symbol (everything else will be
5444 handled by the psymtab code below). */
5446 if (code == TYPE_CODE_UNDEF)
5448 ALL_MSYMBOLS (objfile, msymbol)
5451 MCOMPLETION_LIST_ADD_SYMBOL (msymbol, sym_text, sym_text_len, text,
5454 completion_list_objc_symbol (msymbol, sym_text, sym_text_len, text,
5459 /* Add completions for all currently loaded symbol tables. */
5460 ALL_COMPUNITS (objfile, cust)
5461 add_symtab_completions (cust, sym_text, sym_text_len, text, word,
5464 /* Look through the partial symtabs for all symbols which begin
5465 by matching SYM_TEXT. Expand all CUs that you find to the list.
5466 symtab_expansion_callback is called for each expanded symtab,
5467 causing those symtab's completions to be added to the list too. */
5468 expand_symtabs_matching (NULL, symbol_completion_matcher,
5469 symtab_expansion_callback, ALL_DOMAIN,
5472 /* Search upwards from currently selected frame (so that we can
5473 complete on local vars). Also catch fields of types defined in
5474 this places which match our text string. Only complete on types
5475 visible from current context. */
5477 b = get_selected_block (0);
5478 surrounding_static_block = block_static_block (b);
5479 surrounding_global_block = block_global_block (b);
5480 if (surrounding_static_block != NULL)
5481 while (b != surrounding_static_block)
5485 ALL_BLOCK_SYMBOLS (b, iter, sym)
5487 if (code == TYPE_CODE_UNDEF)
5489 COMPLETION_LIST_ADD_SYMBOL (sym, sym_text, sym_text_len, text,
5491 completion_list_add_fields (sym, sym_text, sym_text_len, text,
5494 else if (SYMBOL_DOMAIN (sym) == STRUCT_DOMAIN
5495 && TYPE_CODE (SYMBOL_TYPE (sym)) == code)
5496 COMPLETION_LIST_ADD_SYMBOL (sym, sym_text, sym_text_len, text,
5500 /* Stop when we encounter an enclosing function. Do not stop for
5501 non-inlined functions - the locals of the enclosing function
5502 are in scope for a nested function. */
5503 if (BLOCK_FUNCTION (b) != NULL && block_inlined_p (b))
5505 b = BLOCK_SUPERBLOCK (b);
5508 /* Add fields from the file's types; symbols will be added below. */
5510 if (code == TYPE_CODE_UNDEF)
5512 if (surrounding_static_block != NULL)
5513 ALL_BLOCK_SYMBOLS (surrounding_static_block, iter, sym)
5514 completion_list_add_fields (sym, sym_text, sym_text_len, text, word);
5516 if (surrounding_global_block != NULL)
5517 ALL_BLOCK_SYMBOLS (surrounding_global_block, iter, sym)
5518 completion_list_add_fields (sym, sym_text, sym_text_len, text, word);
5521 /* Skip macros if we are completing a struct tag -- arguable but
5522 usually what is expected. */
5523 if (current_language->la_macro_expansion == macro_expansion_c
5524 && code == TYPE_CODE_UNDEF)
5526 struct macro_scope *scope;
5528 /* Add any macros visible in the default scope. Note that this
5529 may yield the occasional wrong result, because an expression
5530 might be evaluated in a scope other than the default. For
5531 example, if the user types "break file:line if <TAB>", the
5532 resulting expression will be evaluated at "file:line" -- but
5533 at there does not seem to be a way to detect this at
5535 scope = default_macro_scope ();
5538 macro_for_each_in_scope (scope->file, scope->line,
5539 add_macro_name, &datum);
5543 /* User-defined macros are always visible. */
5544 macro_for_each (macro_user_macros, add_macro_name, &datum);
5547 do_cleanups (cleanups);
5551 default_make_symbol_completion_list_break_on (const char *text,
5553 const char *break_on,
5554 enum type_code code)
5556 struct cleanup *back_to;
5559 back_to = make_cleanup (do_free_completion_list, &return_val);
5563 default_make_symbol_completion_list_break_on_1 (text, word,
5566 CATCH (except, RETURN_MASK_ERROR)
5568 if (except.error != MAX_COMPLETIONS_REACHED_ERROR)
5569 throw_exception (except);
5573 discard_cleanups (back_to);
5578 default_make_symbol_completion_list (const char *text, const char *word,
5579 enum type_code code)
5581 return default_make_symbol_completion_list_break_on (text, word, "", code);
5584 /* Return a vector of all symbols (regardless of class) which begin by
5585 matching TEXT. If the answer is no symbols, then the return value
5589 make_symbol_completion_list (const char *text, const char *word)
5591 return current_language->la_make_symbol_completion_list (text, word,
5595 /* Like make_symbol_completion_list, but only return STRUCT_DOMAIN
5596 symbols whose type code is CODE. */
5599 make_symbol_completion_type (const char *text, const char *word,
5600 enum type_code code)
5602 gdb_assert (code == TYPE_CODE_UNION
5603 || code == TYPE_CODE_STRUCT
5604 || code == TYPE_CODE_ENUM);
5605 return current_language->la_make_symbol_completion_list (text, word, code);
5608 /* Like make_symbol_completion_list, but suitable for use as a
5609 completion function. */
5612 make_symbol_completion_list_fn (struct cmd_list_element *ignore,
5613 const char *text, const char *word)
5615 return make_symbol_completion_list (text, word);
5618 /* Like make_symbol_completion_list, but returns a list of symbols
5619 defined in a source file FILE. */
5621 static VEC (char_ptr) *
5622 make_file_symbol_completion_list_1 (const char *text, const char *word,
5623 const char *srcfile)
5628 struct block_iterator iter;
5629 /* The symbol we are completing on. Points in same buffer as text. */
5630 const char *sym_text;
5631 /* Length of sym_text. */
5634 /* Now look for the symbol we are supposed to complete on.
5635 FIXME: This should be language-specific. */
5639 const char *quote_pos = NULL;
5641 /* First see if this is a quoted string. */
5643 for (p = text; *p != '\0'; ++p)
5645 if (quote_found != '\0')
5647 if (*p == quote_found)
5648 /* Found close quote. */
5650 else if (*p == '\\' && p[1] == quote_found)
5651 /* A backslash followed by the quote character
5652 doesn't end the string. */
5655 else if (*p == '\'' || *p == '"')
5661 if (quote_found == '\'')
5662 /* A string within single quotes can be a symbol, so complete on it. */
5663 sym_text = quote_pos + 1;
5664 else if (quote_found == '"')
5665 /* A double-quoted string is never a symbol, nor does it make sense
5666 to complete it any other way. */
5672 /* Not a quoted string. */
5673 sym_text = language_search_unquoted_string (text, p);
5677 sym_text_len = strlen (sym_text);
5679 /* Find the symtab for SRCFILE (this loads it if it was not yet read
5681 s = lookup_symtab (srcfile);
5684 /* Maybe they typed the file with leading directories, while the
5685 symbol tables record only its basename. */
5686 const char *tail = lbasename (srcfile);
5689 s = lookup_symtab (tail);
5692 /* If we have no symtab for that file, return an empty list. */
5694 return (return_val);
5696 /* Go through this symtab and check the externs and statics for
5697 symbols which match. */
5699 b = BLOCKVECTOR_BLOCK (SYMTAB_BLOCKVECTOR (s), GLOBAL_BLOCK);
5700 ALL_BLOCK_SYMBOLS (b, iter, sym)
5702 COMPLETION_LIST_ADD_SYMBOL (sym, sym_text, sym_text_len, text, word);
5705 b = BLOCKVECTOR_BLOCK (SYMTAB_BLOCKVECTOR (s), STATIC_BLOCK);
5706 ALL_BLOCK_SYMBOLS (b, iter, sym)
5708 COMPLETION_LIST_ADD_SYMBOL (sym, sym_text, sym_text_len, text, word);
5711 return (return_val);
5714 /* Wrapper around make_file_symbol_completion_list_1
5715 to handle MAX_COMPLETIONS_REACHED_ERROR. */
5718 make_file_symbol_completion_list (const char *text, const char *word,
5719 const char *srcfile)
5721 struct cleanup *back_to, *cleanups;
5723 completion_tracker = new_completion_tracker ();
5724 cleanups = make_cleanup_free_completion_tracker (&completion_tracker);
5726 back_to = make_cleanup (do_free_completion_list, &return_val);
5730 make_file_symbol_completion_list_1 (text, word, srcfile);
5732 CATCH (except, RETURN_MASK_ERROR)
5734 if (except.error != MAX_COMPLETIONS_REACHED_ERROR)
5735 throw_exception (except);
5739 discard_cleanups (back_to);
5740 do_cleanups (cleanups);
5744 /* A helper function for make_source_files_completion_list. It adds
5745 another file name to a list of possible completions, growing the
5746 list as necessary. */
5749 add_filename_to_list (const char *fname, const char *text, const char *word,
5750 VEC (char_ptr) **list)
5753 size_t fnlen = strlen (fname);
5757 /* Return exactly fname. */
5758 newobj = (char *) xmalloc (fnlen + 5);
5759 strcpy (newobj, fname);
5761 else if (word > text)
5763 /* Return some portion of fname. */
5764 newobj = (char *) xmalloc (fnlen + 5);
5765 strcpy (newobj, fname + (word - text));
5769 /* Return some of TEXT plus fname. */
5770 newobj = (char *) xmalloc (fnlen + (text - word) + 5);
5771 strncpy (newobj, word, text - word);
5772 newobj[text - word] = '\0';
5773 strcat (newobj, fname);
5775 VEC_safe_push (char_ptr, *list, newobj);
5779 not_interesting_fname (const char *fname)
5781 static const char *illegal_aliens[] = {
5782 "_globals_", /* inserted by coff_symtab_read */
5787 for (i = 0; illegal_aliens[i]; i++)
5789 if (filename_cmp (fname, illegal_aliens[i]) == 0)
5795 /* An object of this type is passed as the user_data argument to
5796 map_partial_symbol_filenames. */
5797 struct add_partial_filename_data
5799 struct filename_seen_cache *filename_seen_cache;
5803 VEC (char_ptr) **list;
5806 /* A callback for map_partial_symbol_filenames. */
5809 maybe_add_partial_symtab_filename (const char *filename, const char *fullname,
5812 struct add_partial_filename_data *data
5813 = (struct add_partial_filename_data *) user_data;
5815 if (not_interesting_fname (filename))
5817 if (!filename_seen (data->filename_seen_cache, filename, 1)
5818 && filename_ncmp (filename, data->text, data->text_len) == 0)
5820 /* This file matches for a completion; add it to the
5821 current list of matches. */
5822 add_filename_to_list (filename, data->text, data->word, data->list);
5826 const char *base_name = lbasename (filename);
5828 if (base_name != filename
5829 && !filename_seen (data->filename_seen_cache, base_name, 1)
5830 && filename_ncmp (base_name, data->text, data->text_len) == 0)
5831 add_filename_to_list (base_name, data->text, data->word, data->list);
5835 /* Return a vector of all source files whose names begin with matching
5836 TEXT. The file names are looked up in the symbol tables of this
5837 program. If the answer is no matchess, then the return value is
5841 make_source_files_completion_list (const char *text, const char *word)
5843 struct compunit_symtab *cu;
5845 struct objfile *objfile;
5846 size_t text_len = strlen (text);
5847 VEC (char_ptr) *list = NULL;
5848 const char *base_name;
5849 struct add_partial_filename_data datum;
5850 struct filename_seen_cache *filename_seen_cache;
5851 struct cleanup *back_to, *cache_cleanup;
5853 if (!have_full_symbols () && !have_partial_symbols ())
5856 back_to = make_cleanup (do_free_completion_list, &list);
5858 filename_seen_cache = create_filename_seen_cache ();
5859 cache_cleanup = make_cleanup (delete_filename_seen_cache,
5860 filename_seen_cache);
5862 ALL_FILETABS (objfile, cu, s)
5864 if (not_interesting_fname (s->filename))
5866 if (!filename_seen (filename_seen_cache, s->filename, 1)
5867 && filename_ncmp (s->filename, text, text_len) == 0)
5869 /* This file matches for a completion; add it to the current
5871 add_filename_to_list (s->filename, text, word, &list);
5875 /* NOTE: We allow the user to type a base name when the
5876 debug info records leading directories, but not the other
5877 way around. This is what subroutines of breakpoint
5878 command do when they parse file names. */
5879 base_name = lbasename (s->filename);
5880 if (base_name != s->filename
5881 && !filename_seen (filename_seen_cache, base_name, 1)
5882 && filename_ncmp (base_name, text, text_len) == 0)
5883 add_filename_to_list (base_name, text, word, &list);
5887 datum.filename_seen_cache = filename_seen_cache;
5890 datum.text_len = text_len;
5892 map_symbol_filenames (maybe_add_partial_symtab_filename, &datum,
5893 0 /*need_fullname*/);
5895 do_cleanups (cache_cleanup);
5896 discard_cleanups (back_to);
5903 /* Return the "main_info" object for the current program space. If
5904 the object has not yet been created, create it and fill in some
5907 static struct main_info *
5908 get_main_info (void)
5910 struct main_info *info
5911 = (struct main_info *) program_space_data (current_program_space,
5912 main_progspace_key);
5916 /* It may seem strange to store the main name in the progspace
5917 and also in whatever objfile happens to see a main name in
5918 its debug info. The reason for this is mainly historical:
5919 gdb returned "main" as the name even if no function named
5920 "main" was defined the program; and this approach lets us
5921 keep compatibility. */
5922 info = XCNEW (struct main_info);
5923 info->language_of_main = language_unknown;
5924 set_program_space_data (current_program_space, main_progspace_key,
5931 /* A cleanup to destroy a struct main_info when a progspace is
5935 main_info_cleanup (struct program_space *pspace, void *data)
5937 struct main_info *info = (struct main_info *) data;
5940 xfree (info->name_of_main);
5945 set_main_name (const char *name, enum language lang)
5947 struct main_info *info = get_main_info ();
5949 if (info->name_of_main != NULL)
5951 xfree (info->name_of_main);
5952 info->name_of_main = NULL;
5953 info->language_of_main = language_unknown;
5957 info->name_of_main = xstrdup (name);
5958 info->language_of_main = lang;
5962 /* Deduce the name of the main procedure, and set NAME_OF_MAIN
5966 find_main_name (void)
5968 const char *new_main_name;
5969 struct objfile *objfile;
5971 /* First check the objfiles to see whether a debuginfo reader has
5972 picked up the appropriate main name. Historically the main name
5973 was found in a more or less random way; this approach instead
5974 relies on the order of objfile creation -- which still isn't
5975 guaranteed to get the correct answer, but is just probably more
5977 ALL_OBJFILES (objfile)
5979 if (objfile->per_bfd->name_of_main != NULL)
5981 set_main_name (objfile->per_bfd->name_of_main,
5982 objfile->per_bfd->language_of_main);
5987 /* Try to see if the main procedure is in Ada. */
5988 /* FIXME: brobecker/2005-03-07: Another way of doing this would
5989 be to add a new method in the language vector, and call this
5990 method for each language until one of them returns a non-empty
5991 name. This would allow us to remove this hard-coded call to
5992 an Ada function. It is not clear that this is a better approach
5993 at this point, because all methods need to be written in a way
5994 such that false positives never be returned. For instance, it is
5995 important that a method does not return a wrong name for the main
5996 procedure if the main procedure is actually written in a different
5997 language. It is easy to guaranty this with Ada, since we use a
5998 special symbol generated only when the main in Ada to find the name
5999 of the main procedure. It is difficult however to see how this can
6000 be guarantied for languages such as C, for instance. This suggests
6001 that order of call for these methods becomes important, which means
6002 a more complicated approach. */
6003 new_main_name = ada_main_name ();
6004 if (new_main_name != NULL)
6006 set_main_name (new_main_name, language_ada);
6010 new_main_name = d_main_name ();
6011 if (new_main_name != NULL)
6013 set_main_name (new_main_name, language_d);
6017 new_main_name = go_main_name ();
6018 if (new_main_name != NULL)
6020 set_main_name (new_main_name, language_go);
6024 new_main_name = pascal_main_name ();
6025 if (new_main_name != NULL)
6027 set_main_name (new_main_name, language_pascal);
6031 /* The languages above didn't identify the name of the main procedure.
6032 Fallback to "main". */
6033 set_main_name ("main", language_unknown);
6039 struct main_info *info = get_main_info ();
6041 if (info->name_of_main == NULL)
6044 return info->name_of_main;
6047 /* Return the language of the main function. If it is not known,
6048 return language_unknown. */
6051 main_language (void)
6053 struct main_info *info = get_main_info ();
6055 if (info->name_of_main == NULL)
6058 return info->language_of_main;
6061 /* Handle ``executable_changed'' events for the symtab module. */
6064 symtab_observer_executable_changed (void)
6066 /* NAME_OF_MAIN may no longer be the same, so reset it for now. */
6067 set_main_name (NULL, language_unknown);
6070 /* Return 1 if the supplied producer string matches the ARM RealView
6071 compiler (armcc). */
6074 producer_is_realview (const char *producer)
6076 static const char *const arm_idents[] = {
6077 "ARM C Compiler, ADS",
6078 "Thumb C Compiler, ADS",
6079 "ARM C++ Compiler, ADS",
6080 "Thumb C++ Compiler, ADS",
6081 "ARM/Thumb C/C++ Compiler, RVCT",
6082 "ARM C/C++ Compiler, RVCT"
6086 if (producer == NULL)
6089 for (i = 0; i < ARRAY_SIZE (arm_idents); i++)
6090 if (startswith (producer, arm_idents[i]))
6098 /* The next index to hand out in response to a registration request. */
6100 static int next_aclass_value = LOC_FINAL_VALUE;
6102 /* The maximum number of "aclass" registrations we support. This is
6103 constant for convenience. */
6104 #define MAX_SYMBOL_IMPLS (LOC_FINAL_VALUE + 10)
6106 /* The objects representing the various "aclass" values. The elements
6107 from 0 up to LOC_FINAL_VALUE-1 represent themselves, and subsequent
6108 elements are those registered at gdb initialization time. */
6110 static struct symbol_impl symbol_impl[MAX_SYMBOL_IMPLS];
6112 /* The globally visible pointer. This is separate from 'symbol_impl'
6113 so that it can be const. */
6115 const struct symbol_impl *symbol_impls = &symbol_impl[0];
6117 /* Make sure we saved enough room in struct symbol. */
6119 gdb_static_assert (MAX_SYMBOL_IMPLS <= (1 << SYMBOL_ACLASS_BITS));
6121 /* Register a computed symbol type. ACLASS must be LOC_COMPUTED. OPS
6122 is the ops vector associated with this index. This returns the new
6123 index, which should be used as the aclass_index field for symbols
6127 register_symbol_computed_impl (enum address_class aclass,
6128 const struct symbol_computed_ops *ops)
6130 int result = next_aclass_value++;
6132 gdb_assert (aclass == LOC_COMPUTED);
6133 gdb_assert (result < MAX_SYMBOL_IMPLS);
6134 symbol_impl[result].aclass = aclass;
6135 symbol_impl[result].ops_computed = ops;
6137 /* Sanity check OPS. */
6138 gdb_assert (ops != NULL);
6139 gdb_assert (ops->tracepoint_var_ref != NULL);
6140 gdb_assert (ops->describe_location != NULL);
6141 gdb_assert (ops->read_needs_frame != NULL);
6142 gdb_assert (ops->read_variable != NULL);
6147 /* Register a function with frame base type. ACLASS must be LOC_BLOCK.
6148 OPS is the ops vector associated with this index. This returns the
6149 new index, which should be used as the aclass_index field for symbols
6153 register_symbol_block_impl (enum address_class aclass,
6154 const struct symbol_block_ops *ops)
6156 int result = next_aclass_value++;
6158 gdb_assert (aclass == LOC_BLOCK);
6159 gdb_assert (result < MAX_SYMBOL_IMPLS);
6160 symbol_impl[result].aclass = aclass;
6161 symbol_impl[result].ops_block = ops;
6163 /* Sanity check OPS. */
6164 gdb_assert (ops != NULL);
6165 gdb_assert (ops->find_frame_base_location != NULL);
6170 /* Register a register symbol type. ACLASS must be LOC_REGISTER or
6171 LOC_REGPARM_ADDR. OPS is the register ops vector associated with
6172 this index. This returns the new index, which should be used as
6173 the aclass_index field for symbols of this type. */
6176 register_symbol_register_impl (enum address_class aclass,
6177 const struct symbol_register_ops *ops)
6179 int result = next_aclass_value++;
6181 gdb_assert (aclass == LOC_REGISTER || aclass == LOC_REGPARM_ADDR);
6182 gdb_assert (result < MAX_SYMBOL_IMPLS);
6183 symbol_impl[result].aclass = aclass;
6184 symbol_impl[result].ops_register = ops;
6189 /* Initialize elements of 'symbol_impl' for the constants in enum
6193 initialize_ordinary_address_classes (void)
6197 for (i = 0; i < LOC_FINAL_VALUE; ++i)
6198 symbol_impl[i].aclass = (enum address_class) i;
6203 /* Helper function to initialize the fields of an objfile-owned symbol.
6204 It assumed that *SYM is already all zeroes. */
6207 initialize_objfile_symbol_1 (struct symbol *sym)
6209 SYMBOL_OBJFILE_OWNED (sym) = 1;
6210 SYMBOL_SECTION (sym) = -1;
6213 /* Initialize the symbol SYM, and mark it as being owned by an objfile. */
6216 initialize_objfile_symbol (struct symbol *sym)
6218 memset (sym, 0, sizeof (*sym));
6219 initialize_objfile_symbol_1 (sym);
6222 /* Allocate and initialize a new 'struct symbol' on OBJFILE's
6226 allocate_symbol (struct objfile *objfile)
6228 struct symbol *result;
6230 result = OBSTACK_ZALLOC (&objfile->objfile_obstack, struct symbol);
6231 initialize_objfile_symbol_1 (result);
6236 /* Allocate and initialize a new 'struct template_symbol' on OBJFILE's
6239 struct template_symbol *
6240 allocate_template_symbol (struct objfile *objfile)
6242 struct template_symbol *result;
6244 result = OBSTACK_ZALLOC (&objfile->objfile_obstack, struct template_symbol);
6245 initialize_objfile_symbol_1 (&result->base);
6253 symbol_objfile (const struct symbol *symbol)
6255 gdb_assert (SYMBOL_OBJFILE_OWNED (symbol));
6256 return SYMTAB_OBJFILE (symbol->owner.symtab);
6262 symbol_arch (const struct symbol *symbol)
6264 if (!SYMBOL_OBJFILE_OWNED (symbol))
6265 return symbol->owner.arch;
6266 return get_objfile_arch (SYMTAB_OBJFILE (symbol->owner.symtab));
6272 symbol_symtab (const struct symbol *symbol)
6274 gdb_assert (SYMBOL_OBJFILE_OWNED (symbol));
6275 return symbol->owner.symtab;
6281 symbol_set_symtab (struct symbol *symbol, struct symtab *symtab)
6283 gdb_assert (SYMBOL_OBJFILE_OWNED (symbol));
6284 symbol->owner.symtab = symtab;
6290 _initialize_symtab (void)
6292 initialize_ordinary_address_classes ();
6295 = register_program_space_data_with_cleanup (NULL, main_info_cleanup);
6298 = register_program_space_data_with_cleanup (NULL, symbol_cache_cleanup);
6300 add_info ("variables", variables_info, _("\
6301 All global and static variable names, or those matching REGEXP."));
6303 add_com ("whereis", class_info, variables_info, _("\
6304 All global and static variable names, or those matching REGEXP."));
6306 add_info ("functions", functions_info,
6307 _("All function names, or those matching REGEXP."));
6309 /* FIXME: This command has at least the following problems:
6310 1. It prints builtin types (in a very strange and confusing fashion).
6311 2. It doesn't print right, e.g. with
6312 typedef struct foo *FOO
6313 type_print prints "FOO" when we want to make it (in this situation)
6314 print "struct foo *".
6315 I also think "ptype" or "whatis" is more likely to be useful (but if
6316 there is much disagreement "info types" can be fixed). */
6317 add_info ("types", types_info,
6318 _("All type names, or those matching REGEXP."));
6320 add_info ("sources", sources_info,
6321 _("Source files in the program."));
6323 add_com ("rbreak", class_breakpoint, rbreak_command,
6324 _("Set a breakpoint for all functions matching REGEXP."));
6326 add_setshow_enum_cmd ("multiple-symbols", no_class,
6327 multiple_symbols_modes, &multiple_symbols_mode,
6329 Set the debugger behavior when more than one symbol are possible matches\n\
6330 in an expression."), _("\
6331 Show how the debugger handles ambiguities in expressions."), _("\
6332 Valid values are \"ask\", \"all\", \"cancel\", and the default is \"all\"."),
6333 NULL, NULL, &setlist, &showlist);
6335 add_setshow_boolean_cmd ("basenames-may-differ", class_obscure,
6336 &basenames_may_differ, _("\
6337 Set whether a source file may have multiple base names."), _("\
6338 Show whether a source file may have multiple base names."), _("\
6339 (A \"base name\" is the name of a file with the directory part removed.\n\
6340 Example: The base name of \"/home/user/hello.c\" is \"hello.c\".)\n\
6341 If set, GDB will canonicalize file names (e.g., expand symlinks)\n\
6342 before comparing them. Canonicalization is an expensive operation,\n\
6343 but it allows the same file be known by more than one base name.\n\
6344 If not set (the default), all source files are assumed to have just\n\
6345 one base name, and gdb will do file name comparisons more efficiently."),
6347 &setlist, &showlist);
6349 add_setshow_zuinteger_cmd ("symtab-create", no_class, &symtab_create_debug,
6350 _("Set debugging of symbol table creation."),
6351 _("Show debugging of symbol table creation."), _("\
6352 When enabled (non-zero), debugging messages are printed when building\n\
6353 symbol tables. A value of 1 (one) normally provides enough information.\n\
6354 A value greater than 1 provides more verbose information."),
6357 &setdebuglist, &showdebuglist);
6359 add_setshow_zuinteger_cmd ("symbol-lookup", no_class, &symbol_lookup_debug,
6361 Set debugging of symbol lookup."), _("\
6362 Show debugging of symbol lookup."), _("\
6363 When enabled (non-zero), symbol lookups are logged."),
6365 &setdebuglist, &showdebuglist);
6367 add_setshow_zuinteger_cmd ("symbol-cache-size", no_class,
6368 &new_symbol_cache_size,
6369 _("Set the size of the symbol cache."),
6370 _("Show the size of the symbol cache."), _("\
6371 The size of the symbol cache.\n\
6372 If zero then the symbol cache is disabled."),
6373 set_symbol_cache_size_handler, NULL,
6374 &maintenance_set_cmdlist,
6375 &maintenance_show_cmdlist);
6377 add_cmd ("symbol-cache", class_maintenance, maintenance_print_symbol_cache,
6378 _("Dump the symbol cache for each program space."),
6379 &maintenanceprintlist);
6381 add_cmd ("symbol-cache-statistics", class_maintenance,
6382 maintenance_print_symbol_cache_statistics,
6383 _("Print symbol cache statistics for each program space."),
6384 &maintenanceprintlist);
6386 add_cmd ("flush-symbol-cache", class_maintenance,
6387 maintenance_flush_symbol_cache,
6388 _("Flush the symbol cache for each program space."),
6391 observer_attach_executable_changed (symtab_observer_executable_changed);
6392 observer_attach_new_objfile (symtab_new_objfile_observer);
6393 observer_attach_free_objfile (symtab_free_objfile_observer);