1 /* Parser for linespec for the GNU debugger, GDB.
3 Copyright (C) 1986-2019 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 /* An address entry is used to ensure that any given location is only
81 added to the result a single time. It holds an address and the
82 program space from which the address came. */
86 struct program_space *pspace;
90 /* A linespec. Elements of this structure are filled in by a parser
91 (either parse_linespec or some other function). The structure is
92 then converted into SALs by convert_linespec_to_sals. */
96 /* An explicit location describing the SaLs. */
97 struct explicit_location explicit_loc;
99 /* The list of symtabs to search to which to limit the search. May not
100 be NULL. If explicit.SOURCE_FILENAME is NULL (no user-specified
101 filename), FILE_SYMTABS should contain one single NULL member. This
102 will cause the code to use the default symtab. */
103 std::vector<symtab *> *file_symtabs;
105 /* A list of matching function symbols and minimal symbols. Both lists
106 may be NULL (or empty) if no matching symbols were found. */
107 std::vector<block_symbol> *function_symbols;
108 std::vector<bound_minimal_symbol> *minimal_symbols;
110 /* A structure of matching label symbols and the corresponding
111 function symbol in which the label was found. Both may be NULL
112 or both must be non-NULL. */
115 std::vector<block_symbol> *label_symbols;
116 std::vector<block_symbol> *function_symbols;
119 typedef struct linespec *linespec_p;
121 /* A canonical linespec represented as a symtab-related string.
123 Each entry represents the "SYMTAB:SUFFIX" linespec string.
124 SYMTAB can be converted for example by symtab_to_fullname or
125 symtab_to_filename_for_display as needed. */
127 struct linespec_canonical_name
129 /* Remaining text part of the linespec string. */
132 /* If NULL then SUFFIX is the whole linespec string. */
133 struct symtab *symtab;
136 /* An instance of this is used to keep all state while linespec
137 operates. This instance is passed around as a 'this' pointer to
138 the various implementation methods. */
140 struct linespec_state
142 /* The language in use during linespec processing. */
143 const struct language_defn *language;
145 /* The program space as seen when the module was entered. */
146 struct program_space *program_space;
148 /* If not NULL, the search is restricted to just this program
150 struct program_space *search_pspace;
152 /* The default symtab to use, if no other symtab is specified. */
153 struct symtab *default_symtab;
155 /* The default line to use. */
158 /* The 'funfirstline' value that was passed in to decode_line_1 or
162 /* Nonzero if we are running in 'list' mode; see decode_line_list. */
165 /* The 'canonical' value passed to decode_line_full, or NULL. */
166 struct linespec_result *canonical;
168 /* Canonical strings that mirror the std::vector<symtab_and_line> result. */
169 struct linespec_canonical_name *canonical_names;
171 /* This is a set of address_entry objects which is used to prevent
172 duplicate symbols from being entered into the result. */
175 /* Are we building a linespec? */
179 /* This is a helper object that is used when collecting symbols into a
184 /* The linespec object in use. */
185 struct linespec_state *state;
187 /* A list of symtabs to which to restrict matches. */
188 std::vector<symtab *> *file_symtabs;
190 /* The result being accumulated. */
193 std::vector<block_symbol> *symbols;
194 std::vector<bound_minimal_symbol> *minimal_symbols;
197 /* Possibly add a symbol to the results. */
198 virtual bool add_symbol (block_symbol *bsym);
202 collect_info::add_symbol (block_symbol *bsym)
204 /* In list mode, add all matching symbols, regardless of class.
205 This allows the user to type "list a_global_variable". */
206 if (SYMBOL_CLASS (bsym->symbol) == LOC_BLOCK || this->state->list_mode)
207 this->result.symbols->push_back (*bsym);
209 /* Continue iterating. */
213 /* Custom collect_info for symbol_searcher. */
215 struct symbol_searcher_collect_info
218 bool add_symbol (block_symbol *bsym) override
220 /* Add everything. */
221 this->result.symbols->push_back (*bsym);
223 /* Continue iterating. */
235 /* A colon "separator" */
247 /* EOI (end of input) */
253 typedef enum ls_token_type linespec_token_type;
255 /* List of keywords. This is NULL-terminated so that it can be used
256 as enum completer. */
257 const char * const linespec_keywords[] = { "if", "thread", "task", NULL };
258 #define IF_KEYWORD_INDEX 0
260 /* A token of the linespec lexer */
264 /* The type of the token */
265 linespec_token_type type;
267 /* Data for the token */
270 /* A string, given as a stoken */
271 struct stoken string;
277 typedef struct ls_token linespec_token;
279 #define LS_TOKEN_STOKEN(TOK) (TOK).data.string
280 #define LS_TOKEN_KEYWORD(TOK) (TOK).data.keyword
282 /* An instance of the linespec parser. */
284 struct linespec_parser
286 linespec_parser (int flags, const struct language_defn *language,
287 struct program_space *search_pspace,
288 struct symtab *default_symtab,
290 struct linespec_result *canonical);
294 DISABLE_COPY_AND_ASSIGN (linespec_parser);
296 /* Lexer internal data */
299 /* Save head of input stream. */
300 const char *saved_arg;
302 /* Head of the input stream. */
304 #define PARSER_STREAM(P) ((P)->lexer.stream)
306 /* The current token. */
307 linespec_token current;
310 /* Is the entire linespec quote-enclosed? */
311 int is_quote_enclosed = 0;
313 /* The state of the parse. */
314 struct linespec_state state {};
315 #define PARSER_STATE(PPTR) (&(PPTR)->state)
317 /* The result of the parse. */
318 struct linespec result {};
319 #define PARSER_RESULT(PPTR) (&(PPTR)->result)
321 /* What the parser believes the current word point should complete
323 linespec_complete_what complete_what = linespec_complete_what::NOTHING;
325 /* The completion word point. The parser advances this as it skips
326 tokens. At some point the input string will end or parsing will
327 fail, and then we attempt completion at the captured completion
328 word point, interpreting the string at completion_word as
330 const char *completion_word = nullptr;
332 /* If the current token was a quoted string, then this is the
333 quoting character (either " or '). */
334 int completion_quote_char = 0;
336 /* If the current token was a quoted string, then this points at the
337 end of the quoted string. */
338 const char *completion_quote_end = nullptr;
340 /* If parsing for completion, then this points at the completion
341 tracker. Otherwise, this is NULL. */
342 struct completion_tracker *completion_tracker = nullptr;
345 /* A convenience macro for accessing the explicit location result of
347 #define PARSER_EXPLICIT(PPTR) (&PARSER_RESULT ((PPTR))->explicit_loc)
349 /* Prototypes for local functions. */
351 static void iterate_over_file_blocks
352 (struct symtab *symtab, const lookup_name_info &name,
354 gdb::function_view<symbol_found_callback_ftype> callback);
356 static void initialize_defaults (struct symtab **default_symtab,
359 CORE_ADDR linespec_expression_to_pc (const char **exp_ptr);
361 static std::vector<symtab_and_line> decode_objc (struct linespec_state *self,
365 static std::vector<symtab *> symtabs_from_filename
366 (const char *, struct program_space *pspace);
368 static std::vector<block_symbol> *find_label_symbols
369 (struct linespec_state *self, std::vector<block_symbol> *function_symbols,
370 std::vector<block_symbol> *label_funcs_ret, const char *name,
371 bool completion_mode = false);
373 static void find_linespec_symbols (struct linespec_state *self,
374 std::vector<symtab *> *file_symtabs,
376 symbol_name_match_type name_match_type,
377 std::vector<block_symbol> *symbols,
378 std::vector<bound_minimal_symbol> *minsyms);
380 static struct line_offset
381 linespec_parse_variable (struct linespec_state *self,
382 const char *variable);
384 static int symbol_to_sal (struct symtab_and_line *result,
385 int funfirstline, struct symbol *sym);
387 static void add_matching_symbols_to_info (const char *name,
388 symbol_name_match_type name_match_type,
389 enum search_domain search_domain,
390 struct collect_info *info,
391 struct program_space *pspace);
393 static void add_all_symbol_names_from_pspace
394 (struct collect_info *info, struct program_space *pspace,
395 const std::vector<const char *> &names, enum search_domain search_domain);
397 static std::vector<symtab *>
398 collect_symtabs_from_filename (const char *file,
399 struct program_space *pspace);
401 static std::vector<symtab_and_line> decode_digits_ordinary
402 (struct linespec_state *self,
405 linetable_entry **best_entry);
407 static std::vector<symtab_and_line> decode_digits_list_mode
408 (struct linespec_state *self,
410 struct symtab_and_line val);
412 static void minsym_found (struct linespec_state *self, struct objfile *objfile,
413 struct minimal_symbol *msymbol,
414 std::vector<symtab_and_line> *result);
416 static bool compare_symbols (const block_symbol &a, const block_symbol &b);
418 static bool compare_msymbols (const bound_minimal_symbol &a,
419 const bound_minimal_symbol &b);
421 /* Permitted quote characters for the parser. This is different from the
422 completer's quote characters to allow backward compatibility with the
424 static const char *const linespec_quote_characters = "\"\'";
426 /* Lexer functions. */
428 /* Lex a number from the input in PARSER. This only supports
431 Return true if input is decimal numbers. Return false if not. */
434 linespec_lexer_lex_number (linespec_parser *parser, linespec_token *tokenp)
436 tokenp->type = LSTOKEN_NUMBER;
437 LS_TOKEN_STOKEN (*tokenp).length = 0;
438 LS_TOKEN_STOKEN (*tokenp).ptr = PARSER_STREAM (parser);
440 /* Keep any sign at the start of the stream. */
441 if (*PARSER_STREAM (parser) == '+' || *PARSER_STREAM (parser) == '-')
443 ++LS_TOKEN_STOKEN (*tokenp).length;
444 ++(PARSER_STREAM (parser));
447 while (isdigit (*PARSER_STREAM (parser)))
449 ++LS_TOKEN_STOKEN (*tokenp).length;
450 ++(PARSER_STREAM (parser));
453 /* If the next character in the input buffer is not a space, comma,
454 quote, or colon, this input does not represent a number. */
455 if (*PARSER_STREAM (parser) != '\0'
456 && !isspace (*PARSER_STREAM (parser)) && *PARSER_STREAM (parser) != ','
457 && *PARSER_STREAM (parser) != ':'
458 && !strchr (linespec_quote_characters, *PARSER_STREAM (parser)))
460 PARSER_STREAM (parser) = LS_TOKEN_STOKEN (*tokenp).ptr;
467 /* See linespec.h. */
470 linespec_lexer_lex_keyword (const char *p)
476 for (i = 0; linespec_keywords[i] != NULL; ++i)
478 int len = strlen (linespec_keywords[i]);
480 /* If P begins with one of the keywords and the next
481 character is whitespace, we may have found a keyword.
482 It is only a keyword if it is not followed by another
484 if (strncmp (p, linespec_keywords[i], len) == 0
489 /* Special case: "if" ALWAYS stops the lexer, since it
490 is not possible to predict what is going to appear in
491 the condition, which can only be parsed after SaLs have
493 if (i != IF_KEYWORD_INDEX)
497 for (j = 0; linespec_keywords[j] != NULL; ++j)
499 int nextlen = strlen (linespec_keywords[j]);
501 if (strncmp (p, linespec_keywords[j], nextlen) == 0
502 && isspace (p[nextlen]))
507 return linespec_keywords[i];
515 /* See description in linespec.h. */
518 is_ada_operator (const char *string)
520 const struct ada_opname_map *mapping;
522 for (mapping = ada_opname_table;
523 mapping->encoded != NULL
524 && !startswith (string, mapping->decoded); ++mapping)
527 return mapping->decoded == NULL ? 0 : strlen (mapping->decoded);
530 /* Find QUOTE_CHAR in STRING, accounting for the ':' terminal. Return
531 the location of QUOTE_CHAR, or NULL if not found. */
534 skip_quote_char (const char *string, char quote_char)
536 const char *p, *last;
538 p = last = find_toplevel_char (string, quote_char);
539 while (p && *p != '\0' && *p != ':')
541 p = find_toplevel_char (p, quote_char);
549 /* Make a writable copy of the string given in TOKEN, trimming
550 any trailing whitespace. */
552 static gdb::unique_xmalloc_ptr<char>
553 copy_token_string (linespec_token token)
557 if (token.type == LSTOKEN_KEYWORD)
558 return gdb::unique_xmalloc_ptr<char> (xstrdup (LS_TOKEN_KEYWORD (token)));
560 str = LS_TOKEN_STOKEN (token).ptr;
561 s = remove_trailing_whitespace (str, str + LS_TOKEN_STOKEN (token).length);
563 return gdb::unique_xmalloc_ptr<char> (savestring (str, s - str));
566 /* Does P represent the end of a quote-enclosed linespec? */
569 is_closing_quote_enclosed (const char *p)
571 if (strchr (linespec_quote_characters, *p))
573 p = skip_spaces ((char *) p);
574 return (*p == '\0' || linespec_lexer_lex_keyword (p));
577 /* Find the end of the parameter list that starts with *INPUT.
578 This helper function assists with lexing string segments
579 which might contain valid (non-terminating) commas. */
582 find_parameter_list_end (const char *input)
584 char end_char, start_char;
589 if (start_char == '(')
591 else if (start_char == '<')
600 if (*p == start_char)
602 else if (*p == end_char)
616 /* If the [STRING, STRING_LEN) string ends with what looks like a
617 keyword, return the keyword start offset in STRING. Return -1
621 string_find_incomplete_keyword_at_end (const char * const *keywords,
622 const char *string, size_t string_len)
624 const char *end = string + string_len;
627 while (p > string && *p != ' ')
632 size_t len = end - p;
633 for (size_t i = 0; keywords[i] != NULL; ++i)
634 if (strncmp (keywords[i], p, len) == 0)
641 /* Lex a string from the input in PARSER. */
643 static linespec_token
644 linespec_lexer_lex_string (linespec_parser *parser)
646 linespec_token token;
647 const char *start = PARSER_STREAM (parser);
649 token.type = LSTOKEN_STRING;
651 /* If the input stream starts with a quote character, skip to the next
652 quote character, regardless of the content. */
653 if (strchr (linespec_quote_characters, *PARSER_STREAM (parser)))
656 char quote_char = *PARSER_STREAM (parser);
658 /* Special case: Ada operators. */
659 if (PARSER_STATE (parser)->language->la_language == language_ada
660 && quote_char == '\"')
662 int len = is_ada_operator (PARSER_STREAM (parser));
666 /* The input is an Ada operator. Return the quoted string
668 LS_TOKEN_STOKEN (token).ptr = PARSER_STREAM (parser);
669 LS_TOKEN_STOKEN (token).length = len;
670 PARSER_STREAM (parser) += len;
674 /* The input does not represent an Ada operator -- fall through
675 to normal quoted string handling. */
678 /* Skip past the beginning quote. */
679 ++(PARSER_STREAM (parser));
681 /* Mark the start of the string. */
682 LS_TOKEN_STOKEN (token).ptr = PARSER_STREAM (parser);
684 /* Skip to the ending quote. */
685 end = skip_quote_char (PARSER_STREAM (parser), quote_char);
687 /* This helps the completer mode decide whether we have a
689 parser->completion_quote_char = quote_char;
690 parser->completion_quote_end = end;
692 /* Error if the input did not terminate properly, unless in
696 if (parser->completion_tracker == NULL)
697 error (_("unmatched quote"));
699 /* In completion mode, we'll try to complete the incomplete
701 token.type = LSTOKEN_STRING;
702 while (*PARSER_STREAM (parser) != '\0')
703 PARSER_STREAM (parser)++;
704 LS_TOKEN_STOKEN (token).length = PARSER_STREAM (parser) - 1 - start;
708 /* Skip over the ending quote and mark the length of the string. */
709 PARSER_STREAM (parser) = (char *) ++end;
710 LS_TOKEN_STOKEN (token).length = PARSER_STREAM (parser) - 2 - start;
717 /* Otherwise, only identifier characters are permitted.
718 Spaces are the exception. In general, we keep spaces,
719 but only if the next characters in the input do not resolve
720 to one of the keywords.
722 This allows users to forgo quoting CV-qualifiers, template arguments,
723 and similar common language constructs. */
727 if (isspace (*PARSER_STREAM (parser)))
729 p = skip_spaces (PARSER_STREAM (parser));
730 /* When we get here we know we've found something followed by
731 a space (we skip over parens and templates below).
732 So if we find a keyword now, we know it is a keyword and not,
733 say, a function name. */
734 if (linespec_lexer_lex_keyword (p) != NULL)
736 LS_TOKEN_STOKEN (token).ptr = start;
737 LS_TOKEN_STOKEN (token).length
738 = PARSER_STREAM (parser) - start;
742 /* Advance past the whitespace. */
743 PARSER_STREAM (parser) = p;
746 /* If the next character is EOI or (single) ':', the
747 string is complete; return the token. */
748 if (*PARSER_STREAM (parser) == 0)
750 LS_TOKEN_STOKEN (token).ptr = start;
751 LS_TOKEN_STOKEN (token).length = PARSER_STREAM (parser) - start;
754 else if (PARSER_STREAM (parser)[0] == ':')
756 /* Do not tokenize the C++ scope operator. */
757 if (PARSER_STREAM (parser)[1] == ':')
758 ++(PARSER_STREAM (parser));
760 /* Do not tokenize ABI tags such as "[abi:cxx11]". */
761 else if (PARSER_STREAM (parser) - start > 4
762 && startswith (PARSER_STREAM (parser) - 4, "[abi"))
763 ++(PARSER_STREAM (parser));
765 /* Do not tokenify if the input length so far is one
766 (i.e, a single-letter drive name) and the next character
767 is a directory separator. This allows Windows-style
768 paths to be recognized as filenames without quoting it. */
769 else if ((PARSER_STREAM (parser) - start) != 1
770 || !IS_DIR_SEPARATOR (PARSER_STREAM (parser)[1]))
772 LS_TOKEN_STOKEN (token).ptr = start;
773 LS_TOKEN_STOKEN (token).length
774 = PARSER_STREAM (parser) - start;
778 /* Special case: permit quote-enclosed linespecs. */
779 else if (parser->is_quote_enclosed
780 && strchr (linespec_quote_characters,
781 *PARSER_STREAM (parser))
782 && is_closing_quote_enclosed (PARSER_STREAM (parser)))
784 LS_TOKEN_STOKEN (token).ptr = start;
785 LS_TOKEN_STOKEN (token).length = PARSER_STREAM (parser) - start;
788 /* Because commas may terminate a linespec and appear in
789 the middle of valid string input, special cases for
790 '<' and '(' are necessary. */
791 else if (*PARSER_STREAM (parser) == '<'
792 || *PARSER_STREAM (parser) == '(')
794 /* Don't interpret 'operator<' / 'operator<<' as a
795 template parameter list though. */
796 if (*PARSER_STREAM (parser) == '<'
797 && (PARSER_STATE (parser)->language->la_language
799 && (PARSER_STREAM (parser) - start) >= CP_OPERATOR_LEN)
801 const char *op = PARSER_STREAM (parser);
803 while (op > start && isspace (op[-1]))
805 if (op - start >= CP_OPERATOR_LEN)
807 op -= CP_OPERATOR_LEN;
808 if (strncmp (op, CP_OPERATOR_STR, CP_OPERATOR_LEN) == 0
810 || !(isalnum (op[-1]) || op[-1] == '_')))
812 /* This is an operator name. Keep going. */
813 ++(PARSER_STREAM (parser));
814 if (*PARSER_STREAM (parser) == '<')
815 ++(PARSER_STREAM (parser));
821 const char *end = find_parameter_list_end (PARSER_STREAM (parser));
822 PARSER_STREAM (parser) = end;
824 /* Don't loop around to the normal \0 case above because
825 we don't want to misinterpret a potential keyword at
826 the end of the token when the string isn't
827 "()<>"-balanced. This handles "b
828 function(thread<tab>" in completion mode. */
831 LS_TOKEN_STOKEN (token).ptr = start;
832 LS_TOKEN_STOKEN (token).length
833 = PARSER_STREAM (parser) - start;
839 /* Commas are terminators, but not if they are part of an
841 else if (*PARSER_STREAM (parser) == ',')
843 if ((PARSER_STATE (parser)->language->la_language
845 && (PARSER_STREAM (parser) - start) > CP_OPERATOR_LEN)
847 const char *op = strstr (start, CP_OPERATOR_STR);
849 if (op != NULL && is_operator_name (op))
851 /* This is an operator name. Keep going. */
852 ++(PARSER_STREAM (parser));
857 /* Comma terminates the string. */
858 LS_TOKEN_STOKEN (token).ptr = start;
859 LS_TOKEN_STOKEN (token).length = PARSER_STREAM (parser) - start;
863 /* Advance the stream. */
864 ++(PARSER_STREAM (parser));
871 /* Lex a single linespec token from PARSER. */
873 static linespec_token
874 linespec_lexer_lex_one (linespec_parser *parser)
878 if (parser->lexer.current.type == LSTOKEN_CONSUMED)
880 /* Skip any whitespace. */
881 PARSER_STREAM (parser) = skip_spaces (PARSER_STREAM (parser));
883 /* Check for a keyword, they end the linespec. */
884 keyword = linespec_lexer_lex_keyword (PARSER_STREAM (parser));
887 parser->lexer.current.type = LSTOKEN_KEYWORD;
888 LS_TOKEN_KEYWORD (parser->lexer.current) = keyword;
889 /* We do not advance the stream here intentionally:
890 we would like lexing to stop when a keyword is seen.
892 PARSER_STREAM (parser) += strlen (keyword); */
894 return parser->lexer.current;
897 /* Handle other tokens. */
898 switch (*PARSER_STREAM (parser))
901 parser->lexer.current.type = LSTOKEN_EOI;
905 case '0': case '1': case '2': case '3': case '4':
906 case '5': case '6': case '7': case '8': case '9':
907 if (!linespec_lexer_lex_number (parser, &(parser->lexer.current)))
908 parser->lexer.current = linespec_lexer_lex_string (parser);
912 /* If we have a scope operator, lex the input as a string.
913 Otherwise, return LSTOKEN_COLON. */
914 if (PARSER_STREAM (parser)[1] == ':')
915 parser->lexer.current = linespec_lexer_lex_string (parser);
918 parser->lexer.current.type = LSTOKEN_COLON;
919 ++(PARSER_STREAM (parser));
923 case '\'': case '\"':
924 /* Special case: permit quote-enclosed linespecs. */
925 if (parser->is_quote_enclosed
926 && is_closing_quote_enclosed (PARSER_STREAM (parser)))
928 ++(PARSER_STREAM (parser));
929 parser->lexer.current.type = LSTOKEN_EOI;
932 parser->lexer.current = linespec_lexer_lex_string (parser);
936 parser->lexer.current.type = LSTOKEN_COMMA;
937 LS_TOKEN_STOKEN (parser->lexer.current).ptr
938 = PARSER_STREAM (parser);
939 LS_TOKEN_STOKEN (parser->lexer.current).length = 1;
940 ++(PARSER_STREAM (parser));
944 /* If the input is not a number, it must be a string.
945 [Keywords were already considered above.] */
946 parser->lexer.current = linespec_lexer_lex_string (parser);
951 return parser->lexer.current;
954 /* Consume the current token and return the next token in PARSER's
955 input stream. Also advance the completion word for completion
958 static linespec_token
959 linespec_lexer_consume_token (linespec_parser *parser)
961 gdb_assert (parser->lexer.current.type != LSTOKEN_EOI);
963 bool advance_word = (parser->lexer.current.type != LSTOKEN_STRING
964 || *PARSER_STREAM (parser) != '\0');
966 /* If we're moving past a string to some other token, it must be the
967 quote was terminated. */
968 if (parser->completion_quote_char)
970 gdb_assert (parser->lexer.current.type == LSTOKEN_STRING);
972 /* If the string was the last (non-EOI) token, we're past the
973 quote, but remember that for later. */
974 if (*PARSER_STREAM (parser) != '\0')
976 parser->completion_quote_char = '\0';
977 parser->completion_quote_end = NULL;;
981 parser->lexer.current.type = LSTOKEN_CONSUMED;
982 linespec_lexer_lex_one (parser);
984 if (parser->lexer.current.type == LSTOKEN_STRING)
986 /* Advance the completion word past a potential initial
988 parser->completion_word = LS_TOKEN_STOKEN (parser->lexer.current).ptr;
990 else if (advance_word)
992 /* Advance the completion word past any whitespace. */
993 parser->completion_word = PARSER_STREAM (parser);
996 return parser->lexer.current;
999 /* Return the next token without consuming the current token. */
1001 static linespec_token
1002 linespec_lexer_peek_token (linespec_parser *parser)
1004 linespec_token next;
1005 const char *saved_stream = PARSER_STREAM (parser);
1006 linespec_token saved_token = parser->lexer.current;
1007 int saved_completion_quote_char = parser->completion_quote_char;
1008 const char *saved_completion_quote_end = parser->completion_quote_end;
1009 const char *saved_completion_word = parser->completion_word;
1011 next = linespec_lexer_consume_token (parser);
1012 PARSER_STREAM (parser) = saved_stream;
1013 parser->lexer.current = saved_token;
1014 parser->completion_quote_char = saved_completion_quote_char;
1015 parser->completion_quote_end = saved_completion_quote_end;
1016 parser->completion_word = saved_completion_word;
1020 /* Helper functions. */
1022 /* Add SAL to SALS, and also update SELF->CANONICAL_NAMES to reflect
1023 the new sal, if needed. If not NULL, SYMNAME is the name of the
1024 symbol to use when constructing the new canonical name.
1026 If LITERAL_CANONICAL is non-zero, SYMNAME will be used as the
1027 canonical name for the SAL. */
1030 add_sal_to_sals (struct linespec_state *self,
1031 std::vector<symtab_and_line> *sals,
1032 struct symtab_and_line *sal,
1033 const char *symname, int literal_canonical)
1035 sals->push_back (*sal);
1037 if (self->canonical)
1039 struct linespec_canonical_name *canonical;
1041 self->canonical_names = XRESIZEVEC (struct linespec_canonical_name,
1042 self->canonical_names,
1044 canonical = &self->canonical_names[sals->size () - 1];
1045 if (!literal_canonical && sal->symtab)
1047 symtab_to_fullname (sal->symtab);
1049 /* Note that the filter doesn't have to be a valid linespec
1050 input. We only apply the ":LINE" treatment to Ada for
1052 if (symname != NULL && sal->line != 0
1053 && self->language->la_language == language_ada)
1054 canonical->suffix = xstrprintf ("%s:%d", symname, sal->line);
1055 else if (symname != NULL)
1056 canonical->suffix = xstrdup (symname);
1058 canonical->suffix = xstrprintf ("%d", sal->line);
1059 canonical->symtab = sal->symtab;
1063 if (symname != NULL)
1064 canonical->suffix = xstrdup (symname);
1066 canonical->suffix = xstrdup ("<unknown>");
1067 canonical->symtab = NULL;
1072 /* A hash function for address_entry. */
1075 hash_address_entry (const void *p)
1077 const struct address_entry *aep = (const struct address_entry *) p;
1080 hash = iterative_hash_object (aep->pspace, 0);
1081 return iterative_hash_object (aep->addr, hash);
1084 /* An equality function for address_entry. */
1087 eq_address_entry (const void *a, const void *b)
1089 const struct address_entry *aea = (const struct address_entry *) a;
1090 const struct address_entry *aeb = (const struct address_entry *) b;
1092 return aea->pspace == aeb->pspace && aea->addr == aeb->addr;
1095 /* Check whether the address, represented by PSPACE and ADDR, is
1096 already in the set. If so, return 0. Otherwise, add it and return
1100 maybe_add_address (htab_t set, struct program_space *pspace, CORE_ADDR addr)
1102 struct address_entry e, *p;
1107 slot = htab_find_slot (set, &e, INSERT);
1111 p = XNEW (struct address_entry);
1112 memcpy (p, &e, sizeof (struct address_entry));
1118 /* A helper that walks over all matching symtabs in all objfiles and
1119 calls CALLBACK for each symbol matching NAME. If SEARCH_PSPACE is
1120 not NULL, then the search is restricted to just that program
1121 space. If INCLUDE_INLINE is true then symbols representing
1122 inlined instances of functions will be included in the result. */
1125 iterate_over_all_matching_symtabs
1126 (struct linespec_state *state,
1127 const lookup_name_info &lookup_name,
1128 const domain_enum name_domain,
1129 enum search_domain search_domain,
1130 struct program_space *search_pspace, bool include_inline,
1131 gdb::function_view<symbol_found_callback_ftype> callback)
1133 struct program_space *pspace;
1135 ALL_PSPACES (pspace)
1137 if (search_pspace != NULL && search_pspace != pspace)
1139 if (pspace->executing_startup)
1142 set_current_program_space (pspace);
1144 for (objfile *objfile : current_program_space->objfiles ())
1147 objfile->sf->qf->expand_symtabs_matching (objfile,
1153 for (compunit_symtab *cu : objfile->compunits ())
1155 struct symtab *symtab = COMPUNIT_FILETABS (cu);
1157 iterate_over_file_blocks (symtab, lookup_name, name_domain,
1162 struct block *block;
1165 for (i = FIRST_LOCAL_BLOCK;
1166 i < BLOCKVECTOR_NBLOCKS (SYMTAB_BLOCKVECTOR (symtab));
1169 block = BLOCKVECTOR_BLOCK (SYMTAB_BLOCKVECTOR (symtab), i);
1170 state->language->la_iterate_over_symbols
1171 (block, lookup_name, name_domain,
1172 [&] (block_symbol *bsym)
1174 /* Restrict calls to CALLBACK to symbols
1175 representing inline symbols only. */
1176 if (SYMBOL_INLINED (bsym->symbol))
1177 return callback (bsym);
1187 /* Returns the block to be used for symbol searches from
1188 the current location. */
1190 static const struct block *
1191 get_current_search_block (void)
1193 const struct block *block;
1194 enum language save_language;
1196 /* get_selected_block can change the current language when there is
1197 no selected frame yet. */
1198 save_language = current_language->la_language;
1199 block = get_selected_block (0);
1200 set_language (save_language);
1205 /* Iterate over static and global blocks. */
1208 iterate_over_file_blocks
1209 (struct symtab *symtab, const lookup_name_info &name,
1210 domain_enum domain, gdb::function_view<symbol_found_callback_ftype> callback)
1212 struct block *block;
1214 for (block = BLOCKVECTOR_BLOCK (SYMTAB_BLOCKVECTOR (symtab), STATIC_BLOCK);
1216 block = BLOCK_SUPERBLOCK (block))
1217 LA_ITERATE_OVER_SYMBOLS (block, name, domain, callback);
1220 /* A helper for find_method. This finds all methods in type T of
1221 language T_LANG which match NAME. It adds matching symbol names to
1222 RESULT_NAMES, and adds T's direct superclasses to SUPERCLASSES. */
1225 find_methods (struct type *t, enum language t_lang, const char *name,
1226 std::vector<const char *> *result_names,
1227 std::vector<struct type *> *superclasses)
1230 const char *class_name = TYPE_NAME (t);
1232 /* Ignore this class if it doesn't have a name. This is ugly, but
1233 unless we figure out how to get the physname without the name of
1234 the class, then the loop can't do any good. */
1238 lookup_name_info lookup_name (name, symbol_name_match_type::FULL);
1239 symbol_name_matcher_ftype *symbol_name_compare
1240 = get_symbol_name_matcher (language_def (t_lang), lookup_name);
1242 t = check_typedef (t);
1244 /* Loop over each method name. At this level, all overloads of a name
1245 are counted as a single name. There is an inner loop which loops over
1248 for (method_counter = TYPE_NFN_FIELDS (t) - 1;
1249 method_counter >= 0;
1252 const char *method_name = TYPE_FN_FIELDLIST_NAME (t, method_counter);
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 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<block_symbol> symbols;
1772 std::vector<block_symbol> *labels;
1773 std::vector<bound_minimal_symbol> 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.empty ())
1878 PARSER_RESULT (parser)->function_symbols
1879 = new std::vector<block_symbol> (std::move (symbols));
1880 PARSER_RESULT (parser)->minimal_symbols
1881 = new std::vector<bound_minimal_symbol>
1882 (std::move (minimal_symbols));
1883 PARSER_EXPLICIT (parser)->function_name = name.release ();
1887 /* NAME was not a function or a method. So it must be a label
1888 name or user specified variable like "break foo.c:$zippo". */
1889 labels = find_label_symbols (PARSER_STATE (parser), NULL,
1890 &symbols, name.get ());
1893 PARSER_RESULT (parser)->labels.label_symbols = labels;
1894 PARSER_RESULT (parser)->labels.function_symbols
1895 = new std::vector<block_symbol> (std::move (symbols));
1896 PARSER_EXPLICIT (parser)->label_name = name.release ();
1898 else if (token.type == LSTOKEN_STRING
1899 && *LS_TOKEN_STOKEN (token).ptr == '$')
1901 /* User specified a convenience variable or history value. */
1902 PARSER_EXPLICIT (parser)->line_offset
1903 = linespec_parse_variable (PARSER_STATE (parser), name.get ());
1905 if (PARSER_EXPLICIT (parser)->line_offset.sign == LINE_OFFSET_UNKNOWN)
1907 /* The user-specified variable was not valid. Do not
1908 throw an error here. parse_linespec will do it for us. */
1909 PARSER_EXPLICIT (parser)->function_name = name.release ();
1915 /* The name is also not a label. Abort parsing. Do not throw
1916 an error here. parse_linespec will do it for us. */
1918 /* Save a copy of the name we were trying to lookup. */
1919 PARSER_EXPLICIT (parser)->function_name = name.release ();
1925 int previous_qc = parser->completion_quote_char;
1927 /* Get the next token. */
1928 token = linespec_lexer_consume_token (parser);
1930 if (token.type == LSTOKEN_EOI)
1932 if (previous_qc && !parser->completion_quote_char)
1933 parser->complete_what = linespec_complete_what::KEYWORD;
1935 else if (token.type == LSTOKEN_COLON)
1937 /* User specified a label or a lineno. */
1938 token = linespec_lexer_consume_token (parser);
1940 if (token.type == LSTOKEN_NUMBER)
1942 /* User specified an offset. Record the line offset and
1943 get the next token. */
1944 set_completion_after_number (parser, linespec_complete_what::KEYWORD);
1946 name = copy_token_string (token);
1947 PARSER_EXPLICIT (parser)->line_offset
1948 = linespec_parse_line_offset (name.get ());
1950 /* Get the next token. */
1951 token = linespec_lexer_consume_token (parser);
1953 else if (token.type == LSTOKEN_EOI && parser->completion_tracker != NULL)
1955 parser->complete_what = linespec_complete_what::LABEL;
1957 else if (token.type == LSTOKEN_STRING)
1959 parser->complete_what = linespec_complete_what::LABEL;
1961 /* If we have text after the label separated by whitespace
1962 (e.g., "b func():lab i<tab>"), don't consider it part of
1963 the label. In completion mode that should complete to
1964 "if", in normal mode, the 'i' should be treated as
1966 if (parser->completion_quote_char == '\0')
1968 const char *ptr = LS_TOKEN_STOKEN (token).ptr;
1969 for (size_t i = 0; i < LS_TOKEN_STOKEN (token).length; i++)
1973 LS_TOKEN_STOKEN (token).length = i;
1974 PARSER_STREAM (parser) = skip_spaces (ptr + i + 1);
1980 if (parser->completion_tracker != NULL)
1982 if (PARSER_STREAM (parser)[-1] == ' ')
1984 parser->completion_word = PARSER_STREAM (parser);
1985 parser->complete_what = linespec_complete_what::KEYWORD;
1990 /* Grab a copy of the label's name and look it up. */
1991 name = copy_token_string (token);
1993 = find_label_symbols (PARSER_STATE (parser),
1994 PARSER_RESULT (parser)->function_symbols,
1995 &symbols, name.get ());
1999 PARSER_RESULT (parser)->labels.label_symbols = labels;
2000 PARSER_RESULT (parser)->labels.function_symbols
2001 = new std::vector<block_symbol> (std::move (symbols));
2002 PARSER_EXPLICIT (parser)->label_name = name.release ();
2006 /* We don't know what it was, but it isn't a label. */
2007 undefined_label_error
2008 (PARSER_EXPLICIT (parser)->function_name, name.get ());
2013 /* Check for a line offset. */
2014 token = save_stream_and_consume_token (parser);
2015 if (token.type == LSTOKEN_COLON)
2017 /* Get the next token. */
2018 token = linespec_lexer_consume_token (parser);
2020 /* It must be a line offset. */
2021 if (token.type != LSTOKEN_NUMBER)
2022 unexpected_linespec_error (parser);
2024 /* Record the line offset and get the next token. */
2025 name = copy_token_string (token);
2027 PARSER_EXPLICIT (parser)->line_offset
2028 = linespec_parse_line_offset (name.get ());
2030 /* Get the next token. */
2031 token = linespec_lexer_consume_token (parser);
2036 /* Trailing ':' in the input. Issue an error. */
2037 unexpected_linespec_error (parser);
2042 /* Canonicalize the linespec contained in LS. The result is saved into
2043 STATE->canonical. This function handles both linespec and explicit
2047 canonicalize_linespec (struct linespec_state *state, const linespec_p ls)
2049 struct event_location *canon;
2050 struct explicit_location *explicit_loc;
2052 /* If canonicalization was not requested, no need to do anything. */
2053 if (!state->canonical)
2056 /* Save everything as an explicit location. */
2057 state->canonical->location
2058 = new_explicit_location (&ls->explicit_loc);
2059 canon = state->canonical->location.get ();
2060 explicit_loc = get_explicit_location (canon);
2062 if (explicit_loc->label_name != NULL)
2064 state->canonical->special_display = 1;
2066 if (explicit_loc->function_name == NULL)
2068 /* No function was specified, so add the symbol name. */
2069 gdb_assert (!ls->labels.function_symbols->empty ()
2070 && (ls->labels.function_symbols->size () == 1));
2071 block_symbol s = ls->labels.function_symbols->front ();
2072 explicit_loc->function_name
2073 = xstrdup (SYMBOL_NATURAL_NAME (s.symbol));
2077 /* If this location originally came from a linespec, save a string
2078 representation of it for display and saving to file. */
2079 if (state->is_linespec)
2081 char *linespec = explicit_location_to_linespec (explicit_loc);
2083 set_event_location_string (canon, linespec);
2088 /* Given a line offset in LS, construct the relevant SALs. */
2090 static std::vector<symtab_and_line>
2091 create_sals_line_offset (struct linespec_state *self,
2094 int use_default = 0;
2096 /* This is where we need to make sure we have good defaults.
2097 We must guarantee that this section of code is never executed
2098 when we are called with just a function name, since
2099 set_default_source_symtab_and_line uses
2100 select_source_symtab that calls us with such an argument. */
2102 if (ls->file_symtabs->size () == 1
2103 && ls->file_symtabs->front () == nullptr)
2105 set_current_program_space (self->program_space);
2107 /* Make sure we have at least a default source line. */
2108 set_default_source_symtab_and_line ();
2109 initialize_defaults (&self->default_symtab, &self->default_line);
2111 = collect_symtabs_from_filename (self->default_symtab->filename,
2112 self->search_pspace);
2116 symtab_and_line val;
2117 val.line = ls->explicit_loc.line_offset.offset;
2118 switch (ls->explicit_loc.line_offset.sign)
2120 case LINE_OFFSET_PLUS:
2121 if (ls->explicit_loc.line_offset.offset == 0)
2124 val.line = self->default_line + val.line;
2127 case LINE_OFFSET_MINUS:
2128 if (ls->explicit_loc.line_offset.offset == 0)
2131 val.line = self->default_line - val.line;
2133 val.line = -val.line;
2136 case LINE_OFFSET_NONE:
2137 break; /* No need to adjust val.line. */
2140 std::vector<symtab_and_line> values;
2141 if (self->list_mode)
2142 values = decode_digits_list_mode (self, ls, val);
2145 struct linetable_entry *best_entry = NULL;
2148 std::vector<symtab_and_line> intermediate_results
2149 = decode_digits_ordinary (self, ls, val.line, &best_entry);
2150 if (intermediate_results.empty () && best_entry != NULL)
2151 intermediate_results = decode_digits_ordinary (self, ls,
2155 /* For optimized code, the compiler can scatter one source line
2156 across disjoint ranges of PC values, even when no duplicate
2157 functions or inline functions are involved. For example,
2158 'for (;;)' inside a non-template, non-inline, and non-ctor-or-dtor
2159 function can result in two PC ranges. In this case, we don't
2160 want to set a breakpoint on the first PC of each range. To filter
2161 such cases, we use containing blocks -- for each PC found
2162 above, we see if there are other PCs that are in the same
2163 block. If yes, the other PCs are filtered out. */
2165 gdb::def_vector<int> filter (intermediate_results.size ());
2166 gdb::def_vector<const block *> blocks (intermediate_results.size ());
2168 for (i = 0; i < intermediate_results.size (); ++i)
2170 set_current_program_space (intermediate_results[i].pspace);
2173 blocks[i] = block_for_pc_sect (intermediate_results[i].pc,
2174 intermediate_results[i].section);
2177 for (i = 0; i < intermediate_results.size (); ++i)
2179 if (blocks[i] != NULL)
2180 for (j = i + 1; j < intermediate_results.size (); ++j)
2182 if (blocks[j] == blocks[i])
2190 for (i = 0; i < intermediate_results.size (); ++i)
2193 struct symbol *sym = (blocks[i]
2194 ? block_containing_function (blocks[i])
2197 if (self->funfirstline)
2198 skip_prologue_sal (&intermediate_results[i]);
2199 intermediate_results[i].symbol = sym;
2200 add_sal_to_sals (self, &values, &intermediate_results[i],
2201 sym ? SYMBOL_NATURAL_NAME (sym) : NULL, 0);
2205 if (values.empty ())
2207 if (ls->explicit_loc.source_filename)
2208 throw_error (NOT_FOUND_ERROR, _("No line %d in file \"%s\"."),
2209 val.line, ls->explicit_loc.source_filename);
2211 throw_error (NOT_FOUND_ERROR, _("No line %d in the current file."),
2218 /* Convert the given ADDRESS into SaLs. */
2220 static std::vector<symtab_and_line>
2221 convert_address_location_to_sals (struct linespec_state *self,
2224 symtab_and_line sal = find_pc_line (address, 0);
2226 sal.section = find_pc_overlay (address);
2227 sal.explicit_pc = 1;
2228 sal.symbol = find_pc_sect_containing_function (sal.pc, sal.section);
2230 std::vector<symtab_and_line> sals;
2231 add_sal_to_sals (self, &sals, &sal, core_addr_to_string (address), 1);
2236 /* Create and return SALs from the linespec LS. */
2238 static std::vector<symtab_and_line>
2239 convert_linespec_to_sals (struct linespec_state *state, linespec_p ls)
2241 std::vector<symtab_and_line> sals;
2243 if (ls->labels.label_symbols != NULL)
2245 /* We have just a bunch of functions/methods or labels. */
2246 struct symtab_and_line sal;
2248 for (const auto &sym : *ls->labels.label_symbols)
2250 struct program_space *pspace
2251 = SYMTAB_PSPACE (symbol_symtab (sym.symbol));
2253 if (symbol_to_sal (&sal, state->funfirstline, sym.symbol)
2254 && maybe_add_address (state->addr_set, pspace, sal.pc))
2255 add_sal_to_sals (state, &sals, &sal,
2256 SYMBOL_NATURAL_NAME (sym.symbol), 0);
2259 else if (ls->function_symbols != NULL || ls->minimal_symbols != NULL)
2261 /* We have just a bunch of functions and/or methods. */
2262 if (ls->function_symbols != NULL)
2264 /* Sort symbols so that symbols with the same program space are next
2266 std::sort (ls->function_symbols->begin (),
2267 ls->function_symbols->end (),
2270 for (const auto &sym : *ls->function_symbols)
2272 program_space *pspace
2273 = SYMTAB_PSPACE (symbol_symtab (sym.symbol));
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.symbol) == LOC_BLOCK)
2286 const CORE_ADDR addr
2287 = BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym.symbol));
2289 for (const auto &elem : *ls->minimal_symbols)
2291 if (MSYMBOL_TYPE (elem.minsym) == mst_text_gnu_ifunc
2292 || MSYMBOL_TYPE (elem.minsym) == mst_data_gnu_ifunc)
2294 CORE_ADDR msym_addr = BMSYMBOL_VALUE_ADDRESS (elem);
2295 if (MSYMBOL_TYPE (elem.minsym) == mst_data_gnu_ifunc)
2297 struct gdbarch *gdbarch
2298 = get_objfile_arch (elem.objfile);
2300 = (gdbarch_convert_from_func_ptr_addr
2303 current_top_target ()));
2306 if (msym_addr == addr)
2317 symtab_and_line sal;
2318 if (symbol_to_sal (&sal, state->funfirstline, sym.symbol)
2319 && maybe_add_address (state->addr_set, pspace, sal.pc))
2320 add_sal_to_sals (state, &sals, &sal,
2321 SYMBOL_NATURAL_NAME (sym.symbol), 0);
2326 if (ls->minimal_symbols != NULL)
2328 /* Sort minimal symbols by program space, too */
2329 std::sort (ls->minimal_symbols->begin (),
2330 ls->minimal_symbols->end (),
2333 for (const auto &elem : *ls->minimal_symbols)
2335 program_space *pspace = elem.objfile->pspace;
2336 set_current_program_space (pspace);
2337 minsym_found (state, elem.objfile, elem.minsym, &sals);
2341 else if (ls->explicit_loc.line_offset.sign != LINE_OFFSET_UNKNOWN)
2343 /* Only an offset was specified. */
2344 sals = create_sals_line_offset (state, ls);
2346 /* Make sure we have a filename for canonicalization. */
2347 if (ls->explicit_loc.source_filename == NULL)
2349 const char *fullname = symtab_to_fullname (state->default_symtab);
2351 /* It may be more appropriate to keep DEFAULT_SYMTAB in its symtab
2352 form so that displaying SOURCE_FILENAME can follow the current
2353 FILENAME_DISPLAY_STRING setting. But as it is used only rarely
2354 it has been kept for code simplicity only in absolute form. */
2355 ls->explicit_loc.source_filename = xstrdup (fullname);
2360 /* We haven't found any results... */
2364 canonicalize_linespec (state, ls);
2366 if (!sals.empty () && state->canonical != NULL)
2367 state->canonical->pre_expanded = 1;
2372 /* Build RESULT from the explicit location components SOURCE_FILENAME,
2373 FUNCTION_NAME, LABEL_NAME and LINE_OFFSET. */
2376 convert_explicit_location_to_linespec (struct linespec_state *self,
2378 const char *source_filename,
2379 const char *function_name,
2380 symbol_name_match_type fname_match_type,
2381 const char *label_name,
2382 struct line_offset line_offset)
2384 std::vector<block_symbol> symbols;
2385 std::vector<block_symbol> *labels;
2386 std::vector<bound_minimal_symbol> minimal_symbols;
2388 result->explicit_loc.func_name_match_type = fname_match_type;
2390 if (source_filename != NULL)
2394 *result->file_symtabs
2395 = symtabs_from_filename (source_filename, self->search_pspace);
2397 CATCH (except, RETURN_MASK_ERROR)
2399 source_file_not_found_error (source_filename);
2402 result->explicit_loc.source_filename = xstrdup (source_filename);
2406 /* A NULL entry means to use the default symtab. */
2407 result->file_symtabs->push_back (nullptr);
2410 if (function_name != NULL)
2412 find_linespec_symbols (self, result->file_symtabs,
2413 function_name, fname_match_type,
2414 &symbols, &minimal_symbols);
2416 if (symbols.empty () && minimal_symbols.empty ())
2417 symbol_not_found_error (function_name,
2418 result->explicit_loc.source_filename);
2420 result->explicit_loc.function_name = xstrdup (function_name);
2421 result->function_symbols
2422 = new std::vector<block_symbol> (std::move (symbols));
2423 result->minimal_symbols
2424 = new std::vector<bound_minimal_symbol> (std::move (minimal_symbols));
2427 if (label_name != NULL)
2429 labels = find_label_symbols (self, result->function_symbols,
2430 &symbols, label_name);
2433 undefined_label_error (result->explicit_loc.function_name,
2436 result->explicit_loc.label_name = xstrdup (label_name);
2437 result->labels.label_symbols = labels;
2438 result->labels.function_symbols
2439 = new std::vector<block_symbol> (std::move (symbols));
2442 if (line_offset.sign != LINE_OFFSET_UNKNOWN)
2443 result->explicit_loc.line_offset = line_offset;
2446 /* Convert the explicit location EXPLICIT_LOC into SaLs. */
2448 static std::vector<symtab_and_line>
2449 convert_explicit_location_to_sals (struct linespec_state *self,
2451 const struct explicit_location *explicit_loc)
2453 convert_explicit_location_to_linespec (self, result,
2454 explicit_loc->source_filename,
2455 explicit_loc->function_name,
2456 explicit_loc->func_name_match_type,
2457 explicit_loc->label_name,
2458 explicit_loc->line_offset);
2459 return convert_linespec_to_sals (self, result);
2462 /* Parse a string that specifies a linespec.
2464 The basic grammar of linespecs:
2466 linespec -> var_spec | basic_spec
2467 var_spec -> '$' (STRING | NUMBER)
2469 basic_spec -> file_offset_spec | function_spec | label_spec
2470 file_offset_spec -> opt_file_spec offset_spec
2471 function_spec -> opt_file_spec function_name_spec opt_label_spec
2472 label_spec -> label_name_spec
2474 opt_file_spec -> "" | file_name_spec ':'
2475 opt_label_spec -> "" | ':' label_name_spec
2477 file_name_spec -> STRING
2478 function_name_spec -> STRING
2479 label_name_spec -> STRING
2480 function_name_spec -> STRING
2481 offset_spec -> NUMBER
2485 This may all be followed by several keywords such as "if EXPR",
2488 A comma will terminate parsing.
2490 The function may be an undebuggable function found in minimal symbol table.
2492 If the argument FUNFIRSTLINE is nonzero, we want the first line
2493 of real code inside a function when a function is specified, and it is
2494 not OK to specify a variable or type to get its line number.
2496 DEFAULT_SYMTAB specifies the file to use if none is specified.
2497 It defaults to current_source_symtab.
2498 DEFAULT_LINE specifies the line number to use for relative
2499 line numbers (that start with signs). Defaults to current_source_line.
2500 If CANONICAL is non-NULL, store an array of strings containing the canonical
2501 line specs there if necessary. Currently overloaded member functions and
2502 line numbers or static functions without a filename yield a canonical
2503 line spec. The array and the line spec strings are allocated on the heap,
2504 it is the callers responsibility to free them.
2506 Note that it is possible to return zero for the symtab
2507 if no file is validly specified. Callers must check that.
2508 Also, the line number returned may be invalid. */
2510 /* Parse the linespec in ARG. MATCH_TYPE indicates how function names
2511 should be matched. */
2513 static std::vector<symtab_and_line>
2514 parse_linespec (linespec_parser *parser, const char *arg,
2515 symbol_name_match_type match_type)
2517 linespec_token token;
2518 struct gdb_exception file_exception = exception_none;
2520 /* A special case to start. It has become quite popular for
2521 IDEs to work around bugs in the previous parser by quoting
2522 the entire linespec, so we attempt to deal with this nicely. */
2523 parser->is_quote_enclosed = 0;
2524 if (parser->completion_tracker == NULL
2525 && !is_ada_operator (arg)
2526 && strchr (linespec_quote_characters, *arg) != NULL)
2530 end = skip_quote_char (arg + 1, *arg);
2531 if (end != NULL && is_closing_quote_enclosed (end))
2533 /* Here's the special case. Skip ARG past the initial
2536 parser->is_quote_enclosed = 1;
2540 parser->lexer.saved_arg = arg;
2541 parser->lexer.stream = arg;
2542 parser->completion_word = arg;
2543 parser->complete_what = linespec_complete_what::FUNCTION;
2544 PARSER_EXPLICIT (parser)->func_name_match_type = match_type;
2546 /* Initialize the default symtab and line offset. */
2547 initialize_defaults (&PARSER_STATE (parser)->default_symtab,
2548 &PARSER_STATE (parser)->default_line);
2550 /* Objective-C shortcut. */
2551 if (parser->completion_tracker == NULL)
2553 std::vector<symtab_and_line> values
2554 = decode_objc (PARSER_STATE (parser), PARSER_RESULT (parser), arg);
2555 if (!values.empty ())
2560 /* "-"/"+" is either an objc selector, or a number. There's
2561 nothing to complete the latter to, so just let the caller
2562 complete on functions, which finds objc selectors, if there's
2564 if ((arg[0] == '-' || arg[0] == '+') && arg[1] == '\0')
2568 /* Start parsing. */
2570 /* Get the first token. */
2571 token = linespec_lexer_consume_token (parser);
2573 /* It must be either LSTOKEN_STRING or LSTOKEN_NUMBER. */
2574 if (token.type == LSTOKEN_STRING && *LS_TOKEN_STOKEN (token).ptr == '$')
2576 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2577 if (parser->completion_tracker == NULL)
2578 PARSER_RESULT (parser)->file_symtabs->push_back (nullptr);
2580 /* User specified a convenience variable or history value. */
2581 gdb::unique_xmalloc_ptr<char> var = copy_token_string (token);
2582 PARSER_EXPLICIT (parser)->line_offset
2583 = linespec_parse_variable (PARSER_STATE (parser), var.get ());
2585 /* If a line_offset wasn't found (VAR is the name of a user
2586 variable/function), then skip to normal symbol processing. */
2587 if (PARSER_EXPLICIT (parser)->line_offset.sign != LINE_OFFSET_UNKNOWN)
2589 /* Consume this token. */
2590 linespec_lexer_consume_token (parser);
2592 goto convert_to_sals;
2595 else if (token.type == LSTOKEN_EOI && parser->completion_tracker != NULL)
2597 /* Let the default linespec_complete_what::FUNCTION kick in. */
2598 unexpected_linespec_error (parser);
2600 else if (token.type != LSTOKEN_STRING && token.type != LSTOKEN_NUMBER)
2602 parser->complete_what = linespec_complete_what::NOTHING;
2603 unexpected_linespec_error (parser);
2606 /* Shortcut: If the next token is not LSTOKEN_COLON, we know that
2607 this token cannot represent a filename. */
2608 token = linespec_lexer_peek_token (parser);
2610 if (token.type == LSTOKEN_COLON)
2612 /* Get the current token again and extract the filename. */
2613 token = linespec_lexer_lex_one (parser);
2614 gdb::unique_xmalloc_ptr<char> user_filename = copy_token_string (token);
2616 /* Check if the input is a filename. */
2619 *PARSER_RESULT (parser)->file_symtabs
2620 = symtabs_from_filename (user_filename.get (),
2621 PARSER_STATE (parser)->search_pspace);
2623 CATCH (ex, RETURN_MASK_ERROR)
2625 file_exception = ex;
2629 if (file_exception.reason >= 0)
2631 /* Symtabs were found for the file. Record the filename. */
2632 PARSER_EXPLICIT (parser)->source_filename = user_filename.release ();
2634 /* Get the next token. */
2635 token = linespec_lexer_consume_token (parser);
2637 /* This is LSTOKEN_COLON; consume it. */
2638 linespec_lexer_consume_token (parser);
2642 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2643 PARSER_RESULT (parser)->file_symtabs->push_back (nullptr);
2646 /* If the next token is not EOI, KEYWORD, or COMMA, issue an error. */
2647 else if (parser->completion_tracker == NULL
2648 && (token.type != LSTOKEN_EOI && token.type != LSTOKEN_KEYWORD
2649 && token.type != LSTOKEN_COMMA))
2651 /* TOKEN is the _next_ token, not the one currently in the parser.
2652 Consuming the token will give the correct error message. */
2653 linespec_lexer_consume_token (parser);
2654 unexpected_linespec_error (parser);
2658 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2659 PARSER_RESULT (parser)->file_symtabs->push_back (nullptr);
2662 /* Parse the rest of the linespec. */
2663 linespec_parse_basic (parser);
2665 if (parser->completion_tracker == NULL
2666 && PARSER_RESULT (parser)->function_symbols == NULL
2667 && PARSER_RESULT (parser)->labels.label_symbols == NULL
2668 && PARSER_EXPLICIT (parser)->line_offset.sign == LINE_OFFSET_UNKNOWN
2669 && PARSER_RESULT (parser)->minimal_symbols == NULL)
2671 /* The linespec didn't parse. Re-throw the file exception if
2673 if (file_exception.reason < 0)
2674 throw_exception (file_exception);
2676 /* Otherwise, the symbol is not found. */
2677 symbol_not_found_error (PARSER_EXPLICIT (parser)->function_name,
2678 PARSER_EXPLICIT (parser)->source_filename);
2683 /* Get the last token and record how much of the input was parsed,
2685 token = linespec_lexer_lex_one (parser);
2686 if (token.type != LSTOKEN_EOI && token.type != LSTOKEN_KEYWORD)
2687 unexpected_linespec_error (parser);
2688 else if (token.type == LSTOKEN_KEYWORD)
2690 /* Setup the completion word past the keyword. Lexing never
2691 advances past a keyword automatically, so skip it
2693 parser->completion_word
2694 = skip_spaces (skip_to_space (PARSER_STREAM (parser)));
2695 parser->complete_what = linespec_complete_what::EXPRESSION;
2698 /* Convert the data in PARSER_RESULT to SALs. */
2699 if (parser->completion_tracker == NULL)
2700 return convert_linespec_to_sals (PARSER_STATE (parser),
2701 PARSER_RESULT (parser));
2707 /* A constructor for linespec_state. */
2710 linespec_state_constructor (struct linespec_state *self,
2711 int flags, const struct language_defn *language,
2712 struct program_space *search_pspace,
2713 struct symtab *default_symtab,
2715 struct linespec_result *canonical)
2717 memset (self, 0, sizeof (*self));
2718 self->language = language;
2719 self->funfirstline = (flags & DECODE_LINE_FUNFIRSTLINE) ? 1 : 0;
2720 self->list_mode = (flags & DECODE_LINE_LIST_MODE) ? 1 : 0;
2721 self->search_pspace = search_pspace;
2722 self->default_symtab = default_symtab;
2723 self->default_line = default_line;
2724 self->canonical = canonical;
2725 self->program_space = current_program_space;
2726 self->addr_set = htab_create_alloc (10, hash_address_entry, eq_address_entry,
2727 xfree, xcalloc, xfree);
2728 self->is_linespec = 0;
2731 /* Initialize a new linespec parser. */
2733 linespec_parser::linespec_parser (int flags,
2734 const struct language_defn *language,
2735 struct program_space *search_pspace,
2736 struct symtab *default_symtab,
2738 struct linespec_result *canonical)
2740 lexer.current.type = LSTOKEN_CONSUMED;
2741 PARSER_RESULT (this)->file_symtabs = new std::vector<symtab *> ();
2742 PARSER_EXPLICIT (this)->func_name_match_type
2743 = symbol_name_match_type::WILD;
2744 PARSER_EXPLICIT (this)->line_offset.sign = LINE_OFFSET_UNKNOWN;
2745 linespec_state_constructor (PARSER_STATE (this), flags, language,
2747 default_symtab, default_line, canonical);
2750 /* A destructor for linespec_state. */
2753 linespec_state_destructor (struct linespec_state *self)
2755 htab_delete (self->addr_set);
2756 xfree (self->canonical_names);
2759 /* Delete a linespec parser. */
2761 linespec_parser::~linespec_parser ()
2763 xfree (PARSER_EXPLICIT (this)->source_filename);
2764 xfree (PARSER_EXPLICIT (this)->label_name);
2765 xfree (PARSER_EXPLICIT (this)->function_name);
2767 delete PARSER_RESULT (this)->file_symtabs;
2768 delete PARSER_RESULT (this)->function_symbols;
2769 delete PARSER_RESULT (this)->minimal_symbols;
2770 delete PARSER_RESULT (this)->labels.label_symbols;
2771 delete PARSER_RESULT (this)->labels.function_symbols;
2773 linespec_state_destructor (PARSER_STATE (this));
2776 /* See description in linespec.h. */
2779 linespec_lex_to_end (const char **stringp)
2781 linespec_token token;
2784 if (stringp == NULL || *stringp == NULL)
2787 linespec_parser parser (0, current_language, NULL, NULL, 0, NULL);
2788 parser.lexer.saved_arg = *stringp;
2789 PARSER_STREAM (&parser) = orig = *stringp;
2793 /* Stop before any comma tokens; we need it to keep it
2794 as the next token in the string. */
2795 token = linespec_lexer_peek_token (&parser);
2796 if (token.type == LSTOKEN_COMMA)
2798 token = linespec_lexer_consume_token (&parser);
2800 while (token.type != LSTOKEN_EOI && token.type != LSTOKEN_KEYWORD);
2802 *stringp += PARSER_STREAM (&parser) - orig;
2805 /* See linespec.h. */
2808 linespec_complete_function (completion_tracker &tracker,
2809 const char *function,
2810 symbol_name_match_type func_match_type,
2811 const char *source_filename)
2813 complete_symbol_mode mode = complete_symbol_mode::LINESPEC;
2815 if (source_filename != NULL)
2817 collect_file_symbol_completion_matches (tracker, mode, func_match_type,
2818 function, function, source_filename);
2822 collect_symbol_completion_matches (tracker, mode, func_match_type,
2823 function, function);
2828 /* Helper for complete_linespec to simplify it. SOURCE_FILENAME is
2829 only meaningful if COMPONENT is FUNCTION. */
2832 complete_linespec_component (linespec_parser *parser,
2833 completion_tracker &tracker,
2835 linespec_complete_what component,
2836 const char *source_filename)
2838 if (component == linespec_complete_what::KEYWORD)
2840 complete_on_enum (tracker, linespec_keywords, text, text);
2842 else if (component == linespec_complete_what::EXPRESSION)
2845 = advance_to_expression_complete_word_point (tracker, text);
2846 complete_expression (tracker, text, word);
2848 else if (component == linespec_complete_what::FUNCTION)
2850 completion_list fn_list;
2852 symbol_name_match_type match_type
2853 = PARSER_EXPLICIT (parser)->func_name_match_type;
2854 linespec_complete_function (tracker, text, match_type, source_filename);
2855 if (source_filename == NULL)
2857 /* Haven't seen a source component, like in "b
2858 file.c:function[TAB]". Maybe this wasn't a function, but
2859 a filename instead, like "b file.[TAB]". */
2860 fn_list = complete_source_filenames (text);
2863 /* If we only have a single filename completion, append a ':' for
2864 the user, since that's the only thing that can usefully follow
2866 if (fn_list.size () == 1 && !tracker.have_completions ())
2868 char *fn = fn_list[0].release ();
2870 /* If we also need to append a quote char, it needs to be
2871 appended before the ':'. Append it now, and make ':' the
2872 new "quote" char. */
2873 if (tracker.quote_char ())
2875 char quote_char_str[2] = { (char) tracker.quote_char () };
2877 fn = reconcat (fn, fn, quote_char_str, (char *) NULL);
2878 tracker.set_quote_char (':');
2881 fn = reconcat (fn, fn, ":", (char *) NULL);
2882 fn_list[0].reset (fn);
2884 /* Tell readline to skip appending a space. */
2885 tracker.set_suppress_append_ws (true);
2887 tracker.add_completions (std::move (fn_list));
2891 /* Helper for linespec_complete_label. Find labels that match
2892 LABEL_NAME in the function symbols listed in the PARSER, and add
2893 them to the tracker. */
2896 complete_label (completion_tracker &tracker,
2897 linespec_parser *parser,
2898 const char *label_name)
2900 std::vector<block_symbol> label_function_symbols;
2901 std::vector<block_symbol> *labels
2902 = find_label_symbols (PARSER_STATE (parser),
2903 PARSER_RESULT (parser)->function_symbols,
2904 &label_function_symbols,
2907 if (labels != nullptr)
2909 for (const auto &label : *labels)
2911 char *match = xstrdup (SYMBOL_SEARCH_NAME (label.symbol));
2912 tracker.add_completion (gdb::unique_xmalloc_ptr<char> (match));
2918 /* See linespec.h. */
2921 linespec_complete_label (completion_tracker &tracker,
2922 const struct language_defn *language,
2923 const char *source_filename,
2924 const char *function_name,
2925 symbol_name_match_type func_name_match_type,
2926 const char *label_name)
2928 linespec_parser parser (0, language, NULL, NULL, 0, NULL);
2930 line_offset unknown_offset = { 0, LINE_OFFSET_UNKNOWN };
2934 convert_explicit_location_to_linespec (PARSER_STATE (&parser),
2935 PARSER_RESULT (&parser),
2938 func_name_match_type,
2939 NULL, unknown_offset);
2941 CATCH (ex, RETURN_MASK_ERROR)
2947 complete_label (tracker, &parser, label_name);
2950 /* See description in linespec.h. */
2953 linespec_complete (completion_tracker &tracker, const char *text,
2954 symbol_name_match_type match_type)
2956 const char *orig = text;
2958 linespec_parser parser (0, current_language, NULL, NULL, 0, NULL);
2959 parser.lexer.saved_arg = text;
2960 PARSER_EXPLICIT (&parser)->func_name_match_type = match_type;
2961 PARSER_STREAM (&parser) = text;
2963 parser.completion_tracker = &tracker;
2964 PARSER_STATE (&parser)->is_linespec = 1;
2966 /* Parse as much as possible. parser.completion_word will hold
2967 furthest completion point we managed to parse to. */
2970 parse_linespec (&parser, text, match_type);
2972 CATCH (except, RETURN_MASK_ERROR)
2977 if (parser.completion_quote_char != '\0'
2978 && parser.completion_quote_end != NULL
2979 && parser.completion_quote_end[1] == '\0')
2981 /* If completing a quoted string with the cursor right at
2982 terminating quote char, complete the completion word without
2983 interpretation, so that readline advances the cursor one
2984 whitespace past the quote, even if there's no match. This
2985 makes these cases behave the same:
2987 before: "b function()"
2988 after: "b function() "
2990 before: "b 'function()'"
2991 after: "b 'function()' "
2993 and trusts the user in this case:
2995 before: "b 'not_loaded_function_yet()'"
2996 after: "b 'not_loaded_function_yet()' "
2998 parser.complete_what = linespec_complete_what::NOTHING;
2999 parser.completion_quote_char = '\0';
3001 gdb::unique_xmalloc_ptr<char> text_copy
3002 (xstrdup (parser.completion_word));
3003 tracker.add_completion (std::move (text_copy));
3006 tracker.set_quote_char (parser.completion_quote_char);
3008 if (parser.complete_what == linespec_complete_what::LABEL)
3010 parser.complete_what = linespec_complete_what::NOTHING;
3012 const char *func_name = PARSER_EXPLICIT (&parser)->function_name;
3014 std::vector<block_symbol> function_symbols;
3015 std::vector<bound_minimal_symbol> minimal_symbols;
3016 find_linespec_symbols (PARSER_STATE (&parser),
3017 PARSER_RESULT (&parser)->file_symtabs,
3018 func_name, match_type,
3019 &function_symbols, &minimal_symbols);
3021 PARSER_RESULT (&parser)->function_symbols
3022 = new std::vector<block_symbol> (std::move (function_symbols));
3023 PARSER_RESULT (&parser)->minimal_symbols
3024 = new std::vector<bound_minimal_symbol> (std::move (minimal_symbols));
3026 complete_label (tracker, &parser, parser.completion_word);
3028 else if (parser.complete_what == linespec_complete_what::FUNCTION)
3030 /* While parsing/lexing, we didn't know whether the completion
3031 word completes to a unique function/source name already or
3035 "b function() <tab>"
3036 may need to complete either to:
3037 "b function() const"
3039 "b function() if/thread/task"
3043 may need to complete either to:
3044 "b foo template_fun<T>()"
3045 with "foo" being the template function's return type, or to:
3050 may need to complete either to a source file name:
3052 or this, also a filename, but a unique completion:
3054 or to a function name:
3057 Address that by completing assuming source or function, and
3058 seeing if we find a completion that matches exactly the
3059 completion word. If so, then it must be a function (see note
3060 below) and we advance the completion word to the end of input
3061 and switch to KEYWORD completion mode.
3063 Note: if we find a unique completion for a source filename,
3064 then it won't match the completion word, because the LCD will
3065 contain a trailing ':'. And if we're completing at or after
3066 the ':', then complete_linespec_component won't try to
3067 complete on source filenames. */
3069 const char *word = parser.completion_word;
3071 complete_linespec_component (&parser, tracker,
3072 parser.completion_word,
3073 linespec_complete_what::FUNCTION,
3074 PARSER_EXPLICIT (&parser)->source_filename);
3076 parser.complete_what = linespec_complete_what::NOTHING;
3078 if (tracker.quote_char ())
3080 /* The function/file name was not close-quoted, so this
3081 can't be a keyword. Note: complete_linespec_component
3082 may have swapped the original quote char for ':' when we
3083 get here, but that still indicates the same. */
3085 else if (!tracker.have_completions ())
3088 size_t wordlen = strlen (parser.completion_word);
3091 = string_find_incomplete_keyword_at_end (linespec_keywords,
3092 parser.completion_word,
3097 && parser.completion_word[wordlen - 1] == ' '))
3099 parser.completion_word += key_start;
3100 parser.complete_what = linespec_complete_what::KEYWORD;
3103 else if (tracker.completes_to_completion_word (word))
3105 /* Skip the function and complete on keywords. */
3106 parser.completion_word += strlen (word);
3107 parser.complete_what = linespec_complete_what::KEYWORD;
3108 tracker.discard_completions ();
3112 tracker.advance_custom_word_point_by (parser.completion_word - orig);
3114 complete_linespec_component (&parser, tracker,
3115 parser.completion_word,
3116 parser.complete_what,
3117 PARSER_EXPLICIT (&parser)->source_filename);
3119 /* If we're past the "filename:function:label:offset" linespec, and
3120 didn't find any match, then assume the user might want to create
3121 a pending breakpoint anyway and offer the keyword
3123 if (!parser.completion_quote_char
3124 && (parser.complete_what == linespec_complete_what::FUNCTION
3125 || parser.complete_what == linespec_complete_what::LABEL
3126 || parser.complete_what == linespec_complete_what::NOTHING)
3127 && !tracker.have_completions ())
3130 = parser.completion_word + strlen (parser.completion_word);
3132 if (end > orig && end[-1] == ' ')
3134 tracker.advance_custom_word_point_by (end - parser.completion_word);
3136 complete_linespec_component (&parser, tracker, end,
3137 linespec_complete_what::KEYWORD,
3143 /* A helper function for decode_line_full and decode_line_1 to
3144 turn LOCATION into std::vector<symtab_and_line>. */
3146 static std::vector<symtab_and_line>
3147 event_location_to_sals (linespec_parser *parser,
3148 const struct event_location *location)
3150 std::vector<symtab_and_line> result;
3152 switch (event_location_type (location))
3154 case LINESPEC_LOCATION:
3156 PARSER_STATE (parser)->is_linespec = 1;
3159 const linespec_location *ls = get_linespec_location (location);
3160 result = parse_linespec (parser,
3161 ls->spec_string, ls->match_type);
3163 CATCH (except, RETURN_MASK_ERROR)
3165 throw_exception (except);
3171 case ADDRESS_LOCATION:
3173 const char *addr_string = get_address_string_location (location);
3174 CORE_ADDR addr = get_address_location (location);
3176 if (addr_string != NULL)
3178 addr = linespec_expression_to_pc (&addr_string);
3179 if (PARSER_STATE (parser)->canonical != NULL)
3180 PARSER_STATE (parser)->canonical->location
3181 = copy_event_location (location);
3184 result = convert_address_location_to_sals (PARSER_STATE (parser),
3189 case EXPLICIT_LOCATION:
3191 const struct explicit_location *explicit_loc;
3193 explicit_loc = get_explicit_location_const (location);
3194 result = convert_explicit_location_to_sals (PARSER_STATE (parser),
3195 PARSER_RESULT (parser),
3200 case PROBE_LOCATION:
3201 /* Probes are handled by their own decoders. */
3202 gdb_assert_not_reached ("attempt to decode probe location");
3206 gdb_assert_not_reached ("unhandled event location type");
3212 /* See linespec.h. */
3215 decode_line_full (const struct event_location *location, int flags,
3216 struct program_space *search_pspace,
3217 struct symtab *default_symtab,
3218 int default_line, struct linespec_result *canonical,
3219 const char *select_mode,
3222 std::vector<const char *> filters;
3223 struct linespec_state *state;
3225 gdb_assert (canonical != NULL);
3226 /* The filter only makes sense for 'all'. */
3227 gdb_assert (filter == NULL || select_mode == multiple_symbols_all);
3228 gdb_assert (select_mode == NULL
3229 || select_mode == multiple_symbols_all
3230 || select_mode == multiple_symbols_ask
3231 || select_mode == multiple_symbols_cancel);
3232 gdb_assert ((flags & DECODE_LINE_LIST_MODE) == 0);
3234 linespec_parser parser (flags, current_language,
3235 search_pspace, default_symtab,
3236 default_line, canonical);
3238 scoped_restore_current_program_space restore_pspace;
3240 std::vector<symtab_and_line> result = event_location_to_sals (&parser,
3242 state = PARSER_STATE (&parser);
3244 gdb_assert (result.size () == 1 || canonical->pre_expanded);
3245 canonical->pre_expanded = 1;
3247 /* Arrange for allocated canonical names to be freed. */
3248 std::vector<gdb::unique_xmalloc_ptr<char>> hold_names;
3249 for (int i = 0; i < result.size (); ++i)
3251 gdb_assert (state->canonical_names[i].suffix != NULL);
3252 hold_names.emplace_back (state->canonical_names[i].suffix);
3255 if (select_mode == NULL)
3257 if (top_level_interpreter ()->interp_ui_out ()->is_mi_like_p ())
3258 select_mode = multiple_symbols_all;
3260 select_mode = multiple_symbols_select_mode ();
3263 if (select_mode == multiple_symbols_all)
3267 filters.push_back (filter);
3268 filter_results (state, &result, filters);
3271 convert_results_to_lsals (state, &result);
3274 decode_line_2 (state, &result, select_mode);
3277 /* See linespec.h. */
3279 std::vector<symtab_and_line>
3280 decode_line_1 (const struct event_location *location, int flags,
3281 struct program_space *search_pspace,
3282 struct symtab *default_symtab,
3285 linespec_parser parser (flags, current_language,
3286 search_pspace, default_symtab,
3287 default_line, NULL);
3289 scoped_restore_current_program_space restore_pspace;
3291 return event_location_to_sals (&parser, location);
3294 /* See linespec.h. */
3296 std::vector<symtab_and_line>
3297 decode_line_with_current_source (const char *string, int flags)
3300 error (_("Empty line specification."));
3302 /* We use whatever is set as the current source line. We do not try
3303 and get a default source symtab+line or it will recursively call us! */
3304 symtab_and_line cursal = get_current_source_symtab_and_line ();
3306 event_location_up location = string_to_event_location (&string,
3308 std::vector<symtab_and_line> sals
3309 = decode_line_1 (location.get (), flags, NULL, cursal.symtab, cursal.line);
3312 error (_("Junk at end of line specification: %s"), string);
3317 /* See linespec.h. */
3319 std::vector<symtab_and_line>
3320 decode_line_with_last_displayed (const char *string, int flags)
3323 error (_("Empty line specification."));
3325 event_location_up location = string_to_event_location (&string,
3327 std::vector<symtab_and_line> sals
3328 = (last_displayed_sal_is_valid ()
3329 ? decode_line_1 (location.get (), flags, NULL,
3330 get_last_displayed_symtab (),
3331 get_last_displayed_line ())
3332 : decode_line_1 (location.get (), flags, NULL,
3333 (struct symtab *) NULL, 0));
3336 error (_("Junk at end of line specification: %s"), string);
3343 /* First, some functions to initialize stuff at the beggining of the
3347 initialize_defaults (struct symtab **default_symtab, int *default_line)
3349 if (*default_symtab == 0)
3351 /* Use whatever we have for the default source line. We don't use
3352 get_current_or_default_symtab_and_line as it can recurse and call
3354 struct symtab_and_line cursal =
3355 get_current_source_symtab_and_line ();
3357 *default_symtab = cursal.symtab;
3358 *default_line = cursal.line;
3364 /* Evaluate the expression pointed to by EXP_PTR into a CORE_ADDR,
3365 advancing EXP_PTR past any parsed text. */
3368 linespec_expression_to_pc (const char **exp_ptr)
3370 if (current_program_space->executing_startup)
3371 /* The error message doesn't really matter, because this case
3372 should only hit during breakpoint reset. */
3373 throw_error (NOT_FOUND_ERROR, _("cannot evaluate expressions while "
3374 "program space is in startup"));
3377 return value_as_address (parse_to_comma_and_eval (exp_ptr));
3382 /* Here's where we recognise an Objective-C Selector. An Objective C
3383 selector may be implemented by more than one class, therefore it
3384 may represent more than one method/function. This gives us a
3385 situation somewhat analogous to C++ overloading. If there's more
3386 than one method that could represent the selector, then use some of
3387 the existing C++ code to let the user choose one. */
3389 static std::vector<symtab_and_line>
3390 decode_objc (struct linespec_state *self, linespec_p ls, const char *arg)
3392 struct collect_info info;
3393 std::vector<const char *> symbol_names;
3394 const char *new_argptr;
3397 std::vector<symtab *> symtabs;
3398 symtabs.push_back (nullptr);
3400 info.file_symtabs = &symtabs;
3402 std::vector<block_symbol> symbols;
3403 info.result.symbols = &symbols;
3404 std::vector<bound_minimal_symbol> minimal_symbols;
3405 info.result.minimal_symbols = &minimal_symbols;
3407 new_argptr = find_imps (arg, &symbol_names);
3408 if (symbol_names.empty ())
3411 add_all_symbol_names_from_pspace (&info, NULL, symbol_names,
3414 std::vector<symtab_and_line> values;
3415 if (!symbols.empty () || !minimal_symbols.empty ())
3419 saved_arg = (char *) alloca (new_argptr - arg + 1);
3420 memcpy (saved_arg, arg, new_argptr - arg);
3421 saved_arg[new_argptr - arg] = '\0';
3423 ls->explicit_loc.function_name = xstrdup (saved_arg);
3424 ls->function_symbols
3425 = new std::vector<block_symbol> (std::move (symbols));
3427 = new std::vector<bound_minimal_symbol> (std::move (minimal_symbols));
3428 values = convert_linespec_to_sals (self, ls);
3430 if (self->canonical)
3435 self->canonical->pre_expanded = 1;
3437 if (ls->explicit_loc.source_filename)
3439 holder = string_printf ("%s:%s",
3440 ls->explicit_loc.source_filename,
3442 str = holder.c_str ();
3447 self->canonical->location
3448 = new_linespec_location (&str, symbol_name_match_type::FULL);
3457 /* A function object that serves as symbol_found_callback_ftype
3458 callback for iterate_over_symbols. This is used by
3459 lookup_prefix_sym to collect type symbols. */
3460 class decode_compound_collector
3463 decode_compound_collector ()
3465 m_unique_syms = htab_create_alloc (1, htab_hash_pointer,
3466 htab_eq_pointer, NULL,
3470 ~decode_compound_collector ()
3472 if (m_unique_syms != NULL)
3473 htab_delete (m_unique_syms);
3476 /* Return all symbols collected. */
3477 std::vector<block_symbol> release_symbols ()
3479 return std::move (m_symbols);
3482 /* Callable as a symbol_found_callback_ftype callback. */
3483 bool operator () (block_symbol *bsym);
3486 /* A hash table of all symbols we found. We use this to avoid
3487 adding any symbol more than once. */
3488 htab_t m_unique_syms;
3490 /* The result vector. */
3491 std::vector<block_symbol> m_symbols;
3495 decode_compound_collector::operator () (block_symbol *bsym)
3499 struct symbol *sym = bsym->symbol;
3501 if (SYMBOL_CLASS (sym) != LOC_TYPEDEF)
3502 return true; /* Continue iterating. */
3504 t = SYMBOL_TYPE (sym);
3505 t = check_typedef (t);
3506 if (TYPE_CODE (t) != TYPE_CODE_STRUCT
3507 && TYPE_CODE (t) != TYPE_CODE_UNION
3508 && TYPE_CODE (t) != TYPE_CODE_NAMESPACE)
3509 return true; /* Continue iterating. */
3511 slot = htab_find_slot (m_unique_syms, sym, INSERT);
3515 m_symbols.push_back (*bsym);
3518 return true; /* Continue iterating. */
3523 /* Return any symbols corresponding to CLASS_NAME in FILE_SYMTABS. */
3525 static std::vector<block_symbol>
3526 lookup_prefix_sym (struct linespec_state *state,
3527 std::vector<symtab *> *file_symtabs,
3528 const char *class_name)
3530 decode_compound_collector collector;
3532 lookup_name_info lookup_name (class_name, symbol_name_match_type::FULL);
3534 for (const auto &elt : *file_symtabs)
3538 iterate_over_all_matching_symtabs (state, lookup_name,
3539 STRUCT_DOMAIN, ALL_DOMAIN,
3540 NULL, false, collector);
3541 iterate_over_all_matching_symtabs (state, lookup_name,
3542 VAR_DOMAIN, ALL_DOMAIN,
3543 NULL, false, collector);
3547 /* Program spaces that are executing startup should have
3548 been filtered out earlier. */
3549 gdb_assert (!SYMTAB_PSPACE (elt)->executing_startup);
3550 set_current_program_space (SYMTAB_PSPACE (elt));
3551 iterate_over_file_blocks (elt, lookup_name, STRUCT_DOMAIN, collector);
3552 iterate_over_file_blocks (elt, lookup_name, VAR_DOMAIN, collector);
3556 return collector.release_symbols ();
3559 /* A std::sort comparison function for symbols. The resulting order does
3560 not actually matter; we just need to be able to sort them so that
3561 symbols with the same program space end up next to each other. */
3564 compare_symbols (const block_symbol &a, const block_symbol &b)
3568 uia = (uintptr_t) SYMTAB_PSPACE (symbol_symtab (a.symbol));
3569 uib = (uintptr_t) SYMTAB_PSPACE (symbol_symtab (b.symbol));
3576 uia = (uintptr_t) a.symbol;
3577 uib = (uintptr_t) b.symbol;
3585 /* Like compare_symbols but for minimal symbols. */
3588 compare_msymbols (const bound_minimal_symbol &a, const bound_minimal_symbol &b)
3592 uia = (uintptr_t) a.objfile->pspace;
3593 uib = (uintptr_t) a.objfile->pspace;
3600 uia = (uintptr_t) a.minsym;
3601 uib = (uintptr_t) b.minsym;
3609 /* Look for all the matching instances of each symbol in NAMES. Only
3610 instances from PSPACE are considered; other program spaces are
3611 handled by our caller. If PSPACE is NULL, then all program spaces
3612 are considered. Results are stored into INFO. */
3615 add_all_symbol_names_from_pspace (struct collect_info *info,
3616 struct program_space *pspace,
3617 const std::vector<const char *> &names,
3618 enum search_domain search_domain)
3620 for (const char *iter : names)
3621 add_matching_symbols_to_info (iter,
3622 symbol_name_match_type::FULL,
3623 search_domain, info, pspace);
3627 find_superclass_methods (std::vector<struct type *> &&superclasses,
3628 const char *name, enum language name_lang,
3629 std::vector<const char *> *result_names)
3631 size_t old_len = result_names->size ();
3635 std::vector<struct type *> new_supers;
3637 for (type *t : superclasses)
3638 find_methods (t, name_lang, name, result_names, &new_supers);
3640 if (result_names->size () != old_len || new_supers.empty ())
3643 superclasses = std::move (new_supers);
3647 /* This finds the method METHOD_NAME in the class CLASS_NAME whose type is
3648 given by one of the symbols in SYM_CLASSES. Matches are returned
3649 in SYMBOLS (for debug symbols) and MINSYMS (for minimal symbols). */
3652 find_method (struct linespec_state *self, std::vector<symtab *> *file_symtabs,
3653 const char *class_name, const char *method_name,
3654 std::vector<block_symbol> *sym_classes,
3655 std::vector<block_symbol> *symbols,
3656 std::vector<bound_minimal_symbol> *minsyms)
3658 size_t last_result_len;
3659 std::vector<struct type *> superclass_vec;
3660 std::vector<const char *> result_names;
3661 struct collect_info info;
3663 /* Sort symbols so that symbols with the same program space are next
3665 std::sort (sym_classes->begin (), sym_classes->end (),
3669 info.file_symtabs = file_symtabs;
3670 info.result.symbols = symbols;
3671 info.result.minimal_symbols = minsyms;
3673 /* Iterate over all the types, looking for the names of existing
3674 methods matching METHOD_NAME. If we cannot find a direct method in a
3675 given program space, then we consider inherited methods; this is
3676 not ideal (ideal would be to respect C++ hiding rules), but it
3677 seems good enough and is what GDB has historically done. We only
3678 need to collect the names because later we find all symbols with
3679 those names. This loop is written in a somewhat funny way
3680 because we collect data across the program space before deciding
3682 last_result_len = 0;
3683 unsigned int ix = 0;
3684 for (const auto &elt : *sym_classes)
3687 struct program_space *pspace;
3688 struct symbol *sym = elt.symbol;
3690 /* Program spaces that are executing startup should have
3691 been filtered out earlier. */
3692 pspace = SYMTAB_PSPACE (symbol_symtab (sym));
3693 gdb_assert (!pspace->executing_startup);
3694 set_current_program_space (pspace);
3695 t = check_typedef (SYMBOL_TYPE (sym));
3696 find_methods (t, SYMBOL_LANGUAGE (sym),
3697 method_name, &result_names, &superclass_vec);
3699 /* Handle all items from a single program space at once; and be
3700 sure not to miss the last batch. */
3701 if (ix == sym_classes->size () - 1
3703 != SYMTAB_PSPACE (symbol_symtab (sym_classes->at (ix + 1).symbol))))
3705 /* If we did not find a direct implementation anywhere in
3706 this program space, consider superclasses. */
3707 if (result_names.size () == last_result_len)
3708 find_superclass_methods (std::move (superclass_vec), method_name,
3709 SYMBOL_LANGUAGE (sym), &result_names);
3711 /* We have a list of candidate symbol names, so now we
3712 iterate over the symbol tables looking for all
3713 matches in this pspace. */
3714 add_all_symbol_names_from_pspace (&info, pspace, result_names,
3717 superclass_vec.clear ();
3718 last_result_len = result_names.size ();
3723 if (!symbols->empty () || !minsyms->empty ())
3726 /* Throw an NOT_FOUND_ERROR. This will be caught by the caller
3727 and other attempts to locate the symbol will be made. */
3728 throw_error (NOT_FOUND_ERROR, _("see caller, this text doesn't matter"));
3735 /* This function object is a callback for iterate_over_symtabs, used
3736 when collecting all matching symtabs. */
3738 class symtab_collector
3743 m_symtab_table = htab_create (1, htab_hash_pointer, htab_eq_pointer,
3747 ~symtab_collector ()
3749 if (m_symtab_table != NULL)
3750 htab_delete (m_symtab_table);
3753 /* Callable as a symbol_found_callback_ftype callback. */
3754 bool operator () (symtab *sym);
3756 /* Return an rvalue reference to the collected symtabs. */
3757 std::vector<symtab *> &&release_symtabs ()
3759 return std::move (m_symtabs);
3763 /* The result vector of symtabs. */
3764 std::vector<symtab *> m_symtabs;
3766 /* This is used to ensure the symtabs are unique. */
3767 htab_t m_symtab_table;
3771 symtab_collector::operator () (struct symtab *symtab)
3775 slot = htab_find_slot (m_symtab_table, symtab, INSERT);
3779 m_symtabs.push_back (symtab);
3787 /* Given a file name, return a list of all matching symtabs. If
3788 SEARCH_PSPACE is not NULL, the search is restricted to just that
3791 static std::vector<symtab *>
3792 collect_symtabs_from_filename (const char *file,
3793 struct program_space *search_pspace)
3795 symtab_collector collector;
3797 /* Find that file's data. */
3798 if (search_pspace == NULL)
3800 struct program_space *pspace;
3802 ALL_PSPACES (pspace)
3804 if (pspace->executing_startup)
3807 set_current_program_space (pspace);
3808 iterate_over_symtabs (file, collector);
3813 set_current_program_space (search_pspace);
3814 iterate_over_symtabs (file, collector);
3817 return collector.release_symtabs ();
3820 /* Return all the symtabs associated to the FILENAME. If SEARCH_PSPACE is
3821 not NULL, the search is restricted to just that program space. */
3823 static std::vector<symtab *>
3824 symtabs_from_filename (const char *filename,
3825 struct program_space *search_pspace)
3827 std::vector<symtab *> result
3828 = collect_symtabs_from_filename (filename, search_pspace);
3830 if (result.empty ())
3832 if (!have_full_symbols () && !have_partial_symbols ())
3833 throw_error (NOT_FOUND_ERROR,
3834 _("No symbol table is loaded. "
3835 "Use the \"file\" command."));
3836 source_file_not_found_error (filename);
3845 symbol_searcher::find_all_symbols (const std::string &name,
3846 const struct language_defn *language,
3847 enum search_domain search_domain,
3848 std::vector<symtab *> *search_symtabs,
3849 struct program_space *search_pspace)
3851 symbol_searcher_collect_info info;
3852 struct linespec_state state;
3854 memset (&state, 0, sizeof (state));
3855 state.language = language;
3856 info.state = &state;
3858 info.result.symbols = &m_symbols;
3859 info.result.minimal_symbols = &m_minimal_symbols;
3860 std::vector<symtab *> all_symtabs;
3861 if (search_symtabs == nullptr)
3863 all_symtabs.push_back (nullptr);
3864 search_symtabs = &all_symtabs;
3866 info.file_symtabs = search_symtabs;
3868 add_matching_symbols_to_info (name.c_str (), symbol_name_match_type::WILD,
3869 search_domain, &info, search_pspace);
3872 /* Look up a function symbol named NAME in symtabs FILE_SYMTABS. Matching
3873 debug symbols are returned in SYMBOLS. Matching minimal symbols are
3874 returned in MINSYMS. */
3877 find_function_symbols (struct linespec_state *state,
3878 std::vector<symtab *> *file_symtabs, const char *name,
3879 symbol_name_match_type name_match_type,
3880 std::vector<block_symbol> *symbols,
3881 std::vector<bound_minimal_symbol> *minsyms)
3883 struct collect_info info;
3884 std::vector<const char *> symbol_names;
3887 info.result.symbols = symbols;
3888 info.result.minimal_symbols = minsyms;
3889 info.file_symtabs = file_symtabs;
3891 /* Try NAME as an Objective-C selector. */
3892 find_imps (name, &symbol_names);
3893 if (!symbol_names.empty ())
3894 add_all_symbol_names_from_pspace (&info, state->search_pspace,
3895 symbol_names, FUNCTIONS_DOMAIN);
3897 add_matching_symbols_to_info (name, name_match_type, FUNCTIONS_DOMAIN,
3898 &info, state->search_pspace);
3901 /* Find all symbols named NAME in FILE_SYMTABS, returning debug symbols
3902 in SYMBOLS and minimal symbols in MINSYMS. */
3905 find_linespec_symbols (struct linespec_state *state,
3906 std::vector<symtab *> *file_symtabs,
3907 const char *lookup_name,
3908 symbol_name_match_type name_match_type,
3909 std::vector <block_symbol> *symbols,
3910 std::vector<bound_minimal_symbol> *minsyms)
3912 std::string canon = cp_canonicalize_string_no_typedefs (lookup_name);
3913 if (!canon.empty ())
3914 lookup_name = canon.c_str ();
3916 /* It's important to not call expand_symtabs_matching unnecessarily
3917 as it can really slow things down (by unnecessarily expanding
3918 potentially 1000s of symtabs, which when debugging some apps can
3919 cost 100s of seconds). Avoid this to some extent by *first* calling
3920 find_function_symbols, and only if that doesn't find anything
3921 *then* call find_method. This handles two important cases:
3922 1) break (anonymous namespace)::foo
3923 2) break class::method where method is in class (and not a baseclass) */
3925 find_function_symbols (state, file_symtabs, lookup_name,
3926 name_match_type, symbols, minsyms);
3928 /* If we were unable to locate a symbol of the same name, try dividing
3929 the name into class and method names and searching the class and its
3931 if (symbols->empty () && minsyms->empty ())
3933 std::string klass, method;
3934 const char *last, *p, *scope_op;
3936 /* See if we can find a scope operator and break this symbol
3937 name into namespaces${SCOPE_OPERATOR}class_name and method_name. */
3939 p = find_toplevel_string (lookup_name, scope_op);
3945 p = find_toplevel_string (p + strlen (scope_op), scope_op);
3948 /* If no scope operator was found, there is nothing more we can do;
3949 we already attempted to lookup the entire name as a symbol
3954 /* LOOKUP_NAME points to the class name.
3955 LAST points to the method name. */
3956 klass = std::string (lookup_name, last - lookup_name);
3958 /* Skip past the scope operator. */
3959 last += strlen (scope_op);
3962 /* Find a list of classes named KLASS. */
3963 std::vector<block_symbol> classes
3964 = lookup_prefix_sym (state, file_symtabs, klass.c_str ());
3965 if (!classes.empty ())
3967 /* Now locate a list of suitable methods named METHOD. */
3970 find_method (state, file_symtabs,
3971 klass.c_str (), method.c_str (),
3972 &classes, symbols, minsyms);
3975 /* If successful, we're done. If NOT_FOUND_ERROR
3976 was not thrown, rethrow the exception that we did get. */
3977 CATCH (except, RETURN_MASK_ERROR)
3979 if (except.error != NOT_FOUND_ERROR)
3980 throw_exception (except);
3987 /* Helper for find_label_symbols. Find all labels that match name
3988 NAME in BLOCK. Return all labels that match in FUNCTION_SYMBOLS.
3989 Return the actual function symbol in which the label was found in
3990 LABEL_FUNC_RET. If COMPLETION_MODE is true, then NAME is
3991 interpreted as a label name prefix. Otherwise, only a label named
3992 exactly NAME match. */
3995 find_label_symbols_in_block (const struct block *block,
3996 const char *name, struct symbol *fn_sym,
3997 bool completion_mode,
3998 std::vector<block_symbol> *result,
3999 std::vector<block_symbol> *label_funcs_ret)
4001 if (completion_mode)
4003 struct block_iterator iter;
4005 size_t name_len = strlen (name);
4007 int (*cmp) (const char *, const char *, size_t);
4008 cmp = case_sensitivity == case_sensitive_on ? strncmp : strncasecmp;
4010 ALL_BLOCK_SYMBOLS (block, iter, sym)
4012 if (symbol_matches_domain (SYMBOL_LANGUAGE (sym),
4013 SYMBOL_DOMAIN (sym), LABEL_DOMAIN)
4014 && cmp (SYMBOL_SEARCH_NAME (sym), name, name_len) == 0)
4016 result->push_back ({sym, block});
4017 label_funcs_ret->push_back ({fn_sym, block});
4023 struct block_symbol label_sym
4024 = lookup_symbol (name, block, LABEL_DOMAIN, 0);
4026 if (label_sym.symbol != NULL)
4028 result->push_back (label_sym);
4029 label_funcs_ret->push_back ({fn_sym, block});
4034 /* Return all labels that match name NAME in FUNCTION_SYMBOLS or NULL
4035 if no matches were found.
4037 Return the actual function symbol in which the label was found in
4038 LABEL_FUNC_RET. If COMPLETION_MODE is true, then NAME is
4039 interpreted as a label name prefix. Otherwise, only labels named
4040 exactly NAME match. */
4043 static std::vector<block_symbol> *
4044 find_label_symbols (struct linespec_state *self,
4045 std::vector<block_symbol> *function_symbols,
4046 std::vector<block_symbol> *label_funcs_ret,
4048 bool completion_mode)
4050 const struct block *block;
4051 struct symbol *fn_sym;
4052 std::vector<block_symbol> result;
4054 if (function_symbols == NULL)
4056 set_current_program_space (self->program_space);
4057 block = get_current_search_block ();
4060 block && !BLOCK_FUNCTION (block);
4061 block = BLOCK_SUPERBLOCK (block))
4065 fn_sym = BLOCK_FUNCTION (block);
4067 find_label_symbols_in_block (block, name, fn_sym, completion_mode,
4068 &result, label_funcs_ret);
4072 for (const auto &elt : *function_symbols)
4074 fn_sym = elt.symbol;
4075 set_current_program_space (SYMTAB_PSPACE (symbol_symtab (fn_sym)));
4076 block = SYMBOL_BLOCK_VALUE (fn_sym);
4078 find_label_symbols_in_block (block, name, fn_sym, completion_mode,
4079 &result, label_funcs_ret);
4083 if (!result.empty ())
4084 return new std::vector<block_symbol> (std::move (result));
4090 /* A helper for create_sals_line_offset that handles the 'list_mode' case. */
4092 static std::vector<symtab_and_line>
4093 decode_digits_list_mode (struct linespec_state *self,
4095 struct symtab_and_line val)
4097 gdb_assert (self->list_mode);
4099 std::vector<symtab_and_line> values;
4101 for (const auto &elt : *ls->file_symtabs)
4103 /* The logic above should ensure this. */
4104 gdb_assert (elt != NULL);
4106 set_current_program_space (SYMTAB_PSPACE (elt));
4108 /* Simplistic search just for the list command. */
4109 val.symtab = find_line_symtab (elt, val.line, NULL, NULL);
4110 if (val.symtab == NULL)
4112 val.pspace = SYMTAB_PSPACE (elt);
4114 val.explicit_line = 1;
4116 add_sal_to_sals (self, &values, &val, NULL, 0);
4122 /* A helper for create_sals_line_offset that iterates over the symtabs,
4123 adding lines to the VEC. */
4125 static std::vector<symtab_and_line>
4126 decode_digits_ordinary (struct linespec_state *self,
4129 struct linetable_entry **best_entry)
4131 std::vector<symtab_and_line> sals;
4132 for (const auto &elt : *ls->file_symtabs)
4134 std::vector<CORE_ADDR> pcs;
4136 /* The logic above should ensure this. */
4137 gdb_assert (elt != NULL);
4139 set_current_program_space (SYMTAB_PSPACE (elt));
4141 pcs = find_pcs_for_symtab_line (elt, line, best_entry);
4142 for (CORE_ADDR pc : pcs)
4144 symtab_and_line sal;
4145 sal.pspace = SYMTAB_PSPACE (elt);
4149 sals.push_back (std::move (sal));
4158 /* Return the line offset represented by VARIABLE. */
4160 static struct line_offset
4161 linespec_parse_variable (struct linespec_state *self, const char *variable)
4165 struct line_offset offset = {0, LINE_OFFSET_NONE};
4167 p = (variable[1] == '$') ? variable + 2 : variable + 1;
4170 while (*p >= '0' && *p <= '9')
4172 if (!*p) /* Reached end of token without hitting non-digit. */
4174 /* We have a value history reference. */
4175 struct value *val_history;
4177 sscanf ((variable[1] == '$') ? variable + 2 : variable + 1, "%d", &index);
4179 = access_value_history ((variable[1] == '$') ? -index : index);
4180 if (TYPE_CODE (value_type (val_history)) != TYPE_CODE_INT)
4181 error (_("History values used in line "
4182 "specs must have integer values."));
4183 offset.offset = value_as_long (val_history);
4187 /* Not all digits -- may be user variable/function or a
4188 convenience variable. */
4190 struct internalvar *ivar;
4192 /* Try it as a convenience variable. If it is not a convenience
4193 variable, return and allow normal symbol lookup to occur. */
4194 ivar = lookup_only_internalvar (variable + 1);
4196 /* No internal variable with that name. Mark the offset
4197 as unknown to allow the name to be looked up as a symbol. */
4198 offset.sign = LINE_OFFSET_UNKNOWN;
4201 /* We found a valid variable name. If it is not an integer,
4203 if (!get_internalvar_integer (ivar, &valx))
4204 error (_("Convenience variables used in line "
4205 "specs must have integer values."));
4207 offset.offset = valx;
4215 /* We've found a minimal symbol MSYMBOL in OBJFILE to associate with our
4216 linespec; return the SAL in RESULT. This function should return SALs
4217 matching those from find_function_start_sal, otherwise false
4218 multiple-locations breakpoints could be placed. */
4221 minsym_found (struct linespec_state *self, struct objfile *objfile,
4222 struct minimal_symbol *msymbol,
4223 std::vector<symtab_and_line> *result)
4225 bool want_start_sal;
4227 CORE_ADDR func_addr;
4228 bool is_function = msymbol_is_function (objfile, msymbol, &func_addr);
4232 const char *msym_name = MSYMBOL_LINKAGE_NAME (msymbol);
4234 if (MSYMBOL_TYPE (msymbol) == mst_text_gnu_ifunc
4235 || MSYMBOL_TYPE (msymbol) == mst_data_gnu_ifunc)
4236 want_start_sal = gnu_ifunc_resolve_name (msym_name, &func_addr);
4238 want_start_sal = true;
4241 symtab_and_line sal;
4243 if (is_function && want_start_sal)
4244 sal = find_function_start_sal (func_addr, NULL, self->funfirstline);
4247 sal.objfile = objfile;
4248 sal.msymbol = msymbol;
4249 /* Store func_addr, not the minsym's address in case this was an
4250 ifunc that hasn't been resolved yet. */
4254 sal.pc = MSYMBOL_VALUE_ADDRESS (objfile, msymbol);
4255 sal.pspace = current_program_space;
4258 sal.section = MSYMBOL_OBJ_SECTION (objfile, msymbol);
4260 if (maybe_add_address (self->addr_set, objfile->pspace, sal.pc))
4261 add_sal_to_sals (self, result, &sal, MSYMBOL_NATURAL_NAME (msymbol), 0);
4264 /* A helper function to classify a minimal_symbol_type according to
4268 classify_mtype (enum minimal_symbol_type t)
4275 /* Intermediate priority. */
4278 case mst_solib_trampoline:
4279 /* Lowest priority. */
4283 /* Highest priority. */
4288 /* Callback for std::sort that sorts symbols by priority. */
4291 compare_msyms (const bound_minimal_symbol &a, const bound_minimal_symbol &b)
4293 enum minimal_symbol_type ta = MSYMBOL_TYPE (a.minsym);
4294 enum minimal_symbol_type tb = MSYMBOL_TYPE (b.minsym);
4296 return classify_mtype (ta) < classify_mtype (tb);
4299 /* Helper for search_minsyms_for_name that adds the symbol to the
4303 add_minsym (struct minimal_symbol *minsym, struct objfile *objfile,
4304 struct symtab *symtab, int list_mode,
4305 std::vector<struct bound_minimal_symbol> *msyms)
4309 /* We're looking for a label for which we don't have debug
4311 CORE_ADDR func_addr;
4312 if (msymbol_is_function (objfile, minsym, &func_addr))
4314 symtab_and_line sal = find_pc_sect_line (func_addr, NULL, 0);
4316 if (symtab != sal.symtab)
4321 /* Exclude data symbols when looking for breakpoint locations. */
4322 if (!list_mode && !msymbol_is_function (objfile, minsym))
4325 struct bound_minimal_symbol mo = {minsym, objfile};
4326 msyms->push_back (mo);
4330 /* Search for minimal symbols called NAME. If SEARCH_PSPACE
4331 is not NULL, the search is restricted to just that program
4334 If SYMTAB is NULL, search all objfiles, otherwise
4335 restrict results to the given SYMTAB. */
4338 search_minsyms_for_name (struct collect_info *info,
4339 const lookup_name_info &name,
4340 struct program_space *search_pspace,
4341 struct symtab *symtab)
4343 std::vector<struct bound_minimal_symbol> minsyms;
4347 struct program_space *pspace;
4349 ALL_PSPACES (pspace)
4351 if (search_pspace != NULL && search_pspace != pspace)
4353 if (pspace->executing_startup)
4356 set_current_program_space (pspace);
4358 for (objfile *objfile : current_program_space->objfiles ())
4360 iterate_over_minimal_symbols (objfile, name,
4361 [&] (struct minimal_symbol *msym)
4363 add_minsym (msym, objfile, nullptr,
4364 info->state->list_mode,
4373 if (search_pspace == NULL || SYMTAB_PSPACE (symtab) == search_pspace)
4375 set_current_program_space (SYMTAB_PSPACE (symtab));
4376 iterate_over_minimal_symbols
4377 (SYMTAB_OBJFILE (symtab), name,
4378 [&] (struct minimal_symbol *msym)
4380 add_minsym (msym, SYMTAB_OBJFILE (symtab), symtab,
4381 info->state->list_mode, &minsyms);
4387 if (!minsyms.empty ())
4391 std::sort (minsyms.begin (), minsyms.end (), compare_msyms);
4393 /* Now the minsyms are in classification order. So, we walk
4394 over them and process just the minsyms with the same
4395 classification as the very first minsym in the list. */
4396 classification = classify_mtype (MSYMBOL_TYPE (minsyms[0].minsym));
4398 for (const bound_minimal_symbol &item : minsyms)
4400 if (classify_mtype (MSYMBOL_TYPE (item.minsym)) != classification)
4403 info->result.minimal_symbols->push_back (item);
4408 /* A helper function to add all symbols matching NAME to INFO. If
4409 PSPACE is not NULL, the search is restricted to just that program
4413 add_matching_symbols_to_info (const char *name,
4414 symbol_name_match_type name_match_type,
4415 enum search_domain search_domain,
4416 struct collect_info *info,
4417 struct program_space *pspace)
4419 lookup_name_info lookup_name (name, name_match_type);
4421 for (const auto &elt : *info->file_symtabs)
4425 iterate_over_all_matching_symtabs (info->state, lookup_name,
4426 VAR_DOMAIN, search_domain,
4428 [&] (block_symbol *bsym)
4429 { return info->add_symbol (bsym); });
4430 search_minsyms_for_name (info, lookup_name, pspace, NULL);
4432 else if (pspace == NULL || pspace == SYMTAB_PSPACE (elt))
4434 int prev_len = info->result.symbols->size ();
4436 /* Program spaces that are executing startup should have
4437 been filtered out earlier. */
4438 gdb_assert (!SYMTAB_PSPACE (elt)->executing_startup);
4439 set_current_program_space (SYMTAB_PSPACE (elt));
4440 iterate_over_file_blocks (elt, lookup_name, VAR_DOMAIN,
4441 [&] (block_symbol *bsym)
4442 { return info->add_symbol (bsym); });
4444 /* If no new symbols were found in this iteration and this symtab
4445 is in assembler, we might actually be looking for a label for
4446 which we don't have debug info. Check for a minimal symbol in
4448 if (prev_len == info->result.symbols->size ()
4449 && elt->language == language_asm)
4450 search_minsyms_for_name (info, lookup_name, pspace, elt);
4457 /* Now come some functions that are called from multiple places within
4461 symbol_to_sal (struct symtab_and_line *result,
4462 int funfirstline, struct symbol *sym)
4464 if (SYMBOL_CLASS (sym) == LOC_BLOCK)
4466 *result = find_function_start_sal (sym, funfirstline);
4471 if (SYMBOL_CLASS (sym) == LOC_LABEL && SYMBOL_VALUE_ADDRESS (sym) != 0)
4474 result->symtab = symbol_symtab (sym);
4475 result->symbol = sym;
4476 result->line = SYMBOL_LINE (sym);
4477 result->pc = SYMBOL_VALUE_ADDRESS (sym);
4478 result->pspace = SYMTAB_PSPACE (result->symtab);
4479 result->explicit_pc = 1;
4482 else if (funfirstline)
4486 else if (SYMBOL_LINE (sym) != 0)
4488 /* We know its line number. */
4490 result->symtab = symbol_symtab (sym);
4491 result->symbol = sym;
4492 result->line = SYMBOL_LINE (sym);
4493 result->pc = SYMBOL_VALUE_ADDRESS (sym);
4494 result->pspace = SYMTAB_PSPACE (result->symtab);
4502 linespec_result::~linespec_result ()
4504 for (linespec_sals &lsal : lsals)
4505 xfree (lsal.canonical);
4508 /* Return the quote characters permitted by the linespec parser. */
4511 get_gdb_linespec_parser_quote_characters (void)
4513 return linespec_quote_characters;