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 objfile
*objfile
;
1134 struct program_space
*pspace
;
1136 ALL_PSPACES (pspace
)
1138 if (search_pspace
!= NULL
&& search_pspace
!= pspace
)
1140 if (pspace
->executing_startup
)
1143 set_current_program_space (pspace
);
1145 ALL_OBJFILES (objfile
)
1147 struct compunit_symtab
*cu
;
1150 objfile
->sf
->qf
->expand_symtabs_matching (objfile
,
1156 ALL_OBJFILE_COMPUNITS (objfile
, cu
)
1158 struct symtab
*symtab
= COMPUNIT_FILETABS (cu
);
1160 iterate_over_file_blocks (symtab
, lookup_name
, name_domain
, callback
);
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
, [&] (block_symbol
*bsym
)
1175 /* Restrict calls to CALLBACK to symbols
1176 representing inline symbols only. */
1177 if (SYMBOL_INLINED (bsym
->symbol
))
1178 return callback (bsym
);
1188 /* Returns the block to be used for symbol searches from
1189 the current location. */
1191 static const struct block
*
1192 get_current_search_block (void)
1194 const struct block
*block
;
1195 enum language save_language
;
1197 /* get_selected_block can change the current language when there is
1198 no selected frame yet. */
1199 save_language
= current_language
->la_language
;
1200 block
= get_selected_block (0);
1201 set_language (save_language
);
1206 /* Iterate over static and global blocks. */
1209 iterate_over_file_blocks
1210 (struct symtab
*symtab
, const lookup_name_info
&name
,
1211 domain_enum domain
, gdb::function_view
<symbol_found_callback_ftype
> callback
)
1213 struct block
*block
;
1215 for (block
= BLOCKVECTOR_BLOCK (SYMTAB_BLOCKVECTOR (symtab
), STATIC_BLOCK
);
1217 block
= BLOCK_SUPERBLOCK (block
))
1218 LA_ITERATE_OVER_SYMBOLS (block
, name
, domain
, callback
);
1221 /* A helper for find_method. This finds all methods in type T of
1222 language T_LANG which match NAME. It adds matching symbol names to
1223 RESULT_NAMES, and adds T's direct superclasses to SUPERCLASSES. */
1226 find_methods (struct type
*t
, enum language t_lang
, const char *name
,
1227 std::vector
<const char *> *result_names
,
1228 std::vector
<struct type
*> *superclasses
)
1231 const char *class_name
= TYPE_NAME (t
);
1233 /* Ignore this class if it doesn't have a name. This is ugly, but
1234 unless we figure out how to get the physname without the name of
1235 the class, then the loop can't do any good. */
1239 lookup_name_info
lookup_name (name
, symbol_name_match_type::FULL
);
1240 symbol_name_matcher_ftype
*symbol_name_compare
1241 = get_symbol_name_matcher (language_def (t_lang
), lookup_name
);
1243 t
= check_typedef (t
);
1245 /* Loop over each method name. At this level, all overloads of a name
1246 are counted as a single name. There is an inner loop which loops over
1249 for (method_counter
= TYPE_NFN_FIELDS (t
) - 1;
1250 method_counter
>= 0;
1253 const char *method_name
= TYPE_FN_FIELDLIST_NAME (t
, method_counter
);
1255 if (symbol_name_compare (method_name
, lookup_name
, NULL
))
1259 for (field_counter
= (TYPE_FN_FIELDLIST_LENGTH (t
, method_counter
)
1265 const char *phys_name
;
1267 f
= TYPE_FN_FIELDLIST1 (t
, method_counter
);
1268 if (TYPE_FN_FIELD_STUB (f
, field_counter
))
1270 phys_name
= TYPE_FN_FIELD_PHYSNAME (f
, field_counter
);
1271 result_names
->push_back (phys_name
);
1277 for (ibase
= 0; ibase
< TYPE_N_BASECLASSES (t
); ibase
++)
1278 superclasses
->push_back (TYPE_BASECLASS (t
, ibase
));
1281 /* Find an instance of the character C in the string S that is outside
1282 of all parenthesis pairs, single-quoted strings, and double-quoted
1283 strings. Also, ignore the char within a template name, like a ','
1284 within foo<int, int>, while considering C++ operator</operator<<. */
1287 find_toplevel_char (const char *s
, char c
)
1289 int quoted
= 0; /* zero if we're not in quotes;
1290 '"' if we're in a double-quoted string;
1291 '\'' if we're in a single-quoted string. */
1292 int depth
= 0; /* Number of unclosed parens we've seen. */
1295 for (scan
= s
; *scan
; scan
++)
1299 if (*scan
== quoted
)
1301 else if (*scan
== '\\' && *(scan
+ 1))
1304 else if (*scan
== c
&& ! quoted
&& depth
== 0)
1306 else if (*scan
== '"' || *scan
== '\'')
1308 else if (*scan
== '(' || *scan
== '<')
1310 else if ((*scan
== ')' || *scan
== '>') && depth
> 0)
1312 else if (*scan
== 'o' && !quoted
&& depth
== 0)
1314 /* Handle C++ operator names. */
1315 if (strncmp (scan
, CP_OPERATOR_STR
, CP_OPERATOR_LEN
) == 0)
1317 scan
+= CP_OPERATOR_LEN
;
1320 while (isspace (*scan
))
1331 /* Skip over one less than the appropriate number of
1332 characters: the for loop will skip over the last
1358 /* The string equivalent of find_toplevel_char. Returns a pointer
1359 to the location of NEEDLE in HAYSTACK, ignoring any occurrences
1360 inside "()" and "<>". Returns NULL if NEEDLE was not found. */
1363 find_toplevel_string (const char *haystack
, const char *needle
)
1365 const char *s
= haystack
;
1369 s
= find_toplevel_char (s
, *needle
);
1373 /* Found first char in HAYSTACK; check rest of string. */
1374 if (startswith (s
, needle
))
1377 /* Didn't find it; loop over HAYSTACK, looking for the next
1378 instance of the first character of NEEDLE. */
1382 while (s
!= NULL
&& *s
!= '\0');
1384 /* NEEDLE was not found in HAYSTACK. */
1388 /* Convert CANONICAL to its string representation using
1389 symtab_to_fullname for SYMTAB. */
1392 canonical_to_fullform (const struct linespec_canonical_name
*canonical
)
1394 if (canonical
->symtab
== NULL
)
1395 return canonical
->suffix
;
1397 return string_printf ("%s:%s", symtab_to_fullname (canonical
->symtab
),
1401 /* Given FILTERS, a list of canonical names, filter the sals in RESULT
1402 and store the result in SELF->CANONICAL. */
1405 filter_results (struct linespec_state
*self
,
1406 std::vector
<symtab_and_line
> *result
,
1407 const std::vector
<const char *> &filters
)
1409 for (const char *name
: filters
)
1413 for (size_t j
= 0; j
< result
->size (); ++j
)
1415 const struct linespec_canonical_name
*canonical
;
1417 canonical
= &self
->canonical_names
[j
];
1418 std::string fullform
= canonical_to_fullform (canonical
);
1420 if (name
== fullform
)
1421 lsal
.sals
.push_back ((*result
)[j
]);
1424 if (!lsal
.sals
.empty ())
1426 lsal
.canonical
= xstrdup (name
);
1427 self
->canonical
->lsals
.push_back (std::move (lsal
));
1431 self
->canonical
->pre_expanded
= 0;
1434 /* Store RESULT into SELF->CANONICAL. */
1437 convert_results_to_lsals (struct linespec_state
*self
,
1438 std::vector
<symtab_and_line
> *result
)
1440 struct linespec_sals lsal
;
1442 lsal
.canonical
= NULL
;
1443 lsal
.sals
= std::move (*result
);
1444 self
->canonical
->lsals
.push_back (std::move (lsal
));
1447 /* A structure that contains two string representations of a struct
1448 linespec_canonical_name:
1449 - one where the the symtab's fullname is used;
1450 - one where the filename followed the "set filename-display"
1453 struct decode_line_2_item
1455 decode_line_2_item (std::string
&&fullform_
, std::string
&&displayform_
,
1457 : fullform (std::move (fullform_
)),
1458 displayform (std::move (displayform_
)),
1459 selected (selected_
)
1463 /* The form using symtab_to_fullname. */
1464 std::string fullform
;
1466 /* The form using symtab_to_filename_for_display. */
1467 std::string displayform
;
1469 /* Field is initialized to zero and it is set to one if the user
1470 requested breakpoint for this entry. */
1471 unsigned int selected
: 1;
1474 /* Helper for std::sort to sort decode_line_2_item entries by
1475 DISPLAYFORM and secondarily by FULLFORM. */
1478 decode_line_2_compare_items (const decode_line_2_item
&a
,
1479 const decode_line_2_item
&b
)
1481 if (a
.displayform
!= b
.displayform
)
1482 return a
.displayform
< b
.displayform
;
1483 return a
.fullform
< b
.fullform
;
1486 /* Handle multiple results in RESULT depending on SELECT_MODE. This
1487 will either return normally, throw an exception on multiple
1488 results, or present a menu to the user. On return, the SALS vector
1489 in SELF->CANONICAL is set up properly. */
1492 decode_line_2 (struct linespec_state
*self
,
1493 std::vector
<symtab_and_line
> *result
,
1494 const char *select_mode
)
1499 std::vector
<const char *> filters
;
1500 std::vector
<struct decode_line_2_item
> items
;
1502 gdb_assert (select_mode
!= multiple_symbols_all
);
1503 gdb_assert (self
->canonical
!= NULL
);
1504 gdb_assert (!result
->empty ());
1506 /* Prepare ITEMS array. */
1507 for (i
= 0; i
< result
->size (); ++i
)
1509 const struct linespec_canonical_name
*canonical
;
1510 std::string displayform
;
1512 canonical
= &self
->canonical_names
[i
];
1513 gdb_assert (canonical
->suffix
!= NULL
);
1515 std::string fullform
= canonical_to_fullform (canonical
);
1517 if (canonical
->symtab
== NULL
)
1518 displayform
= canonical
->suffix
;
1521 const char *fn_for_display
;
1523 fn_for_display
= symtab_to_filename_for_display (canonical
->symtab
);
1524 displayform
= string_printf ("%s:%s", fn_for_display
,
1528 items
.emplace_back (std::move (fullform
), std::move (displayform
),
1532 /* Sort the list of method names. */
1533 std::sort (items
.begin (), items
.end (), decode_line_2_compare_items
);
1535 /* Remove entries with the same FULLFORM. */
1536 items
.erase (std::unique (items
.begin (), items
.end (),
1537 [] (const struct decode_line_2_item
&a
,
1538 const struct decode_line_2_item
&b
)
1540 return a
.fullform
== b
.fullform
;
1544 if (select_mode
== multiple_symbols_cancel
&& items
.size () > 1)
1545 error (_("canceled because the command is ambiguous\n"
1546 "See set/show multiple-symbol."));
1548 if (select_mode
== multiple_symbols_all
|| items
.size () == 1)
1550 convert_results_to_lsals (self
, result
);
1554 printf_unfiltered (_("[0] cancel\n[1] all\n"));
1555 for (i
= 0; i
< items
.size (); i
++)
1556 printf_unfiltered ("[%d] %s\n", i
+ 2, items
[i
].displayform
.c_str ());
1558 prompt
= getenv ("PS2");
1563 args
= command_line_input (prompt
, "overload-choice");
1565 if (args
== 0 || *args
== 0)
1566 error_no_arg (_("one or more choice numbers"));
1568 number_or_range_parser
parser (args
);
1569 while (!parser
.finished ())
1571 int num
= parser
.get_number ();
1574 error (_("canceled"));
1577 /* We intentionally make this result in a single breakpoint,
1578 contrary to what older versions of gdb did. The
1579 rationale is that this lets a user get the
1580 multiple_symbols_all behavior even with the 'ask'
1581 setting; and he can get separate breakpoints by entering
1582 "2-57" at the query. */
1583 convert_results_to_lsals (self
, result
);
1588 if (num
>= items
.size ())
1589 printf_unfiltered (_("No choice number %d.\n"), num
);
1592 struct decode_line_2_item
*item
= &items
[num
];
1594 if (!item
->selected
)
1596 filters
.push_back (item
->fullform
.c_str ());
1601 printf_unfiltered (_("duplicate request for %d ignored.\n"),
1607 filter_results (self
, result
, filters
);
1612 /* The parser of linespec itself. */
1614 /* Throw an appropriate error when SYMBOL is not found (optionally in
1617 static void ATTRIBUTE_NORETURN
1618 symbol_not_found_error (const char *symbol
, const char *filename
)
1623 if (!have_full_symbols ()
1624 && !have_partial_symbols ()
1625 && !have_minimal_symbols ())
1626 throw_error (NOT_FOUND_ERROR
,
1627 _("No symbol table is loaded. Use the \"file\" command."));
1629 /* If SYMBOL starts with '$', the user attempted to either lookup
1630 a function/variable in his code starting with '$' or an internal
1631 variable of that name. Since we do not know which, be concise and
1632 explain both possibilities. */
1636 throw_error (NOT_FOUND_ERROR
,
1637 _("Undefined convenience variable or function \"%s\" "
1638 "not defined in \"%s\"."), symbol
, filename
);
1640 throw_error (NOT_FOUND_ERROR
,
1641 _("Undefined convenience variable or function \"%s\" "
1642 "not defined."), symbol
);
1647 throw_error (NOT_FOUND_ERROR
,
1648 _("Function \"%s\" not defined in \"%s\"."),
1651 throw_error (NOT_FOUND_ERROR
,
1652 _("Function \"%s\" not defined."), symbol
);
1656 /* Throw an appropriate error when an unexpected token is encountered
1659 static void ATTRIBUTE_NORETURN
1660 unexpected_linespec_error (linespec_parser
*parser
)
1662 linespec_token token
;
1663 static const char * token_type_strings
[]
1664 = {"keyword", "colon", "string", "number", "comma", "end of input"};
1666 /* Get the token that generated the error. */
1667 token
= linespec_lexer_lex_one (parser
);
1669 /* Finally, throw the error. */
1670 if (token
.type
== LSTOKEN_STRING
|| token
.type
== LSTOKEN_NUMBER
1671 || token
.type
== LSTOKEN_KEYWORD
)
1673 gdb::unique_xmalloc_ptr
<char> string
= copy_token_string (token
);
1674 throw_error (GENERIC_ERROR
,
1675 _("malformed linespec error: unexpected %s, \"%s\""),
1676 token_type_strings
[token
.type
], string
.get ());
1679 throw_error (GENERIC_ERROR
,
1680 _("malformed linespec error: unexpected %s"),
1681 token_type_strings
[token
.type
]);
1684 /* Throw an undefined label error. */
1686 static void ATTRIBUTE_NORETURN
1687 undefined_label_error (const char *function
, const char *label
)
1689 if (function
!= NULL
)
1690 throw_error (NOT_FOUND_ERROR
,
1691 _("No label \"%s\" defined in function \"%s\"."),
1694 throw_error (NOT_FOUND_ERROR
,
1695 _("No label \"%s\" defined in current function."),
1699 /* Throw a source file not found error. */
1701 static void ATTRIBUTE_NORETURN
1702 source_file_not_found_error (const char *name
)
1704 throw_error (NOT_FOUND_ERROR
, _("No source file named %s."), name
);
1707 /* Unless at EIO, save the current stream position as completion word
1708 point, and consume the next token. */
1710 static linespec_token
1711 save_stream_and_consume_token (linespec_parser
*parser
)
1713 if (linespec_lexer_peek_token (parser
).type
!= LSTOKEN_EOI
)
1714 parser
->completion_word
= PARSER_STREAM (parser
);
1715 return linespec_lexer_consume_token (parser
);
1718 /* See description in linespec.h. */
1721 linespec_parse_line_offset (const char *string
)
1723 const char *start
= string
;
1724 struct line_offset line_offset
= {0, LINE_OFFSET_NONE
};
1728 line_offset
.sign
= LINE_OFFSET_PLUS
;
1731 else if (*string
== '-')
1733 line_offset
.sign
= LINE_OFFSET_MINUS
;
1737 if (*string
!= '\0' && !isdigit (*string
))
1738 error (_("malformed line offset: \"%s\""), start
);
1740 /* Right now, we only allow base 10 for offsets. */
1741 line_offset
.offset
= atoi (string
);
1745 /* In completion mode, if the user is still typing the number, there's
1746 no possible completion to offer. But if there's already input past
1747 the number, setup to expect NEXT. */
1750 set_completion_after_number (linespec_parser
*parser
,
1751 linespec_complete_what next
)
1753 if (*PARSER_STREAM (parser
) == ' ')
1755 parser
->completion_word
= skip_spaces (PARSER_STREAM (parser
) + 1);
1756 parser
->complete_what
= next
;
1760 parser
->completion_word
= PARSER_STREAM (parser
);
1761 parser
->complete_what
= linespec_complete_what::NOTHING
;
1765 /* Parse the basic_spec in PARSER's input. */
1768 linespec_parse_basic (linespec_parser
*parser
)
1770 gdb::unique_xmalloc_ptr
<char> name
;
1771 linespec_token token
;
1772 std::vector
<block_symbol
> symbols
;
1773 std::vector
<block_symbol
> *labels
;
1774 std::vector
<bound_minimal_symbol
> minimal_symbols
;
1776 /* Get the next token. */
1777 token
= linespec_lexer_lex_one (parser
);
1779 /* If it is EOI or KEYWORD, issue an error. */
1780 if (token
.type
== LSTOKEN_KEYWORD
)
1782 parser
->complete_what
= linespec_complete_what::NOTHING
;
1783 unexpected_linespec_error (parser
);
1785 else if (token
.type
== LSTOKEN_EOI
)
1787 unexpected_linespec_error (parser
);
1789 /* If it is a LSTOKEN_NUMBER, we have an offset. */
1790 else if (token
.type
== LSTOKEN_NUMBER
)
1792 set_completion_after_number (parser
, linespec_complete_what::KEYWORD
);
1794 /* Record the line offset and get the next token. */
1795 name
= copy_token_string (token
);
1796 PARSER_EXPLICIT (parser
)->line_offset
1797 = linespec_parse_line_offset (name
.get ());
1799 /* Get the next token. */
1800 token
= linespec_lexer_consume_token (parser
);
1802 /* If the next token is a comma, stop parsing and return. */
1803 if (token
.type
== LSTOKEN_COMMA
)
1805 parser
->complete_what
= linespec_complete_what::NOTHING
;
1809 /* If the next token is anything but EOI or KEYWORD, issue
1811 if (token
.type
!= LSTOKEN_KEYWORD
&& token
.type
!= LSTOKEN_EOI
)
1812 unexpected_linespec_error (parser
);
1815 if (token
.type
== LSTOKEN_KEYWORD
|| token
.type
== LSTOKEN_EOI
)
1818 /* Next token must be LSTOKEN_STRING. */
1819 if (token
.type
!= LSTOKEN_STRING
)
1821 parser
->complete_what
= linespec_complete_what::NOTHING
;
1822 unexpected_linespec_error (parser
);
1825 /* The current token will contain the name of a function, method,
1827 name
= copy_token_string (token
);
1829 if (parser
->completion_tracker
!= NULL
)
1831 /* If the function name ends with a ":", then this may be an
1832 incomplete "::" scope operator instead of a label separator.
1835 which should expand to:
1838 Do a tentative completion assuming the later. If we find
1839 completions, advance the stream past the colon token and make
1840 it part of the function name/token. */
1842 if (!parser
->completion_quote_char
1843 && strcmp (PARSER_STREAM (parser
), ":") == 0)
1845 completion_tracker tmp_tracker
;
1846 const char *source_filename
1847 = PARSER_EXPLICIT (parser
)->source_filename
;
1848 symbol_name_match_type match_type
1849 = PARSER_EXPLICIT (parser
)->func_name_match_type
;
1851 linespec_complete_function (tmp_tracker
,
1852 parser
->completion_word
,
1856 if (tmp_tracker
.have_completions ())
1858 PARSER_STREAM (parser
)++;
1859 LS_TOKEN_STOKEN (token
).length
++;
1861 name
.reset (savestring (parser
->completion_word
,
1862 (PARSER_STREAM (parser
)
1863 - parser
->completion_word
)));
1867 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1871 /* Try looking it up as a function/method. */
1872 find_linespec_symbols (PARSER_STATE (parser
),
1873 PARSER_RESULT (parser
)->file_symtabs
, name
.get (),
1874 PARSER_EXPLICIT (parser
)->func_name_match_type
,
1875 &symbols
, &minimal_symbols
);
1877 if (!symbols
.empty () || !minimal_symbols
.empty ())
1879 PARSER_RESULT (parser
)->function_symbols
1880 = new std::vector
<block_symbol
> (std::move (symbols
));
1881 PARSER_RESULT (parser
)->minimal_symbols
1882 = new std::vector
<bound_minimal_symbol
>
1883 (std::move (minimal_symbols
));
1884 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1888 /* NAME was not a function or a method. So it must be a label
1889 name or user specified variable like "break foo.c:$zippo". */
1890 labels
= find_label_symbols (PARSER_STATE (parser
), NULL
,
1891 &symbols
, name
.get ());
1894 PARSER_RESULT (parser
)->labels
.label_symbols
= labels
;
1895 PARSER_RESULT (parser
)->labels
.function_symbols
1896 = new std::vector
<block_symbol
> (std::move (symbols
));
1897 PARSER_EXPLICIT (parser
)->label_name
= name
.release ();
1899 else if (token
.type
== LSTOKEN_STRING
1900 && *LS_TOKEN_STOKEN (token
).ptr
== '$')
1902 /* User specified a convenience variable or history value. */
1903 PARSER_EXPLICIT (parser
)->line_offset
1904 = linespec_parse_variable (PARSER_STATE (parser
), name
.get ());
1906 if (PARSER_EXPLICIT (parser
)->line_offset
.sign
== LINE_OFFSET_UNKNOWN
)
1908 /* The user-specified variable was not valid. Do not
1909 throw an error here. parse_linespec will do it for us. */
1910 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1916 /* The name is also not a label. Abort parsing. Do not throw
1917 an error here. parse_linespec will do it for us. */
1919 /* Save a copy of the name we were trying to lookup. */
1920 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1926 int previous_qc
= parser
->completion_quote_char
;
1928 /* Get the next token. */
1929 token
= linespec_lexer_consume_token (parser
);
1931 if (token
.type
== LSTOKEN_EOI
)
1933 if (previous_qc
&& !parser
->completion_quote_char
)
1934 parser
->complete_what
= linespec_complete_what::KEYWORD
;
1936 else if (token
.type
== LSTOKEN_COLON
)
1938 /* User specified a label or a lineno. */
1939 token
= linespec_lexer_consume_token (parser
);
1941 if (token
.type
== LSTOKEN_NUMBER
)
1943 /* User specified an offset. Record the line offset and
1944 get the next token. */
1945 set_completion_after_number (parser
, linespec_complete_what::KEYWORD
);
1947 name
= copy_token_string (token
);
1948 PARSER_EXPLICIT (parser
)->line_offset
1949 = linespec_parse_line_offset (name
.get ());
1951 /* Get the next token. */
1952 token
= linespec_lexer_consume_token (parser
);
1954 else if (token
.type
== LSTOKEN_EOI
&& parser
->completion_tracker
!= NULL
)
1956 parser
->complete_what
= linespec_complete_what::LABEL
;
1958 else if (token
.type
== LSTOKEN_STRING
)
1960 parser
->complete_what
= linespec_complete_what::LABEL
;
1962 /* If we have text after the label separated by whitespace
1963 (e.g., "b func():lab i<tab>"), don't consider it part of
1964 the label. In completion mode that should complete to
1965 "if", in normal mode, the 'i' should be treated as
1967 if (parser
->completion_quote_char
== '\0')
1969 const char *ptr
= LS_TOKEN_STOKEN (token
).ptr
;
1970 for (size_t i
= 0; i
< LS_TOKEN_STOKEN (token
).length
; i
++)
1974 LS_TOKEN_STOKEN (token
).length
= i
;
1975 PARSER_STREAM (parser
) = skip_spaces (ptr
+ i
+ 1);
1981 if (parser
->completion_tracker
!= NULL
)
1983 if (PARSER_STREAM (parser
)[-1] == ' ')
1985 parser
->completion_word
= PARSER_STREAM (parser
);
1986 parser
->complete_what
= linespec_complete_what::KEYWORD
;
1991 /* Grab a copy of the label's name and look it up. */
1992 name
= copy_token_string (token
);
1994 = find_label_symbols (PARSER_STATE (parser
),
1995 PARSER_RESULT (parser
)->function_symbols
,
1996 &symbols
, name
.get ());
2000 PARSER_RESULT (parser
)->labels
.label_symbols
= labels
;
2001 PARSER_RESULT (parser
)->labels
.function_symbols
2002 = new std::vector
<block_symbol
> (std::move (symbols
));
2003 PARSER_EXPLICIT (parser
)->label_name
= name
.release ();
2007 /* We don't know what it was, but it isn't a label. */
2008 undefined_label_error
2009 (PARSER_EXPLICIT (parser
)->function_name
, name
.get ());
2014 /* Check for a line offset. */
2015 token
= save_stream_and_consume_token (parser
);
2016 if (token
.type
== LSTOKEN_COLON
)
2018 /* Get the next token. */
2019 token
= linespec_lexer_consume_token (parser
);
2021 /* It must be a line offset. */
2022 if (token
.type
!= LSTOKEN_NUMBER
)
2023 unexpected_linespec_error (parser
);
2025 /* Record the line offset and get the next token. */
2026 name
= copy_token_string (token
);
2028 PARSER_EXPLICIT (parser
)->line_offset
2029 = linespec_parse_line_offset (name
.get ());
2031 /* Get the next token. */
2032 token
= linespec_lexer_consume_token (parser
);
2037 /* Trailing ':' in the input. Issue an error. */
2038 unexpected_linespec_error (parser
);
2043 /* Canonicalize the linespec contained in LS. The result is saved into
2044 STATE->canonical. This function handles both linespec and explicit
2048 canonicalize_linespec (struct linespec_state
*state
, const linespec_p ls
)
2050 struct event_location
*canon
;
2051 struct explicit_location
*explicit_loc
;
2053 /* If canonicalization was not requested, no need to do anything. */
2054 if (!state
->canonical
)
2057 /* Save everything as an explicit location. */
2058 state
->canonical
->location
2059 = new_explicit_location (&ls
->explicit_loc
);
2060 canon
= state
->canonical
->location
.get ();
2061 explicit_loc
= get_explicit_location (canon
);
2063 if (explicit_loc
->label_name
!= NULL
)
2065 state
->canonical
->special_display
= 1;
2067 if (explicit_loc
->function_name
== NULL
)
2069 /* No function was specified, so add the symbol name. */
2070 gdb_assert (!ls
->labels
.function_symbols
->empty ()
2071 && (ls
->labels
.function_symbols
->size () == 1));
2072 block_symbol s
= ls
->labels
.function_symbols
->front ();
2073 explicit_loc
->function_name
2074 = xstrdup (SYMBOL_NATURAL_NAME (s
.symbol
));
2078 /* If this location originally came from a linespec, save a string
2079 representation of it for display and saving to file. */
2080 if (state
->is_linespec
)
2082 char *linespec
= explicit_location_to_linespec (explicit_loc
);
2084 set_event_location_string (canon
, linespec
);
2089 /* Given a line offset in LS, construct the relevant SALs. */
2091 static std::vector
<symtab_and_line
>
2092 create_sals_line_offset (struct linespec_state
*self
,
2095 int use_default
= 0;
2097 /* This is where we need to make sure we have good defaults.
2098 We must guarantee that this section of code is never executed
2099 when we are called with just a function name, since
2100 set_default_source_symtab_and_line uses
2101 select_source_symtab that calls us with such an argument. */
2103 if (ls
->file_symtabs
->size () == 1
2104 && ls
->file_symtabs
->front () == nullptr)
2106 const char *fullname
;
2108 set_current_program_space (self
->program_space
);
2110 /* Make sure we have at least a default source line. */
2111 set_default_source_symtab_and_line ();
2112 initialize_defaults (&self
->default_symtab
, &self
->default_line
);
2113 fullname
= symtab_to_fullname (self
->default_symtab
);
2115 = collect_symtabs_from_filename (fullname
, self
->search_pspace
);
2119 symtab_and_line val
;
2120 val
.line
= ls
->explicit_loc
.line_offset
.offset
;
2121 switch (ls
->explicit_loc
.line_offset
.sign
)
2123 case LINE_OFFSET_PLUS
:
2124 if (ls
->explicit_loc
.line_offset
.offset
== 0)
2127 val
.line
= self
->default_line
+ val
.line
;
2130 case LINE_OFFSET_MINUS
:
2131 if (ls
->explicit_loc
.line_offset
.offset
== 0)
2134 val
.line
= self
->default_line
- val
.line
;
2136 val
.line
= -val
.line
;
2139 case LINE_OFFSET_NONE
:
2140 break; /* No need to adjust val.line. */
2143 std::vector
<symtab_and_line
> values
;
2144 if (self
->list_mode
)
2145 values
= decode_digits_list_mode (self
, ls
, val
);
2148 struct linetable_entry
*best_entry
= NULL
;
2151 std::vector
<symtab_and_line
> intermediate_results
2152 = decode_digits_ordinary (self
, ls
, val
.line
, &best_entry
);
2153 if (intermediate_results
.empty () && best_entry
!= NULL
)
2154 intermediate_results
= decode_digits_ordinary (self
, ls
,
2158 /* For optimized code, the compiler can scatter one source line
2159 across disjoint ranges of PC values, even when no duplicate
2160 functions or inline functions are involved. For example,
2161 'for (;;)' inside a non-template, non-inline, and non-ctor-or-dtor
2162 function can result in two PC ranges. In this case, we don't
2163 want to set a breakpoint on the first PC of each range. To filter
2164 such cases, we use containing blocks -- for each PC found
2165 above, we see if there are other PCs that are in the same
2166 block. If yes, the other PCs are filtered out. */
2168 gdb::def_vector
<int> filter (intermediate_results
.size ());
2169 gdb::def_vector
<const block
*> blocks (intermediate_results
.size ());
2171 for (i
= 0; i
< intermediate_results
.size (); ++i
)
2173 set_current_program_space (intermediate_results
[i
].pspace
);
2176 blocks
[i
] = block_for_pc_sect (intermediate_results
[i
].pc
,
2177 intermediate_results
[i
].section
);
2180 for (i
= 0; i
< intermediate_results
.size (); ++i
)
2182 if (blocks
[i
] != NULL
)
2183 for (j
= i
+ 1; j
< intermediate_results
.size (); ++j
)
2185 if (blocks
[j
] == blocks
[i
])
2193 for (i
= 0; i
< intermediate_results
.size (); ++i
)
2196 struct symbol
*sym
= (blocks
[i
]
2197 ? block_containing_function (blocks
[i
])
2200 if (self
->funfirstline
)
2201 skip_prologue_sal (&intermediate_results
[i
]);
2202 intermediate_results
[i
].symbol
= sym
;
2203 add_sal_to_sals (self
, &values
, &intermediate_results
[i
],
2204 sym
? SYMBOL_NATURAL_NAME (sym
) : NULL
, 0);
2208 if (values
.empty ())
2210 if (ls
->explicit_loc
.source_filename
)
2211 throw_error (NOT_FOUND_ERROR
, _("No line %d in file \"%s\"."),
2212 val
.line
, ls
->explicit_loc
.source_filename
);
2214 throw_error (NOT_FOUND_ERROR
, _("No line %d in the current file."),
2221 /* Convert the given ADDRESS into SaLs. */
2223 static std::vector
<symtab_and_line
>
2224 convert_address_location_to_sals (struct linespec_state
*self
,
2227 symtab_and_line sal
= find_pc_line (address
, 0);
2229 sal
.section
= find_pc_overlay (address
);
2230 sal
.explicit_pc
= 1;
2231 sal
.symbol
= find_pc_sect_containing_function (sal
.pc
, sal
.section
);
2233 std::vector
<symtab_and_line
> sals
;
2234 add_sal_to_sals (self
, &sals
, &sal
, core_addr_to_string (address
), 1);
2239 /* Create and return SALs from the linespec LS. */
2241 static std::vector
<symtab_and_line
>
2242 convert_linespec_to_sals (struct linespec_state
*state
, linespec_p ls
)
2244 std::vector
<symtab_and_line
> sals
;
2246 if (ls
->labels
.label_symbols
!= NULL
)
2248 /* We have just a bunch of functions/methods or labels. */
2249 struct symtab_and_line sal
;
2251 for (const auto &sym
: *ls
->labels
.label_symbols
)
2253 struct program_space
*pspace
2254 = SYMTAB_PSPACE (symbol_symtab (sym
.symbol
));
2256 if (symbol_to_sal (&sal
, state
->funfirstline
, sym
.symbol
)
2257 && maybe_add_address (state
->addr_set
, pspace
, sal
.pc
))
2258 add_sal_to_sals (state
, &sals
, &sal
,
2259 SYMBOL_NATURAL_NAME (sym
.symbol
), 0);
2262 else if (ls
->function_symbols
!= NULL
|| ls
->minimal_symbols
!= NULL
)
2264 /* We have just a bunch of functions and/or methods. */
2265 if (ls
->function_symbols
!= NULL
)
2267 /* Sort symbols so that symbols with the same program space are next
2269 std::sort (ls
->function_symbols
->begin (),
2270 ls
->function_symbols
->end (),
2273 for (const auto &sym
: *ls
->function_symbols
)
2275 program_space
*pspace
2276 = SYMTAB_PSPACE (symbol_symtab (sym
.symbol
));
2277 set_current_program_space (pspace
);
2279 /* Don't skip to the first line of the function if we
2280 had found an ifunc minimal symbol for this function,
2281 because that means that this function is an ifunc
2282 resolver with the same name as the ifunc itself. */
2283 bool found_ifunc
= false;
2285 if (state
->funfirstline
2286 && ls
->minimal_symbols
!= NULL
2287 && SYMBOL_CLASS (sym
.symbol
) == LOC_BLOCK
)
2289 const CORE_ADDR addr
2290 = BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
.symbol
));
2292 for (const auto &elem
: *ls
->minimal_symbols
)
2294 if (MSYMBOL_TYPE (elem
.minsym
) == mst_text_gnu_ifunc
2295 || MSYMBOL_TYPE (elem
.minsym
) == mst_data_gnu_ifunc
)
2297 CORE_ADDR msym_addr
= BMSYMBOL_VALUE_ADDRESS (elem
);
2298 if (MSYMBOL_TYPE (elem
.minsym
) == mst_data_gnu_ifunc
)
2300 struct gdbarch
*gdbarch
2301 = get_objfile_arch (elem
.objfile
);
2303 = (gdbarch_convert_from_func_ptr_addr
2306 current_top_target ()));
2309 if (msym_addr
== addr
)
2320 symtab_and_line sal
;
2321 if (symbol_to_sal (&sal
, state
->funfirstline
, sym
.symbol
)
2322 && maybe_add_address (state
->addr_set
, pspace
, sal
.pc
))
2323 add_sal_to_sals (state
, &sals
, &sal
,
2324 SYMBOL_NATURAL_NAME (sym
.symbol
), 0);
2329 if (ls
->minimal_symbols
!= NULL
)
2331 /* Sort minimal symbols by program space, too */
2332 std::sort (ls
->minimal_symbols
->begin (),
2333 ls
->minimal_symbols
->end (),
2336 for (const auto &elem
: *ls
->minimal_symbols
)
2338 program_space
*pspace
= elem
.objfile
->pspace
;
2339 set_current_program_space (pspace
);
2340 minsym_found (state
, elem
.objfile
, elem
.minsym
, &sals
);
2344 else if (ls
->explicit_loc
.line_offset
.sign
!= LINE_OFFSET_UNKNOWN
)
2346 /* Only an offset was specified. */
2347 sals
= create_sals_line_offset (state
, ls
);
2349 /* Make sure we have a filename for canonicalization. */
2350 if (ls
->explicit_loc
.source_filename
== NULL
)
2352 const char *fullname
= symtab_to_fullname (state
->default_symtab
);
2354 /* It may be more appropriate to keep DEFAULT_SYMTAB in its symtab
2355 form so that displaying SOURCE_FILENAME can follow the current
2356 FILENAME_DISPLAY_STRING setting. But as it is used only rarely
2357 it has been kept for code simplicity only in absolute form. */
2358 ls
->explicit_loc
.source_filename
= xstrdup (fullname
);
2363 /* We haven't found any results... */
2367 canonicalize_linespec (state
, ls
);
2369 if (!sals
.empty () && state
->canonical
!= NULL
)
2370 state
->canonical
->pre_expanded
= 1;
2375 /* Build RESULT from the explicit location components SOURCE_FILENAME,
2376 FUNCTION_NAME, LABEL_NAME and LINE_OFFSET. */
2379 convert_explicit_location_to_linespec (struct linespec_state
*self
,
2381 const char *source_filename
,
2382 const char *function_name
,
2383 symbol_name_match_type fname_match_type
,
2384 const char *label_name
,
2385 struct line_offset line_offset
)
2387 std::vector
<block_symbol
> symbols
;
2388 std::vector
<block_symbol
> *labels
;
2389 std::vector
<bound_minimal_symbol
> minimal_symbols
;
2391 result
->explicit_loc
.func_name_match_type
= fname_match_type
;
2393 if (source_filename
!= NULL
)
2397 *result
->file_symtabs
2398 = symtabs_from_filename (source_filename
, self
->search_pspace
);
2400 CATCH (except
, RETURN_MASK_ERROR
)
2402 source_file_not_found_error (source_filename
);
2405 result
->explicit_loc
.source_filename
= xstrdup (source_filename
);
2409 /* A NULL entry means to use the default symtab. */
2410 result
->file_symtabs
->push_back (nullptr);
2413 if (function_name
!= NULL
)
2415 find_linespec_symbols (self
, result
->file_symtabs
,
2416 function_name
, fname_match_type
,
2417 &symbols
, &minimal_symbols
);
2419 if (symbols
.empty () && minimal_symbols
.empty ())
2420 symbol_not_found_error (function_name
,
2421 result
->explicit_loc
.source_filename
);
2423 result
->explicit_loc
.function_name
= xstrdup (function_name
);
2424 result
->function_symbols
2425 = new std::vector
<block_symbol
> (std::move (symbols
));
2426 result
->minimal_symbols
2427 = new std::vector
<bound_minimal_symbol
> (std::move (minimal_symbols
));
2430 if (label_name
!= NULL
)
2432 labels
= find_label_symbols (self
, result
->function_symbols
,
2433 &symbols
, label_name
);
2436 undefined_label_error (result
->explicit_loc
.function_name
,
2439 result
->explicit_loc
.label_name
= xstrdup (label_name
);
2440 result
->labels
.label_symbols
= labels
;
2441 result
->labels
.function_symbols
2442 = new std::vector
<block_symbol
> (std::move (symbols
));
2445 if (line_offset
.sign
!= LINE_OFFSET_UNKNOWN
)
2446 result
->explicit_loc
.line_offset
= line_offset
;
2449 /* Convert the explicit location EXPLICIT_LOC into SaLs. */
2451 static std::vector
<symtab_and_line
>
2452 convert_explicit_location_to_sals (struct linespec_state
*self
,
2454 const struct explicit_location
*explicit_loc
)
2456 convert_explicit_location_to_linespec (self
, result
,
2457 explicit_loc
->source_filename
,
2458 explicit_loc
->function_name
,
2459 explicit_loc
->func_name_match_type
,
2460 explicit_loc
->label_name
,
2461 explicit_loc
->line_offset
);
2462 return convert_linespec_to_sals (self
, result
);
2465 /* Parse a string that specifies a linespec.
2467 The basic grammar of linespecs:
2469 linespec -> var_spec | basic_spec
2470 var_spec -> '$' (STRING | NUMBER)
2472 basic_spec -> file_offset_spec | function_spec | label_spec
2473 file_offset_spec -> opt_file_spec offset_spec
2474 function_spec -> opt_file_spec function_name_spec opt_label_spec
2475 label_spec -> label_name_spec
2477 opt_file_spec -> "" | file_name_spec ':'
2478 opt_label_spec -> "" | ':' label_name_spec
2480 file_name_spec -> STRING
2481 function_name_spec -> STRING
2482 label_name_spec -> STRING
2483 function_name_spec -> STRING
2484 offset_spec -> NUMBER
2488 This may all be followed by several keywords such as "if EXPR",
2491 A comma will terminate parsing.
2493 The function may be an undebuggable function found in minimal symbol table.
2495 If the argument FUNFIRSTLINE is nonzero, we want the first line
2496 of real code inside a function when a function is specified, and it is
2497 not OK to specify a variable or type to get its line number.
2499 DEFAULT_SYMTAB specifies the file to use if none is specified.
2500 It defaults to current_source_symtab.
2501 DEFAULT_LINE specifies the line number to use for relative
2502 line numbers (that start with signs). Defaults to current_source_line.
2503 If CANONICAL is non-NULL, store an array of strings containing the canonical
2504 line specs there if necessary. Currently overloaded member functions and
2505 line numbers or static functions without a filename yield a canonical
2506 line spec. The array and the line spec strings are allocated on the heap,
2507 it is the callers responsibility to free them.
2509 Note that it is possible to return zero for the symtab
2510 if no file is validly specified. Callers must check that.
2511 Also, the line number returned may be invalid. */
2513 /* Parse the linespec in ARG. MATCH_TYPE indicates how function names
2514 should be matched. */
2516 static std::vector
<symtab_and_line
>
2517 parse_linespec (linespec_parser
*parser
, const char *arg
,
2518 symbol_name_match_type match_type
)
2520 linespec_token token
;
2521 struct gdb_exception file_exception
= exception_none
;
2523 /* A special case to start. It has become quite popular for
2524 IDEs to work around bugs in the previous parser by quoting
2525 the entire linespec, so we attempt to deal with this nicely. */
2526 parser
->is_quote_enclosed
= 0;
2527 if (parser
->completion_tracker
== NULL
2528 && !is_ada_operator (arg
)
2529 && strchr (linespec_quote_characters
, *arg
) != NULL
)
2533 end
= skip_quote_char (arg
+ 1, *arg
);
2534 if (end
!= NULL
&& is_closing_quote_enclosed (end
))
2536 /* Here's the special case. Skip ARG past the initial
2539 parser
->is_quote_enclosed
= 1;
2543 parser
->lexer
.saved_arg
= arg
;
2544 parser
->lexer
.stream
= arg
;
2545 parser
->completion_word
= arg
;
2546 parser
->complete_what
= linespec_complete_what::FUNCTION
;
2547 PARSER_EXPLICIT (parser
)->func_name_match_type
= match_type
;
2549 /* Initialize the default symtab and line offset. */
2550 initialize_defaults (&PARSER_STATE (parser
)->default_symtab
,
2551 &PARSER_STATE (parser
)->default_line
);
2553 /* Objective-C shortcut. */
2554 if (parser
->completion_tracker
== NULL
)
2556 std::vector
<symtab_and_line
> values
2557 = decode_objc (PARSER_STATE (parser
), PARSER_RESULT (parser
), arg
);
2558 if (!values
.empty ())
2563 /* "-"/"+" is either an objc selector, or a number. There's
2564 nothing to complete the latter to, so just let the caller
2565 complete on functions, which finds objc selectors, if there's
2567 if ((arg
[0] == '-' || arg
[0] == '+') && arg
[1] == '\0')
2571 /* Start parsing. */
2573 /* Get the first token. */
2574 token
= linespec_lexer_consume_token (parser
);
2576 /* It must be either LSTOKEN_STRING or LSTOKEN_NUMBER. */
2577 if (token
.type
== LSTOKEN_STRING
&& *LS_TOKEN_STOKEN (token
).ptr
== '$')
2579 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2580 if (parser
->completion_tracker
== NULL
)
2581 PARSER_RESULT (parser
)->file_symtabs
->push_back (nullptr);
2583 /* User specified a convenience variable or history value. */
2584 gdb::unique_xmalloc_ptr
<char> var
= copy_token_string (token
);
2585 PARSER_EXPLICIT (parser
)->line_offset
2586 = linespec_parse_variable (PARSER_STATE (parser
), var
.get ());
2588 /* If a line_offset wasn't found (VAR is the name of a user
2589 variable/function), then skip to normal symbol processing. */
2590 if (PARSER_EXPLICIT (parser
)->line_offset
.sign
!= LINE_OFFSET_UNKNOWN
)
2592 /* Consume this token. */
2593 linespec_lexer_consume_token (parser
);
2595 goto convert_to_sals
;
2598 else if (token
.type
== LSTOKEN_EOI
&& parser
->completion_tracker
!= NULL
)
2600 /* Let the default linespec_complete_what::FUNCTION kick in. */
2601 unexpected_linespec_error (parser
);
2603 else if (token
.type
!= LSTOKEN_STRING
&& token
.type
!= LSTOKEN_NUMBER
)
2605 parser
->complete_what
= linespec_complete_what::NOTHING
;
2606 unexpected_linespec_error (parser
);
2609 /* Shortcut: If the next token is not LSTOKEN_COLON, we know that
2610 this token cannot represent a filename. */
2611 token
= linespec_lexer_peek_token (parser
);
2613 if (token
.type
== LSTOKEN_COLON
)
2615 /* Get the current token again and extract the filename. */
2616 token
= linespec_lexer_lex_one (parser
);
2617 gdb::unique_xmalloc_ptr
<char> user_filename
= copy_token_string (token
);
2619 /* Check if the input is a filename. */
2622 *PARSER_RESULT (parser
)->file_symtabs
2623 = symtabs_from_filename (user_filename
.get (),
2624 PARSER_STATE (parser
)->search_pspace
);
2626 CATCH (ex
, RETURN_MASK_ERROR
)
2628 file_exception
= ex
;
2632 if (file_exception
.reason
>= 0)
2634 /* Symtabs were found for the file. Record the filename. */
2635 PARSER_EXPLICIT (parser
)->source_filename
= user_filename
.release ();
2637 /* Get the next token. */
2638 token
= linespec_lexer_consume_token (parser
);
2640 /* This is LSTOKEN_COLON; consume it. */
2641 linespec_lexer_consume_token (parser
);
2645 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2646 PARSER_RESULT (parser
)->file_symtabs
->push_back (nullptr);
2649 /* If the next token is not EOI, KEYWORD, or COMMA, issue an error. */
2650 else if (parser
->completion_tracker
== NULL
2651 && (token
.type
!= LSTOKEN_EOI
&& token
.type
!= LSTOKEN_KEYWORD
2652 && token
.type
!= LSTOKEN_COMMA
))
2654 /* TOKEN is the _next_ token, not the one currently in the parser.
2655 Consuming the token will give the correct error message. */
2656 linespec_lexer_consume_token (parser
);
2657 unexpected_linespec_error (parser
);
2661 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2662 PARSER_RESULT (parser
)->file_symtabs
->push_back (nullptr);
2665 /* Parse the rest of the linespec. */
2666 linespec_parse_basic (parser
);
2668 if (parser
->completion_tracker
== NULL
2669 && PARSER_RESULT (parser
)->function_symbols
== NULL
2670 && PARSER_RESULT (parser
)->labels
.label_symbols
== NULL
2671 && PARSER_EXPLICIT (parser
)->line_offset
.sign
== LINE_OFFSET_UNKNOWN
2672 && PARSER_RESULT (parser
)->minimal_symbols
== NULL
)
2674 /* The linespec didn't parse. Re-throw the file exception if
2676 if (file_exception
.reason
< 0)
2677 throw_exception (file_exception
);
2679 /* Otherwise, the symbol is not found. */
2680 symbol_not_found_error (PARSER_EXPLICIT (parser
)->function_name
,
2681 PARSER_EXPLICIT (parser
)->source_filename
);
2686 /* Get the last token and record how much of the input was parsed,
2688 token
= linespec_lexer_lex_one (parser
);
2689 if (token
.type
!= LSTOKEN_EOI
&& token
.type
!= LSTOKEN_KEYWORD
)
2690 unexpected_linespec_error (parser
);
2691 else if (token
.type
== LSTOKEN_KEYWORD
)
2693 /* Setup the completion word past the keyword. Lexing never
2694 advances past a keyword automatically, so skip it
2696 parser
->completion_word
2697 = skip_spaces (skip_to_space (PARSER_STREAM (parser
)));
2698 parser
->complete_what
= linespec_complete_what::EXPRESSION
;
2701 /* Convert the data in PARSER_RESULT to SALs. */
2702 if (parser
->completion_tracker
== NULL
)
2703 return convert_linespec_to_sals (PARSER_STATE (parser
),
2704 PARSER_RESULT (parser
));
2710 /* A constructor for linespec_state. */
2713 linespec_state_constructor (struct linespec_state
*self
,
2714 int flags
, const struct language_defn
*language
,
2715 struct program_space
*search_pspace
,
2716 struct symtab
*default_symtab
,
2718 struct linespec_result
*canonical
)
2720 memset (self
, 0, sizeof (*self
));
2721 self
->language
= language
;
2722 self
->funfirstline
= (flags
& DECODE_LINE_FUNFIRSTLINE
) ? 1 : 0;
2723 self
->list_mode
= (flags
& DECODE_LINE_LIST_MODE
) ? 1 : 0;
2724 self
->search_pspace
= search_pspace
;
2725 self
->default_symtab
= default_symtab
;
2726 self
->default_line
= default_line
;
2727 self
->canonical
= canonical
;
2728 self
->program_space
= current_program_space
;
2729 self
->addr_set
= htab_create_alloc (10, hash_address_entry
, eq_address_entry
,
2730 xfree
, xcalloc
, xfree
);
2731 self
->is_linespec
= 0;
2734 /* Initialize a new linespec parser. */
2736 linespec_parser::linespec_parser (int flags
,
2737 const struct language_defn
*language
,
2738 struct program_space
*search_pspace
,
2739 struct symtab
*default_symtab
,
2741 struct linespec_result
*canonical
)
2743 lexer
.current
.type
= LSTOKEN_CONSUMED
;
2744 PARSER_RESULT (this)->file_symtabs
= new std::vector
<symtab
*> ();
2745 PARSER_EXPLICIT (this)->func_name_match_type
2746 = symbol_name_match_type::WILD
;
2747 PARSER_EXPLICIT (this)->line_offset
.sign
= LINE_OFFSET_UNKNOWN
;
2748 linespec_state_constructor (PARSER_STATE (this), flags
, language
,
2750 default_symtab
, default_line
, canonical
);
2753 /* A destructor for linespec_state. */
2756 linespec_state_destructor (struct linespec_state
*self
)
2758 htab_delete (self
->addr_set
);
2759 xfree (self
->canonical_names
);
2762 /* Delete a linespec parser. */
2764 linespec_parser::~linespec_parser ()
2766 xfree (PARSER_EXPLICIT (this)->source_filename
);
2767 xfree (PARSER_EXPLICIT (this)->label_name
);
2768 xfree (PARSER_EXPLICIT (this)->function_name
);
2770 delete PARSER_RESULT (this)->file_symtabs
;
2771 delete PARSER_RESULT (this)->function_symbols
;
2772 delete PARSER_RESULT (this)->minimal_symbols
;
2773 delete PARSER_RESULT (this)->labels
.label_symbols
;
2774 delete PARSER_RESULT (this)->labels
.function_symbols
;
2776 linespec_state_destructor (PARSER_STATE (this));
2779 /* See description in linespec.h. */
2782 linespec_lex_to_end (const char **stringp
)
2784 linespec_token token
;
2787 if (stringp
== NULL
|| *stringp
== NULL
)
2790 linespec_parser
parser (0, current_language
, NULL
, NULL
, 0, NULL
);
2791 parser
.lexer
.saved_arg
= *stringp
;
2792 PARSER_STREAM (&parser
) = orig
= *stringp
;
2796 /* Stop before any comma tokens; we need it to keep it
2797 as the next token in the string. */
2798 token
= linespec_lexer_peek_token (&parser
);
2799 if (token
.type
== LSTOKEN_COMMA
)
2801 token
= linespec_lexer_consume_token (&parser
);
2803 while (token
.type
!= LSTOKEN_EOI
&& token
.type
!= LSTOKEN_KEYWORD
);
2805 *stringp
+= PARSER_STREAM (&parser
) - orig
;
2808 /* See linespec.h. */
2811 linespec_complete_function (completion_tracker
&tracker
,
2812 const char *function
,
2813 symbol_name_match_type func_match_type
,
2814 const char *source_filename
)
2816 complete_symbol_mode mode
= complete_symbol_mode::LINESPEC
;
2818 if (source_filename
!= NULL
)
2820 collect_file_symbol_completion_matches (tracker
, mode
, func_match_type
,
2821 function
, function
, source_filename
);
2825 collect_symbol_completion_matches (tracker
, mode
, func_match_type
,
2826 function
, function
);
2831 /* Helper for complete_linespec to simplify it. SOURCE_FILENAME is
2832 only meaningful if COMPONENT is FUNCTION. */
2835 complete_linespec_component (linespec_parser
*parser
,
2836 completion_tracker
&tracker
,
2838 linespec_complete_what component
,
2839 const char *source_filename
)
2841 if (component
== linespec_complete_what::KEYWORD
)
2843 complete_on_enum (tracker
, linespec_keywords
, text
, text
);
2845 else if (component
== linespec_complete_what::EXPRESSION
)
2848 = advance_to_expression_complete_word_point (tracker
, text
);
2849 complete_expression (tracker
, text
, word
);
2851 else if (component
== linespec_complete_what::FUNCTION
)
2853 completion_list fn_list
;
2855 symbol_name_match_type match_type
2856 = PARSER_EXPLICIT (parser
)->func_name_match_type
;
2857 linespec_complete_function (tracker
, text
, match_type
, source_filename
);
2858 if (source_filename
== NULL
)
2860 /* Haven't seen a source component, like in "b
2861 file.c:function[TAB]". Maybe this wasn't a function, but
2862 a filename instead, like "b file.[TAB]". */
2863 fn_list
= complete_source_filenames (text
);
2866 /* If we only have a single filename completion, append a ':' for
2867 the user, since that's the only thing that can usefully follow
2869 if (fn_list
.size () == 1 && !tracker
.have_completions ())
2871 char *fn
= fn_list
[0].release ();
2873 /* If we also need to append a quote char, it needs to be
2874 appended before the ':'. Append it now, and make ':' the
2875 new "quote" char. */
2876 if (tracker
.quote_char ())
2878 char quote_char_str
[2] = { (char) tracker
.quote_char () };
2880 fn
= reconcat (fn
, fn
, quote_char_str
, (char *) NULL
);
2881 tracker
.set_quote_char (':');
2884 fn
= reconcat (fn
, fn
, ":", (char *) NULL
);
2885 fn_list
[0].reset (fn
);
2887 /* Tell readline to skip appending a space. */
2888 tracker
.set_suppress_append_ws (true);
2890 tracker
.add_completions (std::move (fn_list
));
2894 /* Helper for linespec_complete_label. Find labels that match
2895 LABEL_NAME in the function symbols listed in the PARSER, and add
2896 them to the tracker. */
2899 complete_label (completion_tracker
&tracker
,
2900 linespec_parser
*parser
,
2901 const char *label_name
)
2903 std::vector
<block_symbol
> label_function_symbols
;
2904 std::vector
<block_symbol
> *labels
2905 = find_label_symbols (PARSER_STATE (parser
),
2906 PARSER_RESULT (parser
)->function_symbols
,
2907 &label_function_symbols
,
2910 if (labels
!= nullptr)
2912 for (const auto &label
: *labels
)
2914 char *match
= xstrdup (SYMBOL_SEARCH_NAME (label
.symbol
));
2915 tracker
.add_completion (gdb::unique_xmalloc_ptr
<char> (match
));
2921 /* See linespec.h. */
2924 linespec_complete_label (completion_tracker
&tracker
,
2925 const struct language_defn
*language
,
2926 const char *source_filename
,
2927 const char *function_name
,
2928 symbol_name_match_type func_name_match_type
,
2929 const char *label_name
)
2931 linespec_parser
parser (0, language
, NULL
, NULL
, 0, NULL
);
2933 line_offset unknown_offset
= { 0, LINE_OFFSET_UNKNOWN
};
2937 convert_explicit_location_to_linespec (PARSER_STATE (&parser
),
2938 PARSER_RESULT (&parser
),
2941 func_name_match_type
,
2942 NULL
, unknown_offset
);
2944 CATCH (ex
, RETURN_MASK_ERROR
)
2950 complete_label (tracker
, &parser
, label_name
);
2953 /* See description in linespec.h. */
2956 linespec_complete (completion_tracker
&tracker
, const char *text
,
2957 symbol_name_match_type match_type
)
2959 const char *orig
= text
;
2961 linespec_parser
parser (0, current_language
, NULL
, NULL
, 0, NULL
);
2962 parser
.lexer
.saved_arg
= text
;
2963 PARSER_EXPLICIT (&parser
)->func_name_match_type
= match_type
;
2964 PARSER_STREAM (&parser
) = text
;
2966 parser
.completion_tracker
= &tracker
;
2967 PARSER_STATE (&parser
)->is_linespec
= 1;
2969 /* Parse as much as possible. parser.completion_word will hold
2970 furthest completion point we managed to parse to. */
2973 parse_linespec (&parser
, text
, match_type
);
2975 CATCH (except
, RETURN_MASK_ERROR
)
2980 if (parser
.completion_quote_char
!= '\0'
2981 && parser
.completion_quote_end
!= NULL
2982 && parser
.completion_quote_end
[1] == '\0')
2984 /* If completing a quoted string with the cursor right at
2985 terminating quote char, complete the completion word without
2986 interpretation, so that readline advances the cursor one
2987 whitespace past the quote, even if there's no match. This
2988 makes these cases behave the same:
2990 before: "b function()"
2991 after: "b function() "
2993 before: "b 'function()'"
2994 after: "b 'function()' "
2996 and trusts the user in this case:
2998 before: "b 'not_loaded_function_yet()'"
2999 after: "b 'not_loaded_function_yet()' "
3001 parser
.complete_what
= linespec_complete_what::NOTHING
;
3002 parser
.completion_quote_char
= '\0';
3004 gdb::unique_xmalloc_ptr
<char> text_copy
3005 (xstrdup (parser
.completion_word
));
3006 tracker
.add_completion (std::move (text_copy
));
3009 tracker
.set_quote_char (parser
.completion_quote_char
);
3011 if (parser
.complete_what
== linespec_complete_what::LABEL
)
3013 parser
.complete_what
= linespec_complete_what::NOTHING
;
3015 const char *func_name
= PARSER_EXPLICIT (&parser
)->function_name
;
3017 std::vector
<block_symbol
> function_symbols
;
3018 std::vector
<bound_minimal_symbol
> minimal_symbols
;
3019 find_linespec_symbols (PARSER_STATE (&parser
),
3020 PARSER_RESULT (&parser
)->file_symtabs
,
3021 func_name
, match_type
,
3022 &function_symbols
, &minimal_symbols
);
3024 PARSER_RESULT (&parser
)->function_symbols
3025 = new std::vector
<block_symbol
> (std::move (function_symbols
));
3026 PARSER_RESULT (&parser
)->minimal_symbols
3027 = new std::vector
<bound_minimal_symbol
> (std::move (minimal_symbols
));
3029 complete_label (tracker
, &parser
, parser
.completion_word
);
3031 else if (parser
.complete_what
== linespec_complete_what::FUNCTION
)
3033 /* While parsing/lexing, we didn't know whether the completion
3034 word completes to a unique function/source name already or
3038 "b function() <tab>"
3039 may need to complete either to:
3040 "b function() const"
3042 "b function() if/thread/task"
3046 may need to complete either to:
3047 "b foo template_fun<T>()"
3048 with "foo" being the template function's return type, or to:
3053 may need to complete either to a source file name:
3055 or this, also a filename, but a unique completion:
3057 or to a function name:
3060 Address that by completing assuming source or function, and
3061 seeing if we find a completion that matches exactly the
3062 completion word. If so, then it must be a function (see note
3063 below) and we advance the completion word to the end of input
3064 and switch to KEYWORD completion mode.
3066 Note: if we find a unique completion for a source filename,
3067 then it won't match the completion word, because the LCD will
3068 contain a trailing ':'. And if we're completing at or after
3069 the ':', then complete_linespec_component won't try to
3070 complete on source filenames. */
3072 const char *word
= parser
.completion_word
;
3074 complete_linespec_component (&parser
, tracker
,
3075 parser
.completion_word
,
3076 linespec_complete_what::FUNCTION
,
3077 PARSER_EXPLICIT (&parser
)->source_filename
);
3079 parser
.complete_what
= linespec_complete_what::NOTHING
;
3081 if (tracker
.quote_char ())
3083 /* The function/file name was not close-quoted, so this
3084 can't be a keyword. Note: complete_linespec_component
3085 may have swapped the original quote char for ':' when we
3086 get here, but that still indicates the same. */
3088 else if (!tracker
.have_completions ())
3091 size_t wordlen
= strlen (parser
.completion_word
);
3094 = string_find_incomplete_keyword_at_end (linespec_keywords
,
3095 parser
.completion_word
,
3100 && parser
.completion_word
[wordlen
- 1] == ' '))
3102 parser
.completion_word
+= key_start
;
3103 parser
.complete_what
= linespec_complete_what::KEYWORD
;
3106 else if (tracker
.completes_to_completion_word (word
))
3108 /* Skip the function and complete on keywords. */
3109 parser
.completion_word
+= strlen (word
);
3110 parser
.complete_what
= linespec_complete_what::KEYWORD
;
3111 tracker
.discard_completions ();
3115 tracker
.advance_custom_word_point_by (parser
.completion_word
- orig
);
3117 complete_linespec_component (&parser
, tracker
,
3118 parser
.completion_word
,
3119 parser
.complete_what
,
3120 PARSER_EXPLICIT (&parser
)->source_filename
);
3122 /* If we're past the "filename:function:label:offset" linespec, and
3123 didn't find any match, then assume the user might want to create
3124 a pending breakpoint anyway and offer the keyword
3126 if (!parser
.completion_quote_char
3127 && (parser
.complete_what
== linespec_complete_what::FUNCTION
3128 || parser
.complete_what
== linespec_complete_what::LABEL
3129 || parser
.complete_what
== linespec_complete_what::NOTHING
)
3130 && !tracker
.have_completions ())
3133 = parser
.completion_word
+ strlen (parser
.completion_word
);
3135 if (end
> orig
&& end
[-1] == ' ')
3137 tracker
.advance_custom_word_point_by (end
- parser
.completion_word
);
3139 complete_linespec_component (&parser
, tracker
, end
,
3140 linespec_complete_what::KEYWORD
,
3146 /* A helper function for decode_line_full and decode_line_1 to
3147 turn LOCATION into std::vector<symtab_and_line>. */
3149 static std::vector
<symtab_and_line
>
3150 event_location_to_sals (linespec_parser
*parser
,
3151 const struct event_location
*location
)
3153 std::vector
<symtab_and_line
> result
;
3155 switch (event_location_type (location
))
3157 case LINESPEC_LOCATION
:
3159 PARSER_STATE (parser
)->is_linespec
= 1;
3162 const linespec_location
*ls
= get_linespec_location (location
);
3163 result
= parse_linespec (parser
,
3164 ls
->spec_string
, ls
->match_type
);
3166 CATCH (except
, RETURN_MASK_ERROR
)
3168 throw_exception (except
);
3174 case ADDRESS_LOCATION
:
3176 const char *addr_string
= get_address_string_location (location
);
3177 CORE_ADDR addr
= get_address_location (location
);
3179 if (addr_string
!= NULL
)
3181 addr
= linespec_expression_to_pc (&addr_string
);
3182 if (PARSER_STATE (parser
)->canonical
!= NULL
)
3183 PARSER_STATE (parser
)->canonical
->location
3184 = copy_event_location (location
);
3187 result
= convert_address_location_to_sals (PARSER_STATE (parser
),
3192 case EXPLICIT_LOCATION
:
3194 const struct explicit_location
*explicit_loc
;
3196 explicit_loc
= get_explicit_location_const (location
);
3197 result
= convert_explicit_location_to_sals (PARSER_STATE (parser
),
3198 PARSER_RESULT (parser
),
3203 case PROBE_LOCATION
:
3204 /* Probes are handled by their own decoders. */
3205 gdb_assert_not_reached ("attempt to decode probe location");
3209 gdb_assert_not_reached ("unhandled event location type");
3215 /* See linespec.h. */
3218 decode_line_full (const struct event_location
*location
, int flags
,
3219 struct program_space
*search_pspace
,
3220 struct symtab
*default_symtab
,
3221 int default_line
, struct linespec_result
*canonical
,
3222 const char *select_mode
,
3225 std::vector
<const char *> filters
;
3226 struct linespec_state
*state
;
3228 gdb_assert (canonical
!= NULL
);
3229 /* The filter only makes sense for 'all'. */
3230 gdb_assert (filter
== NULL
|| select_mode
== multiple_symbols_all
);
3231 gdb_assert (select_mode
== NULL
3232 || select_mode
== multiple_symbols_all
3233 || select_mode
== multiple_symbols_ask
3234 || select_mode
== multiple_symbols_cancel
);
3235 gdb_assert ((flags
& DECODE_LINE_LIST_MODE
) == 0);
3237 linespec_parser
parser (flags
, current_language
,
3238 search_pspace
, default_symtab
,
3239 default_line
, canonical
);
3241 scoped_restore_current_program_space restore_pspace
;
3243 std::vector
<symtab_and_line
> result
= event_location_to_sals (&parser
,
3245 state
= PARSER_STATE (&parser
);
3247 gdb_assert (result
.size () == 1 || canonical
->pre_expanded
);
3248 canonical
->pre_expanded
= 1;
3250 /* Arrange for allocated canonical names to be freed. */
3251 std::vector
<gdb::unique_xmalloc_ptr
<char>> hold_names
;
3252 for (int i
= 0; i
< result
.size (); ++i
)
3254 gdb_assert (state
->canonical_names
[i
].suffix
!= NULL
);
3255 hold_names
.emplace_back (state
->canonical_names
[i
].suffix
);
3258 if (select_mode
== NULL
)
3260 if (top_level_interpreter ()->interp_ui_out ()->is_mi_like_p ())
3261 select_mode
= multiple_symbols_all
;
3263 select_mode
= multiple_symbols_select_mode ();
3266 if (select_mode
== multiple_symbols_all
)
3270 filters
.push_back (filter
);
3271 filter_results (state
, &result
, filters
);
3274 convert_results_to_lsals (state
, &result
);
3277 decode_line_2 (state
, &result
, select_mode
);
3280 /* See linespec.h. */
3282 std::vector
<symtab_and_line
>
3283 decode_line_1 (const struct event_location
*location
, int flags
,
3284 struct program_space
*search_pspace
,
3285 struct symtab
*default_symtab
,
3288 linespec_parser
parser (flags
, current_language
,
3289 search_pspace
, default_symtab
,
3290 default_line
, NULL
);
3292 scoped_restore_current_program_space restore_pspace
;
3294 return event_location_to_sals (&parser
, location
);
3297 /* See linespec.h. */
3299 std::vector
<symtab_and_line
>
3300 decode_line_with_current_source (const char *string
, int flags
)
3303 error (_("Empty line specification."));
3305 /* We use whatever is set as the current source line. We do not try
3306 and get a default source symtab+line or it will recursively call us! */
3307 symtab_and_line cursal
= get_current_source_symtab_and_line ();
3309 event_location_up location
= string_to_event_location (&string
,
3311 std::vector
<symtab_and_line
> sals
3312 = decode_line_1 (location
.get (), flags
, NULL
, cursal
.symtab
, cursal
.line
);
3315 error (_("Junk at end of line specification: %s"), string
);
3320 /* See linespec.h. */
3322 std::vector
<symtab_and_line
>
3323 decode_line_with_last_displayed (const char *string
, int flags
)
3326 error (_("Empty line specification."));
3328 event_location_up location
= string_to_event_location (&string
,
3330 std::vector
<symtab_and_line
> sals
3331 = (last_displayed_sal_is_valid ()
3332 ? decode_line_1 (location
.get (), flags
, NULL
,
3333 get_last_displayed_symtab (),
3334 get_last_displayed_line ())
3335 : decode_line_1 (location
.get (), flags
, NULL
,
3336 (struct symtab
*) NULL
, 0));
3339 error (_("Junk at end of line specification: %s"), string
);
3346 /* First, some functions to initialize stuff at the beggining of the
3350 initialize_defaults (struct symtab
**default_symtab
, int *default_line
)
3352 if (*default_symtab
== 0)
3354 /* Use whatever we have for the default source line. We don't use
3355 get_current_or_default_symtab_and_line as it can recurse and call
3357 struct symtab_and_line cursal
=
3358 get_current_source_symtab_and_line ();
3360 *default_symtab
= cursal
.symtab
;
3361 *default_line
= cursal
.line
;
3367 /* Evaluate the expression pointed to by EXP_PTR into a CORE_ADDR,
3368 advancing EXP_PTR past any parsed text. */
3371 linespec_expression_to_pc (const char **exp_ptr
)
3373 if (current_program_space
->executing_startup
)
3374 /* The error message doesn't really matter, because this case
3375 should only hit during breakpoint reset. */
3376 throw_error (NOT_FOUND_ERROR
, _("cannot evaluate expressions while "
3377 "program space is in startup"));
3380 return value_as_address (parse_to_comma_and_eval (exp_ptr
));
3385 /* Here's where we recognise an Objective-C Selector. An Objective C
3386 selector may be implemented by more than one class, therefore it
3387 may represent more than one method/function. This gives us a
3388 situation somewhat analogous to C++ overloading. If there's more
3389 than one method that could represent the selector, then use some of
3390 the existing C++ code to let the user choose one. */
3392 static std::vector
<symtab_and_line
>
3393 decode_objc (struct linespec_state
*self
, linespec_p ls
, const char *arg
)
3395 struct collect_info info
;
3396 std::vector
<const char *> symbol_names
;
3397 const char *new_argptr
;
3400 std::vector
<symtab
*> symtabs
;
3401 symtabs
.push_back (nullptr);
3403 info
.file_symtabs
= &symtabs
;
3405 std::vector
<block_symbol
> symbols
;
3406 info
.result
.symbols
= &symbols
;
3407 std::vector
<bound_minimal_symbol
> minimal_symbols
;
3408 info
.result
.minimal_symbols
= &minimal_symbols
;
3410 new_argptr
= find_imps (arg
, &symbol_names
);
3411 if (symbol_names
.empty ())
3414 add_all_symbol_names_from_pspace (&info
, NULL
, symbol_names
,
3417 std::vector
<symtab_and_line
> values
;
3418 if (!symbols
.empty () || !minimal_symbols
.empty ())
3422 saved_arg
= (char *) alloca (new_argptr
- arg
+ 1);
3423 memcpy (saved_arg
, arg
, new_argptr
- arg
);
3424 saved_arg
[new_argptr
- arg
] = '\0';
3426 ls
->explicit_loc
.function_name
= xstrdup (saved_arg
);
3427 ls
->function_symbols
3428 = new std::vector
<block_symbol
> (std::move (symbols
));
3430 = new std::vector
<bound_minimal_symbol
> (std::move (minimal_symbols
));
3431 values
= convert_linespec_to_sals (self
, ls
);
3433 if (self
->canonical
)
3438 self
->canonical
->pre_expanded
= 1;
3440 if (ls
->explicit_loc
.source_filename
)
3442 holder
= string_printf ("%s:%s",
3443 ls
->explicit_loc
.source_filename
,
3445 str
= holder
.c_str ();
3450 self
->canonical
->location
3451 = new_linespec_location (&str
, symbol_name_match_type::FULL
);
3460 /* A function object that serves as symbol_found_callback_ftype
3461 callback for iterate_over_symbols. This is used by
3462 lookup_prefix_sym to collect type symbols. */
3463 class decode_compound_collector
3466 decode_compound_collector ()
3468 m_unique_syms
= htab_create_alloc (1, htab_hash_pointer
,
3469 htab_eq_pointer
, NULL
,
3473 ~decode_compound_collector ()
3475 if (m_unique_syms
!= NULL
)
3476 htab_delete (m_unique_syms
);
3479 /* Return all symbols collected. */
3480 std::vector
<block_symbol
> release_symbols ()
3482 return std::move (m_symbols
);
3485 /* Callable as a symbol_found_callback_ftype callback. */
3486 bool operator () (block_symbol
*bsym
);
3489 /* A hash table of all symbols we found. We use this to avoid
3490 adding any symbol more than once. */
3491 htab_t m_unique_syms
;
3493 /* The result vector. */
3494 std::vector
<block_symbol
> m_symbols
;
3498 decode_compound_collector::operator () (block_symbol
*bsym
)
3502 struct symbol
*sym
= bsym
->symbol
;
3504 if (SYMBOL_CLASS (sym
) != LOC_TYPEDEF
)
3505 return true; /* Continue iterating. */
3507 t
= SYMBOL_TYPE (sym
);
3508 t
= check_typedef (t
);
3509 if (TYPE_CODE (t
) != TYPE_CODE_STRUCT
3510 && TYPE_CODE (t
) != TYPE_CODE_UNION
3511 && TYPE_CODE (t
) != TYPE_CODE_NAMESPACE
)
3512 return true; /* Continue iterating. */
3514 slot
= htab_find_slot (m_unique_syms
, sym
, INSERT
);
3518 m_symbols
.push_back (*bsym
);
3521 return true; /* Continue iterating. */
3526 /* Return any symbols corresponding to CLASS_NAME in FILE_SYMTABS. */
3528 static std::vector
<block_symbol
>
3529 lookup_prefix_sym (struct linespec_state
*state
,
3530 std::vector
<symtab
*> *file_symtabs
,
3531 const char *class_name
)
3533 decode_compound_collector collector
;
3535 lookup_name_info
lookup_name (class_name
, symbol_name_match_type::FULL
);
3537 for (const auto &elt
: *file_symtabs
)
3541 iterate_over_all_matching_symtabs (state
, lookup_name
,
3542 STRUCT_DOMAIN
, ALL_DOMAIN
,
3543 NULL
, false, collector
);
3544 iterate_over_all_matching_symtabs (state
, lookup_name
,
3545 VAR_DOMAIN
, ALL_DOMAIN
,
3546 NULL
, false, collector
);
3550 /* Program spaces that are executing startup should have
3551 been filtered out earlier. */
3552 gdb_assert (!SYMTAB_PSPACE (elt
)->executing_startup
);
3553 set_current_program_space (SYMTAB_PSPACE (elt
));
3554 iterate_over_file_blocks (elt
, lookup_name
, STRUCT_DOMAIN
, collector
);
3555 iterate_over_file_blocks (elt
, lookup_name
, VAR_DOMAIN
, collector
);
3559 return collector
.release_symbols ();
3562 /* A std::sort comparison function for symbols. The resulting order does
3563 not actually matter; we just need to be able to sort them so that
3564 symbols with the same program space end up next to each other. */
3567 compare_symbols (const block_symbol
&a
, const block_symbol
&b
)
3571 uia
= (uintptr_t) SYMTAB_PSPACE (symbol_symtab (a
.symbol
));
3572 uib
= (uintptr_t) SYMTAB_PSPACE (symbol_symtab (b
.symbol
));
3579 uia
= (uintptr_t) a
.symbol
;
3580 uib
= (uintptr_t) b
.symbol
;
3588 /* Like compare_symbols but for minimal symbols. */
3591 compare_msymbols (const bound_minimal_symbol
&a
, const bound_minimal_symbol
&b
)
3595 uia
= (uintptr_t) a
.objfile
->pspace
;
3596 uib
= (uintptr_t) a
.objfile
->pspace
;
3603 uia
= (uintptr_t) a
.minsym
;
3604 uib
= (uintptr_t) b
.minsym
;
3612 /* Look for all the matching instances of each symbol in NAMES. Only
3613 instances from PSPACE are considered; other program spaces are
3614 handled by our caller. If PSPACE is NULL, then all program spaces
3615 are considered. Results are stored into INFO. */
3618 add_all_symbol_names_from_pspace (struct collect_info
*info
,
3619 struct program_space
*pspace
,
3620 const std::vector
<const char *> &names
,
3621 enum search_domain search_domain
)
3623 for (const char *iter
: names
)
3624 add_matching_symbols_to_info (iter
,
3625 symbol_name_match_type::FULL
,
3626 search_domain
, info
, pspace
);
3630 find_superclass_methods (std::vector
<struct type
*> &&superclasses
,
3631 const char *name
, enum language name_lang
,
3632 std::vector
<const char *> *result_names
)
3634 size_t old_len
= result_names
->size ();
3638 std::vector
<struct type
*> new_supers
;
3640 for (type
*t
: superclasses
)
3641 find_methods (t
, name_lang
, name
, result_names
, &new_supers
);
3643 if (result_names
->size () != old_len
|| new_supers
.empty ())
3646 superclasses
= std::move (new_supers
);
3650 /* This finds the method METHOD_NAME in the class CLASS_NAME whose type is
3651 given by one of the symbols in SYM_CLASSES. Matches are returned
3652 in SYMBOLS (for debug symbols) and MINSYMS (for minimal symbols). */
3655 find_method (struct linespec_state
*self
, std::vector
<symtab
*> *file_symtabs
,
3656 const char *class_name
, const char *method_name
,
3657 std::vector
<block_symbol
> *sym_classes
,
3658 std::vector
<block_symbol
> *symbols
,
3659 std::vector
<bound_minimal_symbol
> *minsyms
)
3661 size_t last_result_len
;
3662 std::vector
<struct type
*> superclass_vec
;
3663 std::vector
<const char *> result_names
;
3664 struct collect_info info
;
3666 /* Sort symbols so that symbols with the same program space are next
3668 std::sort (sym_classes
->begin (), sym_classes
->end (),
3672 info
.file_symtabs
= file_symtabs
;
3673 info
.result
.symbols
= symbols
;
3674 info
.result
.minimal_symbols
= minsyms
;
3676 /* Iterate over all the types, looking for the names of existing
3677 methods matching METHOD_NAME. If we cannot find a direct method in a
3678 given program space, then we consider inherited methods; this is
3679 not ideal (ideal would be to respect C++ hiding rules), but it
3680 seems good enough and is what GDB has historically done. We only
3681 need to collect the names because later we find all symbols with
3682 those names. This loop is written in a somewhat funny way
3683 because we collect data across the program space before deciding
3685 last_result_len
= 0;
3686 unsigned int ix
= 0;
3687 for (const auto &elt
: *sym_classes
)
3690 struct program_space
*pspace
;
3691 struct symbol
*sym
= elt
.symbol
;
3693 /* Program spaces that are executing startup should have
3694 been filtered out earlier. */
3695 pspace
= SYMTAB_PSPACE (symbol_symtab (sym
));
3696 gdb_assert (!pspace
->executing_startup
);
3697 set_current_program_space (pspace
);
3698 t
= check_typedef (SYMBOL_TYPE (sym
));
3699 find_methods (t
, SYMBOL_LANGUAGE (sym
),
3700 method_name
, &result_names
, &superclass_vec
);
3702 /* Handle all items from a single program space at once; and be
3703 sure not to miss the last batch. */
3704 if (ix
== sym_classes
->size () - 1
3706 != SYMTAB_PSPACE (symbol_symtab (sym_classes
->at (ix
+ 1).symbol
))))
3708 /* If we did not find a direct implementation anywhere in
3709 this program space, consider superclasses. */
3710 if (result_names
.size () == last_result_len
)
3711 find_superclass_methods (std::move (superclass_vec
), method_name
,
3712 SYMBOL_LANGUAGE (sym
), &result_names
);
3714 /* We have a list of candidate symbol names, so now we
3715 iterate over the symbol tables looking for all
3716 matches in this pspace. */
3717 add_all_symbol_names_from_pspace (&info
, pspace
, result_names
,
3720 superclass_vec
.clear ();
3721 last_result_len
= result_names
.size ();
3726 if (!symbols
->empty () || !minsyms
->empty ())
3729 /* Throw an NOT_FOUND_ERROR. This will be caught by the caller
3730 and other attempts to locate the symbol will be made. */
3731 throw_error (NOT_FOUND_ERROR
, _("see caller, this text doesn't matter"));
3738 /* This function object is a callback for iterate_over_symtabs, used
3739 when collecting all matching symtabs. */
3741 class symtab_collector
3746 m_symtab_table
= htab_create (1, htab_hash_pointer
, htab_eq_pointer
,
3750 ~symtab_collector ()
3752 if (m_symtab_table
!= NULL
)
3753 htab_delete (m_symtab_table
);
3756 /* Callable as a symbol_found_callback_ftype callback. */
3757 bool operator () (symtab
*sym
);
3759 /* Return an rvalue reference to the collected symtabs. */
3760 std::vector
<symtab
*> &&release_symtabs ()
3762 return std::move (m_symtabs
);
3766 /* The result vector of symtabs. */
3767 std::vector
<symtab
*> m_symtabs
;
3769 /* This is used to ensure the symtabs are unique. */
3770 htab_t m_symtab_table
;
3774 symtab_collector::operator () (struct symtab
*symtab
)
3778 slot
= htab_find_slot (m_symtab_table
, symtab
, INSERT
);
3782 m_symtabs
.push_back (symtab
);
3790 /* Given a file name, return a list of all matching symtabs. If
3791 SEARCH_PSPACE is not NULL, the search is restricted to just that
3794 static std::vector
<symtab
*>
3795 collect_symtabs_from_filename (const char *file
,
3796 struct program_space
*search_pspace
)
3798 symtab_collector collector
;
3800 /* Find that file's data. */
3801 if (search_pspace
== NULL
)
3803 struct program_space
*pspace
;
3805 ALL_PSPACES (pspace
)
3807 if (pspace
->executing_startup
)
3810 set_current_program_space (pspace
);
3811 iterate_over_symtabs (file
, collector
);
3816 set_current_program_space (search_pspace
);
3817 iterate_over_symtabs (file
, collector
);
3820 return collector
.release_symtabs ();
3823 /* Return all the symtabs associated to the FILENAME. If SEARCH_PSPACE is
3824 not NULL, the search is restricted to just that program space. */
3826 static std::vector
<symtab
*>
3827 symtabs_from_filename (const char *filename
,
3828 struct program_space
*search_pspace
)
3830 std::vector
<symtab
*> result
3831 = collect_symtabs_from_filename (filename
, search_pspace
);
3833 if (result
.empty ())
3835 if (!have_full_symbols () && !have_partial_symbols ())
3836 throw_error (NOT_FOUND_ERROR
,
3837 _("No symbol table is loaded. "
3838 "Use the \"file\" command."));
3839 source_file_not_found_error (filename
);
3848 symbol_searcher::find_all_symbols (const std::string
&name
,
3849 const struct language_defn
*language
,
3850 enum search_domain search_domain
,
3851 std::vector
<symtab
*> *search_symtabs
,
3852 struct program_space
*search_pspace
)
3854 symbol_searcher_collect_info info
;
3855 struct linespec_state state
;
3857 memset (&state
, 0, sizeof (state
));
3858 state
.language
= language
;
3859 info
.state
= &state
;
3861 info
.result
.symbols
= &m_symbols
;
3862 info
.result
.minimal_symbols
= &m_minimal_symbols
;
3863 std::vector
<symtab
*> all_symtabs
;
3864 if (search_symtabs
== nullptr)
3866 all_symtabs
.push_back (nullptr);
3867 search_symtabs
= &all_symtabs
;
3869 info
.file_symtabs
= search_symtabs
;
3871 add_matching_symbols_to_info (name
.c_str (), symbol_name_match_type::WILD
,
3872 search_domain
, &info
, search_pspace
);
3875 /* Look up a function symbol named NAME in symtabs FILE_SYMTABS. Matching
3876 debug symbols are returned in SYMBOLS. Matching minimal symbols are
3877 returned in MINSYMS. */
3880 find_function_symbols (struct linespec_state
*state
,
3881 std::vector
<symtab
*> *file_symtabs
, const char *name
,
3882 symbol_name_match_type name_match_type
,
3883 std::vector
<block_symbol
> *symbols
,
3884 std::vector
<bound_minimal_symbol
> *minsyms
)
3886 struct collect_info info
;
3887 std::vector
<const char *> symbol_names
;
3890 info
.result
.symbols
= symbols
;
3891 info
.result
.minimal_symbols
= minsyms
;
3892 info
.file_symtabs
= file_symtabs
;
3894 /* Try NAME as an Objective-C selector. */
3895 find_imps (name
, &symbol_names
);
3896 if (!symbol_names
.empty ())
3897 add_all_symbol_names_from_pspace (&info
, state
->search_pspace
,
3898 symbol_names
, FUNCTIONS_DOMAIN
);
3900 add_matching_symbols_to_info (name
, name_match_type
, FUNCTIONS_DOMAIN
,
3901 &info
, state
->search_pspace
);
3904 /* Find all symbols named NAME in FILE_SYMTABS, returning debug symbols
3905 in SYMBOLS and minimal symbols in MINSYMS. */
3908 find_linespec_symbols (struct linespec_state
*state
,
3909 std::vector
<symtab
*> *file_symtabs
,
3910 const char *lookup_name
,
3911 symbol_name_match_type name_match_type
,
3912 std::vector
<block_symbol
> *symbols
,
3913 std::vector
<bound_minimal_symbol
> *minsyms
)
3915 std::string canon
= cp_canonicalize_string_no_typedefs (lookup_name
);
3916 if (!canon
.empty ())
3917 lookup_name
= canon
.c_str ();
3919 /* It's important to not call expand_symtabs_matching unnecessarily
3920 as it can really slow things down (by unnecessarily expanding
3921 potentially 1000s of symtabs, which when debugging some apps can
3922 cost 100s of seconds). Avoid this to some extent by *first* calling
3923 find_function_symbols, and only if that doesn't find anything
3924 *then* call find_method. This handles two important cases:
3925 1) break (anonymous namespace)::foo
3926 2) break class::method where method is in class (and not a baseclass) */
3928 find_function_symbols (state
, file_symtabs
, lookup_name
,
3929 name_match_type
, symbols
, minsyms
);
3931 /* If we were unable to locate a symbol of the same name, try dividing
3932 the name into class and method names and searching the class and its
3934 if (symbols
->empty () && minsyms
->empty ())
3936 std::string klass
, method
;
3937 const char *last
, *p
, *scope_op
;
3939 /* See if we can find a scope operator and break this symbol
3940 name into namespaces${SCOPE_OPERATOR}class_name and method_name. */
3942 p
= find_toplevel_string (lookup_name
, scope_op
);
3948 p
= find_toplevel_string (p
+ strlen (scope_op
), scope_op
);
3951 /* If no scope operator was found, there is nothing more we can do;
3952 we already attempted to lookup the entire name as a symbol
3957 /* LOOKUP_NAME points to the class name.
3958 LAST points to the method name. */
3959 klass
= std::string (lookup_name
, last
- lookup_name
);
3961 /* Skip past the scope operator. */
3962 last
+= strlen (scope_op
);
3965 /* Find a list of classes named KLASS. */
3966 std::vector
<block_symbol
> classes
3967 = lookup_prefix_sym (state
, file_symtabs
, klass
.c_str ());
3968 if (!classes
.empty ())
3970 /* Now locate a list of suitable methods named METHOD. */
3973 find_method (state
, file_symtabs
,
3974 klass
.c_str (), method
.c_str (),
3975 &classes
, symbols
, minsyms
);
3978 /* If successful, we're done. If NOT_FOUND_ERROR
3979 was not thrown, rethrow the exception that we did get. */
3980 CATCH (except
, RETURN_MASK_ERROR
)
3982 if (except
.error
!= NOT_FOUND_ERROR
)
3983 throw_exception (except
);
3990 /* Helper for find_label_symbols. Find all labels that match name
3991 NAME in BLOCK. Return all labels that match in FUNCTION_SYMBOLS.
3992 Return the actual function symbol in which the label was found in
3993 LABEL_FUNC_RET. If COMPLETION_MODE is true, then NAME is
3994 interpreted as a label name prefix. Otherwise, only a label named
3995 exactly NAME match. */
3998 find_label_symbols_in_block (const struct block
*block
,
3999 const char *name
, struct symbol
*fn_sym
,
4000 bool completion_mode
,
4001 std::vector
<block_symbol
> *result
,
4002 std::vector
<block_symbol
> *label_funcs_ret
)
4004 if (completion_mode
)
4006 struct block_iterator iter
;
4008 size_t name_len
= strlen (name
);
4010 int (*cmp
) (const char *, const char *, size_t);
4011 cmp
= case_sensitivity
== case_sensitive_on
? strncmp
: strncasecmp
;
4013 ALL_BLOCK_SYMBOLS (block
, iter
, sym
)
4015 if (symbol_matches_domain (SYMBOL_LANGUAGE (sym
),
4016 SYMBOL_DOMAIN (sym
), LABEL_DOMAIN
)
4017 && cmp (SYMBOL_SEARCH_NAME (sym
), name
, name_len
) == 0)
4019 result
->push_back ({sym
, block
});
4020 label_funcs_ret
->push_back ({fn_sym
, block
});
4026 struct block_symbol label_sym
4027 = lookup_symbol (name
, block
, LABEL_DOMAIN
, 0);
4029 if (label_sym
.symbol
!= NULL
)
4031 result
->push_back (label_sym
);
4032 label_funcs_ret
->push_back ({fn_sym
, block
});
4037 /* Return all labels that match name NAME in FUNCTION_SYMBOLS or NULL
4038 if no matches were found.
4040 Return the actual function symbol in which the label was found in
4041 LABEL_FUNC_RET. If COMPLETION_MODE is true, then NAME is
4042 interpreted as a label name prefix. Otherwise, only labels named
4043 exactly NAME match. */
4046 static std::vector
<block_symbol
> *
4047 find_label_symbols (struct linespec_state
*self
,
4048 std::vector
<block_symbol
> *function_symbols
,
4049 std::vector
<block_symbol
> *label_funcs_ret
,
4051 bool completion_mode
)
4053 const struct block
*block
;
4054 struct symbol
*fn_sym
;
4055 std::vector
<block_symbol
> result
;
4057 if (function_symbols
== NULL
)
4059 set_current_program_space (self
->program_space
);
4060 block
= get_current_search_block ();
4063 block
&& !BLOCK_FUNCTION (block
);
4064 block
= BLOCK_SUPERBLOCK (block
))
4068 fn_sym
= BLOCK_FUNCTION (block
);
4070 find_label_symbols_in_block (block
, name
, fn_sym
, completion_mode
,
4071 &result
, label_funcs_ret
);
4075 for (const auto &elt
: *function_symbols
)
4077 fn_sym
= elt
.symbol
;
4078 set_current_program_space (SYMTAB_PSPACE (symbol_symtab (fn_sym
)));
4079 block
= SYMBOL_BLOCK_VALUE (fn_sym
);
4081 find_label_symbols_in_block (block
, name
, fn_sym
, completion_mode
,
4082 &result
, label_funcs_ret
);
4086 if (!result
.empty ())
4087 return new std::vector
<block_symbol
> (std::move (result
));
4093 /* A helper for create_sals_line_offset that handles the 'list_mode' case. */
4095 static std::vector
<symtab_and_line
>
4096 decode_digits_list_mode (struct linespec_state
*self
,
4098 struct symtab_and_line val
)
4100 gdb_assert (self
->list_mode
);
4102 std::vector
<symtab_and_line
> values
;
4104 for (const auto &elt
: *ls
->file_symtabs
)
4106 /* The logic above should ensure this. */
4107 gdb_assert (elt
!= NULL
);
4109 set_current_program_space (SYMTAB_PSPACE (elt
));
4111 /* Simplistic search just for the list command. */
4112 val
.symtab
= find_line_symtab (elt
, val
.line
, NULL
, NULL
);
4113 if (val
.symtab
== NULL
)
4115 val
.pspace
= SYMTAB_PSPACE (elt
);
4117 val
.explicit_line
= 1;
4119 add_sal_to_sals (self
, &values
, &val
, NULL
, 0);
4125 /* A helper for create_sals_line_offset that iterates over the symtabs,
4126 adding lines to the VEC. */
4128 static std::vector
<symtab_and_line
>
4129 decode_digits_ordinary (struct linespec_state
*self
,
4132 struct linetable_entry
**best_entry
)
4134 std::vector
<symtab_and_line
> sals
;
4135 for (const auto &elt
: *ls
->file_symtabs
)
4137 std::vector
<CORE_ADDR
> pcs
;
4139 /* The logic above should ensure this. */
4140 gdb_assert (elt
!= NULL
);
4142 set_current_program_space (SYMTAB_PSPACE (elt
));
4144 pcs
= find_pcs_for_symtab_line (elt
, line
, best_entry
);
4145 for (CORE_ADDR pc
: pcs
)
4147 symtab_and_line sal
;
4148 sal
.pspace
= SYMTAB_PSPACE (elt
);
4152 sals
.push_back (std::move (sal
));
4161 /* Return the line offset represented by VARIABLE. */
4163 static struct line_offset
4164 linespec_parse_variable (struct linespec_state
*self
, const char *variable
)
4168 struct line_offset offset
= {0, LINE_OFFSET_NONE
};
4170 p
= (variable
[1] == '$') ? variable
+ 2 : variable
+ 1;
4173 while (*p
>= '0' && *p
<= '9')
4175 if (!*p
) /* Reached end of token without hitting non-digit. */
4177 /* We have a value history reference. */
4178 struct value
*val_history
;
4180 sscanf ((variable
[1] == '$') ? variable
+ 2 : variable
+ 1, "%d", &index
);
4182 = access_value_history ((variable
[1] == '$') ? -index
: index
);
4183 if (TYPE_CODE (value_type (val_history
)) != TYPE_CODE_INT
)
4184 error (_("History values used in line "
4185 "specs must have integer values."));
4186 offset
.offset
= value_as_long (val_history
);
4190 /* Not all digits -- may be user variable/function or a
4191 convenience variable. */
4193 struct internalvar
*ivar
;
4195 /* Try it as a convenience variable. If it is not a convenience
4196 variable, return and allow normal symbol lookup to occur. */
4197 ivar
= lookup_only_internalvar (variable
+ 1);
4199 /* No internal variable with that name. Mark the offset
4200 as unknown to allow the name to be looked up as a symbol. */
4201 offset
.sign
= LINE_OFFSET_UNKNOWN
;
4204 /* We found a valid variable name. If it is not an integer,
4206 if (!get_internalvar_integer (ivar
, &valx
))
4207 error (_("Convenience variables used in line "
4208 "specs must have integer values."));
4210 offset
.offset
= valx
;
4218 /* We've found a minimal symbol MSYMBOL in OBJFILE to associate with our
4219 linespec; return the SAL in RESULT. This function should return SALs
4220 matching those from find_function_start_sal, otherwise false
4221 multiple-locations breakpoints could be placed. */
4224 minsym_found (struct linespec_state
*self
, struct objfile
*objfile
,
4225 struct minimal_symbol
*msymbol
,
4226 std::vector
<symtab_and_line
> *result
)
4228 bool want_start_sal
;
4230 CORE_ADDR func_addr
;
4231 bool is_function
= msymbol_is_function (objfile
, msymbol
, &func_addr
);
4235 const char *msym_name
= MSYMBOL_LINKAGE_NAME (msymbol
);
4237 if (MSYMBOL_TYPE (msymbol
) == mst_text_gnu_ifunc
4238 || MSYMBOL_TYPE (msymbol
) == mst_data_gnu_ifunc
)
4239 want_start_sal
= gnu_ifunc_resolve_name (msym_name
, &func_addr
);
4241 want_start_sal
= true;
4244 symtab_and_line sal
;
4246 if (is_function
&& want_start_sal
)
4247 sal
= find_function_start_sal (func_addr
, NULL
, self
->funfirstline
);
4250 sal
.objfile
= objfile
;
4251 sal
.msymbol
= msymbol
;
4252 /* Store func_addr, not the minsym's address in case this was an
4253 ifunc that hasn't been resolved yet. */
4257 sal
.pc
= MSYMBOL_VALUE_ADDRESS (objfile
, msymbol
);
4258 sal
.pspace
= current_program_space
;
4261 sal
.section
= MSYMBOL_OBJ_SECTION (objfile
, msymbol
);
4263 if (maybe_add_address (self
->addr_set
, objfile
->pspace
, sal
.pc
))
4264 add_sal_to_sals (self
, result
, &sal
, MSYMBOL_NATURAL_NAME (msymbol
), 0);
4267 /* A helper function to classify a minimal_symbol_type according to
4271 classify_mtype (enum minimal_symbol_type t
)
4278 /* Intermediate priority. */
4281 case mst_solib_trampoline
:
4282 /* Lowest priority. */
4286 /* Highest priority. */
4291 /* Callback for std::sort that sorts symbols by priority. */
4294 compare_msyms (const bound_minimal_symbol
&a
, const bound_minimal_symbol
&b
)
4296 enum minimal_symbol_type ta
= MSYMBOL_TYPE (a
.minsym
);
4297 enum minimal_symbol_type tb
= MSYMBOL_TYPE (b
.minsym
);
4299 return classify_mtype (ta
) < classify_mtype (tb
);
4302 /* Helper for search_minsyms_for_name that adds the symbol to the
4306 add_minsym (struct minimal_symbol
*minsym
, struct objfile
*objfile
,
4307 struct symtab
*symtab
, int list_mode
,
4308 std::vector
<struct bound_minimal_symbol
> *msyms
)
4312 /* We're looking for a label for which we don't have debug
4314 CORE_ADDR func_addr
;
4315 if (msymbol_is_function (objfile
, minsym
, &func_addr
))
4317 symtab_and_line sal
= find_pc_sect_line (func_addr
, NULL
, 0);
4319 if (symtab
!= sal
.symtab
)
4324 /* Exclude data symbols when looking for breakpoint locations. */
4325 if (!list_mode
&& !msymbol_is_function (objfile
, minsym
))
4328 struct bound_minimal_symbol mo
= {minsym
, objfile
};
4329 msyms
->push_back (mo
);
4333 /* Search for minimal symbols called NAME. If SEARCH_PSPACE
4334 is not NULL, the search is restricted to just that program
4337 If SYMTAB is NULL, search all objfiles, otherwise
4338 restrict results to the given SYMTAB. */
4341 search_minsyms_for_name (struct collect_info
*info
,
4342 const lookup_name_info
&name
,
4343 struct program_space
*search_pspace
,
4344 struct symtab
*symtab
)
4346 std::vector
<struct bound_minimal_symbol
> minsyms
;
4350 struct program_space
*pspace
;
4352 ALL_PSPACES (pspace
)
4354 struct objfile
*objfile
;
4356 if (search_pspace
!= NULL
&& search_pspace
!= pspace
)
4358 if (pspace
->executing_startup
)
4361 set_current_program_space (pspace
);
4363 ALL_OBJFILES (objfile
)
4365 iterate_over_minimal_symbols (objfile
, name
,
4366 [&] (struct minimal_symbol
*msym
)
4368 add_minsym (msym
, objfile
, nullptr,
4369 info
->state
->list_mode
,
4378 if (search_pspace
== NULL
|| SYMTAB_PSPACE (symtab
) == search_pspace
)
4380 set_current_program_space (SYMTAB_PSPACE (symtab
));
4381 iterate_over_minimal_symbols
4382 (SYMTAB_OBJFILE (symtab
), name
,
4383 [&] (struct minimal_symbol
*msym
)
4385 add_minsym (msym
, SYMTAB_OBJFILE (symtab
), symtab
,
4386 info
->state
->list_mode
, &minsyms
);
4392 if (!minsyms
.empty ())
4396 std::sort (minsyms
.begin (), minsyms
.end (), compare_msyms
);
4398 /* Now the minsyms are in classification order. So, we walk
4399 over them and process just the minsyms with the same
4400 classification as the very first minsym in the list. */
4401 classification
= classify_mtype (MSYMBOL_TYPE (minsyms
[0].minsym
));
4403 for (const bound_minimal_symbol
&item
: minsyms
)
4405 if (classify_mtype (MSYMBOL_TYPE (item
.minsym
)) != classification
)
4408 info
->result
.minimal_symbols
->push_back (item
);
4413 /* A helper function to add all symbols matching NAME to INFO. If
4414 PSPACE is not NULL, the search is restricted to just that program
4418 add_matching_symbols_to_info (const char *name
,
4419 symbol_name_match_type name_match_type
,
4420 enum search_domain search_domain
,
4421 struct collect_info
*info
,
4422 struct program_space
*pspace
)
4424 lookup_name_info
lookup_name (name
, name_match_type
);
4426 for (const auto &elt
: *info
->file_symtabs
)
4430 iterate_over_all_matching_symtabs (info
->state
, lookup_name
,
4431 VAR_DOMAIN
, search_domain
,
4433 [&] (block_symbol
*bsym
)
4434 { return info
->add_symbol (bsym
); });
4435 search_minsyms_for_name (info
, lookup_name
, pspace
, NULL
);
4437 else if (pspace
== NULL
|| pspace
== SYMTAB_PSPACE (elt
))
4439 int prev_len
= info
->result
.symbols
->size ();
4441 /* Program spaces that are executing startup should have
4442 been filtered out earlier. */
4443 gdb_assert (!SYMTAB_PSPACE (elt
)->executing_startup
);
4444 set_current_program_space (SYMTAB_PSPACE (elt
));
4445 iterate_over_file_blocks (elt
, lookup_name
, VAR_DOMAIN
,
4446 [&] (block_symbol
*bsym
)
4447 { return info
->add_symbol (bsym
); });
4449 /* If no new symbols were found in this iteration and this symtab
4450 is in assembler, we might actually be looking for a label for
4451 which we don't have debug info. Check for a minimal symbol in
4453 if (prev_len
== info
->result
.symbols
->size ()
4454 && elt
->language
== language_asm
)
4455 search_minsyms_for_name (info
, lookup_name
, pspace
, elt
);
4462 /* Now come some functions that are called from multiple places within
4466 symbol_to_sal (struct symtab_and_line
*result
,
4467 int funfirstline
, struct symbol
*sym
)
4469 if (SYMBOL_CLASS (sym
) == LOC_BLOCK
)
4471 *result
= find_function_start_sal (sym
, funfirstline
);
4476 if (SYMBOL_CLASS (sym
) == LOC_LABEL
&& SYMBOL_VALUE_ADDRESS (sym
) != 0)
4479 result
->symtab
= symbol_symtab (sym
);
4480 result
->symbol
= sym
;
4481 result
->line
= SYMBOL_LINE (sym
);
4482 result
->pc
= SYMBOL_VALUE_ADDRESS (sym
);
4483 result
->pspace
= SYMTAB_PSPACE (result
->symtab
);
4484 result
->explicit_pc
= 1;
4487 else if (funfirstline
)
4491 else if (SYMBOL_LINE (sym
) != 0)
4493 /* We know its line number. */
4495 result
->symtab
= symbol_symtab (sym
);
4496 result
->symbol
= sym
;
4497 result
->line
= SYMBOL_LINE (sym
);
4498 result
->pc
= SYMBOL_VALUE_ADDRESS (sym
);
4499 result
->pspace
= SYMTAB_PSPACE (result
->symtab
);
4507 linespec_result::~linespec_result ()
4509 for (linespec_sals
&lsal
: lsals
)
4510 xfree (lsal
.canonical
);
4513 /* Return the quote characters permitted by the linespec parser. */
4516 get_gdb_linespec_parser_quote_characters (void)
4518 return linespec_quote_characters
;