1 /* Symbol table lookup for the GNU debugger, GDB.
3 Copyright (C) 1986-2013 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>
53 #include "gdb_string.h"
57 #include "cp-support.h"
59 #include "gdb_assert.h"
62 #include "macroscope.h"
65 #include "parser-defs.h"
67 /* Prototypes for local functions */
69 static void rbreak_command (char *, int);
71 static void types_info (char *, int);
73 static void functions_info (char *, int);
75 static void variables_info (char *, int);
77 static void sources_info (char *, int);
79 static int find_line_common (struct linetable *, int, int *, int);
81 static struct symbol *lookup_symbol_aux (const char *name,
82 const struct block *block,
83 const domain_enum domain,
84 enum language language,
85 struct field_of_this_result *is_a_field_of_this);
88 struct symbol *lookup_symbol_aux_local (const char *name,
89 const struct block *block,
90 const domain_enum domain,
91 enum language language);
94 struct symbol *lookup_symbol_aux_symtabs (int block_index,
96 const domain_enum domain);
99 struct symbol *lookup_symbol_aux_quick (struct objfile *objfile,
102 const domain_enum domain);
104 void _initialize_symtab (void);
108 /* When non-zero, print debugging messages related to symtab creation. */
109 int symtab_create_debug = 0;
111 /* Non-zero if a file may be known by two different basenames.
112 This is the uncommon case, and significantly slows down gdb.
113 Default set to "off" to not slow down the common case. */
114 int basenames_may_differ = 0;
116 /* Allow the user to configure the debugger behavior with respect
117 to multiple-choice menus when more than one symbol matches during
120 const char multiple_symbols_ask[] = "ask";
121 const char multiple_symbols_all[] = "all";
122 const char multiple_symbols_cancel[] = "cancel";
123 static const char *const multiple_symbols_modes[] =
125 multiple_symbols_ask,
126 multiple_symbols_all,
127 multiple_symbols_cancel,
130 static const char *multiple_symbols_mode = multiple_symbols_all;
132 /* Read-only accessor to AUTO_SELECT_MODE. */
135 multiple_symbols_select_mode (void)
137 return multiple_symbols_mode;
140 /* Block in which the most recently searched-for symbol was found.
141 Might be better to make this a parameter to lookup_symbol and
144 const struct block *block_found;
146 /* Return the name of a domain_enum. */
149 domain_name (domain_enum e)
153 case UNDEF_DOMAIN: return "UNDEF_DOMAIN";
154 case VAR_DOMAIN: return "VAR_DOMAIN";
155 case STRUCT_DOMAIN: return "STRUCT_DOMAIN";
156 case LABEL_DOMAIN: return "LABEL_DOMAIN";
157 case COMMON_BLOCK_DOMAIN: return "COMMON_BLOCK_DOMAIN";
158 default: gdb_assert_not_reached ("bad domain_enum");
162 /* Return the name of a search_domain . */
165 search_domain_name (enum search_domain e)
169 case VARIABLES_DOMAIN: return "VARIABLES_DOMAIN";
170 case FUNCTIONS_DOMAIN: return "FUNCTIONS_DOMAIN";
171 case TYPES_DOMAIN: return "TYPES_DOMAIN";
172 case ALL_DOMAIN: return "ALL_DOMAIN";
173 default: gdb_assert_not_reached ("bad search_domain");
177 /* See whether FILENAME matches SEARCH_NAME using the rule that we
178 advertise to the user. (The manual's description of linespecs
179 describes what we advertise). Returns true if they match, false
183 compare_filenames_for_search (const char *filename, const char *search_name)
185 int len = strlen (filename);
186 size_t search_len = strlen (search_name);
188 if (len < search_len)
191 /* The tail of FILENAME must match. */
192 if (FILENAME_CMP (filename + len - search_len, search_name) != 0)
195 /* Either the names must completely match, or the character
196 preceding the trailing SEARCH_NAME segment of FILENAME must be a
199 The check !IS_ABSOLUTE_PATH ensures SEARCH_NAME "/dir/file.c"
200 cannot match FILENAME "/path//dir/file.c" - as user has requested
201 absolute path. The sama applies for "c:\file.c" possibly
202 incorrectly hypothetically matching "d:\dir\c:\file.c".
204 The HAS_DRIVE_SPEC purpose is to make FILENAME "c:file.c"
205 compatible with SEARCH_NAME "file.c". In such case a compiler had
206 to put the "c:file.c" name into debug info. Such compatibility
207 works only on GDB built for DOS host. */
208 return (len == search_len
209 || (!IS_ABSOLUTE_PATH (search_name)
210 && IS_DIR_SEPARATOR (filename[len - search_len - 1]))
211 || (HAS_DRIVE_SPEC (filename)
212 && STRIP_DRIVE_SPEC (filename) == &filename[len - search_len]));
215 /* Check for a symtab of a specific name by searching some symtabs.
216 This is a helper function for callbacks of iterate_over_symtabs.
218 If NAME is not absolute, then REAL_PATH is NULL
219 If NAME is absolute, then REAL_PATH is the gdb_realpath form of NAME.
221 The return value, NAME, REAL_PATH, CALLBACK, and DATA
222 are identical to the `map_symtabs_matching_filename' method of
223 quick_symbol_functions.
225 FIRST and AFTER_LAST indicate the range of symtabs to search.
226 AFTER_LAST is one past the last symtab to search; NULL means to
227 search until the end of the list. */
230 iterate_over_some_symtabs (const char *name,
231 const char *real_path,
232 int (*callback) (struct symtab *symtab,
235 struct symtab *first,
236 struct symtab *after_last)
238 struct symtab *s = NULL;
239 const char* base_name = lbasename (name);
241 for (s = first; s != NULL && s != after_last; s = s->next)
243 if (compare_filenames_for_search (s->filename, name))
245 if (callback (s, data))
250 /* Before we invoke realpath, which can get expensive when many
251 files are involved, do a quick comparison of the basenames. */
252 if (! basenames_may_differ
253 && FILENAME_CMP (base_name, lbasename (s->filename)) != 0)
256 if (compare_filenames_for_search (symtab_to_fullname (s), name))
258 if (callback (s, data))
263 /* If the user gave us an absolute path, try to find the file in
264 this symtab and use its absolute path. */
265 if (real_path != NULL)
267 const char *fullname = symtab_to_fullname (s);
269 gdb_assert (IS_ABSOLUTE_PATH (real_path));
270 gdb_assert (IS_ABSOLUTE_PATH (name));
271 if (FILENAME_CMP (real_path, fullname) == 0)
273 if (callback (s, data))
283 /* Check for a symtab of a specific name; first in symtabs, then in
284 psymtabs. *If* there is no '/' in the name, a match after a '/'
285 in the symtab filename will also work.
287 Calls CALLBACK with each symtab that is found and with the supplied
288 DATA. If CALLBACK returns true, the search stops. */
291 iterate_over_symtabs (const char *name,
292 int (*callback) (struct symtab *symtab,
296 struct objfile *objfile;
297 char *real_path = NULL;
298 struct cleanup *cleanups = make_cleanup (null_cleanup, NULL);
300 /* Here we are interested in canonicalizing an absolute path, not
301 absolutizing a relative path. */
302 if (IS_ABSOLUTE_PATH (name))
304 real_path = gdb_realpath (name);
305 make_cleanup (xfree, real_path);
306 gdb_assert (IS_ABSOLUTE_PATH (real_path));
309 ALL_OBJFILES (objfile)
311 if (iterate_over_some_symtabs (name, real_path, callback, data,
312 objfile->symtabs, NULL))
314 do_cleanups (cleanups);
319 /* Same search rules as above apply here, but now we look thru the
322 ALL_OBJFILES (objfile)
325 && objfile->sf->qf->map_symtabs_matching_filename (objfile,
331 do_cleanups (cleanups);
336 do_cleanups (cleanups);
339 /* The callback function used by lookup_symtab. */
342 lookup_symtab_callback (struct symtab *symtab, void *data)
344 struct symtab **result_ptr = data;
346 *result_ptr = symtab;
350 /* A wrapper for iterate_over_symtabs that returns the first matching
354 lookup_symtab (const char *name)
356 struct symtab *result = NULL;
358 iterate_over_symtabs (name, lookup_symtab_callback, &result);
363 /* Mangle a GDB method stub type. This actually reassembles the pieces of the
364 full method name, which consist of the class name (from T), the unadorned
365 method name from METHOD_ID, and the signature for the specific overload,
366 specified by SIGNATURE_ID. Note that this function is g++ specific. */
369 gdb_mangle_name (struct type *type, int method_id, int signature_id)
371 int mangled_name_len;
373 struct fn_field *f = TYPE_FN_FIELDLIST1 (type, method_id);
374 struct fn_field *method = &f[signature_id];
375 const char *field_name = TYPE_FN_FIELDLIST_NAME (type, method_id);
376 const char *physname = TYPE_FN_FIELD_PHYSNAME (f, signature_id);
377 const char *newname = type_name_no_tag (type);
379 /* Does the form of physname indicate that it is the full mangled name
380 of a constructor (not just the args)? */
381 int is_full_physname_constructor;
384 int is_destructor = is_destructor_name (physname);
385 /* Need a new type prefix. */
386 char *const_prefix = method->is_const ? "C" : "";
387 char *volatile_prefix = method->is_volatile ? "V" : "";
389 int len = (newname == NULL ? 0 : strlen (newname));
391 /* Nothing to do if physname already contains a fully mangled v3 abi name
392 or an operator name. */
393 if ((physname[0] == '_' && physname[1] == 'Z')
394 || is_operator_name (field_name))
395 return xstrdup (physname);
397 is_full_physname_constructor = is_constructor_name (physname);
399 is_constructor = is_full_physname_constructor
400 || (newname && strcmp (field_name, newname) == 0);
403 is_destructor = (strncmp (physname, "__dt", 4) == 0);
405 if (is_destructor || is_full_physname_constructor)
407 mangled_name = (char *) xmalloc (strlen (physname) + 1);
408 strcpy (mangled_name, physname);
414 xsnprintf (buf, sizeof (buf), "__%s%s", const_prefix, volatile_prefix);
416 else if (physname[0] == 't' || physname[0] == 'Q')
418 /* The physname for template and qualified methods already includes
420 xsnprintf (buf, sizeof (buf), "__%s%s", const_prefix, volatile_prefix);
426 xsnprintf (buf, sizeof (buf), "__%s%s%d", const_prefix,
427 volatile_prefix, len);
429 mangled_name_len = ((is_constructor ? 0 : strlen (field_name))
430 + strlen (buf) + len + strlen (physname) + 1);
432 mangled_name = (char *) xmalloc (mangled_name_len);
434 mangled_name[0] = '\0';
436 strcpy (mangled_name, field_name);
438 strcat (mangled_name, buf);
439 /* If the class doesn't have a name, i.e. newname NULL, then we just
440 mangle it using 0 for the length of the class. Thus it gets mangled
441 as something starting with `::' rather than `classname::'. */
443 strcat (mangled_name, newname);
445 strcat (mangled_name, physname);
446 return (mangled_name);
449 /* Initialize the cplus_specific structure. 'cplus_specific' should
450 only be allocated for use with cplus symbols. */
453 symbol_init_cplus_specific (struct general_symbol_info *gsymbol,
454 struct obstack *obstack)
456 /* A language_specific structure should not have been previously
458 gdb_assert (gsymbol->language_specific.cplus_specific == NULL);
459 gdb_assert (obstack != NULL);
461 gsymbol->language_specific.cplus_specific =
462 OBSTACK_ZALLOC (obstack, struct cplus_specific);
465 /* Set the demangled name of GSYMBOL to NAME. NAME must be already
466 correctly allocated. For C++ symbols a cplus_specific struct is
467 allocated so OBJFILE must not be NULL. If this is a non C++ symbol
468 OBJFILE can be NULL. */
471 symbol_set_demangled_name (struct general_symbol_info *gsymbol,
473 struct obstack *obstack)
475 if (gsymbol->language == language_cplus)
477 if (gsymbol->language_specific.cplus_specific == NULL)
478 symbol_init_cplus_specific (gsymbol, obstack);
480 gsymbol->language_specific.cplus_specific->demangled_name = name;
482 else if (gsymbol->language == language_ada)
486 gsymbol->ada_mangled = 0;
487 gsymbol->language_specific.obstack = obstack;
491 gsymbol->ada_mangled = 1;
492 gsymbol->language_specific.mangled_lang.demangled_name = name;
496 gsymbol->language_specific.mangled_lang.demangled_name = name;
499 /* Return the demangled name of GSYMBOL. */
502 symbol_get_demangled_name (const struct general_symbol_info *gsymbol)
504 if (gsymbol->language == language_cplus)
506 if (gsymbol->language_specific.cplus_specific != NULL)
507 return gsymbol->language_specific.cplus_specific->demangled_name;
511 else if (gsymbol->language == language_ada)
513 if (!gsymbol->ada_mangled)
518 return gsymbol->language_specific.mangled_lang.demangled_name;
522 /* Initialize the language dependent portion of a symbol
523 depending upon the language for the symbol. */
526 symbol_set_language (struct general_symbol_info *gsymbol,
527 enum language language,
528 struct obstack *obstack)
530 gsymbol->language = language;
531 if (gsymbol->language == language_d
532 || gsymbol->language == language_go
533 || gsymbol->language == language_java
534 || gsymbol->language == language_objc
535 || gsymbol->language == language_fortran)
537 symbol_set_demangled_name (gsymbol, NULL, obstack);
539 else if (gsymbol->language == language_ada)
541 gdb_assert (gsymbol->ada_mangled == 0);
542 gsymbol->language_specific.obstack = obstack;
544 else if (gsymbol->language == language_cplus)
545 gsymbol->language_specific.cplus_specific = NULL;
548 memset (&gsymbol->language_specific, 0,
549 sizeof (gsymbol->language_specific));
553 /* Functions to initialize a symbol's mangled name. */
555 /* Objects of this type are stored in the demangled name hash table. */
556 struct demangled_name_entry
562 /* Hash function for the demangled name hash. */
565 hash_demangled_name_entry (const void *data)
567 const struct demangled_name_entry *e = data;
569 return htab_hash_string (e->mangled);
572 /* Equality function for the demangled name hash. */
575 eq_demangled_name_entry (const void *a, const void *b)
577 const struct demangled_name_entry *da = a;
578 const struct demangled_name_entry *db = b;
580 return strcmp (da->mangled, db->mangled) == 0;
583 /* Create the hash table used for demangled names. Each hash entry is
584 a pair of strings; one for the mangled name and one for the demangled
585 name. The entry is hashed via just the mangled name. */
588 create_demangled_names_hash (struct objfile *objfile)
590 /* Choose 256 as the starting size of the hash table, somewhat arbitrarily.
591 The hash table code will round this up to the next prime number.
592 Choosing a much larger table size wastes memory, and saves only about
593 1% in symbol reading. */
595 objfile->demangled_names_hash = htab_create_alloc
596 (256, hash_demangled_name_entry, eq_demangled_name_entry,
597 NULL, xcalloc, xfree);
600 /* Try to determine the demangled name for a symbol, based on the
601 language of that symbol. If the language is set to language_auto,
602 it will attempt to find any demangling algorithm that works and
603 then set the language appropriately. The returned name is allocated
604 by the demangler and should be xfree'd. */
607 symbol_find_demangled_name (struct general_symbol_info *gsymbol,
610 char *demangled = NULL;
612 if (gsymbol->language == language_unknown)
613 gsymbol->language = language_auto;
615 if (gsymbol->language == language_objc
616 || gsymbol->language == language_auto)
619 objc_demangle (mangled, 0);
620 if (demangled != NULL)
622 gsymbol->language = language_objc;
626 if (gsymbol->language == language_cplus
627 || gsymbol->language == language_auto)
630 gdb_demangle (mangled, DMGL_PARAMS | DMGL_ANSI);
631 if (demangled != NULL)
633 gsymbol->language = language_cplus;
637 if (gsymbol->language == language_java)
640 gdb_demangle (mangled,
641 DMGL_PARAMS | DMGL_ANSI | DMGL_JAVA);
642 if (demangled != NULL)
644 gsymbol->language = language_java;
648 if (gsymbol->language == language_d
649 || gsymbol->language == language_auto)
651 demangled = d_demangle(mangled, 0);
652 if (demangled != NULL)
654 gsymbol->language = language_d;
658 /* FIXME(dje): Continually adding languages here is clumsy.
659 Better to just call la_demangle if !auto, and if auto then call
660 a utility routine that tries successive languages in turn and reports
661 which one it finds. I realize the la_demangle options may be different
662 for different languages but there's already a FIXME for that. */
663 if (gsymbol->language == language_go
664 || gsymbol->language == language_auto)
666 demangled = go_demangle (mangled, 0);
667 if (demangled != NULL)
669 gsymbol->language = language_go;
674 /* We could support `gsymbol->language == language_fortran' here to provide
675 module namespaces also for inferiors with only minimal symbol table (ELF
676 symbols). Just the mangling standard is not standardized across compilers
677 and there is no DW_AT_producer available for inferiors with only the ELF
678 symbols to check the mangling kind. */
682 /* Set both the mangled and demangled (if any) names for GSYMBOL based
683 on LINKAGE_NAME and LEN. Ordinarily, NAME is copied onto the
684 objfile's obstack; but if COPY_NAME is 0 and if NAME is
685 NUL-terminated, then this function assumes that NAME is already
686 correctly saved (either permanently or with a lifetime tied to the
687 objfile), and it will not be copied.
689 The hash table corresponding to OBJFILE is used, and the memory
690 comes from that objfile's objfile_obstack. LINKAGE_NAME is copied,
691 so the pointer can be discarded after calling this function. */
693 /* We have to be careful when dealing with Java names: when we run
694 into a Java minimal symbol, we don't know it's a Java symbol, so it
695 gets demangled as a C++ name. This is unfortunate, but there's not
696 much we can do about it: but when demangling partial symbols and
697 regular symbols, we'd better not reuse the wrong demangled name.
698 (See PR gdb/1039.) We solve this by putting a distinctive prefix
699 on Java names when storing them in the hash table. */
701 /* FIXME: carlton/2003-03-13: This is an unfortunate situation. I
702 don't mind the Java prefix so much: different languages have
703 different demangling requirements, so it's only natural that we
704 need to keep language data around in our demangling cache. But
705 it's not good that the minimal symbol has the wrong demangled name.
706 Unfortunately, I can't think of any easy solution to that
709 #define JAVA_PREFIX "##JAVA$$"
710 #define JAVA_PREFIX_LEN 8
713 symbol_set_names (struct general_symbol_info *gsymbol,
714 const char *linkage_name, int len, int copy_name,
715 struct objfile *objfile)
717 struct demangled_name_entry **slot;
718 /* A 0-terminated copy of the linkage name. */
719 const char *linkage_name_copy;
720 /* A copy of the linkage name that might have a special Java prefix
721 added to it, for use when looking names up in the hash table. */
722 const char *lookup_name;
723 /* The length of lookup_name. */
725 struct demangled_name_entry entry;
727 if (gsymbol->language == language_ada)
729 /* In Ada, we do the symbol lookups using the mangled name, so
730 we can save some space by not storing the demangled name.
732 As a side note, we have also observed some overlap between
733 the C++ mangling and Ada mangling, similarly to what has
734 been observed with Java. Because we don't store the demangled
735 name with the symbol, we don't need to use the same trick
738 gsymbol->name = linkage_name;
741 char *name = obstack_alloc (&objfile->objfile_obstack, len + 1);
743 memcpy (name, linkage_name, len);
745 gsymbol->name = name;
747 symbol_set_demangled_name (gsymbol, NULL, &objfile->objfile_obstack);
752 if (objfile->demangled_names_hash == NULL)
753 create_demangled_names_hash (objfile);
755 /* The stabs reader generally provides names that are not
756 NUL-terminated; most of the other readers don't do this, so we
757 can just use the given copy, unless we're in the Java case. */
758 if (gsymbol->language == language_java)
762 lookup_len = len + JAVA_PREFIX_LEN;
763 alloc_name = alloca (lookup_len + 1);
764 memcpy (alloc_name, JAVA_PREFIX, JAVA_PREFIX_LEN);
765 memcpy (alloc_name + JAVA_PREFIX_LEN, linkage_name, len);
766 alloc_name[lookup_len] = '\0';
768 lookup_name = alloc_name;
769 linkage_name_copy = alloc_name + JAVA_PREFIX_LEN;
771 else if (linkage_name[len] != '\0')
776 alloc_name = alloca (lookup_len + 1);
777 memcpy (alloc_name, linkage_name, len);
778 alloc_name[lookup_len] = '\0';
780 lookup_name = alloc_name;
781 linkage_name_copy = alloc_name;
786 lookup_name = linkage_name;
787 linkage_name_copy = linkage_name;
790 entry.mangled = lookup_name;
791 slot = ((struct demangled_name_entry **)
792 htab_find_slot (objfile->demangled_names_hash,
795 /* If this name is not in the hash table, add it. */
797 /* A C version of the symbol may have already snuck into the table.
798 This happens to, e.g., main.init (__go_init_main). Cope. */
799 || (gsymbol->language == language_go
800 && (*slot)->demangled[0] == '\0'))
802 char *demangled_name = symbol_find_demangled_name (gsymbol,
804 int demangled_len = demangled_name ? strlen (demangled_name) : 0;
806 /* Suppose we have demangled_name==NULL, copy_name==0, and
807 lookup_name==linkage_name. In this case, we already have the
808 mangled name saved, and we don't have a demangled name. So,
809 you might think we could save a little space by not recording
810 this in the hash table at all.
812 It turns out that it is actually important to still save such
813 an entry in the hash table, because storing this name gives
814 us better bcache hit rates for partial symbols. */
815 if (!copy_name && lookup_name == linkage_name)
817 *slot = obstack_alloc (&objfile->objfile_obstack,
818 offsetof (struct demangled_name_entry,
820 + demangled_len + 1);
821 (*slot)->mangled = lookup_name;
827 /* If we must copy the mangled name, put it directly after
828 the demangled name so we can have a single
830 *slot = obstack_alloc (&objfile->objfile_obstack,
831 offsetof (struct demangled_name_entry,
833 + lookup_len + demangled_len + 2);
834 mangled_ptr = &((*slot)->demangled[demangled_len + 1]);
835 strcpy (mangled_ptr, lookup_name);
836 (*slot)->mangled = mangled_ptr;
839 if (demangled_name != NULL)
841 strcpy ((*slot)->demangled, demangled_name);
842 xfree (demangled_name);
845 (*slot)->demangled[0] = '\0';
848 gsymbol->name = (*slot)->mangled + lookup_len - len;
849 if ((*slot)->demangled[0] != '\0')
850 symbol_set_demangled_name (gsymbol, (*slot)->demangled,
851 &objfile->objfile_obstack);
853 symbol_set_demangled_name (gsymbol, NULL, &objfile->objfile_obstack);
856 /* Return the source code name of a symbol. In languages where
857 demangling is necessary, this is the demangled name. */
860 symbol_natural_name (const struct general_symbol_info *gsymbol)
862 switch (gsymbol->language)
869 case language_fortran:
870 if (symbol_get_demangled_name (gsymbol) != NULL)
871 return symbol_get_demangled_name (gsymbol);
874 return ada_decode_symbol (gsymbol);
878 return gsymbol->name;
881 /* Return the demangled name for a symbol based on the language for
882 that symbol. If no demangled name exists, return NULL. */
885 symbol_demangled_name (const struct general_symbol_info *gsymbol)
887 const char *dem_name = NULL;
889 switch (gsymbol->language)
896 case language_fortran:
897 dem_name = symbol_get_demangled_name (gsymbol);
900 dem_name = ada_decode_symbol (gsymbol);
908 /* Return the search name of a symbol---generally the demangled or
909 linkage name of the symbol, depending on how it will be searched for.
910 If there is no distinct demangled name, then returns the same value
911 (same pointer) as SYMBOL_LINKAGE_NAME. */
914 symbol_search_name (const struct general_symbol_info *gsymbol)
916 if (gsymbol->language == language_ada)
917 return gsymbol->name;
919 return symbol_natural_name (gsymbol);
922 /* Initialize the structure fields to zero values. */
925 init_sal (struct symtab_and_line *sal)
933 sal->explicit_pc = 0;
934 sal->explicit_line = 0;
939 /* Return 1 if the two sections are the same, or if they could
940 plausibly be copies of each other, one in an original object
941 file and another in a separated debug file. */
944 matching_obj_sections (struct obj_section *obj_first,
945 struct obj_section *obj_second)
947 asection *first = obj_first? obj_first->the_bfd_section : NULL;
948 asection *second = obj_second? obj_second->the_bfd_section : NULL;
951 /* If they're the same section, then they match. */
955 /* If either is NULL, give up. */
956 if (first == NULL || second == NULL)
959 /* This doesn't apply to absolute symbols. */
960 if (first->owner == NULL || second->owner == NULL)
963 /* If they're in the same object file, they must be different sections. */
964 if (first->owner == second->owner)
967 /* Check whether the two sections are potentially corresponding. They must
968 have the same size, address, and name. We can't compare section indexes,
969 which would be more reliable, because some sections may have been
971 if (bfd_get_section_size (first) != bfd_get_section_size (second))
974 /* In-memory addresses may start at a different offset, relativize them. */
975 if (bfd_get_section_vma (first->owner, first)
976 - bfd_get_start_address (first->owner)
977 != bfd_get_section_vma (second->owner, second)
978 - bfd_get_start_address (second->owner))
981 if (bfd_get_section_name (first->owner, first) == NULL
982 || bfd_get_section_name (second->owner, second) == NULL
983 || strcmp (bfd_get_section_name (first->owner, first),
984 bfd_get_section_name (second->owner, second)) != 0)
987 /* Otherwise check that they are in corresponding objfiles. */
990 if (obj->obfd == first->owner)
992 gdb_assert (obj != NULL);
994 if (obj->separate_debug_objfile != NULL
995 && obj->separate_debug_objfile->obfd == second->owner)
997 if (obj->separate_debug_objfile_backlink != NULL
998 && obj->separate_debug_objfile_backlink->obfd == second->owner)
1005 find_pc_sect_symtab_via_partial (CORE_ADDR pc, struct obj_section *section)
1007 struct objfile *objfile;
1008 struct minimal_symbol *msymbol;
1010 /* If we know that this is not a text address, return failure. This is
1011 necessary because we loop based on texthigh and textlow, which do
1012 not include the data ranges. */
1013 msymbol = lookup_minimal_symbol_by_pc_section (pc, section).minsym;
1015 && (MSYMBOL_TYPE (msymbol) == mst_data
1016 || MSYMBOL_TYPE (msymbol) == mst_bss
1017 || MSYMBOL_TYPE (msymbol) == mst_abs
1018 || MSYMBOL_TYPE (msymbol) == mst_file_data
1019 || MSYMBOL_TYPE (msymbol) == mst_file_bss))
1022 ALL_OBJFILES (objfile)
1024 struct symtab *result = NULL;
1027 result = objfile->sf->qf->find_pc_sect_symtab (objfile, msymbol,
1036 /* Debug symbols usually don't have section information. We need to dig that
1037 out of the minimal symbols and stash that in the debug symbol. */
1040 fixup_section (struct general_symbol_info *ginfo,
1041 CORE_ADDR addr, struct objfile *objfile)
1043 struct minimal_symbol *msym;
1045 /* First, check whether a minimal symbol with the same name exists
1046 and points to the same address. The address check is required
1047 e.g. on PowerPC64, where the minimal symbol for a function will
1048 point to the function descriptor, while the debug symbol will
1049 point to the actual function code. */
1050 msym = lookup_minimal_symbol_by_pc_name (addr, ginfo->name, objfile);
1052 ginfo->section = SYMBOL_SECTION (msym);
1055 /* Static, function-local variables do appear in the linker
1056 (minimal) symbols, but are frequently given names that won't
1057 be found via lookup_minimal_symbol(). E.g., it has been
1058 observed in frv-uclinux (ELF) executables that a static,
1059 function-local variable named "foo" might appear in the
1060 linker symbols as "foo.6" or "foo.3". Thus, there is no
1061 point in attempting to extend the lookup-by-name mechanism to
1062 handle this case due to the fact that there can be multiple
1065 So, instead, search the section table when lookup by name has
1066 failed. The ``addr'' and ``endaddr'' fields may have already
1067 been relocated. If so, the relocation offset (i.e. the
1068 ANOFFSET value) needs to be subtracted from these values when
1069 performing the comparison. We unconditionally subtract it,
1070 because, when no relocation has been performed, the ANOFFSET
1071 value will simply be zero.
1073 The address of the symbol whose section we're fixing up HAS
1074 NOT BEEN adjusted (relocated) yet. It can't have been since
1075 the section isn't yet known and knowing the section is
1076 necessary in order to add the correct relocation value. In
1077 other words, we wouldn't even be in this function (attempting
1078 to compute the section) if it were already known.
1080 Note that it is possible to search the minimal symbols
1081 (subtracting the relocation value if necessary) to find the
1082 matching minimal symbol, but this is overkill and much less
1083 efficient. It is not necessary to find the matching minimal
1084 symbol, only its section.
1086 Note that this technique (of doing a section table search)
1087 can fail when unrelocated section addresses overlap. For
1088 this reason, we still attempt a lookup by name prior to doing
1089 a search of the section table. */
1091 struct obj_section *s;
1094 ALL_OBJFILE_OSECTIONS (objfile, s)
1096 int idx = s - objfile->sections;
1097 CORE_ADDR offset = ANOFFSET (objfile->section_offsets, idx);
1102 if (obj_section_addr (s) - offset <= addr
1103 && addr < obj_section_endaddr (s) - offset)
1105 ginfo->section = idx;
1110 /* If we didn't find the section, assume it is in the first
1111 section. If there is no allocated section, then it hardly
1112 matters what we pick, so just pick zero. */
1116 ginfo->section = fallback;
1121 fixup_symbol_section (struct symbol *sym, struct objfile *objfile)
1128 /* We either have an OBJFILE, or we can get at it from the sym's
1129 symtab. Anything else is a bug. */
1130 gdb_assert (objfile || SYMBOL_SYMTAB (sym));
1132 if (objfile == NULL)
1133 objfile = SYMBOL_SYMTAB (sym)->objfile;
1135 if (SYMBOL_OBJ_SECTION (objfile, sym))
1138 /* We should have an objfile by now. */
1139 gdb_assert (objfile);
1141 switch (SYMBOL_CLASS (sym))
1145 addr = SYMBOL_VALUE_ADDRESS (sym);
1148 addr = BLOCK_START (SYMBOL_BLOCK_VALUE (sym));
1152 /* Nothing else will be listed in the minsyms -- no use looking
1157 fixup_section (&sym->ginfo, addr, objfile);
1162 /* Compute the demangled form of NAME as used by the various symbol
1163 lookup functions. The result is stored in *RESULT_NAME. Returns a
1164 cleanup which can be used to clean up the result.
1166 For Ada, this function just sets *RESULT_NAME to NAME, unmodified.
1167 Normally, Ada symbol lookups are performed using the encoded name
1168 rather than the demangled name, and so it might seem to make sense
1169 for this function to return an encoded version of NAME.
1170 Unfortunately, we cannot do this, because this function is used in
1171 circumstances where it is not appropriate to try to encode NAME.
1172 For instance, when displaying the frame info, we demangle the name
1173 of each parameter, and then perform a symbol lookup inside our
1174 function using that demangled name. In Ada, certain functions
1175 have internally-generated parameters whose name contain uppercase
1176 characters. Encoding those name would result in those uppercase
1177 characters to become lowercase, and thus cause the symbol lookup
1181 demangle_for_lookup (const char *name, enum language lang,
1182 const char **result_name)
1184 char *demangled_name = NULL;
1185 const char *modified_name = NULL;
1186 struct cleanup *cleanup = make_cleanup (null_cleanup, 0);
1188 modified_name = name;
1190 /* If we are using C++, D, Go, or Java, demangle the name before doing a
1191 lookup, so we can always binary search. */
1192 if (lang == language_cplus)
1194 demangled_name = gdb_demangle (name, DMGL_ANSI | DMGL_PARAMS);
1197 modified_name = demangled_name;
1198 make_cleanup (xfree, demangled_name);
1202 /* If we were given a non-mangled name, canonicalize it
1203 according to the language (so far only for C++). */
1204 demangled_name = cp_canonicalize_string (name);
1207 modified_name = demangled_name;
1208 make_cleanup (xfree, demangled_name);
1212 else if (lang == language_java)
1214 demangled_name = gdb_demangle (name,
1215 DMGL_ANSI | DMGL_PARAMS | DMGL_JAVA);
1218 modified_name = demangled_name;
1219 make_cleanup (xfree, demangled_name);
1222 else if (lang == language_d)
1224 demangled_name = d_demangle (name, 0);
1227 modified_name = demangled_name;
1228 make_cleanup (xfree, demangled_name);
1231 else if (lang == language_go)
1233 demangled_name = go_demangle (name, 0);
1236 modified_name = demangled_name;
1237 make_cleanup (xfree, demangled_name);
1241 *result_name = modified_name;
1245 /* Find the definition for a specified symbol name NAME
1246 in domain DOMAIN, visible from lexical block BLOCK.
1247 Returns the struct symbol pointer, or zero if no symbol is found.
1248 C++: if IS_A_FIELD_OF_THIS is nonzero on entry, check to see if
1249 NAME is a field of the current implied argument `this'. If so set
1250 *IS_A_FIELD_OF_THIS to 1, otherwise set it to zero.
1251 BLOCK_FOUND is set to the block in which NAME is found (in the case of
1252 a field of `this', value_of_this sets BLOCK_FOUND to the proper value.) */
1254 /* This function (or rather its subordinates) have a bunch of loops and
1255 it would seem to be attractive to put in some QUIT's (though I'm not really
1256 sure whether it can run long enough to be really important). But there
1257 are a few calls for which it would appear to be bad news to quit
1258 out of here: e.g., find_proc_desc in alpha-mdebug-tdep.c. (Note
1259 that there is C++ code below which can error(), but that probably
1260 doesn't affect these calls since they are looking for a known
1261 variable and thus can probably assume it will never hit the C++
1265 lookup_symbol_in_language (const char *name, const struct block *block,
1266 const domain_enum domain, enum language lang,
1267 struct field_of_this_result *is_a_field_of_this)
1269 const char *modified_name;
1270 struct symbol *returnval;
1271 struct cleanup *cleanup = demangle_for_lookup (name, lang, &modified_name);
1273 returnval = lookup_symbol_aux (modified_name, block, domain, lang,
1274 is_a_field_of_this);
1275 do_cleanups (cleanup);
1280 /* Behave like lookup_symbol_in_language, but performed with the
1281 current language. */
1284 lookup_symbol (const char *name, const struct block *block,
1286 struct field_of_this_result *is_a_field_of_this)
1288 return lookup_symbol_in_language (name, block, domain,
1289 current_language->la_language,
1290 is_a_field_of_this);
1293 /* Look up the `this' symbol for LANG in BLOCK. Return the symbol if
1294 found, or NULL if not found. */
1297 lookup_language_this (const struct language_defn *lang,
1298 const struct block *block)
1300 if (lang->la_name_of_this == NULL || block == NULL)
1307 sym = lookup_block_symbol (block, lang->la_name_of_this, VAR_DOMAIN);
1310 block_found = block;
1313 if (BLOCK_FUNCTION (block))
1315 block = BLOCK_SUPERBLOCK (block);
1321 /* Given TYPE, a structure/union,
1322 return 1 if the component named NAME from the ultimate target
1323 structure/union is defined, otherwise, return 0. */
1326 check_field (struct type *type, const char *name,
1327 struct field_of_this_result *is_a_field_of_this)
1331 /* The type may be a stub. */
1332 CHECK_TYPEDEF (type);
1334 for (i = TYPE_NFIELDS (type) - 1; i >= TYPE_N_BASECLASSES (type); i--)
1336 const char *t_field_name = TYPE_FIELD_NAME (type, i);
1338 if (t_field_name && (strcmp_iw (t_field_name, name) == 0))
1340 is_a_field_of_this->type = type;
1341 is_a_field_of_this->field = &TYPE_FIELD (type, i);
1346 /* C++: If it was not found as a data field, then try to return it
1347 as a pointer to a method. */
1349 for (i = TYPE_NFN_FIELDS (type) - 1; i >= 0; --i)
1351 if (strcmp_iw (TYPE_FN_FIELDLIST_NAME (type, i), name) == 0)
1353 is_a_field_of_this->type = type;
1354 is_a_field_of_this->fn_field = &TYPE_FN_FIELDLIST (type, i);
1359 for (i = TYPE_N_BASECLASSES (type) - 1; i >= 0; i--)
1360 if (check_field (TYPE_BASECLASS (type, i), name, is_a_field_of_this))
1366 /* Behave like lookup_symbol except that NAME is the natural name
1367 (e.g., demangled name) of the symbol that we're looking for. */
1369 static struct symbol *
1370 lookup_symbol_aux (const char *name, const struct block *block,
1371 const domain_enum domain, enum language language,
1372 struct field_of_this_result *is_a_field_of_this)
1375 const struct language_defn *langdef;
1377 /* Make sure we do something sensible with is_a_field_of_this, since
1378 the callers that set this parameter to some non-null value will
1379 certainly use it later. If we don't set it, the contents of
1380 is_a_field_of_this are undefined. */
1381 if (is_a_field_of_this != NULL)
1382 memset (is_a_field_of_this, 0, sizeof (*is_a_field_of_this));
1384 /* Search specified block and its superiors. Don't search
1385 STATIC_BLOCK or GLOBAL_BLOCK. */
1387 sym = lookup_symbol_aux_local (name, block, domain, language);
1391 /* If requested to do so by the caller and if appropriate for LANGUAGE,
1392 check to see if NAME is a field of `this'. */
1394 langdef = language_def (language);
1396 /* Don't do this check if we are searching for a struct. It will
1397 not be found by check_field, but will be found by other
1399 if (is_a_field_of_this != NULL && domain != STRUCT_DOMAIN)
1401 struct symbol *sym = lookup_language_this (langdef, block);
1405 struct type *t = sym->type;
1407 /* I'm not really sure that type of this can ever
1408 be typedefed; just be safe. */
1410 if (TYPE_CODE (t) == TYPE_CODE_PTR
1411 || TYPE_CODE (t) == TYPE_CODE_REF)
1412 t = TYPE_TARGET_TYPE (t);
1414 if (TYPE_CODE (t) != TYPE_CODE_STRUCT
1415 && TYPE_CODE (t) != TYPE_CODE_UNION)
1416 error (_("Internal error: `%s' is not an aggregate"),
1417 langdef->la_name_of_this);
1419 if (check_field (t, name, is_a_field_of_this))
1424 /* Now do whatever is appropriate for LANGUAGE to look
1425 up static and global variables. */
1427 sym = langdef->la_lookup_symbol_nonlocal (name, block, domain);
1431 /* Now search all static file-level symbols. Not strictly correct,
1432 but more useful than an error. */
1434 return lookup_static_symbol_aux (name, domain);
1437 /* Search all static file-level symbols for NAME from DOMAIN. Do the symtabs
1438 first, then check the psymtabs. If a psymtab indicates the existence of the
1439 desired name as a file-level static, then do psymtab-to-symtab conversion on
1440 the fly and return the found symbol. */
1443 lookup_static_symbol_aux (const char *name, const domain_enum domain)
1445 struct objfile *objfile;
1448 sym = lookup_symbol_aux_symtabs (STATIC_BLOCK, name, domain);
1452 ALL_OBJFILES (objfile)
1454 sym = lookup_symbol_aux_quick (objfile, STATIC_BLOCK, name, domain);
1462 /* Check to see if the symbol is defined in BLOCK or its superiors.
1463 Don't search STATIC_BLOCK or GLOBAL_BLOCK. */
1465 static struct symbol *
1466 lookup_symbol_aux_local (const char *name, const struct block *block,
1467 const domain_enum domain,
1468 enum language language)
1471 const struct block *static_block = block_static_block (block);
1472 const char *scope = block_scope (block);
1474 /* Check if either no block is specified or it's a global block. */
1476 if (static_block == NULL)
1479 while (block != static_block)
1481 sym = lookup_symbol_aux_block (name, block, domain);
1485 if (language == language_cplus || language == language_fortran)
1487 sym = cp_lookup_symbol_imports_or_template (scope, name, block,
1493 if (BLOCK_FUNCTION (block) != NULL && block_inlined_p (block))
1495 block = BLOCK_SUPERBLOCK (block);
1498 /* We've reached the edge of the function without finding a result. */
1503 /* Look up OBJFILE to BLOCK. */
1506 lookup_objfile_from_block (const struct block *block)
1508 struct objfile *obj;
1514 block = block_global_block (block);
1515 /* Go through SYMTABS. */
1516 ALL_SYMTABS (obj, s)
1517 if (block == BLOCKVECTOR_BLOCK (BLOCKVECTOR (s), GLOBAL_BLOCK))
1519 if (obj->separate_debug_objfile_backlink)
1520 obj = obj->separate_debug_objfile_backlink;
1528 /* Look up a symbol in a block; if found, fixup the symbol, and set
1529 block_found appropriately. */
1532 lookup_symbol_aux_block (const char *name, const struct block *block,
1533 const domain_enum domain)
1537 sym = lookup_block_symbol (block, name, domain);
1540 block_found = block;
1541 return fixup_symbol_section (sym, NULL);
1547 /* Check all global symbols in OBJFILE in symtabs and
1551 lookup_global_symbol_from_objfile (const struct objfile *main_objfile,
1553 const domain_enum domain)
1555 const struct objfile *objfile;
1557 struct blockvector *bv;
1558 const struct block *block;
1561 for (objfile = main_objfile;
1563 objfile = objfile_separate_debug_iterate (main_objfile, objfile))
1565 /* Go through symtabs. */
1566 ALL_OBJFILE_PRIMARY_SYMTABS (objfile, s)
1568 bv = BLOCKVECTOR (s);
1569 block = BLOCKVECTOR_BLOCK (bv, GLOBAL_BLOCK);
1570 sym = lookup_block_symbol (block, name, domain);
1573 block_found = block;
1574 return fixup_symbol_section (sym, (struct objfile *)objfile);
1578 sym = lookup_symbol_aux_quick ((struct objfile *) objfile, GLOBAL_BLOCK,
1587 /* Check to see if the symbol is defined in one of the OBJFILE's
1588 symtabs. BLOCK_INDEX should be either GLOBAL_BLOCK or STATIC_BLOCK,
1589 depending on whether or not we want to search global symbols or
1592 static struct symbol *
1593 lookup_symbol_aux_objfile (struct objfile *objfile, int block_index,
1594 const char *name, const domain_enum domain)
1596 struct symbol *sym = NULL;
1597 struct blockvector *bv;
1598 const struct block *block;
1601 ALL_OBJFILE_PRIMARY_SYMTABS (objfile, s)
1603 bv = BLOCKVECTOR (s);
1604 block = BLOCKVECTOR_BLOCK (bv, block_index);
1605 sym = lookup_block_symbol (block, name, domain);
1608 block_found = block;
1609 return fixup_symbol_section (sym, objfile);
1616 /* Same as lookup_symbol_aux_objfile, except that it searches all
1617 objfiles. Return the first match found. */
1619 static struct symbol *
1620 lookup_symbol_aux_symtabs (int block_index, const char *name,
1621 const domain_enum domain)
1624 struct objfile *objfile;
1626 ALL_OBJFILES (objfile)
1628 sym = lookup_symbol_aux_objfile (objfile, block_index, name, domain);
1636 /* Wrapper around lookup_symbol_aux_objfile for search_symbols.
1637 Look up LINKAGE_NAME in DOMAIN in the global and static blocks of OBJFILE
1638 and all related objfiles. */
1640 static struct symbol *
1641 lookup_symbol_in_objfile_from_linkage_name (struct objfile *objfile,
1642 const char *linkage_name,
1645 enum language lang = current_language->la_language;
1646 const char *modified_name;
1647 struct cleanup *cleanup = demangle_for_lookup (linkage_name, lang,
1649 struct objfile *main_objfile, *cur_objfile;
1651 if (objfile->separate_debug_objfile_backlink)
1652 main_objfile = objfile->separate_debug_objfile_backlink;
1654 main_objfile = objfile;
1656 for (cur_objfile = main_objfile;
1658 cur_objfile = objfile_separate_debug_iterate (main_objfile, cur_objfile))
1662 sym = lookup_symbol_aux_objfile (cur_objfile, GLOBAL_BLOCK,
1663 modified_name, domain);
1665 sym = lookup_symbol_aux_objfile (cur_objfile, STATIC_BLOCK,
1666 modified_name, domain);
1669 do_cleanups (cleanup);
1674 do_cleanups (cleanup);
1678 /* A helper function that throws an exception when a symbol was found
1679 in a psymtab but not in a symtab. */
1681 static void ATTRIBUTE_NORETURN
1682 error_in_psymtab_expansion (int kind, const char *name, struct symtab *symtab)
1685 Internal: %s symbol `%s' found in %s psymtab but not in symtab.\n\
1686 %s may be an inlined function, or may be a template function\n \
1687 (if a template, try specifying an instantiation: %s<type>)."),
1688 kind == GLOBAL_BLOCK ? "global" : "static",
1689 name, symtab_to_filename_for_display (symtab), name, name);
1692 /* A helper function for lookup_symbol_aux that interfaces with the
1693 "quick" symbol table functions. */
1695 static struct symbol *
1696 lookup_symbol_aux_quick (struct objfile *objfile, int kind,
1697 const char *name, const domain_enum domain)
1699 struct symtab *symtab;
1700 struct blockvector *bv;
1701 const struct block *block;
1706 symtab = objfile->sf->qf->lookup_symbol (objfile, kind, name, domain);
1710 bv = BLOCKVECTOR (symtab);
1711 block = BLOCKVECTOR_BLOCK (bv, kind);
1712 sym = lookup_block_symbol (block, name, domain);
1714 error_in_psymtab_expansion (kind, name, symtab);
1715 return fixup_symbol_section (sym, objfile);
1718 /* A default version of lookup_symbol_nonlocal for use by languages
1719 that can't think of anything better to do. This implements the C
1723 basic_lookup_symbol_nonlocal (const char *name,
1724 const struct block *block,
1725 const domain_enum domain)
1729 /* NOTE: carlton/2003-05-19: The comments below were written when
1730 this (or what turned into this) was part of lookup_symbol_aux;
1731 I'm much less worried about these questions now, since these
1732 decisions have turned out well, but I leave these comments here
1735 /* NOTE: carlton/2002-12-05: There is a question as to whether or
1736 not it would be appropriate to search the current global block
1737 here as well. (That's what this code used to do before the
1738 is_a_field_of_this check was moved up.) On the one hand, it's
1739 redundant with the lookup_symbol_aux_symtabs search that happens
1740 next. On the other hand, if decode_line_1 is passed an argument
1741 like filename:var, then the user presumably wants 'var' to be
1742 searched for in filename. On the third hand, there shouldn't be
1743 multiple global variables all of which are named 'var', and it's
1744 not like decode_line_1 has ever restricted its search to only
1745 global variables in a single filename. All in all, only
1746 searching the static block here seems best: it's correct and it's
1749 /* NOTE: carlton/2002-12-05: There's also a possible performance
1750 issue here: if you usually search for global symbols in the
1751 current file, then it would be slightly better to search the
1752 current global block before searching all the symtabs. But there
1753 are other factors that have a much greater effect on performance
1754 than that one, so I don't think we should worry about that for
1757 sym = lookup_symbol_static (name, block, domain);
1761 return lookup_symbol_global (name, block, domain);
1764 /* Lookup a symbol in the static block associated to BLOCK, if there
1765 is one; do nothing if BLOCK is NULL or a global block. */
1768 lookup_symbol_static (const char *name,
1769 const struct block *block,
1770 const domain_enum domain)
1772 const struct block *static_block = block_static_block (block);
1774 if (static_block != NULL)
1775 return lookup_symbol_aux_block (name, static_block, domain);
1780 /* Private data to be used with lookup_symbol_global_iterator_cb. */
1782 struct global_sym_lookup_data
1784 /* The name of the symbol we are searching for. */
1787 /* The domain to use for our search. */
1790 /* The field where the callback should store the symbol if found.
1791 It should be initialized to NULL before the search is started. */
1792 struct symbol *result;
1795 /* A callback function for gdbarch_iterate_over_objfiles_in_search_order.
1796 It searches by name for a symbol in the GLOBAL_BLOCK of the given
1797 OBJFILE. The arguments for the search are passed via CB_DATA,
1798 which in reality is a pointer to struct global_sym_lookup_data. */
1801 lookup_symbol_global_iterator_cb (struct objfile *objfile,
1804 struct global_sym_lookup_data *data =
1805 (struct global_sym_lookup_data *) cb_data;
1807 gdb_assert (data->result == NULL);
1809 data->result = lookup_symbol_aux_objfile (objfile, GLOBAL_BLOCK,
1810 data->name, data->domain);
1811 if (data->result == NULL)
1812 data->result = lookup_symbol_aux_quick (objfile, GLOBAL_BLOCK,
1813 data->name, data->domain);
1815 /* If we found a match, tell the iterator to stop. Otherwise,
1817 return (data->result != NULL);
1820 /* Lookup a symbol in all files' global blocks (searching psymtabs if
1824 lookup_symbol_global (const char *name,
1825 const struct block *block,
1826 const domain_enum domain)
1828 struct symbol *sym = NULL;
1829 struct objfile *objfile = NULL;
1830 struct global_sym_lookup_data lookup_data;
1832 /* Call library-specific lookup procedure. */
1833 objfile = lookup_objfile_from_block (block);
1834 if (objfile != NULL)
1835 sym = solib_global_lookup (objfile, name, domain);
1839 memset (&lookup_data, 0, sizeof (lookup_data));
1840 lookup_data.name = name;
1841 lookup_data.domain = domain;
1842 gdbarch_iterate_over_objfiles_in_search_order
1843 (objfile != NULL ? get_objfile_arch (objfile) : target_gdbarch (),
1844 lookup_symbol_global_iterator_cb, &lookup_data, objfile);
1846 return lookup_data.result;
1850 symbol_matches_domain (enum language symbol_language,
1851 domain_enum symbol_domain,
1854 /* For C++ "struct foo { ... }" also defines a typedef for "foo".
1855 A Java class declaration also defines a typedef for the class.
1856 Similarly, any Ada type declaration implicitly defines a typedef. */
1857 if (symbol_language == language_cplus
1858 || symbol_language == language_d
1859 || symbol_language == language_java
1860 || symbol_language == language_ada)
1862 if ((domain == VAR_DOMAIN || domain == STRUCT_DOMAIN)
1863 && symbol_domain == STRUCT_DOMAIN)
1866 /* For all other languages, strict match is required. */
1867 return (symbol_domain == domain);
1870 /* Look up a type named NAME in the struct_domain. The type returned
1871 must not be opaque -- i.e., must have at least one field
1875 lookup_transparent_type (const char *name)
1877 return current_language->la_lookup_transparent_type (name);
1880 /* A helper for basic_lookup_transparent_type that interfaces with the
1881 "quick" symbol table functions. */
1883 static struct type *
1884 basic_lookup_transparent_type_quick (struct objfile *objfile, int kind,
1887 struct symtab *symtab;
1888 struct blockvector *bv;
1889 struct block *block;
1894 symtab = objfile->sf->qf->lookup_symbol (objfile, kind, name, STRUCT_DOMAIN);
1898 bv = BLOCKVECTOR (symtab);
1899 block = BLOCKVECTOR_BLOCK (bv, kind);
1900 sym = lookup_block_symbol (block, name, STRUCT_DOMAIN);
1902 error_in_psymtab_expansion (kind, name, symtab);
1904 if (!TYPE_IS_OPAQUE (SYMBOL_TYPE (sym)))
1905 return SYMBOL_TYPE (sym);
1910 /* The standard implementation of lookup_transparent_type. This code
1911 was modeled on lookup_symbol -- the parts not relevant to looking
1912 up types were just left out. In particular it's assumed here that
1913 types are available in struct_domain and only at file-static or
1917 basic_lookup_transparent_type (const char *name)
1920 struct symtab *s = NULL;
1921 struct blockvector *bv;
1922 struct objfile *objfile;
1923 struct block *block;
1926 /* Now search all the global symbols. Do the symtab's first, then
1927 check the psymtab's. If a psymtab indicates the existence
1928 of the desired name as a global, then do psymtab-to-symtab
1929 conversion on the fly and return the found symbol. */
1931 ALL_OBJFILES (objfile)
1933 ALL_OBJFILE_PRIMARY_SYMTABS (objfile, s)
1935 bv = BLOCKVECTOR (s);
1936 block = BLOCKVECTOR_BLOCK (bv, GLOBAL_BLOCK);
1937 sym = lookup_block_symbol (block, name, STRUCT_DOMAIN);
1938 if (sym && !TYPE_IS_OPAQUE (SYMBOL_TYPE (sym)))
1940 return SYMBOL_TYPE (sym);
1945 ALL_OBJFILES (objfile)
1947 t = basic_lookup_transparent_type_quick (objfile, GLOBAL_BLOCK, name);
1952 /* Now search the static file-level symbols.
1953 Not strictly correct, but more useful than an error.
1954 Do the symtab's first, then
1955 check the psymtab's. If a psymtab indicates the existence
1956 of the desired name as a file-level static, then do psymtab-to-symtab
1957 conversion on the fly and return the found symbol. */
1959 ALL_OBJFILES (objfile)
1961 ALL_OBJFILE_PRIMARY_SYMTABS (objfile, s)
1963 bv = BLOCKVECTOR (s);
1964 block = BLOCKVECTOR_BLOCK (bv, STATIC_BLOCK);
1965 sym = lookup_block_symbol (block, name, STRUCT_DOMAIN);
1966 if (sym && !TYPE_IS_OPAQUE (SYMBOL_TYPE (sym)))
1968 return SYMBOL_TYPE (sym);
1973 ALL_OBJFILES (objfile)
1975 t = basic_lookup_transparent_type_quick (objfile, STATIC_BLOCK, name);
1980 return (struct type *) 0;
1983 /* Search BLOCK for symbol NAME in DOMAIN.
1985 Note that if NAME is the demangled form of a C++ symbol, we will fail
1986 to find a match during the binary search of the non-encoded names, but
1987 for now we don't worry about the slight inefficiency of looking for
1988 a match we'll never find, since it will go pretty quick. Once the
1989 binary search terminates, we drop through and do a straight linear
1990 search on the symbols. Each symbol which is marked as being a ObjC/C++
1991 symbol (language_cplus or language_objc set) has both the encoded and
1992 non-encoded names tested for a match. */
1995 lookup_block_symbol (const struct block *block, const char *name,
1996 const domain_enum domain)
1998 struct block_iterator iter;
2001 if (!BLOCK_FUNCTION (block))
2003 for (sym = block_iter_name_first (block, name, &iter);
2005 sym = block_iter_name_next (name, &iter))
2007 if (symbol_matches_domain (SYMBOL_LANGUAGE (sym),
2008 SYMBOL_DOMAIN (sym), domain))
2015 /* Note that parameter symbols do not always show up last in the
2016 list; this loop makes sure to take anything else other than
2017 parameter symbols first; it only uses parameter symbols as a
2018 last resort. Note that this only takes up extra computation
2021 struct symbol *sym_found = NULL;
2023 for (sym = block_iter_name_first (block, name, &iter);
2025 sym = block_iter_name_next (name, &iter))
2027 if (symbol_matches_domain (SYMBOL_LANGUAGE (sym),
2028 SYMBOL_DOMAIN (sym), domain))
2031 if (!SYMBOL_IS_ARGUMENT (sym))
2037 return (sym_found); /* Will be NULL if not found. */
2041 /* Iterate over the symbols named NAME, matching DOMAIN, in BLOCK.
2043 For each symbol that matches, CALLBACK is called. The symbol and
2044 DATA are passed to the callback.
2046 If CALLBACK returns zero, the iteration ends. Otherwise, the
2047 search continues. */
2050 iterate_over_symbols (const struct block *block, const char *name,
2051 const domain_enum domain,
2052 symbol_found_callback_ftype *callback,
2055 struct block_iterator iter;
2058 for (sym = block_iter_name_first (block, name, &iter);
2060 sym = block_iter_name_next (name, &iter))
2062 if (symbol_matches_domain (SYMBOL_LANGUAGE (sym),
2063 SYMBOL_DOMAIN (sym), domain))
2065 if (!callback (sym, data))
2071 /* Find the symtab associated with PC and SECTION. Look through the
2072 psymtabs and read in another symtab if necessary. */
2075 find_pc_sect_symtab (CORE_ADDR pc, struct obj_section *section)
2078 struct blockvector *bv;
2079 struct symtab *s = NULL;
2080 struct symtab *best_s = NULL;
2081 struct objfile *objfile;
2082 CORE_ADDR distance = 0;
2083 struct minimal_symbol *msymbol;
2085 /* If we know that this is not a text address, return failure. This is
2086 necessary because we loop based on the block's high and low code
2087 addresses, which do not include the data ranges, and because
2088 we call find_pc_sect_psymtab which has a similar restriction based
2089 on the partial_symtab's texthigh and textlow. */
2090 msymbol = lookup_minimal_symbol_by_pc_section (pc, section).minsym;
2092 && (MSYMBOL_TYPE (msymbol) == mst_data
2093 || MSYMBOL_TYPE (msymbol) == mst_bss
2094 || MSYMBOL_TYPE (msymbol) == mst_abs
2095 || MSYMBOL_TYPE (msymbol) == mst_file_data
2096 || MSYMBOL_TYPE (msymbol) == mst_file_bss))
2099 /* Search all symtabs for the one whose file contains our address, and which
2100 is the smallest of all the ones containing the address. This is designed
2101 to deal with a case like symtab a is at 0x1000-0x2000 and 0x3000-0x4000
2102 and symtab b is at 0x2000-0x3000. So the GLOBAL_BLOCK for a is from
2103 0x1000-0x4000, but for address 0x2345 we want to return symtab b.
2105 This happens for native ecoff format, where code from included files
2106 gets its own symtab. The symtab for the included file should have
2107 been read in already via the dependency mechanism.
2108 It might be swifter to create several symtabs with the same name
2109 like xcoff does (I'm not sure).
2111 It also happens for objfiles that have their functions reordered.
2112 For these, the symtab we are looking for is not necessarily read in. */
2114 ALL_PRIMARY_SYMTABS (objfile, s)
2116 bv = BLOCKVECTOR (s);
2117 b = BLOCKVECTOR_BLOCK (bv, GLOBAL_BLOCK);
2119 if (BLOCK_START (b) <= pc
2120 && BLOCK_END (b) > pc
2122 || BLOCK_END (b) - BLOCK_START (b) < distance))
2124 /* For an objfile that has its functions reordered,
2125 find_pc_psymtab will find the proper partial symbol table
2126 and we simply return its corresponding symtab. */
2127 /* In order to better support objfiles that contain both
2128 stabs and coff debugging info, we continue on if a psymtab
2130 if ((objfile->flags & OBJF_REORDERED) && objfile->sf)
2132 struct symtab *result;
2135 = objfile->sf->qf->find_pc_sect_symtab (objfile,
2144 struct block_iterator iter;
2145 struct symbol *sym = NULL;
2147 ALL_BLOCK_SYMBOLS (b, iter, sym)
2149 fixup_symbol_section (sym, objfile);
2150 if (matching_obj_sections (SYMBOL_OBJ_SECTION (objfile, sym),
2155 continue; /* No symbol in this symtab matches
2158 distance = BLOCK_END (b) - BLOCK_START (b);
2166 /* Not found in symtabs, search the "quick" symtabs (e.g. psymtabs). */
2168 ALL_OBJFILES (objfile)
2170 struct symtab *result;
2174 result = objfile->sf->qf->find_pc_sect_symtab (objfile,
2185 /* Find the symtab associated with PC. Look through the psymtabs and read
2186 in another symtab if necessary. Backward compatibility, no section. */
2189 find_pc_symtab (CORE_ADDR pc)
2191 return find_pc_sect_symtab (pc, find_pc_mapped_section (pc));
2195 /* Find the source file and line number for a given PC value and SECTION.
2196 Return a structure containing a symtab pointer, a line number,
2197 and a pc range for the entire source line.
2198 The value's .pc field is NOT the specified pc.
2199 NOTCURRENT nonzero means, if specified pc is on a line boundary,
2200 use the line that ends there. Otherwise, in that case, the line
2201 that begins there is used. */
2203 /* The big complication here is that a line may start in one file, and end just
2204 before the start of another file. This usually occurs when you #include
2205 code in the middle of a subroutine. To properly find the end of a line's PC
2206 range, we must search all symtabs associated with this compilation unit, and
2207 find the one whose first PC is closer than that of the next line in this
2210 /* If it's worth the effort, we could be using a binary search. */
2212 struct symtab_and_line
2213 find_pc_sect_line (CORE_ADDR pc, struct obj_section *section, int notcurrent)
2216 struct linetable *l;
2219 struct linetable_entry *item;
2220 struct symtab_and_line val;
2221 struct blockvector *bv;
2222 struct bound_minimal_symbol msymbol;
2223 struct minimal_symbol *mfunsym;
2224 struct objfile *objfile;
2226 /* Info on best line seen so far, and where it starts, and its file. */
2228 struct linetable_entry *best = NULL;
2229 CORE_ADDR best_end = 0;
2230 struct symtab *best_symtab = 0;
2232 /* Store here the first line number
2233 of a file which contains the line at the smallest pc after PC.
2234 If we don't find a line whose range contains PC,
2235 we will use a line one less than this,
2236 with a range from the start of that file to the first line's pc. */
2237 struct linetable_entry *alt = NULL;
2239 /* Info on best line seen in this file. */
2241 struct linetable_entry *prev;
2243 /* If this pc is not from the current frame,
2244 it is the address of the end of a call instruction.
2245 Quite likely that is the start of the following statement.
2246 But what we want is the statement containing the instruction.
2247 Fudge the pc to make sure we get that. */
2249 init_sal (&val); /* initialize to zeroes */
2251 val.pspace = current_program_space;
2253 /* It's tempting to assume that, if we can't find debugging info for
2254 any function enclosing PC, that we shouldn't search for line
2255 number info, either. However, GAS can emit line number info for
2256 assembly files --- very helpful when debugging hand-written
2257 assembly code. In such a case, we'd have no debug info for the
2258 function, but we would have line info. */
2263 /* elz: added this because this function returned the wrong
2264 information if the pc belongs to a stub (import/export)
2265 to call a shlib function. This stub would be anywhere between
2266 two functions in the target, and the line info was erroneously
2267 taken to be the one of the line before the pc. */
2269 /* RT: Further explanation:
2271 * We have stubs (trampolines) inserted between procedures.
2273 * Example: "shr1" exists in a shared library, and a "shr1" stub also
2274 * exists in the main image.
2276 * In the minimal symbol table, we have a bunch of symbols
2277 * sorted by start address. The stubs are marked as "trampoline",
2278 * the others appear as text. E.g.:
2280 * Minimal symbol table for main image
2281 * main: code for main (text symbol)
2282 * shr1: stub (trampoline symbol)
2283 * foo: code for foo (text symbol)
2285 * Minimal symbol table for "shr1" image:
2287 * shr1: code for shr1 (text symbol)
2290 * So the code below is trying to detect if we are in the stub
2291 * ("shr1" stub), and if so, find the real code ("shr1" trampoline),
2292 * and if found, do the symbolization from the real-code address
2293 * rather than the stub address.
2295 * Assumptions being made about the minimal symbol table:
2296 * 1. lookup_minimal_symbol_by_pc() will return a trampoline only
2297 * if we're really in the trampoline.s If we're beyond it (say
2298 * we're in "foo" in the above example), it'll have a closer
2299 * symbol (the "foo" text symbol for example) and will not
2300 * return the trampoline.
2301 * 2. lookup_minimal_symbol_text() will find a real text symbol
2302 * corresponding to the trampoline, and whose address will
2303 * be different than the trampoline address. I put in a sanity
2304 * check for the address being the same, to avoid an
2305 * infinite recursion.
2307 msymbol = lookup_minimal_symbol_by_pc (pc);
2308 if (msymbol.minsym != NULL)
2309 if (MSYMBOL_TYPE (msymbol.minsym) == mst_solib_trampoline)
2312 = lookup_minimal_symbol_text (SYMBOL_LINKAGE_NAME (msymbol.minsym),
2314 if (mfunsym == NULL)
2315 /* I eliminated this warning since it is coming out
2316 * in the following situation:
2317 * gdb shmain // test program with shared libraries
2318 * (gdb) break shr1 // function in shared lib
2319 * Warning: In stub for ...
2320 * In the above situation, the shared lib is not loaded yet,
2321 * so of course we can't find the real func/line info,
2322 * but the "break" still works, and the warning is annoying.
2323 * So I commented out the warning. RT */
2324 /* warning ("In stub for %s; unable to find real function/line info",
2325 SYMBOL_LINKAGE_NAME (msymbol)); */
2328 else if (SYMBOL_VALUE_ADDRESS (mfunsym)
2329 == SYMBOL_VALUE_ADDRESS (msymbol.minsym))
2330 /* Avoid infinite recursion */
2331 /* See above comment about why warning is commented out. */
2332 /* warning ("In stub for %s; unable to find real function/line info",
2333 SYMBOL_LINKAGE_NAME (msymbol)); */
2337 return find_pc_line (SYMBOL_VALUE_ADDRESS (mfunsym), 0);
2341 s = find_pc_sect_symtab (pc, section);
2344 /* If no symbol information, return previous pc. */
2351 bv = BLOCKVECTOR (s);
2352 objfile = s->objfile;
2354 /* Look at all the symtabs that share this blockvector.
2355 They all have the same apriori range, that we found was right;
2356 but they have different line tables. */
2358 ALL_OBJFILE_SYMTABS (objfile, s)
2360 if (BLOCKVECTOR (s) != bv)
2363 /* Find the best line in this symtab. */
2370 /* I think len can be zero if the symtab lacks line numbers
2371 (e.g. gcc -g1). (Either that or the LINETABLE is NULL;
2372 I'm not sure which, and maybe it depends on the symbol
2378 item = l->item; /* Get first line info. */
2380 /* Is this file's first line closer than the first lines of other files?
2381 If so, record this file, and its first line, as best alternate. */
2382 if (item->pc > pc && (!alt || item->pc < alt->pc))
2385 for (i = 0; i < len; i++, item++)
2387 /* Leave prev pointing to the linetable entry for the last line
2388 that started at or before PC. */
2395 /* At this point, prev points at the line whose start addr is <= pc, and
2396 item points at the next line. If we ran off the end of the linetable
2397 (pc >= start of the last line), then prev == item. If pc < start of
2398 the first line, prev will not be set. */
2400 /* Is this file's best line closer than the best in the other files?
2401 If so, record this file, and its best line, as best so far. Don't
2402 save prev if it represents the end of a function (i.e. line number
2403 0) instead of a real line. */
2405 if (prev && prev->line && (!best || prev->pc > best->pc))
2410 /* Discard BEST_END if it's before the PC of the current BEST. */
2411 if (best_end <= best->pc)
2415 /* If another line (denoted by ITEM) is in the linetable and its
2416 PC is after BEST's PC, but before the current BEST_END, then
2417 use ITEM's PC as the new best_end. */
2418 if (best && i < len && item->pc > best->pc
2419 && (best_end == 0 || best_end > item->pc))
2420 best_end = item->pc;
2425 /* If we didn't find any line number info, just return zeros.
2426 We used to return alt->line - 1 here, but that could be
2427 anywhere; if we don't have line number info for this PC,
2428 don't make some up. */
2431 else if (best->line == 0)
2433 /* If our best fit is in a range of PC's for which no line
2434 number info is available (line number is zero) then we didn't
2435 find any valid line information. */
2440 val.symtab = best_symtab;
2441 val.line = best->line;
2443 if (best_end && (!alt || best_end < alt->pc))
2448 val.end = BLOCK_END (BLOCKVECTOR_BLOCK (bv, GLOBAL_BLOCK));
2450 val.section = section;
2454 /* Backward compatibility (no section). */
2456 struct symtab_and_line
2457 find_pc_line (CORE_ADDR pc, int notcurrent)
2459 struct obj_section *section;
2461 section = find_pc_overlay (pc);
2462 if (pc_in_unmapped_range (pc, section))
2463 pc = overlay_mapped_address (pc, section);
2464 return find_pc_sect_line (pc, section, notcurrent);
2467 /* Find line number LINE in any symtab whose name is the same as
2470 If found, return the symtab that contains the linetable in which it was
2471 found, set *INDEX to the index in the linetable of the best entry
2472 found, and set *EXACT_MATCH nonzero if the value returned is an
2475 If not found, return NULL. */
2478 find_line_symtab (struct symtab *symtab, int line,
2479 int *index, int *exact_match)
2481 int exact = 0; /* Initialized here to avoid a compiler warning. */
2483 /* BEST_INDEX and BEST_LINETABLE identify the smallest linenumber > LINE
2487 struct linetable *best_linetable;
2488 struct symtab *best_symtab;
2490 /* First try looking it up in the given symtab. */
2491 best_linetable = LINETABLE (symtab);
2492 best_symtab = symtab;
2493 best_index = find_line_common (best_linetable, line, &exact, 0);
2494 if (best_index < 0 || !exact)
2496 /* Didn't find an exact match. So we better keep looking for
2497 another symtab with the same name. In the case of xcoff,
2498 multiple csects for one source file (produced by IBM's FORTRAN
2499 compiler) produce multiple symtabs (this is unavoidable
2500 assuming csects can be at arbitrary places in memory and that
2501 the GLOBAL_BLOCK of a symtab has a begin and end address). */
2503 /* BEST is the smallest linenumber > LINE so far seen,
2504 or 0 if none has been seen so far.
2505 BEST_INDEX and BEST_LINETABLE identify the item for it. */
2508 struct objfile *objfile;
2511 if (best_index >= 0)
2512 best = best_linetable->item[best_index].line;
2516 ALL_OBJFILES (objfile)
2519 objfile->sf->qf->expand_symtabs_with_fullname (objfile,
2520 symtab_to_fullname (symtab));
2523 ALL_SYMTABS (objfile, s)
2525 struct linetable *l;
2528 if (FILENAME_CMP (symtab->filename, s->filename) != 0)
2530 if (FILENAME_CMP (symtab_to_fullname (symtab),
2531 symtab_to_fullname (s)) != 0)
2534 ind = find_line_common (l, line, &exact, 0);
2544 if (best == 0 || l->item[ind].line < best)
2546 best = l->item[ind].line;
2559 *index = best_index;
2561 *exact_match = exact;
2566 /* Given SYMTAB, returns all the PCs function in the symtab that
2567 exactly match LINE. Returns NULL if there are no exact matches,
2568 but updates BEST_ITEM in this case. */
2571 find_pcs_for_symtab_line (struct symtab *symtab, int line,
2572 struct linetable_entry **best_item)
2575 VEC (CORE_ADDR) *result = NULL;
2577 /* First, collect all the PCs that are at this line. */
2583 idx = find_line_common (LINETABLE (symtab), line, &was_exact, start);
2589 struct linetable_entry *item = &LINETABLE (symtab)->item[idx];
2591 if (*best_item == NULL || item->line < (*best_item)->line)
2597 VEC_safe_push (CORE_ADDR, result, LINETABLE (symtab)->item[idx].pc);
2605 /* Set the PC value for a given source file and line number and return true.
2606 Returns zero for invalid line number (and sets the PC to 0).
2607 The source file is specified with a struct symtab. */
2610 find_line_pc (struct symtab *symtab, int line, CORE_ADDR *pc)
2612 struct linetable *l;
2619 symtab = find_line_symtab (symtab, line, &ind, NULL);
2622 l = LINETABLE (symtab);
2623 *pc = l->item[ind].pc;
2630 /* Find the range of pc values in a line.
2631 Store the starting pc of the line into *STARTPTR
2632 and the ending pc (start of next line) into *ENDPTR.
2633 Returns 1 to indicate success.
2634 Returns 0 if could not find the specified line. */
2637 find_line_pc_range (struct symtab_and_line sal, CORE_ADDR *startptr,
2640 CORE_ADDR startaddr;
2641 struct symtab_and_line found_sal;
2644 if (startaddr == 0 && !find_line_pc (sal.symtab, sal.line, &startaddr))
2647 /* This whole function is based on address. For example, if line 10 has
2648 two parts, one from 0x100 to 0x200 and one from 0x300 to 0x400, then
2649 "info line *0x123" should say the line goes from 0x100 to 0x200
2650 and "info line *0x355" should say the line goes from 0x300 to 0x400.
2651 This also insures that we never give a range like "starts at 0x134
2652 and ends at 0x12c". */
2654 found_sal = find_pc_sect_line (startaddr, sal.section, 0);
2655 if (found_sal.line != sal.line)
2657 /* The specified line (sal) has zero bytes. */
2658 *startptr = found_sal.pc;
2659 *endptr = found_sal.pc;
2663 *startptr = found_sal.pc;
2664 *endptr = found_sal.end;
2669 /* Given a line table and a line number, return the index into the line
2670 table for the pc of the nearest line whose number is >= the specified one.
2671 Return -1 if none is found. The value is >= 0 if it is an index.
2672 START is the index at which to start searching the line table.
2674 Set *EXACT_MATCH nonzero if the value returned is an exact match. */
2677 find_line_common (struct linetable *l, int lineno,
2678 int *exact_match, int start)
2683 /* BEST is the smallest linenumber > LINENO so far seen,
2684 or 0 if none has been seen so far.
2685 BEST_INDEX identifies the item for it. */
2687 int best_index = -1;
2698 for (i = start; i < len; i++)
2700 struct linetable_entry *item = &(l->item[i]);
2702 if (item->line == lineno)
2704 /* Return the first (lowest address) entry which matches. */
2709 if (item->line > lineno && (best == 0 || item->line < best))
2716 /* If we got here, we didn't get an exact match. */
2721 find_pc_line_pc_range (CORE_ADDR pc, CORE_ADDR *startptr, CORE_ADDR *endptr)
2723 struct symtab_and_line sal;
2725 sal = find_pc_line (pc, 0);
2728 return sal.symtab != 0;
2731 /* Given a function start address FUNC_ADDR and SYMTAB, find the first
2732 address for that function that has an entry in SYMTAB's line info
2733 table. If such an entry cannot be found, return FUNC_ADDR
2737 skip_prologue_using_lineinfo (CORE_ADDR func_addr, struct symtab *symtab)
2739 CORE_ADDR func_start, func_end;
2740 struct linetable *l;
2743 /* Give up if this symbol has no lineinfo table. */
2744 l = LINETABLE (symtab);
2748 /* Get the range for the function's PC values, or give up if we
2749 cannot, for some reason. */
2750 if (!find_pc_partial_function (func_addr, NULL, &func_start, &func_end))
2753 /* Linetable entries are ordered by PC values, see the commentary in
2754 symtab.h where `struct linetable' is defined. Thus, the first
2755 entry whose PC is in the range [FUNC_START..FUNC_END[ is the
2756 address we are looking for. */
2757 for (i = 0; i < l->nitems; i++)
2759 struct linetable_entry *item = &(l->item[i]);
2761 /* Don't use line numbers of zero, they mark special entries in
2762 the table. See the commentary on symtab.h before the
2763 definition of struct linetable. */
2764 if (item->line > 0 && func_start <= item->pc && item->pc < func_end)
2771 /* Given a function symbol SYM, find the symtab and line for the start
2773 If the argument FUNFIRSTLINE is nonzero, we want the first line
2774 of real code inside the function. */
2776 struct symtab_and_line
2777 find_function_start_sal (struct symbol *sym, int funfirstline)
2779 struct symtab_and_line sal;
2781 fixup_symbol_section (sym, NULL);
2782 sal = find_pc_sect_line (BLOCK_START (SYMBOL_BLOCK_VALUE (sym)),
2783 SYMBOL_OBJ_SECTION (SYMBOL_OBJFILE (sym), sym), 0);
2785 /* We always should have a line for the function start address.
2786 If we don't, something is odd. Create a plain SAL refering
2787 just the PC and hope that skip_prologue_sal (if requested)
2788 can find a line number for after the prologue. */
2789 if (sal.pc < BLOCK_START (SYMBOL_BLOCK_VALUE (sym)))
2792 sal.pspace = current_program_space;
2793 sal.pc = BLOCK_START (SYMBOL_BLOCK_VALUE (sym));
2794 sal.section = SYMBOL_OBJ_SECTION (SYMBOL_OBJFILE (sym), sym);
2798 skip_prologue_sal (&sal);
2803 /* Adjust SAL to the first instruction past the function prologue.
2804 If the PC was explicitly specified, the SAL is not changed.
2805 If the line number was explicitly specified, at most the SAL's PC
2806 is updated. If SAL is already past the prologue, then do nothing. */
2809 skip_prologue_sal (struct symtab_and_line *sal)
2812 struct symtab_and_line start_sal;
2813 struct cleanup *old_chain;
2814 CORE_ADDR pc, saved_pc;
2815 struct obj_section *section;
2817 struct objfile *objfile;
2818 struct gdbarch *gdbarch;
2819 struct block *b, *function_block;
2820 int force_skip, skip;
2822 /* Do not change the SAL if PC was specified explicitly. */
2823 if (sal->explicit_pc)
2826 old_chain = save_current_space_and_thread ();
2827 switch_to_program_space_and_thread (sal->pspace);
2829 sym = find_pc_sect_function (sal->pc, sal->section);
2832 fixup_symbol_section (sym, NULL);
2834 pc = BLOCK_START (SYMBOL_BLOCK_VALUE (sym));
2835 section = SYMBOL_OBJ_SECTION (SYMBOL_OBJFILE (sym), sym);
2836 name = SYMBOL_LINKAGE_NAME (sym);
2837 objfile = SYMBOL_SYMTAB (sym)->objfile;
2841 struct bound_minimal_symbol msymbol
2842 = lookup_minimal_symbol_by_pc_section (sal->pc, sal->section);
2844 if (msymbol.minsym == NULL)
2846 do_cleanups (old_chain);
2850 objfile = msymbol.objfile;
2851 pc = SYMBOL_VALUE_ADDRESS (msymbol.minsym);
2852 section = SYMBOL_OBJ_SECTION (objfile, msymbol.minsym);
2853 name = SYMBOL_LINKAGE_NAME (msymbol.minsym);
2856 gdbarch = get_objfile_arch (objfile);
2858 /* Process the prologue in two passes. In the first pass try to skip the
2859 prologue (SKIP is true) and verify there is a real need for it (indicated
2860 by FORCE_SKIP). If no such reason was found run a second pass where the
2861 prologue is not skipped (SKIP is false). */
2866 /* Be conservative - allow direct PC (without skipping prologue) only if we
2867 have proven the CU (Compilation Unit) supports it. sal->SYMTAB does not
2868 have to be set by the caller so we use SYM instead. */
2869 if (sym && SYMBOL_SYMTAB (sym)->locations_valid)
2877 /* If the function is in an unmapped overlay, use its unmapped LMA address,
2878 so that gdbarch_skip_prologue has something unique to work on. */
2879 if (section_is_overlay (section) && !section_is_mapped (section))
2880 pc = overlay_unmapped_address (pc, section);
2882 /* Skip "first line" of function (which is actually its prologue). */
2883 pc += gdbarch_deprecated_function_start_offset (gdbarch);
2885 pc = gdbarch_skip_prologue (gdbarch, pc);
2887 /* For overlays, map pc back into its mapped VMA range. */
2888 pc = overlay_mapped_address (pc, section);
2890 /* Calculate line number. */
2891 start_sal = find_pc_sect_line (pc, section, 0);
2893 /* Check if gdbarch_skip_prologue left us in mid-line, and the next
2894 line is still part of the same function. */
2895 if (skip && start_sal.pc != pc
2896 && (sym ? (BLOCK_START (SYMBOL_BLOCK_VALUE (sym)) <= start_sal.end
2897 && start_sal.end < BLOCK_END (SYMBOL_BLOCK_VALUE (sym)))
2898 : (lookup_minimal_symbol_by_pc_section (start_sal.end, section).minsym
2899 == lookup_minimal_symbol_by_pc_section (pc, section).minsym)))
2901 /* First pc of next line */
2903 /* Recalculate the line number (might not be N+1). */
2904 start_sal = find_pc_sect_line (pc, section, 0);
2907 /* On targets with executable formats that don't have a concept of
2908 constructors (ELF with .init has, PE doesn't), gcc emits a call
2909 to `__main' in `main' between the prologue and before user
2911 if (gdbarch_skip_main_prologue_p (gdbarch)
2912 && name && strcmp_iw (name, "main") == 0)
2914 pc = gdbarch_skip_main_prologue (gdbarch, pc);
2915 /* Recalculate the line number (might not be N+1). */
2916 start_sal = find_pc_sect_line (pc, section, 0);
2920 while (!force_skip && skip--);
2922 /* If we still don't have a valid source line, try to find the first
2923 PC in the lineinfo table that belongs to the same function. This
2924 happens with COFF debug info, which does not seem to have an
2925 entry in lineinfo table for the code after the prologue which has
2926 no direct relation to source. For example, this was found to be
2927 the case with the DJGPP target using "gcc -gcoff" when the
2928 compiler inserted code after the prologue to make sure the stack
2930 if (!force_skip && sym && start_sal.symtab == NULL)
2932 pc = skip_prologue_using_lineinfo (pc, SYMBOL_SYMTAB (sym));
2933 /* Recalculate the line number. */
2934 start_sal = find_pc_sect_line (pc, section, 0);
2937 do_cleanups (old_chain);
2939 /* If we're already past the prologue, leave SAL unchanged. Otherwise
2940 forward SAL to the end of the prologue. */
2945 sal->section = section;
2947 /* Unless the explicit_line flag was set, update the SAL line
2948 and symtab to correspond to the modified PC location. */
2949 if (sal->explicit_line)
2952 sal->symtab = start_sal.symtab;
2953 sal->line = start_sal.line;
2954 sal->end = start_sal.end;
2956 /* Check if we are now inside an inlined function. If we can,
2957 use the call site of the function instead. */
2958 b = block_for_pc_sect (sal->pc, sal->section);
2959 function_block = NULL;
2962 if (BLOCK_FUNCTION (b) != NULL && block_inlined_p (b))
2964 else if (BLOCK_FUNCTION (b) != NULL)
2966 b = BLOCK_SUPERBLOCK (b);
2968 if (function_block != NULL
2969 && SYMBOL_LINE (BLOCK_FUNCTION (function_block)) != 0)
2971 sal->line = SYMBOL_LINE (BLOCK_FUNCTION (function_block));
2972 sal->symtab = SYMBOL_SYMTAB (BLOCK_FUNCTION (function_block));
2976 /* If P is of the form "operator[ \t]+..." where `...' is
2977 some legitimate operator text, return a pointer to the
2978 beginning of the substring of the operator text.
2979 Otherwise, return "". */
2982 operator_chars (char *p, char **end)
2985 if (strncmp (p, "operator", 8))
2989 /* Don't get faked out by `operator' being part of a longer
2991 if (isalpha (*p) || *p == '_' || *p == '$' || *p == '\0')
2994 /* Allow some whitespace between `operator' and the operator symbol. */
2995 while (*p == ' ' || *p == '\t')
2998 /* Recognize 'operator TYPENAME'. */
3000 if (isalpha (*p) || *p == '_' || *p == '$')
3004 while (isalnum (*q) || *q == '_' || *q == '$')
3013 case '\\': /* regexp quoting */
3016 if (p[2] == '=') /* 'operator\*=' */
3018 else /* 'operator\*' */
3022 else if (p[1] == '[')
3025 error (_("mismatched quoting on brackets, "
3026 "try 'operator\\[\\]'"));
3027 else if (p[2] == '\\' && p[3] == ']')
3029 *end = p + 4; /* 'operator\[\]' */
3033 error (_("nothing is allowed between '[' and ']'"));
3037 /* Gratuitous qoute: skip it and move on. */
3059 if (p[0] == '-' && p[1] == '>')
3061 /* Struct pointer member operator 'operator->'. */
3064 *end = p + 3; /* 'operator->*' */
3067 else if (p[2] == '\\')
3069 *end = p + 4; /* Hopefully 'operator->\*' */
3074 *end = p + 2; /* 'operator->' */
3078 if (p[1] == '=' || p[1] == p[0])
3089 error (_("`operator ()' must be specified "
3090 "without whitespace in `()'"));
3095 error (_("`operator ?:' must be specified "
3096 "without whitespace in `?:'"));
3101 error (_("`operator []' must be specified "
3102 "without whitespace in `[]'"));
3106 error (_("`operator %s' not supported"), p);
3115 /* Cache to watch for file names already seen by filename_seen. */
3117 struct filename_seen_cache
3119 /* Table of files seen so far. */
3121 /* Initial size of the table. It automagically grows from here. */
3122 #define INITIAL_FILENAME_SEEN_CACHE_SIZE 100
3125 /* filename_seen_cache constructor. */
3127 static struct filename_seen_cache *
3128 create_filename_seen_cache (void)
3130 struct filename_seen_cache *cache;
3132 cache = XNEW (struct filename_seen_cache);
3133 cache->tab = htab_create_alloc (INITIAL_FILENAME_SEEN_CACHE_SIZE,
3134 filename_hash, filename_eq,
3135 NULL, xcalloc, xfree);
3140 /* Empty the cache, but do not delete it. */
3143 clear_filename_seen_cache (struct filename_seen_cache *cache)
3145 htab_empty (cache->tab);
3148 /* filename_seen_cache destructor.
3149 This takes a void * argument as it is generally used as a cleanup. */
3152 delete_filename_seen_cache (void *ptr)
3154 struct filename_seen_cache *cache = ptr;
3156 htab_delete (cache->tab);
3160 /* If FILE is not already in the table of files in CACHE, return zero;
3161 otherwise return non-zero. Optionally add FILE to the table if ADD
3164 NOTE: We don't manage space for FILE, we assume FILE lives as long
3165 as the caller needs. */
3168 filename_seen (struct filename_seen_cache *cache, const char *file, int add)
3172 /* Is FILE in tab? */
3173 slot = htab_find_slot (cache->tab, file, add ? INSERT : NO_INSERT);
3177 /* No; maybe add it to tab. */
3179 *slot = (char *) file;
3184 /* Data structure to maintain printing state for output_source_filename. */
3186 struct output_source_filename_data
3188 /* Cache of what we've seen so far. */
3189 struct filename_seen_cache *filename_seen_cache;
3191 /* Flag of whether we're printing the first one. */
3195 /* Slave routine for sources_info. Force line breaks at ,'s.
3196 NAME is the name to print.
3197 DATA contains the state for printing and watching for duplicates. */
3200 output_source_filename (const char *name,
3201 struct output_source_filename_data *data)
3203 /* Since a single source file can result in several partial symbol
3204 tables, we need to avoid printing it more than once. Note: if
3205 some of the psymtabs are read in and some are not, it gets
3206 printed both under "Source files for which symbols have been
3207 read" and "Source files for which symbols will be read in on
3208 demand". I consider this a reasonable way to deal with the
3209 situation. I'm not sure whether this can also happen for
3210 symtabs; it doesn't hurt to check. */
3212 /* Was NAME already seen? */
3213 if (filename_seen (data->filename_seen_cache, name, 1))
3215 /* Yes; don't print it again. */
3219 /* No; print it and reset *FIRST. */
3221 printf_filtered (", ");
3225 fputs_filtered (name, gdb_stdout);
3228 /* A callback for map_partial_symbol_filenames. */
3231 output_partial_symbol_filename (const char *filename, const char *fullname,
3234 output_source_filename (fullname ? fullname : filename, data);
3238 sources_info (char *ignore, int from_tty)
3241 struct objfile *objfile;
3242 struct output_source_filename_data data;
3243 struct cleanup *cleanups;
3245 if (!have_full_symbols () && !have_partial_symbols ())
3247 error (_("No symbol table is loaded. Use the \"file\" command."));
3250 data.filename_seen_cache = create_filename_seen_cache ();
3251 cleanups = make_cleanup (delete_filename_seen_cache,
3252 data.filename_seen_cache);
3254 printf_filtered ("Source files for which symbols have been read in:\n\n");
3257 ALL_SYMTABS (objfile, s)
3259 const char *fullname = symtab_to_fullname (s);
3261 output_source_filename (fullname, &data);
3263 printf_filtered ("\n\n");
3265 printf_filtered ("Source files for which symbols "
3266 "will be read in on demand:\n\n");
3268 clear_filename_seen_cache (data.filename_seen_cache);
3270 map_partial_symbol_filenames (output_partial_symbol_filename, &data,
3271 1 /*need_fullname*/);
3272 printf_filtered ("\n");
3274 do_cleanups (cleanups);
3277 /* Compare FILE against all the NFILES entries of FILES. If BASENAMES is
3278 non-zero compare only lbasename of FILES. */
3281 file_matches (const char *file, char *files[], int nfiles, int basenames)
3285 if (file != NULL && nfiles != 0)
3287 for (i = 0; i < nfiles; i++)
3289 if (compare_filenames_for_search (file, (basenames
3290 ? lbasename (files[i])
3295 else if (nfiles == 0)
3300 /* Free any memory associated with a search. */
3303 free_search_symbols (struct symbol_search *symbols)
3305 struct symbol_search *p;
3306 struct symbol_search *next;
3308 for (p = symbols; p != NULL; p = next)
3316 do_free_search_symbols_cleanup (void *symbolsp)
3318 struct symbol_search *symbols = *(struct symbol_search **) symbolsp;
3320 free_search_symbols (symbols);
3324 make_cleanup_free_search_symbols (struct symbol_search **symbolsp)
3326 return make_cleanup (do_free_search_symbols_cleanup, symbolsp);
3329 /* Helper function for sort_search_symbols_remove_dups and qsort. Can only
3330 sort symbols, not minimal symbols. */
3333 compare_search_syms (const void *sa, const void *sb)
3335 struct symbol_search *sym_a = *(struct symbol_search **) sa;
3336 struct symbol_search *sym_b = *(struct symbol_search **) sb;
3339 c = strcmp (sym_a->symtab->filename, sym_b->symtab->filename);
3343 if (sym_a->block != sym_b->block)
3344 return sym_a->block - sym_b->block;
3346 return strcmp (SYMBOL_PRINT_NAME (sym_a->symbol),
3347 SYMBOL_PRINT_NAME (sym_b->symbol));
3350 /* Helper function for sort_search_symbols_remove_dups.
3351 Return TRUE if symbols A, B are equal. */
3354 search_symbols_equal (const struct symbol_search *a,
3355 const struct symbol_search *b)
3357 return (strcmp (a->symtab->filename, b->symtab->filename) == 0
3358 && a->block == b->block
3359 && strcmp (SYMBOL_PRINT_NAME (a->symbol),
3360 SYMBOL_PRINT_NAME (b->symbol)) == 0);
3363 /* Sort the NFOUND symbols in list FOUND and remove duplicates.
3364 The duplicates are freed, and the new list is returned in
3365 *NEW_HEAD, *NEW_TAIL. */
3368 sort_search_symbols_remove_dups (struct symbol_search *found, int nfound,
3369 struct symbol_search **new_head,
3370 struct symbol_search **new_tail)
3372 struct symbol_search **symbols, *symp, *old_next;
3375 gdb_assert (found != NULL && nfound > 0);
3377 /* Build an array out of the list so we can easily sort them. */
3378 symbols = (struct symbol_search **) xmalloc (sizeof (struct symbol_search *)
3381 for (i = 0; i < nfound; i++)
3383 gdb_assert (symp != NULL);
3384 gdb_assert (symp->block >= 0 && symp->block <= 1);
3388 gdb_assert (symp == NULL);
3390 qsort (symbols, nfound, sizeof (struct symbol_search *),
3391 compare_search_syms);
3393 /* Collapse out the dups. */
3394 for (i = 1, j = 1; i < nfound; ++i)
3396 if (! search_symbols_equal (symbols[j - 1], symbols[i]))
3397 symbols[j++] = symbols[i];
3402 symbols[j - 1]->next = NULL;
3404 /* Rebuild the linked list. */
3405 for (i = 0; i < nunique - 1; i++)
3406 symbols[i]->next = symbols[i + 1];
3407 symbols[nunique - 1]->next = NULL;
3409 *new_head = symbols[0];
3410 *new_tail = symbols[nunique - 1];
3414 /* An object of this type is passed as the user_data to the
3415 expand_symtabs_matching method. */
3416 struct search_symbols_data
3421 /* It is true if PREG contains valid data, false otherwise. */
3422 unsigned preg_p : 1;
3426 /* A callback for expand_symtabs_matching. */
3429 search_symbols_file_matches (const char *filename, void *user_data,
3432 struct search_symbols_data *data = user_data;
3434 return file_matches (filename, data->files, data->nfiles, basenames);
3437 /* A callback for expand_symtabs_matching. */
3440 search_symbols_name_matches (const char *symname, void *user_data)
3442 struct search_symbols_data *data = user_data;
3444 return !data->preg_p || regexec (&data->preg, symname, 0, NULL, 0) == 0;
3447 /* Search the symbol table for matches to the regular expression REGEXP,
3448 returning the results in *MATCHES.
3450 Only symbols of KIND are searched:
3451 VARIABLES_DOMAIN - search all symbols, excluding functions, type names,
3452 and constants (enums)
3453 FUNCTIONS_DOMAIN - search all functions
3454 TYPES_DOMAIN - search all type names
3455 ALL_DOMAIN - an internal error for this function
3457 free_search_symbols should be called when *MATCHES is no longer needed.
3459 Within each file the results are sorted locally; each symtab's global and
3460 static blocks are separately alphabetized.
3461 Duplicate entries are removed. */
3464 search_symbols (char *regexp, enum search_domain kind,
3465 int nfiles, char *files[],
3466 struct symbol_search **matches)
3469 struct blockvector *bv;
3472 struct block_iterator iter;
3474 struct objfile *objfile;
3475 struct minimal_symbol *msymbol;
3477 static const enum minimal_symbol_type types[]
3478 = {mst_data, mst_text, mst_abs};
3479 static const enum minimal_symbol_type types2[]
3480 = {mst_bss, mst_file_text, mst_abs};
3481 static const enum minimal_symbol_type types3[]
3482 = {mst_file_data, mst_solib_trampoline, mst_abs};
3483 static const enum minimal_symbol_type types4[]
3484 = {mst_file_bss, mst_text_gnu_ifunc, mst_abs};
3485 enum minimal_symbol_type ourtype;
3486 enum minimal_symbol_type ourtype2;
3487 enum minimal_symbol_type ourtype3;
3488 enum minimal_symbol_type ourtype4;
3489 struct symbol_search *found;
3490 struct symbol_search *tail;
3491 struct search_symbols_data datum;
3494 /* OLD_CHAIN .. RETVAL_CHAIN is always freed, RETVAL_CHAIN .. current
3495 CLEANUP_CHAIN is freed only in the case of an error. */
3496 struct cleanup *old_chain = make_cleanup (null_cleanup, NULL);
3497 struct cleanup *retval_chain;
3499 gdb_assert (kind <= TYPES_DOMAIN);
3501 ourtype = types[kind];
3502 ourtype2 = types2[kind];
3503 ourtype3 = types3[kind];
3504 ourtype4 = types4[kind];
3511 /* Make sure spacing is right for C++ operators.
3512 This is just a courtesy to make the matching less sensitive
3513 to how many spaces the user leaves between 'operator'
3514 and <TYPENAME> or <OPERATOR>. */
3516 char *opname = operator_chars (regexp, &opend);
3521 int fix = -1; /* -1 means ok; otherwise number of
3524 if (isalpha (*opname) || *opname == '_' || *opname == '$')
3526 /* There should 1 space between 'operator' and 'TYPENAME'. */
3527 if (opname[-1] != ' ' || opname[-2] == ' ')
3532 /* There should 0 spaces between 'operator' and 'OPERATOR'. */
3533 if (opname[-1] == ' ')
3536 /* If wrong number of spaces, fix it. */
3539 char *tmp = (char *) alloca (8 + fix + strlen (opname) + 1);
3541 sprintf (tmp, "operator%.*s%s", fix, " ", opname);
3546 errcode = regcomp (&datum.preg, regexp,
3547 REG_NOSUB | (case_sensitivity == case_sensitive_off
3551 char *err = get_regcomp_error (errcode, &datum.preg);
3553 make_cleanup (xfree, err);
3554 error (_("Invalid regexp (%s): %s"), err, regexp);
3557 make_regfree_cleanup (&datum.preg);
3560 /* Search through the partial symtabs *first* for all symbols
3561 matching the regexp. That way we don't have to reproduce all of
3562 the machinery below. */
3564 datum.nfiles = nfiles;
3565 datum.files = files;
3566 ALL_OBJFILES (objfile)
3569 objfile->sf->qf->expand_symtabs_matching (objfile,
3572 : search_symbols_file_matches),
3573 search_symbols_name_matches,
3578 /* Here, we search through the minimal symbol tables for functions
3579 and variables that match, and force their symbols to be read.
3580 This is in particular necessary for demangled variable names,
3581 which are no longer put into the partial symbol tables.
3582 The symbol will then be found during the scan of symtabs below.
3584 For functions, find_pc_symtab should succeed if we have debug info
3585 for the function, for variables we have to call
3586 lookup_symbol_in_objfile_from_linkage_name to determine if the variable
3588 If the lookup fails, set found_misc so that we will rescan to print
3589 any matching symbols without debug info.
3590 We only search the objfile the msymbol came from, we no longer search
3591 all objfiles. In large programs (1000s of shared libs) searching all
3592 objfiles is not worth the pain. */
3594 if (nfiles == 0 && (kind == VARIABLES_DOMAIN || kind == FUNCTIONS_DOMAIN))
3596 ALL_MSYMBOLS (objfile, msymbol)
3600 if (msymbol->created_by_gdb)
3603 if (MSYMBOL_TYPE (msymbol) == ourtype
3604 || MSYMBOL_TYPE (msymbol) == ourtype2
3605 || MSYMBOL_TYPE (msymbol) == ourtype3
3606 || MSYMBOL_TYPE (msymbol) == ourtype4)
3609 || regexec (&datum.preg, SYMBOL_NATURAL_NAME (msymbol), 0,
3612 /* Note: An important side-effect of these lookup functions
3613 is to expand the symbol table if msymbol is found, for the
3614 benefit of the next loop on ALL_PRIMARY_SYMTABS. */
3615 if (kind == FUNCTIONS_DOMAIN
3616 ? find_pc_symtab (SYMBOL_VALUE_ADDRESS (msymbol)) == NULL
3617 : (lookup_symbol_in_objfile_from_linkage_name
3618 (objfile, SYMBOL_LINKAGE_NAME (msymbol), VAR_DOMAIN)
3629 retval_chain = make_cleanup_free_search_symbols (&found);
3631 ALL_PRIMARY_SYMTABS (objfile, s)
3633 bv = BLOCKVECTOR (s);
3634 for (i = GLOBAL_BLOCK; i <= STATIC_BLOCK; i++)
3636 b = BLOCKVECTOR_BLOCK (bv, i);
3637 ALL_BLOCK_SYMBOLS (b, iter, sym)
3639 struct symtab *real_symtab = SYMBOL_SYMTAB (sym);
3643 /* Check first sole REAL_SYMTAB->FILENAME. It does not need to be
3644 a substring of symtab_to_fullname as it may contain "./" etc. */
3645 if ((file_matches (real_symtab->filename, files, nfiles, 0)
3646 || ((basenames_may_differ
3647 || file_matches (lbasename (real_symtab->filename),
3649 && file_matches (symtab_to_fullname (real_symtab),
3652 || regexec (&datum.preg, SYMBOL_NATURAL_NAME (sym), 0,
3654 && ((kind == VARIABLES_DOMAIN
3655 && SYMBOL_CLASS (sym) != LOC_TYPEDEF
3656 && SYMBOL_CLASS (sym) != LOC_UNRESOLVED
3657 && SYMBOL_CLASS (sym) != LOC_BLOCK
3658 /* LOC_CONST can be used for more than just enums,
3659 e.g., c++ static const members.
3660 We only want to skip enums here. */
3661 && !(SYMBOL_CLASS (sym) == LOC_CONST
3662 && TYPE_CODE (SYMBOL_TYPE (sym))
3664 || (kind == FUNCTIONS_DOMAIN
3665 && SYMBOL_CLASS (sym) == LOC_BLOCK)
3666 || (kind == TYPES_DOMAIN
3667 && SYMBOL_CLASS (sym) == LOC_TYPEDEF))))
3670 struct symbol_search *psr = (struct symbol_search *)
3671 xmalloc (sizeof (struct symbol_search));
3673 psr->symtab = real_symtab;
3675 memset (&psr->msymbol, 0, sizeof (psr->msymbol));
3690 sort_search_symbols_remove_dups (found, nfound, &found, &tail);
3691 /* Note: nfound is no longer useful beyond this point. */
3694 /* If there are no eyes, avoid all contact. I mean, if there are
3695 no debug symbols, then print directly from the msymbol_vector. */
3697 if (found_misc || (nfiles == 0 && kind != FUNCTIONS_DOMAIN))
3699 ALL_MSYMBOLS (objfile, msymbol)
3703 if (msymbol->created_by_gdb)
3706 if (MSYMBOL_TYPE (msymbol) == ourtype
3707 || MSYMBOL_TYPE (msymbol) == ourtype2
3708 || MSYMBOL_TYPE (msymbol) == ourtype3
3709 || MSYMBOL_TYPE (msymbol) == ourtype4)
3712 || regexec (&datum.preg, SYMBOL_NATURAL_NAME (msymbol), 0,
3715 /* For functions we can do a quick check of whether the
3716 symbol might be found via find_pc_symtab. */
3717 if (kind != FUNCTIONS_DOMAIN
3718 || find_pc_symtab (SYMBOL_VALUE_ADDRESS (msymbol)) == NULL)
3720 if (lookup_symbol_in_objfile_from_linkage_name
3721 (objfile, SYMBOL_LINKAGE_NAME (msymbol), VAR_DOMAIN)
3725 struct symbol_search *psr = (struct symbol_search *)
3726 xmalloc (sizeof (struct symbol_search));
3728 psr->msymbol.minsym = msymbol;
3729 psr->msymbol.objfile = objfile;
3745 discard_cleanups (retval_chain);
3746 do_cleanups (old_chain);
3750 /* Helper function for symtab_symbol_info, this function uses
3751 the data returned from search_symbols() to print information
3752 regarding the match to gdb_stdout. */
3755 print_symbol_info (enum search_domain kind,
3756 struct symtab *s, struct symbol *sym,
3757 int block, const char *last)
3759 const char *s_filename = symtab_to_filename_for_display (s);
3761 if (last == NULL || filename_cmp (last, s_filename) != 0)
3763 fputs_filtered ("\nFile ", gdb_stdout);
3764 fputs_filtered (s_filename, gdb_stdout);
3765 fputs_filtered (":\n", gdb_stdout);
3768 if (kind != TYPES_DOMAIN && block == STATIC_BLOCK)
3769 printf_filtered ("static ");
3771 /* Typedef that is not a C++ class. */
3772 if (kind == TYPES_DOMAIN
3773 && SYMBOL_DOMAIN (sym) != STRUCT_DOMAIN)
3774 typedef_print (SYMBOL_TYPE (sym), sym, gdb_stdout);
3775 /* variable, func, or typedef-that-is-c++-class. */
3776 else if (kind < TYPES_DOMAIN
3777 || (kind == TYPES_DOMAIN
3778 && SYMBOL_DOMAIN (sym) == STRUCT_DOMAIN))
3780 type_print (SYMBOL_TYPE (sym),
3781 (SYMBOL_CLASS (sym) == LOC_TYPEDEF
3782 ? "" : SYMBOL_PRINT_NAME (sym)),
3785 printf_filtered (";\n");
3789 /* This help function for symtab_symbol_info() prints information
3790 for non-debugging symbols to gdb_stdout. */
3793 print_msymbol_info (struct bound_minimal_symbol msymbol)
3795 struct gdbarch *gdbarch = get_objfile_arch (msymbol.objfile);
3798 if (gdbarch_addr_bit (gdbarch) <= 32)
3799 tmp = hex_string_custom (SYMBOL_VALUE_ADDRESS (msymbol.minsym)
3800 & (CORE_ADDR) 0xffffffff,
3803 tmp = hex_string_custom (SYMBOL_VALUE_ADDRESS (msymbol.minsym),
3805 printf_filtered ("%s %s\n",
3806 tmp, SYMBOL_PRINT_NAME (msymbol.minsym));
3809 /* This is the guts of the commands "info functions", "info types", and
3810 "info variables". It calls search_symbols to find all matches and then
3811 print_[m]symbol_info to print out some useful information about the
3815 symtab_symbol_info (char *regexp, enum search_domain kind, int from_tty)
3817 static const char * const classnames[] =
3818 {"variable", "function", "type"};
3819 struct symbol_search *symbols;
3820 struct symbol_search *p;
3821 struct cleanup *old_chain;
3822 const char *last_filename = NULL;
3825 gdb_assert (kind <= TYPES_DOMAIN);
3827 /* Must make sure that if we're interrupted, symbols gets freed. */
3828 search_symbols (regexp, kind, 0, (char **) NULL, &symbols);
3829 old_chain = make_cleanup_free_search_symbols (&symbols);
3832 printf_filtered (_("All %ss matching regular expression \"%s\":\n"),
3833 classnames[kind], regexp);
3835 printf_filtered (_("All defined %ss:\n"), classnames[kind]);
3837 for (p = symbols; p != NULL; p = p->next)
3841 if (p->msymbol.minsym != NULL)
3845 printf_filtered (_("\nNon-debugging symbols:\n"));
3848 print_msymbol_info (p->msymbol);
3852 print_symbol_info (kind,
3857 last_filename = symtab_to_filename_for_display (p->symtab);
3861 do_cleanups (old_chain);
3865 variables_info (char *regexp, int from_tty)
3867 symtab_symbol_info (regexp, VARIABLES_DOMAIN, from_tty);
3871 functions_info (char *regexp, int from_tty)
3873 symtab_symbol_info (regexp, FUNCTIONS_DOMAIN, from_tty);
3878 types_info (char *regexp, int from_tty)
3880 symtab_symbol_info (regexp, TYPES_DOMAIN, from_tty);
3883 /* Breakpoint all functions matching regular expression. */
3886 rbreak_command_wrapper (char *regexp, int from_tty)
3888 rbreak_command (regexp, from_tty);
3891 /* A cleanup function that calls end_rbreak_breakpoints. */
3894 do_end_rbreak_breakpoints (void *ignore)
3896 end_rbreak_breakpoints ();
3900 rbreak_command (char *regexp, int from_tty)
3902 struct symbol_search *ss;
3903 struct symbol_search *p;
3904 struct cleanup *old_chain;
3905 char *string = NULL;
3907 char **files = NULL, *file_name;
3912 char *colon = strchr (regexp, ':');
3914 if (colon && *(colon + 1) != ':')
3918 colon_index = colon - regexp;
3919 file_name = alloca (colon_index + 1);
3920 memcpy (file_name, regexp, colon_index);
3921 file_name[colon_index--] = 0;
3922 while (isspace (file_name[colon_index]))
3923 file_name[colon_index--] = 0;
3926 regexp = skip_spaces (colon + 1);
3930 search_symbols (regexp, FUNCTIONS_DOMAIN, nfiles, files, &ss);
3931 old_chain = make_cleanup_free_search_symbols (&ss);
3932 make_cleanup (free_current_contents, &string);
3934 start_rbreak_breakpoints ();
3935 make_cleanup (do_end_rbreak_breakpoints, NULL);
3936 for (p = ss; p != NULL; p = p->next)
3938 if (p->msymbol.minsym == NULL)
3940 const char *fullname = symtab_to_fullname (p->symtab);
3942 int newlen = (strlen (fullname)
3943 + strlen (SYMBOL_LINKAGE_NAME (p->symbol))
3948 string = xrealloc (string, newlen);
3951 strcpy (string, fullname);
3952 strcat (string, ":'");
3953 strcat (string, SYMBOL_LINKAGE_NAME (p->symbol));
3954 strcat (string, "'");
3955 break_command (string, from_tty);
3956 print_symbol_info (FUNCTIONS_DOMAIN,
3960 symtab_to_filename_for_display (p->symtab));
3964 int newlen = (strlen (SYMBOL_LINKAGE_NAME (p->msymbol.minsym)) + 3);
3968 string = xrealloc (string, newlen);
3971 strcpy (string, "'");
3972 strcat (string, SYMBOL_LINKAGE_NAME (p->msymbol.minsym));
3973 strcat (string, "'");
3975 break_command (string, from_tty);
3976 printf_filtered ("<function, no debug info> %s;\n",
3977 SYMBOL_PRINT_NAME (p->msymbol.minsym));
3981 do_cleanups (old_chain);
3985 /* Evaluate if NAME matches SYM_TEXT and SYM_TEXT_LEN.
3987 Either sym_text[sym_text_len] != '(' and then we search for any
3988 symbol starting with SYM_TEXT text.
3990 Otherwise sym_text[sym_text_len] == '(' and then we require symbol name to
3991 be terminated at that point. Partial symbol tables do not have parameters
3995 compare_symbol_name (const char *name, const char *sym_text, int sym_text_len)
3997 int (*ncmp) (const char *, const char *, size_t);
3999 ncmp = (case_sensitivity == case_sensitive_on ? strncmp : strncasecmp);
4001 if (ncmp (name, sym_text, sym_text_len) != 0)
4004 if (sym_text[sym_text_len] == '(')
4006 /* User searches for `name(someth...'. Require NAME to be terminated.
4007 Normally psymtabs and gdbindex have no parameter types so '\0' will be
4008 present but accept even parameters presence. In this case this
4009 function is in fact strcmp_iw but whitespace skipping is not supported
4010 for tab completion. */
4012 if (name[sym_text_len] != '\0' && name[sym_text_len] != '(')
4019 /* Free any memory associated with a completion list. */
4022 free_completion_list (VEC (char_ptr) **list_ptr)
4027 for (i = 0; VEC_iterate (char_ptr, *list_ptr, i, p); ++i)
4029 VEC_free (char_ptr, *list_ptr);
4032 /* Callback for make_cleanup. */
4035 do_free_completion_list (void *list)
4037 free_completion_list (list);
4040 /* Helper routine for make_symbol_completion_list. */
4042 static VEC (char_ptr) *return_val;
4044 #define COMPLETION_LIST_ADD_SYMBOL(symbol, sym_text, len, text, word) \
4045 completion_list_add_name \
4046 (SYMBOL_NATURAL_NAME (symbol), (sym_text), (len), (text), (word))
4048 /* Test to see if the symbol specified by SYMNAME (which is already
4049 demangled for C++ symbols) matches SYM_TEXT in the first SYM_TEXT_LEN
4050 characters. If so, add it to the current completion list. */
4053 completion_list_add_name (const char *symname,
4054 const char *sym_text, int sym_text_len,
4055 const char *text, const char *word)
4057 /* Clip symbols that cannot match. */
4058 if (!compare_symbol_name (symname, sym_text, sym_text_len))
4061 /* We have a match for a completion, so add SYMNAME to the current list
4062 of matches. Note that the name is moved to freshly malloc'd space. */
4067 if (word == sym_text)
4069 new = xmalloc (strlen (symname) + 5);
4070 strcpy (new, symname);
4072 else if (word > sym_text)
4074 /* Return some portion of symname. */
4075 new = xmalloc (strlen (symname) + 5);
4076 strcpy (new, symname + (word - sym_text));
4080 /* Return some of SYM_TEXT plus symname. */
4081 new = xmalloc (strlen (symname) + (sym_text - word) + 5);
4082 strncpy (new, word, sym_text - word);
4083 new[sym_text - word] = '\0';
4084 strcat (new, symname);
4087 VEC_safe_push (char_ptr, return_val, new);
4091 /* ObjC: In case we are completing on a selector, look as the msymbol
4092 again and feed all the selectors into the mill. */
4095 completion_list_objc_symbol (struct minimal_symbol *msymbol,
4096 const char *sym_text, int sym_text_len,
4097 const char *text, const char *word)
4099 static char *tmp = NULL;
4100 static unsigned int tmplen = 0;
4102 const char *method, *category, *selector;
4105 method = SYMBOL_NATURAL_NAME (msymbol);
4107 /* Is it a method? */
4108 if ((method[0] != '-') && (method[0] != '+'))
4111 if (sym_text[0] == '[')
4112 /* Complete on shortened method method. */
4113 completion_list_add_name (method + 1, sym_text, sym_text_len, text, word);
4115 while ((strlen (method) + 1) >= tmplen)
4121 tmp = xrealloc (tmp, tmplen);
4123 selector = strchr (method, ' ');
4124 if (selector != NULL)
4127 category = strchr (method, '(');
4129 if ((category != NULL) && (selector != NULL))
4131 memcpy (tmp, method, (category - method));
4132 tmp[category - method] = ' ';
4133 memcpy (tmp + (category - method) + 1, selector, strlen (selector) + 1);
4134 completion_list_add_name (tmp, sym_text, sym_text_len, text, word);
4135 if (sym_text[0] == '[')
4136 completion_list_add_name (tmp + 1, sym_text, sym_text_len, text, word);
4139 if (selector != NULL)
4141 /* Complete on selector only. */
4142 strcpy (tmp, selector);
4143 tmp2 = strchr (tmp, ']');
4147 completion_list_add_name (tmp, sym_text, sym_text_len, text, word);
4151 /* Break the non-quoted text based on the characters which are in
4152 symbols. FIXME: This should probably be language-specific. */
4155 language_search_unquoted_string (const char *text, const char *p)
4157 for (; p > text; --p)
4159 if (isalnum (p[-1]) || p[-1] == '_' || p[-1] == '\0')
4163 if ((current_language->la_language == language_objc))
4165 if (p[-1] == ':') /* Might be part of a method name. */
4167 else if (p[-1] == '[' && (p[-2] == '-' || p[-2] == '+'))
4168 p -= 2; /* Beginning of a method name. */
4169 else if (p[-1] == ' ' || p[-1] == '(' || p[-1] == ')')
4170 { /* Might be part of a method name. */
4173 /* Seeing a ' ' or a '(' is not conclusive evidence
4174 that we are in the middle of a method name. However,
4175 finding "-[" or "+[" should be pretty un-ambiguous.
4176 Unfortunately we have to find it now to decide. */
4179 if (isalnum (t[-1]) || t[-1] == '_' ||
4180 t[-1] == ' ' || t[-1] == ':' ||
4181 t[-1] == '(' || t[-1] == ')')
4186 if (t[-1] == '[' && (t[-2] == '-' || t[-2] == '+'))
4187 p = t - 2; /* Method name detected. */
4188 /* Else we leave with p unchanged. */
4198 completion_list_add_fields (struct symbol *sym, const char *sym_text,
4199 int sym_text_len, const char *text,
4202 if (SYMBOL_CLASS (sym) == LOC_TYPEDEF)
4204 struct type *t = SYMBOL_TYPE (sym);
4205 enum type_code c = TYPE_CODE (t);
4208 if (c == TYPE_CODE_UNION || c == TYPE_CODE_STRUCT)
4209 for (j = TYPE_N_BASECLASSES (t); j < TYPE_NFIELDS (t); j++)
4210 if (TYPE_FIELD_NAME (t, j))
4211 completion_list_add_name (TYPE_FIELD_NAME (t, j),
4212 sym_text, sym_text_len, text, word);
4216 /* Type of the user_data argument passed to add_macro_name or
4217 expand_partial_symbol_name. The contents are simply whatever is
4218 needed by completion_list_add_name. */
4219 struct add_name_data
4221 const char *sym_text;
4227 /* A callback used with macro_for_each and macro_for_each_in_scope.
4228 This adds a macro's name to the current completion list. */
4231 add_macro_name (const char *name, const struct macro_definition *ignore,
4232 struct macro_source_file *ignore2, int ignore3,
4235 struct add_name_data *datum = (struct add_name_data *) user_data;
4237 completion_list_add_name ((char *) name,
4238 datum->sym_text, datum->sym_text_len,
4239 datum->text, datum->word);
4242 /* A callback for expand_partial_symbol_names. */
4245 expand_partial_symbol_name (const char *name, void *user_data)
4247 struct add_name_data *datum = (struct add_name_data *) user_data;
4249 return compare_symbol_name (name, datum->sym_text, datum->sym_text_len);
4253 default_make_symbol_completion_list_break_on (const char *text,
4255 const char *break_on,
4256 enum type_code code)
4258 /* Problem: All of the symbols have to be copied because readline
4259 frees them. I'm not going to worry about this; hopefully there
4260 won't be that many. */
4264 struct minimal_symbol *msymbol;
4265 struct objfile *objfile;
4267 const struct block *surrounding_static_block, *surrounding_global_block;
4268 struct block_iterator iter;
4269 /* The symbol we are completing on. Points in same buffer as text. */
4270 const char *sym_text;
4271 /* Length of sym_text. */
4273 struct add_name_data datum;
4274 struct cleanup *back_to;
4276 /* Now look for the symbol we are supposed to complete on. */
4280 const char *quote_pos = NULL;
4282 /* First see if this is a quoted string. */
4284 for (p = text; *p != '\0'; ++p)
4286 if (quote_found != '\0')
4288 if (*p == quote_found)
4289 /* Found close quote. */
4291 else if (*p == '\\' && p[1] == quote_found)
4292 /* A backslash followed by the quote character
4293 doesn't end the string. */
4296 else if (*p == '\'' || *p == '"')
4302 if (quote_found == '\'')
4303 /* A string within single quotes can be a symbol, so complete on it. */
4304 sym_text = quote_pos + 1;
4305 else if (quote_found == '"')
4306 /* A double-quoted string is never a symbol, nor does it make sense
4307 to complete it any other way. */
4313 /* It is not a quoted string. Break it based on the characters
4314 which are in symbols. */
4317 if (isalnum (p[-1]) || p[-1] == '_' || p[-1] == '\0'
4318 || p[-1] == ':' || strchr (break_on, p[-1]) != NULL)
4327 sym_text_len = strlen (sym_text);
4329 /* Prepare SYM_TEXT_LEN for compare_symbol_name. */
4331 if (current_language->la_language == language_cplus
4332 || current_language->la_language == language_java
4333 || current_language->la_language == language_fortran)
4335 /* These languages may have parameters entered by user but they are never
4336 present in the partial symbol tables. */
4338 const char *cs = memchr (sym_text, '(', sym_text_len);
4341 sym_text_len = cs - sym_text;
4343 gdb_assert (sym_text[sym_text_len] == '\0' || sym_text[sym_text_len] == '(');
4346 back_to = make_cleanup (do_free_completion_list, &return_val);
4348 datum.sym_text = sym_text;
4349 datum.sym_text_len = sym_text_len;
4353 /* Look through the partial symtabs for all symbols which begin
4354 by matching SYM_TEXT. Expand all CUs that you find to the list.
4355 The real names will get added by COMPLETION_LIST_ADD_SYMBOL below. */
4356 expand_partial_symbol_names (expand_partial_symbol_name, &datum);
4358 /* At this point scan through the misc symbol vectors and add each
4359 symbol you find to the list. Eventually we want to ignore
4360 anything that isn't a text symbol (everything else will be
4361 handled by the psymtab code above). */
4363 if (code == TYPE_CODE_UNDEF)
4365 ALL_MSYMBOLS (objfile, msymbol)
4368 COMPLETION_LIST_ADD_SYMBOL (msymbol, sym_text, sym_text_len, text,
4371 completion_list_objc_symbol (msymbol, sym_text, sym_text_len, text,
4376 /* Search upwards from currently selected frame (so that we can
4377 complete on local vars). Also catch fields of types defined in
4378 this places which match our text string. Only complete on types
4379 visible from current context. */
4381 b = get_selected_block (0);
4382 surrounding_static_block = block_static_block (b);
4383 surrounding_global_block = block_global_block (b);
4384 if (surrounding_static_block != NULL)
4385 while (b != surrounding_static_block)
4389 ALL_BLOCK_SYMBOLS (b, iter, sym)
4391 if (code == TYPE_CODE_UNDEF)
4393 COMPLETION_LIST_ADD_SYMBOL (sym, sym_text, sym_text_len, text,
4395 completion_list_add_fields (sym, sym_text, sym_text_len, text,
4398 else if (SYMBOL_DOMAIN (sym) == STRUCT_DOMAIN
4399 && TYPE_CODE (SYMBOL_TYPE (sym)) == code)
4400 COMPLETION_LIST_ADD_SYMBOL (sym, sym_text, sym_text_len, text,
4404 /* Stop when we encounter an enclosing function. Do not stop for
4405 non-inlined functions - the locals of the enclosing function
4406 are in scope for a nested function. */
4407 if (BLOCK_FUNCTION (b) != NULL && block_inlined_p (b))
4409 b = BLOCK_SUPERBLOCK (b);
4412 /* Add fields from the file's types; symbols will be added below. */
4414 if (code == TYPE_CODE_UNDEF)
4416 if (surrounding_static_block != NULL)
4417 ALL_BLOCK_SYMBOLS (surrounding_static_block, iter, sym)
4418 completion_list_add_fields (sym, sym_text, sym_text_len, text, word);
4420 if (surrounding_global_block != NULL)
4421 ALL_BLOCK_SYMBOLS (surrounding_global_block, iter, sym)
4422 completion_list_add_fields (sym, sym_text, sym_text_len, text, word);
4425 /* Go through the symtabs and check the externs and statics for
4426 symbols which match. */
4428 ALL_PRIMARY_SYMTABS (objfile, s)
4431 b = BLOCKVECTOR_BLOCK (BLOCKVECTOR (s), GLOBAL_BLOCK);
4432 ALL_BLOCK_SYMBOLS (b, iter, sym)
4434 if (code == TYPE_CODE_UNDEF
4435 || (SYMBOL_DOMAIN (sym) == STRUCT_DOMAIN
4436 && TYPE_CODE (SYMBOL_TYPE (sym)) == code))
4437 COMPLETION_LIST_ADD_SYMBOL (sym, sym_text, sym_text_len, text, word);
4441 ALL_PRIMARY_SYMTABS (objfile, s)
4444 b = BLOCKVECTOR_BLOCK (BLOCKVECTOR (s), STATIC_BLOCK);
4445 ALL_BLOCK_SYMBOLS (b, iter, sym)
4447 if (code == TYPE_CODE_UNDEF
4448 || (SYMBOL_DOMAIN (sym) == STRUCT_DOMAIN
4449 && TYPE_CODE (SYMBOL_TYPE (sym)) == code))
4450 COMPLETION_LIST_ADD_SYMBOL (sym, sym_text, sym_text_len, text, word);
4454 /* Skip macros if we are completing a struct tag -- arguable but
4455 usually what is expected. */
4456 if (current_language->la_macro_expansion == macro_expansion_c
4457 && code == TYPE_CODE_UNDEF)
4459 struct macro_scope *scope;
4461 /* Add any macros visible in the default scope. Note that this
4462 may yield the occasional wrong result, because an expression
4463 might be evaluated in a scope other than the default. For
4464 example, if the user types "break file:line if <TAB>", the
4465 resulting expression will be evaluated at "file:line" -- but
4466 at there does not seem to be a way to detect this at
4468 scope = default_macro_scope ();
4471 macro_for_each_in_scope (scope->file, scope->line,
4472 add_macro_name, &datum);
4476 /* User-defined macros are always visible. */
4477 macro_for_each (macro_user_macros, add_macro_name, &datum);
4480 discard_cleanups (back_to);
4481 return (return_val);
4485 default_make_symbol_completion_list (const char *text, const char *word,
4486 enum type_code code)
4488 return default_make_symbol_completion_list_break_on (text, word, "", code);
4491 /* Return a vector of all symbols (regardless of class) which begin by
4492 matching TEXT. If the answer is no symbols, then the return value
4496 make_symbol_completion_list (const char *text, const char *word)
4498 return current_language->la_make_symbol_completion_list (text, word,
4502 /* Like make_symbol_completion_list, but only return STRUCT_DOMAIN
4503 symbols whose type code is CODE. */
4506 make_symbol_completion_type (const char *text, const char *word,
4507 enum type_code code)
4509 gdb_assert (code == TYPE_CODE_UNION
4510 || code == TYPE_CODE_STRUCT
4511 || code == TYPE_CODE_CLASS
4512 || code == TYPE_CODE_ENUM);
4513 return current_language->la_make_symbol_completion_list (text, word, code);
4516 /* Like make_symbol_completion_list, but suitable for use as a
4517 completion function. */
4520 make_symbol_completion_list_fn (struct cmd_list_element *ignore,
4521 const char *text, const char *word)
4523 return make_symbol_completion_list (text, word);
4526 /* Like make_symbol_completion_list, but returns a list of symbols
4527 defined in a source file FILE. */
4530 make_file_symbol_completion_list (const char *text, const char *word,
4531 const char *srcfile)
4536 struct block_iterator iter;
4537 /* The symbol we are completing on. Points in same buffer as text. */
4538 const char *sym_text;
4539 /* Length of sym_text. */
4542 /* Now look for the symbol we are supposed to complete on.
4543 FIXME: This should be language-specific. */
4547 const char *quote_pos = NULL;
4549 /* First see if this is a quoted string. */
4551 for (p = text; *p != '\0'; ++p)
4553 if (quote_found != '\0')
4555 if (*p == quote_found)
4556 /* Found close quote. */
4558 else if (*p == '\\' && p[1] == quote_found)
4559 /* A backslash followed by the quote character
4560 doesn't end the string. */
4563 else if (*p == '\'' || *p == '"')
4569 if (quote_found == '\'')
4570 /* A string within single quotes can be a symbol, so complete on it. */
4571 sym_text = quote_pos + 1;
4572 else if (quote_found == '"')
4573 /* A double-quoted string is never a symbol, nor does it make sense
4574 to complete it any other way. */
4580 /* Not a quoted string. */
4581 sym_text = language_search_unquoted_string (text, p);
4585 sym_text_len = strlen (sym_text);
4589 /* Find the symtab for SRCFILE (this loads it if it was not yet read
4591 s = lookup_symtab (srcfile);
4594 /* Maybe they typed the file with leading directories, while the
4595 symbol tables record only its basename. */
4596 const char *tail = lbasename (srcfile);
4599 s = lookup_symtab (tail);
4602 /* If we have no symtab for that file, return an empty list. */
4604 return (return_val);
4606 /* Go through this symtab and check the externs and statics for
4607 symbols which match. */
4609 b = BLOCKVECTOR_BLOCK (BLOCKVECTOR (s), GLOBAL_BLOCK);
4610 ALL_BLOCK_SYMBOLS (b, iter, sym)
4612 COMPLETION_LIST_ADD_SYMBOL (sym, sym_text, sym_text_len, text, word);
4615 b = BLOCKVECTOR_BLOCK (BLOCKVECTOR (s), STATIC_BLOCK);
4616 ALL_BLOCK_SYMBOLS (b, iter, sym)
4618 COMPLETION_LIST_ADD_SYMBOL (sym, sym_text, sym_text_len, text, word);
4621 return (return_val);
4624 /* A helper function for make_source_files_completion_list. It adds
4625 another file name to a list of possible completions, growing the
4626 list as necessary. */
4629 add_filename_to_list (const char *fname, const char *text, const char *word,
4630 VEC (char_ptr) **list)
4633 size_t fnlen = strlen (fname);
4637 /* Return exactly fname. */
4638 new = xmalloc (fnlen + 5);
4639 strcpy (new, fname);
4641 else if (word > text)
4643 /* Return some portion of fname. */
4644 new = xmalloc (fnlen + 5);
4645 strcpy (new, fname + (word - text));
4649 /* Return some of TEXT plus fname. */
4650 new = xmalloc (fnlen + (text - word) + 5);
4651 strncpy (new, word, text - word);
4652 new[text - word] = '\0';
4653 strcat (new, fname);
4655 VEC_safe_push (char_ptr, *list, new);
4659 not_interesting_fname (const char *fname)
4661 static const char *illegal_aliens[] = {
4662 "_globals_", /* inserted by coff_symtab_read */
4667 for (i = 0; illegal_aliens[i]; i++)
4669 if (filename_cmp (fname, illegal_aliens[i]) == 0)
4675 /* An object of this type is passed as the user_data argument to
4676 map_partial_symbol_filenames. */
4677 struct add_partial_filename_data
4679 struct filename_seen_cache *filename_seen_cache;
4683 VEC (char_ptr) **list;
4686 /* A callback for map_partial_symbol_filenames. */
4689 maybe_add_partial_symtab_filename (const char *filename, const char *fullname,
4692 struct add_partial_filename_data *data = user_data;
4694 if (not_interesting_fname (filename))
4696 if (!filename_seen (data->filename_seen_cache, filename, 1)
4697 && filename_ncmp (filename, data->text, data->text_len) == 0)
4699 /* This file matches for a completion; add it to the
4700 current list of matches. */
4701 add_filename_to_list (filename, data->text, data->word, data->list);
4705 const char *base_name = lbasename (filename);
4707 if (base_name != filename
4708 && !filename_seen (data->filename_seen_cache, base_name, 1)
4709 && filename_ncmp (base_name, data->text, data->text_len) == 0)
4710 add_filename_to_list (base_name, data->text, data->word, data->list);
4714 /* Return a vector of all source files whose names begin with matching
4715 TEXT. The file names are looked up in the symbol tables of this
4716 program. If the answer is no matchess, then the return value is
4720 make_source_files_completion_list (const char *text, const char *word)
4723 struct objfile *objfile;
4724 size_t text_len = strlen (text);
4725 VEC (char_ptr) *list = NULL;
4726 const char *base_name;
4727 struct add_partial_filename_data datum;
4728 struct filename_seen_cache *filename_seen_cache;
4729 struct cleanup *back_to, *cache_cleanup;
4731 if (!have_full_symbols () && !have_partial_symbols ())
4734 back_to = make_cleanup (do_free_completion_list, &list);
4736 filename_seen_cache = create_filename_seen_cache ();
4737 cache_cleanup = make_cleanup (delete_filename_seen_cache,
4738 filename_seen_cache);
4740 ALL_SYMTABS (objfile, s)
4742 if (not_interesting_fname (s->filename))
4744 if (!filename_seen (filename_seen_cache, s->filename, 1)
4745 && filename_ncmp (s->filename, text, text_len) == 0)
4747 /* This file matches for a completion; add it to the current
4749 add_filename_to_list (s->filename, text, word, &list);
4753 /* NOTE: We allow the user to type a base name when the
4754 debug info records leading directories, but not the other
4755 way around. This is what subroutines of breakpoint
4756 command do when they parse file names. */
4757 base_name = lbasename (s->filename);
4758 if (base_name != s->filename
4759 && !filename_seen (filename_seen_cache, base_name, 1)
4760 && filename_ncmp (base_name, text, text_len) == 0)
4761 add_filename_to_list (base_name, text, word, &list);
4765 datum.filename_seen_cache = filename_seen_cache;
4768 datum.text_len = text_len;
4770 map_partial_symbol_filenames (maybe_add_partial_symtab_filename, &datum,
4771 0 /*need_fullname*/);
4773 do_cleanups (cache_cleanup);
4774 discard_cleanups (back_to);
4779 /* Determine if PC is in the prologue of a function. The prologue is the area
4780 between the first instruction of a function, and the first executable line.
4781 Returns 1 if PC *might* be in prologue, 0 if definately *not* in prologue.
4783 If non-zero, func_start is where we think the prologue starts, possibly
4784 by previous examination of symbol table information. */
4787 in_prologue (struct gdbarch *gdbarch, CORE_ADDR pc, CORE_ADDR func_start)
4789 struct symtab_and_line sal;
4790 CORE_ADDR func_addr, func_end;
4792 /* We have several sources of information we can consult to figure
4794 - Compilers usually emit line number info that marks the prologue
4795 as its own "source line". So the ending address of that "line"
4796 is the end of the prologue. If available, this is the most
4798 - The minimal symbols and partial symbols, which can usually tell
4799 us the starting and ending addresses of a function.
4800 - If we know the function's start address, we can call the
4801 architecture-defined gdbarch_skip_prologue function to analyze the
4802 instruction stream and guess where the prologue ends.
4803 - Our `func_start' argument; if non-zero, this is the caller's
4804 best guess as to the function's entry point. At the time of
4805 this writing, handle_inferior_event doesn't get this right, so
4806 it should be our last resort. */
4808 /* Consult the partial symbol table, to find which function
4810 if (! find_pc_partial_function (pc, NULL, &func_addr, &func_end))
4812 CORE_ADDR prologue_end;
4814 /* We don't even have minsym information, so fall back to using
4815 func_start, if given. */
4817 return 1; /* We *might* be in a prologue. */
4819 prologue_end = gdbarch_skip_prologue (gdbarch, func_start);
4821 return func_start <= pc && pc < prologue_end;
4824 /* If we have line number information for the function, that's
4825 usually pretty reliable. */
4826 sal = find_pc_line (func_addr, 0);
4828 /* Now sal describes the source line at the function's entry point,
4829 which (by convention) is the prologue. The end of that "line",
4830 sal.end, is the end of the prologue.
4832 Note that, for functions whose source code is all on a single
4833 line, the line number information doesn't always end up this way.
4834 So we must verify that our purported end-of-prologue address is
4835 *within* the function, not at its start or end. */
4837 || sal.end <= func_addr
4838 || func_end <= sal.end)
4840 /* We don't have any good line number info, so use the minsym
4841 information, together with the architecture-specific prologue
4843 CORE_ADDR prologue_end = gdbarch_skip_prologue (gdbarch, func_addr);
4845 return func_addr <= pc && pc < prologue_end;
4848 /* We have line number info, and it looks good. */
4849 return func_addr <= pc && pc < sal.end;
4852 /* Given PC at the function's start address, attempt to find the
4853 prologue end using SAL information. Return zero if the skip fails.
4855 A non-optimized prologue traditionally has one SAL for the function
4856 and a second for the function body. A single line function has
4857 them both pointing at the same line.
4859 An optimized prologue is similar but the prologue may contain
4860 instructions (SALs) from the instruction body. Need to skip those
4861 while not getting into the function body.
4863 The functions end point and an increasing SAL line are used as
4864 indicators of the prologue's endpoint.
4866 This code is based on the function refine_prologue_limit
4870 skip_prologue_using_sal (struct gdbarch *gdbarch, CORE_ADDR func_addr)
4872 struct symtab_and_line prologue_sal;
4877 /* Get an initial range for the function. */
4878 find_pc_partial_function (func_addr, NULL, &start_pc, &end_pc);
4879 start_pc += gdbarch_deprecated_function_start_offset (gdbarch);
4881 prologue_sal = find_pc_line (start_pc, 0);
4882 if (prologue_sal.line != 0)
4884 /* For languages other than assembly, treat two consecutive line
4885 entries at the same address as a zero-instruction prologue.
4886 The GNU assembler emits separate line notes for each instruction
4887 in a multi-instruction macro, but compilers generally will not
4889 if (prologue_sal.symtab->language != language_asm)
4891 struct linetable *linetable = LINETABLE (prologue_sal.symtab);
4894 /* Skip any earlier lines, and any end-of-sequence marker
4895 from a previous function. */
4896 while (linetable->item[idx].pc != prologue_sal.pc
4897 || linetable->item[idx].line == 0)
4900 if (idx+1 < linetable->nitems
4901 && linetable->item[idx+1].line != 0
4902 && linetable->item[idx+1].pc == start_pc)
4906 /* If there is only one sal that covers the entire function,
4907 then it is probably a single line function, like
4909 if (prologue_sal.end >= end_pc)
4912 while (prologue_sal.end < end_pc)
4914 struct symtab_and_line sal;
4916 sal = find_pc_line (prologue_sal.end, 0);
4919 /* Assume that a consecutive SAL for the same (or larger)
4920 line mark the prologue -> body transition. */
4921 if (sal.line >= prologue_sal.line)
4923 /* Likewise if we are in a different symtab altogether
4924 (e.g. within a file included via #include). */
4925 if (sal.symtab != prologue_sal.symtab)
4928 /* The line number is smaller. Check that it's from the
4929 same function, not something inlined. If it's inlined,
4930 then there is no point comparing the line numbers. */
4931 bl = block_for_pc (prologue_sal.end);
4934 if (block_inlined_p (bl))
4936 if (BLOCK_FUNCTION (bl))
4941 bl = BLOCK_SUPERBLOCK (bl);
4946 /* The case in which compiler's optimizer/scheduler has
4947 moved instructions into the prologue. We look ahead in
4948 the function looking for address ranges whose
4949 corresponding line number is less the first one that we
4950 found for the function. This is more conservative then
4951 refine_prologue_limit which scans a large number of SALs
4952 looking for any in the prologue. */
4957 if (prologue_sal.end < end_pc)
4958 /* Return the end of this line, or zero if we could not find a
4960 return prologue_sal.end;
4962 /* Don't return END_PC, which is past the end of the function. */
4963 return prologue_sal.pc;
4967 static char *name_of_main;
4968 enum language language_of_main = language_unknown;
4971 set_main_name (const char *name)
4973 if (name_of_main != NULL)
4975 xfree (name_of_main);
4976 name_of_main = NULL;
4977 language_of_main = language_unknown;
4981 name_of_main = xstrdup (name);
4982 language_of_main = language_unknown;
4986 /* Deduce the name of the main procedure, and set NAME_OF_MAIN
4990 find_main_name (void)
4992 const char *new_main_name;
4994 /* Try to see if the main procedure is in Ada. */
4995 /* FIXME: brobecker/2005-03-07: Another way of doing this would
4996 be to add a new method in the language vector, and call this
4997 method for each language until one of them returns a non-empty
4998 name. This would allow us to remove this hard-coded call to
4999 an Ada function. It is not clear that this is a better approach
5000 at this point, because all methods need to be written in a way
5001 such that false positives never be returned. For instance, it is
5002 important that a method does not return a wrong name for the main
5003 procedure if the main procedure is actually written in a different
5004 language. It is easy to guaranty this with Ada, since we use a
5005 special symbol generated only when the main in Ada to find the name
5006 of the main procedure. It is difficult however to see how this can
5007 be guarantied for languages such as C, for instance. This suggests
5008 that order of call for these methods becomes important, which means
5009 a more complicated approach. */
5010 new_main_name = ada_main_name ();
5011 if (new_main_name != NULL)
5013 set_main_name (new_main_name);
5017 new_main_name = go_main_name ();
5018 if (new_main_name != NULL)
5020 set_main_name (new_main_name);
5024 new_main_name = pascal_main_name ();
5025 if (new_main_name != NULL)
5027 set_main_name (new_main_name);
5031 /* The languages above didn't identify the name of the main procedure.
5032 Fallback to "main". */
5033 set_main_name ("main");
5039 if (name_of_main == NULL)
5042 return name_of_main;
5045 /* Handle ``executable_changed'' events for the symtab module. */
5048 symtab_observer_executable_changed (void)
5050 /* NAME_OF_MAIN may no longer be the same, so reset it for now. */
5051 set_main_name (NULL);
5054 /* Return 1 if the supplied producer string matches the ARM RealView
5055 compiler (armcc). */
5058 producer_is_realview (const char *producer)
5060 static const char *const arm_idents[] = {
5061 "ARM C Compiler, ADS",
5062 "Thumb C Compiler, ADS",
5063 "ARM C++ Compiler, ADS",
5064 "Thumb C++ Compiler, ADS",
5065 "ARM/Thumb C/C++ Compiler, RVCT",
5066 "ARM C/C++ Compiler, RVCT"
5070 if (producer == NULL)
5073 for (i = 0; i < ARRAY_SIZE (arm_idents); i++)
5074 if (strncmp (producer, arm_idents[i], strlen (arm_idents[i])) == 0)
5082 /* The next index to hand out in response to a registration request. */
5084 static int next_aclass_value = LOC_FINAL_VALUE;
5086 /* The maximum number of "aclass" registrations we support. This is
5087 constant for convenience. */
5088 #define MAX_SYMBOL_IMPLS (LOC_FINAL_VALUE + 10)
5090 /* The objects representing the various "aclass" values. The elements
5091 from 0 up to LOC_FINAL_VALUE-1 represent themselves, and subsequent
5092 elements are those registered at gdb initialization time. */
5094 static struct symbol_impl symbol_impl[MAX_SYMBOL_IMPLS];
5096 /* The globally visible pointer. This is separate from 'symbol_impl'
5097 so that it can be const. */
5099 const struct symbol_impl *symbol_impls = &symbol_impl[0];
5101 /* Make sure we saved enough room in struct symbol. */
5103 gdb_static_assert (MAX_SYMBOL_IMPLS <= (1 << SYMBOL_ACLASS_BITS));
5105 /* Register a computed symbol type. ACLASS must be LOC_COMPUTED. OPS
5106 is the ops vector associated with this index. This returns the new
5107 index, which should be used as the aclass_index field for symbols
5111 register_symbol_computed_impl (enum address_class aclass,
5112 const struct symbol_computed_ops *ops)
5114 int result = next_aclass_value++;
5116 gdb_assert (aclass == LOC_COMPUTED);
5117 gdb_assert (result < MAX_SYMBOL_IMPLS);
5118 symbol_impl[result].aclass = aclass;
5119 symbol_impl[result].ops_computed = ops;
5121 /* Sanity check OPS. */
5122 gdb_assert (ops != NULL);
5123 gdb_assert (ops->tracepoint_var_ref != NULL);
5124 gdb_assert (ops->describe_location != NULL);
5125 gdb_assert (ops->read_needs_frame != NULL);
5126 gdb_assert (ops->read_variable != NULL);
5131 /* Register a function with frame base type. ACLASS must be LOC_BLOCK.
5132 OPS is the ops vector associated with this index. This returns the
5133 new index, which should be used as the aclass_index field for symbols
5137 register_symbol_block_impl (enum address_class aclass,
5138 const struct symbol_block_ops *ops)
5140 int result = next_aclass_value++;
5142 gdb_assert (aclass == LOC_BLOCK);
5143 gdb_assert (result < MAX_SYMBOL_IMPLS);
5144 symbol_impl[result].aclass = aclass;
5145 symbol_impl[result].ops_block = ops;
5147 /* Sanity check OPS. */
5148 gdb_assert (ops != NULL);
5149 gdb_assert (ops->find_frame_base_location != NULL);
5154 /* Register a register symbol type. ACLASS must be LOC_REGISTER or
5155 LOC_REGPARM_ADDR. OPS is the register ops vector associated with
5156 this index. This returns the new index, which should be used as
5157 the aclass_index field for symbols of this type. */
5160 register_symbol_register_impl (enum address_class aclass,
5161 const struct symbol_register_ops *ops)
5163 int result = next_aclass_value++;
5165 gdb_assert (aclass == LOC_REGISTER || aclass == LOC_REGPARM_ADDR);
5166 gdb_assert (result < MAX_SYMBOL_IMPLS);
5167 symbol_impl[result].aclass = aclass;
5168 symbol_impl[result].ops_register = ops;
5173 /* Initialize elements of 'symbol_impl' for the constants in enum
5177 initialize_ordinary_address_classes (void)
5181 for (i = 0; i < LOC_FINAL_VALUE; ++i)
5182 symbol_impl[i].aclass = i;
5187 /* Initialize the symbol SYM. */
5190 initialize_symbol (struct symbol *sym)
5192 memset (sym, 0, sizeof (*sym));
5193 SYMBOL_SECTION (sym) = -1;
5196 /* Allocate and initialize a new 'struct symbol' on OBJFILE's
5200 allocate_symbol (struct objfile *objfile)
5202 struct symbol *result;
5204 result = OBSTACK_ZALLOC (&objfile->objfile_obstack, struct symbol);
5205 SYMBOL_SECTION (result) = -1;
5210 /* Allocate and initialize a new 'struct template_symbol' on OBJFILE's
5213 struct template_symbol *
5214 allocate_template_symbol (struct objfile *objfile)
5216 struct template_symbol *result;
5218 result = OBSTACK_ZALLOC (&objfile->objfile_obstack, struct template_symbol);
5219 SYMBOL_SECTION (&result->base) = -1;
5227 _initialize_symtab (void)
5229 initialize_ordinary_address_classes ();
5231 add_info ("variables", variables_info, _("\
5232 All global and static variable names, or those matching REGEXP."));
5234 add_com ("whereis", class_info, variables_info, _("\
5235 All global and static variable names, or those matching REGEXP."));
5237 add_info ("functions", functions_info,
5238 _("All function names, or those matching REGEXP."));
5240 /* FIXME: This command has at least the following problems:
5241 1. It prints builtin types (in a very strange and confusing fashion).
5242 2. It doesn't print right, e.g. with
5243 typedef struct foo *FOO
5244 type_print prints "FOO" when we want to make it (in this situation)
5245 print "struct foo *".
5246 I also think "ptype" or "whatis" is more likely to be useful (but if
5247 there is much disagreement "info types" can be fixed). */
5248 add_info ("types", types_info,
5249 _("All type names, or those matching REGEXP."));
5251 add_info ("sources", sources_info,
5252 _("Source files in the program."));
5254 add_com ("rbreak", class_breakpoint, rbreak_command,
5255 _("Set a breakpoint for all functions matching REGEXP."));
5259 add_com ("lf", class_info, sources_info,
5260 _("Source files in the program"));
5261 add_com ("lg", class_info, variables_info, _("\
5262 All global and static variable names, or those matching REGEXP."));
5265 add_setshow_enum_cmd ("multiple-symbols", no_class,
5266 multiple_symbols_modes, &multiple_symbols_mode,
5268 Set the debugger behavior when more than one symbol are possible matches\n\
5269 in an expression."), _("\
5270 Show how the debugger handles ambiguities in expressions."), _("\
5271 Valid values are \"ask\", \"all\", \"cancel\", and the default is \"all\"."),
5272 NULL, NULL, &setlist, &showlist);
5274 add_setshow_boolean_cmd ("basenames-may-differ", class_obscure,
5275 &basenames_may_differ, _("\
5276 Set whether a source file may have multiple base names."), _("\
5277 Show whether a source file may have multiple base names."), _("\
5278 (A \"base name\" is the name of a file with the directory part removed.\n\
5279 Example: The base name of \"/home/user/hello.c\" is \"hello.c\".)\n\
5280 If set, GDB will canonicalize file names (e.g., expand symlinks)\n\
5281 before comparing them. Canonicalization is an expensive operation,\n\
5282 but it allows the same file be known by more than one base name.\n\
5283 If not set (the default), all source files are assumed to have just\n\
5284 one base name, and gdb will do file name comparisons more efficiently."),
5286 &setlist, &showlist);
5288 add_setshow_boolean_cmd ("symtab-create", no_class, &symtab_create_debug,
5289 _("Set debugging of symbol table creation."),
5290 _("Show debugging of symbol table creation."), _("\
5291 When enabled, debugging messages are printed when building symbol tables."),
5294 &setdebuglist, &showdebuglist);
5296 observer_attach_executable_changed (symtab_observer_executable_changed);