1 /* Parser for linespec for the GNU debugger, GDB.
3 Copyright (C) 1986-2020 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 "gdbsupport/function-view.h"
48 #include "gdbsupport/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 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 make_unique_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"))
767 /* Do not tokenify if the input length so far is one
768 (i.e, a single-letter drive name) and the next character
769 is a directory separator. This allows Windows-style
770 paths to be recognized as filenames without quoting it. */
771 else if ((PARSER_STREAM (parser
) - start
) != 1
772 || !IS_DIR_SEPARATOR (PARSER_STREAM (parser
)[1]))
774 LS_TOKEN_STOKEN (token
).ptr
= start
;
775 LS_TOKEN_STOKEN (token
).length
776 = PARSER_STREAM (parser
) - start
;
780 /* Special case: permit quote-enclosed linespecs. */
781 else if (parser
->is_quote_enclosed
782 && strchr (linespec_quote_characters
,
783 *PARSER_STREAM (parser
))
784 && is_closing_quote_enclosed (PARSER_STREAM (parser
)))
786 LS_TOKEN_STOKEN (token
).ptr
= start
;
787 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - start
;
790 /* Because commas may terminate a linespec and appear in
791 the middle of valid string input, special cases for
792 '<' and '(' are necessary. */
793 else if (*PARSER_STREAM (parser
) == '<'
794 || *PARSER_STREAM (parser
) == '(')
796 /* Don't interpret 'operator<' / 'operator<<' as a
797 template parameter list though. */
798 if (*PARSER_STREAM (parser
) == '<'
799 && (PARSER_STATE (parser
)->language
->la_language
801 && (PARSER_STREAM (parser
) - start
) >= CP_OPERATOR_LEN
)
803 const char *op
= PARSER_STREAM (parser
);
805 while (op
> start
&& isspace (op
[-1]))
807 if (op
- start
>= CP_OPERATOR_LEN
)
809 op
-= CP_OPERATOR_LEN
;
810 if (strncmp (op
, CP_OPERATOR_STR
, CP_OPERATOR_LEN
) == 0
812 || !(isalnum (op
[-1]) || op
[-1] == '_')))
814 /* This is an operator name. Keep going. */
815 ++(PARSER_STREAM (parser
));
816 if (*PARSER_STREAM (parser
) == '<')
817 ++(PARSER_STREAM (parser
));
823 const char *end
= find_parameter_list_end (PARSER_STREAM (parser
));
824 PARSER_STREAM (parser
) = end
;
826 /* Don't loop around to the normal \0 case above because
827 we don't want to misinterpret a potential keyword at
828 the end of the token when the string isn't
829 "()<>"-balanced. This handles "b
830 function(thread<tab>" in completion mode. */
833 LS_TOKEN_STOKEN (token
).ptr
= start
;
834 LS_TOKEN_STOKEN (token
).length
835 = PARSER_STREAM (parser
) - start
;
841 /* Commas are terminators, but not if they are part of an
843 else if (*PARSER_STREAM (parser
) == ',')
845 if ((PARSER_STATE (parser
)->language
->la_language
847 && (PARSER_STREAM (parser
) - start
) > CP_OPERATOR_LEN
)
849 const char *op
= strstr (start
, CP_OPERATOR_STR
);
851 if (op
!= NULL
&& is_operator_name (op
))
853 /* This is an operator name. Keep going. */
854 ++(PARSER_STREAM (parser
));
859 /* Comma terminates the string. */
860 LS_TOKEN_STOKEN (token
).ptr
= start
;
861 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - start
;
865 /* Advance the stream. */
866 gdb_assert (*(PARSER_STREAM (parser
)) != '\0');
867 ++(PARSER_STREAM (parser
));
874 /* Lex a single linespec token from PARSER. */
876 static linespec_token
877 linespec_lexer_lex_one (linespec_parser
*parser
)
881 if (parser
->lexer
.current
.type
== LSTOKEN_CONSUMED
)
883 /* Skip any whitespace. */
884 PARSER_STREAM (parser
) = skip_spaces (PARSER_STREAM (parser
));
886 /* Check for a keyword, they end the linespec. */
887 keyword
= linespec_lexer_lex_keyword (PARSER_STREAM (parser
));
890 parser
->lexer
.current
.type
= LSTOKEN_KEYWORD
;
891 LS_TOKEN_KEYWORD (parser
->lexer
.current
) = keyword
;
892 /* We do not advance the stream here intentionally:
893 we would like lexing to stop when a keyword is seen.
895 PARSER_STREAM (parser) += strlen (keyword); */
897 return parser
->lexer
.current
;
900 /* Handle other tokens. */
901 switch (*PARSER_STREAM (parser
))
904 parser
->lexer
.current
.type
= LSTOKEN_EOI
;
908 case '0': case '1': case '2': case '3': case '4':
909 case '5': case '6': case '7': case '8': case '9':
910 if (!linespec_lexer_lex_number (parser
, &(parser
->lexer
.current
)))
911 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
915 /* If we have a scope operator, lex the input as a string.
916 Otherwise, return LSTOKEN_COLON. */
917 if (PARSER_STREAM (parser
)[1] == ':')
918 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
921 parser
->lexer
.current
.type
= LSTOKEN_COLON
;
922 ++(PARSER_STREAM (parser
));
926 case '\'': case '\"':
927 /* Special case: permit quote-enclosed linespecs. */
928 if (parser
->is_quote_enclosed
929 && is_closing_quote_enclosed (PARSER_STREAM (parser
)))
931 ++(PARSER_STREAM (parser
));
932 parser
->lexer
.current
.type
= LSTOKEN_EOI
;
935 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
939 parser
->lexer
.current
.type
= LSTOKEN_COMMA
;
940 LS_TOKEN_STOKEN (parser
->lexer
.current
).ptr
941 = PARSER_STREAM (parser
);
942 LS_TOKEN_STOKEN (parser
->lexer
.current
).length
= 1;
943 ++(PARSER_STREAM (parser
));
947 /* If the input is not a number, it must be a string.
948 [Keywords were already considered above.] */
949 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
954 return parser
->lexer
.current
;
957 /* Consume the current token and return the next token in PARSER's
958 input stream. Also advance the completion word for completion
961 static linespec_token
962 linespec_lexer_consume_token (linespec_parser
*parser
)
964 gdb_assert (parser
->lexer
.current
.type
!= LSTOKEN_EOI
);
966 bool advance_word
= (parser
->lexer
.current
.type
!= LSTOKEN_STRING
967 || *PARSER_STREAM (parser
) != '\0');
969 /* If we're moving past a string to some other token, it must be the
970 quote was terminated. */
971 if (parser
->completion_quote_char
)
973 gdb_assert (parser
->lexer
.current
.type
== LSTOKEN_STRING
);
975 /* If the string was the last (non-EOI) token, we're past the
976 quote, but remember that for later. */
977 if (*PARSER_STREAM (parser
) != '\0')
979 parser
->completion_quote_char
= '\0';
980 parser
->completion_quote_end
= NULL
;;
984 parser
->lexer
.current
.type
= LSTOKEN_CONSUMED
;
985 linespec_lexer_lex_one (parser
);
987 if (parser
->lexer
.current
.type
== LSTOKEN_STRING
)
989 /* Advance the completion word past a potential initial
991 parser
->completion_word
= LS_TOKEN_STOKEN (parser
->lexer
.current
).ptr
;
993 else if (advance_word
)
995 /* Advance the completion word past any whitespace. */
996 parser
->completion_word
= PARSER_STREAM (parser
);
999 return parser
->lexer
.current
;
1002 /* Return the next token without consuming the current token. */
1004 static linespec_token
1005 linespec_lexer_peek_token (linespec_parser
*parser
)
1007 linespec_token next
;
1008 const char *saved_stream
= PARSER_STREAM (parser
);
1009 linespec_token saved_token
= parser
->lexer
.current
;
1010 int saved_completion_quote_char
= parser
->completion_quote_char
;
1011 const char *saved_completion_quote_end
= parser
->completion_quote_end
;
1012 const char *saved_completion_word
= parser
->completion_word
;
1014 next
= linespec_lexer_consume_token (parser
);
1015 PARSER_STREAM (parser
) = saved_stream
;
1016 parser
->lexer
.current
= saved_token
;
1017 parser
->completion_quote_char
= saved_completion_quote_char
;
1018 parser
->completion_quote_end
= saved_completion_quote_end
;
1019 parser
->completion_word
= saved_completion_word
;
1023 /* Helper functions. */
1025 /* Add SAL to SALS, and also update SELF->CANONICAL_NAMES to reflect
1026 the new sal, if needed. If not NULL, SYMNAME is the name of the
1027 symbol to use when constructing the new canonical name.
1029 If LITERAL_CANONICAL is non-zero, SYMNAME will be used as the
1030 canonical name for the SAL. */
1033 add_sal_to_sals (struct linespec_state
*self
,
1034 std::vector
<symtab_and_line
> *sals
,
1035 struct symtab_and_line
*sal
,
1036 const char *symname
, int literal_canonical
)
1038 sals
->push_back (*sal
);
1040 if (self
->canonical
)
1042 struct linespec_canonical_name
*canonical
;
1044 self
->canonical_names
= XRESIZEVEC (struct linespec_canonical_name
,
1045 self
->canonical_names
,
1047 canonical
= &self
->canonical_names
[sals
->size () - 1];
1048 if (!literal_canonical
&& sal
->symtab
)
1050 symtab_to_fullname (sal
->symtab
);
1052 /* Note that the filter doesn't have to be a valid linespec
1053 input. We only apply the ":LINE" treatment to Ada for
1055 if (symname
!= NULL
&& sal
->line
!= 0
1056 && self
->language
->la_language
== language_ada
)
1057 canonical
->suffix
= xstrprintf ("%s:%d", symname
, sal
->line
);
1058 else if (symname
!= NULL
)
1059 canonical
->suffix
= xstrdup (symname
);
1061 canonical
->suffix
= xstrprintf ("%d", sal
->line
);
1062 canonical
->symtab
= sal
->symtab
;
1066 if (symname
!= NULL
)
1067 canonical
->suffix
= xstrdup (symname
);
1069 canonical
->suffix
= xstrdup ("<unknown>");
1070 canonical
->symtab
= NULL
;
1075 /* A hash function for address_entry. */
1078 hash_address_entry (const void *p
)
1080 const struct address_entry
*aep
= (const struct address_entry
*) p
;
1083 hash
= iterative_hash_object (aep
->pspace
, 0);
1084 return iterative_hash_object (aep
->addr
, hash
);
1087 /* An equality function for address_entry. */
1090 eq_address_entry (const void *a
, const void *b
)
1092 const struct address_entry
*aea
= (const struct address_entry
*) a
;
1093 const struct address_entry
*aeb
= (const struct address_entry
*) b
;
1095 return aea
->pspace
== aeb
->pspace
&& aea
->addr
== aeb
->addr
;
1098 /* Check whether the address, represented by PSPACE and ADDR, is
1099 already in the set. If so, return 0. Otherwise, add it and return
1103 maybe_add_address (htab_t set
, struct program_space
*pspace
, CORE_ADDR addr
)
1105 struct address_entry e
, *p
;
1110 slot
= htab_find_slot (set
, &e
, INSERT
);
1114 p
= XNEW (struct address_entry
);
1115 memcpy (p
, &e
, sizeof (struct address_entry
));
1121 /* A helper that walks over all matching symtabs in all objfiles and
1122 calls CALLBACK for each symbol matching NAME. If SEARCH_PSPACE is
1123 not NULL, then the search is restricted to just that program
1124 space. If INCLUDE_INLINE is true then symbols representing
1125 inlined instances of functions will be included in the result. */
1128 iterate_over_all_matching_symtabs
1129 (struct linespec_state
*state
,
1130 const lookup_name_info
&lookup_name
,
1131 const domain_enum name_domain
,
1132 enum search_domain search_domain
,
1133 struct program_space
*search_pspace
, bool include_inline
,
1134 gdb::function_view
<symbol_found_callback_ftype
> callback
)
1136 for (struct program_space
*pspace
: program_spaces
)
1138 if (search_pspace
!= NULL
&& search_pspace
!= pspace
)
1140 if (pspace
->executing_startup
)
1143 set_current_program_space (pspace
);
1145 for (objfile
*objfile
: current_program_space
->objfiles ())
1148 objfile
->sf
->qf
->expand_symtabs_matching (objfile
,
1154 for (compunit_symtab
*cu
: objfile
->compunits ())
1156 struct symtab
*symtab
= COMPUNIT_FILETABS (cu
);
1158 iterate_over_file_blocks (symtab
, lookup_name
, name_domain
,
1163 const struct block
*block
;
1166 for (i
= FIRST_LOCAL_BLOCK
;
1167 i
< BLOCKVECTOR_NBLOCKS (SYMTAB_BLOCKVECTOR (symtab
));
1170 block
= BLOCKVECTOR_BLOCK (SYMTAB_BLOCKVECTOR (symtab
), i
);
1171 state
->language
->iterate_over_symbols
1172 (block
, lookup_name
, name_domain
,
1173 [&] (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 /* get_selected_block can change the current language when there is
1195 no selected frame yet. */
1196 scoped_restore_current_language save_language
;
1197 return get_selected_block (0);
1200 /* Iterate over static and global blocks. */
1203 iterate_over_file_blocks
1204 (struct symtab
*symtab
, const lookup_name_info
&name
,
1205 domain_enum domain
, gdb::function_view
<symbol_found_callback_ftype
> callback
)
1207 const struct block
*block
;
1209 for (block
= BLOCKVECTOR_BLOCK (SYMTAB_BLOCKVECTOR (symtab
), STATIC_BLOCK
);
1211 block
= BLOCK_SUPERBLOCK (block
))
1212 LA_ITERATE_OVER_SYMBOLS (block
, name
, domain
, callback
);
1215 /* A helper for find_method. This finds all methods in type T of
1216 language T_LANG which match NAME. It adds matching symbol names to
1217 RESULT_NAMES, and adds T's direct superclasses to SUPERCLASSES. */
1220 find_methods (struct type
*t
, enum language t_lang
, const char *name
,
1221 std::vector
<const char *> *result_names
,
1222 std::vector
<struct type
*> *superclasses
)
1225 const char *class_name
= t
->name ();
1227 /* Ignore this class if it doesn't have a name. This is ugly, but
1228 unless we figure out how to get the physname without the name of
1229 the class, then the loop can't do any good. */
1233 lookup_name_info
lookup_name (name
, symbol_name_match_type::FULL
);
1234 symbol_name_matcher_ftype
*symbol_name_compare
1235 = language_def (t_lang
)->get_symbol_name_matcher (lookup_name
);
1237 t
= check_typedef (t
);
1239 /* Loop over each method name. At this level, all overloads of a name
1240 are counted as a single name. There is an inner loop which loops over
1243 for (method_counter
= TYPE_NFN_FIELDS (t
) - 1;
1244 method_counter
>= 0;
1247 const char *method_name
= TYPE_FN_FIELDLIST_NAME (t
, method_counter
);
1249 if (symbol_name_compare (method_name
, lookup_name
, NULL
))
1253 for (field_counter
= (TYPE_FN_FIELDLIST_LENGTH (t
, method_counter
)
1259 const char *phys_name
;
1261 f
= TYPE_FN_FIELDLIST1 (t
, method_counter
);
1262 if (TYPE_FN_FIELD_STUB (f
, field_counter
))
1264 phys_name
= TYPE_FN_FIELD_PHYSNAME (f
, field_counter
);
1265 result_names
->push_back (phys_name
);
1271 for (ibase
= 0; ibase
< TYPE_N_BASECLASSES (t
); ibase
++)
1272 superclasses
->push_back (TYPE_BASECLASS (t
, ibase
));
1275 /* Find an instance of the character C in the string S that is outside
1276 of all parenthesis pairs, single-quoted strings, and double-quoted
1277 strings. Also, ignore the char within a template name, like a ','
1278 within foo<int, int>, while considering C++ operator</operator<<. */
1281 find_toplevel_char (const char *s
, char c
)
1283 int quoted
= 0; /* zero if we're not in quotes;
1284 '"' if we're in a double-quoted string;
1285 '\'' if we're in a single-quoted string. */
1286 int depth
= 0; /* Number of unclosed parens we've seen. */
1289 for (scan
= s
; *scan
; scan
++)
1293 if (*scan
== quoted
)
1295 else if (*scan
== '\\' && *(scan
+ 1))
1298 else if (*scan
== c
&& ! quoted
&& depth
== 0)
1300 else if (*scan
== '"' || *scan
== '\'')
1302 else if (*scan
== '(' || *scan
== '<')
1304 else if ((*scan
== ')' || *scan
== '>') && depth
> 0)
1306 else if (*scan
== 'o' && !quoted
&& depth
== 0)
1308 /* Handle C++ operator names. */
1309 if (strncmp (scan
, CP_OPERATOR_STR
, CP_OPERATOR_LEN
) == 0)
1311 scan
+= CP_OPERATOR_LEN
;
1314 while (isspace (*scan
))
1325 /* Skip over one less than the appropriate number of
1326 characters: the for loop will skip over the last
1352 /* The string equivalent of find_toplevel_char. Returns a pointer
1353 to the location of NEEDLE in HAYSTACK, ignoring any occurrences
1354 inside "()" and "<>". Returns NULL if NEEDLE was not found. */
1357 find_toplevel_string (const char *haystack
, const char *needle
)
1359 const char *s
= haystack
;
1363 s
= find_toplevel_char (s
, *needle
);
1367 /* Found first char in HAYSTACK; check rest of string. */
1368 if (startswith (s
, needle
))
1371 /* Didn't find it; loop over HAYSTACK, looking for the next
1372 instance of the first character of NEEDLE. */
1376 while (s
!= NULL
&& *s
!= '\0');
1378 /* NEEDLE was not found in HAYSTACK. */
1382 /* Convert CANONICAL to its string representation using
1383 symtab_to_fullname for SYMTAB. */
1386 canonical_to_fullform (const struct linespec_canonical_name
*canonical
)
1388 if (canonical
->symtab
== NULL
)
1389 return canonical
->suffix
;
1391 return string_printf ("%s:%s", symtab_to_fullname (canonical
->symtab
),
1395 /* Given FILTERS, a list of canonical names, filter the sals in RESULT
1396 and store the result in SELF->CANONICAL. */
1399 filter_results (struct linespec_state
*self
,
1400 std::vector
<symtab_and_line
> *result
,
1401 const std::vector
<const char *> &filters
)
1403 for (const char *name
: filters
)
1407 for (size_t j
= 0; j
< result
->size (); ++j
)
1409 const struct linespec_canonical_name
*canonical
;
1411 canonical
= &self
->canonical_names
[j
];
1412 std::string fullform
= canonical_to_fullform (canonical
);
1414 if (name
== fullform
)
1415 lsal
.sals
.push_back ((*result
)[j
]);
1418 if (!lsal
.sals
.empty ())
1420 lsal
.canonical
= xstrdup (name
);
1421 self
->canonical
->lsals
.push_back (std::move (lsal
));
1425 self
->canonical
->pre_expanded
= 0;
1428 /* Store RESULT into SELF->CANONICAL. */
1431 convert_results_to_lsals (struct linespec_state
*self
,
1432 std::vector
<symtab_and_line
> *result
)
1434 struct linespec_sals lsal
;
1436 lsal
.canonical
= NULL
;
1437 lsal
.sals
= std::move (*result
);
1438 self
->canonical
->lsals
.push_back (std::move (lsal
));
1441 /* A structure that contains two string representations of a struct
1442 linespec_canonical_name:
1443 - one where the symtab's fullname is used;
1444 - one where the filename followed the "set filename-display"
1447 struct decode_line_2_item
1449 decode_line_2_item (std::string
&&fullform_
, std::string
&&displayform_
,
1451 : fullform (std::move (fullform_
)),
1452 displayform (std::move (displayform_
)),
1453 selected (selected_
)
1457 /* The form using symtab_to_fullname. */
1458 std::string fullform
;
1460 /* The form using symtab_to_filename_for_display. */
1461 std::string displayform
;
1463 /* Field is initialized to zero and it is set to one if the user
1464 requested breakpoint for this entry. */
1465 unsigned int selected
: 1;
1468 /* Helper for std::sort to sort decode_line_2_item entries by
1469 DISPLAYFORM and secondarily by FULLFORM. */
1472 decode_line_2_compare_items (const decode_line_2_item
&a
,
1473 const decode_line_2_item
&b
)
1475 if (a
.displayform
!= b
.displayform
)
1476 return a
.displayform
< b
.displayform
;
1477 return a
.fullform
< b
.fullform
;
1480 /* Handle multiple results in RESULT depending on SELECT_MODE. This
1481 will either return normally, throw an exception on multiple
1482 results, or present a menu to the user. On return, the SALS vector
1483 in SELF->CANONICAL is set up properly. */
1486 decode_line_2 (struct linespec_state
*self
,
1487 std::vector
<symtab_and_line
> *result
,
1488 const char *select_mode
)
1493 std::vector
<const char *> filters
;
1494 std::vector
<struct decode_line_2_item
> items
;
1496 gdb_assert (select_mode
!= multiple_symbols_all
);
1497 gdb_assert (self
->canonical
!= NULL
);
1498 gdb_assert (!result
->empty ());
1500 /* Prepare ITEMS array. */
1501 for (i
= 0; i
< result
->size (); ++i
)
1503 const struct linespec_canonical_name
*canonical
;
1504 std::string displayform
;
1506 canonical
= &self
->canonical_names
[i
];
1507 gdb_assert (canonical
->suffix
!= NULL
);
1509 std::string fullform
= canonical_to_fullform (canonical
);
1511 if (canonical
->symtab
== NULL
)
1512 displayform
= canonical
->suffix
;
1515 const char *fn_for_display
;
1517 fn_for_display
= symtab_to_filename_for_display (canonical
->symtab
);
1518 displayform
= string_printf ("%s:%s", fn_for_display
,
1522 items
.emplace_back (std::move (fullform
), std::move (displayform
),
1526 /* Sort the list of method names. */
1527 std::sort (items
.begin (), items
.end (), decode_line_2_compare_items
);
1529 /* Remove entries with the same FULLFORM. */
1530 items
.erase (std::unique (items
.begin (), items
.end (),
1531 [] (const struct decode_line_2_item
&a
,
1532 const struct decode_line_2_item
&b
)
1534 return a
.fullform
== b
.fullform
;
1538 if (select_mode
== multiple_symbols_cancel
&& items
.size () > 1)
1539 error (_("canceled because the command is ambiguous\n"
1540 "See set/show multiple-symbol."));
1542 if (select_mode
== multiple_symbols_all
|| items
.size () == 1)
1544 convert_results_to_lsals (self
, result
);
1548 printf_unfiltered (_("[0] cancel\n[1] all\n"));
1549 for (i
= 0; i
< items
.size (); i
++)
1550 printf_unfiltered ("[%d] %s\n", i
+ 2, items
[i
].displayform
.c_str ());
1552 prompt
= getenv ("PS2");
1557 args
= command_line_input (prompt
, "overload-choice");
1559 if (args
== 0 || *args
== 0)
1560 error_no_arg (_("one or more choice numbers"));
1562 number_or_range_parser
parser (args
);
1563 while (!parser
.finished ())
1565 int num
= parser
.get_number ();
1568 error (_("canceled"));
1571 /* We intentionally make this result in a single breakpoint,
1572 contrary to what older versions of gdb did. The
1573 rationale is that this lets a user get the
1574 multiple_symbols_all behavior even with the 'ask'
1575 setting; and he can get separate breakpoints by entering
1576 "2-57" at the query. */
1577 convert_results_to_lsals (self
, result
);
1582 if (num
>= items
.size ())
1583 printf_unfiltered (_("No choice number %d.\n"), num
);
1586 struct decode_line_2_item
*item
= &items
[num
];
1588 if (!item
->selected
)
1590 filters
.push_back (item
->fullform
.c_str ());
1595 printf_unfiltered (_("duplicate request for %d ignored.\n"),
1601 filter_results (self
, result
, filters
);
1606 /* The parser of linespec itself. */
1608 /* Throw an appropriate error when SYMBOL is not found (optionally in
1611 static void ATTRIBUTE_NORETURN
1612 symbol_not_found_error (const char *symbol
, const char *filename
)
1617 if (!have_full_symbols ()
1618 && !have_partial_symbols ()
1619 && !have_minimal_symbols ())
1620 throw_error (NOT_FOUND_ERROR
,
1621 _("No symbol table is loaded. Use the \"file\" command."));
1623 /* If SYMBOL starts with '$', the user attempted to either lookup
1624 a function/variable in his code starting with '$' or an internal
1625 variable of that name. Since we do not know which, be concise and
1626 explain both possibilities. */
1630 throw_error (NOT_FOUND_ERROR
,
1631 _("Undefined convenience variable or function \"%s\" "
1632 "not defined in \"%s\"."), symbol
, filename
);
1634 throw_error (NOT_FOUND_ERROR
,
1635 _("Undefined convenience variable or function \"%s\" "
1636 "not defined."), symbol
);
1641 throw_error (NOT_FOUND_ERROR
,
1642 _("Function \"%s\" not defined in \"%s\"."),
1645 throw_error (NOT_FOUND_ERROR
,
1646 _("Function \"%s\" not defined."), symbol
);
1650 /* Throw an appropriate error when an unexpected token is encountered
1653 static void ATTRIBUTE_NORETURN
1654 unexpected_linespec_error (linespec_parser
*parser
)
1656 linespec_token token
;
1657 static const char * token_type_strings
[]
1658 = {"keyword", "colon", "string", "number", "comma", "end of input"};
1660 /* Get the token that generated the error. */
1661 token
= linespec_lexer_lex_one (parser
);
1663 /* Finally, throw the error. */
1664 if (token
.type
== LSTOKEN_STRING
|| token
.type
== LSTOKEN_NUMBER
1665 || token
.type
== LSTOKEN_KEYWORD
)
1667 gdb::unique_xmalloc_ptr
<char> string
= copy_token_string (token
);
1668 throw_error (GENERIC_ERROR
,
1669 _("malformed linespec error: unexpected %s, \"%s\""),
1670 token_type_strings
[token
.type
], string
.get ());
1673 throw_error (GENERIC_ERROR
,
1674 _("malformed linespec error: unexpected %s"),
1675 token_type_strings
[token
.type
]);
1678 /* Throw an undefined label error. */
1680 static void ATTRIBUTE_NORETURN
1681 undefined_label_error (const char *function
, const char *label
)
1683 if (function
!= NULL
)
1684 throw_error (NOT_FOUND_ERROR
,
1685 _("No label \"%s\" defined in function \"%s\"."),
1688 throw_error (NOT_FOUND_ERROR
,
1689 _("No label \"%s\" defined in current function."),
1693 /* Throw a source file not found error. */
1695 static void ATTRIBUTE_NORETURN
1696 source_file_not_found_error (const char *name
)
1698 throw_error (NOT_FOUND_ERROR
, _("No source file named %s."), name
);
1701 /* Unless at EIO, save the current stream position as completion word
1702 point, and consume the next token. */
1704 static linespec_token
1705 save_stream_and_consume_token (linespec_parser
*parser
)
1707 if (linespec_lexer_peek_token (parser
).type
!= LSTOKEN_EOI
)
1708 parser
->completion_word
= PARSER_STREAM (parser
);
1709 return linespec_lexer_consume_token (parser
);
1712 /* See description in linespec.h. */
1715 linespec_parse_line_offset (const char *string
)
1717 const char *start
= string
;
1718 struct line_offset line_offset
= {0, LINE_OFFSET_NONE
};
1722 line_offset
.sign
= LINE_OFFSET_PLUS
;
1725 else if (*string
== '-')
1727 line_offset
.sign
= LINE_OFFSET_MINUS
;
1731 if (*string
!= '\0' && !isdigit (*string
))
1732 error (_("malformed line offset: \"%s\""), start
);
1734 /* Right now, we only allow base 10 for offsets. */
1735 line_offset
.offset
= atoi (string
);
1739 /* In completion mode, if the user is still typing the number, there's
1740 no possible completion to offer. But if there's already input past
1741 the number, setup to expect NEXT. */
1744 set_completion_after_number (linespec_parser
*parser
,
1745 linespec_complete_what next
)
1747 if (*PARSER_STREAM (parser
) == ' ')
1749 parser
->completion_word
= skip_spaces (PARSER_STREAM (parser
) + 1);
1750 parser
->complete_what
= next
;
1754 parser
->completion_word
= PARSER_STREAM (parser
);
1755 parser
->complete_what
= linespec_complete_what::NOTHING
;
1759 /* Parse the basic_spec in PARSER's input. */
1762 linespec_parse_basic (linespec_parser
*parser
)
1764 gdb::unique_xmalloc_ptr
<char> name
;
1765 linespec_token token
;
1766 std::vector
<block_symbol
> symbols
;
1767 std::vector
<block_symbol
> *labels
;
1768 std::vector
<bound_minimal_symbol
> minimal_symbols
;
1770 /* Get the next token. */
1771 token
= linespec_lexer_lex_one (parser
);
1773 /* If it is EOI or KEYWORD, issue an error. */
1774 if (token
.type
== LSTOKEN_KEYWORD
)
1776 parser
->complete_what
= linespec_complete_what::NOTHING
;
1777 unexpected_linespec_error (parser
);
1779 else if (token
.type
== LSTOKEN_EOI
)
1781 unexpected_linespec_error (parser
);
1783 /* If it is a LSTOKEN_NUMBER, we have an offset. */
1784 else if (token
.type
== LSTOKEN_NUMBER
)
1786 set_completion_after_number (parser
, linespec_complete_what::KEYWORD
);
1788 /* Record the line offset and get the next token. */
1789 name
= copy_token_string (token
);
1790 PARSER_EXPLICIT (parser
)->line_offset
1791 = linespec_parse_line_offset (name
.get ());
1793 /* Get the next token. */
1794 token
= linespec_lexer_consume_token (parser
);
1796 /* If the next token is a comma, stop parsing and return. */
1797 if (token
.type
== LSTOKEN_COMMA
)
1799 parser
->complete_what
= linespec_complete_what::NOTHING
;
1803 /* If the next token is anything but EOI or KEYWORD, issue
1805 if (token
.type
!= LSTOKEN_KEYWORD
&& token
.type
!= LSTOKEN_EOI
)
1806 unexpected_linespec_error (parser
);
1809 if (token
.type
== LSTOKEN_KEYWORD
|| token
.type
== LSTOKEN_EOI
)
1812 /* Next token must be LSTOKEN_STRING. */
1813 if (token
.type
!= LSTOKEN_STRING
)
1815 parser
->complete_what
= linespec_complete_what::NOTHING
;
1816 unexpected_linespec_error (parser
);
1819 /* The current token will contain the name of a function, method,
1821 name
= copy_token_string (token
);
1823 if (parser
->completion_tracker
!= NULL
)
1825 /* If the function name ends with a ":", then this may be an
1826 incomplete "::" scope operator instead of a label separator.
1829 which should expand to:
1832 Do a tentative completion assuming the later. If we find
1833 completions, advance the stream past the colon token and make
1834 it part of the function name/token. */
1836 if (!parser
->completion_quote_char
1837 && strcmp (PARSER_STREAM (parser
), ":") == 0)
1839 completion_tracker tmp_tracker
;
1840 const char *source_filename
1841 = PARSER_EXPLICIT (parser
)->source_filename
;
1842 symbol_name_match_type match_type
1843 = PARSER_EXPLICIT (parser
)->func_name_match_type
;
1845 linespec_complete_function (tmp_tracker
,
1846 parser
->completion_word
,
1850 if (tmp_tracker
.have_completions ())
1852 PARSER_STREAM (parser
)++;
1853 LS_TOKEN_STOKEN (token
).length
++;
1855 name
.reset (savestring (parser
->completion_word
,
1856 (PARSER_STREAM (parser
)
1857 - parser
->completion_word
)));
1861 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1865 /* Try looking it up as a function/method. */
1866 find_linespec_symbols (PARSER_STATE (parser
),
1867 PARSER_RESULT (parser
)->file_symtabs
, name
.get (),
1868 PARSER_EXPLICIT (parser
)->func_name_match_type
,
1869 &symbols
, &minimal_symbols
);
1871 if (!symbols
.empty () || !minimal_symbols
.empty ())
1873 PARSER_RESULT (parser
)->function_symbols
1874 = new std::vector
<block_symbol
> (std::move (symbols
));
1875 PARSER_RESULT (parser
)->minimal_symbols
1876 = new std::vector
<bound_minimal_symbol
>
1877 (std::move (minimal_symbols
));
1878 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1882 /* NAME was not a function or a method. So it must be a label
1883 name or user specified variable like "break foo.c:$zippo". */
1884 labels
= find_label_symbols (PARSER_STATE (parser
), NULL
,
1885 &symbols
, name
.get ());
1888 PARSER_RESULT (parser
)->labels
.label_symbols
= labels
;
1889 PARSER_RESULT (parser
)->labels
.function_symbols
1890 = new std::vector
<block_symbol
> (std::move (symbols
));
1891 PARSER_EXPLICIT (parser
)->label_name
= name
.release ();
1893 else if (token
.type
== LSTOKEN_STRING
1894 && *LS_TOKEN_STOKEN (token
).ptr
== '$')
1896 /* User specified a convenience variable or history value. */
1897 PARSER_EXPLICIT (parser
)->line_offset
1898 = linespec_parse_variable (PARSER_STATE (parser
), name
.get ());
1900 if (PARSER_EXPLICIT (parser
)->line_offset
.sign
== LINE_OFFSET_UNKNOWN
)
1902 /* The user-specified variable was not valid. Do not
1903 throw an error here. parse_linespec will do it for us. */
1904 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1910 /* The name is also not a label. Abort parsing. Do not throw
1911 an error here. parse_linespec will do it for us. */
1913 /* Save a copy of the name we were trying to lookup. */
1914 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1920 int previous_qc
= parser
->completion_quote_char
;
1922 /* Get the next token. */
1923 token
= linespec_lexer_consume_token (parser
);
1925 if (token
.type
== LSTOKEN_EOI
)
1927 if (previous_qc
&& !parser
->completion_quote_char
)
1928 parser
->complete_what
= linespec_complete_what::KEYWORD
;
1930 else if (token
.type
== LSTOKEN_COLON
)
1932 /* User specified a label or a lineno. */
1933 token
= linespec_lexer_consume_token (parser
);
1935 if (token
.type
== LSTOKEN_NUMBER
)
1937 /* User specified an offset. Record the line offset and
1938 get the next token. */
1939 set_completion_after_number (parser
, linespec_complete_what::KEYWORD
);
1941 name
= copy_token_string (token
);
1942 PARSER_EXPLICIT (parser
)->line_offset
1943 = linespec_parse_line_offset (name
.get ());
1945 /* Get the next token. */
1946 token
= linespec_lexer_consume_token (parser
);
1948 else if (token
.type
== LSTOKEN_EOI
&& parser
->completion_tracker
!= NULL
)
1950 parser
->complete_what
= linespec_complete_what::LABEL
;
1952 else if (token
.type
== LSTOKEN_STRING
)
1954 parser
->complete_what
= linespec_complete_what::LABEL
;
1956 /* If we have text after the label separated by whitespace
1957 (e.g., "b func():lab i<tab>"), don't consider it part of
1958 the label. In completion mode that should complete to
1959 "if", in normal mode, the 'i' should be treated as
1961 if (parser
->completion_quote_char
== '\0')
1963 const char *ptr
= LS_TOKEN_STOKEN (token
).ptr
;
1964 for (size_t i
= 0; i
< LS_TOKEN_STOKEN (token
).length
; i
++)
1968 LS_TOKEN_STOKEN (token
).length
= i
;
1969 PARSER_STREAM (parser
) = skip_spaces (ptr
+ i
+ 1);
1975 if (parser
->completion_tracker
!= NULL
)
1977 if (PARSER_STREAM (parser
)[-1] == ' ')
1979 parser
->completion_word
= PARSER_STREAM (parser
);
1980 parser
->complete_what
= linespec_complete_what::KEYWORD
;
1985 /* Grab a copy of the label's name and look it up. */
1986 name
= copy_token_string (token
);
1988 = find_label_symbols (PARSER_STATE (parser
),
1989 PARSER_RESULT (parser
)->function_symbols
,
1990 &symbols
, name
.get ());
1994 PARSER_RESULT (parser
)->labels
.label_symbols
= labels
;
1995 PARSER_RESULT (parser
)->labels
.function_symbols
1996 = new std::vector
<block_symbol
> (std::move (symbols
));
1997 PARSER_EXPLICIT (parser
)->label_name
= name
.release ();
2001 /* We don't know what it was, but it isn't a label. */
2002 undefined_label_error
2003 (PARSER_EXPLICIT (parser
)->function_name
, name
.get ());
2008 /* Check for a line offset. */
2009 token
= save_stream_and_consume_token (parser
);
2010 if (token
.type
== LSTOKEN_COLON
)
2012 /* Get the next token. */
2013 token
= linespec_lexer_consume_token (parser
);
2015 /* It must be a line offset. */
2016 if (token
.type
!= LSTOKEN_NUMBER
)
2017 unexpected_linespec_error (parser
);
2019 /* Record the line offset and get the next token. */
2020 name
= copy_token_string (token
);
2022 PARSER_EXPLICIT (parser
)->line_offset
2023 = linespec_parse_line_offset (name
.get ());
2025 /* Get the next token. */
2026 token
= linespec_lexer_consume_token (parser
);
2031 /* Trailing ':' in the input. Issue an error. */
2032 unexpected_linespec_error (parser
);
2037 /* Canonicalize the linespec contained in LS. The result is saved into
2038 STATE->canonical. This function handles both linespec and explicit
2042 canonicalize_linespec (struct linespec_state
*state
, const linespec_p ls
)
2044 struct event_location
*canon
;
2045 struct explicit_location
*explicit_loc
;
2047 /* If canonicalization was not requested, no need to do anything. */
2048 if (!state
->canonical
)
2051 /* Save everything as an explicit location. */
2052 state
->canonical
->location
2053 = new_explicit_location (&ls
->explicit_loc
);
2054 canon
= state
->canonical
->location
.get ();
2055 explicit_loc
= get_explicit_location (canon
);
2057 if (explicit_loc
->label_name
!= NULL
)
2059 state
->canonical
->special_display
= 1;
2061 if (explicit_loc
->function_name
== NULL
)
2063 /* No function was specified, so add the symbol name. */
2064 gdb_assert (!ls
->labels
.function_symbols
->empty ()
2065 && (ls
->labels
.function_symbols
->size () == 1));
2066 block_symbol s
= ls
->labels
.function_symbols
->front ();
2067 explicit_loc
->function_name
= xstrdup (s
.symbol
->natural_name ());
2071 /* If this location originally came from a linespec, save a string
2072 representation of it for display and saving to file. */
2073 if (state
->is_linespec
)
2075 char *linespec
= explicit_location_to_linespec (explicit_loc
);
2077 set_event_location_string (canon
, linespec
);
2082 /* Given a line offset in LS, construct the relevant SALs. */
2084 static std::vector
<symtab_and_line
>
2085 create_sals_line_offset (struct linespec_state
*self
,
2088 int use_default
= 0;
2090 /* This is where we need to make sure we have good defaults.
2091 We must guarantee that this section of code is never executed
2092 when we are called with just a function name, since
2093 set_default_source_symtab_and_line uses
2094 select_source_symtab that calls us with such an argument. */
2096 if (ls
->file_symtabs
->size () == 1
2097 && ls
->file_symtabs
->front () == nullptr)
2099 set_current_program_space (self
->program_space
);
2101 /* Make sure we have at least a default source line. */
2102 set_default_source_symtab_and_line ();
2103 initialize_defaults (&self
->default_symtab
, &self
->default_line
);
2105 = collect_symtabs_from_filename (self
->default_symtab
->filename
,
2106 self
->search_pspace
);
2110 symtab_and_line val
;
2111 val
.line
= ls
->explicit_loc
.line_offset
.offset
;
2112 switch (ls
->explicit_loc
.line_offset
.sign
)
2114 case LINE_OFFSET_PLUS
:
2115 if (ls
->explicit_loc
.line_offset
.offset
== 0)
2118 val
.line
= self
->default_line
+ val
.line
;
2121 case LINE_OFFSET_MINUS
:
2122 if (ls
->explicit_loc
.line_offset
.offset
== 0)
2125 val
.line
= self
->default_line
- val
.line
;
2127 val
.line
= -val
.line
;
2130 case LINE_OFFSET_NONE
:
2131 break; /* No need to adjust val.line. */
2134 std::vector
<symtab_and_line
> values
;
2135 if (self
->list_mode
)
2136 values
= decode_digits_list_mode (self
, ls
, val
);
2139 struct linetable_entry
*best_entry
= NULL
;
2142 std::vector
<symtab_and_line
> intermediate_results
2143 = decode_digits_ordinary (self
, ls
, val
.line
, &best_entry
);
2144 if (intermediate_results
.empty () && best_entry
!= NULL
)
2145 intermediate_results
= decode_digits_ordinary (self
, ls
,
2149 /* For optimized code, the compiler can scatter one source line
2150 across disjoint ranges of PC values, even when no duplicate
2151 functions or inline functions are involved. For example,
2152 'for (;;)' inside a non-template, non-inline, and non-ctor-or-dtor
2153 function can result in two PC ranges. In this case, we don't
2154 want to set a breakpoint on the first PC of each range. To filter
2155 such cases, we use containing blocks -- for each PC found
2156 above, we see if there are other PCs that are in the same
2157 block. If yes, the other PCs are filtered out. */
2159 gdb::def_vector
<int> filter (intermediate_results
.size ());
2160 gdb::def_vector
<const block
*> blocks (intermediate_results
.size ());
2162 for (i
= 0; i
< intermediate_results
.size (); ++i
)
2164 set_current_program_space (intermediate_results
[i
].pspace
);
2167 blocks
[i
] = block_for_pc_sect (intermediate_results
[i
].pc
,
2168 intermediate_results
[i
].section
);
2171 for (i
= 0; i
< intermediate_results
.size (); ++i
)
2173 if (blocks
[i
] != NULL
)
2174 for (j
= i
+ 1; j
< intermediate_results
.size (); ++j
)
2176 if (blocks
[j
] == blocks
[i
])
2184 for (i
= 0; i
< intermediate_results
.size (); ++i
)
2187 struct symbol
*sym
= (blocks
[i
]
2188 ? block_containing_function (blocks
[i
])
2191 if (self
->funfirstline
)
2192 skip_prologue_sal (&intermediate_results
[i
]);
2193 intermediate_results
[i
].symbol
= sym
;
2194 add_sal_to_sals (self
, &values
, &intermediate_results
[i
],
2195 sym
? sym
->natural_name () : NULL
, 0);
2199 if (values
.empty ())
2201 if (ls
->explicit_loc
.source_filename
)
2202 throw_error (NOT_FOUND_ERROR
, _("No line %d in file \"%s\"."),
2203 val
.line
, ls
->explicit_loc
.source_filename
);
2205 throw_error (NOT_FOUND_ERROR
, _("No line %d in the current file."),
2212 /* Convert the given ADDRESS into SaLs. */
2214 static std::vector
<symtab_and_line
>
2215 convert_address_location_to_sals (struct linespec_state
*self
,
2218 symtab_and_line sal
= find_pc_line (address
, 0);
2220 sal
.section
= find_pc_overlay (address
);
2221 sal
.explicit_pc
= 1;
2222 sal
.symbol
= find_pc_sect_containing_function (sal
.pc
, sal
.section
);
2224 std::vector
<symtab_and_line
> sals
;
2225 add_sal_to_sals (self
, &sals
, &sal
, core_addr_to_string (address
), 1);
2230 /* Create and return SALs from the linespec LS. */
2232 static std::vector
<symtab_and_line
>
2233 convert_linespec_to_sals (struct linespec_state
*state
, linespec_p ls
)
2235 std::vector
<symtab_and_line
> sals
;
2237 if (ls
->labels
.label_symbols
!= NULL
)
2239 /* We have just a bunch of functions/methods or labels. */
2240 struct symtab_and_line sal
;
2242 for (const auto &sym
: *ls
->labels
.label_symbols
)
2244 struct program_space
*pspace
2245 = SYMTAB_PSPACE (symbol_symtab (sym
.symbol
));
2247 if (symbol_to_sal (&sal
, state
->funfirstline
, sym
.symbol
)
2248 && maybe_add_address (state
->addr_set
, pspace
, sal
.pc
))
2249 add_sal_to_sals (state
, &sals
, &sal
,
2250 sym
.symbol
->natural_name (), 0);
2253 else if (ls
->function_symbols
!= NULL
|| ls
->minimal_symbols
!= NULL
)
2255 /* We have just a bunch of functions and/or methods. */
2256 if (ls
->function_symbols
!= NULL
)
2258 /* Sort symbols so that symbols with the same program space are next
2260 std::sort (ls
->function_symbols
->begin (),
2261 ls
->function_symbols
->end (),
2264 for (const auto &sym
: *ls
->function_symbols
)
2266 program_space
*pspace
2267 = SYMTAB_PSPACE (symbol_symtab (sym
.symbol
));
2268 set_current_program_space (pspace
);
2270 /* Don't skip to the first line of the function if we
2271 had found an ifunc minimal symbol for this function,
2272 because that means that this function is an ifunc
2273 resolver with the same name as the ifunc itself. */
2274 bool found_ifunc
= false;
2276 if (state
->funfirstline
2277 && ls
->minimal_symbols
!= NULL
2278 && SYMBOL_CLASS (sym
.symbol
) == LOC_BLOCK
)
2280 const CORE_ADDR addr
2281 = BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
.symbol
));
2283 for (const auto &elem
: *ls
->minimal_symbols
)
2285 if (MSYMBOL_TYPE (elem
.minsym
) == mst_text_gnu_ifunc
2286 || MSYMBOL_TYPE (elem
.minsym
) == mst_data_gnu_ifunc
)
2288 CORE_ADDR msym_addr
= BMSYMBOL_VALUE_ADDRESS (elem
);
2289 if (MSYMBOL_TYPE (elem
.minsym
) == mst_data_gnu_ifunc
)
2291 struct gdbarch
*gdbarch
2292 = elem
.objfile
->arch ();
2294 = (gdbarch_convert_from_func_ptr_addr
2297 current_top_target ()));
2300 if (msym_addr
== addr
)
2311 symtab_and_line sal
;
2312 if (symbol_to_sal (&sal
, state
->funfirstline
, sym
.symbol
)
2313 && maybe_add_address (state
->addr_set
, pspace
, sal
.pc
))
2314 add_sal_to_sals (state
, &sals
, &sal
,
2315 sym
.symbol
->natural_name (), 0);
2320 if (ls
->minimal_symbols
!= NULL
)
2322 /* Sort minimal symbols by program space, too */
2323 std::sort (ls
->minimal_symbols
->begin (),
2324 ls
->minimal_symbols
->end (),
2327 for (const auto &elem
: *ls
->minimal_symbols
)
2329 program_space
*pspace
= elem
.objfile
->pspace
;
2330 set_current_program_space (pspace
);
2331 minsym_found (state
, elem
.objfile
, elem
.minsym
, &sals
);
2335 else if (ls
->explicit_loc
.line_offset
.sign
!= LINE_OFFSET_UNKNOWN
)
2337 /* Only an offset was specified. */
2338 sals
= create_sals_line_offset (state
, ls
);
2340 /* Make sure we have a filename for canonicalization. */
2341 if (ls
->explicit_loc
.source_filename
== NULL
)
2343 const char *fullname
= symtab_to_fullname (state
->default_symtab
);
2345 /* It may be more appropriate to keep DEFAULT_SYMTAB in its symtab
2346 form so that displaying SOURCE_FILENAME can follow the current
2347 FILENAME_DISPLAY_STRING setting. But as it is used only rarely
2348 it has been kept for code simplicity only in absolute form. */
2349 ls
->explicit_loc
.source_filename
= xstrdup (fullname
);
2354 /* We haven't found any results... */
2358 canonicalize_linespec (state
, ls
);
2360 if (!sals
.empty () && state
->canonical
!= NULL
)
2361 state
->canonical
->pre_expanded
= 1;
2366 /* Build RESULT from the explicit location components SOURCE_FILENAME,
2367 FUNCTION_NAME, LABEL_NAME and LINE_OFFSET. */
2370 convert_explicit_location_to_linespec (struct linespec_state
*self
,
2372 const char *source_filename
,
2373 const char *function_name
,
2374 symbol_name_match_type fname_match_type
,
2375 const char *label_name
,
2376 struct line_offset line_offset
)
2378 std::vector
<block_symbol
> symbols
;
2379 std::vector
<block_symbol
> *labels
;
2380 std::vector
<bound_minimal_symbol
> minimal_symbols
;
2382 result
->explicit_loc
.func_name_match_type
= fname_match_type
;
2384 if (source_filename
!= NULL
)
2388 *result
->file_symtabs
2389 = symtabs_from_filename (source_filename
, self
->search_pspace
);
2391 catch (const gdb_exception_error
&except
)
2393 source_file_not_found_error (source_filename
);
2395 result
->explicit_loc
.source_filename
= xstrdup (source_filename
);
2399 /* A NULL entry means to use the default symtab. */
2400 result
->file_symtabs
->push_back (nullptr);
2403 if (function_name
!= NULL
)
2405 find_linespec_symbols (self
, result
->file_symtabs
,
2406 function_name
, fname_match_type
,
2407 &symbols
, &minimal_symbols
);
2409 if (symbols
.empty () && minimal_symbols
.empty ())
2410 symbol_not_found_error (function_name
,
2411 result
->explicit_loc
.source_filename
);
2413 result
->explicit_loc
.function_name
= xstrdup (function_name
);
2414 result
->function_symbols
2415 = new std::vector
<block_symbol
> (std::move (symbols
));
2416 result
->minimal_symbols
2417 = new std::vector
<bound_minimal_symbol
> (std::move (minimal_symbols
));
2420 if (label_name
!= NULL
)
2422 labels
= find_label_symbols (self
, result
->function_symbols
,
2423 &symbols
, label_name
);
2426 undefined_label_error (result
->explicit_loc
.function_name
,
2429 result
->explicit_loc
.label_name
= xstrdup (label_name
);
2430 result
->labels
.label_symbols
= labels
;
2431 result
->labels
.function_symbols
2432 = new std::vector
<block_symbol
> (std::move (symbols
));
2435 if (line_offset
.sign
!= LINE_OFFSET_UNKNOWN
)
2436 result
->explicit_loc
.line_offset
= line_offset
;
2439 /* Convert the explicit location EXPLICIT_LOC into SaLs. */
2441 static std::vector
<symtab_and_line
>
2442 convert_explicit_location_to_sals (struct linespec_state
*self
,
2444 const struct explicit_location
*explicit_loc
)
2446 convert_explicit_location_to_linespec (self
, result
,
2447 explicit_loc
->source_filename
,
2448 explicit_loc
->function_name
,
2449 explicit_loc
->func_name_match_type
,
2450 explicit_loc
->label_name
,
2451 explicit_loc
->line_offset
);
2452 return convert_linespec_to_sals (self
, result
);
2455 /* Parse a string that specifies a linespec.
2457 The basic grammar of linespecs:
2459 linespec -> var_spec | basic_spec
2460 var_spec -> '$' (STRING | NUMBER)
2462 basic_spec -> file_offset_spec | function_spec | label_spec
2463 file_offset_spec -> opt_file_spec offset_spec
2464 function_spec -> opt_file_spec function_name_spec opt_label_spec
2465 label_spec -> label_name_spec
2467 opt_file_spec -> "" | file_name_spec ':'
2468 opt_label_spec -> "" | ':' label_name_spec
2470 file_name_spec -> STRING
2471 function_name_spec -> STRING
2472 label_name_spec -> STRING
2473 function_name_spec -> STRING
2474 offset_spec -> NUMBER
2478 This may all be followed by several keywords such as "if EXPR",
2481 A comma will terminate parsing.
2483 The function may be an undebuggable function found in minimal symbol table.
2485 If the argument FUNFIRSTLINE is nonzero, we want the first line
2486 of real code inside a function when a function is specified, and it is
2487 not OK to specify a variable or type to get its line number.
2489 DEFAULT_SYMTAB specifies the file to use if none is specified.
2490 It defaults to current_source_symtab.
2491 DEFAULT_LINE specifies the line number to use for relative
2492 line numbers (that start with signs). Defaults to current_source_line.
2493 If CANONICAL is non-NULL, store an array of strings containing the canonical
2494 line specs there if necessary. Currently overloaded member functions and
2495 line numbers or static functions without a filename yield a canonical
2496 line spec. The array and the line spec strings are allocated on the heap,
2497 it is the callers responsibility to free them.
2499 Note that it is possible to return zero for the symtab
2500 if no file is validly specified. Callers must check that.
2501 Also, the line number returned may be invalid. */
2503 /* Parse the linespec in ARG. MATCH_TYPE indicates how function names
2504 should be matched. */
2506 static std::vector
<symtab_and_line
>
2507 parse_linespec (linespec_parser
*parser
, const char *arg
,
2508 symbol_name_match_type match_type
)
2510 linespec_token token
;
2511 struct gdb_exception file_exception
;
2513 /* A special case to start. It has become quite popular for
2514 IDEs to work around bugs in the previous parser by quoting
2515 the entire linespec, so we attempt to deal with this nicely. */
2516 parser
->is_quote_enclosed
= 0;
2517 if (parser
->completion_tracker
== NULL
2518 && !is_ada_operator (arg
)
2519 && strchr (linespec_quote_characters
, *arg
) != NULL
)
2523 end
= skip_quote_char (arg
+ 1, *arg
);
2524 if (end
!= NULL
&& is_closing_quote_enclosed (end
))
2526 /* Here's the special case. Skip ARG past the initial
2529 parser
->is_quote_enclosed
= 1;
2533 parser
->lexer
.saved_arg
= arg
;
2534 parser
->lexer
.stream
= arg
;
2535 parser
->completion_word
= arg
;
2536 parser
->complete_what
= linespec_complete_what::FUNCTION
;
2537 PARSER_EXPLICIT (parser
)->func_name_match_type
= match_type
;
2539 /* Initialize the default symtab and line offset. */
2540 initialize_defaults (&PARSER_STATE (parser
)->default_symtab
,
2541 &PARSER_STATE (parser
)->default_line
);
2543 /* Objective-C shortcut. */
2544 if (parser
->completion_tracker
== NULL
)
2546 std::vector
<symtab_and_line
> values
2547 = decode_objc (PARSER_STATE (parser
), PARSER_RESULT (parser
), arg
);
2548 if (!values
.empty ())
2553 /* "-"/"+" is either an objc selector, or a number. There's
2554 nothing to complete the latter to, so just let the caller
2555 complete on functions, which finds objc selectors, if there's
2557 if ((arg
[0] == '-' || arg
[0] == '+') && arg
[1] == '\0')
2561 /* Start parsing. */
2563 /* Get the first token. */
2564 token
= linespec_lexer_consume_token (parser
);
2566 /* It must be either LSTOKEN_STRING or LSTOKEN_NUMBER. */
2567 if (token
.type
== LSTOKEN_STRING
&& *LS_TOKEN_STOKEN (token
).ptr
== '$')
2569 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2570 if (parser
->completion_tracker
== NULL
)
2571 PARSER_RESULT (parser
)->file_symtabs
->push_back (nullptr);
2573 /* User specified a convenience variable or history value. */
2574 gdb::unique_xmalloc_ptr
<char> var
= copy_token_string (token
);
2575 PARSER_EXPLICIT (parser
)->line_offset
2576 = linespec_parse_variable (PARSER_STATE (parser
), var
.get ());
2578 /* If a line_offset wasn't found (VAR is the name of a user
2579 variable/function), then skip to normal symbol processing. */
2580 if (PARSER_EXPLICIT (parser
)->line_offset
.sign
!= LINE_OFFSET_UNKNOWN
)
2582 /* Consume this token. */
2583 linespec_lexer_consume_token (parser
);
2585 goto convert_to_sals
;
2588 else if (token
.type
== LSTOKEN_EOI
&& parser
->completion_tracker
!= NULL
)
2590 /* Let the default linespec_complete_what::FUNCTION kick in. */
2591 unexpected_linespec_error (parser
);
2593 else if (token
.type
!= LSTOKEN_STRING
&& token
.type
!= LSTOKEN_NUMBER
)
2595 parser
->complete_what
= linespec_complete_what::NOTHING
;
2596 unexpected_linespec_error (parser
);
2599 /* Shortcut: If the next token is not LSTOKEN_COLON, we know that
2600 this token cannot represent a filename. */
2601 token
= linespec_lexer_peek_token (parser
);
2603 if (token
.type
== LSTOKEN_COLON
)
2605 /* Get the current token again and extract the filename. */
2606 token
= linespec_lexer_lex_one (parser
);
2607 gdb::unique_xmalloc_ptr
<char> user_filename
= copy_token_string (token
);
2609 /* Check if the input is a filename. */
2612 *PARSER_RESULT (parser
)->file_symtabs
2613 = symtabs_from_filename (user_filename
.get (),
2614 PARSER_STATE (parser
)->search_pspace
);
2616 catch (gdb_exception_error
&ex
)
2618 file_exception
= std::move (ex
);
2621 if (file_exception
.reason
>= 0)
2623 /* Symtabs were found for the file. Record the filename. */
2624 PARSER_EXPLICIT (parser
)->source_filename
= user_filename
.release ();
2626 /* Get the next token. */
2627 token
= linespec_lexer_consume_token (parser
);
2629 /* This is LSTOKEN_COLON; consume it. */
2630 linespec_lexer_consume_token (parser
);
2634 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2635 PARSER_RESULT (parser
)->file_symtabs
->push_back (nullptr);
2638 /* If the next token is not EOI, KEYWORD, or COMMA, issue an error. */
2639 else if (parser
->completion_tracker
== NULL
2640 && (token
.type
!= LSTOKEN_EOI
&& token
.type
!= LSTOKEN_KEYWORD
2641 && token
.type
!= LSTOKEN_COMMA
))
2643 /* TOKEN is the _next_ token, not the one currently in the parser.
2644 Consuming the token will give the correct error message. */
2645 linespec_lexer_consume_token (parser
);
2646 unexpected_linespec_error (parser
);
2650 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2651 PARSER_RESULT (parser
)->file_symtabs
->push_back (nullptr);
2654 /* Parse the rest of the linespec. */
2655 linespec_parse_basic (parser
);
2657 if (parser
->completion_tracker
== NULL
2658 && PARSER_RESULT (parser
)->function_symbols
== NULL
2659 && PARSER_RESULT (parser
)->labels
.label_symbols
== NULL
2660 && PARSER_EXPLICIT (parser
)->line_offset
.sign
== LINE_OFFSET_UNKNOWN
2661 && PARSER_RESULT (parser
)->minimal_symbols
== NULL
)
2663 /* The linespec didn't parse. Re-throw the file exception if
2665 if (file_exception
.reason
< 0)
2666 throw_exception (std::move (file_exception
));
2668 /* Otherwise, the symbol is not found. */
2669 symbol_not_found_error (PARSER_EXPLICIT (parser
)->function_name
,
2670 PARSER_EXPLICIT (parser
)->source_filename
);
2675 /* Get the last token and record how much of the input was parsed,
2677 token
= linespec_lexer_lex_one (parser
);
2678 if (token
.type
!= LSTOKEN_EOI
&& token
.type
!= LSTOKEN_KEYWORD
)
2679 unexpected_linespec_error (parser
);
2680 else if (token
.type
== LSTOKEN_KEYWORD
)
2682 /* Setup the completion word past the keyword. Lexing never
2683 advances past a keyword automatically, so skip it
2685 parser
->completion_word
2686 = skip_spaces (skip_to_space (PARSER_STREAM (parser
)));
2687 parser
->complete_what
= linespec_complete_what::EXPRESSION
;
2690 /* Convert the data in PARSER_RESULT to SALs. */
2691 if (parser
->completion_tracker
== NULL
)
2692 return convert_linespec_to_sals (PARSER_STATE (parser
),
2693 PARSER_RESULT (parser
));
2699 /* A constructor for linespec_state. */
2702 linespec_state_constructor (struct linespec_state
*self
,
2703 int flags
, const struct language_defn
*language
,
2704 struct program_space
*search_pspace
,
2705 struct symtab
*default_symtab
,
2707 struct linespec_result
*canonical
)
2709 memset (self
, 0, sizeof (*self
));
2710 self
->language
= language
;
2711 self
->funfirstline
= (flags
& DECODE_LINE_FUNFIRSTLINE
) ? 1 : 0;
2712 self
->list_mode
= (flags
& DECODE_LINE_LIST_MODE
) ? 1 : 0;
2713 self
->search_pspace
= search_pspace
;
2714 self
->default_symtab
= default_symtab
;
2715 self
->default_line
= default_line
;
2716 self
->canonical
= canonical
;
2717 self
->program_space
= current_program_space
;
2718 self
->addr_set
= htab_create_alloc (10, hash_address_entry
, eq_address_entry
,
2719 xfree
, xcalloc
, xfree
);
2720 self
->is_linespec
= 0;
2723 /* Initialize a new linespec parser. */
2725 linespec_parser::linespec_parser (int flags
,
2726 const struct language_defn
*language
,
2727 struct program_space
*search_pspace
,
2728 struct symtab
*default_symtab
,
2730 struct linespec_result
*canonical
)
2732 lexer
.current
.type
= LSTOKEN_CONSUMED
;
2733 PARSER_RESULT (this)->file_symtabs
= new std::vector
<symtab
*> ();
2734 PARSER_EXPLICIT (this)->func_name_match_type
2735 = symbol_name_match_type::WILD
;
2736 PARSER_EXPLICIT (this)->line_offset
.sign
= LINE_OFFSET_UNKNOWN
;
2737 linespec_state_constructor (PARSER_STATE (this), flags
, language
,
2739 default_symtab
, default_line
, canonical
);
2742 /* A destructor for linespec_state. */
2745 linespec_state_destructor (struct linespec_state
*self
)
2747 htab_delete (self
->addr_set
);
2748 xfree (self
->canonical_names
);
2751 /* Delete a linespec parser. */
2753 linespec_parser::~linespec_parser ()
2755 xfree (PARSER_EXPLICIT (this)->source_filename
);
2756 xfree (PARSER_EXPLICIT (this)->label_name
);
2757 xfree (PARSER_EXPLICIT (this)->function_name
);
2759 delete PARSER_RESULT (this)->file_symtabs
;
2760 delete PARSER_RESULT (this)->function_symbols
;
2761 delete PARSER_RESULT (this)->minimal_symbols
;
2762 delete PARSER_RESULT (this)->labels
.label_symbols
;
2763 delete PARSER_RESULT (this)->labels
.function_symbols
;
2765 linespec_state_destructor (PARSER_STATE (this));
2768 /* See description in linespec.h. */
2771 linespec_lex_to_end (const char **stringp
)
2773 linespec_token token
;
2776 if (stringp
== NULL
|| *stringp
== NULL
)
2779 linespec_parser
parser (0, current_language
, NULL
, NULL
, 0, NULL
);
2780 parser
.lexer
.saved_arg
= *stringp
;
2781 PARSER_STREAM (&parser
) = orig
= *stringp
;
2785 /* Stop before any comma tokens; we need it to keep it
2786 as the next token in the string. */
2787 token
= linespec_lexer_peek_token (&parser
);
2788 if (token
.type
== LSTOKEN_COMMA
)
2790 token
= linespec_lexer_consume_token (&parser
);
2792 while (token
.type
!= LSTOKEN_EOI
&& token
.type
!= LSTOKEN_KEYWORD
);
2794 *stringp
+= PARSER_STREAM (&parser
) - orig
;
2797 /* See linespec.h. */
2800 linespec_complete_function (completion_tracker
&tracker
,
2801 const char *function
,
2802 symbol_name_match_type func_match_type
,
2803 const char *source_filename
)
2805 complete_symbol_mode mode
= complete_symbol_mode::LINESPEC
;
2807 if (source_filename
!= NULL
)
2809 collect_file_symbol_completion_matches (tracker
, mode
, func_match_type
,
2810 function
, function
, source_filename
);
2814 collect_symbol_completion_matches (tracker
, mode
, func_match_type
,
2815 function
, function
);
2820 /* Helper for complete_linespec to simplify it. SOURCE_FILENAME is
2821 only meaningful if COMPONENT is FUNCTION. */
2824 complete_linespec_component (linespec_parser
*parser
,
2825 completion_tracker
&tracker
,
2827 linespec_complete_what component
,
2828 const char *source_filename
)
2830 if (component
== linespec_complete_what::KEYWORD
)
2832 complete_on_enum (tracker
, linespec_keywords
, text
, text
);
2834 else if (component
== linespec_complete_what::EXPRESSION
)
2837 = advance_to_expression_complete_word_point (tracker
, text
);
2838 complete_expression (tracker
, text
, word
);
2840 else if (component
== linespec_complete_what::FUNCTION
)
2842 completion_list fn_list
;
2844 symbol_name_match_type match_type
2845 = PARSER_EXPLICIT (parser
)->func_name_match_type
;
2846 linespec_complete_function (tracker
, text
, match_type
, source_filename
);
2847 if (source_filename
== NULL
)
2849 /* Haven't seen a source component, like in "b
2850 file.c:function[TAB]". Maybe this wasn't a function, but
2851 a filename instead, like "b file.[TAB]". */
2852 fn_list
= complete_source_filenames (text
);
2855 /* If we only have a single filename completion, append a ':' for
2856 the user, since that's the only thing that can usefully follow
2858 if (fn_list
.size () == 1 && !tracker
.have_completions ())
2860 char *fn
= fn_list
[0].release ();
2862 /* If we also need to append a quote char, it needs to be
2863 appended before the ':'. Append it now, and make ':' the
2864 new "quote" char. */
2865 if (tracker
.quote_char ())
2867 char quote_char_str
[2] = { (char) tracker
.quote_char () };
2869 fn
= reconcat (fn
, fn
, quote_char_str
, (char *) NULL
);
2870 tracker
.set_quote_char (':');
2873 fn
= reconcat (fn
, fn
, ":", (char *) NULL
);
2874 fn_list
[0].reset (fn
);
2876 /* Tell readline to skip appending a space. */
2877 tracker
.set_suppress_append_ws (true);
2879 tracker
.add_completions (std::move (fn_list
));
2883 /* Helper for linespec_complete_label. Find labels that match
2884 LABEL_NAME in the function symbols listed in the PARSER, and add
2885 them to the tracker. */
2888 complete_label (completion_tracker
&tracker
,
2889 linespec_parser
*parser
,
2890 const char *label_name
)
2892 std::vector
<block_symbol
> label_function_symbols
;
2893 std::vector
<block_symbol
> *labels
2894 = find_label_symbols (PARSER_STATE (parser
),
2895 PARSER_RESULT (parser
)->function_symbols
,
2896 &label_function_symbols
,
2899 if (labels
!= nullptr)
2901 for (const auto &label
: *labels
)
2903 char *match
= xstrdup (label
.symbol
->search_name ());
2904 tracker
.add_completion (gdb::unique_xmalloc_ptr
<char> (match
));
2910 /* See linespec.h. */
2913 linespec_complete_label (completion_tracker
&tracker
,
2914 const struct language_defn
*language
,
2915 const char *source_filename
,
2916 const char *function_name
,
2917 symbol_name_match_type func_name_match_type
,
2918 const char *label_name
)
2920 linespec_parser
parser (0, language
, NULL
, NULL
, 0, NULL
);
2922 line_offset unknown_offset
= { 0, LINE_OFFSET_UNKNOWN
};
2926 convert_explicit_location_to_linespec (PARSER_STATE (&parser
),
2927 PARSER_RESULT (&parser
),
2930 func_name_match_type
,
2931 NULL
, unknown_offset
);
2933 catch (const gdb_exception_error
&ex
)
2938 complete_label (tracker
, &parser
, label_name
);
2941 /* See description in linespec.h. */
2944 linespec_complete (completion_tracker
&tracker
, const char *text
,
2945 symbol_name_match_type match_type
)
2947 const char *orig
= text
;
2949 linespec_parser
parser (0, current_language
, NULL
, NULL
, 0, NULL
);
2950 parser
.lexer
.saved_arg
= text
;
2951 PARSER_EXPLICIT (&parser
)->func_name_match_type
= match_type
;
2952 PARSER_STREAM (&parser
) = text
;
2954 parser
.completion_tracker
= &tracker
;
2955 PARSER_STATE (&parser
)->is_linespec
= 1;
2957 /* Parse as much as possible. parser.completion_word will hold
2958 furthest completion point we managed to parse to. */
2961 parse_linespec (&parser
, text
, match_type
);
2963 catch (const gdb_exception_error
&except
)
2967 if (parser
.completion_quote_char
!= '\0'
2968 && parser
.completion_quote_end
!= NULL
2969 && parser
.completion_quote_end
[1] == '\0')
2971 /* If completing a quoted string with the cursor right at
2972 terminating quote char, complete the completion word without
2973 interpretation, so that readline advances the cursor one
2974 whitespace past the quote, even if there's no match. This
2975 makes these cases behave the same:
2977 before: "b function()"
2978 after: "b function() "
2980 before: "b 'function()'"
2981 after: "b 'function()' "
2983 and trusts the user in this case:
2985 before: "b 'not_loaded_function_yet()'"
2986 after: "b 'not_loaded_function_yet()' "
2988 parser
.complete_what
= linespec_complete_what::NOTHING
;
2989 parser
.completion_quote_char
= '\0';
2991 gdb::unique_xmalloc_ptr
<char> text_copy
2992 (xstrdup (parser
.completion_word
));
2993 tracker
.add_completion (std::move (text_copy
));
2996 tracker
.set_quote_char (parser
.completion_quote_char
);
2998 if (parser
.complete_what
== linespec_complete_what::LABEL
)
3000 parser
.complete_what
= linespec_complete_what::NOTHING
;
3002 const char *func_name
= PARSER_EXPLICIT (&parser
)->function_name
;
3004 std::vector
<block_symbol
> function_symbols
;
3005 std::vector
<bound_minimal_symbol
> minimal_symbols
;
3006 find_linespec_symbols (PARSER_STATE (&parser
),
3007 PARSER_RESULT (&parser
)->file_symtabs
,
3008 func_name
, match_type
,
3009 &function_symbols
, &minimal_symbols
);
3011 PARSER_RESULT (&parser
)->function_symbols
3012 = new std::vector
<block_symbol
> (std::move (function_symbols
));
3013 PARSER_RESULT (&parser
)->minimal_symbols
3014 = new std::vector
<bound_minimal_symbol
> (std::move (minimal_symbols
));
3016 complete_label (tracker
, &parser
, parser
.completion_word
);
3018 else if (parser
.complete_what
== linespec_complete_what::FUNCTION
)
3020 /* While parsing/lexing, we didn't know whether the completion
3021 word completes to a unique function/source name already or
3025 "b function() <tab>"
3026 may need to complete either to:
3027 "b function() const"
3029 "b function() if/thread/task"
3033 may need to complete either to:
3034 "b foo template_fun<T>()"
3035 with "foo" being the template function's return type, or to:
3040 may need to complete either to a source file name:
3042 or this, also a filename, but a unique completion:
3044 or to a function name:
3047 Address that by completing assuming source or function, and
3048 seeing if we find a completion that matches exactly the
3049 completion word. If so, then it must be a function (see note
3050 below) and we advance the completion word to the end of input
3051 and switch to KEYWORD completion mode.
3053 Note: if we find a unique completion for a source filename,
3054 then it won't match the completion word, because the LCD will
3055 contain a trailing ':'. And if we're completing at or after
3056 the ':', then complete_linespec_component won't try to
3057 complete on source filenames. */
3059 const char *word
= parser
.completion_word
;
3061 complete_linespec_component (&parser
, tracker
,
3062 parser
.completion_word
,
3063 linespec_complete_what::FUNCTION
,
3064 PARSER_EXPLICIT (&parser
)->source_filename
);
3066 parser
.complete_what
= linespec_complete_what::NOTHING
;
3068 if (tracker
.quote_char ())
3070 /* The function/file name was not close-quoted, so this
3071 can't be a keyword. Note: complete_linespec_component
3072 may have swapped the original quote char for ':' when we
3073 get here, but that still indicates the same. */
3075 else if (!tracker
.have_completions ())
3078 size_t wordlen
= strlen (parser
.completion_word
);
3081 = string_find_incomplete_keyword_at_end (linespec_keywords
,
3082 parser
.completion_word
,
3087 && parser
.completion_word
[wordlen
- 1] == ' '))
3089 parser
.completion_word
+= key_start
;
3090 parser
.complete_what
= linespec_complete_what::KEYWORD
;
3093 else if (tracker
.completes_to_completion_word (word
))
3095 /* Skip the function and complete on keywords. */
3096 parser
.completion_word
+= strlen (word
);
3097 parser
.complete_what
= linespec_complete_what::KEYWORD
;
3098 tracker
.discard_completions ();
3102 tracker
.advance_custom_word_point_by (parser
.completion_word
- orig
);
3104 complete_linespec_component (&parser
, tracker
,
3105 parser
.completion_word
,
3106 parser
.complete_what
,
3107 PARSER_EXPLICIT (&parser
)->source_filename
);
3109 /* If we're past the "filename:function:label:offset" linespec, and
3110 didn't find any match, then assume the user might want to create
3111 a pending breakpoint anyway and offer the keyword
3113 if (!parser
.completion_quote_char
3114 && (parser
.complete_what
== linespec_complete_what::FUNCTION
3115 || parser
.complete_what
== linespec_complete_what::LABEL
3116 || parser
.complete_what
== linespec_complete_what::NOTHING
)
3117 && !tracker
.have_completions ())
3120 = parser
.completion_word
+ strlen (parser
.completion_word
);
3122 if (end
> orig
&& end
[-1] == ' ')
3124 tracker
.advance_custom_word_point_by (end
- parser
.completion_word
);
3126 complete_linespec_component (&parser
, tracker
, end
,
3127 linespec_complete_what::KEYWORD
,
3133 /* A helper function for decode_line_full and decode_line_1 to
3134 turn LOCATION into std::vector<symtab_and_line>. */
3136 static std::vector
<symtab_and_line
>
3137 event_location_to_sals (linespec_parser
*parser
,
3138 const struct event_location
*location
)
3140 std::vector
<symtab_and_line
> result
;
3142 switch (event_location_type (location
))
3144 case LINESPEC_LOCATION
:
3146 PARSER_STATE (parser
)->is_linespec
= 1;
3149 const linespec_location
*ls
= get_linespec_location (location
);
3150 result
= parse_linespec (parser
,
3151 ls
->spec_string
, ls
->match_type
);
3153 catch (const gdb_exception_error
&except
)
3160 case ADDRESS_LOCATION
:
3162 const char *addr_string
= get_address_string_location (location
);
3163 CORE_ADDR addr
= get_address_location (location
);
3165 if (addr_string
!= NULL
)
3167 addr
= linespec_expression_to_pc (&addr_string
);
3168 if (PARSER_STATE (parser
)->canonical
!= NULL
)
3169 PARSER_STATE (parser
)->canonical
->location
3170 = copy_event_location (location
);
3173 result
= convert_address_location_to_sals (PARSER_STATE (parser
),
3178 case EXPLICIT_LOCATION
:
3180 const struct explicit_location
*explicit_loc
;
3182 explicit_loc
= get_explicit_location_const (location
);
3183 result
= convert_explicit_location_to_sals (PARSER_STATE (parser
),
3184 PARSER_RESULT (parser
),
3189 case PROBE_LOCATION
:
3190 /* Probes are handled by their own decoders. */
3191 gdb_assert_not_reached ("attempt to decode probe location");
3195 gdb_assert_not_reached ("unhandled event location type");
3201 /* See linespec.h. */
3204 decode_line_full (struct event_location
*location
, int flags
,
3205 struct program_space
*search_pspace
,
3206 struct symtab
*default_symtab
,
3207 int default_line
, struct linespec_result
*canonical
,
3208 const char *select_mode
,
3211 std::vector
<const char *> filters
;
3212 struct linespec_state
*state
;
3214 gdb_assert (canonical
!= NULL
);
3215 /* The filter only makes sense for 'all'. */
3216 gdb_assert (filter
== NULL
|| select_mode
== multiple_symbols_all
);
3217 gdb_assert (select_mode
== NULL
3218 || select_mode
== multiple_symbols_all
3219 || select_mode
== multiple_symbols_ask
3220 || select_mode
== multiple_symbols_cancel
);
3221 gdb_assert ((flags
& DECODE_LINE_LIST_MODE
) == 0);
3223 linespec_parser
parser (flags
, current_language
,
3224 search_pspace
, default_symtab
,
3225 default_line
, canonical
);
3227 scoped_restore_current_program_space restore_pspace
;
3229 std::vector
<symtab_and_line
> result
= event_location_to_sals (&parser
,
3231 state
= PARSER_STATE (&parser
);
3233 if (result
.size () == 0)
3234 throw_error (NOT_SUPPORTED_ERROR
, _("Location %s not available"),
3235 event_location_to_string (location
));
3237 gdb_assert (result
.size () == 1 || canonical
->pre_expanded
);
3238 canonical
->pre_expanded
= 1;
3240 /* Arrange for allocated canonical names to be freed. */
3241 std::vector
<gdb::unique_xmalloc_ptr
<char>> hold_names
;
3242 for (int i
= 0; i
< result
.size (); ++i
)
3244 gdb_assert (state
->canonical_names
[i
].suffix
!= NULL
);
3245 hold_names
.emplace_back (state
->canonical_names
[i
].suffix
);
3248 if (select_mode
== NULL
)
3250 if (top_level_interpreter ()->interp_ui_out ()->is_mi_like_p ())
3251 select_mode
= multiple_symbols_all
;
3253 select_mode
= multiple_symbols_select_mode ();
3256 if (select_mode
== multiple_symbols_all
)
3260 filters
.push_back (filter
);
3261 filter_results (state
, &result
, filters
);
3264 convert_results_to_lsals (state
, &result
);
3267 decode_line_2 (state
, &result
, select_mode
);
3270 /* See linespec.h. */
3272 std::vector
<symtab_and_line
>
3273 decode_line_1 (const struct event_location
*location
, int flags
,
3274 struct program_space
*search_pspace
,
3275 struct symtab
*default_symtab
,
3278 linespec_parser
parser (flags
, current_language
,
3279 search_pspace
, default_symtab
,
3280 default_line
, NULL
);
3282 scoped_restore_current_program_space restore_pspace
;
3284 return event_location_to_sals (&parser
, location
);
3287 /* See linespec.h. */
3289 std::vector
<symtab_and_line
>
3290 decode_line_with_current_source (const char *string
, int flags
)
3293 error (_("Empty line specification."));
3295 /* We use whatever is set as the current source line. We do not try
3296 and get a default source symtab+line or it will recursively call us! */
3297 symtab_and_line cursal
= get_current_source_symtab_and_line ();
3299 event_location_up location
= string_to_event_location (&string
,
3301 std::vector
<symtab_and_line
> sals
3302 = decode_line_1 (location
.get (), flags
, NULL
, cursal
.symtab
, cursal
.line
);
3305 error (_("Junk at end of line specification: %s"), string
);
3310 /* See linespec.h. */
3312 std::vector
<symtab_and_line
>
3313 decode_line_with_last_displayed (const char *string
, int flags
)
3316 error (_("Empty line specification."));
3318 event_location_up location
= string_to_event_location (&string
,
3320 std::vector
<symtab_and_line
> sals
3321 = (last_displayed_sal_is_valid ()
3322 ? decode_line_1 (location
.get (), flags
, NULL
,
3323 get_last_displayed_symtab (),
3324 get_last_displayed_line ())
3325 : decode_line_1 (location
.get (), flags
, NULL
, NULL
, 0));
3328 error (_("Junk at end of line specification: %s"), string
);
3335 /* First, some functions to initialize stuff at the beginning of the
3339 initialize_defaults (struct symtab
**default_symtab
, int *default_line
)
3341 if (*default_symtab
== 0)
3343 /* Use whatever we have for the default source line. We don't use
3344 get_current_or_default_symtab_and_line as it can recurse and call
3346 struct symtab_and_line cursal
=
3347 get_current_source_symtab_and_line ();
3349 *default_symtab
= cursal
.symtab
;
3350 *default_line
= cursal
.line
;
3356 /* Evaluate the expression pointed to by EXP_PTR into a CORE_ADDR,
3357 advancing EXP_PTR past any parsed text. */
3360 linespec_expression_to_pc (const char **exp_ptr
)
3362 if (current_program_space
->executing_startup
)
3363 /* The error message doesn't really matter, because this case
3364 should only hit during breakpoint reset. */
3365 throw_error (NOT_FOUND_ERROR
, _("cannot evaluate expressions while "
3366 "program space is in startup"));
3369 return value_as_address (parse_to_comma_and_eval (exp_ptr
));
3374 /* Here's where we recognise an Objective-C Selector. An Objective C
3375 selector may be implemented by more than one class, therefore it
3376 may represent more than one method/function. This gives us a
3377 situation somewhat analogous to C++ overloading. If there's more
3378 than one method that could represent the selector, then use some of
3379 the existing C++ code to let the user choose one. */
3381 static std::vector
<symtab_and_line
>
3382 decode_objc (struct linespec_state
*self
, linespec_p ls
, const char *arg
)
3384 struct collect_info info
;
3385 std::vector
<const char *> symbol_names
;
3386 const char *new_argptr
;
3389 std::vector
<symtab
*> symtabs
;
3390 symtabs
.push_back (nullptr);
3392 info
.file_symtabs
= &symtabs
;
3394 std::vector
<block_symbol
> symbols
;
3395 info
.result
.symbols
= &symbols
;
3396 std::vector
<bound_minimal_symbol
> minimal_symbols
;
3397 info
.result
.minimal_symbols
= &minimal_symbols
;
3399 new_argptr
= find_imps (arg
, &symbol_names
);
3400 if (symbol_names
.empty ())
3403 add_all_symbol_names_from_pspace (&info
, NULL
, symbol_names
,
3406 std::vector
<symtab_and_line
> values
;
3407 if (!symbols
.empty () || !minimal_symbols
.empty ())
3411 saved_arg
= (char *) alloca (new_argptr
- arg
+ 1);
3412 memcpy (saved_arg
, arg
, new_argptr
- arg
);
3413 saved_arg
[new_argptr
- arg
] = '\0';
3415 ls
->explicit_loc
.function_name
= xstrdup (saved_arg
);
3416 ls
->function_symbols
3417 = new std::vector
<block_symbol
> (std::move (symbols
));
3419 = new std::vector
<bound_minimal_symbol
> (std::move (minimal_symbols
));
3420 values
= convert_linespec_to_sals (self
, ls
);
3422 if (self
->canonical
)
3427 self
->canonical
->pre_expanded
= 1;
3429 if (ls
->explicit_loc
.source_filename
)
3431 holder
= string_printf ("%s:%s",
3432 ls
->explicit_loc
.source_filename
,
3434 str
= holder
.c_str ();
3439 self
->canonical
->location
3440 = new_linespec_location (&str
, symbol_name_match_type::FULL
);
3449 /* A function object that serves as symbol_found_callback_ftype
3450 callback for iterate_over_symbols. This is used by
3451 lookup_prefix_sym to collect type symbols. */
3452 class decode_compound_collector
3455 decode_compound_collector ()
3456 : m_unique_syms (htab_create_alloc (1, htab_hash_pointer
,
3457 htab_eq_pointer
, NULL
,
3462 /* Return all symbols collected. */
3463 std::vector
<block_symbol
> release_symbols ()
3465 return std::move (m_symbols
);
3468 /* Callable as a symbol_found_callback_ftype callback. */
3469 bool operator () (block_symbol
*bsym
);
3472 /* A hash table of all symbols we found. We use this to avoid
3473 adding any symbol more than once. */
3474 htab_up m_unique_syms
;
3476 /* The result vector. */
3477 std::vector
<block_symbol
> m_symbols
;
3481 decode_compound_collector::operator () (block_symbol
*bsym
)
3485 struct symbol
*sym
= bsym
->symbol
;
3487 if (SYMBOL_CLASS (sym
) != LOC_TYPEDEF
)
3488 return true; /* Continue iterating. */
3490 t
= SYMBOL_TYPE (sym
);
3491 t
= check_typedef (t
);
3492 if (t
->code () != TYPE_CODE_STRUCT
3493 && t
->code () != TYPE_CODE_UNION
3494 && t
->code () != TYPE_CODE_NAMESPACE
)
3495 return true; /* Continue iterating. */
3497 slot
= htab_find_slot (m_unique_syms
.get (), sym
, INSERT
);
3501 m_symbols
.push_back (*bsym
);
3504 return true; /* Continue iterating. */
3509 /* Return any symbols corresponding to CLASS_NAME in FILE_SYMTABS. */
3511 static std::vector
<block_symbol
>
3512 lookup_prefix_sym (struct linespec_state
*state
,
3513 std::vector
<symtab
*> *file_symtabs
,
3514 const char *class_name
)
3516 decode_compound_collector collector
;
3518 lookup_name_info
lookup_name (class_name
, symbol_name_match_type::FULL
);
3520 for (const auto &elt
: *file_symtabs
)
3524 iterate_over_all_matching_symtabs (state
, lookup_name
,
3525 STRUCT_DOMAIN
, ALL_DOMAIN
,
3526 NULL
, false, collector
);
3527 iterate_over_all_matching_symtabs (state
, lookup_name
,
3528 VAR_DOMAIN
, ALL_DOMAIN
,
3529 NULL
, false, collector
);
3533 /* Program spaces that are executing startup should have
3534 been filtered out earlier. */
3535 gdb_assert (!SYMTAB_PSPACE (elt
)->executing_startup
);
3536 set_current_program_space (SYMTAB_PSPACE (elt
));
3537 iterate_over_file_blocks (elt
, lookup_name
, STRUCT_DOMAIN
, collector
);
3538 iterate_over_file_blocks (elt
, lookup_name
, VAR_DOMAIN
, collector
);
3542 return collector
.release_symbols ();
3545 /* A std::sort comparison function for symbols. The resulting order does
3546 not actually matter; we just need to be able to sort them so that
3547 symbols with the same program space end up next to each other. */
3550 compare_symbols (const block_symbol
&a
, const block_symbol
&b
)
3554 uia
= (uintptr_t) SYMTAB_PSPACE (symbol_symtab (a
.symbol
));
3555 uib
= (uintptr_t) SYMTAB_PSPACE (symbol_symtab (b
.symbol
));
3562 uia
= (uintptr_t) a
.symbol
;
3563 uib
= (uintptr_t) b
.symbol
;
3571 /* Like compare_symbols but for minimal symbols. */
3574 compare_msymbols (const bound_minimal_symbol
&a
, const bound_minimal_symbol
&b
)
3578 uia
= (uintptr_t) a
.objfile
->pspace
;
3579 uib
= (uintptr_t) a
.objfile
->pspace
;
3586 uia
= (uintptr_t) a
.minsym
;
3587 uib
= (uintptr_t) b
.minsym
;
3595 /* Look for all the matching instances of each symbol in NAMES. Only
3596 instances from PSPACE are considered; other program spaces are
3597 handled by our caller. If PSPACE is NULL, then all program spaces
3598 are considered. Results are stored into INFO. */
3601 add_all_symbol_names_from_pspace (struct collect_info
*info
,
3602 struct program_space
*pspace
,
3603 const std::vector
<const char *> &names
,
3604 enum search_domain search_domain
)
3606 for (const char *iter
: names
)
3607 add_matching_symbols_to_info (iter
,
3608 symbol_name_match_type::FULL
,
3609 search_domain
, info
, pspace
);
3613 find_superclass_methods (std::vector
<struct type
*> &&superclasses
,
3614 const char *name
, enum language name_lang
,
3615 std::vector
<const char *> *result_names
)
3617 size_t old_len
= result_names
->size ();
3621 std::vector
<struct type
*> new_supers
;
3623 for (type
*t
: superclasses
)
3624 find_methods (t
, name_lang
, name
, result_names
, &new_supers
);
3626 if (result_names
->size () != old_len
|| new_supers
.empty ())
3629 superclasses
= std::move (new_supers
);
3633 /* This finds the method METHOD_NAME in the class CLASS_NAME whose type is
3634 given by one of the symbols in SYM_CLASSES. Matches are returned
3635 in SYMBOLS (for debug symbols) and MINSYMS (for minimal symbols). */
3638 find_method (struct linespec_state
*self
, std::vector
<symtab
*> *file_symtabs
,
3639 const char *class_name
, const char *method_name
,
3640 std::vector
<block_symbol
> *sym_classes
,
3641 std::vector
<block_symbol
> *symbols
,
3642 std::vector
<bound_minimal_symbol
> *minsyms
)
3644 size_t last_result_len
;
3645 std::vector
<struct type
*> superclass_vec
;
3646 std::vector
<const char *> result_names
;
3647 struct collect_info info
;
3649 /* Sort symbols so that symbols with the same program space are next
3651 std::sort (sym_classes
->begin (), sym_classes
->end (),
3655 info
.file_symtabs
= file_symtabs
;
3656 info
.result
.symbols
= symbols
;
3657 info
.result
.minimal_symbols
= minsyms
;
3659 /* Iterate over all the types, looking for the names of existing
3660 methods matching METHOD_NAME. If we cannot find a direct method in a
3661 given program space, then we consider inherited methods; this is
3662 not ideal (ideal would be to respect C++ hiding rules), but it
3663 seems good enough and is what GDB has historically done. We only
3664 need to collect the names because later we find all symbols with
3665 those names. This loop is written in a somewhat funny way
3666 because we collect data across the program space before deciding
3668 last_result_len
= 0;
3669 for (const auto &elt
: *sym_classes
)
3672 struct program_space
*pspace
;
3673 struct symbol
*sym
= elt
.symbol
;
3674 unsigned int ix
= &elt
- &*sym_classes
->begin ();
3676 /* Program spaces that are executing startup should have
3677 been filtered out earlier. */
3678 pspace
= SYMTAB_PSPACE (symbol_symtab (sym
));
3679 gdb_assert (!pspace
->executing_startup
);
3680 set_current_program_space (pspace
);
3681 t
= check_typedef (SYMBOL_TYPE (sym
));
3682 find_methods (t
, sym
->language (),
3683 method_name
, &result_names
, &superclass_vec
);
3685 /* Handle all items from a single program space at once; and be
3686 sure not to miss the last batch. */
3687 if (ix
== sym_classes
->size () - 1
3689 != SYMTAB_PSPACE (symbol_symtab (sym_classes
->at (ix
+ 1).symbol
))))
3691 /* If we did not find a direct implementation anywhere in
3692 this program space, consider superclasses. */
3693 if (result_names
.size () == last_result_len
)
3694 find_superclass_methods (std::move (superclass_vec
), method_name
,
3695 sym
->language (), &result_names
);
3697 /* We have a list of candidate symbol names, so now we
3698 iterate over the symbol tables looking for all
3699 matches in this pspace. */
3700 add_all_symbol_names_from_pspace (&info
, pspace
, result_names
,
3703 superclass_vec
.clear ();
3704 last_result_len
= result_names
.size ();
3708 if (!symbols
->empty () || !minsyms
->empty ())
3711 /* Throw an NOT_FOUND_ERROR. This will be caught by the caller
3712 and other attempts to locate the symbol will be made. */
3713 throw_error (NOT_FOUND_ERROR
, _("see caller, this text doesn't matter"));
3720 /* This function object is a callback for iterate_over_symtabs, used
3721 when collecting all matching symtabs. */
3723 class symtab_collector
3727 : m_symtab_table (htab_create (1, htab_hash_pointer
, htab_eq_pointer
,
3732 /* Callable as a symbol_found_callback_ftype callback. */
3733 bool operator () (symtab
*sym
);
3735 /* Return an rvalue reference to the collected symtabs. */
3736 std::vector
<symtab
*> &&release_symtabs ()
3738 return std::move (m_symtabs
);
3742 /* The result vector of symtabs. */
3743 std::vector
<symtab
*> m_symtabs
;
3745 /* This is used to ensure the symtabs are unique. */
3746 htab_up m_symtab_table
;
3750 symtab_collector::operator () (struct symtab
*symtab
)
3754 slot
= htab_find_slot (m_symtab_table
.get (), symtab
, INSERT
);
3758 m_symtabs
.push_back (symtab
);
3766 /* Given a file name, return a list of all matching symtabs. If
3767 SEARCH_PSPACE is not NULL, the search is restricted to just that
3770 static std::vector
<symtab
*>
3771 collect_symtabs_from_filename (const char *file
,
3772 struct program_space
*search_pspace
)
3774 symtab_collector collector
;
3776 /* Find that file's data. */
3777 if (search_pspace
== NULL
)
3779 for (struct program_space
*pspace
: program_spaces
)
3781 if (pspace
->executing_startup
)
3784 set_current_program_space (pspace
);
3785 iterate_over_symtabs (file
, collector
);
3790 set_current_program_space (search_pspace
);
3791 iterate_over_symtabs (file
, collector
);
3794 return collector
.release_symtabs ();
3797 /* Return all the symtabs associated to the FILENAME. If SEARCH_PSPACE is
3798 not NULL, the search is restricted to just that program space. */
3800 static std::vector
<symtab
*>
3801 symtabs_from_filename (const char *filename
,
3802 struct program_space
*search_pspace
)
3804 std::vector
<symtab
*> result
3805 = collect_symtabs_from_filename (filename
, search_pspace
);
3807 if (result
.empty ())
3809 if (!have_full_symbols () && !have_partial_symbols ())
3810 throw_error (NOT_FOUND_ERROR
,
3811 _("No symbol table is loaded. "
3812 "Use the \"file\" command."));
3813 source_file_not_found_error (filename
);
3822 symbol_searcher::find_all_symbols (const std::string
&name
,
3823 const struct language_defn
*language
,
3824 enum search_domain search_domain
,
3825 std::vector
<symtab
*> *search_symtabs
,
3826 struct program_space
*search_pspace
)
3828 symbol_searcher_collect_info info
;
3829 struct linespec_state state
;
3831 memset (&state
, 0, sizeof (state
));
3832 state
.language
= language
;
3833 info
.state
= &state
;
3835 info
.result
.symbols
= &m_symbols
;
3836 info
.result
.minimal_symbols
= &m_minimal_symbols
;
3837 std::vector
<symtab
*> all_symtabs
;
3838 if (search_symtabs
== nullptr)
3840 all_symtabs
.push_back (nullptr);
3841 search_symtabs
= &all_symtabs
;
3843 info
.file_symtabs
= search_symtabs
;
3845 add_matching_symbols_to_info (name
.c_str (), symbol_name_match_type::WILD
,
3846 search_domain
, &info
, search_pspace
);
3849 /* Look up a function symbol named NAME in symtabs FILE_SYMTABS. Matching
3850 debug symbols are returned in SYMBOLS. Matching minimal symbols are
3851 returned in MINSYMS. */
3854 find_function_symbols (struct linespec_state
*state
,
3855 std::vector
<symtab
*> *file_symtabs
, const char *name
,
3856 symbol_name_match_type name_match_type
,
3857 std::vector
<block_symbol
> *symbols
,
3858 std::vector
<bound_minimal_symbol
> *minsyms
)
3860 struct collect_info info
;
3861 std::vector
<const char *> symbol_names
;
3864 info
.result
.symbols
= symbols
;
3865 info
.result
.minimal_symbols
= minsyms
;
3866 info
.file_symtabs
= file_symtabs
;
3868 /* Try NAME as an Objective-C selector. */
3869 find_imps (name
, &symbol_names
);
3870 if (!symbol_names
.empty ())
3871 add_all_symbol_names_from_pspace (&info
, state
->search_pspace
,
3872 symbol_names
, FUNCTIONS_DOMAIN
);
3874 add_matching_symbols_to_info (name
, name_match_type
, FUNCTIONS_DOMAIN
,
3875 &info
, state
->search_pspace
);
3878 /* Find all symbols named NAME in FILE_SYMTABS, returning debug symbols
3879 in SYMBOLS and minimal symbols in MINSYMS. */
3882 find_linespec_symbols (struct linespec_state
*state
,
3883 std::vector
<symtab
*> *file_symtabs
,
3884 const char *lookup_name
,
3885 symbol_name_match_type name_match_type
,
3886 std::vector
<block_symbol
> *symbols
,
3887 std::vector
<bound_minimal_symbol
> *minsyms
)
3889 gdb::unique_xmalloc_ptr
<char> canon
3890 = cp_canonicalize_string_no_typedefs (lookup_name
);
3891 if (canon
!= nullptr)
3892 lookup_name
= canon
.get ();
3894 /* It's important to not call expand_symtabs_matching unnecessarily
3895 as it can really slow things down (by unnecessarily expanding
3896 potentially 1000s of symtabs, which when debugging some apps can
3897 cost 100s of seconds). Avoid this to some extent by *first* calling
3898 find_function_symbols, and only if that doesn't find anything
3899 *then* call find_method. This handles two important cases:
3900 1) break (anonymous namespace)::foo
3901 2) break class::method where method is in class (and not a baseclass) */
3903 find_function_symbols (state
, file_symtabs
, lookup_name
,
3904 name_match_type
, symbols
, minsyms
);
3906 /* If we were unable to locate a symbol of the same name, try dividing
3907 the name into class and method names and searching the class and its
3909 if (symbols
->empty () && minsyms
->empty ())
3911 std::string klass
, method
;
3912 const char *last
, *p
, *scope_op
;
3914 /* See if we can find a scope operator and break this symbol
3915 name into namespaces${SCOPE_OPERATOR}class_name and method_name. */
3917 p
= find_toplevel_string (lookup_name
, scope_op
);
3923 p
= find_toplevel_string (p
+ strlen (scope_op
), scope_op
);
3926 /* If no scope operator was found, there is nothing more we can do;
3927 we already attempted to lookup the entire name as a symbol
3932 /* LOOKUP_NAME points to the class name.
3933 LAST points to the method name. */
3934 klass
= std::string (lookup_name
, last
- lookup_name
);
3936 /* Skip past the scope operator. */
3937 last
+= strlen (scope_op
);
3940 /* Find a list of classes named KLASS. */
3941 std::vector
<block_symbol
> classes
3942 = lookup_prefix_sym (state
, file_symtabs
, klass
.c_str ());
3943 if (!classes
.empty ())
3945 /* Now locate a list of suitable methods named METHOD. */
3948 find_method (state
, file_symtabs
,
3949 klass
.c_str (), method
.c_str (),
3950 &classes
, symbols
, minsyms
);
3953 /* If successful, we're done. If NOT_FOUND_ERROR
3954 was not thrown, rethrow the exception that we did get. */
3955 catch (const gdb_exception_error
&except
)
3957 if (except
.error
!= NOT_FOUND_ERROR
)
3964 /* Helper for find_label_symbols. Find all labels that match name
3965 NAME in BLOCK. Return all labels that match in FUNCTION_SYMBOLS.
3966 Return the actual function symbol in which the label was found in
3967 LABEL_FUNC_RET. If COMPLETION_MODE is true, then NAME is
3968 interpreted as a label name prefix. Otherwise, only a label named
3969 exactly NAME match. */
3972 find_label_symbols_in_block (const struct block
*block
,
3973 const char *name
, struct symbol
*fn_sym
,
3974 bool completion_mode
,
3975 std::vector
<block_symbol
> *result
,
3976 std::vector
<block_symbol
> *label_funcs_ret
)
3978 if (completion_mode
)
3980 struct block_iterator iter
;
3982 size_t name_len
= strlen (name
);
3984 int (*cmp
) (const char *, const char *, size_t);
3985 cmp
= case_sensitivity
== case_sensitive_on
? strncmp
: strncasecmp
;
3987 ALL_BLOCK_SYMBOLS (block
, iter
, sym
)
3989 if (symbol_matches_domain (sym
->language (),
3990 SYMBOL_DOMAIN (sym
), LABEL_DOMAIN
)
3991 && cmp (sym
->search_name (), name
, name_len
) == 0)
3993 result
->push_back ({sym
, block
});
3994 label_funcs_ret
->push_back ({fn_sym
, block
});
4000 struct block_symbol label_sym
4001 = lookup_symbol (name
, block
, LABEL_DOMAIN
, 0);
4003 if (label_sym
.symbol
!= NULL
)
4005 result
->push_back (label_sym
);
4006 label_funcs_ret
->push_back ({fn_sym
, block
});
4011 /* Return all labels that match name NAME in FUNCTION_SYMBOLS or NULL
4012 if no matches were found.
4014 Return the actual function symbol in which the label was found in
4015 LABEL_FUNC_RET. If COMPLETION_MODE is true, then NAME is
4016 interpreted as a label name prefix. Otherwise, only labels named
4017 exactly NAME match. */
4020 static std::vector
<block_symbol
> *
4021 find_label_symbols (struct linespec_state
*self
,
4022 std::vector
<block_symbol
> *function_symbols
,
4023 std::vector
<block_symbol
> *label_funcs_ret
,
4025 bool completion_mode
)
4027 const struct block
*block
;
4028 struct symbol
*fn_sym
;
4029 std::vector
<block_symbol
> result
;
4031 if (function_symbols
== NULL
)
4033 set_current_program_space (self
->program_space
);
4034 block
= get_current_search_block ();
4037 block
&& !BLOCK_FUNCTION (block
);
4038 block
= BLOCK_SUPERBLOCK (block
))
4042 fn_sym
= BLOCK_FUNCTION (block
);
4044 find_label_symbols_in_block (block
, name
, fn_sym
, completion_mode
,
4045 &result
, label_funcs_ret
);
4049 for (const auto &elt
: *function_symbols
)
4051 fn_sym
= elt
.symbol
;
4052 set_current_program_space (SYMTAB_PSPACE (symbol_symtab (fn_sym
)));
4053 block
= SYMBOL_BLOCK_VALUE (fn_sym
);
4055 find_label_symbols_in_block (block
, name
, fn_sym
, completion_mode
,
4056 &result
, label_funcs_ret
);
4060 if (!result
.empty ())
4061 return new std::vector
<block_symbol
> (std::move (result
));
4067 /* A helper for create_sals_line_offset that handles the 'list_mode' case. */
4069 static std::vector
<symtab_and_line
>
4070 decode_digits_list_mode (struct linespec_state
*self
,
4072 struct symtab_and_line val
)
4074 gdb_assert (self
->list_mode
);
4076 std::vector
<symtab_and_line
> values
;
4078 for (const auto &elt
: *ls
->file_symtabs
)
4080 /* The logic above should ensure this. */
4081 gdb_assert (elt
!= NULL
);
4083 set_current_program_space (SYMTAB_PSPACE (elt
));
4085 /* Simplistic search just for the list command. */
4086 val
.symtab
= find_line_symtab (elt
, val
.line
, NULL
, NULL
);
4087 if (val
.symtab
== NULL
)
4089 val
.pspace
= SYMTAB_PSPACE (elt
);
4091 val
.explicit_line
= true;
4093 add_sal_to_sals (self
, &values
, &val
, NULL
, 0);
4099 /* A helper for create_sals_line_offset that iterates over the symtabs
4100 associated with LS and returns a vector of corresponding symtab_and_line
4103 static std::vector
<symtab_and_line
>
4104 decode_digits_ordinary (struct linespec_state
*self
,
4107 struct linetable_entry
**best_entry
)
4109 std::vector
<symtab_and_line
> sals
;
4110 for (const auto &elt
: *ls
->file_symtabs
)
4112 std::vector
<CORE_ADDR
> pcs
;
4114 /* The logic above should ensure this. */
4115 gdb_assert (elt
!= NULL
);
4117 set_current_program_space (SYMTAB_PSPACE (elt
));
4119 pcs
= find_pcs_for_symtab_line (elt
, line
, best_entry
);
4120 for (CORE_ADDR pc
: pcs
)
4122 symtab_and_line sal
;
4123 sal
.pspace
= SYMTAB_PSPACE (elt
);
4126 sal
.explicit_line
= true;
4128 sals
.push_back (std::move (sal
));
4137 /* Return the line offset represented by VARIABLE. */
4139 static struct line_offset
4140 linespec_parse_variable (struct linespec_state
*self
, const char *variable
)
4144 struct line_offset offset
= {0, LINE_OFFSET_NONE
};
4146 p
= (variable
[1] == '$') ? variable
+ 2 : variable
+ 1;
4149 while (*p
>= '0' && *p
<= '9')
4151 if (!*p
) /* Reached end of token without hitting non-digit. */
4153 /* We have a value history reference. */
4154 struct value
*val_history
;
4156 sscanf ((variable
[1] == '$') ? variable
+ 2 : variable
+ 1, "%d", &index
);
4158 = access_value_history ((variable
[1] == '$') ? -index
: index
);
4159 if (value_type (val_history
)->code () != TYPE_CODE_INT
)
4160 error (_("History values used in line "
4161 "specs must have integer values."));
4162 offset
.offset
= value_as_long (val_history
);
4166 /* Not all digits -- may be user variable/function or a
4167 convenience variable. */
4169 struct internalvar
*ivar
;
4171 /* Try it as a convenience variable. If it is not a convenience
4172 variable, return and allow normal symbol lookup to occur. */
4173 ivar
= lookup_only_internalvar (variable
+ 1);
4175 /* No internal variable with that name. Mark the offset
4176 as unknown to allow the name to be looked up as a symbol. */
4177 offset
.sign
= LINE_OFFSET_UNKNOWN
;
4180 /* We found a valid variable name. If it is not an integer,
4182 if (!get_internalvar_integer (ivar
, &valx
))
4183 error (_("Convenience variables used in line "
4184 "specs must have integer values."));
4186 offset
.offset
= valx
;
4194 /* We've found a minimal symbol MSYMBOL in OBJFILE to associate with our
4195 linespec; return the SAL in RESULT. This function should return SALs
4196 matching those from find_function_start_sal, otherwise false
4197 multiple-locations breakpoints could be placed. */
4200 minsym_found (struct linespec_state
*self
, struct objfile
*objfile
,
4201 struct minimal_symbol
*msymbol
,
4202 std::vector
<symtab_and_line
> *result
)
4204 bool want_start_sal
;
4206 CORE_ADDR func_addr
;
4207 bool is_function
= msymbol_is_function (objfile
, msymbol
, &func_addr
);
4211 const char *msym_name
= msymbol
->linkage_name ();
4213 if (MSYMBOL_TYPE (msymbol
) == mst_text_gnu_ifunc
4214 || MSYMBOL_TYPE (msymbol
) == mst_data_gnu_ifunc
)
4215 want_start_sal
= gnu_ifunc_resolve_name (msym_name
, &func_addr
);
4217 want_start_sal
= true;
4220 symtab_and_line sal
;
4222 if (is_function
&& want_start_sal
)
4223 sal
= find_function_start_sal (func_addr
, NULL
, self
->funfirstline
);
4226 sal
.objfile
= objfile
;
4227 sal
.msymbol
= msymbol
;
4228 /* Store func_addr, not the minsym's address in case this was an
4229 ifunc that hasn't been resolved yet. */
4233 sal
.pc
= MSYMBOL_VALUE_ADDRESS (objfile
, msymbol
);
4234 sal
.pspace
= current_program_space
;
4237 sal
.section
= MSYMBOL_OBJ_SECTION (objfile
, msymbol
);
4239 if (maybe_add_address (self
->addr_set
, objfile
->pspace
, sal
.pc
))
4240 add_sal_to_sals (self
, result
, &sal
, msymbol
->natural_name (), 0);
4243 /* Helper for search_minsyms_for_name that adds the symbol to the
4247 add_minsym (struct minimal_symbol
*minsym
, struct objfile
*objfile
,
4248 struct symtab
*symtab
, int list_mode
,
4249 std::vector
<struct bound_minimal_symbol
> *msyms
)
4253 /* We're looking for a label for which we don't have debug
4255 CORE_ADDR func_addr
;
4256 if (msymbol_is_function (objfile
, minsym
, &func_addr
))
4258 symtab_and_line sal
= find_pc_sect_line (func_addr
, NULL
, 0);
4260 if (symtab
!= sal
.symtab
)
4265 /* Exclude data symbols when looking for breakpoint locations. */
4266 if (!list_mode
&& !msymbol_is_function (objfile
, minsym
))
4269 struct bound_minimal_symbol mo
= {minsym
, objfile
};
4270 msyms
->push_back (mo
);
4274 /* Search for minimal symbols called NAME. If SEARCH_PSPACE
4275 is not NULL, the search is restricted to just that program
4278 If SYMTAB is NULL, search all objfiles, otherwise
4279 restrict results to the given SYMTAB. */
4282 search_minsyms_for_name (struct collect_info
*info
,
4283 const lookup_name_info
&name
,
4284 struct program_space
*search_pspace
,
4285 struct symtab
*symtab
)
4287 std::vector
<struct bound_minimal_symbol
> minsyms
;
4291 for (struct program_space
*pspace
: program_spaces
)
4293 if (search_pspace
!= NULL
&& search_pspace
!= pspace
)
4295 if (pspace
->executing_startup
)
4298 set_current_program_space (pspace
);
4300 for (objfile
*objfile
: current_program_space
->objfiles ())
4302 iterate_over_minimal_symbols (objfile
, name
,
4303 [&] (struct minimal_symbol
*msym
)
4305 add_minsym (msym
, objfile
, nullptr,
4306 info
->state
->list_mode
,
4315 if (search_pspace
== NULL
|| SYMTAB_PSPACE (symtab
) == search_pspace
)
4317 set_current_program_space (SYMTAB_PSPACE (symtab
));
4318 iterate_over_minimal_symbols
4319 (SYMTAB_OBJFILE (symtab
), name
,
4320 [&] (struct minimal_symbol
*msym
)
4322 add_minsym (msym
, SYMTAB_OBJFILE (symtab
), symtab
,
4323 info
->state
->list_mode
, &minsyms
);
4329 /* Return true if TYPE is a static symbol. */
4330 auto msymbol_type_is_static
= [] (enum minimal_symbol_type type
)
4343 /* Add minsyms to the result set, but filter out trampoline symbols
4344 if we also found extern symbols with the same name. I.e., don't
4345 set a breakpoint on both '<foo@plt>' and 'foo', assuming that
4346 'foo' is the symbol that the plt resolves to. */
4347 for (const bound_minimal_symbol
&item
: minsyms
)
4350 if (MSYMBOL_TYPE (item
.minsym
) == mst_solib_trampoline
)
4352 for (const bound_minimal_symbol
&item2
: minsyms
)
4354 if (&item2
== &item
)
4357 /* Trampoline symbols can only jump to exported
4359 if (msymbol_type_is_static (MSYMBOL_TYPE (item2
.minsym
)))
4362 if (strcmp (item
.minsym
->linkage_name (),
4363 item2
.minsym
->linkage_name ()) != 0)
4366 /* Found a global minsym with the same name as the
4367 trampoline. Don't create a location for this
4375 info
->result
.minimal_symbols
->push_back (item
);
4379 /* A helper function to add all symbols matching NAME to INFO. If
4380 PSPACE is not NULL, the search is restricted to just that program
4384 add_matching_symbols_to_info (const char *name
,
4385 symbol_name_match_type name_match_type
,
4386 enum search_domain search_domain
,
4387 struct collect_info
*info
,
4388 struct program_space
*pspace
)
4390 lookup_name_info
lookup_name (name
, name_match_type
);
4392 for (const auto &elt
: *info
->file_symtabs
)
4396 iterate_over_all_matching_symtabs (info
->state
, lookup_name
,
4397 VAR_DOMAIN
, search_domain
,
4399 [&] (block_symbol
*bsym
)
4400 { return info
->add_symbol (bsym
); });
4401 search_minsyms_for_name (info
, lookup_name
, pspace
, NULL
);
4403 else if (pspace
== NULL
|| pspace
== SYMTAB_PSPACE (elt
))
4405 int prev_len
= info
->result
.symbols
->size ();
4407 /* Program spaces that are executing startup should have
4408 been filtered out earlier. */
4409 gdb_assert (!SYMTAB_PSPACE (elt
)->executing_startup
);
4410 set_current_program_space (SYMTAB_PSPACE (elt
));
4411 iterate_over_file_blocks (elt
, lookup_name
, VAR_DOMAIN
,
4412 [&] (block_symbol
*bsym
)
4413 { return info
->add_symbol (bsym
); });
4415 /* If no new symbols were found in this iteration and this symtab
4416 is in assembler, we might actually be looking for a label for
4417 which we don't have debug info. Check for a minimal symbol in
4419 if (prev_len
== info
->result
.symbols
->size ()
4420 && elt
->language
== language_asm
)
4421 search_minsyms_for_name (info
, lookup_name
, pspace
, elt
);
4428 /* Now come some functions that are called from multiple places within
4432 symbol_to_sal (struct symtab_and_line
*result
,
4433 int funfirstline
, struct symbol
*sym
)
4435 if (SYMBOL_CLASS (sym
) == LOC_BLOCK
)
4437 *result
= find_function_start_sal (sym
, funfirstline
);
4442 if (SYMBOL_CLASS (sym
) == LOC_LABEL
&& SYMBOL_VALUE_ADDRESS (sym
) != 0)
4445 result
->symtab
= symbol_symtab (sym
);
4446 result
->symbol
= sym
;
4447 result
->line
= SYMBOL_LINE (sym
);
4448 result
->pc
= SYMBOL_VALUE_ADDRESS (sym
);
4449 result
->pspace
= SYMTAB_PSPACE (result
->symtab
);
4450 result
->explicit_pc
= 1;
4453 else if (funfirstline
)
4457 else if (SYMBOL_LINE (sym
) != 0)
4459 /* We know its line number. */
4461 result
->symtab
= symbol_symtab (sym
);
4462 result
->symbol
= sym
;
4463 result
->line
= SYMBOL_LINE (sym
);
4464 result
->pc
= SYMBOL_VALUE_ADDRESS (sym
);
4465 result
->pspace
= SYMTAB_PSPACE (result
->symtab
);
4473 linespec_result::~linespec_result ()
4475 for (linespec_sals
&lsal
: lsals
)
4476 xfree (lsal
.canonical
);
4479 /* Return the quote characters permitted by the linespec parser. */
4482 get_gdb_linespec_parser_quote_characters (void)
4484 return linespec_quote_characters
;