1 /* Parser for linespec for the GNU debugger, GDB.
3 Copyright (C) 1986-2018 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"
47 #include "common/function-view.h"
48 #include "common/def-vector.h"
51 /* An enumeration of the various things a user might attempt to
52 complete for a linespec location. */
54 enum class linespec_complete_what
56 /* Nothing, no possible completion. */
59 /* A function/method name. Due to ambiguity between
65 this can also indicate a source filename, iff we haven't seen a
66 separate source filename component, as in "b source.c:function". */
69 /* A label symbol. E.g., break file.c:function:LABEL. */
72 /* An expression. E.g., "break foo if EXPR", or "break *EXPR". */
75 /* A linespec keyword ("if"/"thread"/"task").
76 E.g., "break func threa<tab>". */
80 typedef struct symbol *symbolp;
83 /* An address entry is used to ensure that any given location is only
84 added to the result a single time. It holds an address and the
85 program space from which the address came. */
89 struct program_space *pspace;
93 typedef struct bound_minimal_symbol bound_minimal_symbol_d;
95 DEF_VEC_O (bound_minimal_symbol_d);
97 /* A linespec. Elements of this structure are filled in by a parser
98 (either parse_linespec or some other function). The structure is
99 then converted into SALs by convert_linespec_to_sals. */
103 /* An explicit location describing the SaLs. */
104 struct explicit_location explicit_loc;
106 /* The list of symtabs to search to which to limit the search. May not
107 be NULL. If explicit.SOURCE_FILENAME is NULL (no user-specified
108 filename), FILE_SYMTABS should contain one single NULL member. This
109 will cause the code to use the default symtab. */
110 VEC (symtab_ptr) *file_symtabs;
112 /* A list of matching function symbols and minimal symbols. Both lists
113 may be NULL if no matching symbols were found. */
114 VEC (symbolp) *function_symbols;
115 VEC (bound_minimal_symbol_d) *minimal_symbols;
117 /* A structure of matching label symbols and the corresponding
118 function symbol in which the label was found. Both may be NULL
119 or both must be non-NULL. */
122 VEC (symbolp) *label_symbols;
123 VEC (symbolp) *function_symbols;
126 typedef struct linespec *linespec_p;
128 /* A canonical linespec represented as a symtab-related string.
130 Each entry represents the "SYMTAB:SUFFIX" linespec string.
131 SYMTAB can be converted for example by symtab_to_fullname or
132 symtab_to_filename_for_display as needed. */
134 struct linespec_canonical_name
136 /* Remaining text part of the linespec string. */
139 /* If NULL then SUFFIX is the whole linespec string. */
140 struct symtab *symtab;
143 /* An instance of this is used to keep all state while linespec
144 operates. This instance is passed around as a 'this' pointer to
145 the various implementation methods. */
147 struct linespec_state
149 /* The language in use during linespec processing. */
150 const struct language_defn *language;
152 /* The program space as seen when the module was entered. */
153 struct program_space *program_space;
155 /* If not NULL, the search is restricted to just this program
157 struct program_space *search_pspace;
159 /* The default symtab to use, if no other symtab is specified. */
160 struct symtab *default_symtab;
162 /* The default line to use. */
165 /* The 'funfirstline' value that was passed in to decode_line_1 or
169 /* Nonzero if we are running in 'list' mode; see decode_line_list. */
172 /* The 'canonical' value passed to decode_line_full, or NULL. */
173 struct linespec_result *canonical;
175 /* Canonical strings that mirror the std::vector<symtab_and_line> result. */
176 struct linespec_canonical_name *canonical_names;
178 /* This is a set of address_entry objects which is used to prevent
179 duplicate symbols from being entered into the result. */
182 /* Are we building a linespec? */
186 /* This is a helper object that is used when collecting symbols into a
191 /* The linespec object in use. */
192 struct linespec_state *state;
194 /* A list of symtabs to which to restrict matches. */
195 VEC (symtab_ptr) *file_symtabs;
197 /* The result being accumulated. */
200 VEC (symbolp) *symbols;
201 VEC (bound_minimal_symbol_d) *minimal_symbols;
204 /* Possibly add a symbol to the results. */
205 bool add_symbol (symbol *sym);
209 collect_info::add_symbol (symbol *sym)
211 /* In list mode, add all matching symbols, regardless of class.
212 This allows the user to type "list a_global_variable". */
213 if (SYMBOL_CLASS (sym) == LOC_BLOCK || this->state->list_mode)
214 VEC_safe_push (symbolp, this->result.symbols, sym);
216 /* Continue iterating. */
227 /* A colon "separator" */
239 /* EOI (end of input) */
245 typedef enum ls_token_type linespec_token_type;
247 /* List of keywords. This is NULL-terminated so that it can be used
248 as enum completer. */
249 const char * const linespec_keywords[] = { "if", "thread", "task", NULL };
250 #define IF_KEYWORD_INDEX 0
252 /* A token of the linespec lexer */
256 /* The type of the token */
257 linespec_token_type type;
259 /* Data for the token */
262 /* A string, given as a stoken */
263 struct stoken string;
269 typedef struct ls_token linespec_token;
271 #define LS_TOKEN_STOKEN(TOK) (TOK).data.string
272 #define LS_TOKEN_KEYWORD(TOK) (TOK).data.keyword
274 /* An instance of the linespec parser. */
278 /* Lexer internal data */
281 /* Save head of input stream. */
282 const char *saved_arg;
284 /* Head of the input stream. */
286 #define PARSER_STREAM(P) ((P)->lexer.stream)
288 /* The current token. */
289 linespec_token current;
292 /* Is the entire linespec quote-enclosed? */
293 int is_quote_enclosed;
295 /* The state of the parse. */
296 struct linespec_state state;
297 #define PARSER_STATE(PPTR) (&(PPTR)->state)
299 /* The result of the parse. */
300 struct linespec result;
301 #define PARSER_RESULT(PPTR) (&(PPTR)->result)
303 /* What the parser believes the current word point should complete
305 linespec_complete_what complete_what;
307 /* The completion word point. The parser advances this as it skips
308 tokens. At some point the input string will end or parsing will
309 fail, and then we attempt completion at the captured completion
310 word point, interpreting the string at completion_word as
312 const char *completion_word;
314 /* If the current token was a quoted string, then this is the
315 quoting character (either " or '). */
316 int completion_quote_char;
318 /* If the current token was a quoted string, then this points at the
319 end of the quoted string. */
320 const char *completion_quote_end;
322 /* If parsing for completion, then this points at the completion
323 tracker. Otherwise, this is NULL. */
324 struct completion_tracker *completion_tracker;
326 typedef struct ls_parser linespec_parser;
328 /* A convenience macro for accessing the explicit location result of
330 #define PARSER_EXPLICIT(PPTR) (&PARSER_RESULT ((PPTR))->explicit_loc)
332 /* Prototypes for local functions. */
334 static void iterate_over_file_blocks
335 (struct symtab *symtab, const lookup_name_info &name,
337 gdb::function_view<symbol_found_callback_ftype> callback);
339 static void initialize_defaults (struct symtab **default_symtab,
342 CORE_ADDR linespec_expression_to_pc (const char **exp_ptr);
344 static std::vector<symtab_and_line> decode_objc (struct linespec_state *self,
348 static VEC (symtab_ptr) *symtabs_from_filename (const char *,
349 struct program_space *pspace);
351 static VEC (symbolp) *find_label_symbols (struct linespec_state *self,
352 VEC (symbolp) *function_symbols,
353 VEC (symbolp) **label_funcs_ret,
355 bool completion_mode = false);
357 static void find_linespec_symbols (struct linespec_state *self,
358 VEC (symtab_ptr) *file_symtabs,
360 symbol_name_match_type name_match_type,
361 VEC (symbolp) **symbols,
362 VEC (bound_minimal_symbol_d) **minsyms);
364 static struct line_offset
365 linespec_parse_variable (struct linespec_state *self,
366 const char *variable);
368 static int symbol_to_sal (struct symtab_and_line *result,
369 int funfirstline, struct symbol *sym);
371 static void add_matching_symbols_to_info (const char *name,
372 symbol_name_match_type name_match_type,
373 enum search_domain search_domain,
374 struct collect_info *info,
375 struct program_space *pspace);
377 static void add_all_symbol_names_from_pspace
378 (struct collect_info *info, struct program_space *pspace,
379 const std::vector<const char *> &names, enum search_domain search_domain);
381 static VEC (symtab_ptr) *
382 collect_symtabs_from_filename (const char *file,
383 struct program_space *pspace);
385 static std::vector<symtab_and_line> decode_digits_ordinary
386 (struct linespec_state *self,
389 linetable_entry **best_entry);
391 static std::vector<symtab_and_line> decode_digits_list_mode
392 (struct linespec_state *self,
394 struct symtab_and_line val);
396 static void minsym_found (struct linespec_state *self, struct objfile *objfile,
397 struct minimal_symbol *msymbol,
398 std::vector<symtab_and_line> *result);
400 static int compare_symbols (const void *a, const void *b);
402 static int compare_msymbols (const void *a, const void *b);
404 /* Permitted quote characters for the parser. This is different from the
405 completer's quote characters to allow backward compatibility with the
407 static const char *const linespec_quote_characters = "\"\'";
409 /* Lexer functions. */
411 /* Lex a number from the input in PARSER. This only supports
414 Return true if input is decimal numbers. Return false if not. */
417 linespec_lexer_lex_number (linespec_parser *parser, linespec_token *tokenp)
419 tokenp->type = LSTOKEN_NUMBER;
420 LS_TOKEN_STOKEN (*tokenp).length = 0;
421 LS_TOKEN_STOKEN (*tokenp).ptr = PARSER_STREAM (parser);
423 /* Keep any sign at the start of the stream. */
424 if (*PARSER_STREAM (parser) == '+' || *PARSER_STREAM (parser) == '-')
426 ++LS_TOKEN_STOKEN (*tokenp).length;
427 ++(PARSER_STREAM (parser));
430 while (isdigit (*PARSER_STREAM (parser)))
432 ++LS_TOKEN_STOKEN (*tokenp).length;
433 ++(PARSER_STREAM (parser));
436 /* If the next character in the input buffer is not a space, comma,
437 quote, or colon, this input does not represent a number. */
438 if (*PARSER_STREAM (parser) != '\0'
439 && !isspace (*PARSER_STREAM (parser)) && *PARSER_STREAM (parser) != ','
440 && *PARSER_STREAM (parser) != ':'
441 && !strchr (linespec_quote_characters, *PARSER_STREAM (parser)))
443 PARSER_STREAM (parser) = LS_TOKEN_STOKEN (*tokenp).ptr;
450 /* See linespec.h. */
453 linespec_lexer_lex_keyword (const char *p)
459 for (i = 0; linespec_keywords[i] != NULL; ++i)
461 int len = strlen (linespec_keywords[i]);
463 /* If P begins with one of the keywords and the next
464 character is whitespace, we may have found a keyword.
465 It is only a keyword if it is not followed by another
467 if (strncmp (p, linespec_keywords[i], len) == 0
472 /* Special case: "if" ALWAYS stops the lexer, since it
473 is not possible to predict what is going to appear in
474 the condition, which can only be parsed after SaLs have
476 if (i != IF_KEYWORD_INDEX)
480 for (j = 0; linespec_keywords[j] != NULL; ++j)
482 int nextlen = strlen (linespec_keywords[j]);
484 if (strncmp (p, linespec_keywords[j], nextlen) == 0
485 && isspace (p[nextlen]))
490 return linespec_keywords[i];
498 /* See description in linespec.h. */
501 is_ada_operator (const char *string)
503 const struct ada_opname_map *mapping;
505 for (mapping = ada_opname_table;
506 mapping->encoded != NULL
507 && !startswith (string, mapping->decoded); ++mapping)
510 return mapping->decoded == NULL ? 0 : strlen (mapping->decoded);
513 /* Find QUOTE_CHAR in STRING, accounting for the ':' terminal. Return
514 the location of QUOTE_CHAR, or NULL if not found. */
517 skip_quote_char (const char *string, char quote_char)
519 const char *p, *last;
521 p = last = find_toplevel_char (string, quote_char);
522 while (p && *p != '\0' && *p != ':')
524 p = find_toplevel_char (p, quote_char);
532 /* Make a writable copy of the string given in TOKEN, trimming
533 any trailing whitespace. */
535 static gdb::unique_xmalloc_ptr<char>
536 copy_token_string (linespec_token token)
540 if (token.type == LSTOKEN_KEYWORD)
541 return gdb::unique_xmalloc_ptr<char> (xstrdup (LS_TOKEN_KEYWORD (token)));
543 str = LS_TOKEN_STOKEN (token).ptr;
544 s = remove_trailing_whitespace (str, str + LS_TOKEN_STOKEN (token).length);
546 return gdb::unique_xmalloc_ptr<char> (savestring (str, s - str));
549 /* Does P represent the end of a quote-enclosed linespec? */
552 is_closing_quote_enclosed (const char *p)
554 if (strchr (linespec_quote_characters, *p))
556 p = skip_spaces ((char *) p);
557 return (*p == '\0' || linespec_lexer_lex_keyword (p));
560 /* Find the end of the parameter list that starts with *INPUT.
561 This helper function assists with lexing string segments
562 which might contain valid (non-terminating) commas. */
565 find_parameter_list_end (const char *input)
567 char end_char, start_char;
572 if (start_char == '(')
574 else if (start_char == '<')
583 if (*p == start_char)
585 else if (*p == end_char)
599 /* If the [STRING, STRING_LEN) string ends with what looks like a
600 keyword, return the keyword start offset in STRING. Return -1
604 string_find_incomplete_keyword_at_end (const char * const *keywords,
605 const char *string, size_t string_len)
607 const char *end = string + string_len;
610 while (p > string && *p != ' ')
615 size_t len = end - p;
616 for (size_t i = 0; keywords[i] != NULL; ++i)
617 if (strncmp (keywords[i], p, len) == 0)
624 /* Lex a string from the input in PARSER. */
626 static linespec_token
627 linespec_lexer_lex_string (linespec_parser *parser)
629 linespec_token token;
630 const char *start = PARSER_STREAM (parser);
632 token.type = LSTOKEN_STRING;
634 /* If the input stream starts with a quote character, skip to the next
635 quote character, regardless of the content. */
636 if (strchr (linespec_quote_characters, *PARSER_STREAM (parser)))
639 char quote_char = *PARSER_STREAM (parser);
641 /* Special case: Ada operators. */
642 if (PARSER_STATE (parser)->language->la_language == language_ada
643 && quote_char == '\"')
645 int len = is_ada_operator (PARSER_STREAM (parser));
649 /* The input is an Ada operator. Return the quoted string
651 LS_TOKEN_STOKEN (token).ptr = PARSER_STREAM (parser);
652 LS_TOKEN_STOKEN (token).length = len;
653 PARSER_STREAM (parser) += len;
657 /* The input does not represent an Ada operator -- fall through
658 to normal quoted string handling. */
661 /* Skip past the beginning quote. */
662 ++(PARSER_STREAM (parser));
664 /* Mark the start of the string. */
665 LS_TOKEN_STOKEN (token).ptr = PARSER_STREAM (parser);
667 /* Skip to the ending quote. */
668 end = skip_quote_char (PARSER_STREAM (parser), quote_char);
670 /* This helps the completer mode decide whether we have a
672 parser->completion_quote_char = quote_char;
673 parser->completion_quote_end = end;
675 /* Error if the input did not terminate properly, unless in
679 if (parser->completion_tracker == NULL)
680 error (_("unmatched quote"));
682 /* In completion mode, we'll try to complete the incomplete
684 token.type = LSTOKEN_STRING;
685 while (*PARSER_STREAM (parser) != '\0')
686 PARSER_STREAM (parser)++;
687 LS_TOKEN_STOKEN (token).length = PARSER_STREAM (parser) - 1 - start;
691 /* Skip over the ending quote and mark the length of the string. */
692 PARSER_STREAM (parser) = (char *) ++end;
693 LS_TOKEN_STOKEN (token).length = PARSER_STREAM (parser) - 2 - start;
700 /* Otherwise, only identifier characters are permitted.
701 Spaces are the exception. In general, we keep spaces,
702 but only if the next characters in the input do not resolve
703 to one of the keywords.
705 This allows users to forgo quoting CV-qualifiers, template arguments,
706 and similar common language constructs. */
710 if (isspace (*PARSER_STREAM (parser)))
712 p = skip_spaces (PARSER_STREAM (parser));
713 /* When we get here we know we've found something followed by
714 a space (we skip over parens and templates below).
715 So if we find a keyword now, we know it is a keyword and not,
716 say, a function name. */
717 if (linespec_lexer_lex_keyword (p) != NULL)
719 LS_TOKEN_STOKEN (token).ptr = start;
720 LS_TOKEN_STOKEN (token).length
721 = PARSER_STREAM (parser) - start;
725 /* Advance past the whitespace. */
726 PARSER_STREAM (parser) = p;
729 /* If the next character is EOI or (single) ':', the
730 string is complete; return the token. */
731 if (*PARSER_STREAM (parser) == 0)
733 LS_TOKEN_STOKEN (token).ptr = start;
734 LS_TOKEN_STOKEN (token).length = PARSER_STREAM (parser) - start;
737 else if (PARSER_STREAM (parser)[0] == ':')
739 /* Do not tokenize the C++ scope operator. */
740 if (PARSER_STREAM (parser)[1] == ':')
741 ++(PARSER_STREAM (parser));
743 /* Do not tokenize ABI tags such as "[abi:cxx11]". */
744 else if (PARSER_STREAM (parser) - start > 4
745 && startswith (PARSER_STREAM (parser) - 4, "[abi"))
746 ++(PARSER_STREAM (parser));
748 /* Do not tokenify if the input length so far is one
749 (i.e, a single-letter drive name) and the next character
750 is a directory separator. This allows Windows-style
751 paths to be recognized as filenames without quoting it. */
752 else if ((PARSER_STREAM (parser) - start) != 1
753 || !IS_DIR_SEPARATOR (PARSER_STREAM (parser)[1]))
755 LS_TOKEN_STOKEN (token).ptr = start;
756 LS_TOKEN_STOKEN (token).length
757 = PARSER_STREAM (parser) - start;
761 /* Special case: permit quote-enclosed linespecs. */
762 else if (parser->is_quote_enclosed
763 && strchr (linespec_quote_characters,
764 *PARSER_STREAM (parser))
765 && is_closing_quote_enclosed (PARSER_STREAM (parser)))
767 LS_TOKEN_STOKEN (token).ptr = start;
768 LS_TOKEN_STOKEN (token).length = PARSER_STREAM (parser) - start;
771 /* Because commas may terminate a linespec and appear in
772 the middle of valid string input, special cases for
773 '<' and '(' are necessary. */
774 else if (*PARSER_STREAM (parser) == '<'
775 || *PARSER_STREAM (parser) == '(')
777 /* Don't interpret 'operator<' / 'operator<<' as a
778 template parameter list though. */
779 if (*PARSER_STREAM (parser) == '<'
780 && (PARSER_STATE (parser)->language->la_language
782 && (PARSER_STREAM (parser) - start) >= CP_OPERATOR_LEN)
784 const char *p = PARSER_STREAM (parser);
786 while (p > start && isspace (p[-1]))
788 if (p - start >= CP_OPERATOR_LEN)
790 p -= CP_OPERATOR_LEN;
791 if (strncmp (p, CP_OPERATOR_STR, CP_OPERATOR_LEN) == 0
793 || !(isalnum (p[-1]) || p[-1] == '_')))
795 /* This is an operator name. Keep going. */
796 ++(PARSER_STREAM (parser));
797 if (*PARSER_STREAM (parser) == '<')
798 ++(PARSER_STREAM (parser));
804 const char *p = find_parameter_list_end (PARSER_STREAM (parser));
805 PARSER_STREAM (parser) = p;
807 /* Don't loop around to the normal \0 case above because
808 we don't want to misinterpret a potential keyword at
809 the end of the token when the string isn't
810 "()<>"-balanced. This handles "b
811 function(thread<tab>" in completion mode. */
814 LS_TOKEN_STOKEN (token).ptr = start;
815 LS_TOKEN_STOKEN (token).length
816 = PARSER_STREAM (parser) - start;
822 /* Commas are terminators, but not if they are part of an
824 else if (*PARSER_STREAM (parser) == ',')
826 if ((PARSER_STATE (parser)->language->la_language
828 && (PARSER_STREAM (parser) - start) > CP_OPERATOR_LEN)
830 const char *p = strstr (start, CP_OPERATOR_STR);
832 if (p != NULL && is_operator_name (p))
834 /* This is an operator name. Keep going. */
835 ++(PARSER_STREAM (parser));
840 /* Comma terminates the string. */
841 LS_TOKEN_STOKEN (token).ptr = start;
842 LS_TOKEN_STOKEN (token).length = PARSER_STREAM (parser) - start;
846 /* Advance the stream. */
847 ++(PARSER_STREAM (parser));
854 /* Lex a single linespec token from PARSER. */
856 static linespec_token
857 linespec_lexer_lex_one (linespec_parser *parser)
861 if (parser->lexer.current.type == LSTOKEN_CONSUMED)
863 /* Skip any whitespace. */
864 PARSER_STREAM (parser) = skip_spaces (PARSER_STREAM (parser));
866 /* Check for a keyword, they end the linespec. */
867 keyword = linespec_lexer_lex_keyword (PARSER_STREAM (parser));
870 parser->lexer.current.type = LSTOKEN_KEYWORD;
871 LS_TOKEN_KEYWORD (parser->lexer.current) = keyword;
872 /* We do not advance the stream here intentionally:
873 we would like lexing to stop when a keyword is seen.
875 PARSER_STREAM (parser) += strlen (keyword); */
877 return parser->lexer.current;
880 /* Handle other tokens. */
881 switch (*PARSER_STREAM (parser))
884 parser->lexer.current.type = LSTOKEN_EOI;
888 case '0': case '1': case '2': case '3': case '4':
889 case '5': case '6': case '7': case '8': case '9':
890 if (!linespec_lexer_lex_number (parser, &(parser->lexer.current)))
891 parser->lexer.current = linespec_lexer_lex_string (parser);
895 /* If we have a scope operator, lex the input as a string.
896 Otherwise, return LSTOKEN_COLON. */
897 if (PARSER_STREAM (parser)[1] == ':')
898 parser->lexer.current = linespec_lexer_lex_string (parser);
901 parser->lexer.current.type = LSTOKEN_COLON;
902 ++(PARSER_STREAM (parser));
906 case '\'': case '\"':
907 /* Special case: permit quote-enclosed linespecs. */
908 if (parser->is_quote_enclosed
909 && is_closing_quote_enclosed (PARSER_STREAM (parser)))
911 ++(PARSER_STREAM (parser));
912 parser->lexer.current.type = LSTOKEN_EOI;
915 parser->lexer.current = linespec_lexer_lex_string (parser);
919 parser->lexer.current.type = LSTOKEN_COMMA;
920 LS_TOKEN_STOKEN (parser->lexer.current).ptr
921 = PARSER_STREAM (parser);
922 LS_TOKEN_STOKEN (parser->lexer.current).length = 1;
923 ++(PARSER_STREAM (parser));
927 /* If the input is not a number, it must be a string.
928 [Keywords were already considered above.] */
929 parser->lexer.current = linespec_lexer_lex_string (parser);
934 return parser->lexer.current;
937 /* Consume the current token and return the next token in PARSER's
938 input stream. Also advance the completion word for completion
941 static linespec_token
942 linespec_lexer_consume_token (linespec_parser *parser)
944 gdb_assert (parser->lexer.current.type != LSTOKEN_EOI);
946 bool advance_word = (parser->lexer.current.type != LSTOKEN_STRING
947 || *PARSER_STREAM (parser) != '\0');
949 /* If we're moving past a string to some other token, it must be the
950 quote was terminated. */
951 if (parser->completion_quote_char)
953 gdb_assert (parser->lexer.current.type == LSTOKEN_STRING);
955 /* If the string was the last (non-EOI) token, we're past the
956 quote, but remember that for later. */
957 if (*PARSER_STREAM (parser) != '\0')
959 parser->completion_quote_char = '\0';
960 parser->completion_quote_end = NULL;;
964 parser->lexer.current.type = LSTOKEN_CONSUMED;
965 linespec_lexer_lex_one (parser);
967 if (parser->lexer.current.type == LSTOKEN_STRING)
969 /* Advance the completion word past a potential initial
971 parser->completion_word = LS_TOKEN_STOKEN (parser->lexer.current).ptr;
973 else if (advance_word)
975 /* Advance the completion word past any whitespace. */
976 parser->completion_word = PARSER_STREAM (parser);
979 return parser->lexer.current;
982 /* Return the next token without consuming the current token. */
984 static linespec_token
985 linespec_lexer_peek_token (linespec_parser *parser)
988 const char *saved_stream = PARSER_STREAM (parser);
989 linespec_token saved_token = parser->lexer.current;
990 int saved_completion_quote_char = parser->completion_quote_char;
991 const char *saved_completion_quote_end = parser->completion_quote_end;
992 const char *saved_completion_word = parser->completion_word;
994 next = linespec_lexer_consume_token (parser);
995 PARSER_STREAM (parser) = saved_stream;
996 parser->lexer.current = saved_token;
997 parser->completion_quote_char = saved_completion_quote_char;
998 parser->completion_quote_end = saved_completion_quote_end;
999 parser->completion_word = saved_completion_word;
1003 /* Helper functions. */
1005 /* Add SAL to SALS, and also update SELF->CANONICAL_NAMES to reflect
1006 the new sal, if needed. If not NULL, SYMNAME is the name of the
1007 symbol to use when constructing the new canonical name.
1009 If LITERAL_CANONICAL is non-zero, SYMNAME will be used as the
1010 canonical name for the SAL. */
1013 add_sal_to_sals (struct linespec_state *self,
1014 std::vector<symtab_and_line> *sals,
1015 struct symtab_and_line *sal,
1016 const char *symname, int literal_canonical)
1018 sals->push_back (*sal);
1020 if (self->canonical)
1022 struct linespec_canonical_name *canonical;
1024 self->canonical_names = XRESIZEVEC (struct linespec_canonical_name,
1025 self->canonical_names,
1027 canonical = &self->canonical_names[sals->size () - 1];
1028 if (!literal_canonical && sal->symtab)
1030 symtab_to_fullname (sal->symtab);
1032 /* Note that the filter doesn't have to be a valid linespec
1033 input. We only apply the ":LINE" treatment to Ada for
1035 if (symname != NULL && sal->line != 0
1036 && self->language->la_language == language_ada)
1037 canonical->suffix = xstrprintf ("%s:%d", symname, sal->line);
1038 else if (symname != NULL)
1039 canonical->suffix = xstrdup (symname);
1041 canonical->suffix = xstrprintf ("%d", sal->line);
1042 canonical->symtab = sal->symtab;
1046 if (symname != NULL)
1047 canonical->suffix = xstrdup (symname);
1049 canonical->suffix = xstrdup ("<unknown>");
1050 canonical->symtab = NULL;
1055 /* A hash function for address_entry. */
1058 hash_address_entry (const void *p)
1060 const struct address_entry *aep = (const struct address_entry *) p;
1063 hash = iterative_hash_object (aep->pspace, 0);
1064 return iterative_hash_object (aep->addr, hash);
1067 /* An equality function for address_entry. */
1070 eq_address_entry (const void *a, const void *b)
1072 const struct address_entry *aea = (const struct address_entry *) a;
1073 const struct address_entry *aeb = (const struct address_entry *) b;
1075 return aea->pspace == aeb->pspace && aea->addr == aeb->addr;
1078 /* Check whether the address, represented by PSPACE and ADDR, is
1079 already in the set. If so, return 0. Otherwise, add it and return
1083 maybe_add_address (htab_t set, struct program_space *pspace, CORE_ADDR addr)
1085 struct address_entry e, *p;
1090 slot = htab_find_slot (set, &e, INSERT);
1094 p = XNEW (struct address_entry);
1095 memcpy (p, &e, sizeof (struct address_entry));
1101 /* A helper that walks over all matching symtabs in all objfiles and
1102 calls CALLBACK for each symbol matching NAME. If SEARCH_PSPACE is
1103 not NULL, then the search is restricted to just that program
1104 space. If INCLUDE_INLINE is true then symbols representing
1105 inlined instances of functions will be included in the result. */
1108 iterate_over_all_matching_symtabs
1109 (struct linespec_state *state,
1110 const lookup_name_info &lookup_name,
1111 const domain_enum name_domain,
1112 enum search_domain search_domain,
1113 struct program_space *search_pspace, bool include_inline,
1114 gdb::function_view<symbol_found_callback_ftype> callback)
1116 struct objfile *objfile;
1117 struct program_space *pspace;
1119 ALL_PSPACES (pspace)
1121 if (search_pspace != NULL && search_pspace != pspace)
1123 if (pspace->executing_startup)
1126 set_current_program_space (pspace);
1128 ALL_OBJFILES (objfile)
1130 struct compunit_symtab *cu;
1133 objfile->sf->qf->expand_symtabs_matching (objfile,
1139 ALL_OBJFILE_COMPUNITS (objfile, cu)
1141 struct symtab *symtab = COMPUNIT_FILETABS (cu);
1143 iterate_over_file_blocks (symtab, lookup_name, name_domain, callback);
1147 struct block *block;
1150 for (i = FIRST_LOCAL_BLOCK;
1151 i < BLOCKVECTOR_NBLOCKS (SYMTAB_BLOCKVECTOR (symtab));
1154 block = BLOCKVECTOR_BLOCK (SYMTAB_BLOCKVECTOR (symtab), i);
1155 state->language->la_iterate_over_symbols
1156 (block, lookup_name, name_domain, [&] (symbol *sym)
1158 /* Restrict calls to CALLBACK to symbols
1159 representing inline symbols only. */
1160 if (SYMBOL_INLINED (sym))
1161 return callback (sym);
1171 /* Returns the block to be used for symbol searches from
1172 the current location. */
1174 static const struct block *
1175 get_current_search_block (void)
1177 const struct block *block;
1178 enum language save_language;
1180 /* get_selected_block can change the current language when there is
1181 no selected frame yet. */
1182 save_language = current_language->la_language;
1183 block = get_selected_block (0);
1184 set_language (save_language);
1189 /* Iterate over static and global blocks. */
1192 iterate_over_file_blocks
1193 (struct symtab *symtab, const lookup_name_info &name,
1194 domain_enum domain, gdb::function_view<symbol_found_callback_ftype> callback)
1196 struct block *block;
1198 for (block = BLOCKVECTOR_BLOCK (SYMTAB_BLOCKVECTOR (symtab), STATIC_BLOCK);
1200 block = BLOCK_SUPERBLOCK (block))
1201 LA_ITERATE_OVER_SYMBOLS (block, name, domain, callback);
1204 /* A helper for find_method. This finds all methods in type T of
1205 language T_LANG which match NAME. It adds matching symbol names to
1206 RESULT_NAMES, and adds T's direct superclasses to SUPERCLASSES. */
1209 find_methods (struct type *t, enum language t_lang, const char *name,
1210 std::vector<const char *> *result_names,
1211 std::vector<struct type *> *superclasses)
1214 const char *class_name = TYPE_NAME (t);
1216 /* Ignore this class if it doesn't have a name. This is ugly, but
1217 unless we figure out how to get the physname without the name of
1218 the class, then the loop can't do any good. */
1222 lookup_name_info lookup_name (name, symbol_name_match_type::FULL);
1223 symbol_name_matcher_ftype *symbol_name_compare
1224 = get_symbol_name_matcher (language_def (t_lang), lookup_name);
1226 t = check_typedef (t);
1228 /* Loop over each method name. At this level, all overloads of a name
1229 are counted as a single name. There is an inner loop which loops over
1232 for (method_counter = TYPE_NFN_FIELDS (t) - 1;
1233 method_counter >= 0;
1236 const char *method_name = TYPE_FN_FIELDLIST_NAME (t, method_counter);
1237 char dem_opname[64];
1239 if (startswith (method_name, "__") ||
1240 startswith (method_name, "op") ||
1241 startswith (method_name, "type"))
1243 if (cplus_demangle_opname (method_name, dem_opname, DMGL_ANSI))
1244 method_name = dem_opname;
1245 else if (cplus_demangle_opname (method_name, dem_opname, 0))
1246 method_name = dem_opname;
1249 if (symbol_name_compare (method_name, lookup_name, NULL))
1253 for (field_counter = (TYPE_FN_FIELDLIST_LENGTH (t, method_counter)
1259 const char *phys_name;
1261 f = TYPE_FN_FIELDLIST1 (t, method_counter);
1262 if (TYPE_FN_FIELD_STUB (f, field_counter))
1264 phys_name = TYPE_FN_FIELD_PHYSNAME (f, field_counter);
1265 result_names->push_back (phys_name);
1271 for (ibase = 0; ibase < TYPE_N_BASECLASSES (t); ibase++)
1272 superclasses->push_back (TYPE_BASECLASS (t, ibase));
1275 /* Find an instance of the character C in the string S that is outside
1276 of all parenthesis pairs, single-quoted strings, and double-quoted
1277 strings. Also, ignore the char within a template name, like a ','
1278 within foo<int, int>, while considering C++ operator</operator<<. */
1281 find_toplevel_char (const char *s, char c)
1283 int quoted = 0; /* zero if we're not in quotes;
1284 '"' if we're in a double-quoted string;
1285 '\'' if we're in a single-quoted string. */
1286 int depth = 0; /* Number of unclosed parens we've seen. */
1289 for (scan = s; *scan; scan++)
1293 if (*scan == quoted)
1295 else if (*scan == '\\' && *(scan + 1))
1298 else if (*scan == c && ! quoted && depth == 0)
1300 else if (*scan == '"' || *scan == '\'')
1302 else if (*scan == '(' || *scan == '<')
1304 else if ((*scan == ')' || *scan == '>') && depth > 0)
1306 else if (*scan == 'o' && !quoted && depth == 0)
1308 /* Handle C++ operator names. */
1309 if (strncmp (scan, CP_OPERATOR_STR, CP_OPERATOR_LEN) == 0)
1311 scan += CP_OPERATOR_LEN;
1314 while (isspace (*scan))
1325 /* Skip over one less than the appropriate number of
1326 characters: the for loop will skip over the last
1352 /* The string equivalent of find_toplevel_char. Returns a pointer
1353 to the location of NEEDLE in HAYSTACK, ignoring any occurrences
1354 inside "()" and "<>". Returns NULL if NEEDLE was not found. */
1357 find_toplevel_string (const char *haystack, const char *needle)
1359 const char *s = haystack;
1363 s = find_toplevel_char (s, *needle);
1367 /* Found first char in HAYSTACK; check rest of string. */
1368 if (startswith (s, needle))
1371 /* Didn't find it; loop over HAYSTACK, looking for the next
1372 instance of the first character of NEEDLE. */
1376 while (s != NULL && *s != '\0');
1378 /* NEEDLE was not found in HAYSTACK. */
1382 /* Convert CANONICAL to its string representation using
1383 symtab_to_fullname for SYMTAB. */
1386 canonical_to_fullform (const struct linespec_canonical_name *canonical)
1388 if (canonical->symtab == NULL)
1389 return canonical->suffix;
1391 return string_printf ("%s:%s", symtab_to_fullname (canonical->symtab),
1395 /* Given FILTERS, a list of canonical names, filter the sals in RESULT
1396 and store the result in SELF->CANONICAL. */
1399 filter_results (struct linespec_state *self,
1400 std::vector<symtab_and_line> *result,
1401 const std::vector<const char *> &filters)
1403 for (const char *name : filters)
1407 for (size_t j = 0; j < result->size (); ++j)
1409 const struct linespec_canonical_name *canonical;
1411 canonical = &self->canonical_names[j];
1412 std::string fullform = canonical_to_fullform (canonical);
1414 if (name == fullform)
1415 lsal.sals.push_back ((*result)[j]);
1418 if (!lsal.sals.empty ())
1420 lsal.canonical = xstrdup (name);
1421 self->canonical->lsals.push_back (std::move (lsal));
1425 self->canonical->pre_expanded = 0;
1428 /* Store RESULT into SELF->CANONICAL. */
1431 convert_results_to_lsals (struct linespec_state *self,
1432 std::vector<symtab_and_line> *result)
1434 struct linespec_sals lsal;
1436 lsal.canonical = NULL;
1437 lsal.sals = std::move (*result);
1438 self->canonical->lsals.push_back (std::move (lsal));
1441 /* A structure that contains two string representations of a struct
1442 linespec_canonical_name:
1443 - one where the the symtab's fullname is used;
1444 - one where the filename followed the "set filename-display"
1447 struct decode_line_2_item
1449 decode_line_2_item (std::string &&fullform_, std::string &&displayform_,
1451 : fullform (std::move (fullform_)),
1452 displayform (std::move (displayform_)),
1453 selected (selected_)
1457 /* The form using symtab_to_fullname. */
1458 std::string fullform;
1460 /* The form using symtab_to_filename_for_display. */
1461 std::string displayform;
1463 /* Field is initialized to zero and it is set to one if the user
1464 requested breakpoint for this entry. */
1465 unsigned int selected : 1;
1468 /* Helper for std::sort to sort decode_line_2_item entries by
1469 DISPLAYFORM and secondarily by FULLFORM. */
1472 decode_line_2_compare_items (const decode_line_2_item &a,
1473 const decode_line_2_item &b)
1475 if (a.displayform != b.displayform)
1476 return a.displayform < b.displayform;
1477 return a.fullform < b.fullform;
1480 /* Handle multiple results in RESULT depending on SELECT_MODE. This
1481 will either return normally, throw an exception on multiple
1482 results, or present a menu to the user. On return, the SALS vector
1483 in SELF->CANONICAL is set up properly. */
1486 decode_line_2 (struct linespec_state *self,
1487 std::vector<symtab_and_line> *result,
1488 const char *select_mode)
1493 std::vector<const char *> filters;
1494 std::vector<struct decode_line_2_item> items;
1496 gdb_assert (select_mode != multiple_symbols_all);
1497 gdb_assert (self->canonical != NULL);
1498 gdb_assert (!result->empty ());
1500 /* Prepare ITEMS array. */
1501 for (i = 0; i < result->size (); ++i)
1503 const struct linespec_canonical_name *canonical;
1504 struct decode_line_2_item *item;
1506 std::string displayform;
1508 canonical = &self->canonical_names[i];
1509 gdb_assert (canonical->suffix != NULL);
1511 std::string fullform = canonical_to_fullform (canonical);
1513 if (canonical->symtab == NULL)
1514 displayform = canonical->suffix;
1517 const char *fn_for_display;
1519 fn_for_display = symtab_to_filename_for_display (canonical->symtab);
1520 displayform = string_printf ("%s:%s", fn_for_display,
1524 items.emplace_back (std::move (fullform), std::move (displayform),
1528 /* Sort the list of method names. */
1529 std::sort (items.begin (), items.end (), decode_line_2_compare_items);
1531 /* Remove entries with the same FULLFORM. */
1532 items.erase (std::unique (items.begin (), items.end (),
1533 [] (const struct decode_line_2_item &a,
1534 const struct decode_line_2_item &b)
1536 return a.fullform == b.fullform;
1540 if (select_mode == multiple_symbols_cancel && items.size () > 1)
1541 error (_("canceled because the command is ambiguous\n"
1542 "See set/show multiple-symbol."));
1544 if (select_mode == multiple_symbols_all || items.size () == 1)
1546 convert_results_to_lsals (self, result);
1550 printf_unfiltered (_("[0] cancel\n[1] all\n"));
1551 for (i = 0; i < items.size (); i++)
1552 printf_unfiltered ("[%d] %s\n", i + 2, items[i].displayform.c_str ());
1554 prompt = getenv ("PS2");
1559 args = command_line_input (prompt, "overload-choice");
1561 if (args == 0 || *args == 0)
1562 error_no_arg (_("one or more choice numbers"));
1564 number_or_range_parser parser (args);
1565 while (!parser.finished ())
1567 int num = parser.get_number ();
1570 error (_("canceled"));
1573 /* We intentionally make this result in a single breakpoint,
1574 contrary to what older versions of gdb did. The
1575 rationale is that this lets a user get the
1576 multiple_symbols_all behavior even with the 'ask'
1577 setting; and he can get separate breakpoints by entering
1578 "2-57" at the query. */
1579 convert_results_to_lsals (self, result);
1584 if (num >= items.size ())
1585 printf_unfiltered (_("No choice number %d.\n"), num);
1588 struct decode_line_2_item *item = &items[num];
1590 if (!item->selected)
1592 filters.push_back (item->fullform.c_str ());
1597 printf_unfiltered (_("duplicate request for %d ignored.\n"),
1603 filter_results (self, result, filters);
1608 /* The parser of linespec itself. */
1610 /* Throw an appropriate error when SYMBOL is not found (optionally in
1613 static void ATTRIBUTE_NORETURN
1614 symbol_not_found_error (const char *symbol, const char *filename)
1619 if (!have_full_symbols ()
1620 && !have_partial_symbols ()
1621 && !have_minimal_symbols ())
1622 throw_error (NOT_FOUND_ERROR,
1623 _("No symbol table is loaded. Use the \"file\" command."));
1625 /* If SYMBOL starts with '$', the user attempted to either lookup
1626 a function/variable in his code starting with '$' or an internal
1627 variable of that name. Since we do not know which, be concise and
1628 explain both possibilities. */
1632 throw_error (NOT_FOUND_ERROR,
1633 _("Undefined convenience variable or function \"%s\" "
1634 "not defined in \"%s\"."), symbol, filename);
1636 throw_error (NOT_FOUND_ERROR,
1637 _("Undefined convenience variable or function \"%s\" "
1638 "not defined."), symbol);
1643 throw_error (NOT_FOUND_ERROR,
1644 _("Function \"%s\" not defined in \"%s\"."),
1647 throw_error (NOT_FOUND_ERROR,
1648 _("Function \"%s\" not defined."), symbol);
1652 /* Throw an appropriate error when an unexpected token is encountered
1655 static void ATTRIBUTE_NORETURN
1656 unexpected_linespec_error (linespec_parser *parser)
1658 linespec_token token;
1659 static const char * token_type_strings[]
1660 = {"keyword", "colon", "string", "number", "comma", "end of input"};
1662 /* Get the token that generated the error. */
1663 token = linespec_lexer_lex_one (parser);
1665 /* Finally, throw the error. */
1666 if (token.type == LSTOKEN_STRING || token.type == LSTOKEN_NUMBER
1667 || token.type == LSTOKEN_KEYWORD)
1669 gdb::unique_xmalloc_ptr<char> string = copy_token_string (token);
1670 throw_error (GENERIC_ERROR,
1671 _("malformed linespec error: unexpected %s, \"%s\""),
1672 token_type_strings[token.type], string.get ());
1675 throw_error (GENERIC_ERROR,
1676 _("malformed linespec error: unexpected %s"),
1677 token_type_strings[token.type]);
1680 /* Throw an undefined label error. */
1682 static void ATTRIBUTE_NORETURN
1683 undefined_label_error (const char *function, const char *label)
1685 if (function != NULL)
1686 throw_error (NOT_FOUND_ERROR,
1687 _("No label \"%s\" defined in function \"%s\"."),
1690 throw_error (NOT_FOUND_ERROR,
1691 _("No label \"%s\" defined in current function."),
1695 /* Throw a source file not found error. */
1697 static void ATTRIBUTE_NORETURN
1698 source_file_not_found_error (const char *name)
1700 throw_error (NOT_FOUND_ERROR, _("No source file named %s."), name);
1703 /* Unless at EIO, save the current stream position as completion word
1704 point, and consume the next token. */
1706 static linespec_token
1707 save_stream_and_consume_token (linespec_parser *parser)
1709 if (linespec_lexer_peek_token (parser).type != LSTOKEN_EOI)
1710 parser->completion_word = PARSER_STREAM (parser);
1711 return linespec_lexer_consume_token (parser);
1714 /* See description in linespec.h. */
1717 linespec_parse_line_offset (const char *string)
1719 const char *start = string;
1720 struct line_offset line_offset = {0, LINE_OFFSET_NONE};
1724 line_offset.sign = LINE_OFFSET_PLUS;
1727 else if (*string == '-')
1729 line_offset.sign = LINE_OFFSET_MINUS;
1733 if (*string != '\0' && !isdigit (*string))
1734 error (_("malformed line offset: \"%s\""), start);
1736 /* Right now, we only allow base 10 for offsets. */
1737 line_offset.offset = atoi (string);
1741 /* In completion mode, if the user is still typing the number, there's
1742 no possible completion to offer. But if there's already input past
1743 the number, setup to expect NEXT. */
1746 set_completion_after_number (linespec_parser *parser,
1747 linespec_complete_what next)
1749 if (*PARSER_STREAM (parser) == ' ')
1751 parser->completion_word = skip_spaces (PARSER_STREAM (parser) + 1);
1752 parser->complete_what = next;
1756 parser->completion_word = PARSER_STREAM (parser);
1757 parser->complete_what = linespec_complete_what::NOTHING;
1761 /* Parse the basic_spec in PARSER's input. */
1764 linespec_parse_basic (linespec_parser *parser)
1766 gdb::unique_xmalloc_ptr<char> name;
1767 linespec_token token;
1768 VEC (symbolp) *symbols, *labels;
1769 VEC (bound_minimal_symbol_d) *minimal_symbols;
1771 /* Get the next token. */
1772 token = linespec_lexer_lex_one (parser);
1774 /* If it is EOI or KEYWORD, issue an error. */
1775 if (token.type == LSTOKEN_KEYWORD)
1777 parser->complete_what = linespec_complete_what::NOTHING;
1778 unexpected_linespec_error (parser);
1780 else if (token.type == LSTOKEN_EOI)
1782 unexpected_linespec_error (parser);
1784 /* If it is a LSTOKEN_NUMBER, we have an offset. */
1785 else if (token.type == LSTOKEN_NUMBER)
1787 set_completion_after_number (parser, linespec_complete_what::KEYWORD);
1789 /* Record the line offset and get the next token. */
1790 name = copy_token_string (token);
1791 PARSER_EXPLICIT (parser)->line_offset
1792 = linespec_parse_line_offset (name.get ());
1794 /* Get the next token. */
1795 token = linespec_lexer_consume_token (parser);
1797 /* If the next token is a comma, stop parsing and return. */
1798 if (token.type == LSTOKEN_COMMA)
1800 parser->complete_what = linespec_complete_what::NOTHING;
1804 /* If the next token is anything but EOI or KEYWORD, issue
1806 if (token.type != LSTOKEN_KEYWORD && token.type != LSTOKEN_EOI)
1807 unexpected_linespec_error (parser);
1810 if (token.type == LSTOKEN_KEYWORD || token.type == LSTOKEN_EOI)
1813 /* Next token must be LSTOKEN_STRING. */
1814 if (token.type != LSTOKEN_STRING)
1816 parser->complete_what = linespec_complete_what::NOTHING;
1817 unexpected_linespec_error (parser);
1820 /* The current token will contain the name of a function, method,
1822 name = copy_token_string (token);
1824 if (parser->completion_tracker != NULL)
1826 /* If the function name ends with a ":", then this may be an
1827 incomplete "::" scope operator instead of a label separator.
1830 which should expand to:
1833 Do a tentative completion assuming the later. If we find
1834 completions, advance the stream past the colon token and make
1835 it part of the function name/token. */
1837 if (!parser->completion_quote_char
1838 && strcmp (PARSER_STREAM (parser), ":") == 0)
1840 completion_tracker tmp_tracker;
1841 const char *source_filename
1842 = PARSER_EXPLICIT (parser)->source_filename;
1843 symbol_name_match_type match_type
1844 = PARSER_EXPLICIT (parser)->func_name_match_type;
1846 linespec_complete_function (tmp_tracker,
1847 parser->completion_word,
1851 if (tmp_tracker.have_completions ())
1853 PARSER_STREAM (parser)++;
1854 LS_TOKEN_STOKEN (token).length++;
1856 name.reset (savestring (parser->completion_word,
1857 (PARSER_STREAM (parser)
1858 - parser->completion_word)));
1862 PARSER_EXPLICIT (parser)->function_name = name.release ();
1866 /* Try looking it up as a function/method. */
1867 find_linespec_symbols (PARSER_STATE (parser),
1868 PARSER_RESULT (parser)->file_symtabs, name.get (),
1869 PARSER_EXPLICIT (parser)->func_name_match_type,
1870 &symbols, &minimal_symbols);
1872 if (symbols != NULL || minimal_symbols != NULL)
1874 PARSER_RESULT (parser)->function_symbols = symbols;
1875 PARSER_RESULT (parser)->minimal_symbols = minimal_symbols;
1876 PARSER_EXPLICIT (parser)->function_name = name.release ();
1881 /* NAME was not a function or a method. So it must be a label
1882 name or user specified variable like "break foo.c:$zippo". */
1883 labels = find_label_symbols (PARSER_STATE (parser), NULL,
1884 &symbols, name.get ());
1887 PARSER_RESULT (parser)->labels.label_symbols = labels;
1888 PARSER_RESULT (parser)->labels.function_symbols = symbols;
1889 PARSER_EXPLICIT (parser)->label_name = name.release ();
1892 else if (token.type == LSTOKEN_STRING
1893 && *LS_TOKEN_STOKEN (token).ptr == '$')
1895 /* User specified a convenience variable or history value. */
1896 PARSER_EXPLICIT (parser)->line_offset
1897 = linespec_parse_variable (PARSER_STATE (parser), name.get ());
1899 if (PARSER_EXPLICIT (parser)->line_offset.sign == LINE_OFFSET_UNKNOWN)
1901 /* The user-specified variable was not valid. Do not
1902 throw an error here. parse_linespec will do it for us. */
1903 PARSER_EXPLICIT (parser)->function_name = name.release ();
1909 /* The name is also not a label. Abort parsing. Do not throw
1910 an error here. parse_linespec will do it for us. */
1912 /* Save a copy of the name we were trying to lookup. */
1913 PARSER_EXPLICIT (parser)->function_name = name.release ();
1919 int previous_qc = parser->completion_quote_char;
1921 /* Get the next token. */
1922 token = linespec_lexer_consume_token (parser);
1924 if (token.type == LSTOKEN_EOI)
1926 if (previous_qc && !parser->completion_quote_char)
1927 parser->complete_what = linespec_complete_what::KEYWORD;
1929 else if (token.type == LSTOKEN_COLON)
1931 /* User specified a label or a lineno. */
1932 token = linespec_lexer_consume_token (parser);
1934 if (token.type == LSTOKEN_NUMBER)
1936 /* User specified an offset. Record the line offset and
1937 get the next token. */
1938 set_completion_after_number (parser, linespec_complete_what::KEYWORD);
1940 name = copy_token_string (token);
1941 PARSER_EXPLICIT (parser)->line_offset
1942 = linespec_parse_line_offset (name.get ());
1944 /* Get the next token. */
1945 token = linespec_lexer_consume_token (parser);
1947 else if (token.type == LSTOKEN_EOI && parser->completion_tracker != NULL)
1949 parser->complete_what = linespec_complete_what::LABEL;
1951 else if (token.type == LSTOKEN_STRING)
1953 parser->complete_what = linespec_complete_what::LABEL;
1955 /* If we have text after the label separated by whitespace
1956 (e.g., "b func():lab i<tab>"), don't consider it part of
1957 the label. In completion mode that should complete to
1958 "if", in normal mode, the 'i' should be treated as
1960 if (parser->completion_quote_char == '\0')
1962 const char *ptr = LS_TOKEN_STOKEN (token).ptr;
1963 for (size_t i = 0; i < LS_TOKEN_STOKEN (token).length; i++)
1967 LS_TOKEN_STOKEN (token).length = i;
1968 PARSER_STREAM (parser) = skip_spaces (ptr + i + 1);
1974 if (parser->completion_tracker != NULL)
1976 if (PARSER_STREAM (parser)[-1] == ' ')
1978 parser->completion_word = PARSER_STREAM (parser);
1979 parser->complete_what = linespec_complete_what::KEYWORD;
1984 /* Grab a copy of the label's name and look it up. */
1985 name = copy_token_string (token);
1987 = find_label_symbols (PARSER_STATE (parser),
1988 PARSER_RESULT (parser)->function_symbols,
1989 &symbols, name.get ());
1993 PARSER_RESULT (parser)->labels.label_symbols = labels;
1994 PARSER_RESULT (parser)->labels.function_symbols = symbols;
1995 PARSER_EXPLICIT (parser)->label_name = name.release ();
2000 /* We don't know what it was, but it isn't a label. */
2001 undefined_label_error
2002 (PARSER_EXPLICIT (parser)->function_name, name.get ());
2007 /* Check for a line offset. */
2008 token = save_stream_and_consume_token (parser);
2009 if (token.type == LSTOKEN_COLON)
2011 /* Get the next token. */
2012 token = linespec_lexer_consume_token (parser);
2014 /* It must be a line offset. */
2015 if (token.type != LSTOKEN_NUMBER)
2016 unexpected_linespec_error (parser);
2018 /* Record the line offset and get the next token. */
2019 name = copy_token_string (token);
2021 PARSER_EXPLICIT (parser)->line_offset
2022 = linespec_parse_line_offset (name.get ());
2024 /* Get the next token. */
2025 token = linespec_lexer_consume_token (parser);
2030 /* Trailing ':' in the input. Issue an error. */
2031 unexpected_linespec_error (parser);
2036 /* Canonicalize the linespec contained in LS. The result is saved into
2037 STATE->canonical. This function handles both linespec and explicit
2041 canonicalize_linespec (struct linespec_state *state, const linespec_p ls)
2043 struct event_location *canon;
2044 struct explicit_location *explicit_loc;
2046 /* If canonicalization was not requested, no need to do anything. */
2047 if (!state->canonical)
2050 /* Save everything as an explicit location. */
2051 state->canonical->location
2052 = new_explicit_location (&ls->explicit_loc);
2053 canon = state->canonical->location.get ();
2054 explicit_loc = get_explicit_location (canon);
2056 if (explicit_loc->label_name != NULL)
2058 state->canonical->special_display = 1;
2060 if (explicit_loc->function_name == NULL)
2064 /* No function was specified, so add the symbol name. */
2065 gdb_assert (ls->labels.function_symbols != NULL
2066 && (VEC_length (symbolp, ls->labels.function_symbols)
2068 s = VEC_index (symbolp, ls->labels.function_symbols, 0);
2069 explicit_loc->function_name = xstrdup (SYMBOL_NATURAL_NAME (s));
2073 /* If this location originally came from a linespec, save a string
2074 representation of it for display and saving to file. */
2075 if (state->is_linespec)
2077 char *linespec = explicit_location_to_linespec (explicit_loc);
2079 set_event_location_string (canon, linespec);
2084 /* Given a line offset in LS, construct the relevant SALs. */
2086 static std::vector<symtab_and_line>
2087 create_sals_line_offset (struct linespec_state *self,
2090 int use_default = 0;
2092 /* This is where we need to make sure we have good defaults.
2093 We must guarantee that this section of code is never executed
2094 when we are called with just a function name, since
2095 set_default_source_symtab_and_line uses
2096 select_source_symtab that calls us with such an argument. */
2098 if (VEC_length (symtab_ptr, ls->file_symtabs) == 1
2099 && VEC_index (symtab_ptr, ls->file_symtabs, 0) == NULL)
2101 const char *fullname;
2103 set_current_program_space (self->program_space);
2105 /* Make sure we have at least a default source line. */
2106 set_default_source_symtab_and_line ();
2107 initialize_defaults (&self->default_symtab, &self->default_line);
2108 fullname = symtab_to_fullname (self->default_symtab);
2109 VEC_pop (symtab_ptr, ls->file_symtabs);
2110 VEC_free (symtab_ptr, ls->file_symtabs);
2111 ls->file_symtabs = collect_symtabs_from_filename (fullname,
2112 self->search_pspace);
2116 symtab_and_line val;
2117 val.line = ls->explicit_loc.line_offset.offset;
2118 switch (ls->explicit_loc.line_offset.sign)
2120 case LINE_OFFSET_PLUS:
2121 if (ls->explicit_loc.line_offset.offset == 0)
2124 val.line = self->default_line + val.line;
2127 case LINE_OFFSET_MINUS:
2128 if (ls->explicit_loc.line_offset.offset == 0)
2131 val.line = self->default_line - val.line;
2133 val.line = -val.line;
2136 case LINE_OFFSET_NONE:
2137 break; /* No need to adjust val.line. */
2140 std::vector<symtab_and_line> values;
2141 if (self->list_mode)
2142 values = decode_digits_list_mode (self, ls, val);
2145 struct linetable_entry *best_entry = NULL;
2148 std::vector<symtab_and_line> intermediate_results
2149 = decode_digits_ordinary (self, ls, val.line, &best_entry);
2150 if (intermediate_results.empty () && best_entry != NULL)
2151 intermediate_results = decode_digits_ordinary (self, ls,
2155 /* For optimized code, the compiler can scatter one source line
2156 across disjoint ranges of PC values, even when no duplicate
2157 functions or inline functions are involved. For example,
2158 'for (;;)' inside a non-template, non-inline, and non-ctor-or-dtor
2159 function can result in two PC ranges. In this case, we don't
2160 want to set a breakpoint on the first PC of each range. To filter
2161 such cases, we use containing blocks -- for each PC found
2162 above, we see if there are other PCs that are in the same
2163 block. If yes, the other PCs are filtered out. */
2165 gdb::def_vector<int> filter (intermediate_results.size ());
2166 gdb::def_vector<const block *> blocks (intermediate_results.size ());
2168 for (i = 0; i < intermediate_results.size (); ++i)
2170 set_current_program_space (intermediate_results[i].pspace);
2173 blocks[i] = block_for_pc_sect (intermediate_results[i].pc,
2174 intermediate_results[i].section);
2177 for (i = 0; i < intermediate_results.size (); ++i)
2179 if (blocks[i] != NULL)
2180 for (j = i + 1; j < intermediate_results.size (); ++j)
2182 if (blocks[j] == blocks[i])
2190 for (i = 0; i < intermediate_results.size (); ++i)
2193 struct symbol *sym = (blocks[i]
2194 ? block_containing_function (blocks[i])
2197 if (self->funfirstline)
2198 skip_prologue_sal (&intermediate_results[i]);
2199 intermediate_results[i].symbol = sym;
2200 add_sal_to_sals (self, &values, &intermediate_results[i],
2201 sym ? SYMBOL_NATURAL_NAME (sym) : NULL, 0);
2205 if (values.empty ())
2207 if (ls->explicit_loc.source_filename)
2208 throw_error (NOT_FOUND_ERROR, _("No line %d in file \"%s\"."),
2209 val.line, ls->explicit_loc.source_filename);
2211 throw_error (NOT_FOUND_ERROR, _("No line %d in the current file."),
2218 /* Convert the given ADDRESS into SaLs. */
2220 static std::vector<symtab_and_line>
2221 convert_address_location_to_sals (struct linespec_state *self,
2224 symtab_and_line sal = find_pc_line (address, 0);
2226 sal.section = find_pc_overlay (address);
2227 sal.explicit_pc = 1;
2228 sal.symbol = find_pc_sect_containing_function (sal.pc, sal.section);
2230 std::vector<symtab_and_line> sals;
2231 add_sal_to_sals (self, &sals, &sal, core_addr_to_string (address), 1);
2236 /* Create and return SALs from the linespec LS. */
2238 static std::vector<symtab_and_line>
2239 convert_linespec_to_sals (struct linespec_state *state, linespec_p ls)
2241 std::vector<symtab_and_line> sals;
2243 if (ls->labels.label_symbols != NULL)
2245 /* We have just a bunch of functions/methods or labels. */
2247 struct symtab_and_line sal;
2250 for (i = 0; VEC_iterate (symbolp, ls->labels.label_symbols, i, sym); ++i)
2252 struct program_space *pspace = SYMTAB_PSPACE (symbol_symtab (sym));
2254 if (symbol_to_sal (&sal, state->funfirstline, sym)
2255 && maybe_add_address (state->addr_set, pspace, sal.pc))
2256 add_sal_to_sals (state, &sals, &sal,
2257 SYMBOL_NATURAL_NAME (sym), 0);
2260 else if (ls->function_symbols != NULL || ls->minimal_symbols != NULL)
2262 /* We have just a bunch of functions and/or methods. */
2263 if (ls->function_symbols != NULL)
2265 /* Sort symbols so that symbols with the same program space are next
2267 qsort (VEC_address (symbolp, ls->function_symbols),
2268 VEC_length (symbolp, ls->function_symbols),
2269 sizeof (symbolp), compare_symbols);
2272 for (int i = 0; VEC_iterate (symbolp, ls->function_symbols, i, sym); ++i)
2274 program_space *pspace = SYMTAB_PSPACE (symbol_symtab (sym));
2275 set_current_program_space (pspace);
2277 /* Don't skip to the first line of the function if we
2278 had found an ifunc minimal symbol for this function,
2279 because that means that this function is an ifunc
2280 resolver with the same name as the ifunc itself. */
2281 bool found_ifunc = false;
2283 if (state->funfirstline
2284 && ls->minimal_symbols != NULL
2285 && SYMBOL_CLASS (sym) == LOC_BLOCK)
2287 const CORE_ADDR addr
2288 = BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym));
2290 bound_minimal_symbol_d *elem;
2292 VEC_iterate (bound_minimal_symbol_d, ls->minimal_symbols,
2296 if (MSYMBOL_TYPE (elem->minsym) == mst_text_gnu_ifunc
2297 || MSYMBOL_TYPE (elem->minsym) == mst_data_gnu_ifunc)
2299 CORE_ADDR msym_addr = BMSYMBOL_VALUE_ADDRESS (*elem);
2300 if (MSYMBOL_TYPE (elem->minsym) == mst_data_gnu_ifunc)
2302 struct gdbarch *gdbarch
2303 = get_objfile_arch (elem->objfile);
2305 = (gdbarch_convert_from_func_ptr_addr
2308 current_top_target ()));
2311 if (msym_addr == addr)
2322 symtab_and_line sal;
2323 if (symbol_to_sal (&sal, state->funfirstline, sym)
2324 && maybe_add_address (state->addr_set, pspace, sal.pc))
2325 add_sal_to_sals (state, &sals, &sal,
2326 SYMBOL_NATURAL_NAME (sym), 0);
2331 if (ls->minimal_symbols != NULL)
2333 /* Sort minimal symbols by program space, too */
2334 qsort (VEC_address (bound_minimal_symbol_d, ls->minimal_symbols),
2335 VEC_length (bound_minimal_symbol_d, ls->minimal_symbols),
2336 sizeof (bound_minimal_symbol_d), compare_msymbols);
2338 bound_minimal_symbol_d *elem;
2341 VEC_iterate (bound_minimal_symbol_d, ls->minimal_symbols,
2345 program_space *pspace = elem->objfile->pspace;
2346 set_current_program_space (pspace);
2347 minsym_found (state, elem->objfile, elem->minsym, &sals);
2351 else if (ls->explicit_loc.line_offset.sign != LINE_OFFSET_UNKNOWN)
2353 /* Only an offset was specified. */
2354 sals = create_sals_line_offset (state, ls);
2356 /* Make sure we have a filename for canonicalization. */
2357 if (ls->explicit_loc.source_filename == NULL)
2359 const char *fullname = symtab_to_fullname (state->default_symtab);
2361 /* It may be more appropriate to keep DEFAULT_SYMTAB in its symtab
2362 form so that displaying SOURCE_FILENAME can follow the current
2363 FILENAME_DISPLAY_STRING setting. But as it is used only rarely
2364 it has been kept for code simplicity only in absolute form. */
2365 ls->explicit_loc.source_filename = xstrdup (fullname);
2370 /* We haven't found any results... */
2374 canonicalize_linespec (state, ls);
2376 if (!sals.empty () && state->canonical != NULL)
2377 state->canonical->pre_expanded = 1;
2382 /* Build RESULT from the explicit location components SOURCE_FILENAME,
2383 FUNCTION_NAME, LABEL_NAME and LINE_OFFSET. */
2386 convert_explicit_location_to_linespec (struct linespec_state *self,
2388 const char *source_filename,
2389 const char *function_name,
2390 symbol_name_match_type fname_match_type,
2391 const char *label_name,
2392 struct line_offset line_offset)
2394 VEC (symbolp) *symbols, *labels;
2395 VEC (bound_minimal_symbol_d) *minimal_symbols;
2397 result->explicit_loc.func_name_match_type = fname_match_type;
2399 if (source_filename != NULL)
2403 result->file_symtabs
2404 = symtabs_from_filename (source_filename, self->search_pspace);
2406 CATCH (except, RETURN_MASK_ERROR)
2408 source_file_not_found_error (source_filename);
2411 result->explicit_loc.source_filename = xstrdup (source_filename);
2415 /* A NULL entry means to use the default symtab. */
2416 VEC_safe_push (symtab_ptr, result->file_symtabs, NULL);
2419 if (function_name != NULL)
2421 find_linespec_symbols (self, result->file_symtabs,
2422 function_name, fname_match_type,
2423 &symbols, &minimal_symbols);
2425 if (symbols == NULL && minimal_symbols == NULL)
2426 symbol_not_found_error (function_name,
2427 result->explicit_loc.source_filename);
2429 result->explicit_loc.function_name = xstrdup (function_name);
2430 result->function_symbols = symbols;
2431 result->minimal_symbols = minimal_symbols;
2434 if (label_name != NULL)
2437 labels = find_label_symbols (self, result->function_symbols,
2438 &symbols, label_name);
2441 undefined_label_error (result->explicit_loc.function_name,
2444 result->explicit_loc.label_name = xstrdup (label_name);
2445 result->labels.label_symbols = labels;
2446 result->labels.function_symbols = symbols;
2449 if (line_offset.sign != LINE_OFFSET_UNKNOWN)
2450 result->explicit_loc.line_offset = line_offset;
2453 /* Convert the explicit location EXPLICIT_LOC into SaLs. */
2455 static std::vector<symtab_and_line>
2456 convert_explicit_location_to_sals (struct linespec_state *self,
2458 const struct explicit_location *explicit_loc)
2460 convert_explicit_location_to_linespec (self, result,
2461 explicit_loc->source_filename,
2462 explicit_loc->function_name,
2463 explicit_loc->func_name_match_type,
2464 explicit_loc->label_name,
2465 explicit_loc->line_offset);
2466 return convert_linespec_to_sals (self, result);
2469 /* Parse a string that specifies a linespec.
2471 The basic grammar of linespecs:
2473 linespec -> var_spec | basic_spec
2474 var_spec -> '$' (STRING | NUMBER)
2476 basic_spec -> file_offset_spec | function_spec | label_spec
2477 file_offset_spec -> opt_file_spec offset_spec
2478 function_spec -> opt_file_spec function_name_spec opt_label_spec
2479 label_spec -> label_name_spec
2481 opt_file_spec -> "" | file_name_spec ':'
2482 opt_label_spec -> "" | ':' label_name_spec
2484 file_name_spec -> STRING
2485 function_name_spec -> STRING
2486 label_name_spec -> STRING
2487 function_name_spec -> STRING
2488 offset_spec -> NUMBER
2492 This may all be followed by several keywords such as "if EXPR",
2495 A comma will terminate parsing.
2497 The function may be an undebuggable function found in minimal symbol table.
2499 If the argument FUNFIRSTLINE is nonzero, we want the first line
2500 of real code inside a function when a function is specified, and it is
2501 not OK to specify a variable or type to get its line number.
2503 DEFAULT_SYMTAB specifies the file to use if none is specified.
2504 It defaults to current_source_symtab.
2505 DEFAULT_LINE specifies the line number to use for relative
2506 line numbers (that start with signs). Defaults to current_source_line.
2507 If CANONICAL is non-NULL, store an array of strings containing the canonical
2508 line specs there if necessary. Currently overloaded member functions and
2509 line numbers or static functions without a filename yield a canonical
2510 line spec. The array and the line spec strings are allocated on the heap,
2511 it is the callers responsibility to free them.
2513 Note that it is possible to return zero for the symtab
2514 if no file is validly specified. Callers must check that.
2515 Also, the line number returned may be invalid. */
2517 /* Parse the linespec in ARG. MATCH_TYPE indicates how function names
2518 should be matched. */
2520 static std::vector<symtab_and_line>
2521 parse_linespec (linespec_parser *parser, const char *arg,
2522 symbol_name_match_type match_type)
2524 linespec_token token;
2525 struct gdb_exception file_exception = exception_none;
2527 /* A special case to start. It has become quite popular for
2528 IDEs to work around bugs in the previous parser by quoting
2529 the entire linespec, so we attempt to deal with this nicely. */
2530 parser->is_quote_enclosed = 0;
2531 if (parser->completion_tracker == NULL
2532 && !is_ada_operator (arg)
2533 && strchr (linespec_quote_characters, *arg) != NULL)
2537 end = skip_quote_char (arg + 1, *arg);
2538 if (end != NULL && is_closing_quote_enclosed (end))
2540 /* Here's the special case. Skip ARG past the initial
2543 parser->is_quote_enclosed = 1;
2547 parser->lexer.saved_arg = arg;
2548 parser->lexer.stream = arg;
2549 parser->completion_word = arg;
2550 parser->complete_what = linespec_complete_what::FUNCTION;
2551 PARSER_EXPLICIT (parser)->func_name_match_type = match_type;
2553 /* Initialize the default symtab and line offset. */
2554 initialize_defaults (&PARSER_STATE (parser)->default_symtab,
2555 &PARSER_STATE (parser)->default_line);
2557 /* Objective-C shortcut. */
2558 if (parser->completion_tracker == NULL)
2560 std::vector<symtab_and_line> values
2561 = decode_objc (PARSER_STATE (parser), PARSER_RESULT (parser), arg);
2562 if (!values.empty ())
2567 /* "-"/"+" is either an objc selector, or a number. There's
2568 nothing to complete the latter to, so just let the caller
2569 complete on functions, which finds objc selectors, if there's
2571 if ((arg[0] == '-' || arg[0] == '+') && arg[1] == '\0')
2575 /* Start parsing. */
2577 /* Get the first token. */
2578 token = linespec_lexer_consume_token (parser);
2580 /* It must be either LSTOKEN_STRING or LSTOKEN_NUMBER. */
2581 if (token.type == LSTOKEN_STRING && *LS_TOKEN_STOKEN (token).ptr == '$')
2583 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2584 if (parser->completion_tracker == NULL)
2585 VEC_safe_push (symtab_ptr, PARSER_RESULT (parser)->file_symtabs, NULL);
2587 /* User specified a convenience variable or history value. */
2588 gdb::unique_xmalloc_ptr<char> var = copy_token_string (token);
2589 PARSER_EXPLICIT (parser)->line_offset
2590 = linespec_parse_variable (PARSER_STATE (parser), var.get ());
2592 /* If a line_offset wasn't found (VAR is the name of a user
2593 variable/function), then skip to normal symbol processing. */
2594 if (PARSER_EXPLICIT (parser)->line_offset.sign != LINE_OFFSET_UNKNOWN)
2596 /* Consume this token. */
2597 linespec_lexer_consume_token (parser);
2599 goto convert_to_sals;
2602 else if (token.type == LSTOKEN_EOI && parser->completion_tracker != NULL)
2604 /* Let the default linespec_complete_what::FUNCTION kick in. */
2605 unexpected_linespec_error (parser);
2607 else if (token.type != LSTOKEN_STRING && token.type != LSTOKEN_NUMBER)
2609 parser->complete_what = linespec_complete_what::NOTHING;
2610 unexpected_linespec_error (parser);
2613 /* Shortcut: If the next token is not LSTOKEN_COLON, we know that
2614 this token cannot represent a filename. */
2615 token = linespec_lexer_peek_token (parser);
2617 if (token.type == LSTOKEN_COLON)
2619 /* Get the current token again and extract the filename. */
2620 token = linespec_lexer_lex_one (parser);
2621 gdb::unique_xmalloc_ptr<char> user_filename = copy_token_string (token);
2623 /* Check if the input is a filename. */
2626 PARSER_RESULT (parser)->file_symtabs
2627 = symtabs_from_filename (user_filename.get (),
2628 PARSER_STATE (parser)->search_pspace);
2630 CATCH (ex, RETURN_MASK_ERROR)
2632 file_exception = ex;
2636 if (file_exception.reason >= 0)
2638 /* Symtabs were found for the file. Record the filename. */
2639 PARSER_EXPLICIT (parser)->source_filename = user_filename.release ();
2641 /* Get the next token. */
2642 token = linespec_lexer_consume_token (parser);
2644 /* This is LSTOKEN_COLON; consume it. */
2645 linespec_lexer_consume_token (parser);
2649 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2650 VEC_safe_push (symtab_ptr, PARSER_RESULT (parser)->file_symtabs, NULL);
2653 /* If the next token is not EOI, KEYWORD, or COMMA, issue an error. */
2654 else if (parser->completion_tracker == NULL
2655 && (token.type != LSTOKEN_EOI && token.type != LSTOKEN_KEYWORD
2656 && token.type != LSTOKEN_COMMA))
2658 /* TOKEN is the _next_ token, not the one currently in the parser.
2659 Consuming the token will give the correct error message. */
2660 linespec_lexer_consume_token (parser);
2661 unexpected_linespec_error (parser);
2665 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2666 VEC_safe_push (symtab_ptr, PARSER_RESULT (parser)->file_symtabs, NULL);
2669 /* Parse the rest of the linespec. */
2670 linespec_parse_basic (parser);
2672 if (parser->completion_tracker == NULL
2673 && PARSER_RESULT (parser)->function_symbols == NULL
2674 && PARSER_RESULT (parser)->labels.label_symbols == NULL
2675 && PARSER_EXPLICIT (parser)->line_offset.sign == LINE_OFFSET_UNKNOWN
2676 && PARSER_RESULT (parser)->minimal_symbols == NULL)
2678 /* The linespec didn't parse. Re-throw the file exception if
2680 if (file_exception.reason < 0)
2681 throw_exception (file_exception);
2683 /* Otherwise, the symbol is not found. */
2684 symbol_not_found_error (PARSER_EXPLICIT (parser)->function_name,
2685 PARSER_EXPLICIT (parser)->source_filename);
2690 /* Get the last token and record how much of the input was parsed,
2692 token = linespec_lexer_lex_one (parser);
2693 if (token.type != LSTOKEN_EOI && token.type != LSTOKEN_KEYWORD)
2694 unexpected_linespec_error (parser);
2695 else if (token.type == LSTOKEN_KEYWORD)
2697 /* Setup the completion word past the keyword. Lexing never
2698 advances past a keyword automatically, so skip it
2700 parser->completion_word
2701 = skip_spaces (skip_to_space (PARSER_STREAM (parser)));
2702 parser->complete_what = linespec_complete_what::EXPRESSION;
2705 /* Convert the data in PARSER_RESULT to SALs. */
2706 if (parser->completion_tracker == NULL)
2707 return convert_linespec_to_sals (PARSER_STATE (parser),
2708 PARSER_RESULT (parser));
2714 /* A constructor for linespec_state. */
2717 linespec_state_constructor (struct linespec_state *self,
2718 int flags, const struct language_defn *language,
2719 struct program_space *search_pspace,
2720 struct symtab *default_symtab,
2722 struct linespec_result *canonical)
2724 memset (self, 0, sizeof (*self));
2725 self->language = language;
2726 self->funfirstline = (flags & DECODE_LINE_FUNFIRSTLINE) ? 1 : 0;
2727 self->list_mode = (flags & DECODE_LINE_LIST_MODE) ? 1 : 0;
2728 self->search_pspace = search_pspace;
2729 self->default_symtab = default_symtab;
2730 self->default_line = default_line;
2731 self->canonical = canonical;
2732 self->program_space = current_program_space;
2733 self->addr_set = htab_create_alloc (10, hash_address_entry, eq_address_entry,
2734 xfree, xcalloc, xfree);
2735 self->is_linespec = 0;
2738 /* Initialize a new linespec parser. */
2741 linespec_parser_new (linespec_parser *parser,
2742 int flags, const struct language_defn *language,
2743 struct program_space *search_pspace,
2744 struct symtab *default_symtab,
2746 struct linespec_result *canonical)
2748 memset (parser, 0, sizeof (linespec_parser));
2749 parser->lexer.current.type = LSTOKEN_CONSUMED;
2750 memset (PARSER_RESULT (parser), 0, sizeof (struct linespec));
2751 PARSER_EXPLICIT (parser)->func_name_match_type
2752 = symbol_name_match_type::WILD;
2753 PARSER_EXPLICIT (parser)->line_offset.sign = LINE_OFFSET_UNKNOWN;
2754 linespec_state_constructor (PARSER_STATE (parser), flags, language,
2756 default_symtab, default_line, canonical);
2759 /* A destructor for linespec_state. */
2762 linespec_state_destructor (struct linespec_state *self)
2764 htab_delete (self->addr_set);
2767 /* Delete a linespec parser. */
2770 linespec_parser_delete (void *arg)
2772 linespec_parser *parser = (linespec_parser *) arg;
2774 xfree (PARSER_EXPLICIT (parser)->source_filename);
2775 xfree (PARSER_EXPLICIT (parser)->label_name);
2776 xfree (PARSER_EXPLICIT (parser)->function_name);
2778 if (PARSER_RESULT (parser)->file_symtabs != NULL)
2779 VEC_free (symtab_ptr, PARSER_RESULT (parser)->file_symtabs);
2781 if (PARSER_RESULT (parser)->function_symbols != NULL)
2782 VEC_free (symbolp, PARSER_RESULT (parser)->function_symbols);
2784 if (PARSER_RESULT (parser)->minimal_symbols != NULL)
2785 VEC_free (bound_minimal_symbol_d, PARSER_RESULT (parser)->minimal_symbols);
2787 if (PARSER_RESULT (parser)->labels.label_symbols != NULL)
2788 VEC_free (symbolp, PARSER_RESULT (parser)->labels.label_symbols);
2790 if (PARSER_RESULT (parser)->labels.function_symbols != NULL)
2791 VEC_free (symbolp, PARSER_RESULT (parser)->labels.function_symbols);
2793 linespec_state_destructor (PARSER_STATE (parser));
2796 /* See description in linespec.h. */
2799 linespec_lex_to_end (const char **stringp)
2801 linespec_parser parser;
2802 struct cleanup *cleanup;
2803 linespec_token token;
2806 if (stringp == NULL || *stringp == NULL)
2809 linespec_parser_new (&parser, 0, current_language, NULL, NULL, 0, NULL);
2810 cleanup = make_cleanup (linespec_parser_delete, &parser);
2811 parser.lexer.saved_arg = *stringp;
2812 PARSER_STREAM (&parser) = orig = *stringp;
2816 /* Stop before any comma tokens; we need it to keep it
2817 as the next token in the string. */
2818 token = linespec_lexer_peek_token (&parser);
2819 if (token.type == LSTOKEN_COMMA)
2821 token = linespec_lexer_consume_token (&parser);
2823 while (token.type != LSTOKEN_EOI && token.type != LSTOKEN_KEYWORD);
2825 *stringp += PARSER_STREAM (&parser) - orig;
2826 do_cleanups (cleanup);
2829 /* See linespec.h. */
2832 linespec_complete_function (completion_tracker &tracker,
2833 const char *function,
2834 symbol_name_match_type func_match_type,
2835 const char *source_filename)
2837 complete_symbol_mode mode = complete_symbol_mode::LINESPEC;
2839 if (source_filename != NULL)
2841 collect_file_symbol_completion_matches (tracker, mode, func_match_type,
2842 function, function, source_filename);
2846 collect_symbol_completion_matches (tracker, mode, func_match_type,
2847 function, function);
2852 /* Helper for complete_linespec to simplify it. SOURCE_FILENAME is
2853 only meaningful if COMPONENT is FUNCTION. */
2856 complete_linespec_component (linespec_parser *parser,
2857 completion_tracker &tracker,
2859 linespec_complete_what component,
2860 const char *source_filename)
2862 if (component == linespec_complete_what::KEYWORD)
2864 complete_on_enum (tracker, linespec_keywords, text, text);
2866 else if (component == linespec_complete_what::EXPRESSION)
2869 = advance_to_expression_complete_word_point (tracker, text);
2870 complete_expression (tracker, text, word);
2872 else if (component == linespec_complete_what::FUNCTION)
2874 completion_list fn_list;
2876 symbol_name_match_type match_type
2877 = PARSER_EXPLICIT (parser)->func_name_match_type;
2878 linespec_complete_function (tracker, text, match_type, source_filename);
2879 if (source_filename == NULL)
2881 /* Haven't seen a source component, like in "b
2882 file.c:function[TAB]". Maybe this wasn't a function, but
2883 a filename instead, like "b file.[TAB]". */
2884 fn_list = complete_source_filenames (text);
2887 /* If we only have a single filename completion, append a ':' for
2888 the user, since that's the only thing that can usefully follow
2890 if (fn_list.size () == 1 && !tracker.have_completions ())
2892 char *fn = fn_list[0].release ();
2894 /* If we also need to append a quote char, it needs to be
2895 appended before the ':'. Append it now, and make ':' the
2896 new "quote" char. */
2897 if (tracker.quote_char ())
2899 char quote_char_str[2] = { tracker.quote_char () };
2901 fn = reconcat (fn, fn, quote_char_str, (char *) NULL);
2902 tracker.set_quote_char (':');
2905 fn = reconcat (fn, fn, ":", (char *) NULL);
2906 fn_list[0].reset (fn);
2908 /* Tell readline to skip appending a space. */
2909 tracker.set_suppress_append_ws (true);
2911 tracker.add_completions (std::move (fn_list));
2915 /* Helper for linespec_complete_label. Find labels that match
2916 LABEL_NAME in the function symbols listed in the PARSER, and add
2917 them to the tracker. */
2920 complete_label (completion_tracker &tracker,
2921 linespec_parser *parser,
2922 const char *label_name)
2924 VEC (symbolp) *label_function_symbols = NULL;
2925 VEC (symbolp) *labels
2926 = find_label_symbols (PARSER_STATE (parser),
2927 PARSER_RESULT (parser)->function_symbols,
2928 &label_function_symbols,
2933 VEC_iterate (symbolp, labels, ix, label); ++ix)
2935 char *match = xstrdup (SYMBOL_SEARCH_NAME (label));
2936 tracker.add_completion (gdb::unique_xmalloc_ptr<char> (match));
2938 VEC_free (symbolp, labels);
2941 /* See linespec.h. */
2944 linespec_complete_label (completion_tracker &tracker,
2945 const struct language_defn *language,
2946 const char *source_filename,
2947 const char *function_name,
2948 symbol_name_match_type func_name_match_type,
2949 const char *label_name)
2951 linespec_parser parser;
2952 struct cleanup *cleanup;
2954 linespec_parser_new (&parser, 0, language, NULL, NULL, 0, NULL);
2955 cleanup = make_cleanup (linespec_parser_delete, &parser);
2957 line_offset unknown_offset = { 0, LINE_OFFSET_UNKNOWN };
2961 convert_explicit_location_to_linespec (PARSER_STATE (&parser),
2962 PARSER_RESULT (&parser),
2965 func_name_match_type,
2966 NULL, unknown_offset);
2968 CATCH (ex, RETURN_MASK_ERROR)
2970 do_cleanups (cleanup);
2975 complete_label (tracker, &parser, label_name);
2977 do_cleanups (cleanup);
2980 /* See description in linespec.h. */
2983 linespec_complete (completion_tracker &tracker, const char *text,
2984 symbol_name_match_type match_type)
2986 linespec_parser parser;
2987 struct cleanup *cleanup;
2988 const char *orig = text;
2990 linespec_parser_new (&parser, 0, current_language, NULL, NULL, 0, NULL);
2991 cleanup = make_cleanup (linespec_parser_delete, &parser);
2992 parser.lexer.saved_arg = text;
2993 PARSER_EXPLICIT (&parser)->func_name_match_type = match_type;
2994 PARSER_STREAM (&parser) = text;
2996 parser.completion_tracker = &tracker;
2997 PARSER_STATE (&parser)->is_linespec = 1;
2999 /* Parse as much as possible. parser.completion_word will hold
3000 furthest completion point we managed to parse to. */
3003 parse_linespec (&parser, text, match_type);
3005 CATCH (except, RETURN_MASK_ERROR)
3010 if (parser.completion_quote_char != '\0'
3011 && parser.completion_quote_end != NULL
3012 && parser.completion_quote_end[1] == '\0')
3014 /* If completing a quoted string with the cursor right at
3015 terminating quote char, complete the completion word without
3016 interpretation, so that readline advances the cursor one
3017 whitespace past the quote, even if there's no match. This
3018 makes these cases behave the same:
3020 before: "b function()"
3021 after: "b function() "
3023 before: "b 'function()'"
3024 after: "b 'function()' "
3026 and trusts the user in this case:
3028 before: "b 'not_loaded_function_yet()'"
3029 after: "b 'not_loaded_function_yet()' "
3031 parser.complete_what = linespec_complete_what::NOTHING;
3032 parser.completion_quote_char = '\0';
3034 gdb::unique_xmalloc_ptr<char> text_copy
3035 (xstrdup (parser.completion_word));
3036 tracker.add_completion (std::move (text_copy));
3039 tracker.set_quote_char (parser.completion_quote_char);
3041 if (parser.complete_what == linespec_complete_what::LABEL)
3043 parser.complete_what = linespec_complete_what::NOTHING;
3045 const char *func_name = PARSER_EXPLICIT (&parser)->function_name;
3047 VEC (symbolp) *function_symbols;
3048 VEC (bound_minimal_symbol_d) *minimal_symbols;
3049 find_linespec_symbols (PARSER_STATE (&parser),
3050 PARSER_RESULT (&parser)->file_symtabs,
3051 func_name, match_type,
3052 &function_symbols, &minimal_symbols);
3054 PARSER_RESULT (&parser)->function_symbols = function_symbols;
3055 PARSER_RESULT (&parser)->minimal_symbols = minimal_symbols;
3057 complete_label (tracker, &parser, parser.completion_word);
3059 else if (parser.complete_what == linespec_complete_what::FUNCTION)
3061 /* While parsing/lexing, we didn't know whether the completion
3062 word completes to a unique function/source name already or
3066 "b function() <tab>"
3067 may need to complete either to:
3068 "b function() const"
3070 "b function() if/thread/task"
3074 may need to complete either to:
3075 "b foo template_fun<T>()"
3076 with "foo" being the template function's return type, or to:
3081 may need to complete either to a source file name:
3083 or this, also a filename, but a unique completion:
3085 or to a function name:
3088 Address that by completing assuming source or function, and
3089 seeing if we find a completion that matches exactly the
3090 completion word. If so, then it must be a function (see note
3091 below) and we advance the completion word to the end of input
3092 and switch to KEYWORD completion mode.
3094 Note: if we find a unique completion for a source filename,
3095 then it won't match the completion word, because the LCD will
3096 contain a trailing ':'. And if we're completing at or after
3097 the ':', then complete_linespec_component won't try to
3098 complete on source filenames. */
3100 const char *word = parser.completion_word;
3102 complete_linespec_component (&parser, tracker,
3103 parser.completion_word,
3104 linespec_complete_what::FUNCTION,
3105 PARSER_EXPLICIT (&parser)->source_filename);
3107 parser.complete_what = linespec_complete_what::NOTHING;
3109 if (tracker.quote_char ())
3111 /* The function/file name was not close-quoted, so this
3112 can't be a keyword. Note: complete_linespec_component
3113 may have swapped the original quote char for ':' when we
3114 get here, but that still indicates the same. */
3116 else if (!tracker.have_completions ())
3119 size_t wordlen = strlen (parser.completion_word);
3122 = string_find_incomplete_keyword_at_end (linespec_keywords,
3123 parser.completion_word,
3128 && parser.completion_word[wordlen - 1] == ' '))
3130 parser.completion_word += key_start;
3131 parser.complete_what = linespec_complete_what::KEYWORD;
3134 else if (tracker.completes_to_completion_word (word))
3136 /* Skip the function and complete on keywords. */
3137 parser.completion_word += strlen (word);
3138 parser.complete_what = linespec_complete_what::KEYWORD;
3139 tracker.discard_completions ();
3143 tracker.advance_custom_word_point_by (parser.completion_word - orig);
3145 complete_linespec_component (&parser, tracker,
3146 parser.completion_word,
3147 parser.complete_what,
3148 PARSER_EXPLICIT (&parser)->source_filename);
3150 /* If we're past the "filename:function:label:offset" linespec, and
3151 didn't find any match, then assume the user might want to create
3152 a pending breakpoint anyway and offer the keyword
3154 if (!parser.completion_quote_char
3155 && (parser.complete_what == linespec_complete_what::FUNCTION
3156 || parser.complete_what == linespec_complete_what::LABEL
3157 || parser.complete_what == linespec_complete_what::NOTHING)
3158 && !tracker.have_completions ())
3161 = parser.completion_word + strlen (parser.completion_word);
3163 if (end > orig && end[-1] == ' ')
3165 tracker.advance_custom_word_point_by (end - parser.completion_word);
3167 complete_linespec_component (&parser, tracker, end,
3168 linespec_complete_what::KEYWORD,
3173 do_cleanups (cleanup);
3176 /* A helper function for decode_line_full and decode_line_1 to
3177 turn LOCATION into std::vector<symtab_and_line>. */
3179 static std::vector<symtab_and_line>
3180 event_location_to_sals (linespec_parser *parser,
3181 const struct event_location *location)
3183 std::vector<symtab_and_line> result;
3185 switch (event_location_type (location))
3187 case LINESPEC_LOCATION:
3189 PARSER_STATE (parser)->is_linespec = 1;
3192 const linespec_location *ls = get_linespec_location (location);
3193 result = parse_linespec (parser,
3194 ls->spec_string, ls->match_type);
3196 CATCH (except, RETURN_MASK_ERROR)
3198 throw_exception (except);
3204 case ADDRESS_LOCATION:
3206 const char *addr_string = get_address_string_location (location);
3207 CORE_ADDR addr = get_address_location (location);
3209 if (addr_string != NULL)
3211 addr = linespec_expression_to_pc (&addr_string);
3212 if (PARSER_STATE (parser)->canonical != NULL)
3213 PARSER_STATE (parser)->canonical->location
3214 = copy_event_location (location);
3217 result = convert_address_location_to_sals (PARSER_STATE (parser),
3222 case EXPLICIT_LOCATION:
3224 const struct explicit_location *explicit_loc;
3226 explicit_loc = get_explicit_location_const (location);
3227 result = convert_explicit_location_to_sals (PARSER_STATE (parser),
3228 PARSER_RESULT (parser),
3233 case PROBE_LOCATION:
3234 /* Probes are handled by their own decoders. */
3235 gdb_assert_not_reached ("attempt to decode probe location");
3239 gdb_assert_not_reached ("unhandled event location type");
3245 /* See linespec.h. */
3248 decode_line_full (const struct event_location *location, int flags,
3249 struct program_space *search_pspace,
3250 struct symtab *default_symtab,
3251 int default_line, struct linespec_result *canonical,
3252 const char *select_mode,
3255 struct cleanup *cleanups;
3256 std::vector<const char *> filters;
3257 linespec_parser parser;
3258 struct linespec_state *state;
3260 gdb_assert (canonical != NULL);
3261 /* The filter only makes sense for 'all'. */
3262 gdb_assert (filter == NULL || select_mode == multiple_symbols_all);
3263 gdb_assert (select_mode == NULL
3264 || select_mode == multiple_symbols_all
3265 || select_mode == multiple_symbols_ask
3266 || select_mode == multiple_symbols_cancel);
3267 gdb_assert ((flags & DECODE_LINE_LIST_MODE) == 0);
3269 linespec_parser_new (&parser, flags, current_language,
3270 search_pspace, default_symtab,
3271 default_line, canonical);
3272 cleanups = make_cleanup (linespec_parser_delete, &parser);
3274 scoped_restore_current_program_space restore_pspace;
3276 std::vector<symtab_and_line> result = event_location_to_sals (&parser,
3278 state = PARSER_STATE (&parser);
3280 gdb_assert (result.size () == 1 || canonical->pre_expanded);
3281 canonical->pre_expanded = 1;
3283 /* Arrange for allocated canonical names to be freed. */
3284 if (!result.empty ())
3288 make_cleanup (xfree, state->canonical_names);
3289 for (i = 0; i < result.size (); ++i)
3291 gdb_assert (state->canonical_names[i].suffix != NULL);
3292 make_cleanup (xfree, state->canonical_names[i].suffix);
3296 if (select_mode == NULL)
3298 if (top_level_interpreter ()->interp_ui_out ()->is_mi_like_p ())
3299 select_mode = multiple_symbols_all;
3301 select_mode = multiple_symbols_select_mode ();
3304 if (select_mode == multiple_symbols_all)
3308 filters.push_back (filter);
3309 filter_results (state, &result, filters);
3312 convert_results_to_lsals (state, &result);
3315 decode_line_2 (state, &result, select_mode);
3317 do_cleanups (cleanups);
3320 /* See linespec.h. */
3322 std::vector<symtab_and_line>
3323 decode_line_1 (const struct event_location *location, int flags,
3324 struct program_space *search_pspace,
3325 struct symtab *default_symtab,
3328 linespec_parser parser;
3329 struct cleanup *cleanups;
3331 linespec_parser_new (&parser, flags, current_language,
3332 search_pspace, default_symtab,
3333 default_line, NULL);
3334 cleanups = make_cleanup (linespec_parser_delete, &parser);
3336 scoped_restore_current_program_space restore_pspace;
3338 std::vector<symtab_and_line> result = event_location_to_sals (&parser,
3341 do_cleanups (cleanups);
3345 /* See linespec.h. */
3347 std::vector<symtab_and_line>
3348 decode_line_with_current_source (const char *string, int flags)
3351 error (_("Empty line specification."));
3353 /* We use whatever is set as the current source line. We do not try
3354 and get a default source symtab+line or it will recursively call us! */
3355 symtab_and_line cursal = get_current_source_symtab_and_line ();
3357 event_location_up location = string_to_event_location (&string,
3359 std::vector<symtab_and_line> sals
3360 = decode_line_1 (location.get (), flags, NULL, cursal.symtab, cursal.line);
3363 error (_("Junk at end of line specification: %s"), string);
3368 /* See linespec.h. */
3370 std::vector<symtab_and_line>
3371 decode_line_with_last_displayed (const char *string, int flags)
3374 error (_("Empty line specification."));
3376 event_location_up location = string_to_event_location (&string,
3378 std::vector<symtab_and_line> sals
3379 = (last_displayed_sal_is_valid ()
3380 ? decode_line_1 (location.get (), flags, NULL,
3381 get_last_displayed_symtab (),
3382 get_last_displayed_line ())
3383 : decode_line_1 (location.get (), flags, NULL,
3384 (struct symtab *) NULL, 0));
3387 error (_("Junk at end of line specification: %s"), string);
3394 /* First, some functions to initialize stuff at the beggining of the
3398 initialize_defaults (struct symtab **default_symtab, int *default_line)
3400 if (*default_symtab == 0)
3402 /* Use whatever we have for the default source line. We don't use
3403 get_current_or_default_symtab_and_line as it can recurse and call
3405 struct symtab_and_line cursal =
3406 get_current_source_symtab_and_line ();
3408 *default_symtab = cursal.symtab;
3409 *default_line = cursal.line;
3415 /* Evaluate the expression pointed to by EXP_PTR into a CORE_ADDR,
3416 advancing EXP_PTR past any parsed text. */
3419 linespec_expression_to_pc (const char **exp_ptr)
3421 if (current_program_space->executing_startup)
3422 /* The error message doesn't really matter, because this case
3423 should only hit during breakpoint reset. */
3424 throw_error (NOT_FOUND_ERROR, _("cannot evaluate expressions while "
3425 "program space is in startup"));
3428 return value_as_address (parse_to_comma_and_eval (exp_ptr));
3433 /* Here's where we recognise an Objective-C Selector. An Objective C
3434 selector may be implemented by more than one class, therefore it
3435 may represent more than one method/function. This gives us a
3436 situation somewhat analogous to C++ overloading. If there's more
3437 than one method that could represent the selector, then use some of
3438 the existing C++ code to let the user choose one. */
3440 static std::vector<symtab_and_line>
3441 decode_objc (struct linespec_state *self, linespec_p ls, const char *arg)
3443 struct collect_info info;
3444 std::vector<const char *> symbol_names;
3445 const char *new_argptr;
3448 info.file_symtabs = NULL;
3449 VEC_safe_push (symtab_ptr, info.file_symtabs, NULL);
3450 struct cleanup *cleanup = make_cleanup (VEC_cleanup (symtab_ptr),
3451 &info.file_symtabs);
3452 info.result.symbols = NULL;
3453 info.result.minimal_symbols = NULL;
3455 new_argptr = find_imps (arg, &symbol_names);
3456 if (symbol_names.empty ())
3458 do_cleanups (cleanup);
3462 add_all_symbol_names_from_pspace (&info, NULL, symbol_names,
3465 std::vector<symtab_and_line> values;
3466 if (!VEC_empty (symbolp, info.result.symbols)
3467 || !VEC_empty (bound_minimal_symbol_d, info.result.minimal_symbols))
3471 saved_arg = (char *) alloca (new_argptr - arg + 1);
3472 memcpy (saved_arg, arg, new_argptr - arg);
3473 saved_arg[new_argptr - arg] = '\0';
3475 ls->explicit_loc.function_name = xstrdup (saved_arg);
3476 ls->function_symbols = info.result.symbols;
3477 ls->minimal_symbols = info.result.minimal_symbols;
3478 values = convert_linespec_to_sals (self, ls);
3480 if (self->canonical)
3485 self->canonical->pre_expanded = 1;
3487 if (ls->explicit_loc.source_filename)
3489 holder = string_printf ("%s:%s",
3490 ls->explicit_loc.source_filename,
3492 str = holder.c_str ();
3497 self->canonical->location
3498 = new_linespec_location (&str, symbol_name_match_type::FULL);
3502 do_cleanups (cleanup);
3509 /* A function object that serves as symbol_found_callback_ftype
3510 callback for iterate_over_symbols. This is used by
3511 lookup_prefix_sym to collect type symbols. */
3512 class decode_compound_collector
3515 decode_compound_collector ()
3518 m_unique_syms = htab_create_alloc (1, htab_hash_pointer,
3519 htab_eq_pointer, NULL,
3523 ~decode_compound_collector ()
3525 if (m_unique_syms != NULL)
3526 htab_delete (m_unique_syms);
3529 /* Releases ownership of the collected symbols and returns them. */
3530 VEC (symbolp) *release_symbols ()
3532 VEC (symbolp) *res = m_symbols;
3537 /* Callable as a symbol_found_callback_ftype callback. */
3538 bool operator () (symbol *sym);
3541 /* A hash table of all symbols we found. We use this to avoid
3542 adding any symbol more than once. */
3543 htab_t m_unique_syms;
3545 /* The result vector. */
3546 VEC (symbolp) *m_symbols;
3550 decode_compound_collector::operator () (symbol *sym)
3555 if (SYMBOL_CLASS (sym) != LOC_TYPEDEF)
3556 return true; /* Continue iterating. */
3558 t = SYMBOL_TYPE (sym);
3559 t = check_typedef (t);
3560 if (TYPE_CODE (t) != TYPE_CODE_STRUCT
3561 && TYPE_CODE (t) != TYPE_CODE_UNION
3562 && TYPE_CODE (t) != TYPE_CODE_NAMESPACE)
3563 return true; /* Continue iterating. */
3565 slot = htab_find_slot (m_unique_syms, sym, INSERT);
3569 VEC_safe_push (symbolp, m_symbols, sym);
3572 return true; /* Continue iterating. */
3577 /* Return any symbols corresponding to CLASS_NAME in FILE_SYMTABS. */
3579 static VEC (symbolp) *
3580 lookup_prefix_sym (struct linespec_state *state, VEC (symtab_ptr) *file_symtabs,
3581 const char *class_name)
3585 decode_compound_collector collector;
3587 lookup_name_info lookup_name (class_name, symbol_name_match_type::FULL);
3589 for (ix = 0; VEC_iterate (symtab_ptr, file_symtabs, ix, elt); ++ix)
3593 iterate_over_all_matching_symtabs (state, lookup_name,
3594 STRUCT_DOMAIN, ALL_DOMAIN,
3595 NULL, false, collector);
3596 iterate_over_all_matching_symtabs (state, lookup_name,
3597 VAR_DOMAIN, ALL_DOMAIN,
3598 NULL, false, collector);
3602 /* Program spaces that are executing startup should have
3603 been filtered out earlier. */
3604 gdb_assert (!SYMTAB_PSPACE (elt)->executing_startup);
3605 set_current_program_space (SYMTAB_PSPACE (elt));
3606 iterate_over_file_blocks (elt, lookup_name, STRUCT_DOMAIN, collector);
3607 iterate_over_file_blocks (elt, lookup_name, VAR_DOMAIN, collector);
3611 return collector.release_symbols ();
3614 /* A qsort comparison function for symbols. The resulting order does
3615 not actually matter; we just need to be able to sort them so that
3616 symbols with the same program space end up next to each other. */
3619 compare_symbols (const void *a, const void *b)
3621 struct symbol * const *sa = (struct symbol * const*) a;
3622 struct symbol * const *sb = (struct symbol * const*) b;
3625 uia = (uintptr_t) SYMTAB_PSPACE (symbol_symtab (*sa));
3626 uib = (uintptr_t) SYMTAB_PSPACE (symbol_symtab (*sb));
3633 uia = (uintptr_t) *sa;
3634 uib = (uintptr_t) *sb;
3644 /* Like compare_symbols but for minimal symbols. */
3647 compare_msymbols (const void *a, const void *b)
3649 const struct bound_minimal_symbol *sa
3650 = (const struct bound_minimal_symbol *) a;
3651 const struct bound_minimal_symbol *sb
3652 = (const struct bound_minimal_symbol *) b;
3655 uia = (uintptr_t) sa->objfile->pspace;
3656 uib = (uintptr_t) sa->objfile->pspace;
3663 uia = (uintptr_t) sa->minsym;
3664 uib = (uintptr_t) sb->minsym;
3674 /* Look for all the matching instances of each symbol in NAMES. Only
3675 instances from PSPACE are considered; other program spaces are
3676 handled by our caller. If PSPACE is NULL, then all program spaces
3677 are considered. Results are stored into INFO. */
3680 add_all_symbol_names_from_pspace (struct collect_info *info,
3681 struct program_space *pspace,
3682 const std::vector<const char *> &names,
3683 enum search_domain search_domain)
3685 for (const char *iter : names)
3686 add_matching_symbols_to_info (iter,
3687 symbol_name_match_type::FULL,
3688 search_domain, info, pspace);
3692 find_superclass_methods (std::vector<struct type *> &&superclasses,
3693 const char *name, enum language name_lang,
3694 std::vector<const char *> *result_names)
3696 size_t old_len = result_names->size ();
3700 std::vector<struct type *> new_supers;
3702 for (type *t : superclasses)
3703 find_methods (t, name_lang, name, result_names, &new_supers);
3705 if (result_names->size () != old_len || new_supers.empty ())
3708 superclasses = std::move (new_supers);
3712 /* This finds the method METHOD_NAME in the class CLASS_NAME whose type is
3713 given by one of the symbols in SYM_CLASSES. Matches are returned
3714 in SYMBOLS (for debug symbols) and MINSYMS (for minimal symbols). */
3717 find_method (struct linespec_state *self, VEC (symtab_ptr) *file_symtabs,
3718 const char *class_name, const char *method_name,
3719 VEC (symbolp) *sym_classes, VEC (symbolp) **symbols,
3720 VEC (bound_minimal_symbol_d) **minsyms)
3724 size_t last_result_len;
3725 std::vector<struct type *> superclass_vec;
3726 std::vector<const char *> result_names;
3727 struct collect_info info;
3729 /* Sort symbols so that symbols with the same program space are next
3731 qsort (VEC_address (symbolp, sym_classes),
3732 VEC_length (symbolp, sym_classes),
3737 info.file_symtabs = file_symtabs;
3738 info.result.symbols = NULL;
3739 info.result.minimal_symbols = NULL;
3741 /* Iterate over all the types, looking for the names of existing
3742 methods matching METHOD_NAME. If we cannot find a direct method in a
3743 given program space, then we consider inherited methods; this is
3744 not ideal (ideal would be to respect C++ hiding rules), but it
3745 seems good enough and is what GDB has historically done. We only
3746 need to collect the names because later we find all symbols with
3747 those names. This loop is written in a somewhat funny way
3748 because we collect data across the program space before deciding
3750 last_result_len = 0;
3751 for (ix = 0; VEC_iterate (symbolp, sym_classes, ix, sym); ++ix)
3754 struct program_space *pspace;
3756 /* Program spaces that are executing startup should have
3757 been filtered out earlier. */
3758 pspace = SYMTAB_PSPACE (symbol_symtab (sym));
3759 gdb_assert (!pspace->executing_startup);
3760 set_current_program_space (pspace);
3761 t = check_typedef (SYMBOL_TYPE (sym));
3762 find_methods (t, SYMBOL_LANGUAGE (sym),
3763 method_name, &result_names, &superclass_vec);
3765 /* Handle all items from a single program space at once; and be
3766 sure not to miss the last batch. */
3767 if (ix == VEC_length (symbolp, sym_classes) - 1
3769 != SYMTAB_PSPACE (symbol_symtab (VEC_index (symbolp, sym_classes,
3772 /* If we did not find a direct implementation anywhere in
3773 this program space, consider superclasses. */
3774 if (result_names.size () == last_result_len)
3775 find_superclass_methods (std::move (superclass_vec), method_name,
3776 SYMBOL_LANGUAGE (sym), &result_names);
3778 /* We have a list of candidate symbol names, so now we
3779 iterate over the symbol tables looking for all
3780 matches in this pspace. */
3781 add_all_symbol_names_from_pspace (&info, pspace, result_names,
3784 superclass_vec.clear ();
3785 last_result_len = result_names.size ();
3789 if (!VEC_empty (symbolp, info.result.symbols)
3790 || !VEC_empty (bound_minimal_symbol_d, info.result.minimal_symbols))
3792 *symbols = info.result.symbols;
3793 *minsyms = info.result.minimal_symbols;
3797 /* Throw an NOT_FOUND_ERROR. This will be caught by the caller
3798 and other attempts to locate the symbol will be made. */
3799 throw_error (NOT_FOUND_ERROR, _("see caller, this text doesn't matter"));
3806 /* This function object is a callback for iterate_over_symtabs, used
3807 when collecting all matching symtabs. */
3809 class symtab_collector
3815 m_symtab_table = htab_create (1, htab_hash_pointer, htab_eq_pointer,
3819 ~symtab_collector ()
3821 if (m_symtab_table != NULL)
3822 htab_delete (m_symtab_table);
3825 /* Callable as a symbol_found_callback_ftype callback. */
3826 bool operator () (symtab *sym);
3828 /* Releases ownership of the collected symtabs and returns them. */
3829 VEC (symtab_ptr) *release_symtabs ()
3831 VEC (symtab_ptr) *res = m_symtabs;
3837 /* The result vector of symtabs. */
3838 VEC (symtab_ptr) *m_symtabs;
3840 /* This is used to ensure the symtabs are unique. */
3841 htab_t m_symtab_table;
3845 symtab_collector::operator () (struct symtab *symtab)
3849 slot = htab_find_slot (m_symtab_table, symtab, INSERT);
3853 VEC_safe_push (symtab_ptr, m_symtabs, symtab);
3861 /* Given a file name, return a VEC of all matching symtabs. If
3862 SEARCH_PSPACE is not NULL, the search is restricted to just that
3865 static VEC (symtab_ptr) *
3866 collect_symtabs_from_filename (const char *file,
3867 struct program_space *search_pspace)
3869 symtab_collector collector;
3871 /* Find that file's data. */
3872 if (search_pspace == NULL)
3874 struct program_space *pspace;
3876 ALL_PSPACES (pspace)
3878 if (pspace->executing_startup)
3881 set_current_program_space (pspace);
3882 iterate_over_symtabs (file, collector);
3887 set_current_program_space (search_pspace);
3888 iterate_over_symtabs (file, collector);
3891 return collector.release_symtabs ();
3894 /* Return all the symtabs associated to the FILENAME. If SEARCH_PSPACE is
3895 not NULL, the search is restricted to just that program space. */
3897 static VEC (symtab_ptr) *
3898 symtabs_from_filename (const char *filename,
3899 struct program_space *search_pspace)
3901 VEC (symtab_ptr) *result;
3903 result = collect_symtabs_from_filename (filename, search_pspace);
3905 if (VEC_empty (symtab_ptr, result))
3907 if (!have_full_symbols () && !have_partial_symbols ())
3908 throw_error (NOT_FOUND_ERROR,
3909 _("No symbol table is loaded. "
3910 "Use the \"file\" command."));
3911 source_file_not_found_error (filename);
3917 /* Look up a function symbol named NAME in symtabs FILE_SYMTABS. Matching
3918 debug symbols are returned in SYMBOLS. Matching minimal symbols are
3919 returned in MINSYMS. */
3922 find_function_symbols (struct linespec_state *state,
3923 VEC (symtab_ptr) *file_symtabs, const char *name,
3924 symbol_name_match_type name_match_type,
3925 VEC (symbolp) **symbols,
3926 VEC (bound_minimal_symbol_d) **minsyms)
3928 struct collect_info info;
3929 std::vector<const char *> symbol_names;
3932 info.result.symbols = NULL;
3933 info.result.minimal_symbols = NULL;
3934 info.file_symtabs = file_symtabs;
3936 /* Try NAME as an Objective-C selector. */
3937 find_imps (name, &symbol_names);
3938 if (!symbol_names.empty ())
3939 add_all_symbol_names_from_pspace (&info, state->search_pspace,
3940 symbol_names, FUNCTIONS_DOMAIN);
3942 add_matching_symbols_to_info (name, name_match_type, FUNCTIONS_DOMAIN,
3943 &info, state->search_pspace);
3945 if (VEC_empty (symbolp, info.result.symbols))
3947 VEC_free (symbolp, info.result.symbols);
3951 *symbols = info.result.symbols;
3953 if (VEC_empty (bound_minimal_symbol_d, info.result.minimal_symbols))
3955 VEC_free (bound_minimal_symbol_d, info.result.minimal_symbols);
3959 *minsyms = info.result.minimal_symbols;
3962 /* Find all symbols named NAME in FILE_SYMTABS, returning debug symbols
3963 in SYMBOLS and minimal symbols in MINSYMS. */
3966 find_linespec_symbols (struct linespec_state *state,
3967 VEC (symtab_ptr) *file_symtabs,
3968 const char *lookup_name,
3969 symbol_name_match_type name_match_type,
3970 VEC (symbolp) **symbols,
3971 VEC (bound_minimal_symbol_d) **minsyms)
3973 std::string canon = cp_canonicalize_string_no_typedefs (lookup_name);
3974 if (!canon.empty ())
3975 lookup_name = canon.c_str ();
3977 /* It's important to not call expand_symtabs_matching unnecessarily
3978 as it can really slow things down (by unnecessarily expanding
3979 potentially 1000s of symtabs, which when debugging some apps can
3980 cost 100s of seconds). Avoid this to some extent by *first* calling
3981 find_function_symbols, and only if that doesn't find anything
3982 *then* call find_method. This handles two important cases:
3983 1) break (anonymous namespace)::foo
3984 2) break class::method where method is in class (and not a baseclass) */
3986 find_function_symbols (state, file_symtabs, lookup_name,
3990 /* If we were unable to locate a symbol of the same name, try dividing
3991 the name into class and method names and searching the class and its
3993 if (VEC_empty (symbolp, *symbols)
3994 && VEC_empty (bound_minimal_symbol_d, *minsyms))
3996 std::string klass, method;
3997 const char *last, *p, *scope_op;
3998 VEC (symbolp) *classes;
4000 /* See if we can find a scope operator and break this symbol
4001 name into namespaces${SCOPE_OPERATOR}class_name and method_name. */
4003 p = find_toplevel_string (lookup_name, scope_op);
4009 p = find_toplevel_string (p + strlen (scope_op), scope_op);
4012 /* If no scope operator was found, there is nothing more we can do;
4013 we already attempted to lookup the entire name as a symbol
4018 /* LOOKUP_NAME points to the class name.
4019 LAST points to the method name. */
4020 klass = std::string (lookup_name, last - lookup_name);
4022 /* Skip past the scope operator. */
4023 last += strlen (scope_op);
4026 /* Find a list of classes named KLASS. */
4027 classes = lookup_prefix_sym (state, file_symtabs, klass.c_str ());
4028 struct cleanup *old_chain
4029 = make_cleanup (VEC_cleanup (symbolp), &classes);
4031 if (!VEC_empty (symbolp, classes))
4033 /* Now locate a list of suitable methods named METHOD. */
4036 find_method (state, file_symtabs,
4037 klass.c_str (), method.c_str (),
4038 classes, symbols, minsyms);
4041 /* If successful, we're done. If NOT_FOUND_ERROR
4042 was not thrown, rethrow the exception that we did get. */
4043 CATCH (except, RETURN_MASK_ERROR)
4045 if (except.error != NOT_FOUND_ERROR)
4046 throw_exception (except);
4051 do_cleanups (old_chain);
4055 /* Helper for find_label_symbols. Find all labels that match name
4056 NAME in BLOCK. Return all labels that match in FUNCTION_SYMBOLS.
4057 Return the actual function symbol in which the label was found in
4058 LABEL_FUNC_RET. If COMPLETION_MODE is true, then NAME is
4059 interpreted as a label name prefix. Otherwise, only a label named
4060 exactly NAME match. */
4063 find_label_symbols_in_block (const struct block *block,
4064 const char *name, struct symbol *fn_sym,
4065 bool completion_mode,
4066 VEC (symbolp) **result,
4067 VEC (symbolp) **label_funcs_ret)
4069 if (completion_mode)
4071 struct block_iterator iter;
4073 size_t name_len = strlen (name);
4075 int (*cmp) (const char *, const char *, size_t);
4076 cmp = case_sensitivity == case_sensitive_on ? strncmp : strncasecmp;
4078 ALL_BLOCK_SYMBOLS (block, iter, sym)
4080 if (symbol_matches_domain (SYMBOL_LANGUAGE (sym),
4081 SYMBOL_DOMAIN (sym), LABEL_DOMAIN)
4082 && cmp (SYMBOL_SEARCH_NAME (sym), name, name_len) == 0)
4084 VEC_safe_push (symbolp, *result, sym);
4085 VEC_safe_push (symbolp, *label_funcs_ret, fn_sym);
4091 struct symbol *sym = lookup_symbol (name, block, LABEL_DOMAIN, 0).symbol;
4095 VEC_safe_push (symbolp, *result, sym);
4096 VEC_safe_push (symbolp, *label_funcs_ret, fn_sym);
4101 /* Return all labels that match name NAME in FUNCTION_SYMBOLS. Return
4102 the actual function symbol in which the label was found in
4103 LABEL_FUNC_RET. If COMPLETION_MODE is true, then NAME is
4104 interpreted as a label name prefix. Otherwise, only labels named
4105 exactly NAME match. */
4107 static VEC (symbolp) *
4108 find_label_symbols (struct linespec_state *self,
4109 VEC (symbolp) *function_symbols,
4110 VEC (symbolp) **label_funcs_ret, const char *name,
4111 bool completion_mode)
4114 const struct block *block;
4115 struct symbol *fn_sym;
4116 VEC (symbolp) *result = NULL;
4118 if (function_symbols == NULL)
4120 set_current_program_space (self->program_space);
4121 block = get_current_search_block ();
4124 block && !BLOCK_FUNCTION (block);
4125 block = BLOCK_SUPERBLOCK (block))
4129 fn_sym = BLOCK_FUNCTION (block);
4131 find_label_symbols_in_block (block, name, fn_sym, completion_mode,
4132 &result, label_funcs_ret);
4137 VEC_iterate (symbolp, function_symbols, ix, fn_sym); ++ix)
4139 set_current_program_space (SYMTAB_PSPACE (symbol_symtab (fn_sym)));
4140 block = SYMBOL_BLOCK_VALUE (fn_sym);
4142 find_label_symbols_in_block (block, name, fn_sym, completion_mode,
4143 &result, label_funcs_ret);
4152 /* A helper for create_sals_line_offset that handles the 'list_mode' case. */
4154 static std::vector<symtab_and_line>
4155 decode_digits_list_mode (struct linespec_state *self,
4157 struct symtab_and_line val)
4162 gdb_assert (self->list_mode);
4164 std::vector<symtab_and_line> values;
4166 for (ix = 0; VEC_iterate (symtab_ptr, ls->file_symtabs, ix, elt);
4169 /* The logic above should ensure this. */
4170 gdb_assert (elt != NULL);
4172 set_current_program_space (SYMTAB_PSPACE (elt));
4174 /* Simplistic search just for the list command. */
4175 val.symtab = find_line_symtab (elt, val.line, NULL, NULL);
4176 if (val.symtab == NULL)
4178 val.pspace = SYMTAB_PSPACE (elt);
4180 val.explicit_line = 1;
4182 add_sal_to_sals (self, &values, &val, NULL, 0);
4188 /* A helper for create_sals_line_offset that iterates over the symtabs,
4189 adding lines to the VEC. */
4191 static std::vector<symtab_and_line>
4192 decode_digits_ordinary (struct linespec_state *self,
4195 struct linetable_entry **best_entry)
4200 std::vector<symtab_and_line> sals;
4201 for (ix = 0; VEC_iterate (symtab_ptr, ls->file_symtabs, ix, elt); ++ix)
4203 std::vector<CORE_ADDR> pcs;
4205 /* The logic above should ensure this. */
4206 gdb_assert (elt != NULL);
4208 set_current_program_space (SYMTAB_PSPACE (elt));
4210 pcs = find_pcs_for_symtab_line (elt, line, best_entry);
4211 for (CORE_ADDR pc : pcs)
4213 symtab_and_line sal;
4214 sal.pspace = SYMTAB_PSPACE (elt);
4218 sals.push_back (std::move (sal));
4227 /* Return the line offset represented by VARIABLE. */
4229 static struct line_offset
4230 linespec_parse_variable (struct linespec_state *self, const char *variable)
4234 struct line_offset offset = {0, LINE_OFFSET_NONE};
4236 p = (variable[1] == '$') ? variable + 2 : variable + 1;
4239 while (*p >= '0' && *p <= '9')
4241 if (!*p) /* Reached end of token without hitting non-digit. */
4243 /* We have a value history reference. */
4244 struct value *val_history;
4246 sscanf ((variable[1] == '$') ? variable + 2 : variable + 1, "%d", &index);
4248 = access_value_history ((variable[1] == '$') ? -index : index);
4249 if (TYPE_CODE (value_type (val_history)) != TYPE_CODE_INT)
4250 error (_("History values used in line "
4251 "specs must have integer values."));
4252 offset.offset = value_as_long (val_history);
4256 /* Not all digits -- may be user variable/function or a
4257 convenience variable. */
4259 struct internalvar *ivar;
4261 /* Try it as a convenience variable. If it is not a convenience
4262 variable, return and allow normal symbol lookup to occur. */
4263 ivar = lookup_only_internalvar (variable + 1);
4265 /* No internal variable with that name. Mark the offset
4266 as unknown to allow the name to be looked up as a symbol. */
4267 offset.sign = LINE_OFFSET_UNKNOWN;
4270 /* We found a valid variable name. If it is not an integer,
4272 if (!get_internalvar_integer (ivar, &valx))
4273 error (_("Convenience variables used in line "
4274 "specs must have integer values."));
4276 offset.offset = valx;
4284 /* We've found a minimal symbol MSYMBOL in OBJFILE to associate with our
4285 linespec; return the SAL in RESULT. This function should return SALs
4286 matching those from find_function_start_sal, otherwise false
4287 multiple-locations breakpoints could be placed. */
4290 minsym_found (struct linespec_state *self, struct objfile *objfile,
4291 struct minimal_symbol *msymbol,
4292 std::vector<symtab_and_line> *result)
4294 bool want_start_sal;
4296 CORE_ADDR func_addr;
4297 bool is_function = msymbol_is_function (objfile, msymbol, &func_addr);
4301 const char *msym_name = MSYMBOL_LINKAGE_NAME (msymbol);
4303 if (MSYMBOL_TYPE (msymbol) == mst_text_gnu_ifunc
4304 || MSYMBOL_TYPE (msymbol) == mst_data_gnu_ifunc)
4305 want_start_sal = gnu_ifunc_resolve_name (msym_name, &func_addr);
4307 want_start_sal = true;
4310 symtab_and_line sal;
4312 if (is_function && want_start_sal)
4313 sal = find_function_start_sal (func_addr, NULL, self->funfirstline);
4316 sal.objfile = objfile;
4317 sal.msymbol = msymbol;
4318 /* Store func_addr, not the minsym's address in case this was an
4319 ifunc that hasn't been resolved yet. */
4323 sal.pc = MSYMBOL_VALUE_ADDRESS (objfile, msymbol);
4324 sal.pspace = current_program_space;
4327 sal.section = MSYMBOL_OBJ_SECTION (objfile, msymbol);
4329 if (maybe_add_address (self->addr_set, objfile->pspace, sal.pc))
4330 add_sal_to_sals (self, result, &sal, MSYMBOL_NATURAL_NAME (msymbol), 0);
4333 /* A helper function to classify a minimal_symbol_type according to
4337 classify_mtype (enum minimal_symbol_type t)
4344 /* Intermediate priority. */
4347 case mst_solib_trampoline:
4348 /* Lowest priority. */
4352 /* Highest priority. */
4357 /* Callback for std::sort that sorts symbols by priority. */
4360 compare_msyms (const bound_minimal_symbol &a, const bound_minimal_symbol &b)
4362 enum minimal_symbol_type ta = MSYMBOL_TYPE (a.minsym);
4363 enum minimal_symbol_type tb = MSYMBOL_TYPE (b.minsym);
4365 return classify_mtype (ta) < classify_mtype (tb);
4368 /* Helper for search_minsyms_for_name that adds the symbol to the
4372 add_minsym (struct minimal_symbol *minsym, struct objfile *objfile,
4373 struct symtab *symtab, int list_mode,
4374 std::vector<struct bound_minimal_symbol> *msyms)
4378 /* We're looking for a label for which we don't have debug
4380 CORE_ADDR func_addr;
4381 if (msymbol_is_function (objfile, minsym, &func_addr))
4383 symtab_and_line sal = find_pc_sect_line (func_addr, NULL, 0);
4385 if (symtab != sal.symtab)
4390 /* Exclude data symbols when looking for breakpoint locations. */
4391 if (!list_mode && !msymbol_is_function (objfile, minsym))
4394 struct bound_minimal_symbol mo = {minsym, objfile};
4395 msyms->push_back (mo);
4399 /* Search for minimal symbols called NAME. If SEARCH_PSPACE
4400 is not NULL, the search is restricted to just that program
4403 If SYMTAB is NULL, search all objfiles, otherwise
4404 restrict results to the given SYMTAB. */
4407 search_minsyms_for_name (struct collect_info *info,
4408 const lookup_name_info &name,
4409 struct program_space *search_pspace,
4410 struct symtab *symtab)
4412 std::vector<struct bound_minimal_symbol> minsyms;
4416 struct program_space *pspace;
4418 ALL_PSPACES (pspace)
4420 struct objfile *objfile;
4422 if (search_pspace != NULL && search_pspace != pspace)
4424 if (pspace->executing_startup)
4427 set_current_program_space (pspace);
4429 ALL_OBJFILES (objfile)
4431 iterate_over_minimal_symbols (objfile, name,
4432 [&] (struct minimal_symbol *msym)
4434 add_minsym (msym, objfile, nullptr,
4435 info->state->list_mode,
4444 if (search_pspace == NULL || SYMTAB_PSPACE (symtab) == search_pspace)
4446 set_current_program_space (SYMTAB_PSPACE (symtab));
4447 iterate_over_minimal_symbols
4448 (SYMTAB_OBJFILE (symtab), name,
4449 [&] (struct minimal_symbol *msym)
4451 add_minsym (msym, SYMTAB_OBJFILE (symtab), symtab,
4452 info->state->list_mode, &minsyms);
4458 if (!minsyms.empty ())
4462 std::sort (minsyms.begin (), minsyms.end (), compare_msyms);
4464 /* Now the minsyms are in classification order. So, we walk
4465 over them and process just the minsyms with the same
4466 classification as the very first minsym in the list. */
4467 classification = classify_mtype (MSYMBOL_TYPE (minsyms[0].minsym));
4469 for (const bound_minimal_symbol &item : minsyms)
4471 if (classify_mtype (MSYMBOL_TYPE (item.minsym)) != classification)
4474 VEC_safe_push (bound_minimal_symbol_d,
4475 info->result.minimal_symbols, &item);
4480 /* A helper function to add all symbols matching NAME to INFO. If
4481 PSPACE is not NULL, the search is restricted to just that program
4485 add_matching_symbols_to_info (const char *name,
4486 symbol_name_match_type name_match_type,
4487 enum search_domain search_domain,
4488 struct collect_info *info,
4489 struct program_space *pspace)
4494 lookup_name_info lookup_name (name, name_match_type);
4496 for (ix = 0; VEC_iterate (symtab_ptr, info->file_symtabs, ix, elt); ++ix)
4500 iterate_over_all_matching_symtabs (info->state, lookup_name,
4501 VAR_DOMAIN, search_domain,
4502 pspace, true, [&] (symbol *sym)
4503 { return info->add_symbol (sym); });
4504 search_minsyms_for_name (info, lookup_name, pspace, NULL);
4506 else if (pspace == NULL || pspace == SYMTAB_PSPACE (elt))
4508 int prev_len = VEC_length (symbolp, info->result.symbols);
4510 /* Program spaces that are executing startup should have
4511 been filtered out earlier. */
4512 gdb_assert (!SYMTAB_PSPACE (elt)->executing_startup);
4513 set_current_program_space (SYMTAB_PSPACE (elt));
4514 iterate_over_file_blocks (elt, lookup_name, VAR_DOMAIN,
4516 { return info->add_symbol (sym); });
4518 /* If no new symbols were found in this iteration and this symtab
4519 is in assembler, we might actually be looking for a label for
4520 which we don't have debug info. Check for a minimal symbol in
4522 if (prev_len == VEC_length (symbolp, info->result.symbols)
4523 && elt->language == language_asm)
4524 search_minsyms_for_name (info, lookup_name, pspace, elt);
4531 /* Now come some functions that are called from multiple places within
4535 symbol_to_sal (struct symtab_and_line *result,
4536 int funfirstline, struct symbol *sym)
4538 if (SYMBOL_CLASS (sym) == LOC_BLOCK)
4540 *result = find_function_start_sal (sym, funfirstline);
4545 if (SYMBOL_CLASS (sym) == LOC_LABEL && SYMBOL_VALUE_ADDRESS (sym) != 0)
4548 result->symtab = symbol_symtab (sym);
4549 result->symbol = sym;
4550 result->line = SYMBOL_LINE (sym);
4551 result->pc = SYMBOL_VALUE_ADDRESS (sym);
4552 result->pspace = SYMTAB_PSPACE (result->symtab);
4553 result->explicit_pc = 1;
4556 else if (funfirstline)
4560 else if (SYMBOL_LINE (sym) != 0)
4562 /* We know its line number. */
4564 result->symtab = symbol_symtab (sym);
4565 result->symbol = sym;
4566 result->line = SYMBOL_LINE (sym);
4567 result->pc = SYMBOL_VALUE_ADDRESS (sym);
4568 result->pspace = SYMTAB_PSPACE (result->symtab);
4576 linespec_result::~linespec_result ()
4578 for (linespec_sals &lsal : lsals)
4579 xfree (lsal.canonical);
4582 /* Return the quote characters permitted by the linespec parser. */
4585 get_gdb_linespec_parser_quote_characters (void)
4587 return linespec_quote_characters;