1 /* Parser for linespec for the GNU debugger, GDB.
3 Copyright (C) 1986-2017 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"
50 /* An enumeration of the various things a user might attempt to
51 complete for a linespec location. */
53 enum class linespec_complete_what
55 /* Nothing, no possible completion. */
58 /* A function/method name. Due to ambiguity between
64 this can also indicate a source filename, iff we haven't seen a
65 separate source filename component, as in "b source.c:function". */
68 /* A label symbol. E.g., break file.c:function:LABEL. */
71 /* An expression. E.g., "break foo if EXPR", or "break *EXPR". */
74 /* A linespec keyword ("if"/"thread"/"task").
75 E.g., "break func threa<tab>". */
79 typedef struct symbol *symbolp;
82 typedef struct type *typep;
85 /* An address entry is used to ensure that any given location is only
86 added to the result a single time. It holds an address and the
87 program space from which the address came. */
91 struct program_space *pspace;
95 typedef struct bound_minimal_symbol bound_minimal_symbol_d;
97 DEF_VEC_O (bound_minimal_symbol_d);
99 /* A linespec. Elements of this structure are filled in by a parser
100 (either parse_linespec or some other function). The structure is
101 then converted into SALs by convert_linespec_to_sals. */
105 /* An explicit location describing the SaLs. */
106 struct explicit_location explicit_loc;
108 /* The list of symtabs to search to which to limit the search. May not
109 be NULL. If explicit.SOURCE_FILENAME is NULL (no user-specified
110 filename), FILE_SYMTABS should contain one single NULL member. This
111 will cause the code to use the default symtab. */
112 VEC (symtab_ptr) *file_symtabs;
114 /* A list of matching function symbols and minimal symbols. Both lists
115 may be NULL if no matching symbols were found. */
116 VEC (symbolp) *function_symbols;
117 VEC (bound_minimal_symbol_d) *minimal_symbols;
119 /* A structure of matching label symbols and the corresponding
120 function symbol in which the label was found. Both may be NULL
121 or both must be non-NULL. */
124 VEC (symbolp) *label_symbols;
125 VEC (symbolp) *function_symbols;
128 typedef struct linespec *linespec_p;
130 /* A canonical linespec represented as a symtab-related string.
132 Each entry represents the "SYMTAB:SUFFIX" linespec string.
133 SYMTAB can be converted for example by symtab_to_fullname or
134 symtab_to_filename_for_display as needed. */
136 struct linespec_canonical_name
138 /* Remaining text part of the linespec string. */
141 /* If NULL then SUFFIX is the whole linespec string. */
142 struct symtab *symtab;
145 /* An instance of this is used to keep all state while linespec
146 operates. This instance is passed around as a 'this' pointer to
147 the various implementation methods. */
149 struct linespec_state
151 /* The language in use during linespec processing. */
152 const struct language_defn *language;
154 /* The program space as seen when the module was entered. */
155 struct program_space *program_space;
157 /* If not NULL, the search is restricted to just this program
159 struct program_space *search_pspace;
161 /* The default symtab to use, if no other symtab is specified. */
162 struct symtab *default_symtab;
164 /* The default line to use. */
167 /* The 'funfirstline' value that was passed in to decode_line_1 or
171 /* Nonzero if we are running in 'list' mode; see decode_line_list. */
174 /* The 'canonical' value passed to decode_line_full, or NULL. */
175 struct linespec_result *canonical;
177 /* Canonical strings that mirror the std::vector<symtab_and_line> result. */
178 struct linespec_canonical_name *canonical_names;
180 /* This is a set of address_entry objects which is used to prevent
181 duplicate symbols from being entered into the result. */
184 /* Are we building a linespec? */
188 /* This is a helper object that is used when collecting symbols into a
193 /* The linespec object in use. */
194 struct linespec_state *state;
196 /* A list of symtabs to which to restrict matches. */
197 VEC (symtab_ptr) *file_symtabs;
199 /* The result being accumulated. */
202 VEC (symbolp) *symbols;
203 VEC (bound_minimal_symbol_d) *minimal_symbols;
206 /* Possibly add a symbol to the results. */
207 bool add_symbol (symbol *sym);
211 collect_info::add_symbol (symbol *sym)
213 /* In list mode, add all matching symbols, regardless of class.
214 This allows the user to type "list a_global_variable". */
215 if (SYMBOL_CLASS (sym) == LOC_BLOCK || this->state->list_mode)
216 VEC_safe_push (symbolp, this->result.symbols, sym);
218 /* Continue iterating. */
229 /* A colon "separator" */
241 /* EOI (end of input) */
247 typedef enum ls_token_type linespec_token_type;
249 /* List of keywords. This is NULL-terminated so that it can be used
250 as enum completer. */
251 const char * const linespec_keywords[] = { "if", "thread", "task", NULL };
252 #define IF_KEYWORD_INDEX 0
254 /* A token of the linespec lexer */
258 /* The type of the token */
259 linespec_token_type type;
261 /* Data for the token */
264 /* A string, given as a stoken */
265 struct stoken string;
271 typedef struct ls_token linespec_token;
273 #define LS_TOKEN_STOKEN(TOK) (TOK).data.string
274 #define LS_TOKEN_KEYWORD(TOK) (TOK).data.keyword
276 /* An instance of the linespec parser. */
280 /* Lexer internal data */
283 /* Save head of input stream. */
284 const char *saved_arg;
286 /* Head of the input stream. */
288 #define PARSER_STREAM(P) ((P)->lexer.stream)
290 /* The current token. */
291 linespec_token current;
294 /* Is the entire linespec quote-enclosed? */
295 int is_quote_enclosed;
297 /* The state of the parse. */
298 struct linespec_state state;
299 #define PARSER_STATE(PPTR) (&(PPTR)->state)
301 /* The result of the parse. */
302 struct linespec result;
303 #define PARSER_RESULT(PPTR) (&(PPTR)->result)
305 /* What the parser believes the current word point should complete
307 linespec_complete_what complete_what;
309 /* The completion word point. The parser advances this as it skips
310 tokens. At some point the input string will end or parsing will
311 fail, and then we attempt completion at the captured completion
312 word point, interpreting the string at completion_word as
314 const char *completion_word;
316 /* If the current token was a quoted string, then this is the
317 quoting character (either " or '). */
318 int completion_quote_char;
320 /* If the current token was a quoted string, then this points at the
321 end of the quoted string. */
322 const char *completion_quote_end;
324 /* If parsing for completion, then this points at the completion
325 tracker. Otherwise, this is NULL. */
326 struct completion_tracker *completion_tracker;
328 typedef struct ls_parser linespec_parser;
330 /* A convenience macro for accessing the explicit location result of
332 #define PARSER_EXPLICIT(PPTR) (&PARSER_RESULT ((PPTR))->explicit_loc)
334 /* Prototypes for local functions. */
336 static void iterate_over_file_blocks
337 (struct symtab *symtab, const lookup_name_info &name,
339 gdb::function_view<symbol_found_callback_ftype> callback);
341 static void initialize_defaults (struct symtab **default_symtab,
344 CORE_ADDR linespec_expression_to_pc (const char **exp_ptr);
346 static std::vector<symtab_and_line> decode_objc (struct linespec_state *self,
350 static VEC (symtab_ptr) *symtabs_from_filename (const char *,
351 struct program_space *pspace);
353 static VEC (symbolp) *find_label_symbols (struct linespec_state *self,
354 VEC (symbolp) *function_symbols,
355 VEC (symbolp) **label_funcs_ret,
357 bool completion_mode = false);
359 static void find_linespec_symbols (struct linespec_state *self,
360 VEC (symtab_ptr) *file_symtabs,
362 symbol_name_match_type name_match_type,
363 VEC (symbolp) **symbols,
364 VEC (bound_minimal_symbol_d) **minsyms);
366 static struct line_offset
367 linespec_parse_variable (struct linespec_state *self,
368 const char *variable);
370 static int symbol_to_sal (struct symtab_and_line *result,
371 int funfirstline, struct symbol *sym);
373 static void add_matching_symbols_to_info (const char *name,
374 symbol_name_match_type name_match_type,
375 enum search_domain search_domain,
376 struct collect_info *info,
377 struct program_space *pspace);
379 static void add_all_symbol_names_from_pspace (struct collect_info *info,
380 struct program_space *pspace,
381 VEC (const_char_ptr) *names,
382 enum search_domain search_domain);
384 static VEC (symtab_ptr) *
385 collect_symtabs_from_filename (const char *file,
386 struct program_space *pspace);
388 static std::vector<symtab_and_line> decode_digits_ordinary
389 (struct linespec_state *self,
392 linetable_entry **best_entry);
394 static std::vector<symtab_and_line> decode_digits_list_mode
395 (struct linespec_state *self,
397 struct symtab_and_line val);
399 static void minsym_found (struct linespec_state *self, struct objfile *objfile,
400 struct minimal_symbol *msymbol,
401 std::vector<symtab_and_line> *result);
403 static int compare_symbols (const void *a, const void *b);
405 static int compare_msymbols (const void *a, const void *b);
407 /* Permitted quote characters for the parser. This is different from the
408 completer's quote characters to allow backward compatibility with the
410 static const char *const linespec_quote_characters = "\"\'";
412 /* Lexer functions. */
414 /* Lex a number from the input in PARSER. This only supports
417 Return true if input is decimal numbers. Return false if not. */
420 linespec_lexer_lex_number (linespec_parser *parser, linespec_token *tokenp)
422 tokenp->type = LSTOKEN_NUMBER;
423 LS_TOKEN_STOKEN (*tokenp).length = 0;
424 LS_TOKEN_STOKEN (*tokenp).ptr = PARSER_STREAM (parser);
426 /* Keep any sign at the start of the stream. */
427 if (*PARSER_STREAM (parser) == '+' || *PARSER_STREAM (parser) == '-')
429 ++LS_TOKEN_STOKEN (*tokenp).length;
430 ++(PARSER_STREAM (parser));
433 while (isdigit (*PARSER_STREAM (parser)))
435 ++LS_TOKEN_STOKEN (*tokenp).length;
436 ++(PARSER_STREAM (parser));
439 /* If the next character in the input buffer is not a space, comma,
440 quote, or colon, this input does not represent a number. */
441 if (*PARSER_STREAM (parser) != '\0'
442 && !isspace (*PARSER_STREAM (parser)) && *PARSER_STREAM (parser) != ','
443 && *PARSER_STREAM (parser) != ':'
444 && !strchr (linespec_quote_characters, *PARSER_STREAM (parser)))
446 PARSER_STREAM (parser) = LS_TOKEN_STOKEN (*tokenp).ptr;
453 /* See linespec.h. */
456 linespec_lexer_lex_keyword (const char *p)
462 for (i = 0; linespec_keywords[i] != NULL; ++i)
464 int len = strlen (linespec_keywords[i]);
466 /* If P begins with one of the keywords and the next
467 character is whitespace, we may have found a keyword.
468 It is only a keyword if it is not followed by another
470 if (strncmp (p, linespec_keywords[i], len) == 0
475 /* Special case: "if" ALWAYS stops the lexer, since it
476 is not possible to predict what is going to appear in
477 the condition, which can only be parsed after SaLs have
479 if (i != IF_KEYWORD_INDEX)
483 for (j = 0; linespec_keywords[j] != NULL; ++j)
485 int nextlen = strlen (linespec_keywords[j]);
487 if (strncmp (p, linespec_keywords[j], nextlen) == 0
488 && isspace (p[nextlen]))
493 return linespec_keywords[i];
501 /* See description in linespec.h. */
504 is_ada_operator (const char *string)
506 const struct ada_opname_map *mapping;
508 for (mapping = ada_opname_table;
509 mapping->encoded != NULL
510 && !startswith (string, mapping->decoded); ++mapping)
513 return mapping->decoded == NULL ? 0 : strlen (mapping->decoded);
516 /* Find QUOTE_CHAR in STRING, accounting for the ':' terminal. Return
517 the location of QUOTE_CHAR, or NULL if not found. */
520 skip_quote_char (const char *string, char quote_char)
522 const char *p, *last;
524 p = last = find_toplevel_char (string, quote_char);
525 while (p && *p != '\0' && *p != ':')
527 p = find_toplevel_char (p, quote_char);
535 /* Make a writable copy of the string given in TOKEN, trimming
536 any trailing whitespace. */
539 copy_token_string (linespec_token token)
543 if (token.type == LSTOKEN_KEYWORD)
544 return xstrdup (LS_TOKEN_KEYWORD (token));
546 str = savestring (LS_TOKEN_STOKEN (token).ptr,
547 LS_TOKEN_STOKEN (token).length);
548 s = remove_trailing_whitespace (str, str + LS_TOKEN_STOKEN (token).length);
554 /* Does P represent the end of a quote-enclosed linespec? */
557 is_closing_quote_enclosed (const char *p)
559 if (strchr (linespec_quote_characters, *p))
561 p = skip_spaces ((char *) p);
562 return (*p == '\0' || linespec_lexer_lex_keyword (p));
565 /* Find the end of the parameter list that starts with *INPUT.
566 This helper function assists with lexing string segments
567 which might contain valid (non-terminating) commas. */
570 find_parameter_list_end (const char *input)
572 char end_char, start_char;
577 if (start_char == '(')
579 else if (start_char == '<')
588 if (*p == start_char)
590 else if (*p == end_char)
604 /* If the [STRING, STRING_LEN) string ends with what looks like a
605 keyword, return the keyword start offset in STRING. Return -1
609 string_find_incomplete_keyword_at_end (const char * const *keywords,
610 const char *string, size_t string_len)
612 const char *end = string + string_len;
615 while (p > string && *p != ' ')
620 size_t len = end - p;
621 for (size_t i = 0; keywords[i] != NULL; ++i)
622 if (strncmp (keywords[i], p, len) == 0)
629 /* Lex a string from the input in PARSER. */
631 static linespec_token
632 linespec_lexer_lex_string (linespec_parser *parser)
634 linespec_token token;
635 const char *start = PARSER_STREAM (parser);
637 token.type = LSTOKEN_STRING;
639 /* If the input stream starts with a quote character, skip to the next
640 quote character, regardless of the content. */
641 if (strchr (linespec_quote_characters, *PARSER_STREAM (parser)))
644 char quote_char = *PARSER_STREAM (parser);
646 /* Special case: Ada operators. */
647 if (PARSER_STATE (parser)->language->la_language == language_ada
648 && quote_char == '\"')
650 int len = is_ada_operator (PARSER_STREAM (parser));
654 /* The input is an Ada operator. Return the quoted string
656 LS_TOKEN_STOKEN (token).ptr = PARSER_STREAM (parser);
657 LS_TOKEN_STOKEN (token).length = len;
658 PARSER_STREAM (parser) += len;
662 /* The input does not represent an Ada operator -- fall through
663 to normal quoted string handling. */
666 /* Skip past the beginning quote. */
667 ++(PARSER_STREAM (parser));
669 /* Mark the start of the string. */
670 LS_TOKEN_STOKEN (token).ptr = PARSER_STREAM (parser);
672 /* Skip to the ending quote. */
673 end = skip_quote_char (PARSER_STREAM (parser), quote_char);
675 /* This helps the completer mode decide whether we have a
677 parser->completion_quote_char = quote_char;
678 parser->completion_quote_end = end;
680 /* Error if the input did not terminate properly, unless in
684 if (parser->completion_tracker == NULL)
685 error (_("unmatched quote"));
687 /* In completion mode, we'll try to complete the incomplete
689 token.type = LSTOKEN_STRING;
690 while (*PARSER_STREAM (parser) != '\0')
691 PARSER_STREAM (parser)++;
692 LS_TOKEN_STOKEN (token).length = PARSER_STREAM (parser) - 1 - start;
696 /* Skip over the ending quote and mark the length of the string. */
697 PARSER_STREAM (parser) = (char *) ++end;
698 LS_TOKEN_STOKEN (token).length = PARSER_STREAM (parser) - 2 - start;
705 /* Otherwise, only identifier characters are permitted.
706 Spaces are the exception. In general, we keep spaces,
707 but only if the next characters in the input do not resolve
708 to one of the keywords.
710 This allows users to forgo quoting CV-qualifiers, template arguments,
711 and similar common language constructs. */
715 if (isspace (*PARSER_STREAM (parser)))
717 p = skip_spaces (PARSER_STREAM (parser));
718 /* When we get here we know we've found something followed by
719 a space (we skip over parens and templates below).
720 So if we find a keyword now, we know it is a keyword and not,
721 say, a function name. */
722 if (linespec_lexer_lex_keyword (p) != NULL)
724 LS_TOKEN_STOKEN (token).ptr = start;
725 LS_TOKEN_STOKEN (token).length
726 = PARSER_STREAM (parser) - start;
730 /* Advance past the whitespace. */
731 PARSER_STREAM (parser) = p;
734 /* If the next character is EOI or (single) ':', the
735 string is complete; return the token. */
736 if (*PARSER_STREAM (parser) == 0)
738 LS_TOKEN_STOKEN (token).ptr = start;
739 LS_TOKEN_STOKEN (token).length = PARSER_STREAM (parser) - start;
742 else if (PARSER_STREAM (parser)[0] == ':')
744 /* Do not tokenize the C++ scope operator. */
745 if (PARSER_STREAM (parser)[1] == ':')
746 ++(PARSER_STREAM (parser));
748 /* Do not tokenify if the input length so far is one
749 (i.e, a single-letter drive name) and the next character
750 is a directory separator. This allows Windows-style
751 paths to be recognized as filenames without quoting it. */
752 else if ((PARSER_STREAM (parser) - start) != 1
753 || !IS_DIR_SEPARATOR (PARSER_STREAM (parser)[1]))
755 LS_TOKEN_STOKEN (token).ptr = start;
756 LS_TOKEN_STOKEN (token).length
757 = PARSER_STREAM (parser) - start;
761 /* Special case: permit quote-enclosed linespecs. */
762 else if (parser->is_quote_enclosed
763 && strchr (linespec_quote_characters,
764 *PARSER_STREAM (parser))
765 && is_closing_quote_enclosed (PARSER_STREAM (parser)))
767 LS_TOKEN_STOKEN (token).ptr = start;
768 LS_TOKEN_STOKEN (token).length = PARSER_STREAM (parser) - start;
771 /* Because commas may terminate a linespec and appear in
772 the middle of valid string input, special cases for
773 '<' and '(' are necessary. */
774 else if (*PARSER_STREAM (parser) == '<'
775 || *PARSER_STREAM (parser) == '(')
777 /* Don't interpret 'operator<' / 'operator<<' as a
778 template parameter list though. */
779 if (*PARSER_STREAM (parser) == '<'
780 && (PARSER_STATE (parser)->language->la_language
782 && (PARSER_STREAM (parser) - start) >= CP_OPERATOR_LEN)
784 const char *p = PARSER_STREAM (parser);
786 while (p > start && isspace (p[-1]))
788 if (p - start >= CP_OPERATOR_LEN)
790 p -= CP_OPERATOR_LEN;
791 if (strncmp (p, CP_OPERATOR_STR, CP_OPERATOR_LEN) == 0
793 || !(isalnum (p[-1]) || p[-1] == '_')))
795 /* This is an operator name. Keep going. */
796 ++(PARSER_STREAM (parser));
797 if (*PARSER_STREAM (parser) == '<')
798 ++(PARSER_STREAM (parser));
804 const char *p = find_parameter_list_end (PARSER_STREAM (parser));
805 PARSER_STREAM (parser) = p;
807 /* Don't loop around to the normal \0 case above because
808 we don't want to misinterpret a potential keyword at
809 the end of the token when the string isn't
810 "()<>"-balanced. This handles "b
811 function(thread<tab>" in completion mode. */
814 LS_TOKEN_STOKEN (token).ptr = start;
815 LS_TOKEN_STOKEN (token).length
816 = PARSER_STREAM (parser) - start;
822 /* Commas are terminators, but not if they are part of an
824 else if (*PARSER_STREAM (parser) == ',')
826 if ((PARSER_STATE (parser)->language->la_language
828 && (PARSER_STREAM (parser) - start) > CP_OPERATOR_LEN)
830 const char *p = strstr (start, CP_OPERATOR_STR);
832 if (p != NULL && is_operator_name (p))
834 /* This is an operator name. Keep going. */
835 ++(PARSER_STREAM (parser));
840 /* Comma terminates the string. */
841 LS_TOKEN_STOKEN (token).ptr = start;
842 LS_TOKEN_STOKEN (token).length = PARSER_STREAM (parser) - start;
846 /* Advance the stream. */
847 ++(PARSER_STREAM (parser));
854 /* Lex a single linespec token from PARSER. */
856 static linespec_token
857 linespec_lexer_lex_one (linespec_parser *parser)
861 if (parser->lexer.current.type == LSTOKEN_CONSUMED)
863 /* Skip any whitespace. */
864 PARSER_STREAM (parser) = skip_spaces (PARSER_STREAM (parser));
866 /* Check for a keyword, they end the linespec. */
867 keyword = linespec_lexer_lex_keyword (PARSER_STREAM (parser));
870 parser->lexer.current.type = LSTOKEN_KEYWORD;
871 LS_TOKEN_KEYWORD (parser->lexer.current) = keyword;
872 /* We do not advance the stream here intentionally:
873 we would like lexing to stop when a keyword is seen.
875 PARSER_STREAM (parser) += strlen (keyword); */
877 return parser->lexer.current;
880 /* Handle other tokens. */
881 switch (*PARSER_STREAM (parser))
884 parser->lexer.current.type = LSTOKEN_EOI;
888 case '0': case '1': case '2': case '3': case '4':
889 case '5': case '6': case '7': case '8': case '9':
890 if (!linespec_lexer_lex_number (parser, &(parser->lexer.current)))
891 parser->lexer.current = linespec_lexer_lex_string (parser);
895 /* If we have a scope operator, lex the input as a string.
896 Otherwise, return LSTOKEN_COLON. */
897 if (PARSER_STREAM (parser)[1] == ':')
898 parser->lexer.current = linespec_lexer_lex_string (parser);
901 parser->lexer.current.type = LSTOKEN_COLON;
902 ++(PARSER_STREAM (parser));
906 case '\'': case '\"':
907 /* Special case: permit quote-enclosed linespecs. */
908 if (parser->is_quote_enclosed
909 && is_closing_quote_enclosed (PARSER_STREAM (parser)))
911 ++(PARSER_STREAM (parser));
912 parser->lexer.current.type = LSTOKEN_EOI;
915 parser->lexer.current = linespec_lexer_lex_string (parser);
919 parser->lexer.current.type = LSTOKEN_COMMA;
920 LS_TOKEN_STOKEN (parser->lexer.current).ptr
921 = PARSER_STREAM (parser);
922 LS_TOKEN_STOKEN (parser->lexer.current).length = 1;
923 ++(PARSER_STREAM (parser));
927 /* If the input is not a number, it must be a string.
928 [Keywords were already considered above.] */
929 parser->lexer.current = linespec_lexer_lex_string (parser);
934 return parser->lexer.current;
937 /* Consume the current token and return the next token in PARSER's
938 input stream. Also advance the completion word for completion
941 static linespec_token
942 linespec_lexer_consume_token (linespec_parser *parser)
944 gdb_assert (parser->lexer.current.type != LSTOKEN_EOI);
946 bool advance_word = (parser->lexer.current.type != LSTOKEN_STRING
947 || *PARSER_STREAM (parser) != '\0');
949 /* If we're moving past a string to some other token, it must be the
950 quote was terminated. */
951 if (parser->completion_quote_char)
953 gdb_assert (parser->lexer.current.type == LSTOKEN_STRING);
955 /* If the string was the last (non-EOI) token, we're past the
956 quote, but remember that for later. */
957 if (*PARSER_STREAM (parser) != '\0')
959 parser->completion_quote_char = '\0';
960 parser->completion_quote_end = NULL;;
964 parser->lexer.current.type = LSTOKEN_CONSUMED;
965 linespec_lexer_lex_one (parser);
967 if (parser->lexer.current.type == LSTOKEN_STRING)
969 /* Advance the completion word past a potential initial
971 parser->completion_word = LS_TOKEN_STOKEN (parser->lexer.current).ptr;
973 else if (advance_word)
975 /* Advance the completion word past any whitespace. */
976 parser->completion_word = PARSER_STREAM (parser);
979 return parser->lexer.current;
982 /* Return the next token without consuming the current token. */
984 static linespec_token
985 linespec_lexer_peek_token (linespec_parser *parser)
988 const char *saved_stream = PARSER_STREAM (parser);
989 linespec_token saved_token = parser->lexer.current;
990 int saved_completion_quote_char = parser->completion_quote_char;
991 const char *saved_completion_quote_end = parser->completion_quote_end;
992 const char *saved_completion_word = parser->completion_word;
994 next = linespec_lexer_consume_token (parser);
995 PARSER_STREAM (parser) = saved_stream;
996 parser->lexer.current = saved_token;
997 parser->completion_quote_char = saved_completion_quote_char;
998 parser->completion_quote_end = saved_completion_quote_end;
999 parser->completion_word = saved_completion_word;
1003 /* Helper functions. */
1005 /* Add SAL to SALS, and also update SELF->CANONICAL_NAMES to reflect
1006 the new sal, if needed. If not NULL, SYMNAME is the name of the
1007 symbol to use when constructing the new canonical name.
1009 If LITERAL_CANONICAL is non-zero, SYMNAME will be used as the
1010 canonical name for the SAL. */
1013 add_sal_to_sals (struct linespec_state *self,
1014 std::vector<symtab_and_line> *sals,
1015 struct symtab_and_line *sal,
1016 const char *symname, int literal_canonical)
1018 sals->push_back (*sal);
1020 if (self->canonical)
1022 struct linespec_canonical_name *canonical;
1024 self->canonical_names = XRESIZEVEC (struct linespec_canonical_name,
1025 self->canonical_names,
1027 canonical = &self->canonical_names[sals->size () - 1];
1028 if (!literal_canonical && sal->symtab)
1030 symtab_to_fullname (sal->symtab);
1032 /* Note that the filter doesn't have to be a valid linespec
1033 input. We only apply the ":LINE" treatment to Ada for
1035 if (symname != NULL && sal->line != 0
1036 && self->language->la_language == language_ada)
1037 canonical->suffix = xstrprintf ("%s:%d", symname, sal->line);
1038 else if (symname != NULL)
1039 canonical->suffix = xstrdup (symname);
1041 canonical->suffix = xstrprintf ("%d", sal->line);
1042 canonical->symtab = sal->symtab;
1046 if (symname != NULL)
1047 canonical->suffix = xstrdup (symname);
1049 canonical->suffix = xstrdup ("<unknown>");
1050 canonical->symtab = NULL;
1055 /* A hash function for address_entry. */
1058 hash_address_entry (const void *p)
1060 const struct address_entry *aep = (const struct address_entry *) p;
1063 hash = iterative_hash_object (aep->pspace, 0);
1064 return iterative_hash_object (aep->addr, hash);
1067 /* An equality function for address_entry. */
1070 eq_address_entry (const void *a, const void *b)
1072 const struct address_entry *aea = (const struct address_entry *) a;
1073 const struct address_entry *aeb = (const struct address_entry *) b;
1075 return aea->pspace == aeb->pspace && aea->addr == aeb->addr;
1078 /* Check whether the address, represented by PSPACE and ADDR, is
1079 already in the set. If so, return 0. Otherwise, add it and return
1083 maybe_add_address (htab_t set, struct program_space *pspace, CORE_ADDR addr)
1085 struct address_entry e, *p;
1090 slot = htab_find_slot (set, &e, INSERT);
1094 p = XNEW (struct address_entry);
1095 memcpy (p, &e, sizeof (struct address_entry));
1101 /* A helper that walks over all matching symtabs in all objfiles and
1102 calls CALLBACK for each symbol matching NAME. If SEARCH_PSPACE is
1103 not NULL, then the search is restricted to just that program
1104 space. If INCLUDE_INLINE is true then symbols representing
1105 inlined instances of functions will be included in the result. */
1108 iterate_over_all_matching_symtabs
1109 (struct linespec_state *state,
1110 const lookup_name_info &lookup_name,
1111 const domain_enum name_domain,
1112 enum search_domain search_domain,
1113 struct program_space *search_pspace, bool include_inline,
1114 gdb::function_view<symbol_found_callback_ftype> callback)
1116 struct objfile *objfile;
1117 struct program_space *pspace;
1119 ALL_PSPACES (pspace)
1121 if (search_pspace != NULL && search_pspace != pspace)
1123 if (pspace->executing_startup)
1126 set_current_program_space (pspace);
1128 ALL_OBJFILES (objfile)
1130 struct compunit_symtab *cu;
1133 objfile->sf->qf->expand_symtabs_matching (objfile,
1139 ALL_OBJFILE_COMPUNITS (objfile, cu)
1141 struct symtab *symtab = COMPUNIT_FILETABS (cu);
1143 iterate_over_file_blocks (symtab, lookup_name, name_domain, callback);
1147 struct block *block;
1150 for (i = FIRST_LOCAL_BLOCK;
1151 i < BLOCKVECTOR_NBLOCKS (SYMTAB_BLOCKVECTOR (symtab));
1154 block = BLOCKVECTOR_BLOCK (SYMTAB_BLOCKVECTOR (symtab), i);
1155 state->language->la_iterate_over_symbols
1156 (block, lookup_name, name_domain, [&] (symbol *sym)
1158 /* Restrict calls to CALLBACK to symbols
1159 representing inline symbols only. */
1160 if (SYMBOL_INLINED (sym))
1161 return callback (sym);
1171 /* Returns the block to be used for symbol searches from
1172 the current location. */
1174 static const struct block *
1175 get_current_search_block (void)
1177 const struct block *block;
1178 enum language save_language;
1180 /* get_selected_block can change the current language when there is
1181 no selected frame yet. */
1182 save_language = current_language->la_language;
1183 block = get_selected_block (0);
1184 set_language (save_language);
1189 /* Iterate over static and global blocks. */
1192 iterate_over_file_blocks
1193 (struct symtab *symtab, const lookup_name_info &name,
1194 domain_enum domain, gdb::function_view<symbol_found_callback_ftype> callback)
1196 struct block *block;
1198 for (block = BLOCKVECTOR_BLOCK (SYMTAB_BLOCKVECTOR (symtab), STATIC_BLOCK);
1200 block = BLOCK_SUPERBLOCK (block))
1201 LA_ITERATE_OVER_SYMBOLS (block, name, domain, callback);
1204 /* A helper for find_method. This finds all methods in type T of
1205 language T_LANG which match NAME. It adds matching symbol names to
1206 RESULT_NAMES, and adds T's direct superclasses to SUPERCLASSES. */
1209 find_methods (struct type *t, enum language t_lang, const char *name,
1210 VEC (const_char_ptr) **result_names,
1211 VEC (typep) **superclasses)
1214 const char *class_name = type_name_no_tag (t);
1216 /* Ignore this class if it doesn't have a name. This is ugly, but
1217 unless we figure out how to get the physname without the name of
1218 the class, then the loop can't do any good. */
1222 lookup_name_info lookup_name (name, symbol_name_match_type::FULL);
1223 symbol_name_matcher_ftype *symbol_name_compare
1224 = language_get_symbol_name_matcher (language_def (t_lang), lookup_name);
1226 t = check_typedef (t);
1228 /* Loop over each method name. At this level, all overloads of a name
1229 are counted as a single name. There is an inner loop which loops over
1232 for (method_counter = TYPE_NFN_FIELDS (t) - 1;
1233 method_counter >= 0;
1236 const char *method_name = TYPE_FN_FIELDLIST_NAME (t, method_counter);
1237 char dem_opname[64];
1239 if (startswith (method_name, "__") ||
1240 startswith (method_name, "op") ||
1241 startswith (method_name, "type"))
1243 if (cplus_demangle_opname (method_name, dem_opname, DMGL_ANSI))
1244 method_name = dem_opname;
1245 else if (cplus_demangle_opname (method_name, dem_opname, 0))
1246 method_name = dem_opname;
1249 if (symbol_name_compare (method_name, lookup_name, NULL))
1253 for (field_counter = (TYPE_FN_FIELDLIST_LENGTH (t, method_counter)
1259 const char *phys_name;
1261 f = TYPE_FN_FIELDLIST1 (t, method_counter);
1262 if (TYPE_FN_FIELD_STUB (f, field_counter))
1264 phys_name = TYPE_FN_FIELD_PHYSNAME (f, field_counter);
1265 VEC_safe_push (const_char_ptr, *result_names, phys_name);
1271 for (ibase = 0; ibase < TYPE_N_BASECLASSES (t); ibase++)
1272 VEC_safe_push (typep, *superclasses, TYPE_BASECLASS (t, ibase));
1275 /* Find an instance of the character C in the string S that is outside
1276 of all parenthesis pairs, single-quoted strings, and double-quoted
1277 strings. Also, ignore the char within a template name, like a ','
1278 within foo<int, int>, while considering C++ operator</operator<<. */
1281 find_toplevel_char (const char *s, char c)
1283 int quoted = 0; /* zero if we're not in quotes;
1284 '"' if we're in a double-quoted string;
1285 '\'' if we're in a single-quoted string. */
1286 int depth = 0; /* Number of unclosed parens we've seen. */
1289 for (scan = s; *scan; scan++)
1293 if (*scan == quoted)
1295 else if (*scan == '\\' && *(scan + 1))
1298 else if (*scan == c && ! quoted && depth == 0)
1300 else if (*scan == '"' || *scan == '\'')
1302 else if (*scan == '(' || *scan == '<')
1304 else if ((*scan == ')' || *scan == '>') && depth > 0)
1306 else if (*scan == 'o' && !quoted && depth == 0)
1308 /* Handle C++ operator names. */
1309 if (strncmp (scan, CP_OPERATOR_STR, CP_OPERATOR_LEN) == 0)
1311 scan += CP_OPERATOR_LEN;
1314 while (isspace (*scan))
1325 /* Skip over one less than the appropriate number of
1326 characters: the for loop will skip over the last
1352 /* The string equivalent of find_toplevel_char. Returns a pointer
1353 to the location of NEEDLE in HAYSTACK, ignoring any occurrences
1354 inside "()" and "<>". Returns NULL if NEEDLE was not found. */
1357 find_toplevel_string (const char *haystack, const char *needle)
1359 const char *s = haystack;
1363 s = find_toplevel_char (s, *needle);
1367 /* Found first char in HAYSTACK; check rest of string. */
1368 if (startswith (s, needle))
1371 /* Didn't find it; loop over HAYSTACK, looking for the next
1372 instance of the first character of NEEDLE. */
1376 while (s != NULL && *s != '\0');
1378 /* NEEDLE was not found in HAYSTACK. */
1382 /* Convert CANONICAL to its string representation using
1383 symtab_to_fullname for SYMTAB. The caller must xfree the result. */
1386 canonical_to_fullform (const struct linespec_canonical_name *canonical)
1388 if (canonical->symtab == NULL)
1389 return xstrdup (canonical->suffix);
1391 return xstrprintf ("%s:%s", symtab_to_fullname (canonical->symtab),
1395 /* Given FILTERS, a list of canonical names, filter the sals in RESULT
1396 and store the result in SELF->CANONICAL. */
1399 filter_results (struct linespec_state *self,
1400 std::vector<symtab_and_line> *result,
1401 VEC (const_char_ptr) *filters)
1406 for (i = 0; VEC_iterate (const_char_ptr, filters, i, name); ++i)
1410 for (size_t j = 0; j < result->size (); ++j)
1412 const struct linespec_canonical_name *canonical;
1414 struct cleanup *cleanup;
1416 canonical = &self->canonical_names[j];
1417 fullform = canonical_to_fullform (canonical);
1418 cleanup = make_cleanup (xfree, fullform);
1420 if (strcmp (name, fullform) == 0)
1421 lsal.sals.push_back ((*result)[j]);
1423 do_cleanups (cleanup);
1426 if (!lsal.sals.empty ())
1428 lsal.canonical = xstrdup (name);
1429 self->canonical->lsals.push_back (std::move (lsal));
1433 self->canonical->pre_expanded = 0;
1436 /* Store RESULT into SELF->CANONICAL. */
1439 convert_results_to_lsals (struct linespec_state *self,
1440 std::vector<symtab_and_line> *result)
1442 struct linespec_sals lsal;
1444 lsal.canonical = NULL;
1445 lsal.sals = std::move (*result);
1446 self->canonical->lsals.push_back (std::move (lsal));
1449 /* A structure that contains two string representations of a struct
1450 linespec_canonical_name:
1451 - one where the the symtab's fullname is used;
1452 - one where the filename followed the "set filename-display"
1455 struct decode_line_2_item
1457 /* The form using symtab_to_fullname.
1458 It must be xfree'ed after use. */
1461 /* The form using symtab_to_filename_for_display.
1462 It must be xfree'ed after use. */
1465 /* Field is initialized to zero and it is set to one if the user
1466 requested breakpoint for this entry. */
1467 unsigned int selected : 1;
1470 /* Helper for qsort to sort decode_line_2_item entries by DISPLAYFORM and
1471 secondarily by FULLFORM. */
1474 decode_line_2_compare_items (const void *ap, const void *bp)
1476 const struct decode_line_2_item *a = (const struct decode_line_2_item *) ap;
1477 const struct decode_line_2_item *b = (const struct decode_line_2_item *) bp;
1480 retval = strcmp (a->displayform, b->displayform);
1484 return strcmp (a->fullform, b->fullform);
1487 /* Handle multiple results in RESULT depending on SELECT_MODE. This
1488 will either return normally, throw an exception on multiple
1489 results, or present a menu to the user. On return, the SALS vector
1490 in SELF->CANONICAL is set up properly. */
1493 decode_line_2 (struct linespec_state *self,
1494 std::vector<symtab_and_line> *result,
1495 const char *select_mode)
1500 struct cleanup *old_chain;
1501 VEC (const_char_ptr) *filters = NULL;
1502 struct decode_line_2_item *items;
1505 gdb_assert (select_mode != multiple_symbols_all);
1506 gdb_assert (self->canonical != NULL);
1507 gdb_assert (!result->empty ());
1509 old_chain = make_cleanup (VEC_cleanup (const_char_ptr), &filters);
1511 /* Prepare ITEMS array. */
1512 items_count = result->size ();
1513 items = XNEWVEC (struct decode_line_2_item, items_count);
1514 make_cleanup (xfree, items);
1515 for (i = 0; i < items_count; ++i)
1517 const struct linespec_canonical_name *canonical;
1518 struct decode_line_2_item *item;
1520 canonical = &self->canonical_names[i];
1521 gdb_assert (canonical->suffix != NULL);
1524 item->fullform = canonical_to_fullform (canonical);
1525 make_cleanup (xfree, item->fullform);
1527 if (canonical->symtab == NULL)
1528 item->displayform = canonical->suffix;
1531 const char *fn_for_display;
1533 fn_for_display = symtab_to_filename_for_display (canonical->symtab);
1534 item->displayform = xstrprintf ("%s:%s", fn_for_display,
1536 make_cleanup (xfree, item->displayform);
1542 /* Sort the list of method names. */
1543 qsort (items, items_count, sizeof (*items), decode_line_2_compare_items);
1545 /* Remove entries with the same FULLFORM. */
1546 if (items_count >= 2)
1548 struct decode_line_2_item *dst, *src;
1551 for (src = &items[1]; src < &items[items_count]; src++)
1552 if (strcmp (src->fullform, dst->fullform) != 0)
1554 items_count = dst + 1 - items;
1557 if (select_mode == multiple_symbols_cancel && items_count > 1)
1558 error (_("canceled because the command is ambiguous\n"
1559 "See set/show multiple-symbol."));
1561 if (select_mode == multiple_symbols_all || items_count == 1)
1563 do_cleanups (old_chain);
1564 convert_results_to_lsals (self, result);
1568 printf_unfiltered (_("[0] cancel\n[1] all\n"));
1569 for (i = 0; i < items_count; i++)
1570 printf_unfiltered ("[%d] %s\n", i + 2, items[i].displayform);
1572 prompt = getenv ("PS2");
1577 args = command_line_input (prompt, 0, "overload-choice");
1579 if (args == 0 || *args == 0)
1580 error_no_arg (_("one or more choice numbers"));
1582 number_or_range_parser parser (args);
1583 while (!parser.finished ())
1585 int num = parser.get_number ();
1588 error (_("canceled"));
1591 /* We intentionally make this result in a single breakpoint,
1592 contrary to what older versions of gdb did. The
1593 rationale is that this lets a user get the
1594 multiple_symbols_all behavior even with the 'ask'
1595 setting; and he can get separate breakpoints by entering
1596 "2-57" at the query. */
1597 do_cleanups (old_chain);
1598 convert_results_to_lsals (self, result);
1603 if (num >= items_count)
1604 printf_unfiltered (_("No choice number %d.\n"), num);
1607 struct decode_line_2_item *item = &items[num];
1609 if (!item->selected)
1611 VEC_safe_push (const_char_ptr, filters, item->fullform);
1616 printf_unfiltered (_("duplicate request for %d ignored.\n"),
1622 filter_results (self, result, filters);
1623 do_cleanups (old_chain);
1628 /* The parser of linespec itself. */
1630 /* Throw an appropriate error when SYMBOL is not found (optionally in
1633 static void ATTRIBUTE_NORETURN
1634 symbol_not_found_error (const char *symbol, const char *filename)
1639 if (!have_full_symbols ()
1640 && !have_partial_symbols ()
1641 && !have_minimal_symbols ())
1642 throw_error (NOT_FOUND_ERROR,
1643 _("No symbol table is loaded. Use the \"file\" command."));
1645 /* If SYMBOL starts with '$', the user attempted to either lookup
1646 a function/variable in his code starting with '$' or an internal
1647 variable of that name. Since we do not know which, be concise and
1648 explain both possibilities. */
1652 throw_error (NOT_FOUND_ERROR,
1653 _("Undefined convenience variable or function \"%s\" "
1654 "not defined in \"%s\"."), symbol, filename);
1656 throw_error (NOT_FOUND_ERROR,
1657 _("Undefined convenience variable or function \"%s\" "
1658 "not defined."), symbol);
1663 throw_error (NOT_FOUND_ERROR,
1664 _("Function \"%s\" not defined in \"%s\"."),
1667 throw_error (NOT_FOUND_ERROR,
1668 _("Function \"%s\" not defined."), symbol);
1672 /* Throw an appropriate error when an unexpected token is encountered
1675 static void ATTRIBUTE_NORETURN
1676 unexpected_linespec_error (linespec_parser *parser)
1678 linespec_token token;
1679 static const char * token_type_strings[]
1680 = {"keyword", "colon", "string", "number", "comma", "end of input"};
1682 /* Get the token that generated the error. */
1683 token = linespec_lexer_lex_one (parser);
1685 /* Finally, throw the error. */
1686 if (token.type == LSTOKEN_STRING || token.type == LSTOKEN_NUMBER
1687 || token.type == LSTOKEN_KEYWORD)
1691 string = copy_token_string (token);
1692 make_cleanup (xfree, string);
1693 throw_error (GENERIC_ERROR,
1694 _("malformed linespec error: unexpected %s, \"%s\""),
1695 token_type_strings[token.type], string);
1698 throw_error (GENERIC_ERROR,
1699 _("malformed linespec error: unexpected %s"),
1700 token_type_strings[token.type]);
1703 /* Throw an undefined label error. */
1705 static void ATTRIBUTE_NORETURN
1706 undefined_label_error (const char *function, const char *label)
1708 if (function != NULL)
1709 throw_error (NOT_FOUND_ERROR,
1710 _("No label \"%s\" defined in function \"%s\"."),
1713 throw_error (NOT_FOUND_ERROR,
1714 _("No label \"%s\" defined in current function."),
1718 /* Throw a source file not found error. */
1720 static void ATTRIBUTE_NORETURN
1721 source_file_not_found_error (const char *name)
1723 throw_error (NOT_FOUND_ERROR, _("No source file named %s."), name);
1726 /* Unless at EIO, save the current stream position as completion word
1727 point, and consume the next token. */
1729 static linespec_token
1730 save_stream_and_consume_token (linespec_parser *parser)
1732 if (linespec_lexer_peek_token (parser).type != LSTOKEN_EOI)
1733 parser->completion_word = PARSER_STREAM (parser);
1734 return linespec_lexer_consume_token (parser);
1737 /* See description in linespec.h. */
1740 linespec_parse_line_offset (const char *string)
1742 const char *start = string;
1743 struct line_offset line_offset = {0, LINE_OFFSET_NONE};
1747 line_offset.sign = LINE_OFFSET_PLUS;
1750 else if (*string == '-')
1752 line_offset.sign = LINE_OFFSET_MINUS;
1756 if (*string != '\0' && !isdigit (*string))
1757 error (_("malformed line offset: \"%s\""), start);
1759 /* Right now, we only allow base 10 for offsets. */
1760 line_offset.offset = atoi (string);
1764 /* In completion mode, if the user is still typing the number, there's
1765 no possible completion to offer. But if there's already input past
1766 the number, setup to expect NEXT. */
1769 set_completion_after_number (linespec_parser *parser,
1770 linespec_complete_what next)
1772 if (*PARSER_STREAM (parser) == ' ')
1774 parser->completion_word = skip_spaces (PARSER_STREAM (parser) + 1);
1775 parser->complete_what = next;
1779 parser->completion_word = PARSER_STREAM (parser);
1780 parser->complete_what = linespec_complete_what::NOTHING;
1784 /* Parse the basic_spec in PARSER's input. */
1787 linespec_parse_basic (linespec_parser *parser)
1790 linespec_token token;
1791 VEC (symbolp) *symbols, *labels;
1792 VEC (bound_minimal_symbol_d) *minimal_symbols;
1793 struct cleanup *cleanup;
1795 /* Get the next token. */
1796 token = linespec_lexer_lex_one (parser);
1798 /* If it is EOI or KEYWORD, issue an error. */
1799 if (token.type == LSTOKEN_KEYWORD)
1801 parser->complete_what = linespec_complete_what::NOTHING;
1802 unexpected_linespec_error (parser);
1804 else if (token.type == LSTOKEN_EOI)
1806 unexpected_linespec_error (parser);
1808 /* If it is a LSTOKEN_NUMBER, we have an offset. */
1809 else if (token.type == LSTOKEN_NUMBER)
1811 set_completion_after_number (parser, linespec_complete_what::KEYWORD);
1813 /* Record the line offset and get the next token. */
1814 name = copy_token_string (token);
1815 cleanup = make_cleanup (xfree, name);
1816 PARSER_EXPLICIT (parser)->line_offset = linespec_parse_line_offset (name);
1817 do_cleanups (cleanup);
1819 /* Get the next token. */
1820 token = linespec_lexer_consume_token (parser);
1822 /* If the next token is a comma, stop parsing and return. */
1823 if (token.type == LSTOKEN_COMMA)
1825 parser->complete_what = linespec_complete_what::NOTHING;
1829 /* If the next token is anything but EOI or KEYWORD, issue
1831 if (token.type != LSTOKEN_KEYWORD && token.type != LSTOKEN_EOI)
1832 unexpected_linespec_error (parser);
1835 if (token.type == LSTOKEN_KEYWORD || token.type == LSTOKEN_EOI)
1838 /* Next token must be LSTOKEN_STRING. */
1839 if (token.type != LSTOKEN_STRING)
1841 parser->complete_what = linespec_complete_what::NOTHING;
1842 unexpected_linespec_error (parser);
1845 /* The current token will contain the name of a function, method,
1847 name = copy_token_string (token);
1848 cleanup = make_cleanup (free_current_contents, &name);
1850 if (parser->completion_tracker != NULL)
1852 /* If the function name ends with a ":", then this may be an
1853 incomplete "::" scope operator instead of a label separator.
1856 which should expand to:
1859 Do a tentative completion assuming the later. If we find
1860 completions, advance the stream past the colon token and make
1861 it part of the function name/token. */
1863 if (!parser->completion_quote_char
1864 && strcmp (PARSER_STREAM (parser), ":") == 0)
1866 completion_tracker tmp_tracker;
1867 const char *source_filename
1868 = PARSER_EXPLICIT (parser)->source_filename;
1869 symbol_name_match_type match_type
1870 = PARSER_EXPLICIT (parser)->func_name_match_type;
1872 linespec_complete_function (tmp_tracker,
1873 parser->completion_word,
1877 if (tmp_tracker.have_completions ())
1879 PARSER_STREAM (parser)++;
1880 LS_TOKEN_STOKEN (token).length++;
1883 name = savestring (parser->completion_word,
1884 (PARSER_STREAM (parser)
1885 - parser->completion_word));
1889 PARSER_EXPLICIT (parser)->function_name = name;
1890 discard_cleanups (cleanup);
1894 /* XXX Reindent before pushing. */
1896 /* Try looking it up as a function/method. */
1897 find_linespec_symbols (PARSER_STATE (parser),
1898 PARSER_RESULT (parser)->file_symtabs, name,
1899 PARSER_EXPLICIT (parser)->func_name_match_type,
1900 &symbols, &minimal_symbols);
1902 if (symbols != NULL || minimal_symbols != NULL)
1904 PARSER_RESULT (parser)->function_symbols = symbols;
1905 PARSER_RESULT (parser)->minimal_symbols = minimal_symbols;
1906 PARSER_EXPLICIT (parser)->function_name = name;
1908 discard_cleanups (cleanup);
1912 /* NAME was not a function or a method. So it must be a label
1913 name or user specified variable like "break foo.c:$zippo". */
1914 labels = find_label_symbols (PARSER_STATE (parser), NULL,
1918 PARSER_RESULT (parser)->labels.label_symbols = labels;
1919 PARSER_RESULT (parser)->labels.function_symbols = symbols;
1920 PARSER_EXPLICIT (parser)->label_name = name;
1922 discard_cleanups (cleanup);
1924 else if (token.type == LSTOKEN_STRING
1925 && *LS_TOKEN_STOKEN (token).ptr == '$')
1927 /* User specified a convenience variable or history value. */
1928 PARSER_EXPLICIT (parser)->line_offset
1929 = linespec_parse_variable (PARSER_STATE (parser), name);
1931 if (PARSER_EXPLICIT (parser)->line_offset.sign == LINE_OFFSET_UNKNOWN)
1933 /* The user-specified variable was not valid. Do not
1934 throw an error here. parse_linespec will do it for us. */
1935 PARSER_EXPLICIT (parser)->function_name = name;
1936 discard_cleanups (cleanup);
1940 /* The convenience variable/history value parsed correctly.
1941 NAME is no longer needed. */
1942 do_cleanups (cleanup);
1946 /* The name is also not a label. Abort parsing. Do not throw
1947 an error here. parse_linespec will do it for us. */
1949 /* Save a copy of the name we were trying to lookup. */
1950 PARSER_EXPLICIT (parser)->function_name = name;
1951 discard_cleanups (cleanup);
1957 int previous_qc = parser->completion_quote_char;
1959 /* Get the next token. */
1960 token = linespec_lexer_consume_token (parser);
1962 if (token.type == LSTOKEN_EOI)
1964 if (previous_qc && !parser->completion_quote_char)
1965 parser->complete_what = linespec_complete_what::KEYWORD;
1967 else if (token.type == LSTOKEN_COLON)
1969 /* User specified a label or a lineno. */
1970 token = linespec_lexer_consume_token (parser);
1972 if (token.type == LSTOKEN_NUMBER)
1974 /* User specified an offset. Record the line offset and
1975 get the next token. */
1976 set_completion_after_number (parser, linespec_complete_what::KEYWORD);
1978 name = copy_token_string (token);
1979 cleanup = make_cleanup (xfree, name);
1980 PARSER_EXPLICIT (parser)->line_offset
1981 = linespec_parse_line_offset (name);
1982 do_cleanups (cleanup);
1984 /* Get the next token. */
1985 token = linespec_lexer_consume_token (parser);
1987 else if (token.type == LSTOKEN_EOI && parser->completion_tracker != NULL)
1989 parser->complete_what = linespec_complete_what::LABEL;
1991 else if (token.type == LSTOKEN_STRING)
1993 parser->complete_what = linespec_complete_what::LABEL;
1995 /* If we have text after the label separated by whitespace
1996 (e.g., "b func():lab i<tab>"), don't consider it part of
1997 the label. In completion mode that should complete to
1998 "if", in normal mode, the 'i' should be treated as
2000 if (parser->completion_quote_char == '\0')
2002 const char *ptr = LS_TOKEN_STOKEN (token).ptr;
2003 for (size_t i = 0; i < LS_TOKEN_STOKEN (token).length; i++)
2007 LS_TOKEN_STOKEN (token).length = i;
2008 PARSER_STREAM (parser) = skip_spaces (ptr + i + 1);
2014 if (parser->completion_tracker != NULL)
2016 if (PARSER_STREAM (parser)[-1] == ' ')
2018 parser->completion_word = PARSER_STREAM (parser);
2019 parser->complete_what = linespec_complete_what::KEYWORD;
2024 /* XXX Reindent before pushing. */
2026 /* Grab a copy of the label's name and look it up. */
2027 name = copy_token_string (token);
2028 cleanup = make_cleanup (xfree, name);
2029 labels = find_label_symbols (PARSER_STATE (parser),
2030 PARSER_RESULT (parser)->function_symbols,
2035 PARSER_RESULT (parser)->labels.label_symbols = labels;
2036 PARSER_RESULT (parser)->labels.function_symbols = symbols;
2037 PARSER_EXPLICIT (parser)->label_name = name;
2039 discard_cleanups (cleanup);
2043 /* We don't know what it was, but it isn't a label. */
2044 undefined_label_error (PARSER_EXPLICIT (parser)->function_name,
2050 /* Check for a line offset. */
2051 token = save_stream_and_consume_token (parser);
2052 if (token.type == LSTOKEN_COLON)
2054 /* Get the next token. */
2055 token = linespec_lexer_consume_token (parser);
2057 /* It must be a line offset. */
2058 if (token.type != LSTOKEN_NUMBER)
2059 unexpected_linespec_error (parser);
2061 /* Record the line offset and get the next token. */
2062 name = copy_token_string (token);
2063 cleanup = make_cleanup (xfree, name);
2065 PARSER_EXPLICIT (parser)->line_offset
2066 = linespec_parse_line_offset (name);
2067 do_cleanups (cleanup);
2069 /* Get the next token. */
2070 token = linespec_lexer_consume_token (parser);
2075 /* Trailing ':' in the input. Issue an error. */
2076 unexpected_linespec_error (parser);
2081 /* Canonicalize the linespec contained in LS. The result is saved into
2082 STATE->canonical. This function handles both linespec and explicit
2086 canonicalize_linespec (struct linespec_state *state, const linespec_p ls)
2088 struct event_location *canon;
2089 struct explicit_location *explicit_loc;
2091 /* If canonicalization was not requested, no need to do anything. */
2092 if (!state->canonical)
2095 /* Save everything as an explicit location. */
2096 state->canonical->location
2097 = new_explicit_location (&ls->explicit_loc);
2098 canon = state->canonical->location.get ();
2099 explicit_loc = get_explicit_location (canon);
2101 if (explicit_loc->label_name != NULL)
2103 state->canonical->special_display = 1;
2105 if (explicit_loc->function_name == NULL)
2109 /* No function was specified, so add the symbol name. */
2110 gdb_assert (ls->labels.function_symbols != NULL
2111 && (VEC_length (symbolp, ls->labels.function_symbols)
2113 s = VEC_index (symbolp, ls->labels.function_symbols, 0);
2114 explicit_loc->function_name = xstrdup (SYMBOL_NATURAL_NAME (s));
2118 /* If this location originally came from a linespec, save a string
2119 representation of it for display and saving to file. */
2120 if (state->is_linespec)
2122 char *linespec = explicit_location_to_linespec (explicit_loc);
2124 set_event_location_string (canon, linespec);
2129 /* Given a line offset in LS, construct the relevant SALs. */
2131 static std::vector<symtab_and_line>
2132 create_sals_line_offset (struct linespec_state *self,
2135 int use_default = 0;
2137 /* This is where we need to make sure we have good defaults.
2138 We must guarantee that this section of code is never executed
2139 when we are called with just a function name, since
2140 set_default_source_symtab_and_line uses
2141 select_source_symtab that calls us with such an argument. */
2143 if (VEC_length (symtab_ptr, ls->file_symtabs) == 1
2144 && VEC_index (symtab_ptr, ls->file_symtabs, 0) == NULL)
2146 const char *fullname;
2148 set_current_program_space (self->program_space);
2150 /* Make sure we have at least a default source line. */
2151 set_default_source_symtab_and_line ();
2152 initialize_defaults (&self->default_symtab, &self->default_line);
2153 fullname = symtab_to_fullname (self->default_symtab);
2154 VEC_pop (symtab_ptr, ls->file_symtabs);
2155 VEC_free (symtab_ptr, ls->file_symtabs);
2156 ls->file_symtabs = collect_symtabs_from_filename (fullname,
2157 self->search_pspace);
2161 symtab_and_line val;
2162 val.line = ls->explicit_loc.line_offset.offset;
2163 switch (ls->explicit_loc.line_offset.sign)
2165 case LINE_OFFSET_PLUS:
2166 if (ls->explicit_loc.line_offset.offset == 0)
2169 val.line = self->default_line + val.line;
2172 case LINE_OFFSET_MINUS:
2173 if (ls->explicit_loc.line_offset.offset == 0)
2176 val.line = self->default_line - val.line;
2178 val.line = -val.line;
2181 case LINE_OFFSET_NONE:
2182 break; /* No need to adjust val.line. */
2185 std::vector<symtab_and_line> values;
2186 if (self->list_mode)
2187 values = decode_digits_list_mode (self, ls, val);
2190 struct linetable_entry *best_entry = NULL;
2193 std::vector<symtab_and_line> intermediate_results
2194 = decode_digits_ordinary (self, ls, val.line, &best_entry);
2195 if (intermediate_results.empty () && best_entry != NULL)
2196 intermediate_results = decode_digits_ordinary (self, ls,
2200 /* For optimized code, the compiler can scatter one source line
2201 across disjoint ranges of PC values, even when no duplicate
2202 functions or inline functions are involved. For example,
2203 'for (;;)' inside a non-template, non-inline, and non-ctor-or-dtor
2204 function can result in two PC ranges. In this case, we don't
2205 want to set a breakpoint on the first PC of each range. To filter
2206 such cases, we use containing blocks -- for each PC found
2207 above, we see if there are other PCs that are in the same
2208 block. If yes, the other PCs are filtered out. */
2210 gdb::def_vector<int> filter (intermediate_results.size ());
2211 gdb::def_vector<const block *> blocks (intermediate_results.size ());
2213 for (i = 0; i < intermediate_results.size (); ++i)
2215 set_current_program_space (intermediate_results[i].pspace);
2218 blocks[i] = block_for_pc_sect (intermediate_results[i].pc,
2219 intermediate_results[i].section);
2222 for (i = 0; i < intermediate_results.size (); ++i)
2224 if (blocks[i] != NULL)
2225 for (j = i + 1; j < intermediate_results.size (); ++j)
2227 if (blocks[j] == blocks[i])
2235 for (i = 0; i < intermediate_results.size (); ++i)
2238 struct symbol *sym = (blocks[i]
2239 ? block_containing_function (blocks[i])
2242 if (self->funfirstline)
2243 skip_prologue_sal (&intermediate_results[i]);
2244 /* Make sure the line matches the request, not what was
2246 intermediate_results[i].line = val.line;
2247 add_sal_to_sals (self, &values, &intermediate_results[i],
2248 sym ? SYMBOL_NATURAL_NAME (sym) : NULL, 0);
2252 if (values.empty ())
2254 if (ls->explicit_loc.source_filename)
2255 throw_error (NOT_FOUND_ERROR, _("No line %d in file \"%s\"."),
2256 val.line, ls->explicit_loc.source_filename);
2258 throw_error (NOT_FOUND_ERROR, _("No line %d in the current file."),
2265 /* Convert the given ADDRESS into SaLs. */
2267 static std::vector<symtab_and_line>
2268 convert_address_location_to_sals (struct linespec_state *self,
2271 symtab_and_line sal = find_pc_line (address, 0);
2273 sal.section = find_pc_overlay (address);
2274 sal.explicit_pc = 1;
2276 std::vector<symtab_and_line> sals;
2277 add_sal_to_sals (self, &sals, &sal, core_addr_to_string (address), 1);
2282 /* Create and return SALs from the linespec LS. */
2284 static std::vector<symtab_and_line>
2285 convert_linespec_to_sals (struct linespec_state *state, linespec_p ls)
2287 std::vector<symtab_and_line> sals;
2289 if (ls->labels.label_symbols != NULL)
2291 /* We have just a bunch of functions/methods or labels. */
2293 struct symtab_and_line sal;
2296 for (i = 0; VEC_iterate (symbolp, ls->labels.label_symbols, i, sym); ++i)
2298 struct program_space *pspace = SYMTAB_PSPACE (symbol_symtab (sym));
2300 if (symbol_to_sal (&sal, state->funfirstline, sym)
2301 && maybe_add_address (state->addr_set, pspace, sal.pc))
2302 add_sal_to_sals (state, &sals, &sal,
2303 SYMBOL_NATURAL_NAME (sym), 0);
2306 else if (ls->function_symbols != NULL || ls->minimal_symbols != NULL)
2308 /* We have just a bunch of functions and/or methods. */
2310 struct symtab_and_line sal;
2312 bound_minimal_symbol_d *elem;
2313 struct program_space *pspace;
2315 if (ls->function_symbols != NULL)
2317 /* Sort symbols so that symbols with the same program space are next
2319 qsort (VEC_address (symbolp, ls->function_symbols),
2320 VEC_length (symbolp, ls->function_symbols),
2321 sizeof (symbolp), compare_symbols);
2323 for (i = 0; VEC_iterate (symbolp, ls->function_symbols, i, sym); ++i)
2325 pspace = SYMTAB_PSPACE (symbol_symtab (sym));
2326 set_current_program_space (pspace);
2327 if (symbol_to_sal (&sal, state->funfirstline, sym)
2328 && maybe_add_address (state->addr_set, pspace, sal.pc))
2329 add_sal_to_sals (state, &sals, &sal,
2330 SYMBOL_NATURAL_NAME (sym), 0);
2334 if (ls->minimal_symbols != NULL)
2336 /* Sort minimal symbols by program space, too. */
2337 qsort (VEC_address (bound_minimal_symbol_d, ls->minimal_symbols),
2338 VEC_length (bound_minimal_symbol_d, ls->minimal_symbols),
2339 sizeof (bound_minimal_symbol_d), compare_msymbols);
2342 VEC_iterate (bound_minimal_symbol_d, ls->minimal_symbols,
2346 pspace = elem->objfile->pspace;
2347 set_current_program_space (pspace);
2348 minsym_found (state, elem->objfile, elem->minsym, &sals);
2352 else if (ls->explicit_loc.line_offset.sign != LINE_OFFSET_UNKNOWN)
2354 /* Only an offset was specified. */
2355 sals = create_sals_line_offset (state, ls);
2357 /* Make sure we have a filename for canonicalization. */
2358 if (ls->explicit_loc.source_filename == NULL)
2360 const char *fullname = symtab_to_fullname (state->default_symtab);
2362 /* It may be more appropriate to keep DEFAULT_SYMTAB in its symtab
2363 form so that displaying SOURCE_FILENAME can follow the current
2364 FILENAME_DISPLAY_STRING setting. But as it is used only rarely
2365 it has been kept for code simplicity only in absolute form. */
2366 ls->explicit_loc.source_filename = xstrdup (fullname);
2371 /* We haven't found any results... */
2375 canonicalize_linespec (state, ls);
2377 if (!sals.empty () && state->canonical != NULL)
2378 state->canonical->pre_expanded = 1;
2383 /* Build RESULT from the explicit location components SOURCE_FILENAME,
2384 FUNCTION_NAME, LABEL_NAME and LINE_OFFSET. */
2387 convert_explicit_location_to_linespec (struct linespec_state *self,
2389 const char *source_filename,
2390 const char *function_name,
2391 symbol_name_match_type fname_match_type,
2392 const char *label_name,
2393 struct line_offset line_offset)
2395 VEC (symbolp) *symbols, *labels;
2396 VEC (bound_minimal_symbol_d) *minimal_symbols;
2398 result->explicit_loc.func_name_match_type = fname_match_type;
2400 if (source_filename != NULL)
2404 result->file_symtabs
2405 = symtabs_from_filename (source_filename, self->search_pspace);
2407 CATCH (except, RETURN_MASK_ERROR)
2409 source_file_not_found_error (source_filename);
2412 result->explicit_loc.source_filename = xstrdup (source_filename);
2416 /* A NULL entry means to use the default symtab. */
2417 VEC_safe_push (symtab_ptr, result->file_symtabs, NULL);
2420 if (function_name != NULL)
2422 find_linespec_symbols (self, result->file_symtabs,
2423 function_name, fname_match_type,
2424 &symbols, &minimal_symbols);
2426 if (symbols == NULL && minimal_symbols == NULL)
2427 symbol_not_found_error (function_name,
2428 result->explicit_loc.source_filename);
2430 result->explicit_loc.function_name = xstrdup (function_name);
2431 result->function_symbols = symbols;
2432 result->minimal_symbols = minimal_symbols;
2435 if (label_name != NULL)
2438 labels = find_label_symbols (self, result->function_symbols,
2439 &symbols, label_name);
2442 undefined_label_error (result->explicit_loc.function_name,
2445 result->explicit_loc.label_name = xstrdup (label_name);
2446 result->labels.label_symbols = labels;
2447 result->labels.function_symbols = symbols;
2450 if (line_offset.sign != LINE_OFFSET_UNKNOWN)
2451 result->explicit_loc.line_offset = line_offset;
2454 /* Convert the explicit location EXPLICIT_LOC into SaLs. */
2456 static std::vector<symtab_and_line>
2457 convert_explicit_location_to_sals (struct linespec_state *self,
2459 const struct explicit_location *explicit_loc)
2461 convert_explicit_location_to_linespec (self, result,
2462 explicit_loc->source_filename,
2463 explicit_loc->function_name,
2464 explicit_loc->func_name_match_type,
2465 explicit_loc->label_name,
2466 explicit_loc->line_offset);
2467 return convert_linespec_to_sals (self, result);
2470 /* Parse a string that specifies a linespec.
2472 The basic grammar of linespecs:
2474 linespec -> var_spec | basic_spec
2475 var_spec -> '$' (STRING | NUMBER)
2477 basic_spec -> file_offset_spec | function_spec | label_spec
2478 file_offset_spec -> opt_file_spec offset_spec
2479 function_spec -> opt_file_spec function_name_spec opt_label_spec
2480 label_spec -> label_name_spec
2482 opt_file_spec -> "" | file_name_spec ':'
2483 opt_label_spec -> "" | ':' label_name_spec
2485 file_name_spec -> STRING
2486 function_name_spec -> STRING
2487 label_name_spec -> STRING
2488 function_name_spec -> STRING
2489 offset_spec -> NUMBER
2493 This may all be followed by several keywords such as "if EXPR",
2496 A comma will terminate parsing.
2498 The function may be an undebuggable function found in minimal symbol table.
2500 If the argument FUNFIRSTLINE is nonzero, we want the first line
2501 of real code inside a function when a function is specified, and it is
2502 not OK to specify a variable or type to get its line number.
2504 DEFAULT_SYMTAB specifies the file to use if none is specified.
2505 It defaults to current_source_symtab.
2506 DEFAULT_LINE specifies the line number to use for relative
2507 line numbers (that start with signs). Defaults to current_source_line.
2508 If CANONICAL is non-NULL, store an array of strings containing the canonical
2509 line specs there if necessary. Currently overloaded member functions and
2510 line numbers or static functions without a filename yield a canonical
2511 line spec. The array and the line spec strings are allocated on the heap,
2512 it is the callers responsibility to free them.
2514 Note that it is possible to return zero for the symtab
2515 if no file is validly specified. Callers must check that.
2516 Also, the line number returned may be invalid. */
2518 /* Parse the linespec in ARG. MATCH_TYPE indicates how function names
2519 should be matched. */
2521 static std::vector<symtab_and_line>
2522 parse_linespec (linespec_parser *parser, const char *arg,
2523 symbol_name_match_type match_type)
2525 linespec_token token;
2526 struct gdb_exception file_exception = exception_none;
2527 struct cleanup *cleanup;
2529 /* A special case to start. It has become quite popular for
2530 IDEs to work around bugs in the previous parser by quoting
2531 the entire linespec, so we attempt to deal with this nicely. */
2532 parser->is_quote_enclosed = 0;
2533 if (parser->completion_tracker == NULL
2534 && !is_ada_operator (arg)
2535 && strchr (linespec_quote_characters, *arg) != NULL)
2539 end = skip_quote_char (arg + 1, *arg);
2540 if (end != NULL && is_closing_quote_enclosed (end))
2542 /* Here's the special case. Skip ARG past the initial
2545 parser->is_quote_enclosed = 1;
2549 parser->lexer.saved_arg = arg;
2550 parser->lexer.stream = arg;
2551 parser->completion_word = arg;
2552 parser->complete_what = linespec_complete_what::FUNCTION;
2553 PARSER_EXPLICIT (parser)->func_name_match_type = match_type;
2555 /* Initialize the default symtab and line offset. */
2556 initialize_defaults (&PARSER_STATE (parser)->default_symtab,
2557 &PARSER_STATE (parser)->default_line);
2559 /* Objective-C shortcut. */
2560 if (parser->completion_tracker == NULL)
2562 std::vector<symtab_and_line> values
2563 = decode_objc (PARSER_STATE (parser), PARSER_RESULT (parser), arg);
2564 if (!values.empty ())
2569 /* "-"/"+" is either an objc selector, or a number. There's
2570 nothing to complete the latter to, so just let the caller
2571 complete on functions, which finds objc selectors, if there's
2573 if ((arg[0] == '-' || arg[0] == '+') && arg[1] == '\0')
2577 /* Start parsing. */
2579 /* Get the first token. */
2580 token = linespec_lexer_consume_token (parser);
2582 /* It must be either LSTOKEN_STRING or LSTOKEN_NUMBER. */
2583 if (token.type == LSTOKEN_STRING && *LS_TOKEN_STOKEN (token).ptr == '$')
2587 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2588 if (parser->completion_tracker == NULL)
2589 VEC_safe_push (symtab_ptr, PARSER_RESULT (parser)->file_symtabs, NULL);
2591 /* User specified a convenience variable or history value. */
2592 var = copy_token_string (token);
2593 cleanup = make_cleanup (xfree, var);
2594 PARSER_EXPLICIT (parser)->line_offset
2595 = linespec_parse_variable (PARSER_STATE (parser), var);
2596 do_cleanups (cleanup);
2598 /* If a line_offset wasn't found (VAR is the name of a user
2599 variable/function), then skip to normal symbol processing. */
2600 if (PARSER_EXPLICIT (parser)->line_offset.sign != LINE_OFFSET_UNKNOWN)
2602 /* Consume this token. */
2603 linespec_lexer_consume_token (parser);
2605 goto convert_to_sals;
2608 else if (token.type == LSTOKEN_EOI && parser->completion_tracker != NULL)
2610 /* Let the default linespec_complete_what::FUNCTION kick in. */
2611 unexpected_linespec_error (parser);
2613 else if (token.type != LSTOKEN_STRING && token.type != LSTOKEN_NUMBER)
2615 parser->complete_what = linespec_complete_what::NOTHING;
2616 unexpected_linespec_error (parser);
2619 /* Shortcut: If the next token is not LSTOKEN_COLON, we know that
2620 this token cannot represent a filename. */
2621 token = linespec_lexer_peek_token (parser);
2623 if (token.type == LSTOKEN_COLON)
2625 char *user_filename;
2627 /* Get the current token again and extract the filename. */
2628 token = linespec_lexer_lex_one (parser);
2629 user_filename = copy_token_string (token);
2631 /* Check if the input is a filename. */
2634 PARSER_RESULT (parser)->file_symtabs
2635 = symtabs_from_filename (user_filename,
2636 PARSER_STATE (parser)->search_pspace);
2638 CATCH (ex, RETURN_MASK_ERROR)
2640 file_exception = ex;
2644 if (file_exception.reason >= 0)
2646 /* Symtabs were found for the file. Record the filename. */
2647 PARSER_EXPLICIT (parser)->source_filename = user_filename;
2649 /* Get the next token. */
2650 token = linespec_lexer_consume_token (parser);
2652 /* This is LSTOKEN_COLON; consume it. */
2653 linespec_lexer_consume_token (parser);
2657 /* No symtabs found -- discard user_filename. */
2658 xfree (user_filename);
2660 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2661 VEC_safe_push (symtab_ptr, PARSER_RESULT (parser)->file_symtabs, NULL);
2664 /* If the next token is not EOI, KEYWORD, or COMMA, issue an error. */
2665 else if (parser->completion_tracker == NULL
2666 && (token.type != LSTOKEN_EOI && token.type != LSTOKEN_KEYWORD
2667 && token.type != LSTOKEN_COMMA))
2669 /* TOKEN is the _next_ token, not the one currently in the parser.
2670 Consuming the token will give the correct error message. */
2671 linespec_lexer_consume_token (parser);
2672 unexpected_linespec_error (parser);
2676 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2677 VEC_safe_push (symtab_ptr, PARSER_RESULT (parser)->file_symtabs, NULL);
2680 /* Parse the rest of the linespec. */
2681 linespec_parse_basic (parser);
2683 if (parser->completion_tracker == NULL
2684 && PARSER_RESULT (parser)->function_symbols == NULL
2685 && PARSER_RESULT (parser)->labels.label_symbols == NULL
2686 && PARSER_EXPLICIT (parser)->line_offset.sign == LINE_OFFSET_UNKNOWN
2687 && PARSER_RESULT (parser)->minimal_symbols == NULL)
2689 /* The linespec didn't parse. Re-throw the file exception if
2691 if (file_exception.reason < 0)
2692 throw_exception (file_exception);
2694 /* Otherwise, the symbol is not found. */
2695 symbol_not_found_error (PARSER_EXPLICIT (parser)->function_name,
2696 PARSER_EXPLICIT (parser)->source_filename);
2701 /* Get the last token and record how much of the input was parsed,
2703 token = linespec_lexer_lex_one (parser);
2704 if (token.type != LSTOKEN_EOI && token.type != LSTOKEN_KEYWORD)
2705 unexpected_linespec_error (parser);
2706 else if (token.type == LSTOKEN_KEYWORD)
2708 /* Setup the completion word past the keyword. Lexing never
2709 advances past a keyword automatically, so skip it
2711 parser->completion_word
2712 = skip_spaces (skip_to_space (PARSER_STREAM (parser)));
2713 parser->complete_what = linespec_complete_what::EXPRESSION;
2716 /* Convert the data in PARSER_RESULT to SALs. */
2717 if (parser->completion_tracker == NULL)
2718 return convert_linespec_to_sals (PARSER_STATE (parser),
2719 PARSER_RESULT (parser));
2725 /* A constructor for linespec_state. */
2728 linespec_state_constructor (struct linespec_state *self,
2729 int flags, const struct language_defn *language,
2730 struct program_space *search_pspace,
2731 struct symtab *default_symtab,
2733 struct linespec_result *canonical)
2735 memset (self, 0, sizeof (*self));
2736 self->language = language;
2737 self->funfirstline = (flags & DECODE_LINE_FUNFIRSTLINE) ? 1 : 0;
2738 self->list_mode = (flags & DECODE_LINE_LIST_MODE) ? 1 : 0;
2739 self->search_pspace = search_pspace;
2740 self->default_symtab = default_symtab;
2741 self->default_line = default_line;
2742 self->canonical = canonical;
2743 self->program_space = current_program_space;
2744 self->addr_set = htab_create_alloc (10, hash_address_entry, eq_address_entry,
2745 xfree, xcalloc, xfree);
2746 self->is_linespec = 0;
2749 /* Initialize a new linespec parser. */
2752 linespec_parser_new (linespec_parser *parser,
2753 int flags, const struct language_defn *language,
2754 struct program_space *search_pspace,
2755 struct symtab *default_symtab,
2757 struct linespec_result *canonical)
2759 memset (parser, 0, sizeof (linespec_parser));
2760 parser->lexer.current.type = LSTOKEN_CONSUMED;
2761 memset (PARSER_RESULT (parser), 0, sizeof (struct linespec));
2762 PARSER_EXPLICIT (parser)->func_name_match_type
2763 = symbol_name_match_type::WILD;
2764 PARSER_EXPLICIT (parser)->line_offset.sign = LINE_OFFSET_UNKNOWN;
2765 linespec_state_constructor (PARSER_STATE (parser), flags, language,
2767 default_symtab, default_line, canonical);
2770 /* A destructor for linespec_state. */
2773 linespec_state_destructor (struct linespec_state *self)
2775 htab_delete (self->addr_set);
2778 /* Delete a linespec parser. */
2781 linespec_parser_delete (void *arg)
2783 linespec_parser *parser = (linespec_parser *) arg;
2785 xfree (PARSER_EXPLICIT (parser)->source_filename);
2786 xfree (PARSER_EXPLICIT (parser)->label_name);
2787 xfree (PARSER_EXPLICIT (parser)->function_name);
2789 if (PARSER_RESULT (parser)->file_symtabs != NULL)
2790 VEC_free (symtab_ptr, PARSER_RESULT (parser)->file_symtabs);
2792 if (PARSER_RESULT (parser)->function_symbols != NULL)
2793 VEC_free (symbolp, PARSER_RESULT (parser)->function_symbols);
2795 if (PARSER_RESULT (parser)->minimal_symbols != NULL)
2796 VEC_free (bound_minimal_symbol_d, PARSER_RESULT (parser)->minimal_symbols);
2798 if (PARSER_RESULT (parser)->labels.label_symbols != NULL)
2799 VEC_free (symbolp, PARSER_RESULT (parser)->labels.label_symbols);
2801 if (PARSER_RESULT (parser)->labels.function_symbols != NULL)
2802 VEC_free (symbolp, PARSER_RESULT (parser)->labels.function_symbols);
2804 linespec_state_destructor (PARSER_STATE (parser));
2807 /* See description in linespec.h. */
2810 linespec_lex_to_end (const char **stringp)
2812 linespec_parser parser;
2813 struct cleanup *cleanup;
2814 linespec_token token;
2817 if (stringp == NULL || *stringp == NULL)
2820 linespec_parser_new (&parser, 0, current_language, NULL, NULL, 0, NULL);
2821 cleanup = make_cleanup (linespec_parser_delete, &parser);
2822 parser.lexer.saved_arg = *stringp;
2823 PARSER_STREAM (&parser) = orig = *stringp;
2827 /* Stop before any comma tokens; we need it to keep it
2828 as the next token in the string. */
2829 token = linespec_lexer_peek_token (&parser);
2830 if (token.type == LSTOKEN_COMMA)
2832 token = linespec_lexer_consume_token (&parser);
2834 while (token.type != LSTOKEN_EOI && token.type != LSTOKEN_KEYWORD);
2836 *stringp += PARSER_STREAM (&parser) - orig;
2837 do_cleanups (cleanup);
2840 /* See linespec.h. */
2843 linespec_complete_function (completion_tracker &tracker,
2844 const char *function,
2845 symbol_name_match_type func_match_type,
2846 const char *source_filename)
2848 complete_symbol_mode mode = complete_symbol_mode::LINESPEC;
2850 if (source_filename != NULL)
2852 collect_file_symbol_completion_matches (tracker, mode, func_match_type,
2853 function, function, source_filename);
2857 collect_symbol_completion_matches (tracker, mode, func_match_type,
2858 function, function);
2863 /* Helper for complete_linespec to simplify it. SOURCE_FILENAME is
2864 only meaningful if COMPONENT is FUNCTION. */
2867 complete_linespec_component (linespec_parser *parser,
2868 completion_tracker &tracker,
2870 linespec_complete_what component,
2871 const char *source_filename)
2873 if (component == linespec_complete_what::KEYWORD)
2875 complete_on_enum (tracker, linespec_keywords, text, text);
2877 else if (component == linespec_complete_what::EXPRESSION)
2880 = advance_to_expression_complete_word_point (tracker, text);
2881 complete_expression (tracker, text, word);
2883 else if (component == linespec_complete_what::FUNCTION)
2885 completion_list fn_list;
2887 symbol_name_match_type match_type
2888 = PARSER_EXPLICIT (parser)->func_name_match_type;
2889 linespec_complete_function (tracker, text, match_type, source_filename);
2890 if (source_filename == NULL)
2892 /* Haven't seen a source component, like in "b
2893 file.c:function[TAB]". Maybe this wasn't a function, but
2894 a filename instead, like "b file.[TAB]". */
2895 fn_list = complete_source_filenames (text);
2898 /* If we only have a single filename completion, append a ':' for
2899 the user, since that's the only thing that can usefully follow
2901 if (fn_list.size () == 1 && !tracker.have_completions ())
2903 char *fn = fn_list[0].release ();
2905 /* If we also need to append a quote char, it needs to be
2906 appended before the ':'. Append it now, and make ':' the
2907 new "quote" char. */
2908 if (tracker.quote_char ())
2910 char quote_char_str[2] = { tracker.quote_char () };
2912 fn = reconcat (fn, fn, quote_char_str, (char *) NULL);
2913 tracker.set_quote_char (':');
2916 fn = reconcat (fn, fn, ":", (char *) NULL);
2917 fn_list[0].reset (fn);
2919 /* Tell readline to skip appending a space. */
2920 tracker.set_suppress_append_ws (true);
2922 tracker.add_completions (std::move (fn_list));
2926 /* Helper for linespec_complete_label. Find labels that match
2927 LABEL_NAME in the function symbols listed in the PARSER, and add
2928 them to the tracker. */
2931 complete_label (completion_tracker &tracker,
2932 linespec_parser *parser,
2933 const char *label_name)
2935 VEC (symbolp) *label_function_symbols = NULL;
2936 VEC (symbolp) *labels
2937 = find_label_symbols (PARSER_STATE (parser),
2938 PARSER_RESULT (parser)->function_symbols,
2939 &label_function_symbols,
2944 VEC_iterate (symbolp, labels, ix, label); ++ix)
2946 char *match = xstrdup (SYMBOL_SEARCH_NAME (label));
2947 tracker.add_completion (gdb::unique_xmalloc_ptr<char> (match));
2949 VEC_free (symbolp, labels);
2952 /* See linespec.h. */
2955 linespec_complete_label (completion_tracker &tracker,
2956 const struct language_defn *language,
2957 const char *source_filename,
2958 const char *function_name,
2959 symbol_name_match_type func_name_match_type,
2960 const char *label_name)
2962 linespec_parser parser;
2963 struct cleanup *cleanup;
2965 linespec_parser_new (&parser, 0, language, NULL, NULL, 0, NULL);
2966 cleanup = make_cleanup (linespec_parser_delete, &parser);
2968 line_offset unknown_offset = { 0, LINE_OFFSET_UNKNOWN };
2972 convert_explicit_location_to_linespec (PARSER_STATE (&parser),
2973 PARSER_RESULT (&parser),
2976 func_name_match_type,
2977 NULL, unknown_offset);
2979 CATCH (ex, RETURN_MASK_ERROR)
2981 do_cleanups (cleanup);
2986 complete_label (tracker, &parser, label_name);
2988 do_cleanups (cleanup);
2991 /* See description in linespec.h. */
2994 linespec_complete (completion_tracker &tracker, const char *text,
2995 symbol_name_match_type match_type)
2997 linespec_parser parser;
2998 struct cleanup *cleanup;
2999 const char *orig = text;
3001 linespec_parser_new (&parser, 0, current_language, NULL, NULL, 0, NULL);
3002 cleanup = make_cleanup (linespec_parser_delete, &parser);
3003 parser.lexer.saved_arg = text;
3004 PARSER_EXPLICIT (&parser)->func_name_match_type = match_type;
3005 PARSER_STREAM (&parser) = text;
3007 parser.completion_tracker = &tracker;
3008 PARSER_STATE (&parser)->is_linespec = 1;
3010 /* Parse as much as possible. parser.completion_word will hold
3011 furthest completion point we managed to parse to. */
3014 parse_linespec (&parser, text, match_type);
3016 CATCH (except, RETURN_MASK_ERROR)
3021 if (parser.completion_quote_char != '\0'
3022 && parser.completion_quote_end != NULL
3023 && parser.completion_quote_end[1] == '\0')
3025 /* If completing a quoted string with the cursor right at
3026 terminating quote char, complete the completion word without
3027 interpretation, so that readline advances the cursor one
3028 whitespace past the quote, even if there's no match. This
3029 makes these cases behave the same:
3031 before: "b function()"
3032 after: "b function() "
3034 before: "b 'function()'"
3035 after: "b 'function()' "
3037 and trusts the user in this case:
3039 before: "b 'not_loaded_function_yet()'"
3040 after: "b 'not_loaded_function_yet()' "
3042 parser.complete_what = linespec_complete_what::NOTHING;
3043 parser.completion_quote_char = '\0';
3045 gdb::unique_xmalloc_ptr<char> text_copy
3046 (xstrdup (parser.completion_word));
3047 tracker.add_completion (std::move (text_copy));
3050 tracker.set_quote_char (parser.completion_quote_char);
3052 if (parser.complete_what == linespec_complete_what::LABEL)
3054 parser.complete_what = linespec_complete_what::NOTHING;
3056 const char *func_name = PARSER_EXPLICIT (&parser)->function_name;
3058 VEC (symbolp) *function_symbols;
3059 VEC (bound_minimal_symbol_d) *minimal_symbols;
3060 find_linespec_symbols (PARSER_STATE (&parser),
3061 PARSER_RESULT (&parser)->file_symtabs,
3062 func_name, match_type,
3063 &function_symbols, &minimal_symbols);
3065 PARSER_RESULT (&parser)->function_symbols = function_symbols;
3066 PARSER_RESULT (&parser)->minimal_symbols = minimal_symbols;
3068 complete_label (tracker, &parser, parser.completion_word);
3070 else if (parser.complete_what == linespec_complete_what::FUNCTION)
3072 /* While parsing/lexing, we didn't know whether the completion
3073 word completes to a unique function/source name already or
3077 "b function() <tab>"
3078 may need to complete either to:
3079 "b function() const"
3081 "b function() if/thread/task"
3085 may need to complete either to:
3086 "b foo template_fun<T>()"
3087 with "foo" being the template function's return type, or to:
3092 may need to complete either to a source file name:
3094 or this, also a filename, but a unique completion:
3096 or to a function name:
3099 Address that by completing assuming source or function, and
3100 seeing if we find a completion that matches exactly the
3101 completion word. If so, then it must be a function (see note
3102 below) and we advance the completion word to the end of input
3103 and switch to KEYWORD completion mode.
3105 Note: if we find a unique completion for a source filename,
3106 then it won't match the completion word, because the LCD will
3107 contain a trailing ':'. And if we're completing at or after
3108 the ':', then complete_linespec_component won't try to
3109 complete on source filenames. */
3111 const char *text = parser.completion_word;
3112 const char *word = parser.completion_word;
3114 complete_linespec_component (&parser, tracker,
3115 parser.completion_word,
3116 linespec_complete_what::FUNCTION,
3117 PARSER_EXPLICIT (&parser)->source_filename);
3119 parser.complete_what = linespec_complete_what::NOTHING;
3121 if (tracker.quote_char ())
3123 /* The function/file name was not close-quoted, so this
3124 can't be a keyword. Note: complete_linespec_component
3125 may have swapped the original quote char for ':' when we
3126 get here, but that still indicates the same. */
3128 else if (!tracker.have_completions ())
3131 size_t wordlen = strlen (parser.completion_word);
3134 = string_find_incomplete_keyword_at_end (linespec_keywords,
3135 parser.completion_word,
3140 && parser.completion_word[wordlen - 1] == ' '))
3142 parser.completion_word += key_start;
3143 parser.complete_what = linespec_complete_what::KEYWORD;
3146 else if (tracker.completes_to_completion_word (word))
3148 /* Skip the function and complete on keywords. */
3149 parser.completion_word += strlen (word);
3150 parser.complete_what = linespec_complete_what::KEYWORD;
3151 tracker.discard_completions ();
3155 tracker.advance_custom_word_point_by (parser.completion_word - orig);
3157 complete_linespec_component (&parser, tracker,
3158 parser.completion_word,
3159 parser.complete_what,
3160 PARSER_EXPLICIT (&parser)->source_filename);
3162 /* If we're past the "filename:function:label:offset" linespec, and
3163 didn't find any match, then assume the user might want to create
3164 a pending breakpoint anyway and offer the keyword
3166 if (!parser.completion_quote_char
3167 && (parser.complete_what == linespec_complete_what::FUNCTION
3168 || parser.complete_what == linespec_complete_what::LABEL
3169 || parser.complete_what == linespec_complete_what::NOTHING)
3170 && !tracker.have_completions ())
3173 = parser.completion_word + strlen (parser.completion_word);
3175 if (end > orig && end[-1] == ' ')
3177 tracker.advance_custom_word_point_by (end - parser.completion_word);
3179 complete_linespec_component (&parser, tracker, end,
3180 linespec_complete_what::KEYWORD,
3185 do_cleanups (cleanup);
3188 /* A helper function for decode_line_full and decode_line_1 to
3189 turn LOCATION into std::vector<symtab_and_line>. */
3191 static std::vector<symtab_and_line>
3192 event_location_to_sals (linespec_parser *parser,
3193 const struct event_location *location)
3195 std::vector<symtab_and_line> result;
3197 switch (event_location_type (location))
3199 case LINESPEC_LOCATION:
3201 PARSER_STATE (parser)->is_linespec = 1;
3204 const linespec_location *ls = get_linespec_location (location);
3205 result = parse_linespec (parser,
3206 ls->spec_string, ls->match_type);
3208 CATCH (except, RETURN_MASK_ERROR)
3210 throw_exception (except);
3216 case ADDRESS_LOCATION:
3218 const char *addr_string = get_address_string_location (location);
3219 CORE_ADDR addr = get_address_location (location);
3221 if (addr_string != NULL)
3223 char *expr = xstrdup (addr_string);
3224 const char *const_expr = expr;
3225 struct cleanup *cleanup = make_cleanup (xfree, expr);
3227 addr = linespec_expression_to_pc (&const_expr);
3228 if (PARSER_STATE (parser)->canonical != NULL)
3229 PARSER_STATE (parser)->canonical->location
3230 = copy_event_location (location);
3232 do_cleanups (cleanup);
3235 result = convert_address_location_to_sals (PARSER_STATE (parser),
3240 case EXPLICIT_LOCATION:
3242 const struct explicit_location *explicit_loc;
3244 explicit_loc = get_explicit_location_const (location);
3245 result = convert_explicit_location_to_sals (PARSER_STATE (parser),
3246 PARSER_RESULT (parser),
3251 case PROBE_LOCATION:
3252 /* Probes are handled by their own decoders. */
3253 gdb_assert_not_reached ("attempt to decode probe location");
3257 gdb_assert_not_reached ("unhandled event location type");
3263 /* See linespec.h. */
3266 decode_line_full (const struct event_location *location, int flags,
3267 struct program_space *search_pspace,
3268 struct symtab *default_symtab,
3269 int default_line, struct linespec_result *canonical,
3270 const char *select_mode,
3273 struct cleanup *cleanups;
3274 VEC (const_char_ptr) *filters = NULL;
3275 linespec_parser parser;
3276 struct linespec_state *state;
3278 gdb_assert (canonical != NULL);
3279 /* The filter only makes sense for 'all'. */
3280 gdb_assert (filter == NULL || select_mode == multiple_symbols_all);
3281 gdb_assert (select_mode == NULL
3282 || select_mode == multiple_symbols_all
3283 || select_mode == multiple_symbols_ask
3284 || select_mode == multiple_symbols_cancel);
3285 gdb_assert ((flags & DECODE_LINE_LIST_MODE) == 0);
3287 linespec_parser_new (&parser, flags, current_language,
3288 search_pspace, default_symtab,
3289 default_line, canonical);
3290 cleanups = make_cleanup (linespec_parser_delete, &parser);
3292 scoped_restore_current_program_space restore_pspace;
3294 std::vector<symtab_and_line> result = event_location_to_sals (&parser,
3296 state = PARSER_STATE (&parser);
3298 gdb_assert (result.size () == 1 || canonical->pre_expanded);
3299 canonical->pre_expanded = 1;
3301 /* Arrange for allocated canonical names to be freed. */
3302 if (!result.empty ())
3306 make_cleanup (xfree, state->canonical_names);
3307 for (i = 0; i < result.size (); ++i)
3309 gdb_assert (state->canonical_names[i].suffix != NULL);
3310 make_cleanup (xfree, state->canonical_names[i].suffix);
3314 if (select_mode == NULL)
3316 if (interp_ui_out (top_level_interpreter ())->is_mi_like_p ())
3317 select_mode = multiple_symbols_all;
3319 select_mode = multiple_symbols_select_mode ();
3322 if (select_mode == multiple_symbols_all)
3326 make_cleanup (VEC_cleanup (const_char_ptr), &filters);
3327 VEC_safe_push (const_char_ptr, filters, filter);
3328 filter_results (state, &result, filters);
3331 convert_results_to_lsals (state, &result);
3334 decode_line_2 (state, &result, select_mode);
3336 do_cleanups (cleanups);
3339 /* See linespec.h. */
3341 std::vector<symtab_and_line>
3342 decode_line_1 (const struct event_location *location, int flags,
3343 struct program_space *search_pspace,
3344 struct symtab *default_symtab,
3347 linespec_parser parser;
3348 struct cleanup *cleanups;
3350 linespec_parser_new (&parser, flags, current_language,
3351 search_pspace, default_symtab,
3352 default_line, NULL);
3353 cleanups = make_cleanup (linespec_parser_delete, &parser);
3355 scoped_restore_current_program_space restore_pspace;
3357 std::vector<symtab_and_line> result = event_location_to_sals (&parser,
3360 do_cleanups (cleanups);
3364 /* See linespec.h. */
3366 std::vector<symtab_and_line>
3367 decode_line_with_current_source (const char *string, int flags)
3370 error (_("Empty line specification."));
3372 /* We use whatever is set as the current source line. We do not try
3373 and get a default source symtab+line or it will recursively call us! */
3374 symtab_and_line cursal = get_current_source_symtab_and_line ();
3376 event_location_up location = string_to_event_location (&string,
3378 std::vector<symtab_and_line> sals
3379 = decode_line_1 (location.get (), flags, NULL, cursal.symtab, cursal.line);
3382 error (_("Junk at end of line specification: %s"), string);
3387 /* See linespec.h. */
3389 std::vector<symtab_and_line>
3390 decode_line_with_last_displayed (const char *string, int flags)
3393 error (_("Empty line specification."));
3395 event_location_up location = string_to_event_location (&string,
3397 std::vector<symtab_and_line> sals
3398 = (last_displayed_sal_is_valid ()
3399 ? decode_line_1 (location.get (), flags, NULL,
3400 get_last_displayed_symtab (),
3401 get_last_displayed_line ())
3402 : decode_line_1 (location.get (), flags, NULL,
3403 (struct symtab *) NULL, 0));
3406 error (_("Junk at end of line specification: %s"), string);
3413 /* First, some functions to initialize stuff at the beggining of the
3417 initialize_defaults (struct symtab **default_symtab, int *default_line)
3419 if (*default_symtab == 0)
3421 /* Use whatever we have for the default source line. We don't use
3422 get_current_or_default_symtab_and_line as it can recurse and call
3424 struct symtab_and_line cursal =
3425 get_current_source_symtab_and_line ();
3427 *default_symtab = cursal.symtab;
3428 *default_line = cursal.line;
3434 /* Evaluate the expression pointed to by EXP_PTR into a CORE_ADDR,
3435 advancing EXP_PTR past any parsed text. */
3438 linespec_expression_to_pc (const char **exp_ptr)
3440 if (current_program_space->executing_startup)
3441 /* The error message doesn't really matter, because this case
3442 should only hit during breakpoint reset. */
3443 throw_error (NOT_FOUND_ERROR, _("cannot evaluate expressions while "
3444 "program space is in startup"));
3447 return value_as_address (parse_to_comma_and_eval (exp_ptr));
3452 /* Here's where we recognise an Objective-C Selector. An Objective C
3453 selector may be implemented by more than one class, therefore it
3454 may represent more than one method/function. This gives us a
3455 situation somewhat analogous to C++ overloading. If there's more
3456 than one method that could represent the selector, then use some of
3457 the existing C++ code to let the user choose one. */
3459 static std::vector<symtab_and_line>
3460 decode_objc (struct linespec_state *self, linespec_p ls, const char *arg)
3462 struct collect_info info;
3463 VEC (const_char_ptr) *symbol_names = NULL;
3464 const char *new_argptr;
3465 struct cleanup *cleanup = make_cleanup (VEC_cleanup (const_char_ptr),
3469 info.file_symtabs = NULL;
3470 VEC_safe_push (symtab_ptr, info.file_symtabs, NULL);
3471 make_cleanup (VEC_cleanup (symtab_ptr), &info.file_symtabs);
3472 info.result.symbols = NULL;
3473 info.result.minimal_symbols = NULL;
3475 new_argptr = find_imps (arg, &symbol_names);
3476 if (VEC_empty (const_char_ptr, symbol_names))
3478 do_cleanups (cleanup);
3482 add_all_symbol_names_from_pspace (&info, NULL, symbol_names,
3485 std::vector<symtab_and_line> values;
3486 if (!VEC_empty (symbolp, info.result.symbols)
3487 || !VEC_empty (bound_minimal_symbol_d, info.result.minimal_symbols))
3491 saved_arg = (char *) alloca (new_argptr - arg + 1);
3492 memcpy (saved_arg, arg, new_argptr - arg);
3493 saved_arg[new_argptr - arg] = '\0';
3495 ls->explicit_loc.function_name = xstrdup (saved_arg);
3496 ls->function_symbols = info.result.symbols;
3497 ls->minimal_symbols = info.result.minimal_symbols;
3498 values = convert_linespec_to_sals (self, ls);
3500 if (self->canonical)
3505 self->canonical->pre_expanded = 1;
3507 if (ls->explicit_loc.source_filename)
3509 holder = string_printf ("%s:%s",
3510 ls->explicit_loc.source_filename,
3512 str = holder.c_str ();
3517 self->canonical->location
3518 = new_linespec_location (&str, symbol_name_match_type::FULL);
3522 do_cleanups (cleanup);
3529 /* A function object that serves as symbol_found_callback_ftype
3530 callback for iterate_over_symbols. This is used by
3531 lookup_prefix_sym to collect type symbols. */
3532 class decode_compound_collector
3535 decode_compound_collector ()
3538 m_unique_syms = htab_create_alloc (1, htab_hash_pointer,
3539 htab_eq_pointer, NULL,
3543 ~decode_compound_collector ()
3545 if (m_unique_syms != NULL)
3546 htab_delete (m_unique_syms);
3549 /* Releases ownership of the collected symbols and returns them. */
3550 VEC (symbolp) *release_symbols ()
3552 VEC (symbolp) *res = m_symbols;
3557 /* Callable as a symbol_found_callback_ftype callback. */
3558 bool operator () (symbol *sym);
3561 /* A hash table of all symbols we found. We use this to avoid
3562 adding any symbol more than once. */
3563 htab_t m_unique_syms;
3565 /* The result vector. */
3566 VEC (symbolp) *m_symbols;
3570 decode_compound_collector::operator () (symbol *sym)
3575 if (SYMBOL_CLASS (sym) != LOC_TYPEDEF)
3576 return true; /* Continue iterating. */
3578 t = SYMBOL_TYPE (sym);
3579 t = check_typedef (t);
3580 if (TYPE_CODE (t) != TYPE_CODE_STRUCT
3581 && TYPE_CODE (t) != TYPE_CODE_UNION
3582 && TYPE_CODE (t) != TYPE_CODE_NAMESPACE)
3583 return true; /* Continue iterating. */
3585 slot = htab_find_slot (m_unique_syms, sym, INSERT);
3589 VEC_safe_push (symbolp, m_symbols, sym);
3592 return true; /* Continue iterating. */
3597 /* Return any symbols corresponding to CLASS_NAME in FILE_SYMTABS. */
3599 static VEC (symbolp) *
3600 lookup_prefix_sym (struct linespec_state *state, VEC (symtab_ptr) *file_symtabs,
3601 const char *class_name)
3605 decode_compound_collector collector;
3607 lookup_name_info lookup_name (class_name, symbol_name_match_type::FULL);
3609 for (ix = 0; VEC_iterate (symtab_ptr, file_symtabs, ix, elt); ++ix)
3613 iterate_over_all_matching_symtabs (state, lookup_name,
3614 STRUCT_DOMAIN, ALL_DOMAIN,
3615 NULL, false, collector);
3616 iterate_over_all_matching_symtabs (state, lookup_name,
3617 VAR_DOMAIN, ALL_DOMAIN,
3618 NULL, false, collector);
3622 /* Program spaces that are executing startup should have
3623 been filtered out earlier. */
3624 gdb_assert (!SYMTAB_PSPACE (elt)->executing_startup);
3625 set_current_program_space (SYMTAB_PSPACE (elt));
3626 iterate_over_file_blocks (elt, lookup_name, STRUCT_DOMAIN, collector);
3627 iterate_over_file_blocks (elt, lookup_name, VAR_DOMAIN, collector);
3631 return collector.release_symbols ();
3634 /* A qsort comparison function for symbols. The resulting order does
3635 not actually matter; we just need to be able to sort them so that
3636 symbols with the same program space end up next to each other. */
3639 compare_symbols (const void *a, const void *b)
3641 struct symbol * const *sa = (struct symbol * const*) a;
3642 struct symbol * const *sb = (struct symbol * const*) b;
3645 uia = (uintptr_t) SYMTAB_PSPACE (symbol_symtab (*sa));
3646 uib = (uintptr_t) SYMTAB_PSPACE (symbol_symtab (*sb));
3653 uia = (uintptr_t) *sa;
3654 uib = (uintptr_t) *sb;
3664 /* Like compare_symbols but for minimal symbols. */
3667 compare_msymbols (const void *a, const void *b)
3669 const struct bound_minimal_symbol *sa
3670 = (const struct bound_minimal_symbol *) a;
3671 const struct bound_minimal_symbol *sb
3672 = (const struct bound_minimal_symbol *) b;
3675 uia = (uintptr_t) sa->objfile->pspace;
3676 uib = (uintptr_t) sa->objfile->pspace;
3683 uia = (uintptr_t) sa->minsym;
3684 uib = (uintptr_t) sb->minsym;
3694 /* Look for all the matching instances of each symbol in NAMES. Only
3695 instances from PSPACE are considered; other program spaces are
3696 handled by our caller. If PSPACE is NULL, then all program spaces
3697 are considered. Results are stored into INFO. */
3700 add_all_symbol_names_from_pspace (struct collect_info *info,
3701 struct program_space *pspace,
3702 VEC (const_char_ptr) *names,
3703 enum search_domain search_domain)
3708 for (ix = 0; VEC_iterate (const_char_ptr, names, ix, iter); ++ix)
3709 add_matching_symbols_to_info (iter,
3710 symbol_name_match_type::FULL,
3711 search_domain, info, pspace);
3715 find_superclass_methods (VEC (typep) *superclasses,
3716 const char *name, enum language name_lang,
3717 VEC (const_char_ptr) **result_names)
3719 int old_len = VEC_length (const_char_ptr, *result_names);
3720 VEC (typep) *iter_classes;
3721 struct cleanup *cleanup = make_cleanup (null_cleanup, NULL);
3723 iter_classes = superclasses;
3726 VEC (typep) *new_supers = NULL;
3730 make_cleanup (VEC_cleanup (typep), &new_supers);
3731 for (ix = 0; VEC_iterate (typep, iter_classes, ix, t); ++ix)
3732 find_methods (t, name_lang, name, result_names, &new_supers);
3734 if (VEC_length (const_char_ptr, *result_names) != old_len
3735 || VEC_empty (typep, new_supers))
3738 iter_classes = new_supers;
3741 do_cleanups (cleanup);
3744 /* This finds the method METHOD_NAME in the class CLASS_NAME whose type is
3745 given by one of the symbols in SYM_CLASSES. Matches are returned
3746 in SYMBOLS (for debug symbols) and MINSYMS (for minimal symbols). */
3749 find_method (struct linespec_state *self, VEC (symtab_ptr) *file_symtabs,
3750 const char *class_name, const char *method_name,
3751 VEC (symbolp) *sym_classes, VEC (symbolp) **symbols,
3752 VEC (bound_minimal_symbol_d) **minsyms)
3755 struct cleanup *cleanup = make_cleanup (null_cleanup, NULL);
3757 int last_result_len;
3758 VEC (typep) *superclass_vec;
3759 VEC (const_char_ptr) *result_names;
3760 struct collect_info info;
3762 /* Sort symbols so that symbols with the same program space are next
3764 qsort (VEC_address (symbolp, sym_classes),
3765 VEC_length (symbolp, sym_classes),
3770 info.file_symtabs = file_symtabs;
3771 info.result.symbols = NULL;
3772 info.result.minimal_symbols = NULL;
3774 /* Iterate over all the types, looking for the names of existing
3775 methods matching METHOD_NAME. If we cannot find a direct method in a
3776 given program space, then we consider inherited methods; this is
3777 not ideal (ideal would be to respect C++ hiding rules), but it
3778 seems good enough and is what GDB has historically done. We only
3779 need to collect the names because later we find all symbols with
3780 those names. This loop is written in a somewhat funny way
3781 because we collect data across the program space before deciding
3783 superclass_vec = NULL;
3784 make_cleanup (VEC_cleanup (typep), &superclass_vec);
3785 result_names = NULL;
3786 make_cleanup (VEC_cleanup (const_char_ptr), &result_names);
3787 last_result_len = 0;
3788 for (ix = 0; VEC_iterate (symbolp, sym_classes, ix, sym); ++ix)
3791 struct program_space *pspace;
3793 /* Program spaces that are executing startup should have
3794 been filtered out earlier. */
3795 pspace = SYMTAB_PSPACE (symbol_symtab (sym));
3796 gdb_assert (!pspace->executing_startup);
3797 set_current_program_space (pspace);
3798 t = check_typedef (SYMBOL_TYPE (sym));
3799 find_methods (t, SYMBOL_LANGUAGE (sym),
3800 method_name, &result_names, &superclass_vec);
3802 /* Handle all items from a single program space at once; and be
3803 sure not to miss the last batch. */
3804 if (ix == VEC_length (symbolp, sym_classes) - 1
3806 != SYMTAB_PSPACE (symbol_symtab (VEC_index (symbolp, sym_classes,
3809 /* If we did not find a direct implementation anywhere in
3810 this program space, consider superclasses. */
3811 if (VEC_length (const_char_ptr, result_names) == last_result_len)
3812 find_superclass_methods (superclass_vec, method_name,
3813 SYMBOL_LANGUAGE (sym), &result_names);
3815 /* We have a list of candidate symbol names, so now we
3816 iterate over the symbol tables looking for all
3817 matches in this pspace. */
3818 add_all_symbol_names_from_pspace (&info, pspace, result_names,
3821 VEC_truncate (typep, superclass_vec, 0);
3822 last_result_len = VEC_length (const_char_ptr, result_names);
3826 if (!VEC_empty (symbolp, info.result.symbols)
3827 || !VEC_empty (bound_minimal_symbol_d, info.result.minimal_symbols))
3829 *symbols = info.result.symbols;
3830 *minsyms = info.result.minimal_symbols;
3831 do_cleanups (cleanup);
3835 /* Throw an NOT_FOUND_ERROR. This will be caught by the caller
3836 and other attempts to locate the symbol will be made. */
3837 throw_error (NOT_FOUND_ERROR, _("see caller, this text doesn't matter"));
3844 /* This function object is a callback for iterate_over_symtabs, used
3845 when collecting all matching symtabs. */
3847 class symtab_collector
3853 m_symtab_table = htab_create (1, htab_hash_pointer, htab_eq_pointer,
3857 ~symtab_collector ()
3859 if (m_symtab_table != NULL)
3860 htab_delete (m_symtab_table);
3863 /* Callable as a symbol_found_callback_ftype callback. */
3864 bool operator () (symtab *sym);
3866 /* Releases ownership of the collected symtabs and returns them. */
3867 VEC (symtab_ptr) *release_symtabs ()
3869 VEC (symtab_ptr) *res = m_symtabs;
3875 /* The result vector of symtabs. */
3876 VEC (symtab_ptr) *m_symtabs;
3878 /* This is used to ensure the symtabs are unique. */
3879 htab_t m_symtab_table;
3883 symtab_collector::operator () (struct symtab *symtab)
3887 slot = htab_find_slot (m_symtab_table, symtab, INSERT);
3891 VEC_safe_push (symtab_ptr, m_symtabs, symtab);
3899 /* Given a file name, return a VEC of all matching symtabs. If
3900 SEARCH_PSPACE is not NULL, the search is restricted to just that
3903 static VEC (symtab_ptr) *
3904 collect_symtabs_from_filename (const char *file,
3905 struct program_space *search_pspace)
3907 symtab_collector collector;
3909 /* Find that file's data. */
3910 if (search_pspace == NULL)
3912 struct program_space *pspace;
3914 ALL_PSPACES (pspace)
3916 if (pspace->executing_startup)
3919 set_current_program_space (pspace);
3920 iterate_over_symtabs (file, collector);
3925 set_current_program_space (search_pspace);
3926 iterate_over_symtabs (file, collector);
3929 return collector.release_symtabs ();
3932 /* Return all the symtabs associated to the FILENAME. If SEARCH_PSPACE is
3933 not NULL, the search is restricted to just that program space. */
3935 static VEC (symtab_ptr) *
3936 symtabs_from_filename (const char *filename,
3937 struct program_space *search_pspace)
3939 VEC (symtab_ptr) *result;
3941 result = collect_symtabs_from_filename (filename, search_pspace);
3943 if (VEC_empty (symtab_ptr, result))
3945 if (!have_full_symbols () && !have_partial_symbols ())
3946 throw_error (NOT_FOUND_ERROR,
3947 _("No symbol table is loaded. "
3948 "Use the \"file\" command."));
3949 source_file_not_found_error (filename);
3955 /* Look up a function symbol named NAME in symtabs FILE_SYMTABS. Matching
3956 debug symbols are returned in SYMBOLS. Matching minimal symbols are
3957 returned in MINSYMS. */
3960 find_function_symbols (struct linespec_state *state,
3961 VEC (symtab_ptr) *file_symtabs, const char *name,
3962 symbol_name_match_type name_match_type,
3963 VEC (symbolp) **symbols,
3964 VEC (bound_minimal_symbol_d) **minsyms)
3966 struct collect_info info;
3967 VEC (const_char_ptr) *symbol_names = NULL;
3968 struct cleanup *cleanup = make_cleanup (VEC_cleanup (const_char_ptr),
3972 info.result.symbols = NULL;
3973 info.result.minimal_symbols = NULL;
3974 info.file_symtabs = file_symtabs;
3976 /* Try NAME as an Objective-C selector. */
3977 find_imps (name, &symbol_names);
3978 if (!VEC_empty (const_char_ptr, symbol_names))
3979 add_all_symbol_names_from_pspace (&info, state->search_pspace,
3980 symbol_names, FUNCTIONS_DOMAIN);
3982 add_matching_symbols_to_info (name, name_match_type, FUNCTIONS_DOMAIN,
3983 &info, state->search_pspace);
3985 do_cleanups (cleanup);
3987 if (VEC_empty (symbolp, info.result.symbols))
3989 VEC_free (symbolp, info.result.symbols);
3993 *symbols = info.result.symbols;
3995 if (VEC_empty (bound_minimal_symbol_d, info.result.minimal_symbols))
3997 VEC_free (bound_minimal_symbol_d, info.result.minimal_symbols);
4001 *minsyms = info.result.minimal_symbols;
4004 /* Find all symbols named NAME in FILE_SYMTABS, returning debug symbols
4005 in SYMBOLS and minimal symbols in MINSYMS. */
4008 find_linespec_symbols (struct linespec_state *state,
4009 VEC (symtab_ptr) *file_symtabs,
4010 const char *lookup_name,
4011 symbol_name_match_type name_match_type,
4012 VEC (symbolp) **symbols,
4013 VEC (bound_minimal_symbol_d) **minsyms)
4015 std::string canon = cp_canonicalize_string_no_typedefs (lookup_name);
4016 if (!canon.empty ())
4017 lookup_name = canon.c_str ();
4019 /* It's important to not call expand_symtabs_matching unnecessarily
4020 as it can really slow things down (by unnecessarily expanding
4021 potentially 1000s of symtabs, which when debugging some apps can
4022 cost 100s of seconds). Avoid this to some extent by *first* calling
4023 find_function_symbols, and only if that doesn't find anything
4024 *then* call find_method. This handles two important cases:
4025 1) break (anonymous namespace)::foo
4026 2) break class::method where method is in class (and not a baseclass) */
4028 find_function_symbols (state, file_symtabs, lookup_name,
4032 /* If we were unable to locate a symbol of the same name, try dividing
4033 the name into class and method names and searching the class and its
4035 if (VEC_empty (symbolp, *symbols)
4036 && VEC_empty (bound_minimal_symbol_d, *minsyms))
4038 std::string klass, method;
4039 const char *last, *p, *scope_op;
4040 VEC (symbolp) *classes;
4042 /* See if we can find a scope operator and break this symbol
4043 name into namespaces${SCOPE_OPERATOR}class_name and method_name. */
4045 p = find_toplevel_string (lookup_name, scope_op);
4051 p = find_toplevel_string (p + strlen (scope_op), scope_op);
4054 /* If no scope operator was found, there is nothing more we can do;
4055 we already attempted to lookup the entire name as a symbol
4060 /* LOOKUP_NAME points to the class name.
4061 LAST points to the method name. */
4062 klass = std::string (lookup_name, last - lookup_name);
4064 /* Skip past the scope operator. */
4065 last += strlen (scope_op);
4068 /* Find a list of classes named KLASS. */
4069 classes = lookup_prefix_sym (state, file_symtabs, klass.c_str ());
4070 struct cleanup *old_chain
4071 = make_cleanup (VEC_cleanup (symbolp), &classes);
4073 if (!VEC_empty (symbolp, classes))
4075 /* Now locate a list of suitable methods named METHOD. */
4078 find_method (state, file_symtabs,
4079 klass.c_str (), method.c_str (),
4080 classes, symbols, minsyms);
4083 /* If successful, we're done. If NOT_FOUND_ERROR
4084 was not thrown, rethrow the exception that we did get. */
4085 CATCH (except, RETURN_MASK_ERROR)
4087 if (except.error != NOT_FOUND_ERROR)
4088 throw_exception (except);
4093 do_cleanups (old_chain);
4097 /* Helper for find_label_symbols. Find all labels that match name
4098 NAME in BLOCK. Return all labels that match in FUNCTION_SYMBOLS.
4099 Return the actual function symbol in which the label was found in
4100 LABEL_FUNC_RET. If COMPLETION_MODE is true, then NAME is
4101 interpreted as a label name prefix. Otherwise, only a label named
4102 exactly NAME match. */
4105 find_label_symbols_in_block (const struct block *block,
4106 const char *name, struct symbol *fn_sym,
4107 bool completion_mode,
4108 VEC (symbolp) **result,
4109 VEC (symbolp) **label_funcs_ret)
4111 if (completion_mode)
4113 struct block_iterator iter;
4115 size_t name_len = strlen (name);
4117 int (*cmp) (const char *, const char *, size_t);
4118 cmp = case_sensitivity == case_sensitive_on ? strncmp : strncasecmp;
4120 ALL_BLOCK_SYMBOLS (block, iter, sym)
4122 if (symbol_matches_domain (SYMBOL_LANGUAGE (sym),
4123 SYMBOL_DOMAIN (sym), LABEL_DOMAIN)
4124 && cmp (SYMBOL_SEARCH_NAME (sym), name, name_len) == 0)
4126 VEC_safe_push (symbolp, *result, sym);
4127 VEC_safe_push (symbolp, *label_funcs_ret, fn_sym);
4133 struct symbol *sym = lookup_symbol (name, block, LABEL_DOMAIN, 0).symbol;
4137 VEC_safe_push (symbolp, *result, sym);
4138 VEC_safe_push (symbolp, *label_funcs_ret, fn_sym);
4143 /* Return all labels that match name NAME in FUNCTION_SYMBOLS. Return
4144 the actual function symbol in which the label was found in
4145 LABEL_FUNC_RET. If COMPLETION_MODE is true, then NAME is
4146 interpreted as a label name prefix. Otherwise, only labels named
4147 exactly NAME match. */
4149 static VEC (symbolp) *
4150 find_label_symbols (struct linespec_state *self,
4151 VEC (symbolp) *function_symbols,
4152 VEC (symbolp) **label_funcs_ret, const char *name,
4153 bool completion_mode)
4156 const struct block *block;
4158 struct symbol *fn_sym;
4159 VEC (symbolp) *result = NULL;
4161 if (function_symbols == NULL)
4163 set_current_program_space (self->program_space);
4164 block = get_current_search_block ();
4167 block && !BLOCK_FUNCTION (block);
4168 block = BLOCK_SUPERBLOCK (block))
4172 fn_sym = BLOCK_FUNCTION (block);
4174 find_label_symbols_in_block (block, name, fn_sym, completion_mode,
4175 &result, label_funcs_ret);
4180 VEC_iterate (symbolp, function_symbols, ix, fn_sym); ++ix)
4182 set_current_program_space (SYMTAB_PSPACE (symbol_symtab (fn_sym)));
4183 block = SYMBOL_BLOCK_VALUE (fn_sym);
4185 find_label_symbols_in_block (block, name, fn_sym, completion_mode,
4186 &result, label_funcs_ret);
4195 /* A helper for create_sals_line_offset that handles the 'list_mode' case. */
4197 static std::vector<symtab_and_line>
4198 decode_digits_list_mode (struct linespec_state *self,
4200 struct symtab_and_line val)
4205 gdb_assert (self->list_mode);
4207 std::vector<symtab_and_line> values;
4209 for (ix = 0; VEC_iterate (symtab_ptr, ls->file_symtabs, ix, elt);
4212 /* The logic above should ensure this. */
4213 gdb_assert (elt != NULL);
4215 set_current_program_space (SYMTAB_PSPACE (elt));
4217 /* Simplistic search just for the list command. */
4218 val.symtab = find_line_symtab (elt, val.line, NULL, NULL);
4219 if (val.symtab == NULL)
4221 val.pspace = SYMTAB_PSPACE (elt);
4223 val.explicit_line = 1;
4225 add_sal_to_sals (self, &values, &val, NULL, 0);
4231 /* A helper for create_sals_line_offset that iterates over the symtabs,
4232 adding lines to the VEC. */
4234 static std::vector<symtab_and_line>
4235 decode_digits_ordinary (struct linespec_state *self,
4238 struct linetable_entry **best_entry)
4243 std::vector<symtab_and_line> sals;
4244 for (ix = 0; VEC_iterate (symtab_ptr, ls->file_symtabs, ix, elt); ++ix)
4246 std::vector<CORE_ADDR> pcs;
4248 /* The logic above should ensure this. */
4249 gdb_assert (elt != NULL);
4251 set_current_program_space (SYMTAB_PSPACE (elt));
4253 pcs = find_pcs_for_symtab_line (elt, line, best_entry);
4254 for (CORE_ADDR pc : pcs)
4256 symtab_and_line sal;
4257 sal.pspace = SYMTAB_PSPACE (elt);
4261 sals.push_back (std::move (sal));
4270 /* Return the line offset represented by VARIABLE. */
4272 static struct line_offset
4273 linespec_parse_variable (struct linespec_state *self, const char *variable)
4277 struct line_offset offset = {0, LINE_OFFSET_NONE};
4279 p = (variable[1] == '$') ? variable + 2 : variable + 1;
4282 while (*p >= '0' && *p <= '9')
4284 if (!*p) /* Reached end of token without hitting non-digit. */
4286 /* We have a value history reference. */
4287 struct value *val_history;
4289 sscanf ((variable[1] == '$') ? variable + 2 : variable + 1, "%d", &index);
4291 = access_value_history ((variable[1] == '$') ? -index : index);
4292 if (TYPE_CODE (value_type (val_history)) != TYPE_CODE_INT)
4293 error (_("History values used in line "
4294 "specs must have integer values."));
4295 offset.offset = value_as_long (val_history);
4299 /* Not all digits -- may be user variable/function or a
4300 convenience variable. */
4302 struct internalvar *ivar;
4304 /* Try it as a convenience variable. If it is not a convenience
4305 variable, return and allow normal symbol lookup to occur. */
4306 ivar = lookup_only_internalvar (variable + 1);
4308 /* No internal variable with that name. Mark the offset
4309 as unknown to allow the name to be looked up as a symbol. */
4310 offset.sign = LINE_OFFSET_UNKNOWN;
4313 /* We found a valid variable name. If it is not an integer,
4315 if (!get_internalvar_integer (ivar, &valx))
4316 error (_("Convenience variables used in line "
4317 "specs must have integer values."));
4319 offset.offset = valx;
4327 /* We've found a minimal symbol MSYMBOL in OBJFILE to associate with our
4328 linespec; return the SAL in RESULT. This function should return SALs
4329 matching those from find_function_start_sal, otherwise false
4330 multiple-locations breakpoints could be placed. */
4333 minsym_found (struct linespec_state *self, struct objfile *objfile,
4334 struct minimal_symbol *msymbol,
4335 std::vector<symtab_and_line> *result)
4337 struct symtab_and_line sal;
4339 CORE_ADDR func_addr;
4340 if (msymbol_is_function (objfile, msymbol, &func_addr))
4342 sal = find_pc_sect_line (func_addr, NULL, 0);
4344 if (self->funfirstline)
4346 if (sal.symtab != NULL
4347 && (COMPUNIT_LOCATIONS_VALID (SYMTAB_COMPUNIT (sal.symtab))
4348 || SYMTAB_LANGUAGE (sal.symtab) == language_asm))
4350 struct gdbarch *gdbarch = get_objfile_arch (objfile);
4353 if (gdbarch_skip_entrypoint_p (gdbarch))
4354 sal.pc = gdbarch_skip_entrypoint (gdbarch, sal.pc);
4357 skip_prologue_sal (&sal);
4362 sal.objfile = objfile;
4363 sal.pc = MSYMBOL_VALUE_ADDRESS (objfile, msymbol);
4364 sal.pspace = current_program_space;
4365 sal.section = MSYMBOL_OBJ_SECTION (objfile, msymbol);
4368 if (maybe_add_address (self->addr_set, objfile->pspace, sal.pc))
4369 add_sal_to_sals (self, result, &sal, MSYMBOL_NATURAL_NAME (msymbol), 0);
4372 /* A helper struct to pass some data through
4373 iterate_over_minimal_symbols. */
4375 struct collect_minsyms
4377 /* The objfile we're examining. */
4378 struct objfile *objfile;
4380 /* Only search the given symtab, or NULL to search for all symbols. */
4381 struct symtab *symtab;
4383 /* The funfirstline setting from the initial call. */
4386 /* The list_mode setting from the initial call. */
4389 /* The resulting symbols. */
4390 VEC (bound_minimal_symbol_d) *msyms;
4393 /* A helper function to classify a minimal_symbol_type according to
4397 classify_mtype (enum minimal_symbol_type t)
4404 /* Intermediate priority. */
4407 case mst_solib_trampoline:
4408 /* Lowest priority. */
4412 /* Highest priority. */
4417 /* Callback for qsort that sorts symbols by priority. */
4420 compare_msyms (const void *a, const void *b)
4422 const bound_minimal_symbol_d *moa = (const bound_minimal_symbol_d *) a;
4423 const bound_minimal_symbol_d *mob = (const bound_minimal_symbol_d *) b;
4424 enum minimal_symbol_type ta = MSYMBOL_TYPE (moa->minsym);
4425 enum minimal_symbol_type tb = MSYMBOL_TYPE (mob->minsym);
4427 return classify_mtype (ta) - classify_mtype (tb);
4430 /* Callback for iterate_over_minimal_symbols that adds the symbol to
4434 add_minsym (struct minimal_symbol *minsym, void *d)
4436 struct collect_minsyms *info = (struct collect_minsyms *) d;
4438 if (info->symtab != NULL)
4440 /* We're looking for a label for which we don't have debug
4442 CORE_ADDR func_addr;
4443 if (msymbol_is_function (info->objfile, minsym, &func_addr))
4445 symtab_and_line sal = find_pc_sect_line (func_addr, NULL, 0);
4447 if (info->symtab != sal.symtab)
4452 /* Exclude data symbols when looking for breakpoint locations. */
4453 if (!info->list_mode && !msymbol_is_function (info->objfile, minsym))
4456 bound_minimal_symbol_d mo = {minsym, info->objfile};
4457 VEC_safe_push (bound_minimal_symbol_d, info->msyms, &mo);
4460 /* Search for minimal symbols called NAME. If SEARCH_PSPACE
4461 is not NULL, the search is restricted to just that program
4464 If SYMTAB is NULL, search all objfiles, otherwise
4465 restrict results to the given SYMTAB. */
4468 search_minsyms_for_name (struct collect_info *info,
4469 const lookup_name_info &name,
4470 struct program_space *search_pspace,
4471 struct symtab *symtab)
4473 struct collect_minsyms local;
4474 struct cleanup *cleanup;
4476 memset (&local, 0, sizeof (local));
4477 local.funfirstline = info->state->funfirstline;
4478 local.list_mode = info->state->list_mode;
4479 local.symtab = symtab;
4481 cleanup = make_cleanup (VEC_cleanup (bound_minimal_symbol_d), &local.msyms);
4485 struct program_space *pspace;
4487 ALL_PSPACES (pspace)
4489 struct objfile *objfile;
4491 if (search_pspace != NULL && search_pspace != pspace)
4493 if (pspace->executing_startup)
4496 set_current_program_space (pspace);
4498 ALL_OBJFILES (objfile)
4500 local.objfile = objfile;
4501 iterate_over_minimal_symbols (objfile, name, add_minsym, &local);
4507 if (search_pspace == NULL || SYMTAB_PSPACE (symtab) == search_pspace)
4509 set_current_program_space (SYMTAB_PSPACE (symtab));
4510 local.objfile = SYMTAB_OBJFILE(symtab);
4511 iterate_over_minimal_symbols (local.objfile, name, add_minsym, &local);
4515 if (!VEC_empty (bound_minimal_symbol_d, local.msyms))
4519 bound_minimal_symbol_d *item;
4521 qsort (VEC_address (bound_minimal_symbol_d, local.msyms),
4522 VEC_length (bound_minimal_symbol_d, local.msyms),
4523 sizeof (bound_minimal_symbol_d),
4526 /* Now the minsyms are in classification order. So, we walk
4527 over them and process just the minsyms with the same
4528 classification as the very first minsym in the list. */
4529 item = VEC_index (bound_minimal_symbol_d, local.msyms, 0);
4530 classification = classify_mtype (MSYMBOL_TYPE (item->minsym));
4533 VEC_iterate (bound_minimal_symbol_d, local.msyms, ix, item);
4536 if (classify_mtype (MSYMBOL_TYPE (item->minsym)) != classification)
4539 VEC_safe_push (bound_minimal_symbol_d,
4540 info->result.minimal_symbols, item);
4544 do_cleanups (cleanup);
4547 /* A helper function to add all symbols matching NAME to INFO. If
4548 PSPACE is not NULL, the search is restricted to just that program
4552 add_matching_symbols_to_info (const char *name,
4553 symbol_name_match_type name_match_type,
4554 enum search_domain search_domain,
4555 struct collect_info *info,
4556 struct program_space *pspace)
4561 lookup_name_info lookup_name (name, name_match_type);
4563 for (ix = 0; VEC_iterate (symtab_ptr, info->file_symtabs, ix, elt); ++ix)
4567 iterate_over_all_matching_symtabs (info->state, lookup_name,
4568 VAR_DOMAIN, search_domain,
4569 pspace, true, [&] (symbol *sym)
4570 { return info->add_symbol (sym); });
4571 search_minsyms_for_name (info, lookup_name, pspace, NULL);
4573 else if (pspace == NULL || pspace == SYMTAB_PSPACE (elt))
4575 int prev_len = VEC_length (symbolp, info->result.symbols);
4577 /* Program spaces that are executing startup should have
4578 been filtered out earlier. */
4579 gdb_assert (!SYMTAB_PSPACE (elt)->executing_startup);
4580 set_current_program_space (SYMTAB_PSPACE (elt));
4581 iterate_over_file_blocks (elt, lookup_name, VAR_DOMAIN,
4583 { return info->add_symbol (sym); });
4585 /* If no new symbols were found in this iteration and this symtab
4586 is in assembler, we might actually be looking for a label for
4587 which we don't have debug info. Check for a minimal symbol in
4589 if (prev_len == VEC_length (symbolp, info->result.symbols)
4590 && elt->language == language_asm)
4591 search_minsyms_for_name (info, lookup_name, pspace, elt);
4598 /* Now come some functions that are called from multiple places within
4602 symbol_to_sal (struct symtab_and_line *result,
4603 int funfirstline, struct symbol *sym)
4605 if (SYMBOL_CLASS (sym) == LOC_BLOCK)
4607 *result = find_function_start_sal (sym, funfirstline);
4612 if (SYMBOL_CLASS (sym) == LOC_LABEL && SYMBOL_VALUE_ADDRESS (sym) != 0)
4615 result->symtab = symbol_symtab (sym);
4616 result->symbol = sym;
4617 result->line = SYMBOL_LINE (sym);
4618 result->pc = SYMBOL_VALUE_ADDRESS (sym);
4619 result->pspace = SYMTAB_PSPACE (result->symtab);
4620 result->explicit_pc = 1;
4623 else if (funfirstline)
4627 else if (SYMBOL_LINE (sym) != 0)
4629 /* We know its line number. */
4631 result->symtab = symbol_symtab (sym);
4632 result->symbol = sym;
4633 result->line = SYMBOL_LINE (sym);
4634 result->pc = SYMBOL_VALUE_ADDRESS (sym);
4635 result->pspace = SYMTAB_PSPACE (result->symtab);
4643 linespec_result::~linespec_result ()
4645 for (linespec_sals &lsal : lsals)
4646 xfree (lsal.canonical);
4649 /* Return the quote characters permitted by the linespec parser. */
4652 get_gdb_linespec_parser_quote_characters (void)
4654 return linespec_quote_characters;