1 /* Parser for linespec for the GNU debugger, GDB.
3 Copyright (C) 1986-2016 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/>. */
29 #include "completer.h"
31 #include "cp-support.h"
32 #include "parser-defs.h"
34 #include "objc-lang.h"
38 #include "mi/mi-cmds.h"
40 #include "arch-utils.h"
42 #include "cli/cli-utils.h"
43 #include "filenames.h"
48 typedef struct symbol *symbolp;
51 typedef struct type *typep;
54 /* An address entry is used to ensure that any given location is only
55 added to the result a single time. It holds an address and the
56 program space from which the address came. */
60 struct program_space *pspace;
64 typedef struct bound_minimal_symbol bound_minimal_symbol_d;
66 DEF_VEC_O (bound_minimal_symbol_d);
68 /* A linespec. Elements of this structure are filled in by a parser
69 (either parse_linespec or some other function). The structure is
70 then converted into SALs by convert_linespec_to_sals. */
74 /* An explicit location describing the SaLs. */
75 struct explicit_location explicit_loc;
77 /* The list of symtabs to search to which to limit the search. May not
78 be NULL. If explicit.SOURCE_FILENAME is NULL (no user-specified
79 filename), FILE_SYMTABS should contain one single NULL member. This
80 will cause the code to use the default symtab. */
81 VEC (symtab_ptr) *file_symtabs;
83 /* A list of matching function symbols and minimal symbols. Both lists
84 may be NULL if no matching symbols were found. */
85 VEC (symbolp) *function_symbols;
86 VEC (bound_minimal_symbol_d) *minimal_symbols;
88 /* A structure of matching label symbols and the corresponding
89 function symbol in which the label was found. Both may be NULL
90 or both must be non-NULL. */
93 VEC (symbolp) *label_symbols;
94 VEC (symbolp) *function_symbols;
97 typedef struct linespec *linespec_p;
99 /* A canonical linespec represented as a symtab-related string.
101 Each entry represents the "SYMTAB:SUFFIX" linespec string.
102 SYMTAB can be converted for example by symtab_to_fullname or
103 symtab_to_filename_for_display as needed. */
105 struct linespec_canonical_name
107 /* Remaining text part of the linespec string. */
110 /* If NULL then SUFFIX is the whole linespec string. */
111 struct symtab *symtab;
114 /* An instance of this is used to keep all state while linespec
115 operates. This instance is passed around as a 'this' pointer to
116 the various implementation methods. */
118 struct linespec_state
120 /* The language in use during linespec processing. */
121 const struct language_defn *language;
123 /* The program space as seen when the module was entered. */
124 struct program_space *program_space;
126 /* If not NULL, the search is restricted to just this program
128 struct program_space *search_pspace;
130 /* The default symtab to use, if no other symtab is specified. */
131 struct symtab *default_symtab;
133 /* The default line to use. */
136 /* The 'funfirstline' value that was passed in to decode_line_1 or
140 /* Nonzero if we are running in 'list' mode; see decode_line_list. */
143 /* The 'canonical' value passed to decode_line_full, or NULL. */
144 struct linespec_result *canonical;
146 /* Canonical strings that mirror the symtabs_and_lines result. */
147 struct linespec_canonical_name *canonical_names;
149 /* This is a set of address_entry objects which is used to prevent
150 duplicate symbols from being entered into the result. */
153 /* Are we building a linespec? */
157 /* This is a helper object that is used when collecting symbols into a
162 /* The linespec object in use. */
163 struct linespec_state *state;
165 /* A list of symtabs to which to restrict matches. */
166 VEC (symtab_ptr) *file_symtabs;
168 /* The result being accumulated. */
171 VEC (symbolp) *symbols;
172 VEC (bound_minimal_symbol_d) *minimal_symbols;
183 /* A colon "separator" */
195 /* EOI (end of input) */
201 typedef enum ls_token_type linespec_token_type;
203 /* List of keywords */
205 static const char * const linespec_keywords[] = { "if", "thread", "task" };
206 #define IF_KEYWORD_INDEX 0
208 /* A token of the linespec lexer */
212 /* The type of the token */
213 linespec_token_type type;
215 /* Data for the token */
218 /* A string, given as a stoken */
219 struct stoken string;
225 typedef struct ls_token linespec_token;
227 #define LS_TOKEN_STOKEN(TOK) (TOK).data.string
228 #define LS_TOKEN_KEYWORD(TOK) (TOK).data.keyword
230 /* An instance of the linespec parser. */
234 /* Lexer internal data */
237 /* Save head of input stream. */
238 const char *saved_arg;
240 /* Head of the input stream. */
242 #define PARSER_STREAM(P) ((P)->lexer.stream)
244 /* The current token. */
245 linespec_token current;
248 /* Is the entire linespec quote-enclosed? */
249 int is_quote_enclosed;
251 /* The state of the parse. */
252 struct linespec_state state;
253 #define PARSER_STATE(PPTR) (&(PPTR)->state)
255 /* The result of the parse. */
256 struct linespec result;
257 #define PARSER_RESULT(PPTR) (&(PPTR)->result)
259 typedef struct ls_parser linespec_parser;
261 /* A convenience macro for accessing the explicit location result of
263 #define PARSER_EXPLICIT(PPTR) (&PARSER_RESULT ((PPTR))->explicit_loc)
265 /* Prototypes for local functions. */
267 static void iterate_over_file_blocks (struct symtab *symtab,
268 const char *name, domain_enum domain,
269 symbol_found_callback_ftype *callback,
272 static void initialize_defaults (struct symtab **default_symtab,
275 CORE_ADDR linespec_expression_to_pc (const char **exp_ptr);
277 static struct symtabs_and_lines decode_objc (struct linespec_state *self,
281 static VEC (symtab_ptr) *symtabs_from_filename (const char *,
282 struct program_space *pspace);
284 static VEC (symbolp) *find_label_symbols (struct linespec_state *self,
285 VEC (symbolp) *function_symbols,
286 VEC (symbolp) **label_funcs_ret,
289 static void find_linespec_symbols (struct linespec_state *self,
290 VEC (symtab_ptr) *file_symtabs,
292 VEC (symbolp) **symbols,
293 VEC (bound_minimal_symbol_d) **minsyms);
295 static struct line_offset
296 linespec_parse_variable (struct linespec_state *self,
297 const char *variable);
299 static int symbol_to_sal (struct symtab_and_line *result,
300 int funfirstline, struct symbol *sym);
302 static void add_matching_symbols_to_info (const char *name,
303 struct collect_info *info,
304 struct program_space *pspace);
306 static void add_all_symbol_names_from_pspace (struct collect_info *info,
307 struct program_space *pspace,
308 VEC (const_char_ptr) *names);
310 static VEC (symtab_ptr) *
311 collect_symtabs_from_filename (const char *file,
312 struct program_space *pspace);
314 static void decode_digits_ordinary (struct linespec_state *self,
317 struct symtabs_and_lines *sals,
318 struct linetable_entry **best_entry);
320 static void decode_digits_list_mode (struct linespec_state *self,
322 struct symtabs_and_lines *values,
323 struct symtab_and_line val);
325 static void minsym_found (struct linespec_state *self, struct objfile *objfile,
326 struct minimal_symbol *msymbol,
327 struct symtabs_and_lines *result);
329 static int compare_symbols (const void *a, const void *b);
331 static int compare_msymbols (const void *a, const void *b);
333 /* Permitted quote characters for the parser. This is different from the
334 completer's quote characters to allow backward compatibility with the
336 static const char *const linespec_quote_characters = "\"\'";
338 /* Lexer functions. */
340 /* Lex a number from the input in PARSER. This only supports
343 Return true if input is decimal numbers. Return false if not. */
346 linespec_lexer_lex_number (linespec_parser *parser, linespec_token *tokenp)
348 tokenp->type = LSTOKEN_NUMBER;
349 LS_TOKEN_STOKEN (*tokenp).length = 0;
350 LS_TOKEN_STOKEN (*tokenp).ptr = PARSER_STREAM (parser);
352 /* Keep any sign at the start of the stream. */
353 if (*PARSER_STREAM (parser) == '+' || *PARSER_STREAM (parser) == '-')
355 ++LS_TOKEN_STOKEN (*tokenp).length;
356 ++(PARSER_STREAM (parser));
359 while (isdigit (*PARSER_STREAM (parser)))
361 ++LS_TOKEN_STOKEN (*tokenp).length;
362 ++(PARSER_STREAM (parser));
365 /* If the next character in the input buffer is not a space, comma,
366 quote, or colon, this input does not represent a number. */
367 if (*PARSER_STREAM (parser) != '\0'
368 && !isspace (*PARSER_STREAM (parser)) && *PARSER_STREAM (parser) != ','
369 && *PARSER_STREAM (parser) != ':'
370 && !strchr (linespec_quote_characters, *PARSER_STREAM (parser)))
372 PARSER_STREAM (parser) = LS_TOKEN_STOKEN (*tokenp).ptr;
379 /* See linespec.h. */
382 linespec_lexer_lex_keyword (const char *p)
388 for (i = 0; i < ARRAY_SIZE (linespec_keywords); ++i)
390 int len = strlen (linespec_keywords[i]);
392 /* If P begins with one of the keywords and the next
393 character is whitespace, we may have found a keyword.
394 It is only a keyword if it is not followed by another
396 if (strncmp (p, linespec_keywords[i], len) == 0
401 /* Special case: "if" ALWAYS stops the lexer, since it
402 is not possible to predict what is going to appear in
403 the condition, which can only be parsed after SaLs have
405 if (i != IF_KEYWORD_INDEX)
408 p = skip_spaces_const (p);
409 for (j = 0; j < ARRAY_SIZE (linespec_keywords); ++j)
411 int nextlen = strlen (linespec_keywords[j]);
413 if (strncmp (p, linespec_keywords[j], nextlen) == 0
414 && isspace (p[nextlen]))
419 return linespec_keywords[i];
427 /* See description in linespec.h. */
430 is_ada_operator (const char *string)
432 const struct ada_opname_map *mapping;
434 for (mapping = ada_opname_table;
435 mapping->encoded != NULL
436 && !startswith (string, mapping->decoded); ++mapping)
439 return mapping->decoded == NULL ? 0 : strlen (mapping->decoded);
442 /* Find QUOTE_CHAR in STRING, accounting for the ':' terminal. Return
443 the location of QUOTE_CHAR, or NULL if not found. */
446 skip_quote_char (const char *string, char quote_char)
448 const char *p, *last;
450 p = last = find_toplevel_char (string, quote_char);
451 while (p && *p != '\0' && *p != ':')
453 p = find_toplevel_char (p, quote_char);
461 /* Make a writable copy of the string given in TOKEN, trimming
462 any trailing whitespace. */
465 copy_token_string (linespec_token token)
469 if (token.type == LSTOKEN_KEYWORD)
470 return xstrdup (LS_TOKEN_KEYWORD (token));
472 str = savestring (LS_TOKEN_STOKEN (token).ptr,
473 LS_TOKEN_STOKEN (token).length);
474 s = remove_trailing_whitespace (str, str + LS_TOKEN_STOKEN (token).length);
480 /* Does P represent the end of a quote-enclosed linespec? */
483 is_closing_quote_enclosed (const char *p)
485 if (strchr (linespec_quote_characters, *p))
487 p = skip_spaces ((char *) p);
488 return (*p == '\0' || linespec_lexer_lex_keyword (p));
491 /* Find the end of the parameter list that starts with *INPUT.
492 This helper function assists with lexing string segments
493 which might contain valid (non-terminating) commas. */
496 find_parameter_list_end (const char *input)
498 char end_char, start_char;
503 if (start_char == '(')
505 else if (start_char == '<')
514 if (*p == start_char)
516 else if (*p == end_char)
531 /* Lex a string from the input in PARSER. */
533 static linespec_token
534 linespec_lexer_lex_string (linespec_parser *parser)
536 linespec_token token;
537 const char *start = PARSER_STREAM (parser);
539 token.type = LSTOKEN_STRING;
541 /* If the input stream starts with a quote character, skip to the next
542 quote character, regardless of the content. */
543 if (strchr (linespec_quote_characters, *PARSER_STREAM (parser)))
546 char quote_char = *PARSER_STREAM (parser);
548 /* Special case: Ada operators. */
549 if (PARSER_STATE (parser)->language->la_language == language_ada
550 && quote_char == '\"')
552 int len = is_ada_operator (PARSER_STREAM (parser));
556 /* The input is an Ada operator. Return the quoted string
558 LS_TOKEN_STOKEN (token).ptr = PARSER_STREAM (parser);
559 LS_TOKEN_STOKEN (token).length = len;
560 PARSER_STREAM (parser) += len;
564 /* The input does not represent an Ada operator -- fall through
565 to normal quoted string handling. */
568 /* Skip past the beginning quote. */
569 ++(PARSER_STREAM (parser));
571 /* Mark the start of the string. */
572 LS_TOKEN_STOKEN (token).ptr = PARSER_STREAM (parser);
574 /* Skip to the ending quote. */
575 end = skip_quote_char (PARSER_STREAM (parser), quote_char);
577 /* Error if the input did not terminate properly. */
579 error (_("unmatched quote"));
581 /* Skip over the ending quote and mark the length of the string. */
582 PARSER_STREAM (parser) = (char *) ++end;
583 LS_TOKEN_STOKEN (token).length = PARSER_STREAM (parser) - 2 - start;
589 /* Otherwise, only identifier characters are permitted.
590 Spaces are the exception. In general, we keep spaces,
591 but only if the next characters in the input do not resolve
592 to one of the keywords.
594 This allows users to forgo quoting CV-qualifiers, template arguments,
595 and similar common language constructs. */
599 if (isspace (*PARSER_STREAM (parser)))
601 p = skip_spaces_const (PARSER_STREAM (parser));
602 /* When we get here we know we've found something followed by
603 a space (we skip over parens and templates below).
604 So if we find a keyword now, we know it is a keyword and not,
605 say, a function name. */
606 if (linespec_lexer_lex_keyword (p) != NULL)
608 LS_TOKEN_STOKEN (token).ptr = start;
609 LS_TOKEN_STOKEN (token).length
610 = PARSER_STREAM (parser) - start;
614 /* Advance past the whitespace. */
615 PARSER_STREAM (parser) = p;
618 /* If the next character is EOI or (single) ':', the
619 string is complete; return the token. */
620 if (*PARSER_STREAM (parser) == 0)
622 LS_TOKEN_STOKEN (token).ptr = start;
623 LS_TOKEN_STOKEN (token).length = PARSER_STREAM (parser) - start;
626 else if (PARSER_STREAM (parser)[0] == ':')
628 /* Do not tokenize the C++ scope operator. */
629 if (PARSER_STREAM (parser)[1] == ':')
630 ++(PARSER_STREAM (parser));
632 /* Do not tokenify if the input length so far is one
633 (i.e, a single-letter drive name) and the next character
634 is a directory separator. This allows Windows-style
635 paths to be recognized as filenames without quoting it. */
636 else if ((PARSER_STREAM (parser) - start) != 1
637 || !IS_DIR_SEPARATOR (PARSER_STREAM (parser)[1]))
639 LS_TOKEN_STOKEN (token).ptr = start;
640 LS_TOKEN_STOKEN (token).length
641 = PARSER_STREAM (parser) - start;
645 /* Special case: permit quote-enclosed linespecs. */
646 else if (parser->is_quote_enclosed
647 && strchr (linespec_quote_characters,
648 *PARSER_STREAM (parser))
649 && is_closing_quote_enclosed (PARSER_STREAM (parser)))
651 LS_TOKEN_STOKEN (token).ptr = start;
652 LS_TOKEN_STOKEN (token).length = PARSER_STREAM (parser) - start;
655 /* Because commas may terminate a linespec and appear in
656 the middle of valid string input, special cases for
657 '<' and '(' are necessary. */
658 else if (*PARSER_STREAM (parser) == '<'
659 || *PARSER_STREAM (parser) == '(')
663 p = find_parameter_list_end (PARSER_STREAM (parser));
666 PARSER_STREAM (parser) = p;
670 /* Commas are terminators, but not if they are part of an
672 else if (*PARSER_STREAM (parser) == ',')
674 if ((PARSER_STATE (parser)->language->la_language
676 && (PARSER_STREAM (parser) - start) > 8
677 /* strlen ("operator") */)
679 const char *p = strstr (start, "operator");
681 if (p != NULL && is_operator_name (p))
683 /* This is an operator name. Keep going. */
684 ++(PARSER_STREAM (parser));
689 /* Comma terminates the string. */
690 LS_TOKEN_STOKEN (token).ptr = start;
691 LS_TOKEN_STOKEN (token).length = PARSER_STREAM (parser) - start;
695 /* Advance the stream. */
696 ++(PARSER_STREAM (parser));
703 /* Lex a single linespec token from PARSER. */
705 static linespec_token
706 linespec_lexer_lex_one (linespec_parser *parser)
710 if (parser->lexer.current.type == LSTOKEN_CONSUMED)
712 /* Skip any whitespace. */
713 PARSER_STREAM (parser) = skip_spaces_const (PARSER_STREAM (parser));
715 /* Check for a keyword, they end the linespec. */
716 keyword = linespec_lexer_lex_keyword (PARSER_STREAM (parser));
719 parser->lexer.current.type = LSTOKEN_KEYWORD;
720 LS_TOKEN_KEYWORD (parser->lexer.current) = keyword;
721 /* We do not advance the stream here intentionally:
722 we would like lexing to stop when a keyword is seen.
724 PARSER_STREAM (parser) += strlen (keyword); */
726 return parser->lexer.current;
729 /* Handle other tokens. */
730 switch (*PARSER_STREAM (parser))
733 parser->lexer.current.type = LSTOKEN_EOI;
737 case '0': case '1': case '2': case '3': case '4':
738 case '5': case '6': case '7': case '8': case '9':
739 if (!linespec_lexer_lex_number (parser, &(parser->lexer.current)))
740 parser->lexer.current = linespec_lexer_lex_string (parser);
744 /* If we have a scope operator, lex the input as a string.
745 Otherwise, return LSTOKEN_COLON. */
746 if (PARSER_STREAM (parser)[1] == ':')
747 parser->lexer.current = linespec_lexer_lex_string (parser);
750 parser->lexer.current.type = LSTOKEN_COLON;
751 ++(PARSER_STREAM (parser));
755 case '\'': case '\"':
756 /* Special case: permit quote-enclosed linespecs. */
757 if (parser->is_quote_enclosed
758 && is_closing_quote_enclosed (PARSER_STREAM (parser)))
760 ++(PARSER_STREAM (parser));
761 parser->lexer.current.type = LSTOKEN_EOI;
764 parser->lexer.current = linespec_lexer_lex_string (parser);
768 parser->lexer.current.type = LSTOKEN_COMMA;
769 LS_TOKEN_STOKEN (parser->lexer.current).ptr
770 = PARSER_STREAM (parser);
771 LS_TOKEN_STOKEN (parser->lexer.current).length = 1;
772 ++(PARSER_STREAM (parser));
776 /* If the input is not a number, it must be a string.
777 [Keywords were already considered above.] */
778 parser->lexer.current = linespec_lexer_lex_string (parser);
783 return parser->lexer.current;
786 /* Consume the current token and return the next token in PARSER's
789 static linespec_token
790 linespec_lexer_consume_token (linespec_parser *parser)
792 parser->lexer.current.type = LSTOKEN_CONSUMED;
793 return linespec_lexer_lex_one (parser);
796 /* Return the next token without consuming the current token. */
798 static linespec_token
799 linespec_lexer_peek_token (linespec_parser *parser)
802 const char *saved_stream = PARSER_STREAM (parser);
803 linespec_token saved_token = parser->lexer.current;
805 next = linespec_lexer_consume_token (parser);
806 PARSER_STREAM (parser) = saved_stream;
807 parser->lexer.current = saved_token;
811 /* Helper functions. */
813 /* Add SAL to SALS. */
816 add_sal_to_sals_basic (struct symtabs_and_lines *sals,
817 struct symtab_and_line *sal)
820 sals->sals = XRESIZEVEC (struct symtab_and_line, sals->sals, sals->nelts);
821 sals->sals[sals->nelts - 1] = *sal;
824 /* Add SAL to SALS, and also update SELF->CANONICAL_NAMES to reflect
825 the new sal, if needed. If not NULL, SYMNAME is the name of the
826 symbol to use when constructing the new canonical name.
828 If LITERAL_CANONICAL is non-zero, SYMNAME will be used as the
829 canonical name for the SAL. */
832 add_sal_to_sals (struct linespec_state *self,
833 struct symtabs_and_lines *sals,
834 struct symtab_and_line *sal,
835 const char *symname, int literal_canonical)
837 add_sal_to_sals_basic (sals, sal);
841 struct linespec_canonical_name *canonical;
843 self->canonical_names = XRESIZEVEC (struct linespec_canonical_name,
844 self->canonical_names, sals->nelts);
845 canonical = &self->canonical_names[sals->nelts - 1];
846 if (!literal_canonical && sal->symtab)
848 /* Note that the filter doesn't have to be a valid linespec
849 input. We only apply the ":LINE" treatment to Ada for
851 if (symname != NULL && sal->line != 0
852 && self->language->la_language == language_ada)
853 canonical->suffix = xstrprintf ("%s:%d", symname, sal->line);
854 else if (symname != NULL)
855 canonical->suffix = xstrdup (symname);
857 canonical->suffix = xstrprintf ("%d", sal->line);
858 canonical->symtab = sal->symtab;
863 canonical->suffix = xstrdup (symname);
865 canonical->suffix = xstrdup ("<unknown>");
866 canonical->symtab = NULL;
871 /* A hash function for address_entry. */
874 hash_address_entry (const void *p)
876 const struct address_entry *aep = (const struct address_entry *) p;
879 hash = iterative_hash_object (aep->pspace, 0);
880 return iterative_hash_object (aep->addr, hash);
883 /* An equality function for address_entry. */
886 eq_address_entry (const void *a, const void *b)
888 const struct address_entry *aea = (const struct address_entry *) a;
889 const struct address_entry *aeb = (const struct address_entry *) b;
891 return aea->pspace == aeb->pspace && aea->addr == aeb->addr;
894 /* Check whether the address, represented by PSPACE and ADDR, is
895 already in the set. If so, return 0. Otherwise, add it and return
899 maybe_add_address (htab_t set, struct program_space *pspace, CORE_ADDR addr)
901 struct address_entry e, *p;
906 slot = htab_find_slot (set, &e, INSERT);
910 p = XNEW (struct address_entry);
911 memcpy (p, &e, sizeof (struct address_entry));
917 /* A callback function and the additional data to call it with. */
919 struct symbol_and_data_callback
921 /* The callback to use. */
922 symbol_found_callback_ftype *callback;
924 /* Data to be passed to the callback. */
928 /* A helper for iterate_over_all_matching_symtabs that is used to
929 restrict calls to another callback to symbols representing inline
933 iterate_inline_only (struct symbol *sym, void *d)
935 if (SYMBOL_INLINED (sym))
937 struct symbol_and_data_callback *cad
938 = (struct symbol_and_data_callback *) d;
940 return cad->callback (sym, cad->data);
942 return 1; /* Continue iterating. */
945 /* Some data for the expand_symtabs_matching callback. */
947 struct symbol_matcher_data
949 /* The lookup name against which symbol name should be compared. */
950 const char *lookup_name;
952 /* The routine to be used for comparison. */
953 symbol_name_cmp_ftype symbol_name_cmp;
956 /* A helper for iterate_over_all_matching_symtabs that is passed as a
957 callback to the expand_symtabs_matching method. */
960 iterate_name_matcher (const char *name, void *d)
962 const struct symbol_matcher_data *data
963 = (const struct symbol_matcher_data *) d;
965 if (data->symbol_name_cmp (name, data->lookup_name) == 0)
966 return 1; /* Expand this symbol's symbol table. */
967 return 0; /* Skip this symbol. */
970 /* A helper that walks over all matching symtabs in all objfiles and
971 calls CALLBACK for each symbol matching NAME. If SEARCH_PSPACE is
972 not NULL, then the search is restricted to just that program
973 space. If INCLUDE_INLINE is nonzero then symbols representing
974 inlined instances of functions will be included in the result. */
977 iterate_over_all_matching_symtabs (struct linespec_state *state,
979 const domain_enum domain,
980 symbol_found_callback_ftype *callback,
982 struct program_space *search_pspace,
985 struct objfile *objfile;
986 struct program_space *pspace;
987 struct symbol_matcher_data matcher_data;
989 matcher_data.lookup_name = name;
990 matcher_data.symbol_name_cmp =
991 state->language->la_get_symbol_name_cmp != NULL
992 ? state->language->la_get_symbol_name_cmp (name)
997 if (search_pspace != NULL && search_pspace != pspace)
999 if (pspace->executing_startup)
1002 set_current_program_space (pspace);
1004 ALL_OBJFILES (objfile)
1006 struct compunit_symtab *cu;
1009 objfile->sf->qf->expand_symtabs_matching (objfile, NULL,
1010 iterate_name_matcher,
1014 ALL_OBJFILE_COMPUNITS (objfile, cu)
1016 struct symtab *symtab = COMPUNIT_FILETABS (cu);
1018 iterate_over_file_blocks (symtab, name, domain, callback, data);
1022 struct symbol_and_data_callback cad = { callback, data };
1023 struct block *block;
1026 for (i = FIRST_LOCAL_BLOCK;
1027 i < BLOCKVECTOR_NBLOCKS (SYMTAB_BLOCKVECTOR (symtab));
1030 block = BLOCKVECTOR_BLOCK (SYMTAB_BLOCKVECTOR (symtab), i);
1031 state->language->la_iterate_over_symbols
1032 (block, name, domain, iterate_inline_only, &cad);
1040 /* Returns the block to be used for symbol searches from
1041 the current location. */
1043 static const struct block *
1044 get_current_search_block (void)
1046 const struct block *block;
1047 enum language save_language;
1049 /* get_selected_block can change the current language when there is
1050 no selected frame yet. */
1051 save_language = current_language->la_language;
1052 block = get_selected_block (0);
1053 set_language (save_language);
1058 /* Iterate over static and global blocks. */
1061 iterate_over_file_blocks (struct symtab *symtab,
1062 const char *name, domain_enum domain,
1063 symbol_found_callback_ftype *callback, void *data)
1065 struct block *block;
1067 for (block = BLOCKVECTOR_BLOCK (SYMTAB_BLOCKVECTOR (symtab), STATIC_BLOCK);
1069 block = BLOCK_SUPERBLOCK (block))
1070 LA_ITERATE_OVER_SYMBOLS (block, name, domain, callback, data);
1073 /* A helper for find_method. This finds all methods in type T which
1074 match NAME. It adds matching symbol names to RESULT_NAMES, and
1075 adds T's direct superclasses to SUPERCLASSES. */
1078 find_methods (struct type *t, const char *name,
1079 VEC (const_char_ptr) **result_names,
1080 VEC (typep) **superclasses)
1083 const char *class_name = type_name_no_tag (t);
1085 /* Ignore this class if it doesn't have a name. This is ugly, but
1086 unless we figure out how to get the physname without the name of
1087 the class, then the loop can't do any good. */
1092 t = check_typedef (t);
1094 /* Loop over each method name. At this level, all overloads of a name
1095 are counted as a single name. There is an inner loop which loops over
1098 for (method_counter = TYPE_NFN_FIELDS (t) - 1;
1099 method_counter >= 0;
1102 const char *method_name = TYPE_FN_FIELDLIST_NAME (t, method_counter);
1103 char dem_opname[64];
1105 if (startswith (method_name, "__") ||
1106 startswith (method_name, "op") ||
1107 startswith (method_name, "type"))
1109 if (cplus_demangle_opname (method_name, dem_opname, DMGL_ANSI))
1110 method_name = dem_opname;
1111 else if (cplus_demangle_opname (method_name, dem_opname, 0))
1112 method_name = dem_opname;
1115 if (strcmp_iw (method_name, name) == 0)
1119 for (field_counter = (TYPE_FN_FIELDLIST_LENGTH (t, method_counter)
1125 const char *phys_name;
1127 f = TYPE_FN_FIELDLIST1 (t, method_counter);
1128 if (TYPE_FN_FIELD_STUB (f, field_counter))
1130 phys_name = TYPE_FN_FIELD_PHYSNAME (f, field_counter);
1131 VEC_safe_push (const_char_ptr, *result_names, phys_name);
1137 for (ibase = 0; ibase < TYPE_N_BASECLASSES (t); ibase++)
1138 VEC_safe_push (typep, *superclasses, TYPE_BASECLASS (t, ibase));
1141 /* Find an instance of the character C in the string S that is outside
1142 of all parenthesis pairs, single-quoted strings, and double-quoted
1143 strings. Also, ignore the char within a template name, like a ','
1144 within foo<int, int>. */
1147 find_toplevel_char (const char *s, char c)
1149 int quoted = 0; /* zero if we're not in quotes;
1150 '"' if we're in a double-quoted string;
1151 '\'' if we're in a single-quoted string. */
1152 int depth = 0; /* Number of unclosed parens we've seen. */
1155 for (scan = s; *scan; scan++)
1159 if (*scan == quoted)
1161 else if (*scan == '\\' && *(scan + 1))
1164 else if (*scan == c && ! quoted && depth == 0)
1166 else if (*scan == '"' || *scan == '\'')
1168 else if (*scan == '(' || *scan == '<')
1170 else if ((*scan == ')' || *scan == '>') && depth > 0)
1177 /* The string equivalent of find_toplevel_char. Returns a pointer
1178 to the location of NEEDLE in HAYSTACK, ignoring any occurrences
1179 inside "()" and "<>". Returns NULL if NEEDLE was not found. */
1182 find_toplevel_string (const char *haystack, const char *needle)
1184 const char *s = haystack;
1188 s = find_toplevel_char (s, *needle);
1192 /* Found first char in HAYSTACK; check rest of string. */
1193 if (startswith (s, needle))
1196 /* Didn't find it; loop over HAYSTACK, looking for the next
1197 instance of the first character of NEEDLE. */
1201 while (s != NULL && *s != '\0');
1203 /* NEEDLE was not found in HAYSTACK. */
1207 /* Convert CANONICAL to its string representation using
1208 symtab_to_fullname for SYMTAB. The caller must xfree the result. */
1211 canonical_to_fullform (const struct linespec_canonical_name *canonical)
1213 if (canonical->symtab == NULL)
1214 return xstrdup (canonical->suffix);
1216 return xstrprintf ("%s:%s", symtab_to_fullname (canonical->symtab),
1220 /* Given FILTERS, a list of canonical names, filter the sals in RESULT
1221 and store the result in SELF->CANONICAL. */
1224 filter_results (struct linespec_state *self,
1225 struct symtabs_and_lines *result,
1226 VEC (const_char_ptr) *filters)
1231 for (i = 0; VEC_iterate (const_char_ptr, filters, i, name); ++i)
1233 struct linespec_sals lsal;
1236 memset (&lsal, 0, sizeof (lsal));
1238 for (j = 0; j < result->nelts; ++j)
1240 const struct linespec_canonical_name *canonical;
1242 struct cleanup *cleanup;
1244 canonical = &self->canonical_names[j];
1245 fullform = canonical_to_fullform (canonical);
1246 cleanup = make_cleanup (xfree, fullform);
1248 if (strcmp (name, fullform) == 0)
1249 add_sal_to_sals_basic (&lsal.sals, &result->sals[j]);
1251 do_cleanups (cleanup);
1254 if (lsal.sals.nelts > 0)
1256 lsal.canonical = xstrdup (name);
1257 VEC_safe_push (linespec_sals, self->canonical->sals, &lsal);
1261 self->canonical->pre_expanded = 0;
1264 /* Store RESULT into SELF->CANONICAL. */
1267 convert_results_to_lsals (struct linespec_state *self,
1268 struct symtabs_and_lines *result)
1270 struct linespec_sals lsal;
1272 lsal.canonical = NULL;
1273 lsal.sals = *result;
1274 VEC_safe_push (linespec_sals, self->canonical->sals, &lsal);
1277 /* A structure that contains two string representations of a struct
1278 linespec_canonical_name:
1279 - one where the the symtab's fullname is used;
1280 - one where the filename followed the "set filename-display"
1283 struct decode_line_2_item
1285 /* The form using symtab_to_fullname.
1286 It must be xfree'ed after use. */
1289 /* The form using symtab_to_filename_for_display.
1290 It must be xfree'ed after use. */
1293 /* Field is initialized to zero and it is set to one if the user
1294 requested breakpoint for this entry. */
1295 unsigned int selected : 1;
1298 /* Helper for qsort to sort decode_line_2_item entries by DISPLAYFORM and
1299 secondarily by FULLFORM. */
1302 decode_line_2_compare_items (const void *ap, const void *bp)
1304 const struct decode_line_2_item *a = (const struct decode_line_2_item *) ap;
1305 const struct decode_line_2_item *b = (const struct decode_line_2_item *) bp;
1308 retval = strcmp (a->displayform, b->displayform);
1312 return strcmp (a->fullform, b->fullform);
1315 /* Handle multiple results in RESULT depending on SELECT_MODE. This
1316 will either return normally, throw an exception on multiple
1317 results, or present a menu to the user. On return, the SALS vector
1318 in SELF->CANONICAL is set up properly. */
1321 decode_line_2 (struct linespec_state *self,
1322 struct symtabs_and_lines *result,
1323 const char *select_mode)
1325 char *args, *prompt;
1327 struct cleanup *old_chain;
1328 VEC (const_char_ptr) *filters = NULL;
1329 struct get_number_or_range_state state;
1330 struct decode_line_2_item *items;
1333 gdb_assert (select_mode != multiple_symbols_all);
1334 gdb_assert (self->canonical != NULL);
1335 gdb_assert (result->nelts >= 1);
1337 old_chain = make_cleanup (VEC_cleanup (const_char_ptr), &filters);
1339 /* Prepare ITEMS array. */
1340 items_count = result->nelts;
1341 items = XNEWVEC (struct decode_line_2_item, items_count);
1342 make_cleanup (xfree, items);
1343 for (i = 0; i < items_count; ++i)
1345 const struct linespec_canonical_name *canonical;
1346 struct decode_line_2_item *item;
1348 canonical = &self->canonical_names[i];
1349 gdb_assert (canonical->suffix != NULL);
1352 item->fullform = canonical_to_fullform (canonical);
1353 make_cleanup (xfree, item->fullform);
1355 if (canonical->symtab == NULL)
1356 item->displayform = canonical->suffix;
1359 const char *fn_for_display;
1361 fn_for_display = symtab_to_filename_for_display (canonical->symtab);
1362 item->displayform = xstrprintf ("%s:%s", fn_for_display,
1364 make_cleanup (xfree, item->displayform);
1370 /* Sort the list of method names. */
1371 qsort (items, items_count, sizeof (*items), decode_line_2_compare_items);
1373 /* Remove entries with the same FULLFORM. */
1374 if (items_count >= 2)
1376 struct decode_line_2_item *dst, *src;
1379 for (src = &items[1]; src < &items[items_count]; src++)
1380 if (strcmp (src->fullform, dst->fullform) != 0)
1382 items_count = dst + 1 - items;
1385 if (select_mode == multiple_symbols_cancel && items_count > 1)
1386 error (_("canceled because the command is ambiguous\n"
1387 "See set/show multiple-symbol."));
1389 if (select_mode == multiple_symbols_all || items_count == 1)
1391 do_cleanups (old_chain);
1392 convert_results_to_lsals (self, result);
1396 printf_unfiltered (_("[0] cancel\n[1] all\n"));
1397 for (i = 0; i < items_count; i++)
1398 printf_unfiltered ("[%d] %s\n", i + 2, items[i].displayform);
1400 prompt = getenv ("PS2");
1405 args = command_line_input (prompt, 0, "overload-choice");
1407 if (args == 0 || *args == 0)
1408 error_no_arg (_("one or more choice numbers"));
1410 init_number_or_range (&state, args);
1411 while (!state.finished)
1415 num = get_number_or_range (&state);
1418 error (_("canceled"));
1421 /* We intentionally make this result in a single breakpoint,
1422 contrary to what older versions of gdb did. The
1423 rationale is that this lets a user get the
1424 multiple_symbols_all behavior even with the 'ask'
1425 setting; and he can get separate breakpoints by entering
1426 "2-57" at the query. */
1427 do_cleanups (old_chain);
1428 convert_results_to_lsals (self, result);
1433 if (num >= items_count)
1434 printf_unfiltered (_("No choice number %d.\n"), num);
1437 struct decode_line_2_item *item = &items[num];
1439 if (!item->selected)
1441 VEC_safe_push (const_char_ptr, filters, item->fullform);
1446 printf_unfiltered (_("duplicate request for %d ignored.\n"),
1452 filter_results (self, result, filters);
1453 do_cleanups (old_chain);
1458 /* The parser of linespec itself. */
1460 /* Throw an appropriate error when SYMBOL is not found (optionally in
1463 static void ATTRIBUTE_NORETURN
1464 symbol_not_found_error (const char *symbol, const char *filename)
1469 if (!have_full_symbols ()
1470 && !have_partial_symbols ()
1471 && !have_minimal_symbols ())
1472 throw_error (NOT_FOUND_ERROR,
1473 _("No symbol table is loaded. Use the \"file\" command."));
1475 /* If SYMBOL starts with '$', the user attempted to either lookup
1476 a function/variable in his code starting with '$' or an internal
1477 variable of that name. Since we do not know which, be concise and
1478 explain both possibilities. */
1482 throw_error (NOT_FOUND_ERROR,
1483 _("Undefined convenience variable or function \"%s\" "
1484 "not defined in \"%s\"."), symbol, filename);
1486 throw_error (NOT_FOUND_ERROR,
1487 _("Undefined convenience variable or function \"%s\" "
1488 "not defined."), symbol);
1493 throw_error (NOT_FOUND_ERROR,
1494 _("Function \"%s\" not defined in \"%s\"."),
1497 throw_error (NOT_FOUND_ERROR,
1498 _("Function \"%s\" not defined."), symbol);
1502 /* Throw an appropriate error when an unexpected token is encountered
1505 static void ATTRIBUTE_NORETURN
1506 unexpected_linespec_error (linespec_parser *parser)
1508 linespec_token token;
1509 static const char * token_type_strings[]
1510 = {"keyword", "colon", "string", "number", "comma", "end of input"};
1512 /* Get the token that generated the error. */
1513 token = linespec_lexer_lex_one (parser);
1515 /* Finally, throw the error. */
1516 if (token.type == LSTOKEN_STRING || token.type == LSTOKEN_NUMBER
1517 || token.type == LSTOKEN_KEYWORD)
1520 struct cleanup *cleanup;
1522 string = copy_token_string (token);
1523 cleanup = make_cleanup (xfree, string);
1524 throw_error (GENERIC_ERROR,
1525 _("malformed linespec error: unexpected %s, \"%s\""),
1526 token_type_strings[token.type], string);
1529 throw_error (GENERIC_ERROR,
1530 _("malformed linespec error: unexpected %s"),
1531 token_type_strings[token.type]);
1534 /* Throw an undefined label error. */
1536 static void ATTRIBUTE_NORETURN
1537 undefined_label_error (const char *function, const char *label)
1539 if (function != NULL)
1540 throw_error (NOT_FOUND_ERROR,
1541 _("No label \"%s\" defined in function \"%s\"."),
1544 throw_error (NOT_FOUND_ERROR,
1545 _("No label \"%s\" defined in current function."),
1549 /* Throw a source file not found error. */
1551 static void ATTRIBUTE_NORETURN
1552 source_file_not_found_error (const char *name)
1554 throw_error (NOT_FOUND_ERROR, _("No source file named %s."), name);
1557 /* See description in linespec.h. */
1560 linespec_parse_line_offset (const char *string)
1562 const char *start = string;
1563 struct line_offset line_offset = {0, LINE_OFFSET_NONE};
1567 line_offset.sign = LINE_OFFSET_PLUS;
1570 else if (*string == '-')
1572 line_offset.sign = LINE_OFFSET_MINUS;
1576 if (*string != '\0' && !isdigit (*string))
1577 error (_("malformed line offset: \"%s\""), start);
1579 /* Right now, we only allow base 10 for offsets. */
1580 line_offset.offset = atoi (string);
1584 /* Parse the basic_spec in PARSER's input. */
1587 linespec_parse_basic (linespec_parser *parser)
1590 linespec_token token;
1591 VEC (symbolp) *symbols, *labels;
1592 VEC (bound_minimal_symbol_d) *minimal_symbols;
1593 struct cleanup *cleanup;
1595 /* Get the next token. */
1596 token = linespec_lexer_lex_one (parser);
1598 /* If it is EOI or KEYWORD, issue an error. */
1599 if (token.type == LSTOKEN_KEYWORD || token.type == LSTOKEN_EOI)
1600 unexpected_linespec_error (parser);
1601 /* If it is a LSTOKEN_NUMBER, we have an offset. */
1602 else if (token.type == LSTOKEN_NUMBER)
1604 /* Record the line offset and get the next token. */
1605 name = copy_token_string (token);
1606 cleanup = make_cleanup (xfree, name);
1607 PARSER_EXPLICIT (parser)->line_offset = linespec_parse_line_offset (name);
1608 do_cleanups (cleanup);
1610 /* Get the next token. */
1611 token = linespec_lexer_consume_token (parser);
1613 /* If the next token is a comma, stop parsing and return. */
1614 if (token.type == LSTOKEN_COMMA)
1617 /* If the next token is anything but EOI or KEYWORD, issue
1619 if (token.type != LSTOKEN_KEYWORD && token.type != LSTOKEN_EOI)
1620 unexpected_linespec_error (parser);
1623 if (token.type == LSTOKEN_KEYWORD || token.type == LSTOKEN_EOI)
1626 /* Next token must be LSTOKEN_STRING. */
1627 if (token.type != LSTOKEN_STRING)
1628 unexpected_linespec_error (parser);
1630 /* The current token will contain the name of a function, method,
1632 name = copy_token_string (token);
1633 cleanup = make_cleanup (xfree, name);
1635 /* Try looking it up as a function/method. */
1636 find_linespec_symbols (PARSER_STATE (parser),
1637 PARSER_RESULT (parser)->file_symtabs, name,
1638 &symbols, &minimal_symbols);
1640 if (symbols != NULL || minimal_symbols != NULL)
1642 PARSER_RESULT (parser)->function_symbols = symbols;
1643 PARSER_RESULT (parser)->minimal_symbols = minimal_symbols;
1644 PARSER_EXPLICIT (parser)->function_name = name;
1646 discard_cleanups (cleanup);
1650 /* NAME was not a function or a method. So it must be a label
1651 name or user specified variable like "break foo.c:$zippo". */
1652 labels = find_label_symbols (PARSER_STATE (parser), NULL,
1656 PARSER_RESULT (parser)->labels.label_symbols = labels;
1657 PARSER_RESULT (parser)->labels.function_symbols = symbols;
1658 PARSER_EXPLICIT (parser)->label_name = name;
1660 discard_cleanups (cleanup);
1662 else if (token.type == LSTOKEN_STRING
1663 && *LS_TOKEN_STOKEN (token).ptr == '$')
1665 /* User specified a convenience variable or history value. */
1666 PARSER_EXPLICIT (parser)->line_offset
1667 = linespec_parse_variable (PARSER_STATE (parser), name);
1669 if (PARSER_EXPLICIT (parser)->line_offset.sign == LINE_OFFSET_UNKNOWN)
1671 /* The user-specified variable was not valid. Do not
1672 throw an error here. parse_linespec will do it for us. */
1673 PARSER_EXPLICIT (parser)->function_name = name;
1674 discard_cleanups (cleanup);
1678 /* The convenience variable/history value parsed correctly.
1679 NAME is no longer needed. */
1680 do_cleanups (cleanup);
1684 /* The name is also not a label. Abort parsing. Do not throw
1685 an error here. parse_linespec will do it for us. */
1687 /* Save a copy of the name we were trying to lookup. */
1688 PARSER_EXPLICIT (parser)->function_name = name;
1689 discard_cleanups (cleanup);
1694 /* Get the next token. */
1695 token = linespec_lexer_consume_token (parser);
1697 if (token.type == LSTOKEN_COLON)
1699 /* User specified a label or a lineno. */
1700 token = linespec_lexer_consume_token (parser);
1702 if (token.type == LSTOKEN_NUMBER)
1704 /* User specified an offset. Record the line offset and
1705 get the next token. */
1706 name = copy_token_string (token);
1707 cleanup = make_cleanup (xfree, name);
1708 PARSER_EXPLICIT (parser)->line_offset
1709 = linespec_parse_line_offset (name);
1710 do_cleanups (cleanup);
1712 /* Ge the next token. */
1713 token = linespec_lexer_consume_token (parser);
1715 else if (token.type == LSTOKEN_STRING)
1717 /* Grab a copy of the label's name and look it up. */
1718 name = copy_token_string (token);
1719 cleanup = make_cleanup (xfree, name);
1720 labels = find_label_symbols (PARSER_STATE (parser),
1721 PARSER_RESULT (parser)->function_symbols,
1726 PARSER_RESULT (parser)->labels.label_symbols = labels;
1727 PARSER_RESULT (parser)->labels.function_symbols = symbols;
1728 PARSER_EXPLICIT (parser)->label_name = name;
1730 discard_cleanups (cleanup);
1734 /* We don't know what it was, but it isn't a label. */
1735 undefined_label_error (PARSER_EXPLICIT (parser)->function_name,
1739 /* Check for a line offset. */
1740 token = linespec_lexer_consume_token (parser);
1741 if (token.type == LSTOKEN_COLON)
1743 /* Get the next token. */
1744 token = linespec_lexer_consume_token (parser);
1746 /* It must be a line offset. */
1747 if (token.type != LSTOKEN_NUMBER)
1748 unexpected_linespec_error (parser);
1750 /* Record the lione offset and get the next token. */
1751 name = copy_token_string (token);
1752 cleanup = make_cleanup (xfree, name);
1754 PARSER_EXPLICIT (parser)->line_offset
1755 = linespec_parse_line_offset (name);
1756 do_cleanups (cleanup);
1758 /* Get the next token. */
1759 token = linespec_lexer_consume_token (parser);
1764 /* Trailing ':' in the input. Issue an error. */
1765 unexpected_linespec_error (parser);
1770 /* Canonicalize the linespec contained in LS. The result is saved into
1771 STATE->canonical. This function handles both linespec and explicit
1775 canonicalize_linespec (struct linespec_state *state, const linespec_p ls)
1777 struct event_location *canon;
1778 struct explicit_location *explicit_loc;
1780 /* If canonicalization was not requested, no need to do anything. */
1781 if (!state->canonical)
1784 /* Save everything as an explicit location. */
1785 canon = state->canonical->location
1786 = new_explicit_location (&ls->explicit_loc);
1787 explicit_loc = get_explicit_location (canon);
1789 if (explicit_loc->label_name != NULL)
1791 state->canonical->special_display = 1;
1793 if (explicit_loc->function_name == NULL)
1797 /* No function was specified, so add the symbol name. */
1798 gdb_assert (ls->labels.function_symbols != NULL
1799 && (VEC_length (symbolp, ls->labels.function_symbols)
1801 s = VEC_index (symbolp, ls->labels.function_symbols, 0);
1802 explicit_loc->function_name = xstrdup (SYMBOL_NATURAL_NAME (s));
1806 /* If this location originally came from a linespec, save a string
1807 representation of it for display and saving to file. */
1808 if (state->is_linespec)
1810 char *linespec = explicit_location_to_linespec (explicit_loc);
1812 set_event_location_string (canon, linespec);
1817 /* Given a line offset in LS, construct the relevant SALs. */
1819 static struct symtabs_and_lines
1820 create_sals_line_offset (struct linespec_state *self,
1823 struct symtabs_and_lines values;
1824 struct symtab_and_line val;
1825 int use_default = 0;
1831 /* This is where we need to make sure we have good defaults.
1832 We must guarantee that this section of code is never executed
1833 when we are called with just a function name, since
1834 set_default_source_symtab_and_line uses
1835 select_source_symtab that calls us with such an argument. */
1837 if (VEC_length (symtab_ptr, ls->file_symtabs) == 1
1838 && VEC_index (symtab_ptr, ls->file_symtabs, 0) == NULL)
1840 const char *fullname;
1842 set_current_program_space (self->program_space);
1844 /* Make sure we have at least a default source line. */
1845 set_default_source_symtab_and_line ();
1846 initialize_defaults (&self->default_symtab, &self->default_line);
1847 fullname = symtab_to_fullname (self->default_symtab);
1848 VEC_pop (symtab_ptr, ls->file_symtabs);
1849 VEC_free (symtab_ptr, ls->file_symtabs);
1850 ls->file_symtabs = collect_symtabs_from_filename (fullname,
1851 self->search_pspace);
1855 val.line = ls->explicit_loc.line_offset.offset;
1856 switch (ls->explicit_loc.line_offset.sign)
1858 case LINE_OFFSET_PLUS:
1859 if (ls->explicit_loc.line_offset.offset == 0)
1862 val.line = self->default_line + val.line;
1865 case LINE_OFFSET_MINUS:
1866 if (ls->explicit_loc.line_offset.offset == 0)
1869 val.line = self->default_line - val.line;
1871 val.line = -val.line;
1874 case LINE_OFFSET_NONE:
1875 break; /* No need to adjust val.line. */
1878 if (self->list_mode)
1879 decode_digits_list_mode (self, ls, &values, val);
1882 struct linetable_entry *best_entry = NULL;
1884 const struct block **blocks;
1885 struct cleanup *cleanup;
1886 struct symtabs_and_lines intermediate_results;
1889 intermediate_results.sals = NULL;
1890 intermediate_results.nelts = 0;
1892 decode_digits_ordinary (self, ls, val.line, &intermediate_results,
1894 if (intermediate_results.nelts == 0 && best_entry != NULL)
1895 decode_digits_ordinary (self, ls, best_entry->line,
1896 &intermediate_results, &best_entry);
1898 cleanup = make_cleanup (xfree, intermediate_results.sals);
1900 /* For optimized code, the compiler can scatter one source line
1901 across disjoint ranges of PC values, even when no duplicate
1902 functions or inline functions are involved. For example,
1903 'for (;;)' inside a non-template, non-inline, and non-ctor-or-dtor
1904 function can result in two PC ranges. In this case, we don't
1905 want to set a breakpoint on the first PC of each range. To filter
1906 such cases, we use containing blocks -- for each PC found
1907 above, we see if there are other PCs that are in the same
1908 block. If yes, the other PCs are filtered out. */
1910 filter = XNEWVEC (int, intermediate_results.nelts);
1911 make_cleanup (xfree, filter);
1912 blocks = XNEWVEC (const struct block *, intermediate_results.nelts);
1913 make_cleanup (xfree, blocks);
1915 for (i = 0; i < intermediate_results.nelts; ++i)
1917 set_current_program_space (intermediate_results.sals[i].pspace);
1920 blocks[i] = block_for_pc_sect (intermediate_results.sals[i].pc,
1921 intermediate_results.sals[i].section);
1924 for (i = 0; i < intermediate_results.nelts; ++i)
1926 if (blocks[i] != NULL)
1927 for (j = i + 1; j < intermediate_results.nelts; ++j)
1929 if (blocks[j] == blocks[i])
1937 for (i = 0; i < intermediate_results.nelts; ++i)
1940 struct symbol *sym = (blocks[i]
1941 ? block_containing_function (blocks[i])
1944 if (self->funfirstline)
1945 skip_prologue_sal (&intermediate_results.sals[i]);
1946 /* Make sure the line matches the request, not what was
1948 intermediate_results.sals[i].line = val.line;
1949 add_sal_to_sals (self, &values, &intermediate_results.sals[i],
1950 sym ? SYMBOL_NATURAL_NAME (sym) : NULL, 0);
1953 do_cleanups (cleanup);
1956 if (values.nelts == 0)
1958 if (ls->explicit_loc.source_filename)
1959 throw_error (NOT_FOUND_ERROR, _("No line %d in file \"%s\"."),
1960 val.line, ls->explicit_loc.source_filename);
1962 throw_error (NOT_FOUND_ERROR, _("No line %d in the current file."),
1969 /* Convert the given ADDRESS into SaLs. */
1971 static struct symtabs_and_lines
1972 convert_address_location_to_sals (struct linespec_state *self,
1975 struct symtab_and_line sal;
1976 struct symtabs_and_lines sals = {NULL, 0};
1978 sal = find_pc_line (address, 0);
1980 sal.section = find_pc_overlay (address);
1981 sal.explicit_pc = 1;
1982 add_sal_to_sals (self, &sals, &sal, core_addr_to_string (address), 1);
1987 /* Create and return SALs from the linespec LS. */
1989 static struct symtabs_and_lines
1990 convert_linespec_to_sals (struct linespec_state *state, linespec_p ls)
1992 struct symtabs_and_lines sals = {NULL, 0};
1994 if (ls->labels.label_symbols != NULL)
1996 /* We have just a bunch of functions/methods or labels. */
1998 struct symtab_and_line sal;
2001 for (i = 0; VEC_iterate (symbolp, ls->labels.label_symbols, i, sym); ++i)
2003 struct program_space *pspace = SYMTAB_PSPACE (symbol_symtab (sym));
2005 if (symbol_to_sal (&sal, state->funfirstline, sym)
2006 && maybe_add_address (state->addr_set, pspace, sal.pc))
2007 add_sal_to_sals (state, &sals, &sal,
2008 SYMBOL_NATURAL_NAME (sym), 0);
2011 else if (ls->function_symbols != NULL || ls->minimal_symbols != NULL)
2013 /* We have just a bunch of functions and/or methods. */
2015 struct symtab_and_line sal;
2017 bound_minimal_symbol_d *elem;
2018 struct program_space *pspace;
2020 if (ls->function_symbols != NULL)
2022 /* Sort symbols so that symbols with the same program space are next
2024 qsort (VEC_address (symbolp, ls->function_symbols),
2025 VEC_length (symbolp, ls->function_symbols),
2026 sizeof (symbolp), compare_symbols);
2028 for (i = 0; VEC_iterate (symbolp, ls->function_symbols, i, sym); ++i)
2030 pspace = SYMTAB_PSPACE (symbol_symtab (sym));
2031 set_current_program_space (pspace);
2032 if (symbol_to_sal (&sal, state->funfirstline, sym)
2033 && maybe_add_address (state->addr_set, pspace, sal.pc))
2034 add_sal_to_sals (state, &sals, &sal,
2035 SYMBOL_NATURAL_NAME (sym), 0);
2039 if (ls->minimal_symbols != NULL)
2041 /* Sort minimal symbols by program space, too. */
2042 qsort (VEC_address (bound_minimal_symbol_d, ls->minimal_symbols),
2043 VEC_length (bound_minimal_symbol_d, ls->minimal_symbols),
2044 sizeof (bound_minimal_symbol_d), compare_msymbols);
2047 VEC_iterate (bound_minimal_symbol_d, ls->minimal_symbols,
2051 pspace = elem->objfile->pspace;
2052 set_current_program_space (pspace);
2053 minsym_found (state, elem->objfile, elem->minsym, &sals);
2057 else if (ls->explicit_loc.line_offset.sign != LINE_OFFSET_UNKNOWN)
2059 /* Only an offset was specified. */
2060 sals = create_sals_line_offset (state, ls);
2062 /* Make sure we have a filename for canonicalization. */
2063 if (ls->explicit_loc.source_filename == NULL)
2065 const char *fullname = symtab_to_fullname (state->default_symtab);
2067 /* It may be more appropriate to keep DEFAULT_SYMTAB in its symtab
2068 form so that displaying SOURCE_FILENAME can follow the current
2069 FILENAME_DISPLAY_STRING setting. But as it is used only rarely
2070 it has been kept for code simplicity only in absolute form. */
2071 ls->explicit_loc.source_filename = xstrdup (fullname);
2076 /* We haven't found any results... */
2080 canonicalize_linespec (state, ls);
2082 if (sals.nelts > 0 && state->canonical != NULL)
2083 state->canonical->pre_expanded = 1;
2088 /* Convert the explicit location EXPLICIT_LOC into SaLs. */
2090 static struct symtabs_and_lines
2091 convert_explicit_location_to_sals (struct linespec_state *self,
2093 const struct explicit_location *explicit_loc)
2095 VEC (symbolp) *symbols, *labels;
2096 VEC (bound_minimal_symbol_d) *minimal_symbols;
2098 if (explicit_loc->source_filename != NULL)
2102 result->file_symtabs
2103 = symtabs_from_filename (explicit_loc->source_filename,
2104 self->search_pspace);
2106 CATCH (except, RETURN_MASK_ERROR)
2108 source_file_not_found_error (explicit_loc->source_filename);
2111 result->explicit_loc.source_filename
2112 = xstrdup (explicit_loc->source_filename);
2116 /* A NULL entry means to use the default symtab. */
2117 VEC_safe_push (symtab_ptr, result->file_symtabs, NULL);
2120 if (explicit_loc->function_name != NULL)
2122 find_linespec_symbols (self, result->file_symtabs,
2123 explicit_loc->function_name, &symbols,
2126 if (symbols == NULL && minimal_symbols == NULL)
2127 symbol_not_found_error (explicit_loc->function_name,
2128 result->explicit_loc.source_filename);
2130 result->explicit_loc.function_name
2131 = xstrdup (explicit_loc->function_name);
2132 result->function_symbols = symbols;
2133 result->minimal_symbols = minimal_symbols;
2136 if (explicit_loc->label_name != NULL)
2139 labels = find_label_symbols (self, result->function_symbols,
2140 &symbols, explicit_loc->label_name);
2143 undefined_label_error (result->explicit_loc.function_name,
2144 explicit_loc->label_name);
2146 result->explicit_loc.label_name = xstrdup (explicit_loc->label_name);
2147 result->labels.label_symbols = labels;
2148 result->labels.function_symbols = symbols;
2151 if (explicit_loc->line_offset.sign != LINE_OFFSET_UNKNOWN)
2152 result->explicit_loc.line_offset = explicit_loc->line_offset;
2154 return convert_linespec_to_sals (self, result);
2157 /* Parse a string that specifies a linespec.
2159 The basic grammar of linespecs:
2161 linespec -> var_spec | basic_spec
2162 var_spec -> '$' (STRING | NUMBER)
2164 basic_spec -> file_offset_spec | function_spec | label_spec
2165 file_offset_spec -> opt_file_spec offset_spec
2166 function_spec -> opt_file_spec function_name_spec opt_label_spec
2167 label_spec -> label_name_spec
2169 opt_file_spec -> "" | file_name_spec ':'
2170 opt_label_spec -> "" | ':' label_name_spec
2172 file_name_spec -> STRING
2173 function_name_spec -> STRING
2174 label_name_spec -> STRING
2175 function_name_spec -> STRING
2176 offset_spec -> NUMBER
2180 This may all be followed by several keywords such as "if EXPR",
2183 A comma will terminate parsing.
2185 The function may be an undebuggable function found in minimal symbol table.
2187 If the argument FUNFIRSTLINE is nonzero, we want the first line
2188 of real code inside a function when a function is specified, and it is
2189 not OK to specify a variable or type to get its line number.
2191 DEFAULT_SYMTAB specifies the file to use if none is specified.
2192 It defaults to current_source_symtab.
2193 DEFAULT_LINE specifies the line number to use for relative
2194 line numbers (that start with signs). Defaults to current_source_line.
2195 If CANONICAL is non-NULL, store an array of strings containing the canonical
2196 line specs there if necessary. Currently overloaded member functions and
2197 line numbers or static functions without a filename yield a canonical
2198 line spec. The array and the line spec strings are allocated on the heap,
2199 it is the callers responsibility to free them.
2201 Note that it is possible to return zero for the symtab
2202 if no file is validly specified. Callers must check that.
2203 Also, the line number returned may be invalid. */
2205 /* Parse the linespec in ARG. */
2207 static struct symtabs_and_lines
2208 parse_linespec (linespec_parser *parser, const char *arg)
2210 linespec_token token;
2211 struct symtabs_and_lines values;
2212 struct gdb_exception file_exception = exception_none;
2213 struct cleanup *cleanup;
2215 /* A special case to start. It has become quite popular for
2216 IDEs to work around bugs in the previous parser by quoting
2217 the entire linespec, so we attempt to deal with this nicely. */
2218 parser->is_quote_enclosed = 0;
2219 if (!is_ada_operator (arg)
2220 && strchr (linespec_quote_characters, *arg) != NULL)
2224 end = skip_quote_char (arg + 1, *arg);
2225 if (end != NULL && is_closing_quote_enclosed (end))
2227 /* Here's the special case. Skip ARG past the initial
2230 parser->is_quote_enclosed = 1;
2234 parser->lexer.saved_arg = arg;
2235 parser->lexer.stream = arg;
2237 /* Initialize the default symtab and line offset. */
2238 initialize_defaults (&PARSER_STATE (parser)->default_symtab,
2239 &PARSER_STATE (parser)->default_line);
2241 /* Objective-C shortcut. */
2242 values = decode_objc (PARSER_STATE (parser), PARSER_RESULT (parser), arg);
2243 if (values.sals != NULL)
2246 /* Start parsing. */
2248 /* Get the first token. */
2249 token = linespec_lexer_lex_one (parser);
2251 /* It must be either LSTOKEN_STRING or LSTOKEN_NUMBER. */
2252 if (token.type == LSTOKEN_STRING && *LS_TOKEN_STOKEN (token).ptr == '$')
2256 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2257 VEC_safe_push (symtab_ptr, PARSER_RESULT (parser)->file_symtabs, NULL);
2259 /* User specified a convenience variable or history value. */
2260 var = copy_token_string (token);
2261 cleanup = make_cleanup (xfree, var);
2262 PARSER_EXPLICIT (parser)->line_offset
2263 = linespec_parse_variable (PARSER_STATE (parser), var);
2264 do_cleanups (cleanup);
2266 /* If a line_offset wasn't found (VAR is the name of a user
2267 variable/function), then skip to normal symbol processing. */
2268 if (PARSER_EXPLICIT (parser)->line_offset.sign != LINE_OFFSET_UNKNOWN)
2270 /* Consume this token. */
2271 linespec_lexer_consume_token (parser);
2273 goto convert_to_sals;
2276 else if (token.type != LSTOKEN_STRING && token.type != LSTOKEN_NUMBER)
2277 unexpected_linespec_error (parser);
2279 /* Shortcut: If the next token is not LSTOKEN_COLON, we know that
2280 this token cannot represent a filename. */
2281 token = linespec_lexer_peek_token (parser);
2283 if (token.type == LSTOKEN_COLON)
2285 char *user_filename;
2287 /* Get the current token again and extract the filename. */
2288 token = linespec_lexer_lex_one (parser);
2289 user_filename = copy_token_string (token);
2291 /* Check if the input is a filename. */
2294 PARSER_RESULT (parser)->file_symtabs
2295 = symtabs_from_filename (user_filename,
2296 PARSER_STATE (parser)->search_pspace);
2298 CATCH (ex, RETURN_MASK_ERROR)
2300 file_exception = ex;
2304 if (file_exception.reason >= 0)
2306 /* Symtabs were found for the file. Record the filename. */
2307 PARSER_EXPLICIT (parser)->source_filename = user_filename;
2309 /* Get the next token. */
2310 token = linespec_lexer_consume_token (parser);
2312 /* This is LSTOKEN_COLON; consume it. */
2313 linespec_lexer_consume_token (parser);
2317 /* No symtabs found -- discard user_filename. */
2318 xfree (user_filename);
2320 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2321 VEC_safe_push (symtab_ptr, PARSER_RESULT (parser)->file_symtabs, NULL);
2324 /* If the next token is not EOI, KEYWORD, or COMMA, issue an error. */
2325 else if (token.type != LSTOKEN_EOI && token.type != LSTOKEN_KEYWORD
2326 && token.type != LSTOKEN_COMMA)
2328 /* TOKEN is the _next_ token, not the one currently in the parser.
2329 Consuming the token will give the correct error message. */
2330 linespec_lexer_consume_token (parser);
2331 unexpected_linespec_error (parser);
2335 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2336 VEC_safe_push (symtab_ptr, PARSER_RESULT (parser)->file_symtabs, NULL);
2339 /* Parse the rest of the linespec. */
2340 linespec_parse_basic (parser);
2342 if (PARSER_RESULT (parser)->function_symbols == NULL
2343 && PARSER_RESULT (parser)->labels.label_symbols == NULL
2344 && PARSER_EXPLICIT (parser)->line_offset.sign == LINE_OFFSET_UNKNOWN
2345 && PARSER_RESULT (parser)->minimal_symbols == NULL)
2347 /* The linespec didn't parse. Re-throw the file exception if
2349 if (file_exception.reason < 0)
2350 throw_exception (file_exception);
2352 /* Otherwise, the symbol is not found. */
2353 symbol_not_found_error (PARSER_EXPLICIT (parser)->function_name,
2354 PARSER_EXPLICIT (parser)->source_filename);
2359 /* Get the last token and record how much of the input was parsed,
2361 token = linespec_lexer_lex_one (parser);
2362 if (token.type != LSTOKEN_EOI && token.type != LSTOKEN_KEYWORD)
2363 PARSER_STREAM (parser) = LS_TOKEN_STOKEN (token).ptr;
2365 /* Convert the data in PARSER_RESULT to SALs. */
2366 values = convert_linespec_to_sals (PARSER_STATE (parser),
2367 PARSER_RESULT (parser));
2373 /* A constructor for linespec_state. */
2376 linespec_state_constructor (struct linespec_state *self,
2377 int flags, const struct language_defn *language,
2378 struct program_space *search_pspace,
2379 struct symtab *default_symtab,
2381 struct linespec_result *canonical)
2383 memset (self, 0, sizeof (*self));
2384 self->language = language;
2385 self->funfirstline = (flags & DECODE_LINE_FUNFIRSTLINE) ? 1 : 0;
2386 self->list_mode = (flags & DECODE_LINE_LIST_MODE) ? 1 : 0;
2387 self->search_pspace = search_pspace;
2388 self->default_symtab = default_symtab;
2389 self->default_line = default_line;
2390 self->canonical = canonical;
2391 self->program_space = current_program_space;
2392 self->addr_set = htab_create_alloc (10, hash_address_entry, eq_address_entry,
2393 xfree, xcalloc, xfree);
2394 self->is_linespec = 0;
2397 /* Initialize a new linespec parser. */
2400 linespec_parser_new (linespec_parser *parser,
2401 int flags, const struct language_defn *language,
2402 struct program_space *search_pspace,
2403 struct symtab *default_symtab,
2405 struct linespec_result *canonical)
2407 memset (parser, 0, sizeof (linespec_parser));
2408 parser->lexer.current.type = LSTOKEN_CONSUMED;
2409 memset (PARSER_RESULT (parser), 0, sizeof (struct linespec));
2410 PARSER_EXPLICIT (parser)->line_offset.sign = LINE_OFFSET_UNKNOWN;
2411 linespec_state_constructor (PARSER_STATE (parser), flags, language,
2413 default_symtab, default_line, canonical);
2416 /* A destructor for linespec_state. */
2419 linespec_state_destructor (struct linespec_state *self)
2421 htab_delete (self->addr_set);
2424 /* Delete a linespec parser. */
2427 linespec_parser_delete (void *arg)
2429 linespec_parser *parser = (linespec_parser *) arg;
2431 xfree (PARSER_EXPLICIT (parser)->source_filename);
2432 xfree (PARSER_EXPLICIT (parser)->label_name);
2433 xfree (PARSER_EXPLICIT (parser)->function_name);
2435 if (PARSER_RESULT (parser)->file_symtabs != NULL)
2436 VEC_free (symtab_ptr, PARSER_RESULT (parser)->file_symtabs);
2438 if (PARSER_RESULT (parser)->function_symbols != NULL)
2439 VEC_free (symbolp, PARSER_RESULT (parser)->function_symbols);
2441 if (PARSER_RESULT (parser)->minimal_symbols != NULL)
2442 VEC_free (bound_minimal_symbol_d, PARSER_RESULT (parser)->minimal_symbols);
2444 if (PARSER_RESULT (parser)->labels.label_symbols != NULL)
2445 VEC_free (symbolp, PARSER_RESULT (parser)->labels.label_symbols);
2447 if (PARSER_RESULT (parser)->labels.function_symbols != NULL)
2448 VEC_free (symbolp, PARSER_RESULT (parser)->labels.function_symbols);
2450 linespec_state_destructor (PARSER_STATE (parser));
2453 /* See description in linespec.h. */
2456 linespec_lex_to_end (char **stringp)
2458 linespec_parser parser;
2459 struct cleanup *cleanup;
2460 linespec_token token;
2463 if (stringp == NULL || *stringp == NULL)
2466 linespec_parser_new (&parser, 0, current_language, NULL, NULL, 0, NULL);
2467 cleanup = make_cleanup (linespec_parser_delete, &parser);
2468 parser.lexer.saved_arg = *stringp;
2469 PARSER_STREAM (&parser) = orig = *stringp;
2473 /* Stop before any comma tokens; we need it to keep it
2474 as the next token in the string. */
2475 token = linespec_lexer_peek_token (&parser);
2476 if (token.type == LSTOKEN_COMMA)
2478 token = linespec_lexer_consume_token (&parser);
2480 while (token.type != LSTOKEN_EOI && token.type != LSTOKEN_KEYWORD);
2482 *stringp += PARSER_STREAM (&parser) - orig;
2483 do_cleanups (cleanup);
2486 /* A helper function for decode_line_full and decode_line_1 to
2487 turn LOCATION into symtabs_and_lines. */
2489 static struct symtabs_and_lines
2490 event_location_to_sals (linespec_parser *parser,
2491 const struct event_location *location)
2493 struct symtabs_and_lines result = {NULL, 0};
2495 switch (event_location_type (location))
2497 case LINESPEC_LOCATION:
2499 PARSER_STATE (parser)->is_linespec = 1;
2502 result = parse_linespec (parser, get_linespec_location (location));
2504 CATCH (except, RETURN_MASK_ERROR)
2506 throw_exception (except);
2512 case ADDRESS_LOCATION:
2514 const char *addr_string = get_address_string_location (location);
2515 CORE_ADDR addr = get_address_location (location);
2517 if (addr_string != NULL)
2519 char *expr = xstrdup (addr_string);
2520 const char *const_expr = expr;
2521 struct cleanup *cleanup = make_cleanup (xfree, expr);
2523 addr = linespec_expression_to_pc (&const_expr);
2524 if (PARSER_STATE (parser)->canonical != NULL)
2525 PARSER_STATE (parser)->canonical->location
2526 = copy_event_location (location);
2528 do_cleanups (cleanup);
2531 result = convert_address_location_to_sals (PARSER_STATE (parser),
2536 case EXPLICIT_LOCATION:
2538 const struct explicit_location *explicit_loc;
2540 explicit_loc = get_explicit_location_const (location);
2541 result = convert_explicit_location_to_sals (PARSER_STATE (parser),
2542 PARSER_RESULT (parser),
2547 case PROBE_LOCATION:
2548 /* Probes are handled by their own decoders. */
2549 gdb_assert_not_reached ("attempt to decode probe location");
2553 gdb_assert_not_reached ("unhandled event location type");
2559 /* See linespec.h. */
2562 decode_line_full (const struct event_location *location, int flags,
2563 struct program_space *search_pspace,
2564 struct symtab *default_symtab,
2565 int default_line, struct linespec_result *canonical,
2566 const char *select_mode,
2569 struct symtabs_and_lines result;
2570 struct cleanup *cleanups;
2571 VEC (const_char_ptr) *filters = NULL;
2572 linespec_parser parser;
2573 struct linespec_state *state;
2575 gdb_assert (canonical != NULL);
2576 /* The filter only makes sense for 'all'. */
2577 gdb_assert (filter == NULL || select_mode == multiple_symbols_all);
2578 gdb_assert (select_mode == NULL
2579 || select_mode == multiple_symbols_all
2580 || select_mode == multiple_symbols_ask
2581 || select_mode == multiple_symbols_cancel);
2582 gdb_assert ((flags & DECODE_LINE_LIST_MODE) == 0);
2584 linespec_parser_new (&parser, flags, current_language,
2585 search_pspace, default_symtab,
2586 default_line, canonical);
2587 cleanups = make_cleanup (linespec_parser_delete, &parser);
2588 save_current_program_space ();
2590 result = event_location_to_sals (&parser, location);
2591 state = PARSER_STATE (&parser);
2593 gdb_assert (result.nelts == 1 || canonical->pre_expanded);
2594 canonical->pre_expanded = 1;
2596 /* Arrange for allocated canonical names to be freed. */
2597 if (result.nelts > 0)
2601 make_cleanup (xfree, state->canonical_names);
2602 for (i = 0; i < result.nelts; ++i)
2604 gdb_assert (state->canonical_names[i].suffix != NULL);
2605 make_cleanup (xfree, state->canonical_names[i].suffix);
2609 if (select_mode == NULL)
2611 if (ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ())))
2612 select_mode = multiple_symbols_all;
2614 select_mode = multiple_symbols_select_mode ();
2617 if (select_mode == multiple_symbols_all)
2621 make_cleanup (VEC_cleanup (const_char_ptr), &filters);
2622 VEC_safe_push (const_char_ptr, filters, filter);
2623 filter_results (state, &result, filters);
2626 convert_results_to_lsals (state, &result);
2629 decode_line_2 (state, &result, select_mode);
2631 do_cleanups (cleanups);
2634 /* See linespec.h. */
2636 struct symtabs_and_lines
2637 decode_line_1 (const struct event_location *location, int flags,
2638 struct program_space *search_pspace,
2639 struct symtab *default_symtab,
2642 struct symtabs_and_lines result;
2643 linespec_parser parser;
2644 struct cleanup *cleanups;
2646 linespec_parser_new (&parser, flags, current_language,
2647 search_pspace, default_symtab,
2648 default_line, NULL);
2649 cleanups = make_cleanup (linespec_parser_delete, &parser);
2650 save_current_program_space ();
2652 result = event_location_to_sals (&parser, location);
2654 do_cleanups (cleanups);
2658 /* See linespec.h. */
2660 struct symtabs_and_lines
2661 decode_line_with_current_source (char *string, int flags)
2663 struct symtabs_and_lines sals;
2664 struct symtab_and_line cursal;
2665 struct event_location *location;
2666 struct cleanup *cleanup;
2669 error (_("Empty line specification."));
2671 /* We use whatever is set as the current source line. We do not try
2672 and get a default source symtab+line or it will recursively call us! */
2673 cursal = get_current_source_symtab_and_line ();
2675 location = string_to_event_location (&string, current_language);
2676 cleanup = make_cleanup_delete_event_location (location);
2677 sals = decode_line_1 (location, flags, NULL,
2678 cursal.symtab, cursal.line);
2681 error (_("Junk at end of line specification: %s"), string);
2683 do_cleanups (cleanup);
2687 /* See linespec.h. */
2689 struct symtabs_and_lines
2690 decode_line_with_last_displayed (char *string, int flags)
2692 struct symtabs_and_lines sals;
2693 struct event_location *location;
2694 struct cleanup *cleanup;
2697 error (_("Empty line specification."));
2699 location = string_to_event_location (&string, current_language);
2700 cleanup = make_cleanup_delete_event_location (location);
2701 if (last_displayed_sal_is_valid ())
2702 sals = decode_line_1 (location, flags, NULL,
2703 get_last_displayed_symtab (),
2704 get_last_displayed_line ());
2706 sals = decode_line_1 (location, flags, NULL, (struct symtab *) NULL, 0);
2709 error (_("Junk at end of line specification: %s"), string);
2711 do_cleanups (cleanup);
2717 /* First, some functions to initialize stuff at the beggining of the
2721 initialize_defaults (struct symtab **default_symtab, int *default_line)
2723 if (*default_symtab == 0)
2725 /* Use whatever we have for the default source line. We don't use
2726 get_current_or_default_symtab_and_line as it can recurse and call
2728 struct symtab_and_line cursal =
2729 get_current_source_symtab_and_line ();
2731 *default_symtab = cursal.symtab;
2732 *default_line = cursal.line;
2738 /* Evaluate the expression pointed to by EXP_PTR into a CORE_ADDR,
2739 advancing EXP_PTR past any parsed text. */
2742 linespec_expression_to_pc (const char **exp_ptr)
2744 if (current_program_space->executing_startup)
2745 /* The error message doesn't really matter, because this case
2746 should only hit during breakpoint reset. */
2747 throw_error (NOT_FOUND_ERROR, _("cannot evaluate expressions while "
2748 "program space is in startup"));
2751 return value_as_address (parse_to_comma_and_eval (exp_ptr));
2756 /* Here's where we recognise an Objective-C Selector. An Objective C
2757 selector may be implemented by more than one class, therefore it
2758 may represent more than one method/function. This gives us a
2759 situation somewhat analogous to C++ overloading. If there's more
2760 than one method that could represent the selector, then use some of
2761 the existing C++ code to let the user choose one. */
2763 static struct symtabs_and_lines
2764 decode_objc (struct linespec_state *self, linespec_p ls, const char *arg)
2766 struct collect_info info;
2767 VEC (const_char_ptr) *symbol_names = NULL;
2768 struct symtabs_and_lines values;
2769 const char *new_argptr;
2770 struct cleanup *cleanup = make_cleanup (VEC_cleanup (const_char_ptr),
2774 info.file_symtabs = NULL;
2775 VEC_safe_push (symtab_ptr, info.file_symtabs, NULL);
2776 make_cleanup (VEC_cleanup (symtab_ptr), &info.file_symtabs);
2777 info.result.symbols = NULL;
2778 info.result.minimal_symbols = NULL;
2782 new_argptr = find_imps (arg, &symbol_names);
2783 if (VEC_empty (const_char_ptr, symbol_names))
2785 do_cleanups (cleanup);
2789 add_all_symbol_names_from_pspace (&info, NULL, symbol_names);
2791 if (!VEC_empty (symbolp, info.result.symbols)
2792 || !VEC_empty (bound_minimal_symbol_d, info.result.minimal_symbols))
2796 saved_arg = (char *) alloca (new_argptr - arg + 1);
2797 memcpy (saved_arg, arg, new_argptr - arg);
2798 saved_arg[new_argptr - arg] = '\0';
2800 ls->explicit_loc.function_name = xstrdup (saved_arg);
2801 ls->function_symbols = info.result.symbols;
2802 ls->minimal_symbols = info.result.minimal_symbols;
2803 values = convert_linespec_to_sals (self, ls);
2805 if (self->canonical)
2809 self->canonical->pre_expanded = 1;
2811 if (ls->explicit_loc.source_filename)
2813 str = xstrprintf ("%s:%s",
2814 ls->explicit_loc.source_filename, saved_arg);
2817 str = xstrdup (saved_arg);
2819 make_cleanup (xfree, str);
2820 self->canonical->location = new_linespec_location (&str);
2824 do_cleanups (cleanup);
2829 /* An instance of this type is used when collecting prefix symbols for
2832 struct decode_compound_collector
2834 /* The result vector. */
2835 VEC (symbolp) *symbols;
2837 /* A hash table of all symbols we found. We use this to avoid
2838 adding any symbol more than once. */
2842 /* A callback for iterate_over_symbols that is used by
2843 lookup_prefix_sym to collect type symbols. */
2846 collect_one_symbol (struct symbol *sym, void *d)
2848 struct decode_compound_collector *collector
2849 = (struct decode_compound_collector *) d;
2853 if (SYMBOL_CLASS (sym) != LOC_TYPEDEF)
2854 return 1; /* Continue iterating. */
2856 t = SYMBOL_TYPE (sym);
2857 t = check_typedef (t);
2858 if (TYPE_CODE (t) != TYPE_CODE_STRUCT
2859 && TYPE_CODE (t) != TYPE_CODE_UNION
2860 && TYPE_CODE (t) != TYPE_CODE_NAMESPACE)
2861 return 1; /* Continue iterating. */
2863 slot = htab_find_slot (collector->unique_syms, sym, INSERT);
2867 VEC_safe_push (symbolp, collector->symbols, sym);
2870 return 1; /* Continue iterating. */
2873 /* Return any symbols corresponding to CLASS_NAME in FILE_SYMTABS. */
2875 static VEC (symbolp) *
2876 lookup_prefix_sym (struct linespec_state *state, VEC (symtab_ptr) *file_symtabs,
2877 const char *class_name)
2881 struct decode_compound_collector collector;
2882 struct cleanup *outer;
2883 struct cleanup *cleanup;
2885 collector.symbols = NULL;
2886 outer = make_cleanup (VEC_cleanup (symbolp), &collector.symbols);
2888 collector.unique_syms = htab_create_alloc (1, htab_hash_pointer,
2889 htab_eq_pointer, NULL,
2891 cleanup = make_cleanup_htab_delete (collector.unique_syms);
2893 for (ix = 0; VEC_iterate (symtab_ptr, file_symtabs, ix, elt); ++ix)
2897 iterate_over_all_matching_symtabs (state, class_name, STRUCT_DOMAIN,
2898 collect_one_symbol, &collector,
2900 iterate_over_all_matching_symtabs (state, class_name, VAR_DOMAIN,
2901 collect_one_symbol, &collector,
2906 /* Program spaces that are executing startup should have
2907 been filtered out earlier. */
2908 gdb_assert (!SYMTAB_PSPACE (elt)->executing_startup);
2909 set_current_program_space (SYMTAB_PSPACE (elt));
2910 iterate_over_file_blocks (elt, class_name, STRUCT_DOMAIN,
2911 collect_one_symbol, &collector);
2912 iterate_over_file_blocks (elt, class_name, VAR_DOMAIN,
2913 collect_one_symbol, &collector);
2917 do_cleanups (cleanup);
2918 discard_cleanups (outer);
2919 return collector.symbols;
2922 /* A qsort comparison function for symbols. The resulting order does
2923 not actually matter; we just need to be able to sort them so that
2924 symbols with the same program space end up next to each other. */
2927 compare_symbols (const void *a, const void *b)
2929 struct symbol * const *sa = (struct symbol * const*) a;
2930 struct symbol * const *sb = (struct symbol * const*) b;
2933 uia = (uintptr_t) SYMTAB_PSPACE (symbol_symtab (*sa));
2934 uib = (uintptr_t) SYMTAB_PSPACE (symbol_symtab (*sb));
2941 uia = (uintptr_t) *sa;
2942 uib = (uintptr_t) *sb;
2952 /* Like compare_symbols but for minimal symbols. */
2955 compare_msymbols (const void *a, const void *b)
2957 const struct bound_minimal_symbol *sa
2958 = (const struct bound_minimal_symbol *) a;
2959 const struct bound_minimal_symbol *sb
2960 = (const struct bound_minimal_symbol *) b;
2963 uia = (uintptr_t) sa->objfile->pspace;
2964 uib = (uintptr_t) sa->objfile->pspace;
2971 uia = (uintptr_t) sa->minsym;
2972 uib = (uintptr_t) sb->minsym;
2982 /* Look for all the matching instances of each symbol in NAMES. Only
2983 instances from PSPACE are considered; other program spaces are
2984 handled by our caller. If PSPACE is NULL, then all program spaces
2985 are considered. Results are stored into INFO. */
2988 add_all_symbol_names_from_pspace (struct collect_info *info,
2989 struct program_space *pspace,
2990 VEC (const_char_ptr) *names)
2995 for (ix = 0; VEC_iterate (const_char_ptr, names, ix, iter); ++ix)
2996 add_matching_symbols_to_info (iter, info, pspace);
3000 find_superclass_methods (VEC (typep) *superclasses,
3002 VEC (const_char_ptr) **result_names)
3004 int old_len = VEC_length (const_char_ptr, *result_names);
3005 VEC (typep) *iter_classes;
3006 struct cleanup *cleanup = make_cleanup (null_cleanup, NULL);
3008 iter_classes = superclasses;
3011 VEC (typep) *new_supers = NULL;
3015 make_cleanup (VEC_cleanup (typep), &new_supers);
3016 for (ix = 0; VEC_iterate (typep, iter_classes, ix, t); ++ix)
3017 find_methods (t, name, result_names, &new_supers);
3019 if (VEC_length (const_char_ptr, *result_names) != old_len
3020 || VEC_empty (typep, new_supers))
3023 iter_classes = new_supers;
3026 do_cleanups (cleanup);
3029 /* This finds the method METHOD_NAME in the class CLASS_NAME whose type is
3030 given by one of the symbols in SYM_CLASSES. Matches are returned
3031 in SYMBOLS (for debug symbols) and MINSYMS (for minimal symbols). */
3034 find_method (struct linespec_state *self, VEC (symtab_ptr) *file_symtabs,
3035 const char *class_name, const char *method_name,
3036 VEC (symbolp) *sym_classes, VEC (symbolp) **symbols,
3037 VEC (bound_minimal_symbol_d) **minsyms)
3040 struct cleanup *cleanup = make_cleanup (null_cleanup, NULL);
3042 int last_result_len;
3043 VEC (typep) *superclass_vec;
3044 VEC (const_char_ptr) *result_names;
3045 struct collect_info info;
3047 /* Sort symbols so that symbols with the same program space are next
3049 qsort (VEC_address (symbolp, sym_classes),
3050 VEC_length (symbolp, sym_classes),
3055 info.file_symtabs = file_symtabs;
3056 info.result.symbols = NULL;
3057 info.result.minimal_symbols = NULL;
3059 /* Iterate over all the types, looking for the names of existing
3060 methods matching METHOD_NAME. If we cannot find a direct method in a
3061 given program space, then we consider inherited methods; this is
3062 not ideal (ideal would be to respect C++ hiding rules), but it
3063 seems good enough and is what GDB has historically done. We only
3064 need to collect the names because later we find all symbols with
3065 those names. This loop is written in a somewhat funny way
3066 because we collect data across the program space before deciding
3068 superclass_vec = NULL;
3069 make_cleanup (VEC_cleanup (typep), &superclass_vec);
3070 result_names = NULL;
3071 make_cleanup (VEC_cleanup (const_char_ptr), &result_names);
3072 last_result_len = 0;
3073 for (ix = 0; VEC_iterate (symbolp, sym_classes, ix, sym); ++ix)
3076 struct program_space *pspace;
3078 /* Program spaces that are executing startup should have
3079 been filtered out earlier. */
3080 pspace = SYMTAB_PSPACE (symbol_symtab (sym));
3081 gdb_assert (!pspace->executing_startup);
3082 set_current_program_space (pspace);
3083 t = check_typedef (SYMBOL_TYPE (sym));
3084 find_methods (t, method_name, &result_names, &superclass_vec);
3086 /* Handle all items from a single program space at once; and be
3087 sure not to miss the last batch. */
3088 if (ix == VEC_length (symbolp, sym_classes) - 1
3090 != SYMTAB_PSPACE (symbol_symtab (VEC_index (symbolp, sym_classes,
3093 /* If we did not find a direct implementation anywhere in
3094 this program space, consider superclasses. */
3095 if (VEC_length (const_char_ptr, result_names) == last_result_len)
3096 find_superclass_methods (superclass_vec, method_name,
3099 /* We have a list of candidate symbol names, so now we
3100 iterate over the symbol tables looking for all
3101 matches in this pspace. */
3102 add_all_symbol_names_from_pspace (&info, pspace, result_names);
3104 VEC_truncate (typep, superclass_vec, 0);
3105 last_result_len = VEC_length (const_char_ptr, result_names);
3109 if (!VEC_empty (symbolp, info.result.symbols)
3110 || !VEC_empty (bound_minimal_symbol_d, info.result.minimal_symbols))
3112 *symbols = info.result.symbols;
3113 *minsyms = info.result.minimal_symbols;
3114 do_cleanups (cleanup);
3118 /* Throw an NOT_FOUND_ERROR. This will be caught by the caller
3119 and other attempts to locate the symbol will be made. */
3120 throw_error (NOT_FOUND_ERROR, _("see caller, this text doesn't matter"));
3125 /* This object is used when collecting all matching symtabs. */
3127 struct symtab_collector
3129 /* The result vector of symtabs. */
3130 VEC (symtab_ptr) *symtabs;
3132 /* This is used to ensure the symtabs are unique. */
3133 htab_t symtab_table;
3136 /* Callback for iterate_over_symtabs. */
3139 add_symtabs_to_list (struct symtab *symtab, void *d)
3141 struct symtab_collector *data = (struct symtab_collector *) d;
3144 slot = htab_find_slot (data->symtab_table, symtab, INSERT);
3148 VEC_safe_push (symtab_ptr, data->symtabs, symtab);
3154 /* Given a file name, return a VEC of all matching symtabs. If
3155 SEARCH_PSPACE is not NULL, the search is restricted to just that
3158 static VEC (symtab_ptr) *
3159 collect_symtabs_from_filename (const char *file,
3160 struct program_space *search_pspace)
3162 struct symtab_collector collector;
3163 struct cleanup *cleanups;
3164 struct program_space *pspace;
3166 collector.symtabs = NULL;
3167 collector.symtab_table = htab_create (1, htab_hash_pointer, htab_eq_pointer,
3169 cleanups = make_cleanup_htab_delete (collector.symtab_table);
3171 /* Find that file's data. */
3172 if (search_pspace == NULL)
3174 ALL_PSPACES (pspace)
3176 if (pspace->executing_startup)
3179 set_current_program_space (pspace);
3180 iterate_over_symtabs (file, add_symtabs_to_list, &collector);
3185 set_current_program_space (search_pspace);
3186 iterate_over_symtabs (file, add_symtabs_to_list, &collector);
3189 do_cleanups (cleanups);
3190 return collector.symtabs;
3193 /* Return all the symtabs associated to the FILENAME. If SEARCH_PSPACE is
3194 not NULL, the search is restricted to just that program space. */
3196 static VEC (symtab_ptr) *
3197 symtabs_from_filename (const char *filename,
3198 struct program_space *search_pspace)
3200 VEC (symtab_ptr) *result;
3202 result = collect_symtabs_from_filename (filename, search_pspace);
3204 if (VEC_empty (symtab_ptr, result))
3206 if (!have_full_symbols () && !have_partial_symbols ())
3207 throw_error (NOT_FOUND_ERROR,
3208 _("No symbol table is loaded. "
3209 "Use the \"file\" command."));
3210 source_file_not_found_error (filename);
3216 /* Look up a function symbol named NAME in symtabs FILE_SYMTABS. Matching
3217 debug symbols are returned in SYMBOLS. Matching minimal symbols are
3218 returned in MINSYMS. */
3221 find_function_symbols (struct linespec_state *state,
3222 VEC (symtab_ptr) *file_symtabs, const char *name,
3223 VEC (symbolp) **symbols,
3224 VEC (bound_minimal_symbol_d) **minsyms)
3226 struct collect_info info;
3227 VEC (const_char_ptr) *symbol_names = NULL;
3228 struct cleanup *cleanup = make_cleanup (VEC_cleanup (const_char_ptr),
3232 info.result.symbols = NULL;
3233 info.result.minimal_symbols = NULL;
3234 info.file_symtabs = file_symtabs;
3236 /* Try NAME as an Objective-C selector. */
3237 find_imps (name, &symbol_names);
3238 if (!VEC_empty (const_char_ptr, symbol_names))
3239 add_all_symbol_names_from_pspace (&info, state->search_pspace,
3242 add_matching_symbols_to_info (name, &info, state->search_pspace);
3244 do_cleanups (cleanup);
3246 if (VEC_empty (symbolp, info.result.symbols))
3248 VEC_free (symbolp, info.result.symbols);
3252 *symbols = info.result.symbols;
3254 if (VEC_empty (bound_minimal_symbol_d, info.result.minimal_symbols))
3256 VEC_free (bound_minimal_symbol_d, info.result.minimal_symbols);
3260 *minsyms = info.result.minimal_symbols;
3263 /* Find all symbols named NAME in FILE_SYMTABS, returning debug symbols
3264 in SYMBOLS and minimal symbols in MINSYMS. */
3267 find_linespec_symbols (struct linespec_state *state,
3268 VEC (symtab_ptr) *file_symtabs,
3270 VEC (symbolp) **symbols,
3271 VEC (bound_minimal_symbol_d) **minsyms)
3273 struct cleanup *cleanup;
3275 const char *lookup_name;
3277 cleanup = demangle_for_lookup (name, state->language->la_language,
3279 if (state->language->la_language == language_ada)
3281 /* In Ada, the symbol lookups are performed using the encoded
3282 name rather than the demangled name. */
3283 lookup_name = ada_name_for_lookup (name);
3284 make_cleanup (xfree, (void *) lookup_name);
3287 canon = cp_canonicalize_string_no_typedefs (lookup_name);
3290 lookup_name = canon;
3291 make_cleanup (xfree, canon);
3294 /* It's important to not call expand_symtabs_matching unnecessarily
3295 as it can really slow things down (by unnecessarily expanding
3296 potentially 1000s of symtabs, which when debugging some apps can
3297 cost 100s of seconds). Avoid this to some extent by *first* calling
3298 find_function_symbols, and only if that doesn't find anything
3299 *then* call find_method. This handles two important cases:
3300 1) break (anonymous namespace)::foo
3301 2) break class::method where method is in class (and not a baseclass) */
3303 find_function_symbols (state, file_symtabs, lookup_name,
3306 /* If we were unable to locate a symbol of the same name, try dividing
3307 the name into class and method names and searching the class and its
3309 if (VEC_empty (symbolp, *symbols)
3310 && VEC_empty (bound_minimal_symbol_d, *minsyms))
3312 char *klass, *method;
3313 const char *last, *p, *scope_op;
3314 VEC (symbolp) *classes;
3316 /* See if we can find a scope operator and break this symbol
3317 name into namespaces${SCOPE_OPERATOR}class_name and method_name. */
3319 p = find_toplevel_string (lookup_name, scope_op);
3322 /* No C++ scope operator. Try Java. */
3324 p = find_toplevel_string (lookup_name, scope_op);
3331 p = find_toplevel_string (p + strlen (scope_op), scope_op);
3334 /* If no scope operator was found, there is nothing more we can do;
3335 we already attempted to lookup the entire name as a symbol
3339 do_cleanups (cleanup);
3343 /* LOOKUP_NAME points to the class name.
3344 LAST points to the method name. */
3345 klass = XNEWVEC (char, last - lookup_name + 1);
3346 make_cleanup (xfree, klass);
3347 strncpy (klass, lookup_name, last - lookup_name);
3348 klass[last - lookup_name] = '\0';
3350 /* Skip past the scope operator. */
3351 last += strlen (scope_op);
3352 method = XNEWVEC (char, strlen (last) + 1);
3353 make_cleanup (xfree, method);
3354 strcpy (method, last);
3356 /* Find a list of classes named KLASS. */
3357 classes = lookup_prefix_sym (state, file_symtabs, klass);
3358 make_cleanup (VEC_cleanup (symbolp), &classes);
3360 if (!VEC_empty (symbolp, classes))
3362 /* Now locate a list of suitable methods named METHOD. */
3365 find_method (state, file_symtabs, klass, method, classes,
3369 /* If successful, we're done. If NOT_FOUND_ERROR
3370 was not thrown, rethrow the exception that we did get. */
3371 CATCH (except, RETURN_MASK_ERROR)
3373 if (except.error != NOT_FOUND_ERROR)
3374 throw_exception (except);
3380 do_cleanups (cleanup);
3383 /* Return all labels named NAME in FUNCTION_SYMBOLS. Return the
3384 actual function symbol in which the label was found in LABEL_FUNC_RET. */
3386 static VEC (symbolp) *
3387 find_label_symbols (struct linespec_state *self,
3388 VEC (symbolp) *function_symbols,
3389 VEC (symbolp) **label_funcs_ret, const char *name)
3392 const struct block *block;
3394 struct symbol *fn_sym;
3395 VEC (symbolp) *result = NULL;
3397 if (function_symbols == NULL)
3399 set_current_program_space (self->program_space);
3400 block = get_current_search_block ();
3403 block && !BLOCK_FUNCTION (block);
3404 block = BLOCK_SUPERBLOCK (block))
3408 fn_sym = BLOCK_FUNCTION (block);
3410 sym = lookup_symbol (name, block, LABEL_DOMAIN, 0).symbol;
3414 VEC_safe_push (symbolp, result, sym);
3415 VEC_safe_push (symbolp, *label_funcs_ret, fn_sym);
3421 VEC_iterate (symbolp, function_symbols, ix, fn_sym); ++ix)
3423 set_current_program_space (SYMTAB_PSPACE (symbol_symtab (fn_sym)));
3424 block = SYMBOL_BLOCK_VALUE (fn_sym);
3425 sym = lookup_symbol (name, block, LABEL_DOMAIN, 0).symbol;
3429 VEC_safe_push (symbolp, result, sym);
3430 VEC_safe_push (symbolp, *label_funcs_ret, fn_sym);
3440 /* A helper for create_sals_line_offset that handles the 'list_mode' case. */
3443 decode_digits_list_mode (struct linespec_state *self,
3445 struct symtabs_and_lines *values,
3446 struct symtab_and_line val)
3451 gdb_assert (self->list_mode);
3453 for (ix = 0; VEC_iterate (symtab_ptr, ls->file_symtabs, ix, elt);
3456 /* The logic above should ensure this. */
3457 gdb_assert (elt != NULL);
3459 set_current_program_space (SYMTAB_PSPACE (elt));
3461 /* Simplistic search just for the list command. */
3462 val.symtab = find_line_symtab (elt, val.line, NULL, NULL);
3463 if (val.symtab == NULL)
3465 val.pspace = SYMTAB_PSPACE (elt);
3467 val.explicit_line = 1;
3469 add_sal_to_sals (self, values, &val, NULL, 0);
3473 /* A helper for create_sals_line_offset that iterates over the symtabs,
3474 adding lines to the VEC. */
3477 decode_digits_ordinary (struct linespec_state *self,
3480 struct symtabs_and_lines *sals,
3481 struct linetable_entry **best_entry)
3486 for (ix = 0; VEC_iterate (symtab_ptr, ls->file_symtabs, ix, elt); ++ix)
3489 VEC (CORE_ADDR) *pcs;
3492 /* The logic above should ensure this. */
3493 gdb_assert (elt != NULL);
3495 set_current_program_space (SYMTAB_PSPACE (elt));
3497 pcs = find_pcs_for_symtab_line (elt, line, best_entry);
3498 for (i = 0; VEC_iterate (CORE_ADDR, pcs, i, pc); ++i)
3500 struct symtab_and_line sal;
3503 sal.pspace = SYMTAB_PSPACE (elt);
3507 add_sal_to_sals_basic (sals, &sal);
3510 VEC_free (CORE_ADDR, pcs);
3516 /* Return the line offset represented by VARIABLE. */
3518 static struct line_offset
3519 linespec_parse_variable (struct linespec_state *self, const char *variable)
3523 struct line_offset offset = {0, LINE_OFFSET_NONE};
3525 p = (variable[1] == '$') ? variable + 2 : variable + 1;
3528 while (*p >= '0' && *p <= '9')
3530 if (!*p) /* Reached end of token without hitting non-digit. */
3532 /* We have a value history reference. */
3533 struct value *val_history;
3535 sscanf ((variable[1] == '$') ? variable + 2 : variable + 1, "%d", &index);
3537 = access_value_history ((variable[1] == '$') ? -index : index);
3538 if (TYPE_CODE (value_type (val_history)) != TYPE_CODE_INT)
3539 error (_("History values used in line "
3540 "specs must have integer values."));
3541 offset.offset = value_as_long (val_history);
3545 /* Not all digits -- may be user variable/function or a
3546 convenience variable. */
3548 struct internalvar *ivar;
3550 /* Try it as a convenience variable. If it is not a convenience
3551 variable, return and allow normal symbol lookup to occur. */
3552 ivar = lookup_only_internalvar (variable + 1);
3554 /* No internal variable with that name. Mark the offset
3555 as unknown to allow the name to be looked up as a symbol. */
3556 offset.sign = LINE_OFFSET_UNKNOWN;
3559 /* We found a valid variable name. If it is not an integer,
3561 if (!get_internalvar_integer (ivar, &valx))
3562 error (_("Convenience variables used in line "
3563 "specs must have integer values."));
3565 offset.offset = valx;
3573 /* A callback used to possibly add a symbol to the results. */
3576 collect_symbols (struct symbol *sym, void *data)
3578 struct collect_info *info = (struct collect_info *) data;
3580 /* In list mode, add all matching symbols, regardless of class.
3581 This allows the user to type "list a_global_variable". */
3582 if (SYMBOL_CLASS (sym) == LOC_BLOCK || info->state->list_mode)
3583 VEC_safe_push (symbolp, info->result.symbols, sym);
3584 return 1; /* Continue iterating. */
3587 /* We've found a minimal symbol MSYMBOL in OBJFILE to associate with our
3588 linespec; return the SAL in RESULT. This function should return SALs
3589 matching those from find_function_start_sal, otherwise false
3590 multiple-locations breakpoints could be placed. */
3593 minsym_found (struct linespec_state *self, struct objfile *objfile,
3594 struct minimal_symbol *msymbol,
3595 struct symtabs_and_lines *result)
3597 struct gdbarch *gdbarch = get_objfile_arch (objfile);
3599 struct symtab_and_line sal;
3601 sal = find_pc_sect_line (MSYMBOL_VALUE_ADDRESS (objfile, msymbol),
3602 (struct obj_section *) 0, 0);
3603 sal.section = MSYMBOL_OBJ_SECTION (objfile, msymbol);
3605 /* The minimal symbol might point to a function descriptor;
3606 resolve it to the actual code address instead. */
3607 pc = gdbarch_convert_from_func_ptr_addr (gdbarch, sal.pc, ¤t_target);
3609 sal = find_pc_sect_line (pc, NULL, 0);
3611 if (self->funfirstline)
3613 if (sal.symtab != NULL
3614 && (COMPUNIT_LOCATIONS_VALID (SYMTAB_COMPUNIT (sal.symtab))
3615 || SYMTAB_LANGUAGE (sal.symtab) == language_asm))
3617 /* If gdbarch_convert_from_func_ptr_addr does not apply then
3618 sal.SECTION, sal.LINE&co. will stay correct from above.
3619 If gdbarch_convert_from_func_ptr_addr applies then
3620 sal.SECTION is cleared from above and sal.LINE&co. will
3621 stay correct from the last find_pc_sect_line above. */
3622 sal.pc = MSYMBOL_VALUE_ADDRESS (objfile, msymbol);
3623 sal.pc = gdbarch_convert_from_func_ptr_addr (gdbarch, sal.pc,
3625 if (gdbarch_skip_entrypoint_p (gdbarch))
3626 sal.pc = gdbarch_skip_entrypoint (gdbarch, sal.pc);
3629 skip_prologue_sal (&sal);
3632 if (maybe_add_address (self->addr_set, objfile->pspace, sal.pc))
3633 add_sal_to_sals (self, result, &sal, MSYMBOL_NATURAL_NAME (msymbol), 0);
3636 /* A helper struct to pass some data through
3637 iterate_over_minimal_symbols. */
3639 struct collect_minsyms
3641 /* The objfile we're examining. */
3642 struct objfile *objfile;
3644 /* Only search the given symtab, or NULL to search for all symbols. */
3645 struct symtab *symtab;
3647 /* The funfirstline setting from the initial call. */
3650 /* The list_mode setting from the initial call. */
3653 /* The resulting symbols. */
3654 VEC (bound_minimal_symbol_d) *msyms;
3657 /* A helper function to classify a minimal_symbol_type according to
3661 classify_mtype (enum minimal_symbol_type t)
3668 /* Intermediate priority. */
3671 case mst_solib_trampoline:
3672 /* Lowest priority. */
3676 /* Highest priority. */
3681 /* Callback for qsort that sorts symbols by priority. */
3684 compare_msyms (const void *a, const void *b)
3686 const bound_minimal_symbol_d *moa = (const bound_minimal_symbol_d *) a;
3687 const bound_minimal_symbol_d *mob = (const bound_minimal_symbol_d *) b;
3688 enum minimal_symbol_type ta = MSYMBOL_TYPE (moa->minsym);
3689 enum minimal_symbol_type tb = MSYMBOL_TYPE (mob->minsym);
3691 return classify_mtype (ta) - classify_mtype (tb);
3694 /* Callback for iterate_over_minimal_symbols that adds the symbol to
3698 add_minsym (struct minimal_symbol *minsym, void *d)
3700 struct collect_minsyms *info = (struct collect_minsyms *) d;
3701 bound_minimal_symbol_d mo;
3704 mo.objfile = info->objfile;
3706 if (info->symtab != NULL)
3709 struct symtab_and_line sal;
3710 struct gdbarch *gdbarch = get_objfile_arch (info->objfile);
3712 sal = find_pc_sect_line (MSYMBOL_VALUE_ADDRESS (info->objfile, minsym),
3714 sal.section = MSYMBOL_OBJ_SECTION (info->objfile, minsym);
3716 = gdbarch_convert_from_func_ptr_addr (gdbarch, sal.pc, ¤t_target);
3718 sal = find_pc_sect_line (pc, NULL, 0);
3720 if (info->symtab != sal.symtab)
3724 /* Exclude data symbols when looking for breakpoint locations. */
3725 if (!info->list_mode)
3726 switch (minsym->type)
3728 case mst_slot_got_plt:
3735 /* Make sure this minsym is not a function descriptor
3736 before we decide to discard it. */
3737 struct gdbarch *gdbarch = get_objfile_arch (info->objfile);
3738 CORE_ADDR addr = gdbarch_convert_from_func_ptr_addr
3739 (gdbarch, BMSYMBOL_VALUE_ADDRESS (mo),
3742 if (addr == BMSYMBOL_VALUE_ADDRESS (mo))
3747 VEC_safe_push (bound_minimal_symbol_d, info->msyms, &mo);
3750 /* Search for minimal symbols called NAME. If SEARCH_PSPACE
3751 is not NULL, the search is restricted to just that program
3754 If SYMTAB is NULL, search all objfiles, otherwise
3755 restrict results to the given SYMTAB. */
3758 search_minsyms_for_name (struct collect_info *info, const char *name,
3759 struct program_space *search_pspace,
3760 struct symtab *symtab)
3762 struct collect_minsyms local;
3763 struct cleanup *cleanup;
3765 memset (&local, 0, sizeof (local));
3766 local.funfirstline = info->state->funfirstline;
3767 local.list_mode = info->state->list_mode;
3768 local.symtab = symtab;
3770 cleanup = make_cleanup (VEC_cleanup (bound_minimal_symbol_d), &local.msyms);
3774 struct program_space *pspace;
3776 ALL_PSPACES (pspace)
3778 struct objfile *objfile;
3780 if (search_pspace != NULL && search_pspace != pspace)
3782 if (pspace->executing_startup)
3785 set_current_program_space (pspace);
3787 ALL_OBJFILES (objfile)
3789 local.objfile = objfile;
3790 iterate_over_minimal_symbols (objfile, name, add_minsym, &local);
3796 if (search_pspace == NULL || SYMTAB_PSPACE (symtab) == search_pspace)
3798 set_current_program_space (SYMTAB_PSPACE (symtab));
3799 local.objfile = SYMTAB_OBJFILE(symtab);
3800 iterate_over_minimal_symbols (local.objfile, name, add_minsym,
3805 if (!VEC_empty (bound_minimal_symbol_d, local.msyms))
3809 bound_minimal_symbol_d *item;
3811 qsort (VEC_address (bound_minimal_symbol_d, local.msyms),
3812 VEC_length (bound_minimal_symbol_d, local.msyms),
3813 sizeof (bound_minimal_symbol_d),
3816 /* Now the minsyms are in classification order. So, we walk
3817 over them and process just the minsyms with the same
3818 classification as the very first minsym in the list. */
3819 item = VEC_index (bound_minimal_symbol_d, local.msyms, 0);
3820 classification = classify_mtype (MSYMBOL_TYPE (item->minsym));
3823 VEC_iterate (bound_minimal_symbol_d, local.msyms, ix, item);
3826 if (classify_mtype (MSYMBOL_TYPE (item->minsym)) != classification)
3829 VEC_safe_push (bound_minimal_symbol_d,
3830 info->result.minimal_symbols, item);
3834 do_cleanups (cleanup);
3837 /* A helper function to add all symbols matching NAME to INFO. If
3838 PSPACE is not NULL, the search is restricted to just that program
3842 add_matching_symbols_to_info (const char *name,
3843 struct collect_info *info,
3844 struct program_space *pspace)
3849 for (ix = 0; VEC_iterate (symtab_ptr, info->file_symtabs, ix, elt); ++ix)
3853 iterate_over_all_matching_symtabs (info->state, name, VAR_DOMAIN,
3854 collect_symbols, info,
3856 search_minsyms_for_name (info, name, pspace, NULL);
3858 else if (pspace == NULL || pspace == SYMTAB_PSPACE (elt))
3860 int prev_len = VEC_length (symbolp, info->result.symbols);
3862 /* Program spaces that are executing startup should have
3863 been filtered out earlier. */
3864 gdb_assert (!SYMTAB_PSPACE (elt)->executing_startup);
3865 set_current_program_space (SYMTAB_PSPACE (elt));
3866 iterate_over_file_blocks (elt, name, VAR_DOMAIN,
3867 collect_symbols, info);
3869 /* If no new symbols were found in this iteration and this symtab
3870 is in assembler, we might actually be looking for a label for
3871 which we don't have debug info. Check for a minimal symbol in
3873 if (prev_len == VEC_length (symbolp, info->result.symbols)
3874 && elt->language == language_asm)
3875 search_minsyms_for_name (info, name, pspace, elt);
3882 /* Now come some functions that are called from multiple places within
3886 symbol_to_sal (struct symtab_and_line *result,
3887 int funfirstline, struct symbol *sym)
3889 if (SYMBOL_CLASS (sym) == LOC_BLOCK)
3891 *result = find_function_start_sal (sym, funfirstline);
3896 if (SYMBOL_CLASS (sym) == LOC_LABEL && SYMBOL_VALUE_ADDRESS (sym) != 0)
3899 result->symtab = symbol_symtab (sym);
3900 result->line = SYMBOL_LINE (sym);
3901 result->pc = SYMBOL_VALUE_ADDRESS (sym);
3902 result->pspace = SYMTAB_PSPACE (result->symtab);
3903 result->explicit_pc = 1;
3906 else if (funfirstline)
3910 else if (SYMBOL_LINE (sym) != 0)
3912 /* We know its line number. */
3914 result->symtab = symbol_symtab (sym);
3915 result->line = SYMBOL_LINE (sym);
3916 result->pspace = SYMTAB_PSPACE (result->symtab);
3924 /* See the comment in linespec.h. */
3927 init_linespec_result (struct linespec_result *lr)
3929 memset (lr, 0, sizeof (*lr));
3932 /* See the comment in linespec.h. */
3935 destroy_linespec_result (struct linespec_result *ls)
3938 struct linespec_sals *lsal;
3940 delete_event_location (ls->location);
3941 for (i = 0; VEC_iterate (linespec_sals, ls->sals, i, lsal); ++i)
3943 xfree (lsal->canonical);
3944 xfree (lsal->sals.sals);
3946 VEC_free (linespec_sals, ls->sals);
3949 /* Cleanup function for a linespec_result. */
3952 cleanup_linespec_result (void *a)
3954 destroy_linespec_result ((struct linespec_result *) a);
3957 /* See the comment in linespec.h. */
3960 make_cleanup_destroy_linespec_result (struct linespec_result *ls)
3962 return make_cleanup (cleanup_linespec_result, ls);
3965 /* Return the quote characters permitted by the linespec parser. */
3968 get_gdb_linespec_parser_quote_characters (void)
3970 return linespec_quote_characters;