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 for unique_ptrs of vectors of symtabs. */
82 typedef std::unique_ptr<std::vector<symtab *>> symtab_vector_up;
84 typedef struct symbol *symbolp;
87 /* An address entry is used to ensure that any given location is only
88 added to the result a single time. It holds an address and the
89 program space from which the address came. */
93 struct program_space *pspace;
97 typedef struct bound_minimal_symbol bound_minimal_symbol_d;
99 DEF_VEC_O (bound_minimal_symbol_d);
101 /* A linespec. Elements of this structure are filled in by a parser
102 (either parse_linespec or some other function). The structure is
103 then converted into SALs by convert_linespec_to_sals. */
107 /* An explicit location describing the SaLs. */
108 struct explicit_location explicit_loc;
110 /* The list of symtabs to search to which to limit the search. May not
111 be NULL. If explicit.SOURCE_FILENAME is NULL (no user-specified
112 filename), FILE_SYMTABS should contain one single NULL member. This
113 will cause the code to use the default symtab. */
114 std::vector<symtab *> *file_symtabs;
116 /* A list of matching function symbols and minimal symbols. Both lists
117 may be NULL (or empty) if no matching symbols were found. */
118 std::vector<symbol *> *function_symbols;
119 VEC (bound_minimal_symbol_d) *minimal_symbols;
121 /* A structure of matching label symbols and the corresponding
122 function symbol in which the label was found. Both may be NULL
123 or both must be non-NULL. */
126 VEC (symbolp) *label_symbols;
127 std::vector<symbol *> *function_symbols;
130 typedef struct linespec *linespec_p;
132 /* A canonical linespec represented as a symtab-related string.
134 Each entry represents the "SYMTAB:SUFFIX" linespec string.
135 SYMTAB can be converted for example by symtab_to_fullname or
136 symtab_to_filename_for_display as needed. */
138 struct linespec_canonical_name
140 /* Remaining text part of the linespec string. */
143 /* If NULL then SUFFIX is the whole linespec string. */
144 struct symtab *symtab;
147 /* An instance of this is used to keep all state while linespec
148 operates. This instance is passed around as a 'this' pointer to
149 the various implementation methods. */
151 struct linespec_state
153 /* The language in use during linespec processing. */
154 const struct language_defn *language;
156 /* The program space as seen when the module was entered. */
157 struct program_space *program_space;
159 /* If not NULL, the search is restricted to just this program
161 struct program_space *search_pspace;
163 /* The default symtab to use, if no other symtab is specified. */
164 struct symtab *default_symtab;
166 /* The default line to use. */
169 /* The 'funfirstline' value that was passed in to decode_line_1 or
173 /* Nonzero if we are running in 'list' mode; see decode_line_list. */
176 /* The 'canonical' value passed to decode_line_full, or NULL. */
177 struct linespec_result *canonical;
179 /* Canonical strings that mirror the std::vector<symtab_and_line> result. */
180 struct linespec_canonical_name *canonical_names;
182 /* This is a set of address_entry objects which is used to prevent
183 duplicate symbols from being entered into the result. */
186 /* Are we building a linespec? */
190 /* This is a helper object that is used when collecting symbols into a
195 /* The linespec object in use. */
196 struct linespec_state *state;
198 /* A list of symtabs to which to restrict matches. */
199 std::vector<symtab *> *file_symtabs;
201 /* The result being accumulated. */
204 std::vector<symbol *> *symbols;
205 VEC (bound_minimal_symbol_d) *minimal_symbols;
208 /* Possibly add a symbol to the results. */
209 bool add_symbol (symbol *sym);
213 collect_info::add_symbol (symbol *sym)
215 /* In list mode, add all matching symbols, regardless of class.
216 This allows the user to type "list a_global_variable". */
217 if (SYMBOL_CLASS (sym) == LOC_BLOCK || this->state->list_mode)
218 this->result.symbols->push_back (sym);
220 /* Continue iterating. */
231 /* A colon "separator" */
243 /* EOI (end of input) */
249 typedef enum ls_token_type linespec_token_type;
251 /* List of keywords. This is NULL-terminated so that it can be used
252 as enum completer. */
253 const char * const linespec_keywords[] = { "if", "thread", "task", NULL };
254 #define IF_KEYWORD_INDEX 0
256 /* A token of the linespec lexer */
260 /* The type of the token */
261 linespec_token_type type;
263 /* Data for the token */
266 /* A string, given as a stoken */
267 struct stoken string;
273 typedef struct ls_token linespec_token;
275 #define LS_TOKEN_STOKEN(TOK) (TOK).data.string
276 #define LS_TOKEN_KEYWORD(TOK) (TOK).data.keyword
278 /* An instance of the linespec parser. */
282 /* Lexer internal data */
285 /* Save head of input stream. */
286 const char *saved_arg;
288 /* Head of the input stream. */
290 #define PARSER_STREAM(P) ((P)->lexer.stream)
292 /* The current token. */
293 linespec_token current;
296 /* Is the entire linespec quote-enclosed? */
297 int is_quote_enclosed;
299 /* The state of the parse. */
300 struct linespec_state state;
301 #define PARSER_STATE(PPTR) (&(PPTR)->state)
303 /* The result of the parse. */
304 struct linespec result;
305 #define PARSER_RESULT(PPTR) (&(PPTR)->result)
307 /* What the parser believes the current word point should complete
309 linespec_complete_what complete_what;
311 /* The completion word point. The parser advances this as it skips
312 tokens. At some point the input string will end or parsing will
313 fail, and then we attempt completion at the captured completion
314 word point, interpreting the string at completion_word as
316 const char *completion_word;
318 /* If the current token was a quoted string, then this is the
319 quoting character (either " or '). */
320 int completion_quote_char;
322 /* If the current token was a quoted string, then this points at the
323 end of the quoted string. */
324 const char *completion_quote_end;
326 /* If parsing for completion, then this points at the completion
327 tracker. Otherwise, this is NULL. */
328 struct completion_tracker *completion_tracker;
330 typedef struct ls_parser linespec_parser;
332 /* A convenience macro for accessing the explicit location result of
334 #define PARSER_EXPLICIT(PPTR) (&PARSER_RESULT ((PPTR))->explicit_loc)
336 /* Prototypes for local functions. */
338 static void iterate_over_file_blocks
339 (struct symtab *symtab, const lookup_name_info &name,
341 gdb::function_view<symbol_found_callback_ftype> callback);
343 static void initialize_defaults (struct symtab **default_symtab,
346 CORE_ADDR linespec_expression_to_pc (const char **exp_ptr);
348 static std::vector<symtab_and_line> decode_objc (struct linespec_state *self,
352 static symtab_vector_up symtabs_from_filename
353 (const char *, struct program_space *pspace);
355 static VEC (symbolp) *find_label_symbols
356 (struct linespec_state *self, std::vector<symbol *> *function_symbols,
357 std::vector<symbol *> *label_funcs_ret, const char *name,
358 bool completion_mode = false);
360 static void find_linespec_symbols (struct linespec_state *self,
361 std::vector<symtab *> *file_symtabs,
363 symbol_name_match_type name_match_type,
364 std::vector<symbol *> *symbols,
365 VEC (bound_minimal_symbol_d) **minsyms);
367 static struct line_offset
368 linespec_parse_variable (struct linespec_state *self,
369 const char *variable);
371 static int symbol_to_sal (struct symtab_and_line *result,
372 int funfirstline, struct symbol *sym);
374 static void add_matching_symbols_to_info (const char *name,
375 symbol_name_match_type name_match_type,
376 enum search_domain search_domain,
377 struct collect_info *info,
378 struct program_space *pspace);
380 static void add_all_symbol_names_from_pspace
381 (struct collect_info *info, struct program_space *pspace,
382 const std::vector<const char *> &names, enum search_domain search_domain);
384 static symtab_vector_up
385 collect_symtabs_from_filename (const char *file,
386 struct program_space *pspace);
388 static std::vector<symtab_and_line> decode_digits_ordinary
389 (struct linespec_state *self,
392 linetable_entry **best_entry);
394 static std::vector<symtab_and_line> decode_digits_list_mode
395 (struct linespec_state *self,
397 struct symtab_and_line val);
399 static void minsym_found (struct linespec_state *self, struct objfile *objfile,
400 struct minimal_symbol *msymbol,
401 std::vector<symtab_and_line> *result);
403 static int compare_symbols (const void *a, const void *b);
404 static bool std_compare_symbols (const struct symbol *a,
405 const struct symbol *b);
407 static int compare_msymbols (const void *a, const void *b);
409 /* Permitted quote characters for the parser. This is different from the
410 completer's quote characters to allow backward compatibility with the
412 static const char *const linespec_quote_characters = "\"\'";
414 /* Lexer functions. */
416 /* Lex a number from the input in PARSER. This only supports
419 Return true if input is decimal numbers. Return false if not. */
422 linespec_lexer_lex_number (linespec_parser *parser, linespec_token *tokenp)
424 tokenp->type = LSTOKEN_NUMBER;
425 LS_TOKEN_STOKEN (*tokenp).length = 0;
426 LS_TOKEN_STOKEN (*tokenp).ptr = PARSER_STREAM (parser);
428 /* Keep any sign at the start of the stream. */
429 if (*PARSER_STREAM (parser) == '+' || *PARSER_STREAM (parser) == '-')
431 ++LS_TOKEN_STOKEN (*tokenp).length;
432 ++(PARSER_STREAM (parser));
435 while (isdigit (*PARSER_STREAM (parser)))
437 ++LS_TOKEN_STOKEN (*tokenp).length;
438 ++(PARSER_STREAM (parser));
441 /* If the next character in the input buffer is not a space, comma,
442 quote, or colon, this input does not represent a number. */
443 if (*PARSER_STREAM (parser) != '\0'
444 && !isspace (*PARSER_STREAM (parser)) && *PARSER_STREAM (parser) != ','
445 && *PARSER_STREAM (parser) != ':'
446 && !strchr (linespec_quote_characters, *PARSER_STREAM (parser)))
448 PARSER_STREAM (parser) = LS_TOKEN_STOKEN (*tokenp).ptr;
455 /* See linespec.h. */
458 linespec_lexer_lex_keyword (const char *p)
464 for (i = 0; linespec_keywords[i] != NULL; ++i)
466 int len = strlen (linespec_keywords[i]);
468 /* If P begins with one of the keywords and the next
469 character is whitespace, we may have found a keyword.
470 It is only a keyword if it is not followed by another
472 if (strncmp (p, linespec_keywords[i], len) == 0
477 /* Special case: "if" ALWAYS stops the lexer, since it
478 is not possible to predict what is going to appear in
479 the condition, which can only be parsed after SaLs have
481 if (i != IF_KEYWORD_INDEX)
485 for (j = 0; linespec_keywords[j] != NULL; ++j)
487 int nextlen = strlen (linespec_keywords[j]);
489 if (strncmp (p, linespec_keywords[j], nextlen) == 0
490 && isspace (p[nextlen]))
495 return linespec_keywords[i];
503 /* See description in linespec.h. */
506 is_ada_operator (const char *string)
508 const struct ada_opname_map *mapping;
510 for (mapping = ada_opname_table;
511 mapping->encoded != NULL
512 && !startswith (string, mapping->decoded); ++mapping)
515 return mapping->decoded == NULL ? 0 : strlen (mapping->decoded);
518 /* Find QUOTE_CHAR in STRING, accounting for the ':' terminal. Return
519 the location of QUOTE_CHAR, or NULL if not found. */
522 skip_quote_char (const char *string, char quote_char)
524 const char *p, *last;
526 p = last = find_toplevel_char (string, quote_char);
527 while (p && *p != '\0' && *p != ':')
529 p = find_toplevel_char (p, quote_char);
537 /* Make a writable copy of the string given in TOKEN, trimming
538 any trailing whitespace. */
540 static gdb::unique_xmalloc_ptr<char>
541 copy_token_string (linespec_token token)
545 if (token.type == LSTOKEN_KEYWORD)
546 return gdb::unique_xmalloc_ptr<char> (xstrdup (LS_TOKEN_KEYWORD (token)));
548 str = LS_TOKEN_STOKEN (token).ptr;
549 s = remove_trailing_whitespace (str, str + LS_TOKEN_STOKEN (token).length);
551 return gdb::unique_xmalloc_ptr<char> (savestring (str, s - str));
554 /* Does P represent the end of a quote-enclosed linespec? */
557 is_closing_quote_enclosed (const char *p)
559 if (strchr (linespec_quote_characters, *p))
561 p = skip_spaces ((char *) p);
562 return (*p == '\0' || linespec_lexer_lex_keyword (p));
565 /* Find the end of the parameter list that starts with *INPUT.
566 This helper function assists with lexing string segments
567 which might contain valid (non-terminating) commas. */
570 find_parameter_list_end (const char *input)
572 char end_char, start_char;
577 if (start_char == '(')
579 else if (start_char == '<')
588 if (*p == start_char)
590 else if (*p == end_char)
604 /* If the [STRING, STRING_LEN) string ends with what looks like a
605 keyword, return the keyword start offset in STRING. Return -1
609 string_find_incomplete_keyword_at_end (const char * const *keywords,
610 const char *string, size_t string_len)
612 const char *end = string + string_len;
615 while (p > string && *p != ' ')
620 size_t len = end - p;
621 for (size_t i = 0; keywords[i] != NULL; ++i)
622 if (strncmp (keywords[i], p, len) == 0)
629 /* Lex a string from the input in PARSER. */
631 static linespec_token
632 linespec_lexer_lex_string (linespec_parser *parser)
634 linespec_token token;
635 const char *start = PARSER_STREAM (parser);
637 token.type = LSTOKEN_STRING;
639 /* If the input stream starts with a quote character, skip to the next
640 quote character, regardless of the content. */
641 if (strchr (linespec_quote_characters, *PARSER_STREAM (parser)))
644 char quote_char = *PARSER_STREAM (parser);
646 /* Special case: Ada operators. */
647 if (PARSER_STATE (parser)->language->la_language == language_ada
648 && quote_char == '\"')
650 int len = is_ada_operator (PARSER_STREAM (parser));
654 /* The input is an Ada operator. Return the quoted string
656 LS_TOKEN_STOKEN (token).ptr = PARSER_STREAM (parser);
657 LS_TOKEN_STOKEN (token).length = len;
658 PARSER_STREAM (parser) += len;
662 /* The input does not represent an Ada operator -- fall through
663 to normal quoted string handling. */
666 /* Skip past the beginning quote. */
667 ++(PARSER_STREAM (parser));
669 /* Mark the start of the string. */
670 LS_TOKEN_STOKEN (token).ptr = PARSER_STREAM (parser);
672 /* Skip to the ending quote. */
673 end = skip_quote_char (PARSER_STREAM (parser), quote_char);
675 /* This helps the completer mode decide whether we have a
677 parser->completion_quote_char = quote_char;
678 parser->completion_quote_end = end;
680 /* Error if the input did not terminate properly, unless in
684 if (parser->completion_tracker == NULL)
685 error (_("unmatched quote"));
687 /* In completion mode, we'll try to complete the incomplete
689 token.type = LSTOKEN_STRING;
690 while (*PARSER_STREAM (parser) != '\0')
691 PARSER_STREAM (parser)++;
692 LS_TOKEN_STOKEN (token).length = PARSER_STREAM (parser) - 1 - start;
696 /* Skip over the ending quote and mark the length of the string. */
697 PARSER_STREAM (parser) = (char *) ++end;
698 LS_TOKEN_STOKEN (token).length = PARSER_STREAM (parser) - 2 - start;
705 /* Otherwise, only identifier characters are permitted.
706 Spaces are the exception. In general, we keep spaces,
707 but only if the next characters in the input do not resolve
708 to one of the keywords.
710 This allows users to forgo quoting CV-qualifiers, template arguments,
711 and similar common language constructs. */
715 if (isspace (*PARSER_STREAM (parser)))
717 p = skip_spaces (PARSER_STREAM (parser));
718 /* When we get here we know we've found something followed by
719 a space (we skip over parens and templates below).
720 So if we find a keyword now, we know it is a keyword and not,
721 say, a function name. */
722 if (linespec_lexer_lex_keyword (p) != NULL)
724 LS_TOKEN_STOKEN (token).ptr = start;
725 LS_TOKEN_STOKEN (token).length
726 = PARSER_STREAM (parser) - start;
730 /* Advance past the whitespace. */
731 PARSER_STREAM (parser) = p;
734 /* If the next character is EOI or (single) ':', the
735 string is complete; return the token. */
736 if (*PARSER_STREAM (parser) == 0)
738 LS_TOKEN_STOKEN (token).ptr = start;
739 LS_TOKEN_STOKEN (token).length = PARSER_STREAM (parser) - start;
742 else if (PARSER_STREAM (parser)[0] == ':')
744 /* Do not tokenize the C++ scope operator. */
745 if (PARSER_STREAM (parser)[1] == ':')
746 ++(PARSER_STREAM (parser));
748 /* Do not tokenize ABI tags such as "[abi:cxx11]". */
749 else if (PARSER_STREAM (parser) - start > 4
750 && startswith (PARSER_STREAM (parser) - 4, "[abi"))
751 ++(PARSER_STREAM (parser));
753 /* Do not tokenify if the input length so far is one
754 (i.e, a single-letter drive name) and the next character
755 is a directory separator. This allows Windows-style
756 paths to be recognized as filenames without quoting it. */
757 else if ((PARSER_STREAM (parser) - start) != 1
758 || !IS_DIR_SEPARATOR (PARSER_STREAM (parser)[1]))
760 LS_TOKEN_STOKEN (token).ptr = start;
761 LS_TOKEN_STOKEN (token).length
762 = PARSER_STREAM (parser) - start;
766 /* Special case: permit quote-enclosed linespecs. */
767 else if (parser->is_quote_enclosed
768 && strchr (linespec_quote_characters,
769 *PARSER_STREAM (parser))
770 && is_closing_quote_enclosed (PARSER_STREAM (parser)))
772 LS_TOKEN_STOKEN (token).ptr = start;
773 LS_TOKEN_STOKEN (token).length = PARSER_STREAM (parser) - start;
776 /* Because commas may terminate a linespec and appear in
777 the middle of valid string input, special cases for
778 '<' and '(' are necessary. */
779 else if (*PARSER_STREAM (parser) == '<'
780 || *PARSER_STREAM (parser) == '(')
782 /* Don't interpret 'operator<' / 'operator<<' as a
783 template parameter list though. */
784 if (*PARSER_STREAM (parser) == '<'
785 && (PARSER_STATE (parser)->language->la_language
787 && (PARSER_STREAM (parser) - start) >= CP_OPERATOR_LEN)
789 const char *p = PARSER_STREAM (parser);
791 while (p > start && isspace (p[-1]))
793 if (p - start >= CP_OPERATOR_LEN)
795 p -= CP_OPERATOR_LEN;
796 if (strncmp (p, CP_OPERATOR_STR, CP_OPERATOR_LEN) == 0
798 || !(isalnum (p[-1]) || p[-1] == '_')))
800 /* This is an operator name. Keep going. */
801 ++(PARSER_STREAM (parser));
802 if (*PARSER_STREAM (parser) == '<')
803 ++(PARSER_STREAM (parser));
809 const char *p = find_parameter_list_end (PARSER_STREAM (parser));
810 PARSER_STREAM (parser) = p;
812 /* Don't loop around to the normal \0 case above because
813 we don't want to misinterpret a potential keyword at
814 the end of the token when the string isn't
815 "()<>"-balanced. This handles "b
816 function(thread<tab>" in completion mode. */
819 LS_TOKEN_STOKEN (token).ptr = start;
820 LS_TOKEN_STOKEN (token).length
821 = PARSER_STREAM (parser) - start;
827 /* Commas are terminators, but not if they are part of an
829 else if (*PARSER_STREAM (parser) == ',')
831 if ((PARSER_STATE (parser)->language->la_language
833 && (PARSER_STREAM (parser) - start) > CP_OPERATOR_LEN)
835 const char *p = strstr (start, CP_OPERATOR_STR);
837 if (p != NULL && is_operator_name (p))
839 /* This is an operator name. Keep going. */
840 ++(PARSER_STREAM (parser));
845 /* Comma terminates the string. */
846 LS_TOKEN_STOKEN (token).ptr = start;
847 LS_TOKEN_STOKEN (token).length = PARSER_STREAM (parser) - start;
851 /* Advance the stream. */
852 ++(PARSER_STREAM (parser));
859 /* Lex a single linespec token from PARSER. */
861 static linespec_token
862 linespec_lexer_lex_one (linespec_parser *parser)
866 if (parser->lexer.current.type == LSTOKEN_CONSUMED)
868 /* Skip any whitespace. */
869 PARSER_STREAM (parser) = skip_spaces (PARSER_STREAM (parser));
871 /* Check for a keyword, they end the linespec. */
872 keyword = linespec_lexer_lex_keyword (PARSER_STREAM (parser));
875 parser->lexer.current.type = LSTOKEN_KEYWORD;
876 LS_TOKEN_KEYWORD (parser->lexer.current) = keyword;
877 /* We do not advance the stream here intentionally:
878 we would like lexing to stop when a keyword is seen.
880 PARSER_STREAM (parser) += strlen (keyword); */
882 return parser->lexer.current;
885 /* Handle other tokens. */
886 switch (*PARSER_STREAM (parser))
889 parser->lexer.current.type = LSTOKEN_EOI;
893 case '0': case '1': case '2': case '3': case '4':
894 case '5': case '6': case '7': case '8': case '9':
895 if (!linespec_lexer_lex_number (parser, &(parser->lexer.current)))
896 parser->lexer.current = linespec_lexer_lex_string (parser);
900 /* If we have a scope operator, lex the input as a string.
901 Otherwise, return LSTOKEN_COLON. */
902 if (PARSER_STREAM (parser)[1] == ':')
903 parser->lexer.current = linespec_lexer_lex_string (parser);
906 parser->lexer.current.type = LSTOKEN_COLON;
907 ++(PARSER_STREAM (parser));
911 case '\'': case '\"':
912 /* Special case: permit quote-enclosed linespecs. */
913 if (parser->is_quote_enclosed
914 && is_closing_quote_enclosed (PARSER_STREAM (parser)))
916 ++(PARSER_STREAM (parser));
917 parser->lexer.current.type = LSTOKEN_EOI;
920 parser->lexer.current = linespec_lexer_lex_string (parser);
924 parser->lexer.current.type = LSTOKEN_COMMA;
925 LS_TOKEN_STOKEN (parser->lexer.current).ptr
926 = PARSER_STREAM (parser);
927 LS_TOKEN_STOKEN (parser->lexer.current).length = 1;
928 ++(PARSER_STREAM (parser));
932 /* If the input is not a number, it must be a string.
933 [Keywords were already considered above.] */
934 parser->lexer.current = linespec_lexer_lex_string (parser);
939 return parser->lexer.current;
942 /* Consume the current token and return the next token in PARSER's
943 input stream. Also advance the completion word for completion
946 static linespec_token
947 linespec_lexer_consume_token (linespec_parser *parser)
949 gdb_assert (parser->lexer.current.type != LSTOKEN_EOI);
951 bool advance_word = (parser->lexer.current.type != LSTOKEN_STRING
952 || *PARSER_STREAM (parser) != '\0');
954 /* If we're moving past a string to some other token, it must be the
955 quote was terminated. */
956 if (parser->completion_quote_char)
958 gdb_assert (parser->lexer.current.type == LSTOKEN_STRING);
960 /* If the string was the last (non-EOI) token, we're past the
961 quote, but remember that for later. */
962 if (*PARSER_STREAM (parser) != '\0')
964 parser->completion_quote_char = '\0';
965 parser->completion_quote_end = NULL;;
969 parser->lexer.current.type = LSTOKEN_CONSUMED;
970 linespec_lexer_lex_one (parser);
972 if (parser->lexer.current.type == LSTOKEN_STRING)
974 /* Advance the completion word past a potential initial
976 parser->completion_word = LS_TOKEN_STOKEN (parser->lexer.current).ptr;
978 else if (advance_word)
980 /* Advance the completion word past any whitespace. */
981 parser->completion_word = PARSER_STREAM (parser);
984 return parser->lexer.current;
987 /* Return the next token without consuming the current token. */
989 static linespec_token
990 linespec_lexer_peek_token (linespec_parser *parser)
993 const char *saved_stream = PARSER_STREAM (parser);
994 linespec_token saved_token = parser->lexer.current;
995 int saved_completion_quote_char = parser->completion_quote_char;
996 const char *saved_completion_quote_end = parser->completion_quote_end;
997 const char *saved_completion_word = parser->completion_word;
999 next = linespec_lexer_consume_token (parser);
1000 PARSER_STREAM (parser) = saved_stream;
1001 parser->lexer.current = saved_token;
1002 parser->completion_quote_char = saved_completion_quote_char;
1003 parser->completion_quote_end = saved_completion_quote_end;
1004 parser->completion_word = saved_completion_word;
1008 /* Helper functions. */
1010 /* Add SAL to SALS, and also update SELF->CANONICAL_NAMES to reflect
1011 the new sal, if needed. If not NULL, SYMNAME is the name of the
1012 symbol to use when constructing the new canonical name.
1014 If LITERAL_CANONICAL is non-zero, SYMNAME will be used as the
1015 canonical name for the SAL. */
1018 add_sal_to_sals (struct linespec_state *self,
1019 std::vector<symtab_and_line> *sals,
1020 struct symtab_and_line *sal,
1021 const char *symname, int literal_canonical)
1023 sals->push_back (*sal);
1025 if (self->canonical)
1027 struct linespec_canonical_name *canonical;
1029 self->canonical_names = XRESIZEVEC (struct linespec_canonical_name,
1030 self->canonical_names,
1032 canonical = &self->canonical_names[sals->size () - 1];
1033 if (!literal_canonical && sal->symtab)
1035 symtab_to_fullname (sal->symtab);
1037 /* Note that the filter doesn't have to be a valid linespec
1038 input. We only apply the ":LINE" treatment to Ada for
1040 if (symname != NULL && sal->line != 0
1041 && self->language->la_language == language_ada)
1042 canonical->suffix = xstrprintf ("%s:%d", symname, sal->line);
1043 else if (symname != NULL)
1044 canonical->suffix = xstrdup (symname);
1046 canonical->suffix = xstrprintf ("%d", sal->line);
1047 canonical->symtab = sal->symtab;
1051 if (symname != NULL)
1052 canonical->suffix = xstrdup (symname);
1054 canonical->suffix = xstrdup ("<unknown>");
1055 canonical->symtab = NULL;
1060 /* A hash function for address_entry. */
1063 hash_address_entry (const void *p)
1065 const struct address_entry *aep = (const struct address_entry *) p;
1068 hash = iterative_hash_object (aep->pspace, 0);
1069 return iterative_hash_object (aep->addr, hash);
1072 /* An equality function for address_entry. */
1075 eq_address_entry (const void *a, const void *b)
1077 const struct address_entry *aea = (const struct address_entry *) a;
1078 const struct address_entry *aeb = (const struct address_entry *) b;
1080 return aea->pspace == aeb->pspace && aea->addr == aeb->addr;
1083 /* Check whether the address, represented by PSPACE and ADDR, is
1084 already in the set. If so, return 0. Otherwise, add it and return
1088 maybe_add_address (htab_t set, struct program_space *pspace, CORE_ADDR addr)
1090 struct address_entry e, *p;
1095 slot = htab_find_slot (set, &e, INSERT);
1099 p = XNEW (struct address_entry);
1100 memcpy (p, &e, sizeof (struct address_entry));
1106 /* A helper that walks over all matching symtabs in all objfiles and
1107 calls CALLBACK for each symbol matching NAME. If SEARCH_PSPACE is
1108 not NULL, then the search is restricted to just that program
1109 space. If INCLUDE_INLINE is true then symbols representing
1110 inlined instances of functions will be included in the result. */
1113 iterate_over_all_matching_symtabs
1114 (struct linespec_state *state,
1115 const lookup_name_info &lookup_name,
1116 const domain_enum name_domain,
1117 enum search_domain search_domain,
1118 struct program_space *search_pspace, bool include_inline,
1119 gdb::function_view<symbol_found_callback_ftype> callback)
1121 struct objfile *objfile;
1122 struct program_space *pspace;
1124 ALL_PSPACES (pspace)
1126 if (search_pspace != NULL && search_pspace != pspace)
1128 if (pspace->executing_startup)
1131 set_current_program_space (pspace);
1133 ALL_OBJFILES (objfile)
1135 struct compunit_symtab *cu;
1138 objfile->sf->qf->expand_symtabs_matching (objfile,
1144 ALL_OBJFILE_COMPUNITS (objfile, cu)
1146 struct symtab *symtab = COMPUNIT_FILETABS (cu);
1148 iterate_over_file_blocks (symtab, lookup_name, name_domain, callback);
1152 struct block *block;
1155 for (i = FIRST_LOCAL_BLOCK;
1156 i < BLOCKVECTOR_NBLOCKS (SYMTAB_BLOCKVECTOR (symtab));
1159 block = BLOCKVECTOR_BLOCK (SYMTAB_BLOCKVECTOR (symtab), i);
1160 state->language->la_iterate_over_symbols
1161 (block, lookup_name, name_domain, [&] (symbol *sym)
1163 /* Restrict calls to CALLBACK to symbols
1164 representing inline symbols only. */
1165 if (SYMBOL_INLINED (sym))
1166 return callback (sym);
1176 /* Returns the block to be used for symbol searches from
1177 the current location. */
1179 static const struct block *
1180 get_current_search_block (void)
1182 const struct block *block;
1183 enum language save_language;
1185 /* get_selected_block can change the current language when there is
1186 no selected frame yet. */
1187 save_language = current_language->la_language;
1188 block = get_selected_block (0);
1189 set_language (save_language);
1194 /* Iterate over static and global blocks. */
1197 iterate_over_file_blocks
1198 (struct symtab *symtab, const lookup_name_info &name,
1199 domain_enum domain, gdb::function_view<symbol_found_callback_ftype> callback)
1201 struct block *block;
1203 for (block = BLOCKVECTOR_BLOCK (SYMTAB_BLOCKVECTOR (symtab), STATIC_BLOCK);
1205 block = BLOCK_SUPERBLOCK (block))
1206 LA_ITERATE_OVER_SYMBOLS (block, name, domain, callback);
1209 /* A helper for find_method. This finds all methods in type T of
1210 language T_LANG which match NAME. It adds matching symbol names to
1211 RESULT_NAMES, and adds T's direct superclasses to SUPERCLASSES. */
1214 find_methods (struct type *t, enum language t_lang, const char *name,
1215 std::vector<const char *> *result_names,
1216 std::vector<struct type *> *superclasses)
1219 const char *class_name = TYPE_NAME (t);
1221 /* Ignore this class if it doesn't have a name. This is ugly, but
1222 unless we figure out how to get the physname without the name of
1223 the class, then the loop can't do any good. */
1227 lookup_name_info lookup_name (name, symbol_name_match_type::FULL);
1228 symbol_name_matcher_ftype *symbol_name_compare
1229 = get_symbol_name_matcher (language_def (t_lang), lookup_name);
1231 t = check_typedef (t);
1233 /* Loop over each method name. At this level, all overloads of a name
1234 are counted as a single name. There is an inner loop which loops over
1237 for (method_counter = TYPE_NFN_FIELDS (t) - 1;
1238 method_counter >= 0;
1241 const char *method_name = TYPE_FN_FIELDLIST_NAME (t, method_counter);
1242 char dem_opname[64];
1244 if (startswith (method_name, "__") ||
1245 startswith (method_name, "op") ||
1246 startswith (method_name, "type"))
1248 if (cplus_demangle_opname (method_name, dem_opname, DMGL_ANSI))
1249 method_name = dem_opname;
1250 else if (cplus_demangle_opname (method_name, dem_opname, 0))
1251 method_name = dem_opname;
1254 if (symbol_name_compare (method_name, lookup_name, NULL))
1258 for (field_counter = (TYPE_FN_FIELDLIST_LENGTH (t, method_counter)
1264 const char *phys_name;
1266 f = TYPE_FN_FIELDLIST1 (t, method_counter);
1267 if (TYPE_FN_FIELD_STUB (f, field_counter))
1269 phys_name = TYPE_FN_FIELD_PHYSNAME (f, field_counter);
1270 result_names->push_back (phys_name);
1276 for (ibase = 0; ibase < TYPE_N_BASECLASSES (t); ibase++)
1277 superclasses->push_back (TYPE_BASECLASS (t, ibase));
1280 /* Find an instance of the character C in the string S that is outside
1281 of all parenthesis pairs, single-quoted strings, and double-quoted
1282 strings. Also, ignore the char within a template name, like a ','
1283 within foo<int, int>, while considering C++ operator</operator<<. */
1286 find_toplevel_char (const char *s, char c)
1288 int quoted = 0; /* zero if we're not in quotes;
1289 '"' if we're in a double-quoted string;
1290 '\'' if we're in a single-quoted string. */
1291 int depth = 0; /* Number of unclosed parens we've seen. */
1294 for (scan = s; *scan; scan++)
1298 if (*scan == quoted)
1300 else if (*scan == '\\' && *(scan + 1))
1303 else if (*scan == c && ! quoted && depth == 0)
1305 else if (*scan == '"' || *scan == '\'')
1307 else if (*scan == '(' || *scan == '<')
1309 else if ((*scan == ')' || *scan == '>') && depth > 0)
1311 else if (*scan == 'o' && !quoted && depth == 0)
1313 /* Handle C++ operator names. */
1314 if (strncmp (scan, CP_OPERATOR_STR, CP_OPERATOR_LEN) == 0)
1316 scan += CP_OPERATOR_LEN;
1319 while (isspace (*scan))
1330 /* Skip over one less than the appropriate number of
1331 characters: the for loop will skip over the last
1357 /* The string equivalent of find_toplevel_char. Returns a pointer
1358 to the location of NEEDLE in HAYSTACK, ignoring any occurrences
1359 inside "()" and "<>". Returns NULL if NEEDLE was not found. */
1362 find_toplevel_string (const char *haystack, const char *needle)
1364 const char *s = haystack;
1368 s = find_toplevel_char (s, *needle);
1372 /* Found first char in HAYSTACK; check rest of string. */
1373 if (startswith (s, needle))
1376 /* Didn't find it; loop over HAYSTACK, looking for the next
1377 instance of the first character of NEEDLE. */
1381 while (s != NULL && *s != '\0');
1383 /* NEEDLE was not found in HAYSTACK. */
1387 /* Convert CANONICAL to its string representation using
1388 symtab_to_fullname for SYMTAB. */
1391 canonical_to_fullform (const struct linespec_canonical_name *canonical)
1393 if (canonical->symtab == NULL)
1394 return canonical->suffix;
1396 return string_printf ("%s:%s", symtab_to_fullname (canonical->symtab),
1400 /* Given FILTERS, a list of canonical names, filter the sals in RESULT
1401 and store the result in SELF->CANONICAL. */
1404 filter_results (struct linespec_state *self,
1405 std::vector<symtab_and_line> *result,
1406 const std::vector<const char *> &filters)
1408 for (const char *name : filters)
1412 for (size_t j = 0; j < result->size (); ++j)
1414 const struct linespec_canonical_name *canonical;
1416 canonical = &self->canonical_names[j];
1417 std::string fullform = canonical_to_fullform (canonical);
1419 if (name == fullform)
1420 lsal.sals.push_back ((*result)[j]);
1423 if (!lsal.sals.empty ())
1425 lsal.canonical = xstrdup (name);
1426 self->canonical->lsals.push_back (std::move (lsal));
1430 self->canonical->pre_expanded = 0;
1433 /* Store RESULT into SELF->CANONICAL. */
1436 convert_results_to_lsals (struct linespec_state *self,
1437 std::vector<symtab_and_line> *result)
1439 struct linespec_sals lsal;
1441 lsal.canonical = NULL;
1442 lsal.sals = std::move (*result);
1443 self->canonical->lsals.push_back (std::move (lsal));
1446 /* A structure that contains two string representations of a struct
1447 linespec_canonical_name:
1448 - one where the the symtab's fullname is used;
1449 - one where the filename followed the "set filename-display"
1452 struct decode_line_2_item
1454 decode_line_2_item (std::string &&fullform_, std::string &&displayform_,
1456 : fullform (std::move (fullform_)),
1457 displayform (std::move (displayform_)),
1458 selected (selected_)
1462 /* The form using symtab_to_fullname. */
1463 std::string fullform;
1465 /* The form using symtab_to_filename_for_display. */
1466 std::string displayform;
1468 /* Field is initialized to zero and it is set to one if the user
1469 requested breakpoint for this entry. */
1470 unsigned int selected : 1;
1473 /* Helper for std::sort to sort decode_line_2_item entries by
1474 DISPLAYFORM and secondarily by FULLFORM. */
1477 decode_line_2_compare_items (const decode_line_2_item &a,
1478 const decode_line_2_item &b)
1480 if (a.displayform != b.displayform)
1481 return a.displayform < b.displayform;
1482 return a.fullform < b.fullform;
1485 /* Handle multiple results in RESULT depending on SELECT_MODE. This
1486 will either return normally, throw an exception on multiple
1487 results, or present a menu to the user. On return, the SALS vector
1488 in SELF->CANONICAL is set up properly. */
1491 decode_line_2 (struct linespec_state *self,
1492 std::vector<symtab_and_line> *result,
1493 const char *select_mode)
1498 std::vector<const char *> filters;
1499 std::vector<struct decode_line_2_item> items;
1501 gdb_assert (select_mode != multiple_symbols_all);
1502 gdb_assert (self->canonical != NULL);
1503 gdb_assert (!result->empty ());
1505 /* Prepare ITEMS array. */
1506 for (i = 0; i < result->size (); ++i)
1508 const struct linespec_canonical_name *canonical;
1509 std::string displayform;
1511 canonical = &self->canonical_names[i];
1512 gdb_assert (canonical->suffix != NULL);
1514 std::string fullform = canonical_to_fullform (canonical);
1516 if (canonical->symtab == NULL)
1517 displayform = canonical->suffix;
1520 const char *fn_for_display;
1522 fn_for_display = symtab_to_filename_for_display (canonical->symtab);
1523 displayform = string_printf ("%s:%s", fn_for_display,
1527 items.emplace_back (std::move (fullform), std::move (displayform),
1531 /* Sort the list of method names. */
1532 std::sort (items.begin (), items.end (), decode_line_2_compare_items);
1534 /* Remove entries with the same FULLFORM. */
1535 items.erase (std::unique (items.begin (), items.end (),
1536 [] (const struct decode_line_2_item &a,
1537 const struct decode_line_2_item &b)
1539 return a.fullform == b.fullform;
1543 if (select_mode == multiple_symbols_cancel && items.size () > 1)
1544 error (_("canceled because the command is ambiguous\n"
1545 "See set/show multiple-symbol."));
1547 if (select_mode == multiple_symbols_all || items.size () == 1)
1549 convert_results_to_lsals (self, result);
1553 printf_unfiltered (_("[0] cancel\n[1] all\n"));
1554 for (i = 0; i < items.size (); i++)
1555 printf_unfiltered ("[%d] %s\n", i + 2, items[i].displayform.c_str ());
1557 prompt = getenv ("PS2");
1562 args = command_line_input (prompt, "overload-choice");
1564 if (args == 0 || *args == 0)
1565 error_no_arg (_("one or more choice numbers"));
1567 number_or_range_parser parser (args);
1568 while (!parser.finished ())
1570 int num = parser.get_number ();
1573 error (_("canceled"));
1576 /* We intentionally make this result in a single breakpoint,
1577 contrary to what older versions of gdb did. The
1578 rationale is that this lets a user get the
1579 multiple_symbols_all behavior even with the 'ask'
1580 setting; and he can get separate breakpoints by entering
1581 "2-57" at the query. */
1582 convert_results_to_lsals (self, result);
1587 if (num >= items.size ())
1588 printf_unfiltered (_("No choice number %d.\n"), num);
1591 struct decode_line_2_item *item = &items[num];
1593 if (!item->selected)
1595 filters.push_back (item->fullform.c_str ());
1600 printf_unfiltered (_("duplicate request for %d ignored.\n"),
1606 filter_results (self, result, filters);
1611 /* The parser of linespec itself. */
1613 /* Throw an appropriate error when SYMBOL is not found (optionally in
1616 static void ATTRIBUTE_NORETURN
1617 symbol_not_found_error (const char *symbol, const char *filename)
1622 if (!have_full_symbols ()
1623 && !have_partial_symbols ()
1624 && !have_minimal_symbols ())
1625 throw_error (NOT_FOUND_ERROR,
1626 _("No symbol table is loaded. Use the \"file\" command."));
1628 /* If SYMBOL starts with '$', the user attempted to either lookup
1629 a function/variable in his code starting with '$' or an internal
1630 variable of that name. Since we do not know which, be concise and
1631 explain both possibilities. */
1635 throw_error (NOT_FOUND_ERROR,
1636 _("Undefined convenience variable or function \"%s\" "
1637 "not defined in \"%s\"."), symbol, filename);
1639 throw_error (NOT_FOUND_ERROR,
1640 _("Undefined convenience variable or function \"%s\" "
1641 "not defined."), symbol);
1646 throw_error (NOT_FOUND_ERROR,
1647 _("Function \"%s\" not defined in \"%s\"."),
1650 throw_error (NOT_FOUND_ERROR,
1651 _("Function \"%s\" not defined."), symbol);
1655 /* Throw an appropriate error when an unexpected token is encountered
1658 static void ATTRIBUTE_NORETURN
1659 unexpected_linespec_error (linespec_parser *parser)
1661 linespec_token token;
1662 static const char * token_type_strings[]
1663 = {"keyword", "colon", "string", "number", "comma", "end of input"};
1665 /* Get the token that generated the error. */
1666 token = linespec_lexer_lex_one (parser);
1668 /* Finally, throw the error. */
1669 if (token.type == LSTOKEN_STRING || token.type == LSTOKEN_NUMBER
1670 || token.type == LSTOKEN_KEYWORD)
1672 gdb::unique_xmalloc_ptr<char> string = copy_token_string (token);
1673 throw_error (GENERIC_ERROR,
1674 _("malformed linespec error: unexpected %s, \"%s\""),
1675 token_type_strings[token.type], string.get ());
1678 throw_error (GENERIC_ERROR,
1679 _("malformed linespec error: unexpected %s"),
1680 token_type_strings[token.type]);
1683 /* Throw an undefined label error. */
1685 static void ATTRIBUTE_NORETURN
1686 undefined_label_error (const char *function, const char *label)
1688 if (function != NULL)
1689 throw_error (NOT_FOUND_ERROR,
1690 _("No label \"%s\" defined in function \"%s\"."),
1693 throw_error (NOT_FOUND_ERROR,
1694 _("No label \"%s\" defined in current function."),
1698 /* Throw a source file not found error. */
1700 static void ATTRIBUTE_NORETURN
1701 source_file_not_found_error (const char *name)
1703 throw_error (NOT_FOUND_ERROR, _("No source file named %s."), name);
1706 /* Unless at EIO, save the current stream position as completion word
1707 point, and consume the next token. */
1709 static linespec_token
1710 save_stream_and_consume_token (linespec_parser *parser)
1712 if (linespec_lexer_peek_token (parser).type != LSTOKEN_EOI)
1713 parser->completion_word = PARSER_STREAM (parser);
1714 return linespec_lexer_consume_token (parser);
1717 /* See description in linespec.h. */
1720 linespec_parse_line_offset (const char *string)
1722 const char *start = string;
1723 struct line_offset line_offset = {0, LINE_OFFSET_NONE};
1727 line_offset.sign = LINE_OFFSET_PLUS;
1730 else if (*string == '-')
1732 line_offset.sign = LINE_OFFSET_MINUS;
1736 if (*string != '\0' && !isdigit (*string))
1737 error (_("malformed line offset: \"%s\""), start);
1739 /* Right now, we only allow base 10 for offsets. */
1740 line_offset.offset = atoi (string);
1744 /* In completion mode, if the user is still typing the number, there's
1745 no possible completion to offer. But if there's already input past
1746 the number, setup to expect NEXT. */
1749 set_completion_after_number (linespec_parser *parser,
1750 linespec_complete_what next)
1752 if (*PARSER_STREAM (parser) == ' ')
1754 parser->completion_word = skip_spaces (PARSER_STREAM (parser) + 1);
1755 parser->complete_what = next;
1759 parser->completion_word = PARSER_STREAM (parser);
1760 parser->complete_what = linespec_complete_what::NOTHING;
1764 /* Parse the basic_spec in PARSER's input. */
1767 linespec_parse_basic (linespec_parser *parser)
1769 gdb::unique_xmalloc_ptr<char> name;
1770 linespec_token token;
1771 std::vector<symbol *> symbols;
1772 VEC (symbolp) *labels;
1773 VEC (bound_minimal_symbol_d) *minimal_symbols;
1775 /* Get the next token. */
1776 token = linespec_lexer_lex_one (parser);
1778 /* If it is EOI or KEYWORD, issue an error. */
1779 if (token.type == LSTOKEN_KEYWORD)
1781 parser->complete_what = linespec_complete_what::NOTHING;
1782 unexpected_linespec_error (parser);
1784 else if (token.type == LSTOKEN_EOI)
1786 unexpected_linespec_error (parser);
1788 /* If it is a LSTOKEN_NUMBER, we have an offset. */
1789 else if (token.type == LSTOKEN_NUMBER)
1791 set_completion_after_number (parser, linespec_complete_what::KEYWORD);
1793 /* Record the line offset and get the next token. */
1794 name = copy_token_string (token);
1795 PARSER_EXPLICIT (parser)->line_offset
1796 = linespec_parse_line_offset (name.get ());
1798 /* Get the next token. */
1799 token = linespec_lexer_consume_token (parser);
1801 /* If the next token is a comma, stop parsing and return. */
1802 if (token.type == LSTOKEN_COMMA)
1804 parser->complete_what = linespec_complete_what::NOTHING;
1808 /* If the next token is anything but EOI or KEYWORD, issue
1810 if (token.type != LSTOKEN_KEYWORD && token.type != LSTOKEN_EOI)
1811 unexpected_linespec_error (parser);
1814 if (token.type == LSTOKEN_KEYWORD || token.type == LSTOKEN_EOI)
1817 /* Next token must be LSTOKEN_STRING. */
1818 if (token.type != LSTOKEN_STRING)
1820 parser->complete_what = linespec_complete_what::NOTHING;
1821 unexpected_linespec_error (parser);
1824 /* The current token will contain the name of a function, method,
1826 name = copy_token_string (token);
1828 if (parser->completion_tracker != NULL)
1830 /* If the function name ends with a ":", then this may be an
1831 incomplete "::" scope operator instead of a label separator.
1834 which should expand to:
1837 Do a tentative completion assuming the later. If we find
1838 completions, advance the stream past the colon token and make
1839 it part of the function name/token. */
1841 if (!parser->completion_quote_char
1842 && strcmp (PARSER_STREAM (parser), ":") == 0)
1844 completion_tracker tmp_tracker;
1845 const char *source_filename
1846 = PARSER_EXPLICIT (parser)->source_filename;
1847 symbol_name_match_type match_type
1848 = PARSER_EXPLICIT (parser)->func_name_match_type;
1850 linespec_complete_function (tmp_tracker,
1851 parser->completion_word,
1855 if (tmp_tracker.have_completions ())
1857 PARSER_STREAM (parser)++;
1858 LS_TOKEN_STOKEN (token).length++;
1860 name.reset (savestring (parser->completion_word,
1861 (PARSER_STREAM (parser)
1862 - parser->completion_word)));
1866 PARSER_EXPLICIT (parser)->function_name = name.release ();
1870 /* Try looking it up as a function/method. */
1871 find_linespec_symbols (PARSER_STATE (parser),
1872 PARSER_RESULT (parser)->file_symtabs, name.get (),
1873 PARSER_EXPLICIT (parser)->func_name_match_type,
1874 &symbols, &minimal_symbols);
1876 if (!symbols.empty () || minimal_symbols != NULL)
1878 PARSER_RESULT (parser)->function_symbols
1879 = new std::vector<symbol *> (std::move (symbols));
1880 PARSER_RESULT (parser)->minimal_symbols = minimal_symbols;
1881 PARSER_EXPLICIT (parser)->function_name = name.release ();
1885 /* NAME was not a function or a method. So it must be a label
1886 name or user specified variable like "break foo.c:$zippo". */
1887 labels = find_label_symbols (PARSER_STATE (parser), NULL,
1888 &symbols, name.get ());
1891 PARSER_RESULT (parser)->labels.label_symbols = labels;
1892 PARSER_RESULT (parser)->labels.function_symbols
1893 = new std::vector<symbol *> (std::move (symbols));
1894 PARSER_EXPLICIT (parser)->label_name = name.release ();
1896 else if (token.type == LSTOKEN_STRING
1897 && *LS_TOKEN_STOKEN (token).ptr == '$')
1899 /* User specified a convenience variable or history value. */
1900 PARSER_EXPLICIT (parser)->line_offset
1901 = linespec_parse_variable (PARSER_STATE (parser), name.get ());
1903 if (PARSER_EXPLICIT (parser)->line_offset.sign == LINE_OFFSET_UNKNOWN)
1905 /* The user-specified variable was not valid. Do not
1906 throw an error here. parse_linespec will do it for us. */
1907 PARSER_EXPLICIT (parser)->function_name = name.release ();
1913 /* The name is also not a label. Abort parsing. Do not throw
1914 an error here. parse_linespec will do it for us. */
1916 /* Save a copy of the name we were trying to lookup. */
1917 PARSER_EXPLICIT (parser)->function_name = name.release ();
1923 int previous_qc = parser->completion_quote_char;
1925 /* Get the next token. */
1926 token = linespec_lexer_consume_token (parser);
1928 if (token.type == LSTOKEN_EOI)
1930 if (previous_qc && !parser->completion_quote_char)
1931 parser->complete_what = linespec_complete_what::KEYWORD;
1933 else if (token.type == LSTOKEN_COLON)
1935 /* User specified a label or a lineno. */
1936 token = linespec_lexer_consume_token (parser);
1938 if (token.type == LSTOKEN_NUMBER)
1940 /* User specified an offset. Record the line offset and
1941 get the next token. */
1942 set_completion_after_number (parser, linespec_complete_what::KEYWORD);
1944 name = copy_token_string (token);
1945 PARSER_EXPLICIT (parser)->line_offset
1946 = linespec_parse_line_offset (name.get ());
1948 /* Get the next token. */
1949 token = linespec_lexer_consume_token (parser);
1951 else if (token.type == LSTOKEN_EOI && parser->completion_tracker != NULL)
1953 parser->complete_what = linespec_complete_what::LABEL;
1955 else if (token.type == LSTOKEN_STRING)
1957 parser->complete_what = linespec_complete_what::LABEL;
1959 /* If we have text after the label separated by whitespace
1960 (e.g., "b func():lab i<tab>"), don't consider it part of
1961 the label. In completion mode that should complete to
1962 "if", in normal mode, the 'i' should be treated as
1964 if (parser->completion_quote_char == '\0')
1966 const char *ptr = LS_TOKEN_STOKEN (token).ptr;
1967 for (size_t i = 0; i < LS_TOKEN_STOKEN (token).length; i++)
1971 LS_TOKEN_STOKEN (token).length = i;
1972 PARSER_STREAM (parser) = skip_spaces (ptr + i + 1);
1978 if (parser->completion_tracker != NULL)
1980 if (PARSER_STREAM (parser)[-1] == ' ')
1982 parser->completion_word = PARSER_STREAM (parser);
1983 parser->complete_what = linespec_complete_what::KEYWORD;
1988 /* Grab a copy of the label's name and look it up. */
1989 name = copy_token_string (token);
1991 = find_label_symbols (PARSER_STATE (parser),
1992 PARSER_RESULT (parser)->function_symbols,
1993 &symbols, name.get ());
1997 PARSER_RESULT (parser)->labels.label_symbols = labels;
1998 PARSER_RESULT (parser)->labels.function_symbols
1999 = new std::vector<symbol *> (std::move (symbols));
2000 PARSER_EXPLICIT (parser)->label_name = name.release ();
2004 /* We don't know what it was, but it isn't a label. */
2005 undefined_label_error
2006 (PARSER_EXPLICIT (parser)->function_name, name.get ());
2011 /* Check for a line offset. */
2012 token = save_stream_and_consume_token (parser);
2013 if (token.type == LSTOKEN_COLON)
2015 /* Get the next token. */
2016 token = linespec_lexer_consume_token (parser);
2018 /* It must be a line offset. */
2019 if (token.type != LSTOKEN_NUMBER)
2020 unexpected_linespec_error (parser);
2022 /* Record the line offset and get the next token. */
2023 name = copy_token_string (token);
2025 PARSER_EXPLICIT (parser)->line_offset
2026 = linespec_parse_line_offset (name.get ());
2028 /* Get the next token. */
2029 token = linespec_lexer_consume_token (parser);
2034 /* Trailing ':' in the input. Issue an error. */
2035 unexpected_linespec_error (parser);
2040 /* Canonicalize the linespec contained in LS. The result is saved into
2041 STATE->canonical. This function handles both linespec and explicit
2045 canonicalize_linespec (struct linespec_state *state, const linespec_p ls)
2047 struct event_location *canon;
2048 struct explicit_location *explicit_loc;
2050 /* If canonicalization was not requested, no need to do anything. */
2051 if (!state->canonical)
2054 /* Save everything as an explicit location. */
2055 state->canonical->location
2056 = new_explicit_location (&ls->explicit_loc);
2057 canon = state->canonical->location.get ();
2058 explicit_loc = get_explicit_location (canon);
2060 if (explicit_loc->label_name != NULL)
2062 state->canonical->special_display = 1;
2064 if (explicit_loc->function_name == NULL)
2066 /* No function was specified, so add the symbol name. */
2067 gdb_assert (!ls->labels.function_symbols->empty ()
2068 && (ls->labels.function_symbols->size () == 1));
2069 struct symbol *s = ls->labels.function_symbols->front ();
2070 explicit_loc->function_name = xstrdup (SYMBOL_NATURAL_NAME (s));
2074 /* If this location originally came from a linespec, save a string
2075 representation of it for display and saving to file. */
2076 if (state->is_linespec)
2078 char *linespec = explicit_location_to_linespec (explicit_loc);
2080 set_event_location_string (canon, linespec);
2085 /* Given a line offset in LS, construct the relevant SALs. */
2087 static std::vector<symtab_and_line>
2088 create_sals_line_offset (struct linespec_state *self,
2091 int use_default = 0;
2093 /* This is where we need to make sure we have good defaults.
2094 We must guarantee that this section of code is never executed
2095 when we are called with just a function name, since
2096 set_default_source_symtab_and_line uses
2097 select_source_symtab that calls us with such an argument. */
2099 if (ls->file_symtabs->size () == 1
2100 && ls->file_symtabs->front () == nullptr)
2102 const char *fullname;
2104 set_current_program_space (self->program_space);
2106 /* Make sure we have at least a default source line. */
2107 set_default_source_symtab_and_line ();
2108 initialize_defaults (&self->default_symtab, &self->default_line);
2109 fullname = symtab_to_fullname (self->default_symtab);
2110 symtab_vector_up r =
2111 collect_symtabs_from_filename (fullname, self->search_pspace);
2112 ls->file_symtabs = r.release ();
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 std::sort (ls->function_symbols->begin (),
2268 ls->function_symbols->end (),
2269 std_compare_symbols);
2271 for (const auto &sym : *ls->function_symbols)
2273 program_space *pspace = SYMTAB_PSPACE (symbol_symtab (sym));
2274 set_current_program_space (pspace);
2276 /* Don't skip to the first line of the function if we
2277 had found an ifunc minimal symbol for this function,
2278 because that means that this function is an ifunc
2279 resolver with the same name as the ifunc itself. */
2280 bool found_ifunc = false;
2282 if (state->funfirstline
2283 && ls->minimal_symbols != NULL
2284 && SYMBOL_CLASS (sym) == LOC_BLOCK)
2286 const CORE_ADDR addr
2287 = BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym));
2289 bound_minimal_symbol_d *elem;
2291 VEC_iterate (bound_minimal_symbol_d, ls->minimal_symbols,
2295 if (MSYMBOL_TYPE (elem->minsym) == mst_text_gnu_ifunc
2296 || MSYMBOL_TYPE (elem->minsym) == mst_data_gnu_ifunc)
2298 CORE_ADDR msym_addr = BMSYMBOL_VALUE_ADDRESS (*elem);
2299 if (MSYMBOL_TYPE (elem->minsym) == mst_data_gnu_ifunc)
2301 struct gdbarch *gdbarch
2302 = get_objfile_arch (elem->objfile);
2304 = (gdbarch_convert_from_func_ptr_addr
2307 current_top_target ()));
2310 if (msym_addr == addr)
2321 symtab_and_line sal;
2322 if (symbol_to_sal (&sal, state->funfirstline, sym)
2323 && maybe_add_address (state->addr_set, pspace, sal.pc))
2324 add_sal_to_sals (state, &sals, &sal,
2325 SYMBOL_NATURAL_NAME (sym), 0);
2330 if (ls->minimal_symbols != NULL)
2332 /* Sort minimal symbols by program space, too */
2333 qsort (VEC_address (bound_minimal_symbol_d, ls->minimal_symbols),
2334 VEC_length (bound_minimal_symbol_d, ls->minimal_symbols),
2335 sizeof (bound_minimal_symbol_d), compare_msymbols);
2337 bound_minimal_symbol_d *elem;
2340 VEC_iterate (bound_minimal_symbol_d, ls->minimal_symbols,
2344 program_space *pspace = elem->objfile->pspace;
2345 set_current_program_space (pspace);
2346 minsym_found (state, elem->objfile, elem->minsym, &sals);
2350 else if (ls->explicit_loc.line_offset.sign != LINE_OFFSET_UNKNOWN)
2352 /* Only an offset was specified. */
2353 sals = create_sals_line_offset (state, ls);
2355 /* Make sure we have a filename for canonicalization. */
2356 if (ls->explicit_loc.source_filename == NULL)
2358 const char *fullname = symtab_to_fullname (state->default_symtab);
2360 /* It may be more appropriate to keep DEFAULT_SYMTAB in its symtab
2361 form so that displaying SOURCE_FILENAME can follow the current
2362 FILENAME_DISPLAY_STRING setting. But as it is used only rarely
2363 it has been kept for code simplicity only in absolute form. */
2364 ls->explicit_loc.source_filename = xstrdup (fullname);
2369 /* We haven't found any results... */
2373 canonicalize_linespec (state, ls);
2375 if (!sals.empty () && state->canonical != NULL)
2376 state->canonical->pre_expanded = 1;
2381 /* Build RESULT from the explicit location components SOURCE_FILENAME,
2382 FUNCTION_NAME, LABEL_NAME and LINE_OFFSET. */
2385 convert_explicit_location_to_linespec (struct linespec_state *self,
2387 const char *source_filename,
2388 const char *function_name,
2389 symbol_name_match_type fname_match_type,
2390 const char *label_name,
2391 struct line_offset line_offset)
2393 std::vector<symbol *> symbols;
2394 VEC (symbolp) *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,
2405 self->search_pspace).release ();
2407 CATCH (except, RETURN_MASK_ERROR)
2409 source_file_not_found_error (source_filename);
2412 result->explicit_loc.source_filename = xstrdup (source_filename);
2416 /* A NULL entry means to use the default symtab. */
2417 result->file_symtabs->push_back (nullptr);
2420 if (function_name != NULL)
2422 find_linespec_symbols (self, result->file_symtabs,
2423 function_name, fname_match_type,
2424 &symbols, &minimal_symbols);
2426 if (symbols.empty () && minimal_symbols == NULL)
2427 symbol_not_found_error (function_name,
2428 result->explicit_loc.source_filename);
2430 result->explicit_loc.function_name = xstrdup (function_name);
2431 result->function_symbols
2432 = new std::vector<symbol *> (std::move (symbols));
2433 result->minimal_symbols = minimal_symbols;
2436 if (label_name != NULL)
2438 labels = find_label_symbols (self, result->function_symbols,
2439 &symbols, label_name);
2442 undefined_label_error (result->explicit_loc.function_name,
2445 result->explicit_loc.label_name = xstrdup (label_name);
2446 result->labels.label_symbols = labels;
2447 result->labels.function_symbols
2448 = new std::vector<symbol *> (std::move (symbols));
2451 if (line_offset.sign != LINE_OFFSET_UNKNOWN)
2452 result->explicit_loc.line_offset = line_offset;
2455 /* Convert the explicit location EXPLICIT_LOC into SaLs. */
2457 static std::vector<symtab_and_line>
2458 convert_explicit_location_to_sals (struct linespec_state *self,
2460 const struct explicit_location *explicit_loc)
2462 convert_explicit_location_to_linespec (self, result,
2463 explicit_loc->source_filename,
2464 explicit_loc->function_name,
2465 explicit_loc->func_name_match_type,
2466 explicit_loc->label_name,
2467 explicit_loc->line_offset);
2468 return convert_linespec_to_sals (self, result);
2471 /* Parse a string that specifies a linespec.
2473 The basic grammar of linespecs:
2475 linespec -> var_spec | basic_spec
2476 var_spec -> '$' (STRING | NUMBER)
2478 basic_spec -> file_offset_spec | function_spec | label_spec
2479 file_offset_spec -> opt_file_spec offset_spec
2480 function_spec -> opt_file_spec function_name_spec opt_label_spec
2481 label_spec -> label_name_spec
2483 opt_file_spec -> "" | file_name_spec ':'
2484 opt_label_spec -> "" | ':' label_name_spec
2486 file_name_spec -> STRING
2487 function_name_spec -> STRING
2488 label_name_spec -> STRING
2489 function_name_spec -> STRING
2490 offset_spec -> NUMBER
2494 This may all be followed by several keywords such as "if EXPR",
2497 A comma will terminate parsing.
2499 The function may be an undebuggable function found in minimal symbol table.
2501 If the argument FUNFIRSTLINE is nonzero, we want the first line
2502 of real code inside a function when a function is specified, and it is
2503 not OK to specify a variable or type to get its line number.
2505 DEFAULT_SYMTAB specifies the file to use if none is specified.
2506 It defaults to current_source_symtab.
2507 DEFAULT_LINE specifies the line number to use for relative
2508 line numbers (that start with signs). Defaults to current_source_line.
2509 If CANONICAL is non-NULL, store an array of strings containing the canonical
2510 line specs there if necessary. Currently overloaded member functions and
2511 line numbers or static functions without a filename yield a canonical
2512 line spec. The array and the line spec strings are allocated on the heap,
2513 it is the callers responsibility to free them.
2515 Note that it is possible to return zero for the symtab
2516 if no file is validly specified. Callers must check that.
2517 Also, the line number returned may be invalid. */
2519 /* Parse the linespec in ARG. MATCH_TYPE indicates how function names
2520 should be matched. */
2522 static std::vector<symtab_and_line>
2523 parse_linespec (linespec_parser *parser, const char *arg,
2524 symbol_name_match_type match_type)
2526 linespec_token token;
2527 struct gdb_exception file_exception = exception_none;
2529 /* A special case to start. It has become quite popular for
2530 IDEs to work around bugs in the previous parser by quoting
2531 the entire linespec, so we attempt to deal with this nicely. */
2532 parser->is_quote_enclosed = 0;
2533 if (parser->completion_tracker == NULL
2534 && !is_ada_operator (arg)
2535 && strchr (linespec_quote_characters, *arg) != NULL)
2539 end = skip_quote_char (arg + 1, *arg);
2540 if (end != NULL && is_closing_quote_enclosed (end))
2542 /* Here's the special case. Skip ARG past the initial
2545 parser->is_quote_enclosed = 1;
2549 parser->lexer.saved_arg = arg;
2550 parser->lexer.stream = arg;
2551 parser->completion_word = arg;
2552 parser->complete_what = linespec_complete_what::FUNCTION;
2553 PARSER_EXPLICIT (parser)->func_name_match_type = match_type;
2555 /* Initialize the default symtab and line offset. */
2556 initialize_defaults (&PARSER_STATE (parser)->default_symtab,
2557 &PARSER_STATE (parser)->default_line);
2559 /* Objective-C shortcut. */
2560 if (parser->completion_tracker == NULL)
2562 std::vector<symtab_and_line> values
2563 = decode_objc (PARSER_STATE (parser), PARSER_RESULT (parser), arg);
2564 if (!values.empty ())
2569 /* "-"/"+" is either an objc selector, or a number. There's
2570 nothing to complete the latter to, so just let the caller
2571 complete on functions, which finds objc selectors, if there's
2573 if ((arg[0] == '-' || arg[0] == '+') && arg[1] == '\0')
2577 /* Start parsing. */
2579 /* Get the first token. */
2580 token = linespec_lexer_consume_token (parser);
2582 /* It must be either LSTOKEN_STRING or LSTOKEN_NUMBER. */
2583 if (token.type == LSTOKEN_STRING && *LS_TOKEN_STOKEN (token).ptr == '$')
2585 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2586 if (parser->completion_tracker == NULL)
2587 PARSER_RESULT (parser)->file_symtabs->push_back (nullptr);
2589 /* User specified a convenience variable or history value. */
2590 gdb::unique_xmalloc_ptr<char> var = copy_token_string (token);
2591 PARSER_EXPLICIT (parser)->line_offset
2592 = linespec_parse_variable (PARSER_STATE (parser), var.get ());
2594 /* If a line_offset wasn't found (VAR is the name of a user
2595 variable/function), then skip to normal symbol processing. */
2596 if (PARSER_EXPLICIT (parser)->line_offset.sign != LINE_OFFSET_UNKNOWN)
2598 /* Consume this token. */
2599 linespec_lexer_consume_token (parser);
2601 goto convert_to_sals;
2604 else if (token.type == LSTOKEN_EOI && parser->completion_tracker != NULL)
2606 /* Let the default linespec_complete_what::FUNCTION kick in. */
2607 unexpected_linespec_error (parser);
2609 else if (token.type != LSTOKEN_STRING && token.type != LSTOKEN_NUMBER)
2611 parser->complete_what = linespec_complete_what::NOTHING;
2612 unexpected_linespec_error (parser);
2615 /* Shortcut: If the next token is not LSTOKEN_COLON, we know that
2616 this token cannot represent a filename. */
2617 token = linespec_lexer_peek_token (parser);
2619 if (token.type == LSTOKEN_COLON)
2621 /* Get the current token again and extract the filename. */
2622 token = linespec_lexer_lex_one (parser);
2623 gdb::unique_xmalloc_ptr<char> user_filename = copy_token_string (token);
2625 /* Check if the input is a filename. */
2629 = symtabs_from_filename (user_filename.get (),
2630 PARSER_STATE (parser)->search_pspace);
2631 PARSER_RESULT (parser)->file_symtabs = r.release ();
2633 CATCH (ex, RETURN_MASK_ERROR)
2635 file_exception = ex;
2639 if (file_exception.reason >= 0)
2641 /* Symtabs were found for the file. Record the filename. */
2642 PARSER_EXPLICIT (parser)->source_filename = user_filename.release ();
2644 /* Get the next token. */
2645 token = linespec_lexer_consume_token (parser);
2647 /* This is LSTOKEN_COLON; consume it. */
2648 linespec_lexer_consume_token (parser);
2652 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2653 PARSER_RESULT (parser)->file_symtabs->push_back (nullptr);
2656 /* If the next token is not EOI, KEYWORD, or COMMA, issue an error. */
2657 else if (parser->completion_tracker == NULL
2658 && (token.type != LSTOKEN_EOI && token.type != LSTOKEN_KEYWORD
2659 && token.type != LSTOKEN_COMMA))
2661 /* TOKEN is the _next_ token, not the one currently in the parser.
2662 Consuming the token will give the correct error message. */
2663 linespec_lexer_consume_token (parser);
2664 unexpected_linespec_error (parser);
2668 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2669 PARSER_RESULT (parser)->file_symtabs->push_back (nullptr);
2672 /* Parse the rest of the linespec. */
2673 linespec_parse_basic (parser);
2675 if (parser->completion_tracker == NULL
2676 && PARSER_RESULT (parser)->function_symbols == NULL
2677 && PARSER_RESULT (parser)->labels.label_symbols == NULL
2678 && PARSER_EXPLICIT (parser)->line_offset.sign == LINE_OFFSET_UNKNOWN
2679 && PARSER_RESULT (parser)->minimal_symbols == NULL)
2681 /* The linespec didn't parse. Re-throw the file exception if
2683 if (file_exception.reason < 0)
2684 throw_exception (file_exception);
2686 /* Otherwise, the symbol is not found. */
2687 symbol_not_found_error (PARSER_EXPLICIT (parser)->function_name,
2688 PARSER_EXPLICIT (parser)->source_filename);
2693 /* Get the last token and record how much of the input was parsed,
2695 token = linespec_lexer_lex_one (parser);
2696 if (token.type != LSTOKEN_EOI && token.type != LSTOKEN_KEYWORD)
2697 unexpected_linespec_error (parser);
2698 else if (token.type == LSTOKEN_KEYWORD)
2700 /* Setup the completion word past the keyword. Lexing never
2701 advances past a keyword automatically, so skip it
2703 parser->completion_word
2704 = skip_spaces (skip_to_space (PARSER_STREAM (parser)));
2705 parser->complete_what = linespec_complete_what::EXPRESSION;
2708 /* Convert the data in PARSER_RESULT to SALs. */
2709 if (parser->completion_tracker == NULL)
2710 return convert_linespec_to_sals (PARSER_STATE (parser),
2711 PARSER_RESULT (parser));
2717 /* A constructor for linespec_state. */
2720 linespec_state_constructor (struct linespec_state *self,
2721 int flags, const struct language_defn *language,
2722 struct program_space *search_pspace,
2723 struct symtab *default_symtab,
2725 struct linespec_result *canonical)
2727 memset (self, 0, sizeof (*self));
2728 self->language = language;
2729 self->funfirstline = (flags & DECODE_LINE_FUNFIRSTLINE) ? 1 : 0;
2730 self->list_mode = (flags & DECODE_LINE_LIST_MODE) ? 1 : 0;
2731 self->search_pspace = search_pspace;
2732 self->default_symtab = default_symtab;
2733 self->default_line = default_line;
2734 self->canonical = canonical;
2735 self->program_space = current_program_space;
2736 self->addr_set = htab_create_alloc (10, hash_address_entry, eq_address_entry,
2737 xfree, xcalloc, xfree);
2738 self->is_linespec = 0;
2741 /* Initialize a new linespec parser. */
2744 linespec_parser_new (linespec_parser *parser,
2745 int flags, const struct language_defn *language,
2746 struct program_space *search_pspace,
2747 struct symtab *default_symtab,
2749 struct linespec_result *canonical)
2751 memset (parser, 0, sizeof (linespec_parser));
2752 parser->lexer.current.type = LSTOKEN_CONSUMED;
2753 memset (PARSER_RESULT (parser), 0, sizeof (struct linespec));
2754 PARSER_RESULT (parser)->file_symtabs = new std::vector<symtab *> ();
2755 PARSER_EXPLICIT (parser)->func_name_match_type
2756 = symbol_name_match_type::WILD;
2757 PARSER_EXPLICIT (parser)->line_offset.sign = LINE_OFFSET_UNKNOWN;
2758 linespec_state_constructor (PARSER_STATE (parser), flags, language,
2760 default_symtab, default_line, canonical);
2763 /* A destructor for linespec_state. */
2766 linespec_state_destructor (struct linespec_state *self)
2768 htab_delete (self->addr_set);
2771 /* Delete a linespec parser. */
2774 linespec_parser_delete (void *arg)
2776 linespec_parser *parser = (linespec_parser *) arg;
2778 xfree (PARSER_EXPLICIT (parser)->source_filename);
2779 xfree (PARSER_EXPLICIT (parser)->label_name);
2780 xfree (PARSER_EXPLICIT (parser)->function_name);
2782 delete PARSER_RESULT (parser)->file_symtabs;
2783 delete PARSER_RESULT (parser)->function_symbols;
2785 if (PARSER_RESULT (parser)->minimal_symbols != NULL)
2786 VEC_free (bound_minimal_symbol_d, PARSER_RESULT (parser)->minimal_symbols);
2788 if (PARSER_RESULT (parser)->labels.label_symbols != NULL)
2789 VEC_free (symbolp, PARSER_RESULT (parser)->labels.label_symbols);
2791 delete 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] = { (char) 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 std::vector<symbol *> label_function_symbols;
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 std::vector<symbol *> 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
3055 = new std::vector<symbol *> (std::move (function_symbols));
3056 PARSER_RESULT (&parser)->minimal_symbols = minimal_symbols;
3058 complete_label (tracker, &parser, parser.completion_word);
3060 else if (parser.complete_what == linespec_complete_what::FUNCTION)
3062 /* While parsing/lexing, we didn't know whether the completion
3063 word completes to a unique function/source name already or
3067 "b function() <tab>"
3068 may need to complete either to:
3069 "b function() const"
3071 "b function() if/thread/task"
3075 may need to complete either to:
3076 "b foo template_fun<T>()"
3077 with "foo" being the template function's return type, or to:
3082 may need to complete either to a source file name:
3084 or this, also a filename, but a unique completion:
3086 or to a function name:
3089 Address that by completing assuming source or function, and
3090 seeing if we find a completion that matches exactly the
3091 completion word. If so, then it must be a function (see note
3092 below) and we advance the completion word to the end of input
3093 and switch to KEYWORD completion mode.
3095 Note: if we find a unique completion for a source filename,
3096 then it won't match the completion word, because the LCD will
3097 contain a trailing ':'. And if we're completing at or after
3098 the ':', then complete_linespec_component won't try to
3099 complete on source filenames. */
3101 const char *word = parser.completion_word;
3103 complete_linespec_component (&parser, tracker,
3104 parser.completion_word,
3105 linespec_complete_what::FUNCTION,
3106 PARSER_EXPLICIT (&parser)->source_filename);
3108 parser.complete_what = linespec_complete_what::NOTHING;
3110 if (tracker.quote_char ())
3112 /* The function/file name was not close-quoted, so this
3113 can't be a keyword. Note: complete_linespec_component
3114 may have swapped the original quote char for ':' when we
3115 get here, but that still indicates the same. */
3117 else if (!tracker.have_completions ())
3120 size_t wordlen = strlen (parser.completion_word);
3123 = string_find_incomplete_keyword_at_end (linespec_keywords,
3124 parser.completion_word,
3129 && parser.completion_word[wordlen - 1] == ' '))
3131 parser.completion_word += key_start;
3132 parser.complete_what = linespec_complete_what::KEYWORD;
3135 else if (tracker.completes_to_completion_word (word))
3137 /* Skip the function and complete on keywords. */
3138 parser.completion_word += strlen (word);
3139 parser.complete_what = linespec_complete_what::KEYWORD;
3140 tracker.discard_completions ();
3144 tracker.advance_custom_word_point_by (parser.completion_word - orig);
3146 complete_linespec_component (&parser, tracker,
3147 parser.completion_word,
3148 parser.complete_what,
3149 PARSER_EXPLICIT (&parser)->source_filename);
3151 /* If we're past the "filename:function:label:offset" linespec, and
3152 didn't find any match, then assume the user might want to create
3153 a pending breakpoint anyway and offer the keyword
3155 if (!parser.completion_quote_char
3156 && (parser.complete_what == linespec_complete_what::FUNCTION
3157 || parser.complete_what == linespec_complete_what::LABEL
3158 || parser.complete_what == linespec_complete_what::NOTHING)
3159 && !tracker.have_completions ())
3162 = parser.completion_word + strlen (parser.completion_word);
3164 if (end > orig && end[-1] == ' ')
3166 tracker.advance_custom_word_point_by (end - parser.completion_word);
3168 complete_linespec_component (&parser, tracker, end,
3169 linespec_complete_what::KEYWORD,
3174 do_cleanups (cleanup);
3177 /* A helper function for decode_line_full and decode_line_1 to
3178 turn LOCATION into std::vector<symtab_and_line>. */
3180 static std::vector<symtab_and_line>
3181 event_location_to_sals (linespec_parser *parser,
3182 const struct event_location *location)
3184 std::vector<symtab_and_line> result;
3186 switch (event_location_type (location))
3188 case LINESPEC_LOCATION:
3190 PARSER_STATE (parser)->is_linespec = 1;
3193 const linespec_location *ls = get_linespec_location (location);
3194 result = parse_linespec (parser,
3195 ls->spec_string, ls->match_type);
3197 CATCH (except, RETURN_MASK_ERROR)
3199 throw_exception (except);
3205 case ADDRESS_LOCATION:
3207 const char *addr_string = get_address_string_location (location);
3208 CORE_ADDR addr = get_address_location (location);
3210 if (addr_string != NULL)
3212 addr = linespec_expression_to_pc (&addr_string);
3213 if (PARSER_STATE (parser)->canonical != NULL)
3214 PARSER_STATE (parser)->canonical->location
3215 = copy_event_location (location);
3218 result = convert_address_location_to_sals (PARSER_STATE (parser),
3223 case EXPLICIT_LOCATION:
3225 const struct explicit_location *explicit_loc;
3227 explicit_loc = get_explicit_location_const (location);
3228 result = convert_explicit_location_to_sals (PARSER_STATE (parser),
3229 PARSER_RESULT (parser),
3234 case PROBE_LOCATION:
3235 /* Probes are handled by their own decoders. */
3236 gdb_assert_not_reached ("attempt to decode probe location");
3240 gdb_assert_not_reached ("unhandled event location type");
3246 /* See linespec.h. */
3249 decode_line_full (const struct event_location *location, int flags,
3250 struct program_space *search_pspace,
3251 struct symtab *default_symtab,
3252 int default_line, struct linespec_result *canonical,
3253 const char *select_mode,
3256 struct cleanup *cleanups;
3257 std::vector<const char *> filters;
3258 linespec_parser parser;
3259 struct linespec_state *state;
3261 gdb_assert (canonical != NULL);
3262 /* The filter only makes sense for 'all'. */
3263 gdb_assert (filter == NULL || select_mode == multiple_symbols_all);
3264 gdb_assert (select_mode == NULL
3265 || select_mode == multiple_symbols_all
3266 || select_mode == multiple_symbols_ask
3267 || select_mode == multiple_symbols_cancel);
3268 gdb_assert ((flags & DECODE_LINE_LIST_MODE) == 0);
3270 linespec_parser_new (&parser, flags, current_language,
3271 search_pspace, default_symtab,
3272 default_line, canonical);
3273 cleanups = make_cleanup (linespec_parser_delete, &parser);
3275 scoped_restore_current_program_space restore_pspace;
3277 std::vector<symtab_and_line> result = event_location_to_sals (&parser,
3279 state = PARSER_STATE (&parser);
3281 gdb_assert (result.size () == 1 || canonical->pre_expanded);
3282 canonical->pre_expanded = 1;
3284 /* Arrange for allocated canonical names to be freed. */
3285 if (!result.empty ())
3289 make_cleanup (xfree, state->canonical_names);
3290 for (i = 0; i < result.size (); ++i)
3292 gdb_assert (state->canonical_names[i].suffix != NULL);
3293 make_cleanup (xfree, state->canonical_names[i].suffix);
3297 if (select_mode == NULL)
3299 if (top_level_interpreter ()->interp_ui_out ()->is_mi_like_p ())
3300 select_mode = multiple_symbols_all;
3302 select_mode = multiple_symbols_select_mode ();
3305 if (select_mode == multiple_symbols_all)
3309 filters.push_back (filter);
3310 filter_results (state, &result, filters);
3313 convert_results_to_lsals (state, &result);
3316 decode_line_2 (state, &result, select_mode);
3318 do_cleanups (cleanups);
3321 /* See linespec.h. */
3323 std::vector<symtab_and_line>
3324 decode_line_1 (const struct event_location *location, int flags,
3325 struct program_space *search_pspace,
3326 struct symtab *default_symtab,
3329 linespec_parser parser;
3330 struct cleanup *cleanups;
3332 linespec_parser_new (&parser, flags, current_language,
3333 search_pspace, default_symtab,
3334 default_line, NULL);
3335 cleanups = make_cleanup (linespec_parser_delete, &parser);
3337 scoped_restore_current_program_space restore_pspace;
3339 std::vector<symtab_and_line> result = event_location_to_sals (&parser,
3342 do_cleanups (cleanups);
3346 /* See linespec.h. */
3348 std::vector<symtab_and_line>
3349 decode_line_with_current_source (const char *string, int flags)
3352 error (_("Empty line specification."));
3354 /* We use whatever is set as the current source line. We do not try
3355 and get a default source symtab+line or it will recursively call us! */
3356 symtab_and_line cursal = get_current_source_symtab_and_line ();
3358 event_location_up location = string_to_event_location (&string,
3360 std::vector<symtab_and_line> sals
3361 = decode_line_1 (location.get (), flags, NULL, cursal.symtab, cursal.line);
3364 error (_("Junk at end of line specification: %s"), string);
3369 /* See linespec.h. */
3371 std::vector<symtab_and_line>
3372 decode_line_with_last_displayed (const char *string, int flags)
3375 error (_("Empty line specification."));
3377 event_location_up location = string_to_event_location (&string,
3379 std::vector<symtab_and_line> sals
3380 = (last_displayed_sal_is_valid ()
3381 ? decode_line_1 (location.get (), flags, NULL,
3382 get_last_displayed_symtab (),
3383 get_last_displayed_line ())
3384 : decode_line_1 (location.get (), flags, NULL,
3385 (struct symtab *) NULL, 0));
3388 error (_("Junk at end of line specification: %s"), string);
3395 /* First, some functions to initialize stuff at the beggining of the
3399 initialize_defaults (struct symtab **default_symtab, int *default_line)
3401 if (*default_symtab == 0)
3403 /* Use whatever we have for the default source line. We don't use
3404 get_current_or_default_symtab_and_line as it can recurse and call
3406 struct symtab_and_line cursal =
3407 get_current_source_symtab_and_line ();
3409 *default_symtab = cursal.symtab;
3410 *default_line = cursal.line;
3416 /* Evaluate the expression pointed to by EXP_PTR into a CORE_ADDR,
3417 advancing EXP_PTR past any parsed text. */
3420 linespec_expression_to_pc (const char **exp_ptr)
3422 if (current_program_space->executing_startup)
3423 /* The error message doesn't really matter, because this case
3424 should only hit during breakpoint reset. */
3425 throw_error (NOT_FOUND_ERROR, _("cannot evaluate expressions while "
3426 "program space is in startup"));
3429 return value_as_address (parse_to_comma_and_eval (exp_ptr));
3434 /* Here's where we recognise an Objective-C Selector. An Objective C
3435 selector may be implemented by more than one class, therefore it
3436 may represent more than one method/function. This gives us a
3437 situation somewhat analogous to C++ overloading. If there's more
3438 than one method that could represent the selector, then use some of
3439 the existing C++ code to let the user choose one. */
3441 static std::vector<symtab_and_line>
3442 decode_objc (struct linespec_state *self, linespec_p ls, const char *arg)
3444 struct collect_info info;
3445 std::vector<const char *> symbol_names;
3446 const char *new_argptr;
3449 std::vector<symtab *> symtabs;
3450 symtabs.push_back (nullptr);
3452 info.file_symtabs = &symtabs;
3454 std::vector<symbol *> symbols;
3455 info.result.symbols = &symbols;
3456 info.result.minimal_symbols = NULL;
3458 new_argptr = find_imps (arg, &symbol_names);
3459 if (symbol_names.empty ())
3462 add_all_symbol_names_from_pspace (&info, NULL, symbol_names,
3465 std::vector<symtab_and_line> values;
3466 if (!symbols.empty ()
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 = new std::vector<symbol *> (std::move (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);
3507 /* A function object that serves as symbol_found_callback_ftype
3508 callback for iterate_over_symbols. This is used by
3509 lookup_prefix_sym to collect type symbols. */
3510 class decode_compound_collector
3513 decode_compound_collector ()
3516 m_unique_syms = htab_create_alloc (1, htab_hash_pointer,
3517 htab_eq_pointer, NULL,
3521 ~decode_compound_collector ()
3523 if (m_unique_syms != NULL)
3524 htab_delete (m_unique_syms);
3527 /* Releases ownership of the collected symbols and returns them. */
3528 VEC (symbolp) *release_symbols ()
3530 VEC (symbolp) *res = m_symbols;
3535 /* Callable as a symbol_found_callback_ftype callback. */
3536 bool operator () (symbol *sym);
3539 /* A hash table of all symbols we found. We use this to avoid
3540 adding any symbol more than once. */
3541 htab_t m_unique_syms;
3543 /* The result vector. */
3544 VEC (symbolp) *m_symbols;
3548 decode_compound_collector::operator () (symbol *sym)
3553 if (SYMBOL_CLASS (sym) != LOC_TYPEDEF)
3554 return true; /* Continue iterating. */
3556 t = SYMBOL_TYPE (sym);
3557 t = check_typedef (t);
3558 if (TYPE_CODE (t) != TYPE_CODE_STRUCT
3559 && TYPE_CODE (t) != TYPE_CODE_UNION
3560 && TYPE_CODE (t) != TYPE_CODE_NAMESPACE)
3561 return true; /* Continue iterating. */
3563 slot = htab_find_slot (m_unique_syms, sym, INSERT);
3567 VEC_safe_push (symbolp, m_symbols, sym);
3570 return true; /* Continue iterating. */
3575 /* Return any symbols corresponding to CLASS_NAME in FILE_SYMTABS. */
3577 static VEC (symbolp) *
3578 lookup_prefix_sym (struct linespec_state *state,
3579 std::vector<symtab *> *file_symtabs,
3580 const char *class_name)
3582 decode_compound_collector collector;
3584 lookup_name_info lookup_name (class_name, symbol_name_match_type::FULL);
3586 for (const auto &elt : *file_symtabs)
3590 iterate_over_all_matching_symtabs (state, lookup_name,
3591 STRUCT_DOMAIN, ALL_DOMAIN,
3592 NULL, false, collector);
3593 iterate_over_all_matching_symtabs (state, lookup_name,
3594 VAR_DOMAIN, ALL_DOMAIN,
3595 NULL, false, collector);
3599 /* Program spaces that are executing startup should have
3600 been filtered out earlier. */
3601 gdb_assert (!SYMTAB_PSPACE (elt)->executing_startup);
3602 set_current_program_space (SYMTAB_PSPACE (elt));
3603 iterate_over_file_blocks (elt, lookup_name, STRUCT_DOMAIN, collector);
3604 iterate_over_file_blocks (elt, lookup_name, VAR_DOMAIN, collector);
3608 return collector.release_symbols ();
3611 /* A std::sort comparison function for symbols. The resulting order does
3612 not actually matter; we just need to be able to sort them so that
3613 symbols with the same program space end up next to each other. */
3616 std_compare_symbols (const struct symbol *a, const struct symbol *b)
3620 uia = (uintptr_t) SYMTAB_PSPACE (symbol_symtab (a));
3621 uib = (uintptr_t) SYMTAB_PSPACE (symbol_symtab (b));
3628 uia = (uintptr_t) a;
3629 uib = (uintptr_t) b;
3637 /* A qsort comparison function for symbols. The resulting order does
3638 not actually matter; we just need to be able to sort them so that
3639 symbols with the same program space end up next to each other. */
3642 compare_symbols (const void *a, const void *b)
3644 struct symbol * const *sa = (struct symbol * const*) a;
3645 struct symbol * const *sb = (struct symbol * const*) b;
3648 uia = (uintptr_t) SYMTAB_PSPACE (symbol_symtab (*sa));
3649 uib = (uintptr_t) SYMTAB_PSPACE (symbol_symtab (*sb));
3656 uia = (uintptr_t) *sa;
3657 uib = (uintptr_t) *sb;
3667 /* Like compare_symbols but for minimal symbols. */
3670 compare_msymbols (const void *a, const void *b)
3672 const struct bound_minimal_symbol *sa
3673 = (const struct bound_minimal_symbol *) a;
3674 const struct bound_minimal_symbol *sb
3675 = (const struct bound_minimal_symbol *) b;
3678 uia = (uintptr_t) sa->objfile->pspace;
3679 uib = (uintptr_t) sa->objfile->pspace;
3686 uia = (uintptr_t) sa->minsym;
3687 uib = (uintptr_t) sb->minsym;
3697 /* Look for all the matching instances of each symbol in NAMES. Only
3698 instances from PSPACE are considered; other program spaces are
3699 handled by our caller. If PSPACE is NULL, then all program spaces
3700 are considered. Results are stored into INFO. */
3703 add_all_symbol_names_from_pspace (struct collect_info *info,
3704 struct program_space *pspace,
3705 const std::vector<const char *> &names,
3706 enum search_domain search_domain)
3708 for (const char *iter : names)
3709 add_matching_symbols_to_info (iter,
3710 symbol_name_match_type::FULL,
3711 search_domain, info, pspace);
3715 find_superclass_methods (std::vector<struct type *> &&superclasses,
3716 const char *name, enum language name_lang,
3717 std::vector<const char *> *result_names)
3719 size_t old_len = result_names->size ();
3723 std::vector<struct type *> new_supers;
3725 for (type *t : superclasses)
3726 find_methods (t, name_lang, name, result_names, &new_supers);
3728 if (result_names->size () != old_len || new_supers.empty ())
3731 superclasses = std::move (new_supers);
3735 /* This finds the method METHOD_NAME in the class CLASS_NAME whose type is
3736 given by one of the symbols in SYM_CLASSES. Matches are returned
3737 in SYMBOLS (for debug symbols) and MINSYMS (for minimal symbols). */
3740 find_method (struct linespec_state *self, std::vector<symtab *> *file_symtabs,
3741 const char *class_name, const char *method_name,
3742 VEC (symbolp) *sym_classes, std::vector<symbol *> *symbols,
3743 VEC (bound_minimal_symbol_d) **minsyms)
3747 size_t last_result_len;
3748 std::vector<struct type *> superclass_vec;
3749 std::vector<const char *> result_names;
3750 struct collect_info info;
3752 /* Sort symbols so that symbols with the same program space are next
3754 qsort (VEC_address (symbolp, sym_classes),
3755 VEC_length (symbolp, sym_classes),
3760 info.file_symtabs = file_symtabs;
3761 info.result.symbols = symbols;
3762 info.result.minimal_symbols = NULL;
3764 /* Iterate over all the types, looking for the names of existing
3765 methods matching METHOD_NAME. If we cannot find a direct method in a
3766 given program space, then we consider inherited methods; this is
3767 not ideal (ideal would be to respect C++ hiding rules), but it
3768 seems good enough and is what GDB has historically done. We only
3769 need to collect the names because later we find all symbols with
3770 those names. This loop is written in a somewhat funny way
3771 because we collect data across the program space before deciding
3773 last_result_len = 0;
3774 for (ix = 0; VEC_iterate (symbolp, sym_classes, ix, sym); ++ix)
3777 struct program_space *pspace;
3779 /* Program spaces that are executing startup should have
3780 been filtered out earlier. */
3781 pspace = SYMTAB_PSPACE (symbol_symtab (sym));
3782 gdb_assert (!pspace->executing_startup);
3783 set_current_program_space (pspace);
3784 t = check_typedef (SYMBOL_TYPE (sym));
3785 find_methods (t, SYMBOL_LANGUAGE (sym),
3786 method_name, &result_names, &superclass_vec);
3788 /* Handle all items from a single program space at once; and be
3789 sure not to miss the last batch. */
3790 if (ix == VEC_length (symbolp, sym_classes) - 1
3792 != SYMTAB_PSPACE (symbol_symtab (VEC_index (symbolp, sym_classes,
3795 /* If we did not find a direct implementation anywhere in
3796 this program space, consider superclasses. */
3797 if (result_names.size () == last_result_len)
3798 find_superclass_methods (std::move (superclass_vec), method_name,
3799 SYMBOL_LANGUAGE (sym), &result_names);
3801 /* We have a list of candidate symbol names, so now we
3802 iterate over the symbol tables looking for all
3803 matches in this pspace. */
3804 add_all_symbol_names_from_pspace (&info, pspace, result_names,
3807 superclass_vec.clear ();
3808 last_result_len = result_names.size ();
3812 if (!symbols->empty ()
3813 || !VEC_empty (bound_minimal_symbol_d, info.result.minimal_symbols))
3815 *minsyms = info.result.minimal_symbols;
3819 /* Throw an NOT_FOUND_ERROR. This will be caught by the caller
3820 and other attempts to locate the symbol will be made. */
3821 throw_error (NOT_FOUND_ERROR, _("see caller, this text doesn't matter"));
3828 /* This function object is a callback for iterate_over_symtabs, used
3829 when collecting all matching symtabs. */
3831 class symtab_collector
3835 : m_symtabs (new std::vector<symtab *> ())
3837 m_symtab_table = htab_create (1, htab_hash_pointer, htab_eq_pointer,
3841 ~symtab_collector ()
3843 if (m_symtab_table != NULL)
3844 htab_delete (m_symtab_table);
3847 /* Callable as a symbol_found_callback_ftype callback. */
3848 bool operator () (symtab *sym);
3850 /* Releases ownership of the collected symtabs and returns them. */
3851 symtab_vector_up release_symtabs ()
3853 return std::move (m_symtabs);
3857 /* The result vector of symtabs. */
3858 symtab_vector_up m_symtabs;
3860 /* This is used to ensure the symtabs are unique. */
3861 htab_t m_symtab_table;
3865 symtab_collector::operator () (struct symtab *symtab)
3869 slot = htab_find_slot (m_symtab_table, symtab, INSERT);
3873 m_symtabs->push_back (symtab);
3881 /* Given a file name, return a list of all matching symtabs. If
3882 SEARCH_PSPACE is not NULL, the search is restricted to just that
3885 static symtab_vector_up
3886 collect_symtabs_from_filename (const char *file,
3887 struct program_space *search_pspace)
3889 symtab_collector collector;
3891 /* Find that file's data. */
3892 if (search_pspace == NULL)
3894 struct program_space *pspace;
3896 ALL_PSPACES (pspace)
3898 if (pspace->executing_startup)
3901 set_current_program_space (pspace);
3902 iterate_over_symtabs (file, collector);
3907 set_current_program_space (search_pspace);
3908 iterate_over_symtabs (file, collector);
3911 return collector.release_symtabs ();
3914 /* Return all the symtabs associated to the FILENAME. If SEARCH_PSPACE is
3915 not NULL, the search is restricted to just that program space. */
3917 static symtab_vector_up
3918 symtabs_from_filename (const char *filename,
3919 struct program_space *search_pspace)
3921 symtab_vector_up result
3922 = collect_symtabs_from_filename (filename, search_pspace);
3924 if (result->empty ())
3926 if (!have_full_symbols () && !have_partial_symbols ())
3927 throw_error (NOT_FOUND_ERROR,
3928 _("No symbol table is loaded. "
3929 "Use the \"file\" command."));
3930 source_file_not_found_error (filename);
3936 /* Look up a function symbol named NAME in symtabs FILE_SYMTABS. Matching
3937 debug symbols are returned in SYMBOLS. Matching minimal symbols are
3938 returned in MINSYMS. */
3941 find_function_symbols (struct linespec_state *state,
3942 std::vector<symtab *> *file_symtabs, const char *name,
3943 symbol_name_match_type name_match_type,
3944 std::vector<symbol *> *symbols,
3945 VEC (bound_minimal_symbol_d) **minsyms)
3947 struct collect_info info;
3948 std::vector<const char *> symbol_names;
3951 info.result.symbols = symbols;
3952 info.result.minimal_symbols = NULL;
3953 info.file_symtabs = file_symtabs;
3955 /* Try NAME as an Objective-C selector. */
3956 find_imps (name, &symbol_names);
3957 if (!symbol_names.empty ())
3958 add_all_symbol_names_from_pspace (&info, state->search_pspace,
3959 symbol_names, FUNCTIONS_DOMAIN);
3961 add_matching_symbols_to_info (name, name_match_type, FUNCTIONS_DOMAIN,
3962 &info, state->search_pspace);
3964 if (VEC_empty (bound_minimal_symbol_d, info.result.minimal_symbols))
3966 VEC_free (bound_minimal_symbol_d, info.result.minimal_symbols);
3970 *minsyms = info.result.minimal_symbols;
3973 /* Find all symbols named NAME in FILE_SYMTABS, returning debug symbols
3974 in SYMBOLS and minimal symbols in MINSYMS. */
3977 find_linespec_symbols (struct linespec_state *state,
3978 std::vector<symtab *> *file_symtabs,
3979 const char *lookup_name,
3980 symbol_name_match_type name_match_type,
3981 std::vector <symbol *> *symbols,
3982 VEC (bound_minimal_symbol_d) **minsyms)
3984 std::string canon = cp_canonicalize_string_no_typedefs (lookup_name);
3985 if (!canon.empty ())
3986 lookup_name = canon.c_str ();
3988 /* It's important to not call expand_symtabs_matching unnecessarily
3989 as it can really slow things down (by unnecessarily expanding
3990 potentially 1000s of symtabs, which when debugging some apps can
3991 cost 100s of seconds). Avoid this to some extent by *first* calling
3992 find_function_symbols, and only if that doesn't find anything
3993 *then* call find_method. This handles two important cases:
3994 1) break (anonymous namespace)::foo
3995 2) break class::method where method is in class (and not a baseclass) */
3997 find_function_symbols (state, file_symtabs, lookup_name,
3998 name_match_type, symbols, minsyms);
4000 /* If we were unable to locate a symbol of the same name, try dividing
4001 the name into class and method names and searching the class and its
4003 if (symbols->empty ()
4004 && VEC_empty (bound_minimal_symbol_d, *minsyms))
4006 std::string klass, method;
4007 const char *last, *p, *scope_op;
4008 VEC (symbolp) *classes;
4010 /* See if we can find a scope operator and break this symbol
4011 name into namespaces${SCOPE_OPERATOR}class_name and method_name. */
4013 p = find_toplevel_string (lookup_name, scope_op);
4019 p = find_toplevel_string (p + strlen (scope_op), scope_op);
4022 /* If no scope operator was found, there is nothing more we can do;
4023 we already attempted to lookup the entire name as a symbol
4028 /* LOOKUP_NAME points to the class name.
4029 LAST points to the method name. */
4030 klass = std::string (lookup_name, last - lookup_name);
4032 /* Skip past the scope operator. */
4033 last += strlen (scope_op);
4036 /* Find a list of classes named KLASS. */
4037 classes = lookup_prefix_sym (state, file_symtabs, klass.c_str ());
4038 struct cleanup *old_chain
4039 = make_cleanup (VEC_cleanup (symbolp), &classes);
4041 if (!VEC_empty (symbolp, classes))
4043 /* Now locate a list of suitable methods named METHOD. */
4046 find_method (state, file_symtabs,
4047 klass.c_str (), method.c_str (),
4048 classes, symbols, minsyms);
4051 /* If successful, we're done. If NOT_FOUND_ERROR
4052 was not thrown, rethrow the exception that we did get. */
4053 CATCH (except, RETURN_MASK_ERROR)
4055 if (except.error != NOT_FOUND_ERROR)
4056 throw_exception (except);
4061 do_cleanups (old_chain);
4065 /* Helper for find_label_symbols. Find all labels that match name
4066 NAME in BLOCK. Return all labels that match in FUNCTION_SYMBOLS.
4067 Return the actual function symbol in which the label was found in
4068 LABEL_FUNC_RET. If COMPLETION_MODE is true, then NAME is
4069 interpreted as a label name prefix. Otherwise, only a label named
4070 exactly NAME match. */
4073 find_label_symbols_in_block (const struct block *block,
4074 const char *name, struct symbol *fn_sym,
4075 bool completion_mode,
4076 VEC (symbolp) **result,
4077 std::vector<symbol *> *label_funcs_ret)
4079 if (completion_mode)
4081 struct block_iterator iter;
4083 size_t name_len = strlen (name);
4085 int (*cmp) (const char *, const char *, size_t);
4086 cmp = case_sensitivity == case_sensitive_on ? strncmp : strncasecmp;
4088 ALL_BLOCK_SYMBOLS (block, iter, sym)
4090 if (symbol_matches_domain (SYMBOL_LANGUAGE (sym),
4091 SYMBOL_DOMAIN (sym), LABEL_DOMAIN)
4092 && cmp (SYMBOL_SEARCH_NAME (sym), name, name_len) == 0)
4094 VEC_safe_push (symbolp, *result, sym);
4095 label_funcs_ret->push_back (fn_sym);
4101 struct symbol *sym = lookup_symbol (name, block, LABEL_DOMAIN, 0).symbol;
4105 VEC_safe_push (symbolp, *result, sym);
4106 label_funcs_ret->push_back (fn_sym);
4111 /* Return all labels that match name NAME in FUNCTION_SYMBOLS. Return
4112 the actual function symbol in which the label was found in
4113 LABEL_FUNC_RET. If COMPLETION_MODE is true, then NAME is
4114 interpreted as a label name prefix. Otherwise, only labels named
4115 exactly NAME match. */
4117 static VEC (symbolp) *
4118 find_label_symbols (struct linespec_state *self,
4119 std::vector<symbol *> *function_symbols,
4120 std::vector<symbol *> *label_funcs_ret, const char *name,
4121 bool completion_mode)
4123 const struct block *block;
4124 struct symbol *fn_sym;
4125 VEC (symbolp) *result = NULL;
4127 if (function_symbols == NULL)
4129 set_current_program_space (self->program_space);
4130 block = get_current_search_block ();
4133 block && !BLOCK_FUNCTION (block);
4134 block = BLOCK_SUPERBLOCK (block))
4138 fn_sym = BLOCK_FUNCTION (block);
4140 find_label_symbols_in_block (block, name, fn_sym, completion_mode,
4141 &result, label_funcs_ret);
4145 for (const auto &elt : *function_symbols)
4147 set_current_program_space (SYMTAB_PSPACE (symbol_symtab (elt)));
4148 block = SYMBOL_BLOCK_VALUE (elt);
4150 find_label_symbols_in_block (block, name, elt, completion_mode,
4151 &result, label_funcs_ret);
4160 /* A helper for create_sals_line_offset that handles the 'list_mode' case. */
4162 static std::vector<symtab_and_line>
4163 decode_digits_list_mode (struct linespec_state *self,
4165 struct symtab_and_line val)
4167 gdb_assert (self->list_mode);
4169 std::vector<symtab_and_line> values;
4171 for (const auto &elt : *ls->file_symtabs)
4173 /* The logic above should ensure this. */
4174 gdb_assert (elt != NULL);
4176 set_current_program_space (SYMTAB_PSPACE (elt));
4178 /* Simplistic search just for the list command. */
4179 val.symtab = find_line_symtab (elt, val.line, NULL, NULL);
4180 if (val.symtab == NULL)
4182 val.pspace = SYMTAB_PSPACE (elt);
4184 val.explicit_line = 1;
4186 add_sal_to_sals (self, &values, &val, NULL, 0);
4192 /* A helper for create_sals_line_offset that iterates over the symtabs,
4193 adding lines to the VEC. */
4195 static std::vector<symtab_and_line>
4196 decode_digits_ordinary (struct linespec_state *self,
4199 struct linetable_entry **best_entry)
4201 std::vector<symtab_and_line> sals;
4202 for (const auto &elt : *ls->file_symtabs)
4204 std::vector<CORE_ADDR> pcs;
4206 /* The logic above should ensure this. */
4207 gdb_assert (elt != NULL);
4209 set_current_program_space (SYMTAB_PSPACE (elt));
4211 pcs = find_pcs_for_symtab_line (elt, line, best_entry);
4212 for (CORE_ADDR pc : pcs)
4214 symtab_and_line sal;
4215 sal.pspace = SYMTAB_PSPACE (elt);
4219 sals.push_back (std::move (sal));
4228 /* Return the line offset represented by VARIABLE. */
4230 static struct line_offset
4231 linespec_parse_variable (struct linespec_state *self, const char *variable)
4235 struct line_offset offset = {0, LINE_OFFSET_NONE};
4237 p = (variable[1] == '$') ? variable + 2 : variable + 1;
4240 while (*p >= '0' && *p <= '9')
4242 if (!*p) /* Reached end of token without hitting non-digit. */
4244 /* We have a value history reference. */
4245 struct value *val_history;
4247 sscanf ((variable[1] == '$') ? variable + 2 : variable + 1, "%d", &index);
4249 = access_value_history ((variable[1] == '$') ? -index : index);
4250 if (TYPE_CODE (value_type (val_history)) != TYPE_CODE_INT)
4251 error (_("History values used in line "
4252 "specs must have integer values."));
4253 offset.offset = value_as_long (val_history);
4257 /* Not all digits -- may be user variable/function or a
4258 convenience variable. */
4260 struct internalvar *ivar;
4262 /* Try it as a convenience variable. If it is not a convenience
4263 variable, return and allow normal symbol lookup to occur. */
4264 ivar = lookup_only_internalvar (variable + 1);
4266 /* No internal variable with that name. Mark the offset
4267 as unknown to allow the name to be looked up as a symbol. */
4268 offset.sign = LINE_OFFSET_UNKNOWN;
4271 /* We found a valid variable name. If it is not an integer,
4273 if (!get_internalvar_integer (ivar, &valx))
4274 error (_("Convenience variables used in line "
4275 "specs must have integer values."));
4277 offset.offset = valx;
4285 /* We've found a minimal symbol MSYMBOL in OBJFILE to associate with our
4286 linespec; return the SAL in RESULT. This function should return SALs
4287 matching those from find_function_start_sal, otherwise false
4288 multiple-locations breakpoints could be placed. */
4291 minsym_found (struct linespec_state *self, struct objfile *objfile,
4292 struct minimal_symbol *msymbol,
4293 std::vector<symtab_and_line> *result)
4295 bool want_start_sal;
4297 CORE_ADDR func_addr;
4298 bool is_function = msymbol_is_function (objfile, msymbol, &func_addr);
4302 const char *msym_name = MSYMBOL_LINKAGE_NAME (msymbol);
4304 if (MSYMBOL_TYPE (msymbol) == mst_text_gnu_ifunc
4305 || MSYMBOL_TYPE (msymbol) == mst_data_gnu_ifunc)
4306 want_start_sal = gnu_ifunc_resolve_name (msym_name, &func_addr);
4308 want_start_sal = true;
4311 symtab_and_line sal;
4313 if (is_function && want_start_sal)
4314 sal = find_function_start_sal (func_addr, NULL, self->funfirstline);
4317 sal.objfile = objfile;
4318 sal.msymbol = msymbol;
4319 /* Store func_addr, not the minsym's address in case this was an
4320 ifunc that hasn't been resolved yet. */
4324 sal.pc = MSYMBOL_VALUE_ADDRESS (objfile, msymbol);
4325 sal.pspace = current_program_space;
4328 sal.section = MSYMBOL_OBJ_SECTION (objfile, msymbol);
4330 if (maybe_add_address (self->addr_set, objfile->pspace, sal.pc))
4331 add_sal_to_sals (self, result, &sal, MSYMBOL_NATURAL_NAME (msymbol), 0);
4334 /* A helper function to classify a minimal_symbol_type according to
4338 classify_mtype (enum minimal_symbol_type t)
4345 /* Intermediate priority. */
4348 case mst_solib_trampoline:
4349 /* Lowest priority. */
4353 /* Highest priority. */
4358 /* Callback for std::sort that sorts symbols by priority. */
4361 compare_msyms (const bound_minimal_symbol &a, const bound_minimal_symbol &b)
4363 enum minimal_symbol_type ta = MSYMBOL_TYPE (a.minsym);
4364 enum minimal_symbol_type tb = MSYMBOL_TYPE (b.minsym);
4366 return classify_mtype (ta) < classify_mtype (tb);
4369 /* Helper for search_minsyms_for_name that adds the symbol to the
4373 add_minsym (struct minimal_symbol *minsym, struct objfile *objfile,
4374 struct symtab *symtab, int list_mode,
4375 std::vector<struct bound_minimal_symbol> *msyms)
4379 /* We're looking for a label for which we don't have debug
4381 CORE_ADDR func_addr;
4382 if (msymbol_is_function (objfile, minsym, &func_addr))
4384 symtab_and_line sal = find_pc_sect_line (func_addr, NULL, 0);
4386 if (symtab != sal.symtab)
4391 /* Exclude data symbols when looking for breakpoint locations. */
4392 if (!list_mode && !msymbol_is_function (objfile, minsym))
4395 struct bound_minimal_symbol mo = {minsym, objfile};
4396 msyms->push_back (mo);
4400 /* Search for minimal symbols called NAME. If SEARCH_PSPACE
4401 is not NULL, the search is restricted to just that program
4404 If SYMTAB is NULL, search all objfiles, otherwise
4405 restrict results to the given SYMTAB. */
4408 search_minsyms_for_name (struct collect_info *info,
4409 const lookup_name_info &name,
4410 struct program_space *search_pspace,
4411 struct symtab *symtab)
4413 std::vector<struct bound_minimal_symbol> minsyms;
4417 struct program_space *pspace;
4419 ALL_PSPACES (pspace)
4421 struct objfile *objfile;
4423 if (search_pspace != NULL && search_pspace != pspace)
4425 if (pspace->executing_startup)
4428 set_current_program_space (pspace);
4430 ALL_OBJFILES (objfile)
4432 iterate_over_minimal_symbols (objfile, name,
4433 [&] (struct minimal_symbol *msym)
4435 add_minsym (msym, objfile, nullptr,
4436 info->state->list_mode,
4445 if (search_pspace == NULL || SYMTAB_PSPACE (symtab) == search_pspace)
4447 set_current_program_space (SYMTAB_PSPACE (symtab));
4448 iterate_over_minimal_symbols
4449 (SYMTAB_OBJFILE (symtab), name,
4450 [&] (struct minimal_symbol *msym)
4452 add_minsym (msym, SYMTAB_OBJFILE (symtab), symtab,
4453 info->state->list_mode, &minsyms);
4459 if (!minsyms.empty ())
4463 std::sort (minsyms.begin (), minsyms.end (), compare_msyms);
4465 /* Now the minsyms are in classification order. So, we walk
4466 over them and process just the minsyms with the same
4467 classification as the very first minsym in the list. */
4468 classification = classify_mtype (MSYMBOL_TYPE (minsyms[0].minsym));
4470 for (const bound_minimal_symbol &item : minsyms)
4472 if (classify_mtype (MSYMBOL_TYPE (item.minsym)) != classification)
4475 VEC_safe_push (bound_minimal_symbol_d,
4476 info->result.minimal_symbols, &item);
4481 /* A helper function to add all symbols matching NAME to INFO. If
4482 PSPACE is not NULL, the search is restricted to just that program
4486 add_matching_symbols_to_info (const char *name,
4487 symbol_name_match_type name_match_type,
4488 enum search_domain search_domain,
4489 struct collect_info *info,
4490 struct program_space *pspace)
4492 lookup_name_info lookup_name (name, name_match_type);
4494 for (const auto &elt : *info->file_symtabs)
4498 iterate_over_all_matching_symtabs (info->state, lookup_name,
4499 VAR_DOMAIN, search_domain,
4500 pspace, true, [&] (symbol *sym)
4501 { return info->add_symbol (sym); });
4502 search_minsyms_for_name (info, lookup_name, pspace, NULL);
4504 else if (pspace == NULL || pspace == SYMTAB_PSPACE (elt))
4506 int prev_len = info->result.symbols->size ();
4508 /* Program spaces that are executing startup should have
4509 been filtered out earlier. */
4510 gdb_assert (!SYMTAB_PSPACE (elt)->executing_startup);
4511 set_current_program_space (SYMTAB_PSPACE (elt));
4512 iterate_over_file_blocks (elt, lookup_name, VAR_DOMAIN,
4514 { return info->add_symbol (sym); });
4516 /* If no new symbols were found in this iteration and this symtab
4517 is in assembler, we might actually be looking for a label for
4518 which we don't have debug info. Check for a minimal symbol in
4520 if (prev_len == info->result.symbols->size ()
4521 && elt->language == language_asm)
4522 search_minsyms_for_name (info, lookup_name, pspace, elt);
4529 /* Now come some functions that are called from multiple places within
4533 symbol_to_sal (struct symtab_and_line *result,
4534 int funfirstline, struct symbol *sym)
4536 if (SYMBOL_CLASS (sym) == LOC_BLOCK)
4538 *result = find_function_start_sal (sym, funfirstline);
4543 if (SYMBOL_CLASS (sym) == LOC_LABEL && SYMBOL_VALUE_ADDRESS (sym) != 0)
4546 result->symtab = symbol_symtab (sym);
4547 result->symbol = sym;
4548 result->line = SYMBOL_LINE (sym);
4549 result->pc = SYMBOL_VALUE_ADDRESS (sym);
4550 result->pspace = SYMTAB_PSPACE (result->symtab);
4551 result->explicit_pc = 1;
4554 else if (funfirstline)
4558 else if (SYMBOL_LINE (sym) != 0)
4560 /* We know its line number. */
4562 result->symtab = symbol_symtab (sym);
4563 result->symbol = sym;
4564 result->line = SYMBOL_LINE (sym);
4565 result->pc = SYMBOL_VALUE_ADDRESS (sym);
4566 result->pspace = SYMTAB_PSPACE (result->symtab);
4574 linespec_result::~linespec_result ()
4576 for (linespec_sals &lsal : lsals)
4577 xfree (lsal.canonical);
4580 /* Return the quote characters permitted by the linespec parser. */
4583 get_gdb_linespec_parser_quote_characters (void)
4585 return linespec_quote_characters;