1 /* Parser for linespec for the GNU debugger, GDB.
3 Copyright (C) 1986-2019 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
29 #include "completer.h"
31 #include "cp-support.h"
32 #include "parser-defs.h"
34 #include "objc-lang.h"
38 #include "mi/mi-cmds.h"
40 #include "arch-utils.h"
42 #include "cli/cli-utils.h"
43 #include "filenames.h"
47 #include "common/function-view.h"
48 #include "common/def-vector.h"
51 /* An enumeration of the various things a user might attempt to
52 complete for a linespec location. */
54 enum class linespec_complete_what
56 /* Nothing, no possible completion. */
59 /* A function/method name. Due to ambiguity between
65 this can also indicate a source filename, iff we haven't seen a
66 separate source filename component, as in "b source.c:function". */
69 /* A label symbol. E.g., break file.c:function:LABEL. */
72 /* An expression. E.g., "break foo if EXPR", or "break *EXPR". */
75 /* A linespec keyword ("if"/"thread"/"task").
76 E.g., "break func threa<tab>". */
80 /* An address entry is used to ensure that any given location is only
81 added to the result a single time. It holds an address and the
82 program space from which the address came. */
86 struct program_space
*pspace
;
90 /* A linespec. Elements of this structure are filled in by a parser
91 (either parse_linespec or some other function). The structure is
92 then converted into SALs by convert_linespec_to_sals. */
96 /* An explicit location describing the SaLs. */
97 struct explicit_location explicit_loc
;
99 /* The list of symtabs to search to which to limit the search. May not
100 be NULL. If explicit.SOURCE_FILENAME is NULL (no user-specified
101 filename), FILE_SYMTABS should contain one single NULL member. This
102 will cause the code to use the default symtab. */
103 std::vector
<symtab
*> *file_symtabs
;
105 /* A list of matching function symbols and minimal symbols. Both lists
106 may be NULL (or empty) if no matching symbols were found. */
107 std::vector
<block_symbol
> *function_symbols
;
108 std::vector
<bound_minimal_symbol
> *minimal_symbols
;
110 /* A structure of matching label symbols and the corresponding
111 function symbol in which the label was found. Both may be NULL
112 or both must be non-NULL. */
115 std::vector
<block_symbol
> *label_symbols
;
116 std::vector
<block_symbol
> *function_symbols
;
119 typedef struct linespec
*linespec_p
;
121 /* A canonical linespec represented as a symtab-related string.
123 Each entry represents the "SYMTAB:SUFFIX" linespec string.
124 SYMTAB can be converted for example by symtab_to_fullname or
125 symtab_to_filename_for_display as needed. */
127 struct linespec_canonical_name
129 /* Remaining text part of the linespec string. */
132 /* If NULL then SUFFIX is the whole linespec string. */
133 struct symtab
*symtab
;
136 /* An instance of this is used to keep all state while linespec
137 operates. This instance is passed around as a 'this' pointer to
138 the various implementation methods. */
140 struct linespec_state
142 /* The language in use during linespec processing. */
143 const struct language_defn
*language
;
145 /* The program space as seen when the module was entered. */
146 struct program_space
*program_space
;
148 /* If not NULL, the search is restricted to just this program
150 struct program_space
*search_pspace
;
152 /* The default symtab to use, if no other symtab is specified. */
153 struct symtab
*default_symtab
;
155 /* The default line to use. */
158 /* The 'funfirstline' value that was passed in to decode_line_1 or
162 /* Nonzero if we are running in 'list' mode; see decode_line_list. */
165 /* The 'canonical' value passed to decode_line_full, or NULL. */
166 struct linespec_result
*canonical
;
168 /* Canonical strings that mirror the std::vector<symtab_and_line> result. */
169 struct linespec_canonical_name
*canonical_names
;
171 /* This is a set of address_entry objects which is used to prevent
172 duplicate symbols from being entered into the result. */
175 /* Are we building a linespec? */
179 /* This is a helper object that is used when collecting symbols into a
184 /* The linespec object in use. */
185 struct linespec_state
*state
;
187 /* A list of symtabs to which to restrict matches. */
188 std::vector
<symtab
*> *file_symtabs
;
190 /* The result being accumulated. */
193 std::vector
<block_symbol
> *symbols
;
194 std::vector
<bound_minimal_symbol
> *minimal_symbols
;
197 /* Possibly add a symbol to the results. */
198 virtual bool add_symbol (block_symbol
*bsym
);
202 collect_info::add_symbol (block_symbol
*bsym
)
204 /* In list mode, add all matching symbols, regardless of class.
205 This allows the user to type "list a_global_variable". */
206 if (SYMBOL_CLASS (bsym
->symbol
) == LOC_BLOCK
|| this->state
->list_mode
)
207 this->result
.symbols
->push_back (*bsym
);
209 /* Continue iterating. */
213 /* Custom collect_info for symbol_searcher. */
215 struct symbol_searcher_collect_info
218 bool add_symbol (block_symbol
*bsym
) override
220 /* Add everything. */
221 this->result
.symbols
->push_back (*bsym
);
223 /* Continue iterating. */
235 /* A colon "separator" */
247 /* EOI (end of input) */
253 typedef enum ls_token_type linespec_token_type
;
255 /* List of keywords. This is NULL-terminated so that it can be used
256 as enum completer. */
257 const char * const linespec_keywords
[] = { "if", "thread", "task", NULL
};
258 #define IF_KEYWORD_INDEX 0
260 /* A token of the linespec lexer */
264 /* The type of the token */
265 linespec_token_type type
;
267 /* Data for the token */
270 /* A string, given as a stoken */
271 struct stoken string
;
277 typedef struct ls_token linespec_token
;
279 #define LS_TOKEN_STOKEN(TOK) (TOK).data.string
280 #define LS_TOKEN_KEYWORD(TOK) (TOK).data.keyword
282 /* An instance of the linespec parser. */
284 struct linespec_parser
286 linespec_parser (int flags
, const struct language_defn
*language
,
287 struct program_space
*search_pspace
,
288 struct symtab
*default_symtab
,
290 struct linespec_result
*canonical
);
294 DISABLE_COPY_AND_ASSIGN (linespec_parser
);
296 /* Lexer internal data */
299 /* Save head of input stream. */
300 const char *saved_arg
;
302 /* Head of the input stream. */
304 #define PARSER_STREAM(P) ((P)->lexer.stream)
306 /* The current token. */
307 linespec_token current
;
310 /* Is the entire linespec quote-enclosed? */
311 int is_quote_enclosed
= 0;
313 /* The state of the parse. */
314 struct linespec_state state
{};
315 #define PARSER_STATE(PPTR) (&(PPTR)->state)
317 /* The result of the parse. */
318 struct linespec result
{};
319 #define PARSER_RESULT(PPTR) (&(PPTR)->result)
321 /* What the parser believes the current word point should complete
323 linespec_complete_what complete_what
= linespec_complete_what::NOTHING
;
325 /* The completion word point. The parser advances this as it skips
326 tokens. At some point the input string will end or parsing will
327 fail, and then we attempt completion at the captured completion
328 word point, interpreting the string at completion_word as
330 const char *completion_word
= nullptr;
332 /* If the current token was a quoted string, then this is the
333 quoting character (either " or '). */
334 int completion_quote_char
= 0;
336 /* If the current token was a quoted string, then this points at the
337 end of the quoted string. */
338 const char *completion_quote_end
= nullptr;
340 /* If parsing for completion, then this points at the completion
341 tracker. Otherwise, this is NULL. */
342 struct completion_tracker
*completion_tracker
= nullptr;
345 /* A convenience macro for accessing the explicit location result of
347 #define PARSER_EXPLICIT(PPTR) (&PARSER_RESULT ((PPTR))->explicit_loc)
349 /* Prototypes for local functions. */
351 static void iterate_over_file_blocks
352 (struct symtab
*symtab
, const lookup_name_info
&name
,
354 gdb::function_view
<symbol_found_callback_ftype
> callback
);
356 static void initialize_defaults (struct symtab
**default_symtab
,
359 CORE_ADDR
linespec_expression_to_pc (const char **exp_ptr
);
361 static std::vector
<symtab_and_line
> decode_objc (struct linespec_state
*self
,
365 static std::vector
<symtab
*> symtabs_from_filename
366 (const char *, struct program_space
*pspace
);
368 static std::vector
<block_symbol
> *find_label_symbols
369 (struct linespec_state
*self
, std::vector
<block_symbol
> *function_symbols
,
370 std::vector
<block_symbol
> *label_funcs_ret
, const char *name
,
371 bool completion_mode
= false);
373 static void find_linespec_symbols (struct linespec_state
*self
,
374 std::vector
<symtab
*> *file_symtabs
,
376 symbol_name_match_type name_match_type
,
377 std::vector
<block_symbol
> *symbols
,
378 std::vector
<bound_minimal_symbol
> *minsyms
);
380 static struct line_offset
381 linespec_parse_variable (struct linespec_state
*self
,
382 const char *variable
);
384 static int symbol_to_sal (struct symtab_and_line
*result
,
385 int funfirstline
, struct symbol
*sym
);
387 static void add_matching_symbols_to_info (const char *name
,
388 symbol_name_match_type name_match_type
,
389 enum search_domain search_domain
,
390 struct collect_info
*info
,
391 struct program_space
*pspace
);
393 static void add_all_symbol_names_from_pspace
394 (struct collect_info
*info
, struct program_space
*pspace
,
395 const std::vector
<const char *> &names
, enum search_domain search_domain
);
397 static std::vector
<symtab
*>
398 collect_symtabs_from_filename (const char *file
,
399 struct program_space
*pspace
);
401 static std::vector
<symtab_and_line
> decode_digits_ordinary
402 (struct linespec_state
*self
,
405 linetable_entry
**best_entry
);
407 static std::vector
<symtab_and_line
> decode_digits_list_mode
408 (struct linespec_state
*self
,
410 struct symtab_and_line val
);
412 static void minsym_found (struct linespec_state
*self
, struct objfile
*objfile
,
413 struct minimal_symbol
*msymbol
,
414 std::vector
<symtab_and_line
> *result
);
416 static bool compare_symbols (const block_symbol
&a
, const block_symbol
&b
);
418 static bool compare_msymbols (const bound_minimal_symbol
&a
,
419 const bound_minimal_symbol
&b
);
421 /* Permitted quote characters for the parser. This is different from the
422 completer's quote characters to allow backward compatibility with the
424 static const char *const linespec_quote_characters
= "\"\'";
426 /* Lexer functions. */
428 /* Lex a number from the input in PARSER. This only supports
431 Return true if input is decimal numbers. Return false if not. */
434 linespec_lexer_lex_number (linespec_parser
*parser
, linespec_token
*tokenp
)
436 tokenp
->type
= LSTOKEN_NUMBER
;
437 LS_TOKEN_STOKEN (*tokenp
).length
= 0;
438 LS_TOKEN_STOKEN (*tokenp
).ptr
= PARSER_STREAM (parser
);
440 /* Keep any sign at the start of the stream. */
441 if (*PARSER_STREAM (parser
) == '+' || *PARSER_STREAM (parser
) == '-')
443 ++LS_TOKEN_STOKEN (*tokenp
).length
;
444 ++(PARSER_STREAM (parser
));
447 while (isdigit (*PARSER_STREAM (parser
)))
449 ++LS_TOKEN_STOKEN (*tokenp
).length
;
450 ++(PARSER_STREAM (parser
));
453 /* If the next character in the input buffer is not a space, comma,
454 quote, or colon, this input does not represent a number. */
455 if (*PARSER_STREAM (parser
) != '\0'
456 && !isspace (*PARSER_STREAM (parser
)) && *PARSER_STREAM (parser
) != ','
457 && *PARSER_STREAM (parser
) != ':'
458 && !strchr (linespec_quote_characters
, *PARSER_STREAM (parser
)))
460 PARSER_STREAM (parser
) = LS_TOKEN_STOKEN (*tokenp
).ptr
;
467 /* See linespec.h. */
470 linespec_lexer_lex_keyword (const char *p
)
476 for (i
= 0; linespec_keywords
[i
] != NULL
; ++i
)
478 int len
= strlen (linespec_keywords
[i
]);
480 /* If P begins with one of the keywords and the next
481 character is whitespace, we may have found a keyword.
482 It is only a keyword if it is not followed by another
484 if (strncmp (p
, linespec_keywords
[i
], len
) == 0
489 /* Special case: "if" ALWAYS stops the lexer, since it
490 is not possible to predict what is going to appear in
491 the condition, which can only be parsed after SaLs have
493 if (i
!= IF_KEYWORD_INDEX
)
497 for (j
= 0; linespec_keywords
[j
] != NULL
; ++j
)
499 int nextlen
= strlen (linespec_keywords
[j
]);
501 if (strncmp (p
, linespec_keywords
[j
], nextlen
) == 0
502 && isspace (p
[nextlen
]))
507 return linespec_keywords
[i
];
515 /* See description in linespec.h. */
518 is_ada_operator (const char *string
)
520 const struct ada_opname_map
*mapping
;
522 for (mapping
= ada_opname_table
;
523 mapping
->encoded
!= NULL
524 && !startswith (string
, mapping
->decoded
); ++mapping
)
527 return mapping
->decoded
== NULL
? 0 : strlen (mapping
->decoded
);
530 /* Find QUOTE_CHAR in STRING, accounting for the ':' terminal. Return
531 the location of QUOTE_CHAR, or NULL if not found. */
534 skip_quote_char (const char *string
, char quote_char
)
536 const char *p
, *last
;
538 p
= last
= find_toplevel_char (string
, quote_char
);
539 while (p
&& *p
!= '\0' && *p
!= ':')
541 p
= find_toplevel_char (p
, quote_char
);
549 /* Make a writable copy of the string given in TOKEN, trimming
550 any trailing whitespace. */
552 static gdb::unique_xmalloc_ptr
<char>
553 copy_token_string (linespec_token token
)
557 if (token
.type
== LSTOKEN_KEYWORD
)
558 return gdb::unique_xmalloc_ptr
<char> (xstrdup (LS_TOKEN_KEYWORD (token
)));
560 str
= LS_TOKEN_STOKEN (token
).ptr
;
561 s
= remove_trailing_whitespace (str
, str
+ LS_TOKEN_STOKEN (token
).length
);
563 return gdb::unique_xmalloc_ptr
<char> (savestring (str
, s
- str
));
566 /* Does P represent the end of a quote-enclosed linespec? */
569 is_closing_quote_enclosed (const char *p
)
571 if (strchr (linespec_quote_characters
, *p
))
573 p
= skip_spaces ((char *) p
);
574 return (*p
== '\0' || linespec_lexer_lex_keyword (p
));
577 /* Find the end of the parameter list that starts with *INPUT.
578 This helper function assists with lexing string segments
579 which might contain valid (non-terminating) commas. */
582 find_parameter_list_end (const char *input
)
584 char end_char
, start_char
;
589 if (start_char
== '(')
591 else if (start_char
== '<')
600 if (*p
== start_char
)
602 else if (*p
== end_char
)
616 /* If the [STRING, STRING_LEN) string ends with what looks like a
617 keyword, return the keyword start offset in STRING. Return -1
621 string_find_incomplete_keyword_at_end (const char * const *keywords
,
622 const char *string
, size_t string_len
)
624 const char *end
= string
+ string_len
;
627 while (p
> string
&& *p
!= ' ')
632 size_t len
= end
- p
;
633 for (size_t i
= 0; keywords
[i
] != NULL
; ++i
)
634 if (strncmp (keywords
[i
], p
, len
) == 0)
641 /* Lex a string from the input in PARSER. */
643 static linespec_token
644 linespec_lexer_lex_string (linespec_parser
*parser
)
646 linespec_token token
;
647 const char *start
= PARSER_STREAM (parser
);
649 token
.type
= LSTOKEN_STRING
;
651 /* If the input stream starts with a quote character, skip to the next
652 quote character, regardless of the content. */
653 if (strchr (linespec_quote_characters
, *PARSER_STREAM (parser
)))
656 char quote_char
= *PARSER_STREAM (parser
);
658 /* Special case: Ada operators. */
659 if (PARSER_STATE (parser
)->language
->la_language
== language_ada
660 && quote_char
== '\"')
662 int len
= is_ada_operator (PARSER_STREAM (parser
));
666 /* The input is an Ada operator. Return the quoted string
668 LS_TOKEN_STOKEN (token
).ptr
= PARSER_STREAM (parser
);
669 LS_TOKEN_STOKEN (token
).length
= len
;
670 PARSER_STREAM (parser
) += len
;
674 /* The input does not represent an Ada operator -- fall through
675 to normal quoted string handling. */
678 /* Skip past the beginning quote. */
679 ++(PARSER_STREAM (parser
));
681 /* Mark the start of the string. */
682 LS_TOKEN_STOKEN (token
).ptr
= PARSER_STREAM (parser
);
684 /* Skip to the ending quote. */
685 end
= skip_quote_char (PARSER_STREAM (parser
), quote_char
);
687 /* This helps the completer mode decide whether we have a
689 parser
->completion_quote_char
= quote_char
;
690 parser
->completion_quote_end
= end
;
692 /* Error if the input did not terminate properly, unless in
696 if (parser
->completion_tracker
== NULL
)
697 error (_("unmatched quote"));
699 /* In completion mode, we'll try to complete the incomplete
701 token
.type
= LSTOKEN_STRING
;
702 while (*PARSER_STREAM (parser
) != '\0')
703 PARSER_STREAM (parser
)++;
704 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - 1 - start
;
708 /* Skip over the ending quote and mark the length of the string. */
709 PARSER_STREAM (parser
) = (char *) ++end
;
710 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - 2 - start
;
717 /* Otherwise, only identifier characters are permitted.
718 Spaces are the exception. In general, we keep spaces,
719 but only if the next characters in the input do not resolve
720 to one of the keywords.
722 This allows users to forgo quoting CV-qualifiers, template arguments,
723 and similar common language constructs. */
727 if (isspace (*PARSER_STREAM (parser
)))
729 p
= skip_spaces (PARSER_STREAM (parser
));
730 /* When we get here we know we've found something followed by
731 a space (we skip over parens and templates below).
732 So if we find a keyword now, we know it is a keyword and not,
733 say, a function name. */
734 if (linespec_lexer_lex_keyword (p
) != NULL
)
736 LS_TOKEN_STOKEN (token
).ptr
= start
;
737 LS_TOKEN_STOKEN (token
).length
738 = PARSER_STREAM (parser
) - start
;
742 /* Advance past the whitespace. */
743 PARSER_STREAM (parser
) = p
;
746 /* If the next character is EOI or (single) ':', the
747 string is complete; return the token. */
748 if (*PARSER_STREAM (parser
) == 0)
750 LS_TOKEN_STOKEN (token
).ptr
= start
;
751 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - start
;
754 else if (PARSER_STREAM (parser
)[0] == ':')
756 /* Do not tokenize the C++ scope operator. */
757 if (PARSER_STREAM (parser
)[1] == ':')
758 ++(PARSER_STREAM (parser
));
760 /* Do not tokenize ABI tags such as "[abi:cxx11]". */
761 else if (PARSER_STREAM (parser
) - start
> 4
762 && startswith (PARSER_STREAM (parser
) - 4, "[abi"))
763 ++(PARSER_STREAM (parser
));
765 /* Do not tokenify if the input length so far is one
766 (i.e, a single-letter drive name) and the next character
767 is a directory separator. This allows Windows-style
768 paths to be recognized as filenames without quoting it. */
769 else if ((PARSER_STREAM (parser
) - start
) != 1
770 || !IS_DIR_SEPARATOR (PARSER_STREAM (parser
)[1]))
772 LS_TOKEN_STOKEN (token
).ptr
= start
;
773 LS_TOKEN_STOKEN (token
).length
774 = PARSER_STREAM (parser
) - start
;
778 /* Special case: permit quote-enclosed linespecs. */
779 else if (parser
->is_quote_enclosed
780 && strchr (linespec_quote_characters
,
781 *PARSER_STREAM (parser
))
782 && is_closing_quote_enclosed (PARSER_STREAM (parser
)))
784 LS_TOKEN_STOKEN (token
).ptr
= start
;
785 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - start
;
788 /* Because commas may terminate a linespec and appear in
789 the middle of valid string input, special cases for
790 '<' and '(' are necessary. */
791 else if (*PARSER_STREAM (parser
) == '<'
792 || *PARSER_STREAM (parser
) == '(')
794 /* Don't interpret 'operator<' / 'operator<<' as a
795 template parameter list though. */
796 if (*PARSER_STREAM (parser
) == '<'
797 && (PARSER_STATE (parser
)->language
->la_language
799 && (PARSER_STREAM (parser
) - start
) >= CP_OPERATOR_LEN
)
801 const char *op
= PARSER_STREAM (parser
);
803 while (op
> start
&& isspace (op
[-1]))
805 if (op
- start
>= CP_OPERATOR_LEN
)
807 op
-= CP_OPERATOR_LEN
;
808 if (strncmp (op
, CP_OPERATOR_STR
, CP_OPERATOR_LEN
) == 0
810 || !(isalnum (op
[-1]) || op
[-1] == '_')))
812 /* This is an operator name. Keep going. */
813 ++(PARSER_STREAM (parser
));
814 if (*PARSER_STREAM (parser
) == '<')
815 ++(PARSER_STREAM (parser
));
821 const char *end
= find_parameter_list_end (PARSER_STREAM (parser
));
822 PARSER_STREAM (parser
) = end
;
824 /* Don't loop around to the normal \0 case above because
825 we don't want to misinterpret a potential keyword at
826 the end of the token when the string isn't
827 "()<>"-balanced. This handles "b
828 function(thread<tab>" in completion mode. */
831 LS_TOKEN_STOKEN (token
).ptr
= start
;
832 LS_TOKEN_STOKEN (token
).length
833 = PARSER_STREAM (parser
) - start
;
839 /* Commas are terminators, but not if they are part of an
841 else if (*PARSER_STREAM (parser
) == ',')
843 if ((PARSER_STATE (parser
)->language
->la_language
845 && (PARSER_STREAM (parser
) - start
) > CP_OPERATOR_LEN
)
847 const char *op
= strstr (start
, CP_OPERATOR_STR
);
849 if (op
!= NULL
&& is_operator_name (op
))
851 /* This is an operator name. Keep going. */
852 ++(PARSER_STREAM (parser
));
857 /* Comma terminates the string. */
858 LS_TOKEN_STOKEN (token
).ptr
= start
;
859 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - start
;
863 /* Advance the stream. */
864 ++(PARSER_STREAM (parser
));
871 /* Lex a single linespec token from PARSER. */
873 static linespec_token
874 linespec_lexer_lex_one (linespec_parser
*parser
)
878 if (parser
->lexer
.current
.type
== LSTOKEN_CONSUMED
)
880 /* Skip any whitespace. */
881 PARSER_STREAM (parser
) = skip_spaces (PARSER_STREAM (parser
));
883 /* Check for a keyword, they end the linespec. */
884 keyword
= linespec_lexer_lex_keyword (PARSER_STREAM (parser
));
887 parser
->lexer
.current
.type
= LSTOKEN_KEYWORD
;
888 LS_TOKEN_KEYWORD (parser
->lexer
.current
) = keyword
;
889 /* We do not advance the stream here intentionally:
890 we would like lexing to stop when a keyword is seen.
892 PARSER_STREAM (parser) += strlen (keyword); */
894 return parser
->lexer
.current
;
897 /* Handle other tokens. */
898 switch (*PARSER_STREAM (parser
))
901 parser
->lexer
.current
.type
= LSTOKEN_EOI
;
905 case '0': case '1': case '2': case '3': case '4':
906 case '5': case '6': case '7': case '8': case '9':
907 if (!linespec_lexer_lex_number (parser
, &(parser
->lexer
.current
)))
908 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
912 /* If we have a scope operator, lex the input as a string.
913 Otherwise, return LSTOKEN_COLON. */
914 if (PARSER_STREAM (parser
)[1] == ':')
915 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
918 parser
->lexer
.current
.type
= LSTOKEN_COLON
;
919 ++(PARSER_STREAM (parser
));
923 case '\'': case '\"':
924 /* Special case: permit quote-enclosed linespecs. */
925 if (parser
->is_quote_enclosed
926 && is_closing_quote_enclosed (PARSER_STREAM (parser
)))
928 ++(PARSER_STREAM (parser
));
929 parser
->lexer
.current
.type
= LSTOKEN_EOI
;
932 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
936 parser
->lexer
.current
.type
= LSTOKEN_COMMA
;
937 LS_TOKEN_STOKEN (parser
->lexer
.current
).ptr
938 = PARSER_STREAM (parser
);
939 LS_TOKEN_STOKEN (parser
->lexer
.current
).length
= 1;
940 ++(PARSER_STREAM (parser
));
944 /* If the input is not a number, it must be a string.
945 [Keywords were already considered above.] */
946 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
951 return parser
->lexer
.current
;
954 /* Consume the current token and return the next token in PARSER's
955 input stream. Also advance the completion word for completion
958 static linespec_token
959 linespec_lexer_consume_token (linespec_parser
*parser
)
961 gdb_assert (parser
->lexer
.current
.type
!= LSTOKEN_EOI
);
963 bool advance_word
= (parser
->lexer
.current
.type
!= LSTOKEN_STRING
964 || *PARSER_STREAM (parser
) != '\0');
966 /* If we're moving past a string to some other token, it must be the
967 quote was terminated. */
968 if (parser
->completion_quote_char
)
970 gdb_assert (parser
->lexer
.current
.type
== LSTOKEN_STRING
);
972 /* If the string was the last (non-EOI) token, we're past the
973 quote, but remember that for later. */
974 if (*PARSER_STREAM (parser
) != '\0')
976 parser
->completion_quote_char
= '\0';
977 parser
->completion_quote_end
= NULL
;;
981 parser
->lexer
.current
.type
= LSTOKEN_CONSUMED
;
982 linespec_lexer_lex_one (parser
);
984 if (parser
->lexer
.current
.type
== LSTOKEN_STRING
)
986 /* Advance the completion word past a potential initial
988 parser
->completion_word
= LS_TOKEN_STOKEN (parser
->lexer
.current
).ptr
;
990 else if (advance_word
)
992 /* Advance the completion word past any whitespace. */
993 parser
->completion_word
= PARSER_STREAM (parser
);
996 return parser
->lexer
.current
;
999 /* Return the next token without consuming the current token. */
1001 static linespec_token
1002 linespec_lexer_peek_token (linespec_parser
*parser
)
1004 linespec_token next
;
1005 const char *saved_stream
= PARSER_STREAM (parser
);
1006 linespec_token saved_token
= parser
->lexer
.current
;
1007 int saved_completion_quote_char
= parser
->completion_quote_char
;
1008 const char *saved_completion_quote_end
= parser
->completion_quote_end
;
1009 const char *saved_completion_word
= parser
->completion_word
;
1011 next
= linespec_lexer_consume_token (parser
);
1012 PARSER_STREAM (parser
) = saved_stream
;
1013 parser
->lexer
.current
= saved_token
;
1014 parser
->completion_quote_char
= saved_completion_quote_char
;
1015 parser
->completion_quote_end
= saved_completion_quote_end
;
1016 parser
->completion_word
= saved_completion_word
;
1020 /* Helper functions. */
1022 /* Add SAL to SALS, and also update SELF->CANONICAL_NAMES to reflect
1023 the new sal, if needed. If not NULL, SYMNAME is the name of the
1024 symbol to use when constructing the new canonical name.
1026 If LITERAL_CANONICAL is non-zero, SYMNAME will be used as the
1027 canonical name for the SAL. */
1030 add_sal_to_sals (struct linespec_state
*self
,
1031 std::vector
<symtab_and_line
> *sals
,
1032 struct symtab_and_line
*sal
,
1033 const char *symname
, int literal_canonical
)
1035 sals
->push_back (*sal
);
1037 if (self
->canonical
)
1039 struct linespec_canonical_name
*canonical
;
1041 self
->canonical_names
= XRESIZEVEC (struct linespec_canonical_name
,
1042 self
->canonical_names
,
1044 canonical
= &self
->canonical_names
[sals
->size () - 1];
1045 if (!literal_canonical
&& sal
->symtab
)
1047 symtab_to_fullname (sal
->symtab
);
1049 /* Note that the filter doesn't have to be a valid linespec
1050 input. We only apply the ":LINE" treatment to Ada for
1052 if (symname
!= NULL
&& sal
->line
!= 0
1053 && self
->language
->la_language
== language_ada
)
1054 canonical
->suffix
= xstrprintf ("%s:%d", symname
, sal
->line
);
1055 else if (symname
!= NULL
)
1056 canonical
->suffix
= xstrdup (symname
);
1058 canonical
->suffix
= xstrprintf ("%d", sal
->line
);
1059 canonical
->symtab
= sal
->symtab
;
1063 if (symname
!= NULL
)
1064 canonical
->suffix
= xstrdup (symname
);
1066 canonical
->suffix
= xstrdup ("<unknown>");
1067 canonical
->symtab
= NULL
;
1072 /* A hash function for address_entry. */
1075 hash_address_entry (const void *p
)
1077 const struct address_entry
*aep
= (const struct address_entry
*) p
;
1080 hash
= iterative_hash_object (aep
->pspace
, 0);
1081 return iterative_hash_object (aep
->addr
, hash
);
1084 /* An equality function for address_entry. */
1087 eq_address_entry (const void *a
, const void *b
)
1089 const struct address_entry
*aea
= (const struct address_entry
*) a
;
1090 const struct address_entry
*aeb
= (const struct address_entry
*) b
;
1092 return aea
->pspace
== aeb
->pspace
&& aea
->addr
== aeb
->addr
;
1095 /* Check whether the address, represented by PSPACE and ADDR, is
1096 already in the set. If so, return 0. Otherwise, add it and return
1100 maybe_add_address (htab_t set
, struct program_space
*pspace
, CORE_ADDR addr
)
1102 struct address_entry e
, *p
;
1107 slot
= htab_find_slot (set
, &e
, INSERT
);
1111 p
= XNEW (struct address_entry
);
1112 memcpy (p
, &e
, sizeof (struct address_entry
));
1118 /* A helper that walks over all matching symtabs in all objfiles and
1119 calls CALLBACK for each symbol matching NAME. If SEARCH_PSPACE is
1120 not NULL, then the search is restricted to just that program
1121 space. If INCLUDE_INLINE is true then symbols representing
1122 inlined instances of functions will be included in the result. */
1125 iterate_over_all_matching_symtabs
1126 (struct linespec_state
*state
,
1127 const lookup_name_info
&lookup_name
,
1128 const domain_enum name_domain
,
1129 enum search_domain search_domain
,
1130 struct program_space
*search_pspace
, bool include_inline
,
1131 gdb::function_view
<symbol_found_callback_ftype
> callback
)
1133 struct program_space
*pspace
;
1135 ALL_PSPACES (pspace
)
1137 if (search_pspace
!= NULL
&& search_pspace
!= pspace
)
1139 if (pspace
->executing_startup
)
1142 set_current_program_space (pspace
);
1144 for (objfile
*objfile
: all_objfiles (current_program_space
))
1146 struct compunit_symtab
*cu
;
1149 objfile
->sf
->qf
->expand_symtabs_matching (objfile
,
1155 ALL_OBJFILE_COMPUNITS (objfile
, cu
)
1157 struct symtab
*symtab
= COMPUNIT_FILETABS (cu
);
1159 iterate_over_file_blocks (symtab
, lookup_name
, name_domain
,
1164 struct block
*block
;
1167 for (i
= FIRST_LOCAL_BLOCK
;
1168 i
< BLOCKVECTOR_NBLOCKS (SYMTAB_BLOCKVECTOR (symtab
));
1171 block
= BLOCKVECTOR_BLOCK (SYMTAB_BLOCKVECTOR (symtab
), i
);
1172 state
->language
->la_iterate_over_symbols
1173 (block
, lookup_name
, name_domain
,
1174 [&] (block_symbol
*bsym
)
1176 /* Restrict calls to CALLBACK to symbols
1177 representing inline symbols only. */
1178 if (SYMBOL_INLINED (bsym
->symbol
))
1179 return callback (bsym
);
1189 /* Returns the block to be used for symbol searches from
1190 the current location. */
1192 static const struct block
*
1193 get_current_search_block (void)
1195 const struct block
*block
;
1196 enum language save_language
;
1198 /* get_selected_block can change the current language when there is
1199 no selected frame yet. */
1200 save_language
= current_language
->la_language
;
1201 block
= get_selected_block (0);
1202 set_language (save_language
);
1207 /* Iterate over static and global blocks. */
1210 iterate_over_file_blocks
1211 (struct symtab
*symtab
, const lookup_name_info
&name
,
1212 domain_enum domain
, gdb::function_view
<symbol_found_callback_ftype
> callback
)
1214 struct block
*block
;
1216 for (block
= BLOCKVECTOR_BLOCK (SYMTAB_BLOCKVECTOR (symtab
), STATIC_BLOCK
);
1218 block
= BLOCK_SUPERBLOCK (block
))
1219 LA_ITERATE_OVER_SYMBOLS (block
, name
, domain
, callback
);
1222 /* A helper for find_method. This finds all methods in type T of
1223 language T_LANG which match NAME. It adds matching symbol names to
1224 RESULT_NAMES, and adds T's direct superclasses to SUPERCLASSES. */
1227 find_methods (struct type
*t
, enum language t_lang
, const char *name
,
1228 std::vector
<const char *> *result_names
,
1229 std::vector
<struct type
*> *superclasses
)
1232 const char *class_name
= TYPE_NAME (t
);
1234 /* Ignore this class if it doesn't have a name. This is ugly, but
1235 unless we figure out how to get the physname without the name of
1236 the class, then the loop can't do any good. */
1240 lookup_name_info
lookup_name (name
, symbol_name_match_type::FULL
);
1241 symbol_name_matcher_ftype
*symbol_name_compare
1242 = get_symbol_name_matcher (language_def (t_lang
), lookup_name
);
1244 t
= check_typedef (t
);
1246 /* Loop over each method name. At this level, all overloads of a name
1247 are counted as a single name. There is an inner loop which loops over
1250 for (method_counter
= TYPE_NFN_FIELDS (t
) - 1;
1251 method_counter
>= 0;
1254 const char *method_name
= TYPE_FN_FIELDLIST_NAME (t
, method_counter
);
1256 if (symbol_name_compare (method_name
, lookup_name
, NULL
))
1260 for (field_counter
= (TYPE_FN_FIELDLIST_LENGTH (t
, method_counter
)
1266 const char *phys_name
;
1268 f
= TYPE_FN_FIELDLIST1 (t
, method_counter
);
1269 if (TYPE_FN_FIELD_STUB (f
, field_counter
))
1271 phys_name
= TYPE_FN_FIELD_PHYSNAME (f
, field_counter
);
1272 result_names
->push_back (phys_name
);
1278 for (ibase
= 0; ibase
< TYPE_N_BASECLASSES (t
); ibase
++)
1279 superclasses
->push_back (TYPE_BASECLASS (t
, ibase
));
1282 /* Find an instance of the character C in the string S that is outside
1283 of all parenthesis pairs, single-quoted strings, and double-quoted
1284 strings. Also, ignore the char within a template name, like a ','
1285 within foo<int, int>, while considering C++ operator</operator<<. */
1288 find_toplevel_char (const char *s
, char c
)
1290 int quoted
= 0; /* zero if we're not in quotes;
1291 '"' if we're in a double-quoted string;
1292 '\'' if we're in a single-quoted string. */
1293 int depth
= 0; /* Number of unclosed parens we've seen. */
1296 for (scan
= s
; *scan
; scan
++)
1300 if (*scan
== quoted
)
1302 else if (*scan
== '\\' && *(scan
+ 1))
1305 else if (*scan
== c
&& ! quoted
&& depth
== 0)
1307 else if (*scan
== '"' || *scan
== '\'')
1309 else if (*scan
== '(' || *scan
== '<')
1311 else if ((*scan
== ')' || *scan
== '>') && depth
> 0)
1313 else if (*scan
== 'o' && !quoted
&& depth
== 0)
1315 /* Handle C++ operator names. */
1316 if (strncmp (scan
, CP_OPERATOR_STR
, CP_OPERATOR_LEN
) == 0)
1318 scan
+= CP_OPERATOR_LEN
;
1321 while (isspace (*scan
))
1332 /* Skip over one less than the appropriate number of
1333 characters: the for loop will skip over the last
1359 /* The string equivalent of find_toplevel_char. Returns a pointer
1360 to the location of NEEDLE in HAYSTACK, ignoring any occurrences
1361 inside "()" and "<>". Returns NULL if NEEDLE was not found. */
1364 find_toplevel_string (const char *haystack
, const char *needle
)
1366 const char *s
= haystack
;
1370 s
= find_toplevel_char (s
, *needle
);
1374 /* Found first char in HAYSTACK; check rest of string. */
1375 if (startswith (s
, needle
))
1378 /* Didn't find it; loop over HAYSTACK, looking for the next
1379 instance of the first character of NEEDLE. */
1383 while (s
!= NULL
&& *s
!= '\0');
1385 /* NEEDLE was not found in HAYSTACK. */
1389 /* Convert CANONICAL to its string representation using
1390 symtab_to_fullname for SYMTAB. */
1393 canonical_to_fullform (const struct linespec_canonical_name
*canonical
)
1395 if (canonical
->symtab
== NULL
)
1396 return canonical
->suffix
;
1398 return string_printf ("%s:%s", symtab_to_fullname (canonical
->symtab
),
1402 /* Given FILTERS, a list of canonical names, filter the sals in RESULT
1403 and store the result in SELF->CANONICAL. */
1406 filter_results (struct linespec_state
*self
,
1407 std::vector
<symtab_and_line
> *result
,
1408 const std::vector
<const char *> &filters
)
1410 for (const char *name
: filters
)
1414 for (size_t j
= 0; j
< result
->size (); ++j
)
1416 const struct linespec_canonical_name
*canonical
;
1418 canonical
= &self
->canonical_names
[j
];
1419 std::string fullform
= canonical_to_fullform (canonical
);
1421 if (name
== fullform
)
1422 lsal
.sals
.push_back ((*result
)[j
]);
1425 if (!lsal
.sals
.empty ())
1427 lsal
.canonical
= xstrdup (name
);
1428 self
->canonical
->lsals
.push_back (std::move (lsal
));
1432 self
->canonical
->pre_expanded
= 0;
1435 /* Store RESULT into SELF->CANONICAL. */
1438 convert_results_to_lsals (struct linespec_state
*self
,
1439 std::vector
<symtab_and_line
> *result
)
1441 struct linespec_sals lsal
;
1443 lsal
.canonical
= NULL
;
1444 lsal
.sals
= std::move (*result
);
1445 self
->canonical
->lsals
.push_back (std::move (lsal
));
1448 /* A structure that contains two string representations of a struct
1449 linespec_canonical_name:
1450 - one where the the symtab's fullname is used;
1451 - one where the filename followed the "set filename-display"
1454 struct decode_line_2_item
1456 decode_line_2_item (std::string
&&fullform_
, std::string
&&displayform_
,
1458 : fullform (std::move (fullform_
)),
1459 displayform (std::move (displayform_
)),
1460 selected (selected_
)
1464 /* The form using symtab_to_fullname. */
1465 std::string fullform
;
1467 /* The form using symtab_to_filename_for_display. */
1468 std::string displayform
;
1470 /* Field is initialized to zero and it is set to one if the user
1471 requested breakpoint for this entry. */
1472 unsigned int selected
: 1;
1475 /* Helper for std::sort to sort decode_line_2_item entries by
1476 DISPLAYFORM and secondarily by FULLFORM. */
1479 decode_line_2_compare_items (const decode_line_2_item
&a
,
1480 const decode_line_2_item
&b
)
1482 if (a
.displayform
!= b
.displayform
)
1483 return a
.displayform
< b
.displayform
;
1484 return 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 std::vector
<const char *> filters
;
1501 std::vector
<struct decode_line_2_item
> items
;
1503 gdb_assert (select_mode
!= multiple_symbols_all
);
1504 gdb_assert (self
->canonical
!= NULL
);
1505 gdb_assert (!result
->empty ());
1507 /* Prepare ITEMS array. */
1508 for (i
= 0; i
< result
->size (); ++i
)
1510 const struct linespec_canonical_name
*canonical
;
1511 std::string displayform
;
1513 canonical
= &self
->canonical_names
[i
];
1514 gdb_assert (canonical
->suffix
!= NULL
);
1516 std::string fullform
= canonical_to_fullform (canonical
);
1518 if (canonical
->symtab
== NULL
)
1519 displayform
= canonical
->suffix
;
1522 const char *fn_for_display
;
1524 fn_for_display
= symtab_to_filename_for_display (canonical
->symtab
);
1525 displayform
= string_printf ("%s:%s", fn_for_display
,
1529 items
.emplace_back (std::move (fullform
), std::move (displayform
),
1533 /* Sort the list of method names. */
1534 std::sort (items
.begin (), items
.end (), decode_line_2_compare_items
);
1536 /* Remove entries with the same FULLFORM. */
1537 items
.erase (std::unique (items
.begin (), items
.end (),
1538 [] (const struct decode_line_2_item
&a
,
1539 const struct decode_line_2_item
&b
)
1541 return a
.fullform
== b
.fullform
;
1545 if (select_mode
== multiple_symbols_cancel
&& items
.size () > 1)
1546 error (_("canceled because the command is ambiguous\n"
1547 "See set/show multiple-symbol."));
1549 if (select_mode
== multiple_symbols_all
|| items
.size () == 1)
1551 convert_results_to_lsals (self
, result
);
1555 printf_unfiltered (_("[0] cancel\n[1] all\n"));
1556 for (i
= 0; i
< items
.size (); i
++)
1557 printf_unfiltered ("[%d] %s\n", i
+ 2, items
[i
].displayform
.c_str ());
1559 prompt
= getenv ("PS2");
1564 args
= command_line_input (prompt
, "overload-choice");
1566 if (args
== 0 || *args
== 0)
1567 error_no_arg (_("one or more choice numbers"));
1569 number_or_range_parser
parser (args
);
1570 while (!parser
.finished ())
1572 int num
= parser
.get_number ();
1575 error (_("canceled"));
1578 /* We intentionally make this result in a single breakpoint,
1579 contrary to what older versions of gdb did. The
1580 rationale is that this lets a user get the
1581 multiple_symbols_all behavior even with the 'ask'
1582 setting; and he can get separate breakpoints by entering
1583 "2-57" at the query. */
1584 convert_results_to_lsals (self
, result
);
1589 if (num
>= items
.size ())
1590 printf_unfiltered (_("No choice number %d.\n"), num
);
1593 struct decode_line_2_item
*item
= &items
[num
];
1595 if (!item
->selected
)
1597 filters
.push_back (item
->fullform
.c_str ());
1602 printf_unfiltered (_("duplicate request for %d ignored.\n"),
1608 filter_results (self
, result
, filters
);
1613 /* The parser of linespec itself. */
1615 /* Throw an appropriate error when SYMBOL is not found (optionally in
1618 static void ATTRIBUTE_NORETURN
1619 symbol_not_found_error (const char *symbol
, const char *filename
)
1624 if (!have_full_symbols ()
1625 && !have_partial_symbols ()
1626 && !have_minimal_symbols ())
1627 throw_error (NOT_FOUND_ERROR
,
1628 _("No symbol table is loaded. Use the \"file\" command."));
1630 /* If SYMBOL starts with '$', the user attempted to either lookup
1631 a function/variable in his code starting with '$' or an internal
1632 variable of that name. Since we do not know which, be concise and
1633 explain both possibilities. */
1637 throw_error (NOT_FOUND_ERROR
,
1638 _("Undefined convenience variable or function \"%s\" "
1639 "not defined in \"%s\"."), symbol
, filename
);
1641 throw_error (NOT_FOUND_ERROR
,
1642 _("Undefined convenience variable or function \"%s\" "
1643 "not defined."), symbol
);
1648 throw_error (NOT_FOUND_ERROR
,
1649 _("Function \"%s\" not defined in \"%s\"."),
1652 throw_error (NOT_FOUND_ERROR
,
1653 _("Function \"%s\" not defined."), symbol
);
1657 /* Throw an appropriate error when an unexpected token is encountered
1660 static void ATTRIBUTE_NORETURN
1661 unexpected_linespec_error (linespec_parser
*parser
)
1663 linespec_token token
;
1664 static const char * token_type_strings
[]
1665 = {"keyword", "colon", "string", "number", "comma", "end of input"};
1667 /* Get the token that generated the error. */
1668 token
= linespec_lexer_lex_one (parser
);
1670 /* Finally, throw the error. */
1671 if (token
.type
== LSTOKEN_STRING
|| token
.type
== LSTOKEN_NUMBER
1672 || token
.type
== LSTOKEN_KEYWORD
)
1674 gdb::unique_xmalloc_ptr
<char> string
= copy_token_string (token
);
1675 throw_error (GENERIC_ERROR
,
1676 _("malformed linespec error: unexpected %s, \"%s\""),
1677 token_type_strings
[token
.type
], string
.get ());
1680 throw_error (GENERIC_ERROR
,
1681 _("malformed linespec error: unexpected %s"),
1682 token_type_strings
[token
.type
]);
1685 /* Throw an undefined label error. */
1687 static void ATTRIBUTE_NORETURN
1688 undefined_label_error (const char *function
, const char *label
)
1690 if (function
!= NULL
)
1691 throw_error (NOT_FOUND_ERROR
,
1692 _("No label \"%s\" defined in function \"%s\"."),
1695 throw_error (NOT_FOUND_ERROR
,
1696 _("No label \"%s\" defined in current function."),
1700 /* Throw a source file not found error. */
1702 static void ATTRIBUTE_NORETURN
1703 source_file_not_found_error (const char *name
)
1705 throw_error (NOT_FOUND_ERROR
, _("No source file named %s."), name
);
1708 /* Unless at EIO, save the current stream position as completion word
1709 point, and consume the next token. */
1711 static linespec_token
1712 save_stream_and_consume_token (linespec_parser
*parser
)
1714 if (linespec_lexer_peek_token (parser
).type
!= LSTOKEN_EOI
)
1715 parser
->completion_word
= PARSER_STREAM (parser
);
1716 return linespec_lexer_consume_token (parser
);
1719 /* See description in linespec.h. */
1722 linespec_parse_line_offset (const char *string
)
1724 const char *start
= string
;
1725 struct line_offset line_offset
= {0, LINE_OFFSET_NONE
};
1729 line_offset
.sign
= LINE_OFFSET_PLUS
;
1732 else if (*string
== '-')
1734 line_offset
.sign
= LINE_OFFSET_MINUS
;
1738 if (*string
!= '\0' && !isdigit (*string
))
1739 error (_("malformed line offset: \"%s\""), start
);
1741 /* Right now, we only allow base 10 for offsets. */
1742 line_offset
.offset
= atoi (string
);
1746 /* In completion mode, if the user is still typing the number, there's
1747 no possible completion to offer. But if there's already input past
1748 the number, setup to expect NEXT. */
1751 set_completion_after_number (linespec_parser
*parser
,
1752 linespec_complete_what next
)
1754 if (*PARSER_STREAM (parser
) == ' ')
1756 parser
->completion_word
= skip_spaces (PARSER_STREAM (parser
) + 1);
1757 parser
->complete_what
= next
;
1761 parser
->completion_word
= PARSER_STREAM (parser
);
1762 parser
->complete_what
= linespec_complete_what::NOTHING
;
1766 /* Parse the basic_spec in PARSER's input. */
1769 linespec_parse_basic (linespec_parser
*parser
)
1771 gdb::unique_xmalloc_ptr
<char> name
;
1772 linespec_token token
;
1773 std::vector
<block_symbol
> symbols
;
1774 std::vector
<block_symbol
> *labels
;
1775 std::vector
<bound_minimal_symbol
> minimal_symbols
;
1777 /* Get the next token. */
1778 token
= linespec_lexer_lex_one (parser
);
1780 /* If it is EOI or KEYWORD, issue an error. */
1781 if (token
.type
== LSTOKEN_KEYWORD
)
1783 parser
->complete_what
= linespec_complete_what::NOTHING
;
1784 unexpected_linespec_error (parser
);
1786 else if (token
.type
== LSTOKEN_EOI
)
1788 unexpected_linespec_error (parser
);
1790 /* If it is a LSTOKEN_NUMBER, we have an offset. */
1791 else if (token
.type
== LSTOKEN_NUMBER
)
1793 set_completion_after_number (parser
, linespec_complete_what::KEYWORD
);
1795 /* Record the line offset and get the next token. */
1796 name
= copy_token_string (token
);
1797 PARSER_EXPLICIT (parser
)->line_offset
1798 = linespec_parse_line_offset (name
.get ());
1800 /* Get the next token. */
1801 token
= linespec_lexer_consume_token (parser
);
1803 /* If the next token is a comma, stop parsing and return. */
1804 if (token
.type
== LSTOKEN_COMMA
)
1806 parser
->complete_what
= linespec_complete_what::NOTHING
;
1810 /* If the next token is anything but EOI or KEYWORD, issue
1812 if (token
.type
!= LSTOKEN_KEYWORD
&& token
.type
!= LSTOKEN_EOI
)
1813 unexpected_linespec_error (parser
);
1816 if (token
.type
== LSTOKEN_KEYWORD
|| token
.type
== LSTOKEN_EOI
)
1819 /* Next token must be LSTOKEN_STRING. */
1820 if (token
.type
!= LSTOKEN_STRING
)
1822 parser
->complete_what
= linespec_complete_what::NOTHING
;
1823 unexpected_linespec_error (parser
);
1826 /* The current token will contain the name of a function, method,
1828 name
= copy_token_string (token
);
1830 if (parser
->completion_tracker
!= NULL
)
1832 /* If the function name ends with a ":", then this may be an
1833 incomplete "::" scope operator instead of a label separator.
1836 which should expand to:
1839 Do a tentative completion assuming the later. If we find
1840 completions, advance the stream past the colon token and make
1841 it part of the function name/token. */
1843 if (!parser
->completion_quote_char
1844 && strcmp (PARSER_STREAM (parser
), ":") == 0)
1846 completion_tracker tmp_tracker
;
1847 const char *source_filename
1848 = PARSER_EXPLICIT (parser
)->source_filename
;
1849 symbol_name_match_type match_type
1850 = PARSER_EXPLICIT (parser
)->func_name_match_type
;
1852 linespec_complete_function (tmp_tracker
,
1853 parser
->completion_word
,
1857 if (tmp_tracker
.have_completions ())
1859 PARSER_STREAM (parser
)++;
1860 LS_TOKEN_STOKEN (token
).length
++;
1862 name
.reset (savestring (parser
->completion_word
,
1863 (PARSER_STREAM (parser
)
1864 - parser
->completion_word
)));
1868 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1872 /* Try looking it up as a function/method. */
1873 find_linespec_symbols (PARSER_STATE (parser
),
1874 PARSER_RESULT (parser
)->file_symtabs
, name
.get (),
1875 PARSER_EXPLICIT (parser
)->func_name_match_type
,
1876 &symbols
, &minimal_symbols
);
1878 if (!symbols
.empty () || !minimal_symbols
.empty ())
1880 PARSER_RESULT (parser
)->function_symbols
1881 = new std::vector
<block_symbol
> (std::move (symbols
));
1882 PARSER_RESULT (parser
)->minimal_symbols
1883 = new std::vector
<bound_minimal_symbol
>
1884 (std::move (minimal_symbols
));
1885 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1889 /* NAME was not a function or a method. So it must be a label
1890 name or user specified variable like "break foo.c:$zippo". */
1891 labels
= find_label_symbols (PARSER_STATE (parser
), NULL
,
1892 &symbols
, name
.get ());
1895 PARSER_RESULT (parser
)->labels
.label_symbols
= labels
;
1896 PARSER_RESULT (parser
)->labels
.function_symbols
1897 = new std::vector
<block_symbol
> (std::move (symbols
));
1898 PARSER_EXPLICIT (parser
)->label_name
= name
.release ();
1900 else if (token
.type
== LSTOKEN_STRING
1901 && *LS_TOKEN_STOKEN (token
).ptr
== '$')
1903 /* User specified a convenience variable or history value. */
1904 PARSER_EXPLICIT (parser
)->line_offset
1905 = linespec_parse_variable (PARSER_STATE (parser
), name
.get ());
1907 if (PARSER_EXPLICIT (parser
)->line_offset
.sign
== LINE_OFFSET_UNKNOWN
)
1909 /* The user-specified variable was not valid. Do not
1910 throw an error here. parse_linespec will do it for us. */
1911 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1917 /* The name is also not a label. Abort parsing. Do not throw
1918 an error here. parse_linespec will do it for us. */
1920 /* Save a copy of the name we were trying to lookup. */
1921 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1927 int previous_qc
= parser
->completion_quote_char
;
1929 /* Get the next token. */
1930 token
= linespec_lexer_consume_token (parser
);
1932 if (token
.type
== LSTOKEN_EOI
)
1934 if (previous_qc
&& !parser
->completion_quote_char
)
1935 parser
->complete_what
= linespec_complete_what::KEYWORD
;
1937 else if (token
.type
== LSTOKEN_COLON
)
1939 /* User specified a label or a lineno. */
1940 token
= linespec_lexer_consume_token (parser
);
1942 if (token
.type
== LSTOKEN_NUMBER
)
1944 /* User specified an offset. Record the line offset and
1945 get the next token. */
1946 set_completion_after_number (parser
, linespec_complete_what::KEYWORD
);
1948 name
= copy_token_string (token
);
1949 PARSER_EXPLICIT (parser
)->line_offset
1950 = linespec_parse_line_offset (name
.get ());
1952 /* Get the next token. */
1953 token
= linespec_lexer_consume_token (parser
);
1955 else if (token
.type
== LSTOKEN_EOI
&& parser
->completion_tracker
!= NULL
)
1957 parser
->complete_what
= linespec_complete_what::LABEL
;
1959 else if (token
.type
== LSTOKEN_STRING
)
1961 parser
->complete_what
= linespec_complete_what::LABEL
;
1963 /* If we have text after the label separated by whitespace
1964 (e.g., "b func():lab i<tab>"), don't consider it part of
1965 the label. In completion mode that should complete to
1966 "if", in normal mode, the 'i' should be treated as
1968 if (parser
->completion_quote_char
== '\0')
1970 const char *ptr
= LS_TOKEN_STOKEN (token
).ptr
;
1971 for (size_t i
= 0; i
< LS_TOKEN_STOKEN (token
).length
; i
++)
1975 LS_TOKEN_STOKEN (token
).length
= i
;
1976 PARSER_STREAM (parser
) = skip_spaces (ptr
+ i
+ 1);
1982 if (parser
->completion_tracker
!= NULL
)
1984 if (PARSER_STREAM (parser
)[-1] == ' ')
1986 parser
->completion_word
= PARSER_STREAM (parser
);
1987 parser
->complete_what
= linespec_complete_what::KEYWORD
;
1992 /* Grab a copy of the label's name and look it up. */
1993 name
= copy_token_string (token
);
1995 = find_label_symbols (PARSER_STATE (parser
),
1996 PARSER_RESULT (parser
)->function_symbols
,
1997 &symbols
, name
.get ());
2001 PARSER_RESULT (parser
)->labels
.label_symbols
= labels
;
2002 PARSER_RESULT (parser
)->labels
.function_symbols
2003 = new std::vector
<block_symbol
> (std::move (symbols
));
2004 PARSER_EXPLICIT (parser
)->label_name
= name
.release ();
2008 /* We don't know what it was, but it isn't a label. */
2009 undefined_label_error
2010 (PARSER_EXPLICIT (parser
)->function_name
, name
.get ());
2015 /* Check for a line offset. */
2016 token
= save_stream_and_consume_token (parser
);
2017 if (token
.type
== LSTOKEN_COLON
)
2019 /* Get the next token. */
2020 token
= linespec_lexer_consume_token (parser
);
2022 /* It must be a line offset. */
2023 if (token
.type
!= LSTOKEN_NUMBER
)
2024 unexpected_linespec_error (parser
);
2026 /* Record the line offset and get the next token. */
2027 name
= copy_token_string (token
);
2029 PARSER_EXPLICIT (parser
)->line_offset
2030 = linespec_parse_line_offset (name
.get ());
2032 /* Get the next token. */
2033 token
= linespec_lexer_consume_token (parser
);
2038 /* Trailing ':' in the input. Issue an error. */
2039 unexpected_linespec_error (parser
);
2044 /* Canonicalize the linespec contained in LS. The result is saved into
2045 STATE->canonical. This function handles both linespec and explicit
2049 canonicalize_linespec (struct linespec_state
*state
, const linespec_p ls
)
2051 struct event_location
*canon
;
2052 struct explicit_location
*explicit_loc
;
2054 /* If canonicalization was not requested, no need to do anything. */
2055 if (!state
->canonical
)
2058 /* Save everything as an explicit location. */
2059 state
->canonical
->location
2060 = new_explicit_location (&ls
->explicit_loc
);
2061 canon
= state
->canonical
->location
.get ();
2062 explicit_loc
= get_explicit_location (canon
);
2064 if (explicit_loc
->label_name
!= NULL
)
2066 state
->canonical
->special_display
= 1;
2068 if (explicit_loc
->function_name
== NULL
)
2070 /* No function was specified, so add the symbol name. */
2071 gdb_assert (!ls
->labels
.function_symbols
->empty ()
2072 && (ls
->labels
.function_symbols
->size () == 1));
2073 block_symbol s
= ls
->labels
.function_symbols
->front ();
2074 explicit_loc
->function_name
2075 = xstrdup (SYMBOL_NATURAL_NAME (s
.symbol
));
2079 /* If this location originally came from a linespec, save a string
2080 representation of it for display and saving to file. */
2081 if (state
->is_linespec
)
2083 char *linespec
= explicit_location_to_linespec (explicit_loc
);
2085 set_event_location_string (canon
, linespec
);
2090 /* Given a line offset in LS, construct the relevant SALs. */
2092 static std::vector
<symtab_and_line
>
2093 create_sals_line_offset (struct linespec_state
*self
,
2096 int use_default
= 0;
2098 /* This is where we need to make sure we have good defaults.
2099 We must guarantee that this section of code is never executed
2100 when we are called with just a function name, since
2101 set_default_source_symtab_and_line uses
2102 select_source_symtab that calls us with such an argument. */
2104 if (ls
->file_symtabs
->size () == 1
2105 && ls
->file_symtabs
->front () == nullptr)
2107 const char *fullname
;
2109 set_current_program_space (self
->program_space
);
2111 /* Make sure we have at least a default source line. */
2112 set_default_source_symtab_and_line ();
2113 initialize_defaults (&self
->default_symtab
, &self
->default_line
);
2114 fullname
= symtab_to_fullname (self
->default_symtab
);
2116 = collect_symtabs_from_filename (fullname
, self
->search_pspace
);
2120 symtab_and_line val
;
2121 val
.line
= ls
->explicit_loc
.line_offset
.offset
;
2122 switch (ls
->explicit_loc
.line_offset
.sign
)
2124 case LINE_OFFSET_PLUS
:
2125 if (ls
->explicit_loc
.line_offset
.offset
== 0)
2128 val
.line
= self
->default_line
+ val
.line
;
2131 case LINE_OFFSET_MINUS
:
2132 if (ls
->explicit_loc
.line_offset
.offset
== 0)
2135 val
.line
= self
->default_line
- val
.line
;
2137 val
.line
= -val
.line
;
2140 case LINE_OFFSET_NONE
:
2141 break; /* No need to adjust val.line. */
2144 std::vector
<symtab_and_line
> values
;
2145 if (self
->list_mode
)
2146 values
= decode_digits_list_mode (self
, ls
, val
);
2149 struct linetable_entry
*best_entry
= NULL
;
2152 std::vector
<symtab_and_line
> intermediate_results
2153 = decode_digits_ordinary (self
, ls
, val
.line
, &best_entry
);
2154 if (intermediate_results
.empty () && best_entry
!= NULL
)
2155 intermediate_results
= decode_digits_ordinary (self
, ls
,
2159 /* For optimized code, the compiler can scatter one source line
2160 across disjoint ranges of PC values, even when no duplicate
2161 functions or inline functions are involved. For example,
2162 'for (;;)' inside a non-template, non-inline, and non-ctor-or-dtor
2163 function can result in two PC ranges. In this case, we don't
2164 want to set a breakpoint on the first PC of each range. To filter
2165 such cases, we use containing blocks -- for each PC found
2166 above, we see if there are other PCs that are in the same
2167 block. If yes, the other PCs are filtered out. */
2169 gdb::def_vector
<int> filter (intermediate_results
.size ());
2170 gdb::def_vector
<const block
*> blocks (intermediate_results
.size ());
2172 for (i
= 0; i
< intermediate_results
.size (); ++i
)
2174 set_current_program_space (intermediate_results
[i
].pspace
);
2177 blocks
[i
] = block_for_pc_sect (intermediate_results
[i
].pc
,
2178 intermediate_results
[i
].section
);
2181 for (i
= 0; i
< intermediate_results
.size (); ++i
)
2183 if (blocks
[i
] != NULL
)
2184 for (j
= i
+ 1; j
< intermediate_results
.size (); ++j
)
2186 if (blocks
[j
] == blocks
[i
])
2194 for (i
= 0; i
< intermediate_results
.size (); ++i
)
2197 struct symbol
*sym
= (blocks
[i
]
2198 ? block_containing_function (blocks
[i
])
2201 if (self
->funfirstline
)
2202 skip_prologue_sal (&intermediate_results
[i
]);
2203 intermediate_results
[i
].symbol
= sym
;
2204 add_sal_to_sals (self
, &values
, &intermediate_results
[i
],
2205 sym
? SYMBOL_NATURAL_NAME (sym
) : NULL
, 0);
2209 if (values
.empty ())
2211 if (ls
->explicit_loc
.source_filename
)
2212 throw_error (NOT_FOUND_ERROR
, _("No line %d in file \"%s\"."),
2213 val
.line
, ls
->explicit_loc
.source_filename
);
2215 throw_error (NOT_FOUND_ERROR
, _("No line %d in the current file."),
2222 /* Convert the given ADDRESS into SaLs. */
2224 static std::vector
<symtab_and_line
>
2225 convert_address_location_to_sals (struct linespec_state
*self
,
2228 symtab_and_line sal
= find_pc_line (address
, 0);
2230 sal
.section
= find_pc_overlay (address
);
2231 sal
.explicit_pc
= 1;
2232 sal
.symbol
= find_pc_sect_containing_function (sal
.pc
, sal
.section
);
2234 std::vector
<symtab_and_line
> sals
;
2235 add_sal_to_sals (self
, &sals
, &sal
, core_addr_to_string (address
), 1);
2240 /* Create and return SALs from the linespec LS. */
2242 static std::vector
<symtab_and_line
>
2243 convert_linespec_to_sals (struct linespec_state
*state
, linespec_p ls
)
2245 std::vector
<symtab_and_line
> sals
;
2247 if (ls
->labels
.label_symbols
!= NULL
)
2249 /* We have just a bunch of functions/methods or labels. */
2250 struct symtab_and_line sal
;
2252 for (const auto &sym
: *ls
->labels
.label_symbols
)
2254 struct program_space
*pspace
2255 = SYMTAB_PSPACE (symbol_symtab (sym
.symbol
));
2257 if (symbol_to_sal (&sal
, state
->funfirstline
, sym
.symbol
)
2258 && maybe_add_address (state
->addr_set
, pspace
, sal
.pc
))
2259 add_sal_to_sals (state
, &sals
, &sal
,
2260 SYMBOL_NATURAL_NAME (sym
.symbol
), 0);
2263 else if (ls
->function_symbols
!= NULL
|| ls
->minimal_symbols
!= NULL
)
2265 /* We have just a bunch of functions and/or methods. */
2266 if (ls
->function_symbols
!= NULL
)
2268 /* Sort symbols so that symbols with the same program space are next
2270 std::sort (ls
->function_symbols
->begin (),
2271 ls
->function_symbols
->end (),
2274 for (const auto &sym
: *ls
->function_symbols
)
2276 program_space
*pspace
2277 = SYMTAB_PSPACE (symbol_symtab (sym
.symbol
));
2278 set_current_program_space (pspace
);
2280 /* Don't skip to the first line of the function if we
2281 had found an ifunc minimal symbol for this function,
2282 because that means that this function is an ifunc
2283 resolver with the same name as the ifunc itself. */
2284 bool found_ifunc
= false;
2286 if (state
->funfirstline
2287 && ls
->minimal_symbols
!= NULL
2288 && SYMBOL_CLASS (sym
.symbol
) == LOC_BLOCK
)
2290 const CORE_ADDR addr
2291 = BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
.symbol
));
2293 for (const auto &elem
: *ls
->minimal_symbols
)
2295 if (MSYMBOL_TYPE (elem
.minsym
) == mst_text_gnu_ifunc
2296 || MSYMBOL_TYPE (elem
.minsym
) == mst_data_gnu_ifunc
)
2298 CORE_ADDR msym_addr
= BMSYMBOL_VALUE_ADDRESS (elem
);
2299 if (MSYMBOL_TYPE (elem
.minsym
) == mst_data_gnu_ifunc
)
2301 struct gdbarch
*gdbarch
2302 = get_objfile_arch (elem
.objfile
);
2304 = (gdbarch_convert_from_func_ptr_addr
2307 current_top_target ()));
2310 if (msym_addr
== addr
)
2321 symtab_and_line sal
;
2322 if (symbol_to_sal (&sal
, state
->funfirstline
, sym
.symbol
)
2323 && maybe_add_address (state
->addr_set
, pspace
, sal
.pc
))
2324 add_sal_to_sals (state
, &sals
, &sal
,
2325 SYMBOL_NATURAL_NAME (sym
.symbol
), 0);
2330 if (ls
->minimal_symbols
!= NULL
)
2332 /* Sort minimal symbols by program space, too */
2333 std::sort (ls
->minimal_symbols
->begin (),
2334 ls
->minimal_symbols
->end (),
2337 for (const auto &elem
: *ls
->minimal_symbols
)
2339 program_space
*pspace
= elem
.objfile
->pspace
;
2340 set_current_program_space (pspace
);
2341 minsym_found (state
, elem
.objfile
, elem
.minsym
, &sals
);
2345 else if (ls
->explicit_loc
.line_offset
.sign
!= LINE_OFFSET_UNKNOWN
)
2347 /* Only an offset was specified. */
2348 sals
= create_sals_line_offset (state
, ls
);
2350 /* Make sure we have a filename for canonicalization. */
2351 if (ls
->explicit_loc
.source_filename
== NULL
)
2353 const char *fullname
= symtab_to_fullname (state
->default_symtab
);
2355 /* It may be more appropriate to keep DEFAULT_SYMTAB in its symtab
2356 form so that displaying SOURCE_FILENAME can follow the current
2357 FILENAME_DISPLAY_STRING setting. But as it is used only rarely
2358 it has been kept for code simplicity only in absolute form. */
2359 ls
->explicit_loc
.source_filename
= xstrdup (fullname
);
2364 /* We haven't found any results... */
2368 canonicalize_linespec (state
, ls
);
2370 if (!sals
.empty () && state
->canonical
!= NULL
)
2371 state
->canonical
->pre_expanded
= 1;
2376 /* Build RESULT from the explicit location components SOURCE_FILENAME,
2377 FUNCTION_NAME, LABEL_NAME and LINE_OFFSET. */
2380 convert_explicit_location_to_linespec (struct linespec_state
*self
,
2382 const char *source_filename
,
2383 const char *function_name
,
2384 symbol_name_match_type fname_match_type
,
2385 const char *label_name
,
2386 struct line_offset line_offset
)
2388 std::vector
<block_symbol
> symbols
;
2389 std::vector
<block_symbol
> *labels
;
2390 std::vector
<bound_minimal_symbol
> minimal_symbols
;
2392 result
->explicit_loc
.func_name_match_type
= fname_match_type
;
2394 if (source_filename
!= NULL
)
2398 *result
->file_symtabs
2399 = symtabs_from_filename (source_filename
, self
->search_pspace
);
2401 CATCH (except
, RETURN_MASK_ERROR
)
2403 source_file_not_found_error (source_filename
);
2406 result
->explicit_loc
.source_filename
= xstrdup (source_filename
);
2410 /* A NULL entry means to use the default symtab. */
2411 result
->file_symtabs
->push_back (nullptr);
2414 if (function_name
!= NULL
)
2416 find_linespec_symbols (self
, result
->file_symtabs
,
2417 function_name
, fname_match_type
,
2418 &symbols
, &minimal_symbols
);
2420 if (symbols
.empty () && minimal_symbols
.empty ())
2421 symbol_not_found_error (function_name
,
2422 result
->explicit_loc
.source_filename
);
2424 result
->explicit_loc
.function_name
= xstrdup (function_name
);
2425 result
->function_symbols
2426 = new std::vector
<block_symbol
> (std::move (symbols
));
2427 result
->minimal_symbols
2428 = new std::vector
<bound_minimal_symbol
> (std::move (minimal_symbols
));
2431 if (label_name
!= NULL
)
2433 labels
= find_label_symbols (self
, result
->function_symbols
,
2434 &symbols
, label_name
);
2437 undefined_label_error (result
->explicit_loc
.function_name
,
2440 result
->explicit_loc
.label_name
= xstrdup (label_name
);
2441 result
->labels
.label_symbols
= labels
;
2442 result
->labels
.function_symbols
2443 = new std::vector
<block_symbol
> (std::move (symbols
));
2446 if (line_offset
.sign
!= LINE_OFFSET_UNKNOWN
)
2447 result
->explicit_loc
.line_offset
= line_offset
;
2450 /* Convert the explicit location EXPLICIT_LOC into SaLs. */
2452 static std::vector
<symtab_and_line
>
2453 convert_explicit_location_to_sals (struct linespec_state
*self
,
2455 const struct explicit_location
*explicit_loc
)
2457 convert_explicit_location_to_linespec (self
, result
,
2458 explicit_loc
->source_filename
,
2459 explicit_loc
->function_name
,
2460 explicit_loc
->func_name_match_type
,
2461 explicit_loc
->label_name
,
2462 explicit_loc
->line_offset
);
2463 return convert_linespec_to_sals (self
, result
);
2466 /* Parse a string that specifies a linespec.
2468 The basic grammar of linespecs:
2470 linespec -> var_spec | basic_spec
2471 var_spec -> '$' (STRING | NUMBER)
2473 basic_spec -> file_offset_spec | function_spec | label_spec
2474 file_offset_spec -> opt_file_spec offset_spec
2475 function_spec -> opt_file_spec function_name_spec opt_label_spec
2476 label_spec -> label_name_spec
2478 opt_file_spec -> "" | file_name_spec ':'
2479 opt_label_spec -> "" | ':' label_name_spec
2481 file_name_spec -> STRING
2482 function_name_spec -> STRING
2483 label_name_spec -> STRING
2484 function_name_spec -> STRING
2485 offset_spec -> NUMBER
2489 This may all be followed by several keywords such as "if EXPR",
2492 A comma will terminate parsing.
2494 The function may be an undebuggable function found in minimal symbol table.
2496 If the argument FUNFIRSTLINE is nonzero, we want the first line
2497 of real code inside a function when a function is specified, and it is
2498 not OK to specify a variable or type to get its line number.
2500 DEFAULT_SYMTAB specifies the file to use if none is specified.
2501 It defaults to current_source_symtab.
2502 DEFAULT_LINE specifies the line number to use for relative
2503 line numbers (that start with signs). Defaults to current_source_line.
2504 If CANONICAL is non-NULL, store an array of strings containing the canonical
2505 line specs there if necessary. Currently overloaded member functions and
2506 line numbers or static functions without a filename yield a canonical
2507 line spec. The array and the line spec strings are allocated on the heap,
2508 it is the callers responsibility to free them.
2510 Note that it is possible to return zero for the symtab
2511 if no file is validly specified. Callers must check that.
2512 Also, the line number returned may be invalid. */
2514 /* Parse the linespec in ARG. MATCH_TYPE indicates how function names
2515 should be matched. */
2517 static std::vector
<symtab_and_line
>
2518 parse_linespec (linespec_parser
*parser
, const char *arg
,
2519 symbol_name_match_type match_type
)
2521 linespec_token token
;
2522 struct gdb_exception file_exception
= exception_none
;
2524 /* A special case to start. It has become quite popular for
2525 IDEs to work around bugs in the previous parser by quoting
2526 the entire linespec, so we attempt to deal with this nicely. */
2527 parser
->is_quote_enclosed
= 0;
2528 if (parser
->completion_tracker
== NULL
2529 && !is_ada_operator (arg
)
2530 && strchr (linespec_quote_characters
, *arg
) != NULL
)
2534 end
= skip_quote_char (arg
+ 1, *arg
);
2535 if (end
!= NULL
&& is_closing_quote_enclosed (end
))
2537 /* Here's the special case. Skip ARG past the initial
2540 parser
->is_quote_enclosed
= 1;
2544 parser
->lexer
.saved_arg
= arg
;
2545 parser
->lexer
.stream
= arg
;
2546 parser
->completion_word
= arg
;
2547 parser
->complete_what
= linespec_complete_what::FUNCTION
;
2548 PARSER_EXPLICIT (parser
)->func_name_match_type
= match_type
;
2550 /* Initialize the default symtab and line offset. */
2551 initialize_defaults (&PARSER_STATE (parser
)->default_symtab
,
2552 &PARSER_STATE (parser
)->default_line
);
2554 /* Objective-C shortcut. */
2555 if (parser
->completion_tracker
== NULL
)
2557 std::vector
<symtab_and_line
> values
2558 = decode_objc (PARSER_STATE (parser
), PARSER_RESULT (parser
), arg
);
2559 if (!values
.empty ())
2564 /* "-"/"+" is either an objc selector, or a number. There's
2565 nothing to complete the latter to, so just let the caller
2566 complete on functions, which finds objc selectors, if there's
2568 if ((arg
[0] == '-' || arg
[0] == '+') && arg
[1] == '\0')
2572 /* Start parsing. */
2574 /* Get the first token. */
2575 token
= linespec_lexer_consume_token (parser
);
2577 /* It must be either LSTOKEN_STRING or LSTOKEN_NUMBER. */
2578 if (token
.type
== LSTOKEN_STRING
&& *LS_TOKEN_STOKEN (token
).ptr
== '$')
2580 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2581 if (parser
->completion_tracker
== NULL
)
2582 PARSER_RESULT (parser
)->file_symtabs
->push_back (nullptr);
2584 /* User specified a convenience variable or history value. */
2585 gdb::unique_xmalloc_ptr
<char> var
= copy_token_string (token
);
2586 PARSER_EXPLICIT (parser
)->line_offset
2587 = linespec_parse_variable (PARSER_STATE (parser
), var
.get ());
2589 /* If a line_offset wasn't found (VAR is the name of a user
2590 variable/function), then skip to normal symbol processing. */
2591 if (PARSER_EXPLICIT (parser
)->line_offset
.sign
!= LINE_OFFSET_UNKNOWN
)
2593 /* Consume this token. */
2594 linespec_lexer_consume_token (parser
);
2596 goto convert_to_sals
;
2599 else if (token
.type
== LSTOKEN_EOI
&& parser
->completion_tracker
!= NULL
)
2601 /* Let the default linespec_complete_what::FUNCTION kick in. */
2602 unexpected_linespec_error (parser
);
2604 else if (token
.type
!= LSTOKEN_STRING
&& token
.type
!= LSTOKEN_NUMBER
)
2606 parser
->complete_what
= linespec_complete_what::NOTHING
;
2607 unexpected_linespec_error (parser
);
2610 /* Shortcut: If the next token is not LSTOKEN_COLON, we know that
2611 this token cannot represent a filename. */
2612 token
= linespec_lexer_peek_token (parser
);
2614 if (token
.type
== LSTOKEN_COLON
)
2616 /* Get the current token again and extract the filename. */
2617 token
= linespec_lexer_lex_one (parser
);
2618 gdb::unique_xmalloc_ptr
<char> user_filename
= copy_token_string (token
);
2620 /* Check if the input is a filename. */
2623 *PARSER_RESULT (parser
)->file_symtabs
2624 = symtabs_from_filename (user_filename
.get (),
2625 PARSER_STATE (parser
)->search_pspace
);
2627 CATCH (ex
, RETURN_MASK_ERROR
)
2629 file_exception
= ex
;
2633 if (file_exception
.reason
>= 0)
2635 /* Symtabs were found for the file. Record the filename. */
2636 PARSER_EXPLICIT (parser
)->source_filename
= user_filename
.release ();
2638 /* Get the next token. */
2639 token
= linespec_lexer_consume_token (parser
);
2641 /* This is LSTOKEN_COLON; consume it. */
2642 linespec_lexer_consume_token (parser
);
2646 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2647 PARSER_RESULT (parser
)->file_symtabs
->push_back (nullptr);
2650 /* If the next token is not EOI, KEYWORD, or COMMA, issue an error. */
2651 else if (parser
->completion_tracker
== NULL
2652 && (token
.type
!= LSTOKEN_EOI
&& token
.type
!= LSTOKEN_KEYWORD
2653 && token
.type
!= LSTOKEN_COMMA
))
2655 /* TOKEN is the _next_ token, not the one currently in the parser.
2656 Consuming the token will give the correct error message. */
2657 linespec_lexer_consume_token (parser
);
2658 unexpected_linespec_error (parser
);
2662 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2663 PARSER_RESULT (parser
)->file_symtabs
->push_back (nullptr);
2666 /* Parse the rest of the linespec. */
2667 linespec_parse_basic (parser
);
2669 if (parser
->completion_tracker
== NULL
2670 && PARSER_RESULT (parser
)->function_symbols
== NULL
2671 && PARSER_RESULT (parser
)->labels
.label_symbols
== NULL
2672 && PARSER_EXPLICIT (parser
)->line_offset
.sign
== LINE_OFFSET_UNKNOWN
2673 && PARSER_RESULT (parser
)->minimal_symbols
== NULL
)
2675 /* The linespec didn't parse. Re-throw the file exception if
2677 if (file_exception
.reason
< 0)
2678 throw_exception (file_exception
);
2680 /* Otherwise, the symbol is not found. */
2681 symbol_not_found_error (PARSER_EXPLICIT (parser
)->function_name
,
2682 PARSER_EXPLICIT (parser
)->source_filename
);
2687 /* Get the last token and record how much of the input was parsed,
2689 token
= linespec_lexer_lex_one (parser
);
2690 if (token
.type
!= LSTOKEN_EOI
&& token
.type
!= LSTOKEN_KEYWORD
)
2691 unexpected_linespec_error (parser
);
2692 else if (token
.type
== LSTOKEN_KEYWORD
)
2694 /* Setup the completion word past the keyword. Lexing never
2695 advances past a keyword automatically, so skip it
2697 parser
->completion_word
2698 = skip_spaces (skip_to_space (PARSER_STREAM (parser
)));
2699 parser
->complete_what
= linespec_complete_what::EXPRESSION
;
2702 /* Convert the data in PARSER_RESULT to SALs. */
2703 if (parser
->completion_tracker
== NULL
)
2704 return convert_linespec_to_sals (PARSER_STATE (parser
),
2705 PARSER_RESULT (parser
));
2711 /* A constructor for linespec_state. */
2714 linespec_state_constructor (struct linespec_state
*self
,
2715 int flags
, const struct language_defn
*language
,
2716 struct program_space
*search_pspace
,
2717 struct symtab
*default_symtab
,
2719 struct linespec_result
*canonical
)
2721 memset (self
, 0, sizeof (*self
));
2722 self
->language
= language
;
2723 self
->funfirstline
= (flags
& DECODE_LINE_FUNFIRSTLINE
) ? 1 : 0;
2724 self
->list_mode
= (flags
& DECODE_LINE_LIST_MODE
) ? 1 : 0;
2725 self
->search_pspace
= search_pspace
;
2726 self
->default_symtab
= default_symtab
;
2727 self
->default_line
= default_line
;
2728 self
->canonical
= canonical
;
2729 self
->program_space
= current_program_space
;
2730 self
->addr_set
= htab_create_alloc (10, hash_address_entry
, eq_address_entry
,
2731 xfree
, xcalloc
, xfree
);
2732 self
->is_linespec
= 0;
2735 /* Initialize a new linespec parser. */
2737 linespec_parser::linespec_parser (int flags
,
2738 const struct language_defn
*language
,
2739 struct program_space
*search_pspace
,
2740 struct symtab
*default_symtab
,
2742 struct linespec_result
*canonical
)
2744 lexer
.current
.type
= LSTOKEN_CONSUMED
;
2745 PARSER_RESULT (this)->file_symtabs
= new std::vector
<symtab
*> ();
2746 PARSER_EXPLICIT (this)->func_name_match_type
2747 = symbol_name_match_type::WILD
;
2748 PARSER_EXPLICIT (this)->line_offset
.sign
= LINE_OFFSET_UNKNOWN
;
2749 linespec_state_constructor (PARSER_STATE (this), flags
, language
,
2751 default_symtab
, default_line
, canonical
);
2754 /* A destructor for linespec_state. */
2757 linespec_state_destructor (struct linespec_state
*self
)
2759 htab_delete (self
->addr_set
);
2760 xfree (self
->canonical_names
);
2763 /* Delete a linespec parser. */
2765 linespec_parser::~linespec_parser ()
2767 xfree (PARSER_EXPLICIT (this)->source_filename
);
2768 xfree (PARSER_EXPLICIT (this)->label_name
);
2769 xfree (PARSER_EXPLICIT (this)->function_name
);
2771 delete PARSER_RESULT (this)->file_symtabs
;
2772 delete PARSER_RESULT (this)->function_symbols
;
2773 delete PARSER_RESULT (this)->minimal_symbols
;
2774 delete PARSER_RESULT (this)->labels
.label_symbols
;
2775 delete PARSER_RESULT (this)->labels
.function_symbols
;
2777 linespec_state_destructor (PARSER_STATE (this));
2780 /* See description in linespec.h. */
2783 linespec_lex_to_end (const char **stringp
)
2785 linespec_token token
;
2788 if (stringp
== NULL
|| *stringp
== NULL
)
2791 linespec_parser
parser (0, current_language
, NULL
, NULL
, 0, NULL
);
2792 parser
.lexer
.saved_arg
= *stringp
;
2793 PARSER_STREAM (&parser
) = orig
= *stringp
;
2797 /* Stop before any comma tokens; we need it to keep it
2798 as the next token in the string. */
2799 token
= linespec_lexer_peek_token (&parser
);
2800 if (token
.type
== LSTOKEN_COMMA
)
2802 token
= linespec_lexer_consume_token (&parser
);
2804 while (token
.type
!= LSTOKEN_EOI
&& token
.type
!= LSTOKEN_KEYWORD
);
2806 *stringp
+= PARSER_STREAM (&parser
) - orig
;
2809 /* See linespec.h. */
2812 linespec_complete_function (completion_tracker
&tracker
,
2813 const char *function
,
2814 symbol_name_match_type func_match_type
,
2815 const char *source_filename
)
2817 complete_symbol_mode mode
= complete_symbol_mode::LINESPEC
;
2819 if (source_filename
!= NULL
)
2821 collect_file_symbol_completion_matches (tracker
, mode
, func_match_type
,
2822 function
, function
, source_filename
);
2826 collect_symbol_completion_matches (tracker
, mode
, func_match_type
,
2827 function
, function
);
2832 /* Helper for complete_linespec to simplify it. SOURCE_FILENAME is
2833 only meaningful if COMPONENT is FUNCTION. */
2836 complete_linespec_component (linespec_parser
*parser
,
2837 completion_tracker
&tracker
,
2839 linespec_complete_what component
,
2840 const char *source_filename
)
2842 if (component
== linespec_complete_what::KEYWORD
)
2844 complete_on_enum (tracker
, linespec_keywords
, text
, text
);
2846 else if (component
== linespec_complete_what::EXPRESSION
)
2849 = advance_to_expression_complete_word_point (tracker
, text
);
2850 complete_expression (tracker
, text
, word
);
2852 else if (component
== linespec_complete_what::FUNCTION
)
2854 completion_list fn_list
;
2856 symbol_name_match_type match_type
2857 = PARSER_EXPLICIT (parser
)->func_name_match_type
;
2858 linespec_complete_function (tracker
, text
, match_type
, source_filename
);
2859 if (source_filename
== NULL
)
2861 /* Haven't seen a source component, like in "b
2862 file.c:function[TAB]". Maybe this wasn't a function, but
2863 a filename instead, like "b file.[TAB]". */
2864 fn_list
= complete_source_filenames (text
);
2867 /* If we only have a single filename completion, append a ':' for
2868 the user, since that's the only thing that can usefully follow
2870 if (fn_list
.size () == 1 && !tracker
.have_completions ())
2872 char *fn
= fn_list
[0].release ();
2874 /* If we also need to append a quote char, it needs to be
2875 appended before the ':'. Append it now, and make ':' the
2876 new "quote" char. */
2877 if (tracker
.quote_char ())
2879 char quote_char_str
[2] = { (char) tracker
.quote_char () };
2881 fn
= reconcat (fn
, fn
, quote_char_str
, (char *) NULL
);
2882 tracker
.set_quote_char (':');
2885 fn
= reconcat (fn
, fn
, ":", (char *) NULL
);
2886 fn_list
[0].reset (fn
);
2888 /* Tell readline to skip appending a space. */
2889 tracker
.set_suppress_append_ws (true);
2891 tracker
.add_completions (std::move (fn_list
));
2895 /* Helper for linespec_complete_label. Find labels that match
2896 LABEL_NAME in the function symbols listed in the PARSER, and add
2897 them to the tracker. */
2900 complete_label (completion_tracker
&tracker
,
2901 linespec_parser
*parser
,
2902 const char *label_name
)
2904 std::vector
<block_symbol
> label_function_symbols
;
2905 std::vector
<block_symbol
> *labels
2906 = find_label_symbols (PARSER_STATE (parser
),
2907 PARSER_RESULT (parser
)->function_symbols
,
2908 &label_function_symbols
,
2911 if (labels
!= nullptr)
2913 for (const auto &label
: *labels
)
2915 char *match
= xstrdup (SYMBOL_SEARCH_NAME (label
.symbol
));
2916 tracker
.add_completion (gdb::unique_xmalloc_ptr
<char> (match
));
2922 /* See linespec.h. */
2925 linespec_complete_label (completion_tracker
&tracker
,
2926 const struct language_defn
*language
,
2927 const char *source_filename
,
2928 const char *function_name
,
2929 symbol_name_match_type func_name_match_type
,
2930 const char *label_name
)
2932 linespec_parser
parser (0, language
, NULL
, NULL
, 0, NULL
);
2934 line_offset unknown_offset
= { 0, LINE_OFFSET_UNKNOWN
};
2938 convert_explicit_location_to_linespec (PARSER_STATE (&parser
),
2939 PARSER_RESULT (&parser
),
2942 func_name_match_type
,
2943 NULL
, unknown_offset
);
2945 CATCH (ex
, RETURN_MASK_ERROR
)
2951 complete_label (tracker
, &parser
, label_name
);
2954 /* See description in linespec.h. */
2957 linespec_complete (completion_tracker
&tracker
, const char *text
,
2958 symbol_name_match_type match_type
)
2960 const char *orig
= text
;
2962 linespec_parser
parser (0, current_language
, NULL
, NULL
, 0, NULL
);
2963 parser
.lexer
.saved_arg
= text
;
2964 PARSER_EXPLICIT (&parser
)->func_name_match_type
= match_type
;
2965 PARSER_STREAM (&parser
) = text
;
2967 parser
.completion_tracker
= &tracker
;
2968 PARSER_STATE (&parser
)->is_linespec
= 1;
2970 /* Parse as much as possible. parser.completion_word will hold
2971 furthest completion point we managed to parse to. */
2974 parse_linespec (&parser
, text
, match_type
);
2976 CATCH (except
, RETURN_MASK_ERROR
)
2981 if (parser
.completion_quote_char
!= '\0'
2982 && parser
.completion_quote_end
!= NULL
2983 && parser
.completion_quote_end
[1] == '\0')
2985 /* If completing a quoted string with the cursor right at
2986 terminating quote char, complete the completion word without
2987 interpretation, so that readline advances the cursor one
2988 whitespace past the quote, even if there's no match. This
2989 makes these cases behave the same:
2991 before: "b function()"
2992 after: "b function() "
2994 before: "b 'function()'"
2995 after: "b 'function()' "
2997 and trusts the user in this case:
2999 before: "b 'not_loaded_function_yet()'"
3000 after: "b 'not_loaded_function_yet()' "
3002 parser
.complete_what
= linespec_complete_what::NOTHING
;
3003 parser
.completion_quote_char
= '\0';
3005 gdb::unique_xmalloc_ptr
<char> text_copy
3006 (xstrdup (parser
.completion_word
));
3007 tracker
.add_completion (std::move (text_copy
));
3010 tracker
.set_quote_char (parser
.completion_quote_char
);
3012 if (parser
.complete_what
== linespec_complete_what::LABEL
)
3014 parser
.complete_what
= linespec_complete_what::NOTHING
;
3016 const char *func_name
= PARSER_EXPLICIT (&parser
)->function_name
;
3018 std::vector
<block_symbol
> function_symbols
;
3019 std::vector
<bound_minimal_symbol
> minimal_symbols
;
3020 find_linespec_symbols (PARSER_STATE (&parser
),
3021 PARSER_RESULT (&parser
)->file_symtabs
,
3022 func_name
, match_type
,
3023 &function_symbols
, &minimal_symbols
);
3025 PARSER_RESULT (&parser
)->function_symbols
3026 = new std::vector
<block_symbol
> (std::move (function_symbols
));
3027 PARSER_RESULT (&parser
)->minimal_symbols
3028 = new std::vector
<bound_minimal_symbol
> (std::move (minimal_symbols
));
3030 complete_label (tracker
, &parser
, parser
.completion_word
);
3032 else if (parser
.complete_what
== linespec_complete_what::FUNCTION
)
3034 /* While parsing/lexing, we didn't know whether the completion
3035 word completes to a unique function/source name already or
3039 "b function() <tab>"
3040 may need to complete either to:
3041 "b function() const"
3043 "b function() if/thread/task"
3047 may need to complete either to:
3048 "b foo template_fun<T>()"
3049 with "foo" being the template function's return type, or to:
3054 may need to complete either to a source file name:
3056 or this, also a filename, but a unique completion:
3058 or to a function name:
3061 Address that by completing assuming source or function, and
3062 seeing if we find a completion that matches exactly the
3063 completion word. If so, then it must be a function (see note
3064 below) and we advance the completion word to the end of input
3065 and switch to KEYWORD completion mode.
3067 Note: if we find a unique completion for a source filename,
3068 then it won't match the completion word, because the LCD will
3069 contain a trailing ':'. And if we're completing at or after
3070 the ':', then complete_linespec_component won't try to
3071 complete on source filenames. */
3073 const char *word
= parser
.completion_word
;
3075 complete_linespec_component (&parser
, tracker
,
3076 parser
.completion_word
,
3077 linespec_complete_what::FUNCTION
,
3078 PARSER_EXPLICIT (&parser
)->source_filename
);
3080 parser
.complete_what
= linespec_complete_what::NOTHING
;
3082 if (tracker
.quote_char ())
3084 /* The function/file name was not close-quoted, so this
3085 can't be a keyword. Note: complete_linespec_component
3086 may have swapped the original quote char for ':' when we
3087 get here, but that still indicates the same. */
3089 else if (!tracker
.have_completions ())
3092 size_t wordlen
= strlen (parser
.completion_word
);
3095 = string_find_incomplete_keyword_at_end (linespec_keywords
,
3096 parser
.completion_word
,
3101 && parser
.completion_word
[wordlen
- 1] == ' '))
3103 parser
.completion_word
+= key_start
;
3104 parser
.complete_what
= linespec_complete_what::KEYWORD
;
3107 else if (tracker
.completes_to_completion_word (word
))
3109 /* Skip the function and complete on keywords. */
3110 parser
.completion_word
+= strlen (word
);
3111 parser
.complete_what
= linespec_complete_what::KEYWORD
;
3112 tracker
.discard_completions ();
3116 tracker
.advance_custom_word_point_by (parser
.completion_word
- orig
);
3118 complete_linespec_component (&parser
, tracker
,
3119 parser
.completion_word
,
3120 parser
.complete_what
,
3121 PARSER_EXPLICIT (&parser
)->source_filename
);
3123 /* If we're past the "filename:function:label:offset" linespec, and
3124 didn't find any match, then assume the user might want to create
3125 a pending breakpoint anyway and offer the keyword
3127 if (!parser
.completion_quote_char
3128 && (parser
.complete_what
== linespec_complete_what::FUNCTION
3129 || parser
.complete_what
== linespec_complete_what::LABEL
3130 || parser
.complete_what
== linespec_complete_what::NOTHING
)
3131 && !tracker
.have_completions ())
3134 = parser
.completion_word
+ strlen (parser
.completion_word
);
3136 if (end
> orig
&& end
[-1] == ' ')
3138 tracker
.advance_custom_word_point_by (end
- parser
.completion_word
);
3140 complete_linespec_component (&parser
, tracker
, end
,
3141 linespec_complete_what::KEYWORD
,
3147 /* A helper function for decode_line_full and decode_line_1 to
3148 turn LOCATION into std::vector<symtab_and_line>. */
3150 static std::vector
<symtab_and_line
>
3151 event_location_to_sals (linespec_parser
*parser
,
3152 const struct event_location
*location
)
3154 std::vector
<symtab_and_line
> result
;
3156 switch (event_location_type (location
))
3158 case LINESPEC_LOCATION
:
3160 PARSER_STATE (parser
)->is_linespec
= 1;
3163 const linespec_location
*ls
= get_linespec_location (location
);
3164 result
= parse_linespec (parser
,
3165 ls
->spec_string
, ls
->match_type
);
3167 CATCH (except
, RETURN_MASK_ERROR
)
3169 throw_exception (except
);
3175 case ADDRESS_LOCATION
:
3177 const char *addr_string
= get_address_string_location (location
);
3178 CORE_ADDR addr
= get_address_location (location
);
3180 if (addr_string
!= NULL
)
3182 addr
= linespec_expression_to_pc (&addr_string
);
3183 if (PARSER_STATE (parser
)->canonical
!= NULL
)
3184 PARSER_STATE (parser
)->canonical
->location
3185 = copy_event_location (location
);
3188 result
= convert_address_location_to_sals (PARSER_STATE (parser
),
3193 case EXPLICIT_LOCATION
:
3195 const struct explicit_location
*explicit_loc
;
3197 explicit_loc
= get_explicit_location_const (location
);
3198 result
= convert_explicit_location_to_sals (PARSER_STATE (parser
),
3199 PARSER_RESULT (parser
),
3204 case PROBE_LOCATION
:
3205 /* Probes are handled by their own decoders. */
3206 gdb_assert_not_reached ("attempt to decode probe location");
3210 gdb_assert_not_reached ("unhandled event location type");
3216 /* See linespec.h. */
3219 decode_line_full (const struct event_location
*location
, int flags
,
3220 struct program_space
*search_pspace
,
3221 struct symtab
*default_symtab
,
3222 int default_line
, struct linespec_result
*canonical
,
3223 const char *select_mode
,
3226 std::vector
<const char *> filters
;
3227 struct linespec_state
*state
;
3229 gdb_assert (canonical
!= NULL
);
3230 /* The filter only makes sense for 'all'. */
3231 gdb_assert (filter
== NULL
|| select_mode
== multiple_symbols_all
);
3232 gdb_assert (select_mode
== NULL
3233 || select_mode
== multiple_symbols_all
3234 || select_mode
== multiple_symbols_ask
3235 || select_mode
== multiple_symbols_cancel
);
3236 gdb_assert ((flags
& DECODE_LINE_LIST_MODE
) == 0);
3238 linespec_parser
parser (flags
, current_language
,
3239 search_pspace
, default_symtab
,
3240 default_line
, canonical
);
3242 scoped_restore_current_program_space restore_pspace
;
3244 std::vector
<symtab_and_line
> result
= event_location_to_sals (&parser
,
3246 state
= PARSER_STATE (&parser
);
3248 gdb_assert (result
.size () == 1 || canonical
->pre_expanded
);
3249 canonical
->pre_expanded
= 1;
3251 /* Arrange for allocated canonical names to be freed. */
3252 std::vector
<gdb::unique_xmalloc_ptr
<char>> hold_names
;
3253 for (int i
= 0; i
< result
.size (); ++i
)
3255 gdb_assert (state
->canonical_names
[i
].suffix
!= NULL
);
3256 hold_names
.emplace_back (state
->canonical_names
[i
].suffix
);
3259 if (select_mode
== NULL
)
3261 if (top_level_interpreter ()->interp_ui_out ()->is_mi_like_p ())
3262 select_mode
= multiple_symbols_all
;
3264 select_mode
= multiple_symbols_select_mode ();
3267 if (select_mode
== multiple_symbols_all
)
3271 filters
.push_back (filter
);
3272 filter_results (state
, &result
, filters
);
3275 convert_results_to_lsals (state
, &result
);
3278 decode_line_2 (state
, &result
, select_mode
);
3281 /* See linespec.h. */
3283 std::vector
<symtab_and_line
>
3284 decode_line_1 (const struct event_location
*location
, int flags
,
3285 struct program_space
*search_pspace
,
3286 struct symtab
*default_symtab
,
3289 linespec_parser
parser (flags
, current_language
,
3290 search_pspace
, default_symtab
,
3291 default_line
, NULL
);
3293 scoped_restore_current_program_space restore_pspace
;
3295 return event_location_to_sals (&parser
, location
);
3298 /* See linespec.h. */
3300 std::vector
<symtab_and_line
>
3301 decode_line_with_current_source (const char *string
, int flags
)
3304 error (_("Empty line specification."));
3306 /* We use whatever is set as the current source line. We do not try
3307 and get a default source symtab+line or it will recursively call us! */
3308 symtab_and_line cursal
= get_current_source_symtab_and_line ();
3310 event_location_up location
= string_to_event_location (&string
,
3312 std::vector
<symtab_and_line
> sals
3313 = decode_line_1 (location
.get (), flags
, NULL
, cursal
.symtab
, cursal
.line
);
3316 error (_("Junk at end of line specification: %s"), string
);
3321 /* See linespec.h. */
3323 std::vector
<symtab_and_line
>
3324 decode_line_with_last_displayed (const char *string
, int flags
)
3327 error (_("Empty line specification."));
3329 event_location_up location
= string_to_event_location (&string
,
3331 std::vector
<symtab_and_line
> sals
3332 = (last_displayed_sal_is_valid ()
3333 ? decode_line_1 (location
.get (), flags
, NULL
,
3334 get_last_displayed_symtab (),
3335 get_last_displayed_line ())
3336 : decode_line_1 (location
.get (), flags
, NULL
,
3337 (struct symtab
*) NULL
, 0));
3340 error (_("Junk at end of line specification: %s"), string
);
3347 /* First, some functions to initialize stuff at the beggining of the
3351 initialize_defaults (struct symtab
**default_symtab
, int *default_line
)
3353 if (*default_symtab
== 0)
3355 /* Use whatever we have for the default source line. We don't use
3356 get_current_or_default_symtab_and_line as it can recurse and call
3358 struct symtab_and_line cursal
=
3359 get_current_source_symtab_and_line ();
3361 *default_symtab
= cursal
.symtab
;
3362 *default_line
= cursal
.line
;
3368 /* Evaluate the expression pointed to by EXP_PTR into a CORE_ADDR,
3369 advancing EXP_PTR past any parsed text. */
3372 linespec_expression_to_pc (const char **exp_ptr
)
3374 if (current_program_space
->executing_startup
)
3375 /* The error message doesn't really matter, because this case
3376 should only hit during breakpoint reset. */
3377 throw_error (NOT_FOUND_ERROR
, _("cannot evaluate expressions while "
3378 "program space is in startup"));
3381 return value_as_address (parse_to_comma_and_eval (exp_ptr
));
3386 /* Here's where we recognise an Objective-C Selector. An Objective C
3387 selector may be implemented by more than one class, therefore it
3388 may represent more than one method/function. This gives us a
3389 situation somewhat analogous to C++ overloading. If there's more
3390 than one method that could represent the selector, then use some of
3391 the existing C++ code to let the user choose one. */
3393 static std::vector
<symtab_and_line
>
3394 decode_objc (struct linespec_state
*self
, linespec_p ls
, const char *arg
)
3396 struct collect_info info
;
3397 std::vector
<const char *> symbol_names
;
3398 const char *new_argptr
;
3401 std::vector
<symtab
*> symtabs
;
3402 symtabs
.push_back (nullptr);
3404 info
.file_symtabs
= &symtabs
;
3406 std::vector
<block_symbol
> symbols
;
3407 info
.result
.symbols
= &symbols
;
3408 std::vector
<bound_minimal_symbol
> minimal_symbols
;
3409 info
.result
.minimal_symbols
= &minimal_symbols
;
3411 new_argptr
= find_imps (arg
, &symbol_names
);
3412 if (symbol_names
.empty ())
3415 add_all_symbol_names_from_pspace (&info
, NULL
, symbol_names
,
3418 std::vector
<symtab_and_line
> values
;
3419 if (!symbols
.empty () || !minimal_symbols
.empty ())
3423 saved_arg
= (char *) alloca (new_argptr
- arg
+ 1);
3424 memcpy (saved_arg
, arg
, new_argptr
- arg
);
3425 saved_arg
[new_argptr
- arg
] = '\0';
3427 ls
->explicit_loc
.function_name
= xstrdup (saved_arg
);
3428 ls
->function_symbols
3429 = new std::vector
<block_symbol
> (std::move (symbols
));
3431 = new std::vector
<bound_minimal_symbol
> (std::move (minimal_symbols
));
3432 values
= convert_linespec_to_sals (self
, ls
);
3434 if (self
->canonical
)
3439 self
->canonical
->pre_expanded
= 1;
3441 if (ls
->explicit_loc
.source_filename
)
3443 holder
= string_printf ("%s:%s",
3444 ls
->explicit_loc
.source_filename
,
3446 str
= holder
.c_str ();
3451 self
->canonical
->location
3452 = new_linespec_location (&str
, symbol_name_match_type::FULL
);
3461 /* A function object that serves as symbol_found_callback_ftype
3462 callback for iterate_over_symbols. This is used by
3463 lookup_prefix_sym to collect type symbols. */
3464 class decode_compound_collector
3467 decode_compound_collector ()
3469 m_unique_syms
= htab_create_alloc (1, htab_hash_pointer
,
3470 htab_eq_pointer
, NULL
,
3474 ~decode_compound_collector ()
3476 if (m_unique_syms
!= NULL
)
3477 htab_delete (m_unique_syms
);
3480 /* Return all symbols collected. */
3481 std::vector
<block_symbol
> release_symbols ()
3483 return std::move (m_symbols
);
3486 /* Callable as a symbol_found_callback_ftype callback. */
3487 bool operator () (block_symbol
*bsym
);
3490 /* A hash table of all symbols we found. We use this to avoid
3491 adding any symbol more than once. */
3492 htab_t m_unique_syms
;
3494 /* The result vector. */
3495 std::vector
<block_symbol
> m_symbols
;
3499 decode_compound_collector::operator () (block_symbol
*bsym
)
3503 struct symbol
*sym
= bsym
->symbol
;
3505 if (SYMBOL_CLASS (sym
) != LOC_TYPEDEF
)
3506 return true; /* Continue iterating. */
3508 t
= SYMBOL_TYPE (sym
);
3509 t
= check_typedef (t
);
3510 if (TYPE_CODE (t
) != TYPE_CODE_STRUCT
3511 && TYPE_CODE (t
) != TYPE_CODE_UNION
3512 && TYPE_CODE (t
) != TYPE_CODE_NAMESPACE
)
3513 return true; /* Continue iterating. */
3515 slot
= htab_find_slot (m_unique_syms
, sym
, INSERT
);
3519 m_symbols
.push_back (*bsym
);
3522 return true; /* Continue iterating. */
3527 /* Return any symbols corresponding to CLASS_NAME in FILE_SYMTABS. */
3529 static std::vector
<block_symbol
>
3530 lookup_prefix_sym (struct linespec_state
*state
,
3531 std::vector
<symtab
*> *file_symtabs
,
3532 const char *class_name
)
3534 decode_compound_collector collector
;
3536 lookup_name_info
lookup_name (class_name
, symbol_name_match_type::FULL
);
3538 for (const auto &elt
: *file_symtabs
)
3542 iterate_over_all_matching_symtabs (state
, lookup_name
,
3543 STRUCT_DOMAIN
, ALL_DOMAIN
,
3544 NULL
, false, collector
);
3545 iterate_over_all_matching_symtabs (state
, lookup_name
,
3546 VAR_DOMAIN
, ALL_DOMAIN
,
3547 NULL
, false, collector
);
3551 /* Program spaces that are executing startup should have
3552 been filtered out earlier. */
3553 gdb_assert (!SYMTAB_PSPACE (elt
)->executing_startup
);
3554 set_current_program_space (SYMTAB_PSPACE (elt
));
3555 iterate_over_file_blocks (elt
, lookup_name
, STRUCT_DOMAIN
, collector
);
3556 iterate_over_file_blocks (elt
, lookup_name
, VAR_DOMAIN
, collector
);
3560 return collector
.release_symbols ();
3563 /* A std::sort comparison function for symbols. The resulting order does
3564 not actually matter; we just need to be able to sort them so that
3565 symbols with the same program space end up next to each other. */
3568 compare_symbols (const block_symbol
&a
, const block_symbol
&b
)
3572 uia
= (uintptr_t) SYMTAB_PSPACE (symbol_symtab (a
.symbol
));
3573 uib
= (uintptr_t) SYMTAB_PSPACE (symbol_symtab (b
.symbol
));
3580 uia
= (uintptr_t) a
.symbol
;
3581 uib
= (uintptr_t) b
.symbol
;
3589 /* Like compare_symbols but for minimal symbols. */
3592 compare_msymbols (const bound_minimal_symbol
&a
, const bound_minimal_symbol
&b
)
3596 uia
= (uintptr_t) a
.objfile
->pspace
;
3597 uib
= (uintptr_t) a
.objfile
->pspace
;
3604 uia
= (uintptr_t) a
.minsym
;
3605 uib
= (uintptr_t) b
.minsym
;
3613 /* Look for all the matching instances of each symbol in NAMES. Only
3614 instances from PSPACE are considered; other program spaces are
3615 handled by our caller. If PSPACE is NULL, then all program spaces
3616 are considered. Results are stored into INFO. */
3619 add_all_symbol_names_from_pspace (struct collect_info
*info
,
3620 struct program_space
*pspace
,
3621 const std::vector
<const char *> &names
,
3622 enum search_domain search_domain
)
3624 for (const char *iter
: names
)
3625 add_matching_symbols_to_info (iter
,
3626 symbol_name_match_type::FULL
,
3627 search_domain
, info
, pspace
);
3631 find_superclass_methods (std::vector
<struct type
*> &&superclasses
,
3632 const char *name
, enum language name_lang
,
3633 std::vector
<const char *> *result_names
)
3635 size_t old_len
= result_names
->size ();
3639 std::vector
<struct type
*> new_supers
;
3641 for (type
*t
: superclasses
)
3642 find_methods (t
, name_lang
, name
, result_names
, &new_supers
);
3644 if (result_names
->size () != old_len
|| new_supers
.empty ())
3647 superclasses
= std::move (new_supers
);
3651 /* This finds the method METHOD_NAME in the class CLASS_NAME whose type is
3652 given by one of the symbols in SYM_CLASSES. Matches are returned
3653 in SYMBOLS (for debug symbols) and MINSYMS (for minimal symbols). */
3656 find_method (struct linespec_state
*self
, std::vector
<symtab
*> *file_symtabs
,
3657 const char *class_name
, const char *method_name
,
3658 std::vector
<block_symbol
> *sym_classes
,
3659 std::vector
<block_symbol
> *symbols
,
3660 std::vector
<bound_minimal_symbol
> *minsyms
)
3662 size_t last_result_len
;
3663 std::vector
<struct type
*> superclass_vec
;
3664 std::vector
<const char *> result_names
;
3665 struct collect_info info
;
3667 /* Sort symbols so that symbols with the same program space are next
3669 std::sort (sym_classes
->begin (), sym_classes
->end (),
3673 info
.file_symtabs
= file_symtabs
;
3674 info
.result
.symbols
= symbols
;
3675 info
.result
.minimal_symbols
= minsyms
;
3677 /* Iterate over all the types, looking for the names of existing
3678 methods matching METHOD_NAME. If we cannot find a direct method in a
3679 given program space, then we consider inherited methods; this is
3680 not ideal (ideal would be to respect C++ hiding rules), but it
3681 seems good enough and is what GDB has historically done. We only
3682 need to collect the names because later we find all symbols with
3683 those names. This loop is written in a somewhat funny way
3684 because we collect data across the program space before deciding
3686 last_result_len
= 0;
3687 unsigned int ix
= 0;
3688 for (const auto &elt
: *sym_classes
)
3691 struct program_space
*pspace
;
3692 struct symbol
*sym
= elt
.symbol
;
3694 /* Program spaces that are executing startup should have
3695 been filtered out earlier. */
3696 pspace
= SYMTAB_PSPACE (symbol_symtab (sym
));
3697 gdb_assert (!pspace
->executing_startup
);
3698 set_current_program_space (pspace
);
3699 t
= check_typedef (SYMBOL_TYPE (sym
));
3700 find_methods (t
, SYMBOL_LANGUAGE (sym
),
3701 method_name
, &result_names
, &superclass_vec
);
3703 /* Handle all items from a single program space at once; and be
3704 sure not to miss the last batch. */
3705 if (ix
== sym_classes
->size () - 1
3707 != SYMTAB_PSPACE (symbol_symtab (sym_classes
->at (ix
+ 1).symbol
))))
3709 /* If we did not find a direct implementation anywhere in
3710 this program space, consider superclasses. */
3711 if (result_names
.size () == last_result_len
)
3712 find_superclass_methods (std::move (superclass_vec
), method_name
,
3713 SYMBOL_LANGUAGE (sym
), &result_names
);
3715 /* We have a list of candidate symbol names, so now we
3716 iterate over the symbol tables looking for all
3717 matches in this pspace. */
3718 add_all_symbol_names_from_pspace (&info
, pspace
, result_names
,
3721 superclass_vec
.clear ();
3722 last_result_len
= result_names
.size ();
3727 if (!symbols
->empty () || !minsyms
->empty ())
3730 /* Throw an NOT_FOUND_ERROR. This will be caught by the caller
3731 and other attempts to locate the symbol will be made. */
3732 throw_error (NOT_FOUND_ERROR
, _("see caller, this text doesn't matter"));
3739 /* This function object is a callback for iterate_over_symtabs, used
3740 when collecting all matching symtabs. */
3742 class symtab_collector
3747 m_symtab_table
= htab_create (1, htab_hash_pointer
, htab_eq_pointer
,
3751 ~symtab_collector ()
3753 if (m_symtab_table
!= NULL
)
3754 htab_delete (m_symtab_table
);
3757 /* Callable as a symbol_found_callback_ftype callback. */
3758 bool operator () (symtab
*sym
);
3760 /* Return an rvalue reference to the collected symtabs. */
3761 std::vector
<symtab
*> &&release_symtabs ()
3763 return std::move (m_symtabs
);
3767 /* The result vector of symtabs. */
3768 std::vector
<symtab
*> m_symtabs
;
3770 /* This is used to ensure the symtabs are unique. */
3771 htab_t m_symtab_table
;
3775 symtab_collector::operator () (struct symtab
*symtab
)
3779 slot
= htab_find_slot (m_symtab_table
, symtab
, INSERT
);
3783 m_symtabs
.push_back (symtab
);
3791 /* Given a file name, return a list of all matching symtabs. If
3792 SEARCH_PSPACE is not NULL, the search is restricted to just that
3795 static std::vector
<symtab
*>
3796 collect_symtabs_from_filename (const char *file
,
3797 struct program_space
*search_pspace
)
3799 symtab_collector collector
;
3801 /* Find that file's data. */
3802 if (search_pspace
== NULL
)
3804 struct program_space
*pspace
;
3806 ALL_PSPACES (pspace
)
3808 if (pspace
->executing_startup
)
3811 set_current_program_space (pspace
);
3812 iterate_over_symtabs (file
, collector
);
3817 set_current_program_space (search_pspace
);
3818 iterate_over_symtabs (file
, collector
);
3821 return collector
.release_symtabs ();
3824 /* Return all the symtabs associated to the FILENAME. If SEARCH_PSPACE is
3825 not NULL, the search is restricted to just that program space. */
3827 static std::vector
<symtab
*>
3828 symtabs_from_filename (const char *filename
,
3829 struct program_space
*search_pspace
)
3831 std::vector
<symtab
*> result
3832 = collect_symtabs_from_filename (filename
, search_pspace
);
3834 if (result
.empty ())
3836 if (!have_full_symbols () && !have_partial_symbols ())
3837 throw_error (NOT_FOUND_ERROR
,
3838 _("No symbol table is loaded. "
3839 "Use the \"file\" command."));
3840 source_file_not_found_error (filename
);
3849 symbol_searcher::find_all_symbols (const std::string
&name
,
3850 const struct language_defn
*language
,
3851 enum search_domain search_domain
,
3852 std::vector
<symtab
*> *search_symtabs
,
3853 struct program_space
*search_pspace
)
3855 symbol_searcher_collect_info info
;
3856 struct linespec_state state
;
3858 memset (&state
, 0, sizeof (state
));
3859 state
.language
= language
;
3860 info
.state
= &state
;
3862 info
.result
.symbols
= &m_symbols
;
3863 info
.result
.minimal_symbols
= &m_minimal_symbols
;
3864 std::vector
<symtab
*> all_symtabs
;
3865 if (search_symtabs
== nullptr)
3867 all_symtabs
.push_back (nullptr);
3868 search_symtabs
= &all_symtabs
;
3870 info
.file_symtabs
= search_symtabs
;
3872 add_matching_symbols_to_info (name
.c_str (), symbol_name_match_type::WILD
,
3873 search_domain
, &info
, search_pspace
);
3876 /* Look up a function symbol named NAME in symtabs FILE_SYMTABS. Matching
3877 debug symbols are returned in SYMBOLS. Matching minimal symbols are
3878 returned in MINSYMS. */
3881 find_function_symbols (struct linespec_state
*state
,
3882 std::vector
<symtab
*> *file_symtabs
, const char *name
,
3883 symbol_name_match_type name_match_type
,
3884 std::vector
<block_symbol
> *symbols
,
3885 std::vector
<bound_minimal_symbol
> *minsyms
)
3887 struct collect_info info
;
3888 std::vector
<const char *> symbol_names
;
3891 info
.result
.symbols
= symbols
;
3892 info
.result
.minimal_symbols
= minsyms
;
3893 info
.file_symtabs
= file_symtabs
;
3895 /* Try NAME as an Objective-C selector. */
3896 find_imps (name
, &symbol_names
);
3897 if (!symbol_names
.empty ())
3898 add_all_symbol_names_from_pspace (&info
, state
->search_pspace
,
3899 symbol_names
, FUNCTIONS_DOMAIN
);
3901 add_matching_symbols_to_info (name
, name_match_type
, FUNCTIONS_DOMAIN
,
3902 &info
, state
->search_pspace
);
3905 /* Find all symbols named NAME in FILE_SYMTABS, returning debug symbols
3906 in SYMBOLS and minimal symbols in MINSYMS. */
3909 find_linespec_symbols (struct linespec_state
*state
,
3910 std::vector
<symtab
*> *file_symtabs
,
3911 const char *lookup_name
,
3912 symbol_name_match_type name_match_type
,
3913 std::vector
<block_symbol
> *symbols
,
3914 std::vector
<bound_minimal_symbol
> *minsyms
)
3916 std::string canon
= cp_canonicalize_string_no_typedefs (lookup_name
);
3917 if (!canon
.empty ())
3918 lookup_name
= canon
.c_str ();
3920 /* It's important to not call expand_symtabs_matching unnecessarily
3921 as it can really slow things down (by unnecessarily expanding
3922 potentially 1000s of symtabs, which when debugging some apps can
3923 cost 100s of seconds). Avoid this to some extent by *first* calling
3924 find_function_symbols, and only if that doesn't find anything
3925 *then* call find_method. This handles two important cases:
3926 1) break (anonymous namespace)::foo
3927 2) break class::method where method is in class (and not a baseclass) */
3929 find_function_symbols (state
, file_symtabs
, lookup_name
,
3930 name_match_type
, symbols
, minsyms
);
3932 /* If we were unable to locate a symbol of the same name, try dividing
3933 the name into class and method names and searching the class and its
3935 if (symbols
->empty () && minsyms
->empty ())
3937 std::string klass
, method
;
3938 const char *last
, *p
, *scope_op
;
3940 /* See if we can find a scope operator and break this symbol
3941 name into namespaces${SCOPE_OPERATOR}class_name and method_name. */
3943 p
= find_toplevel_string (lookup_name
, scope_op
);
3949 p
= find_toplevel_string (p
+ strlen (scope_op
), scope_op
);
3952 /* If no scope operator was found, there is nothing more we can do;
3953 we already attempted to lookup the entire name as a symbol
3958 /* LOOKUP_NAME points to the class name.
3959 LAST points to the method name. */
3960 klass
= std::string (lookup_name
, last
- lookup_name
);
3962 /* Skip past the scope operator. */
3963 last
+= strlen (scope_op
);
3966 /* Find a list of classes named KLASS. */
3967 std::vector
<block_symbol
> classes
3968 = lookup_prefix_sym (state
, file_symtabs
, klass
.c_str ());
3969 if (!classes
.empty ())
3971 /* Now locate a list of suitable methods named METHOD. */
3974 find_method (state
, file_symtabs
,
3975 klass
.c_str (), method
.c_str (),
3976 &classes
, symbols
, minsyms
);
3979 /* If successful, we're done. If NOT_FOUND_ERROR
3980 was not thrown, rethrow the exception that we did get. */
3981 CATCH (except
, RETURN_MASK_ERROR
)
3983 if (except
.error
!= NOT_FOUND_ERROR
)
3984 throw_exception (except
);
3991 /* Helper for find_label_symbols. Find all labels that match name
3992 NAME in BLOCK. Return all labels that match in FUNCTION_SYMBOLS.
3993 Return the actual function symbol in which the label was found in
3994 LABEL_FUNC_RET. If COMPLETION_MODE is true, then NAME is
3995 interpreted as a label name prefix. Otherwise, only a label named
3996 exactly NAME match. */
3999 find_label_symbols_in_block (const struct block
*block
,
4000 const char *name
, struct symbol
*fn_sym
,
4001 bool completion_mode
,
4002 std::vector
<block_symbol
> *result
,
4003 std::vector
<block_symbol
> *label_funcs_ret
)
4005 if (completion_mode
)
4007 struct block_iterator iter
;
4009 size_t name_len
= strlen (name
);
4011 int (*cmp
) (const char *, const char *, size_t);
4012 cmp
= case_sensitivity
== case_sensitive_on
? strncmp
: strncasecmp
;
4014 ALL_BLOCK_SYMBOLS (block
, iter
, sym
)
4016 if (symbol_matches_domain (SYMBOL_LANGUAGE (sym
),
4017 SYMBOL_DOMAIN (sym
), LABEL_DOMAIN
)
4018 && cmp (SYMBOL_SEARCH_NAME (sym
), name
, name_len
) == 0)
4020 result
->push_back ({sym
, block
});
4021 label_funcs_ret
->push_back ({fn_sym
, block
});
4027 struct block_symbol label_sym
4028 = lookup_symbol (name
, block
, LABEL_DOMAIN
, 0);
4030 if (label_sym
.symbol
!= NULL
)
4032 result
->push_back (label_sym
);
4033 label_funcs_ret
->push_back ({fn_sym
, block
});
4038 /* Return all labels that match name NAME in FUNCTION_SYMBOLS or NULL
4039 if no matches were found.
4041 Return the actual function symbol in which the label was found in
4042 LABEL_FUNC_RET. If COMPLETION_MODE is true, then NAME is
4043 interpreted as a label name prefix. Otherwise, only labels named
4044 exactly NAME match. */
4047 static std::vector
<block_symbol
> *
4048 find_label_symbols (struct linespec_state
*self
,
4049 std::vector
<block_symbol
> *function_symbols
,
4050 std::vector
<block_symbol
> *label_funcs_ret
,
4052 bool completion_mode
)
4054 const struct block
*block
;
4055 struct symbol
*fn_sym
;
4056 std::vector
<block_symbol
> result
;
4058 if (function_symbols
== NULL
)
4060 set_current_program_space (self
->program_space
);
4061 block
= get_current_search_block ();
4064 block
&& !BLOCK_FUNCTION (block
);
4065 block
= BLOCK_SUPERBLOCK (block
))
4069 fn_sym
= BLOCK_FUNCTION (block
);
4071 find_label_symbols_in_block (block
, name
, fn_sym
, completion_mode
,
4072 &result
, label_funcs_ret
);
4076 for (const auto &elt
: *function_symbols
)
4078 fn_sym
= elt
.symbol
;
4079 set_current_program_space (SYMTAB_PSPACE (symbol_symtab (fn_sym
)));
4080 block
= SYMBOL_BLOCK_VALUE (fn_sym
);
4082 find_label_symbols_in_block (block
, name
, fn_sym
, completion_mode
,
4083 &result
, label_funcs_ret
);
4087 if (!result
.empty ())
4088 return new std::vector
<block_symbol
> (std::move (result
));
4094 /* A helper for create_sals_line_offset that handles the 'list_mode' case. */
4096 static std::vector
<symtab_and_line
>
4097 decode_digits_list_mode (struct linespec_state
*self
,
4099 struct symtab_and_line val
)
4101 gdb_assert (self
->list_mode
);
4103 std::vector
<symtab_and_line
> values
;
4105 for (const auto &elt
: *ls
->file_symtabs
)
4107 /* The logic above should ensure this. */
4108 gdb_assert (elt
!= NULL
);
4110 set_current_program_space (SYMTAB_PSPACE (elt
));
4112 /* Simplistic search just for the list command. */
4113 val
.symtab
= find_line_symtab (elt
, val
.line
, NULL
, NULL
);
4114 if (val
.symtab
== NULL
)
4116 val
.pspace
= SYMTAB_PSPACE (elt
);
4118 val
.explicit_line
= 1;
4120 add_sal_to_sals (self
, &values
, &val
, NULL
, 0);
4126 /* A helper for create_sals_line_offset that iterates over the symtabs,
4127 adding lines to the VEC. */
4129 static std::vector
<symtab_and_line
>
4130 decode_digits_ordinary (struct linespec_state
*self
,
4133 struct linetable_entry
**best_entry
)
4135 std::vector
<symtab_and_line
> sals
;
4136 for (const auto &elt
: *ls
->file_symtabs
)
4138 std::vector
<CORE_ADDR
> pcs
;
4140 /* The logic above should ensure this. */
4141 gdb_assert (elt
!= NULL
);
4143 set_current_program_space (SYMTAB_PSPACE (elt
));
4145 pcs
= find_pcs_for_symtab_line (elt
, line
, best_entry
);
4146 for (CORE_ADDR pc
: pcs
)
4148 symtab_and_line sal
;
4149 sal
.pspace
= SYMTAB_PSPACE (elt
);
4153 sals
.push_back (std::move (sal
));
4162 /* Return the line offset represented by VARIABLE. */
4164 static struct line_offset
4165 linespec_parse_variable (struct linespec_state
*self
, const char *variable
)
4169 struct line_offset offset
= {0, LINE_OFFSET_NONE
};
4171 p
= (variable
[1] == '$') ? variable
+ 2 : variable
+ 1;
4174 while (*p
>= '0' && *p
<= '9')
4176 if (!*p
) /* Reached end of token without hitting non-digit. */
4178 /* We have a value history reference. */
4179 struct value
*val_history
;
4181 sscanf ((variable
[1] == '$') ? variable
+ 2 : variable
+ 1, "%d", &index
);
4183 = access_value_history ((variable
[1] == '$') ? -index
: index
);
4184 if (TYPE_CODE (value_type (val_history
)) != TYPE_CODE_INT
)
4185 error (_("History values used in line "
4186 "specs must have integer values."));
4187 offset
.offset
= value_as_long (val_history
);
4191 /* Not all digits -- may be user variable/function or a
4192 convenience variable. */
4194 struct internalvar
*ivar
;
4196 /* Try it as a convenience variable. If it is not a convenience
4197 variable, return and allow normal symbol lookup to occur. */
4198 ivar
= lookup_only_internalvar (variable
+ 1);
4200 /* No internal variable with that name. Mark the offset
4201 as unknown to allow the name to be looked up as a symbol. */
4202 offset
.sign
= LINE_OFFSET_UNKNOWN
;
4205 /* We found a valid variable name. If it is not an integer,
4207 if (!get_internalvar_integer (ivar
, &valx
))
4208 error (_("Convenience variables used in line "
4209 "specs must have integer values."));
4211 offset
.offset
= valx
;
4219 /* We've found a minimal symbol MSYMBOL in OBJFILE to associate with our
4220 linespec; return the SAL in RESULT. This function should return SALs
4221 matching those from find_function_start_sal, otherwise false
4222 multiple-locations breakpoints could be placed. */
4225 minsym_found (struct linespec_state
*self
, struct objfile
*objfile
,
4226 struct minimal_symbol
*msymbol
,
4227 std::vector
<symtab_and_line
> *result
)
4229 bool want_start_sal
;
4231 CORE_ADDR func_addr
;
4232 bool is_function
= msymbol_is_function (objfile
, msymbol
, &func_addr
);
4236 const char *msym_name
= MSYMBOL_LINKAGE_NAME (msymbol
);
4238 if (MSYMBOL_TYPE (msymbol
) == mst_text_gnu_ifunc
4239 || MSYMBOL_TYPE (msymbol
) == mst_data_gnu_ifunc
)
4240 want_start_sal
= gnu_ifunc_resolve_name (msym_name
, &func_addr
);
4242 want_start_sal
= true;
4245 symtab_and_line sal
;
4247 if (is_function
&& want_start_sal
)
4248 sal
= find_function_start_sal (func_addr
, NULL
, self
->funfirstline
);
4251 sal
.objfile
= objfile
;
4252 sal
.msymbol
= msymbol
;
4253 /* Store func_addr, not the minsym's address in case this was an
4254 ifunc that hasn't been resolved yet. */
4258 sal
.pc
= MSYMBOL_VALUE_ADDRESS (objfile
, msymbol
);
4259 sal
.pspace
= current_program_space
;
4262 sal
.section
= MSYMBOL_OBJ_SECTION (objfile
, msymbol
);
4264 if (maybe_add_address (self
->addr_set
, objfile
->pspace
, sal
.pc
))
4265 add_sal_to_sals (self
, result
, &sal
, MSYMBOL_NATURAL_NAME (msymbol
), 0);
4268 /* A helper function to classify a minimal_symbol_type according to
4272 classify_mtype (enum minimal_symbol_type t
)
4279 /* Intermediate priority. */
4282 case mst_solib_trampoline
:
4283 /* Lowest priority. */
4287 /* Highest priority. */
4292 /* Callback for std::sort that sorts symbols by priority. */
4295 compare_msyms (const bound_minimal_symbol
&a
, const bound_minimal_symbol
&b
)
4297 enum minimal_symbol_type ta
= MSYMBOL_TYPE (a
.minsym
);
4298 enum minimal_symbol_type tb
= MSYMBOL_TYPE (b
.minsym
);
4300 return classify_mtype (ta
) < classify_mtype (tb
);
4303 /* Helper for search_minsyms_for_name that adds the symbol to the
4307 add_minsym (struct minimal_symbol
*minsym
, struct objfile
*objfile
,
4308 struct symtab
*symtab
, int list_mode
,
4309 std::vector
<struct bound_minimal_symbol
> *msyms
)
4313 /* We're looking for a label for which we don't have debug
4315 CORE_ADDR func_addr
;
4316 if (msymbol_is_function (objfile
, minsym
, &func_addr
))
4318 symtab_and_line sal
= find_pc_sect_line (func_addr
, NULL
, 0);
4320 if (symtab
!= sal
.symtab
)
4325 /* Exclude data symbols when looking for breakpoint locations. */
4326 if (!list_mode
&& !msymbol_is_function (objfile
, minsym
))
4329 struct bound_minimal_symbol mo
= {minsym
, objfile
};
4330 msyms
->push_back (mo
);
4334 /* Search for minimal symbols called NAME. If SEARCH_PSPACE
4335 is not NULL, the search is restricted to just that program
4338 If SYMTAB is NULL, search all objfiles, otherwise
4339 restrict results to the given SYMTAB. */
4342 search_minsyms_for_name (struct collect_info
*info
,
4343 const lookup_name_info
&name
,
4344 struct program_space
*search_pspace
,
4345 struct symtab
*symtab
)
4347 std::vector
<struct bound_minimal_symbol
> minsyms
;
4351 struct program_space
*pspace
;
4353 ALL_PSPACES (pspace
)
4355 if (search_pspace
!= NULL
&& search_pspace
!= pspace
)
4357 if (pspace
->executing_startup
)
4360 set_current_program_space (pspace
);
4362 for (objfile
*objfile
: all_objfiles (current_program_space
))
4364 iterate_over_minimal_symbols (objfile
, name
,
4365 [&] (struct minimal_symbol
*msym
)
4367 add_minsym (msym
, objfile
, nullptr,
4368 info
->state
->list_mode
,
4377 if (search_pspace
== NULL
|| SYMTAB_PSPACE (symtab
) == search_pspace
)
4379 set_current_program_space (SYMTAB_PSPACE (symtab
));
4380 iterate_over_minimal_symbols
4381 (SYMTAB_OBJFILE (symtab
), name
,
4382 [&] (struct minimal_symbol
*msym
)
4384 add_minsym (msym
, SYMTAB_OBJFILE (symtab
), symtab
,
4385 info
->state
->list_mode
, &minsyms
);
4391 if (!minsyms
.empty ())
4395 std::sort (minsyms
.begin (), minsyms
.end (), compare_msyms
);
4397 /* Now the minsyms are in classification order. So, we walk
4398 over them and process just the minsyms with the same
4399 classification as the very first minsym in the list. */
4400 classification
= classify_mtype (MSYMBOL_TYPE (minsyms
[0].minsym
));
4402 for (const bound_minimal_symbol
&item
: minsyms
)
4404 if (classify_mtype (MSYMBOL_TYPE (item
.minsym
)) != classification
)
4407 info
->result
.minimal_symbols
->push_back (item
);
4412 /* A helper function to add all symbols matching NAME to INFO. If
4413 PSPACE is not NULL, the search is restricted to just that program
4417 add_matching_symbols_to_info (const char *name
,
4418 symbol_name_match_type name_match_type
,
4419 enum search_domain search_domain
,
4420 struct collect_info
*info
,
4421 struct program_space
*pspace
)
4423 lookup_name_info
lookup_name (name
, name_match_type
);
4425 for (const auto &elt
: *info
->file_symtabs
)
4429 iterate_over_all_matching_symtabs (info
->state
, lookup_name
,
4430 VAR_DOMAIN
, search_domain
,
4432 [&] (block_symbol
*bsym
)
4433 { return info
->add_symbol (bsym
); });
4434 search_minsyms_for_name (info
, lookup_name
, pspace
, NULL
);
4436 else if (pspace
== NULL
|| pspace
== SYMTAB_PSPACE (elt
))
4438 int prev_len
= info
->result
.symbols
->size ();
4440 /* Program spaces that are executing startup should have
4441 been filtered out earlier. */
4442 gdb_assert (!SYMTAB_PSPACE (elt
)->executing_startup
);
4443 set_current_program_space (SYMTAB_PSPACE (elt
));
4444 iterate_over_file_blocks (elt
, lookup_name
, VAR_DOMAIN
,
4445 [&] (block_symbol
*bsym
)
4446 { return info
->add_symbol (bsym
); });
4448 /* If no new symbols were found in this iteration and this symtab
4449 is in assembler, we might actually be looking for a label for
4450 which we don't have debug info. Check for a minimal symbol in
4452 if (prev_len
== info
->result
.symbols
->size ()
4453 && elt
->language
== language_asm
)
4454 search_minsyms_for_name (info
, lookup_name
, pspace
, elt
);
4461 /* Now come some functions that are called from multiple places within
4465 symbol_to_sal (struct symtab_and_line
*result
,
4466 int funfirstline
, struct symbol
*sym
)
4468 if (SYMBOL_CLASS (sym
) == LOC_BLOCK
)
4470 *result
= find_function_start_sal (sym
, funfirstline
);
4475 if (SYMBOL_CLASS (sym
) == LOC_LABEL
&& SYMBOL_VALUE_ADDRESS (sym
) != 0)
4478 result
->symtab
= symbol_symtab (sym
);
4479 result
->symbol
= sym
;
4480 result
->line
= SYMBOL_LINE (sym
);
4481 result
->pc
= SYMBOL_VALUE_ADDRESS (sym
);
4482 result
->pspace
= SYMTAB_PSPACE (result
->symtab
);
4483 result
->explicit_pc
= 1;
4486 else if (funfirstline
)
4490 else if (SYMBOL_LINE (sym
) != 0)
4492 /* We know its line number. */
4494 result
->symtab
= symbol_symtab (sym
);
4495 result
->symbol
= sym
;
4496 result
->line
= SYMBOL_LINE (sym
);
4497 result
->pc
= SYMBOL_VALUE_ADDRESS (sym
);
4498 result
->pspace
= SYMTAB_PSPACE (result
->symtab
);
4506 linespec_result::~linespec_result ()
4508 for (linespec_sals
&lsal
: lsals
)
4509 xfree (lsal
.canonical
);
4512 /* Return the quote characters permitted by the linespec parser. */
4515 get_gdb_linespec_parser_quote_characters (void)
4517 return linespec_quote_characters
;