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"/"-force-condition").
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", "-force-condition", NULL
};
258 #define IF_KEYWORD_INDEX 0
259 #define FORCE_KEYWORD_INDEX 3
261 /* A token of the linespec lexer */
265 /* The type of the token */
266 linespec_token_type type
;
268 /* Data for the token */
271 /* A string, given as a stoken */
272 struct stoken string
;
278 typedef struct ls_token linespec_token
;
280 #define LS_TOKEN_STOKEN(TOK) (TOK).data.string
281 #define LS_TOKEN_KEYWORD(TOK) (TOK).data.keyword
283 /* An instance of the linespec parser. */
285 struct linespec_parser
287 linespec_parser (int flags
, const struct language_defn
*language
,
288 struct program_space
*search_pspace
,
289 struct symtab
*default_symtab
,
291 struct linespec_result
*canonical
);
295 DISABLE_COPY_AND_ASSIGN (linespec_parser
);
297 /* Lexer internal data */
300 /* Save head of input stream. */
301 const char *saved_arg
;
303 /* Head of the input stream. */
305 #define PARSER_STREAM(P) ((P)->lexer.stream)
307 /* The current token. */
308 linespec_token current
;
311 /* Is the entire linespec quote-enclosed? */
312 int is_quote_enclosed
= 0;
314 /* The state of the parse. */
315 struct linespec_state state
{};
316 #define PARSER_STATE(PPTR) (&(PPTR)->state)
318 /* The result of the parse. */
319 struct linespec result
{};
320 #define PARSER_RESULT(PPTR) (&(PPTR)->result)
322 /* What the parser believes the current word point should complete
324 linespec_complete_what complete_what
= linespec_complete_what::NOTHING
;
326 /* The completion word point. The parser advances this as it skips
327 tokens. At some point the input string will end or parsing will
328 fail, and then we attempt completion at the captured completion
329 word point, interpreting the string at completion_word as
331 const char *completion_word
= nullptr;
333 /* If the current token was a quoted string, then this is the
334 quoting character (either " or '). */
335 int completion_quote_char
= 0;
337 /* If the current token was a quoted string, then this points at the
338 end of the quoted string. */
339 const char *completion_quote_end
= nullptr;
341 /* If parsing for completion, then this points at the completion
342 tracker. Otherwise, this is NULL. */
343 struct completion_tracker
*completion_tracker
= nullptr;
346 /* A convenience macro for accessing the explicit location result of
348 #define PARSER_EXPLICIT(PPTR) (&PARSER_RESULT ((PPTR))->explicit_loc)
350 /* Prototypes for local functions. */
352 static void iterate_over_file_blocks
353 (struct symtab
*symtab
, const lookup_name_info
&name
,
355 gdb::function_view
<symbol_found_callback_ftype
> callback
);
357 static void initialize_defaults (struct symtab
**default_symtab
,
360 CORE_ADDR
linespec_expression_to_pc (const char **exp_ptr
);
362 static std::vector
<symtab_and_line
> decode_objc (struct linespec_state
*self
,
366 static std::vector
<symtab
*> symtabs_from_filename
367 (const char *, struct program_space
*pspace
);
369 static std::vector
<block_symbol
> *find_label_symbols
370 (struct linespec_state
*self
, std::vector
<block_symbol
> *function_symbols
,
371 std::vector
<block_symbol
> *label_funcs_ret
, const char *name
,
372 bool completion_mode
= false);
374 static void find_linespec_symbols (struct linespec_state
*self
,
375 std::vector
<symtab
*> *file_symtabs
,
377 symbol_name_match_type name_match_type
,
378 std::vector
<block_symbol
> *symbols
,
379 std::vector
<bound_minimal_symbol
> *minsyms
);
381 static struct line_offset
382 linespec_parse_variable (struct linespec_state
*self
,
383 const char *variable
);
385 static int symbol_to_sal (struct symtab_and_line
*result
,
386 int funfirstline
, struct symbol
*sym
);
388 static void add_matching_symbols_to_info (const char *name
,
389 symbol_name_match_type name_match_type
,
390 enum search_domain search_domain
,
391 struct collect_info
*info
,
392 struct program_space
*pspace
);
394 static void add_all_symbol_names_from_pspace
395 (struct collect_info
*info
, struct program_space
*pspace
,
396 const std::vector
<const char *> &names
, enum search_domain search_domain
);
398 static std::vector
<symtab
*>
399 collect_symtabs_from_filename (const char *file
,
400 struct program_space
*pspace
);
402 static std::vector
<symtab_and_line
> decode_digits_ordinary
403 (struct linespec_state
*self
,
406 linetable_entry
**best_entry
);
408 static std::vector
<symtab_and_line
> decode_digits_list_mode
409 (struct linespec_state
*self
,
411 struct symtab_and_line val
);
413 static void minsym_found (struct linespec_state
*self
, struct objfile
*objfile
,
414 struct minimal_symbol
*msymbol
,
415 std::vector
<symtab_and_line
> *result
);
417 static bool compare_symbols (const block_symbol
&a
, const block_symbol
&b
);
419 static bool compare_msymbols (const bound_minimal_symbol
&a
,
420 const bound_minimal_symbol
&b
);
422 /* Permitted quote characters for the parser. This is different from the
423 completer's quote characters to allow backward compatibility with the
425 static const char linespec_quote_characters
[] = "\"\'";
427 /* Lexer functions. */
429 /* Lex a number from the input in PARSER. This only supports
432 Return true if input is decimal numbers. Return false if not. */
435 linespec_lexer_lex_number (linespec_parser
*parser
, linespec_token
*tokenp
)
437 tokenp
->type
= LSTOKEN_NUMBER
;
438 LS_TOKEN_STOKEN (*tokenp
).length
= 0;
439 LS_TOKEN_STOKEN (*tokenp
).ptr
= PARSER_STREAM (parser
);
441 /* Keep any sign at the start of the stream. */
442 if (*PARSER_STREAM (parser
) == '+' || *PARSER_STREAM (parser
) == '-')
444 ++LS_TOKEN_STOKEN (*tokenp
).length
;
445 ++(PARSER_STREAM (parser
));
448 while (isdigit (*PARSER_STREAM (parser
)))
450 ++LS_TOKEN_STOKEN (*tokenp
).length
;
451 ++(PARSER_STREAM (parser
));
454 /* If the next character in the input buffer is not a space, comma,
455 quote, or colon, this input does not represent a number. */
456 if (*PARSER_STREAM (parser
) != '\0'
457 && !isspace (*PARSER_STREAM (parser
)) && *PARSER_STREAM (parser
) != ','
458 && *PARSER_STREAM (parser
) != ':'
459 && !strchr (linespec_quote_characters
, *PARSER_STREAM (parser
)))
461 PARSER_STREAM (parser
) = LS_TOKEN_STOKEN (*tokenp
).ptr
;
468 /* See linespec.h. */
471 linespec_lexer_lex_keyword (const char *p
)
477 for (i
= 0; linespec_keywords
[i
] != NULL
; ++i
)
479 int len
= strlen (linespec_keywords
[i
]);
481 /* If P begins with one of the keywords and the next
482 character is whitespace, we may have found a keyword.
483 It is only a keyword if it is not followed by another
485 if (strncmp (p
, linespec_keywords
[i
], len
) == 0
490 /* Special case: "-force" is always followed by an "if". */
491 if (i
== FORCE_KEYWORD_INDEX
)
495 int nextlen
= strlen (linespec_keywords
[IF_KEYWORD_INDEX
]);
496 if (!(strncmp (p
, linespec_keywords
[IF_KEYWORD_INDEX
], nextlen
) == 0
497 && isspace (p
[nextlen
])))
501 /* Special case: "if" ALWAYS stops the lexer, since it
502 is not possible to predict what is going to appear in
503 the condition, which can only be parsed after SaLs have
505 else if (i
!= IF_KEYWORD_INDEX
)
509 for (j
= 0; linespec_keywords
[j
] != NULL
; ++j
)
511 int nextlen
= strlen (linespec_keywords
[j
]);
513 if (strncmp (p
, linespec_keywords
[j
], nextlen
) == 0
514 && isspace (p
[nextlen
]))
519 return linespec_keywords
[i
];
527 /* See description in linespec.h. */
530 is_ada_operator (const char *string
)
532 const struct ada_opname_map
*mapping
;
534 for (mapping
= ada_opname_table
;
535 mapping
->encoded
!= NULL
536 && !startswith (string
, mapping
->decoded
); ++mapping
)
539 return mapping
->decoded
== NULL
? 0 : strlen (mapping
->decoded
);
542 /* Find QUOTE_CHAR in STRING, accounting for the ':' terminal. Return
543 the location of QUOTE_CHAR, or NULL if not found. */
546 skip_quote_char (const char *string
, char quote_char
)
548 const char *p
, *last
;
550 p
= last
= find_toplevel_char (string
, quote_char
);
551 while (p
&& *p
!= '\0' && *p
!= ':')
553 p
= find_toplevel_char (p
, quote_char
);
561 /* Make a writable copy of the string given in TOKEN, trimming
562 any trailing whitespace. */
564 static gdb::unique_xmalloc_ptr
<char>
565 copy_token_string (linespec_token token
)
569 if (token
.type
== LSTOKEN_KEYWORD
)
570 return make_unique_xstrdup (LS_TOKEN_KEYWORD (token
));
572 str
= LS_TOKEN_STOKEN (token
).ptr
;
573 s
= remove_trailing_whitespace (str
, str
+ LS_TOKEN_STOKEN (token
).length
);
575 return gdb::unique_xmalloc_ptr
<char> (savestring (str
, s
- str
));
578 /* Does P represent the end of a quote-enclosed linespec? */
581 is_closing_quote_enclosed (const char *p
)
583 if (strchr (linespec_quote_characters
, *p
))
585 p
= skip_spaces ((char *) p
);
586 return (*p
== '\0' || linespec_lexer_lex_keyword (p
));
589 /* Find the end of the parameter list that starts with *INPUT.
590 This helper function assists with lexing string segments
591 which might contain valid (non-terminating) commas. */
594 find_parameter_list_end (const char *input
)
596 char end_char
, start_char
;
601 if (start_char
== '(')
603 else if (start_char
== '<')
612 if (*p
== start_char
)
614 else if (*p
== end_char
)
628 /* If the [STRING, STRING_LEN) string ends with what looks like a
629 keyword, return the keyword start offset in STRING. Return -1
633 string_find_incomplete_keyword_at_end (const char * const *keywords
,
634 const char *string
, size_t string_len
)
636 const char *end
= string
+ string_len
;
639 while (p
> string
&& *p
!= ' ')
644 size_t len
= end
- p
;
645 for (size_t i
= 0; keywords
[i
] != NULL
; ++i
)
646 if (strncmp (keywords
[i
], p
, len
) == 0)
653 /* Lex a string from the input in PARSER. */
655 static linespec_token
656 linespec_lexer_lex_string (linespec_parser
*parser
)
658 linespec_token token
;
659 const char *start
= PARSER_STREAM (parser
);
661 token
.type
= LSTOKEN_STRING
;
663 /* If the input stream starts with a quote character, skip to the next
664 quote character, regardless of the content. */
665 if (strchr (linespec_quote_characters
, *PARSER_STREAM (parser
)))
668 char quote_char
= *PARSER_STREAM (parser
);
670 /* Special case: Ada operators. */
671 if (PARSER_STATE (parser
)->language
->la_language
== language_ada
672 && quote_char
== '\"')
674 int len
= is_ada_operator (PARSER_STREAM (parser
));
678 /* The input is an Ada operator. Return the quoted string
680 LS_TOKEN_STOKEN (token
).ptr
= PARSER_STREAM (parser
);
681 LS_TOKEN_STOKEN (token
).length
= len
;
682 PARSER_STREAM (parser
) += len
;
686 /* The input does not represent an Ada operator -- fall through
687 to normal quoted string handling. */
690 /* Skip past the beginning quote. */
691 ++(PARSER_STREAM (parser
));
693 /* Mark the start of the string. */
694 LS_TOKEN_STOKEN (token
).ptr
= PARSER_STREAM (parser
);
696 /* Skip to the ending quote. */
697 end
= skip_quote_char (PARSER_STREAM (parser
), quote_char
);
699 /* This helps the completer mode decide whether we have a
701 parser
->completion_quote_char
= quote_char
;
702 parser
->completion_quote_end
= end
;
704 /* Error if the input did not terminate properly, unless in
708 if (parser
->completion_tracker
== NULL
)
709 error (_("unmatched quote"));
711 /* In completion mode, we'll try to complete the incomplete
713 token
.type
= LSTOKEN_STRING
;
714 while (*PARSER_STREAM (parser
) != '\0')
715 PARSER_STREAM (parser
)++;
716 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - 1 - start
;
720 /* Skip over the ending quote and mark the length of the string. */
721 PARSER_STREAM (parser
) = (char *) ++end
;
722 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - 2 - start
;
729 /* Otherwise, only identifier characters are permitted.
730 Spaces are the exception. In general, we keep spaces,
731 but only if the next characters in the input do not resolve
732 to one of the keywords.
734 This allows users to forgo quoting CV-qualifiers, template arguments,
735 and similar common language constructs. */
739 if (isspace (*PARSER_STREAM (parser
)))
741 p
= skip_spaces (PARSER_STREAM (parser
));
742 /* When we get here we know we've found something followed by
743 a space (we skip over parens and templates below).
744 So if we find a keyword now, we know it is a keyword and not,
745 say, a function name. */
746 if (linespec_lexer_lex_keyword (p
) != NULL
)
748 LS_TOKEN_STOKEN (token
).ptr
= start
;
749 LS_TOKEN_STOKEN (token
).length
750 = PARSER_STREAM (parser
) - start
;
754 /* Advance past the whitespace. */
755 PARSER_STREAM (parser
) = p
;
758 /* If the next character is EOI or (single) ':', the
759 string is complete; return the token. */
760 if (*PARSER_STREAM (parser
) == 0)
762 LS_TOKEN_STOKEN (token
).ptr
= start
;
763 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - start
;
766 else if (PARSER_STREAM (parser
)[0] == ':')
768 /* Do not tokenize the C++ scope operator. */
769 if (PARSER_STREAM (parser
)[1] == ':')
770 ++(PARSER_STREAM (parser
));
772 /* Do not tokenize ABI tags such as "[abi:cxx11]". */
773 else if (PARSER_STREAM (parser
) - start
> 4
774 && startswith (PARSER_STREAM (parser
) - 4, "[abi"))
779 /* Do not tokenify if the input length so far is one
780 (i.e, a single-letter drive name) and the next character
781 is a directory separator. This allows Windows-style
782 paths to be recognized as filenames without quoting it. */
783 else if ((PARSER_STREAM (parser
) - start
) != 1
784 || !IS_DIR_SEPARATOR (PARSER_STREAM (parser
)[1]))
786 LS_TOKEN_STOKEN (token
).ptr
= start
;
787 LS_TOKEN_STOKEN (token
).length
788 = PARSER_STREAM (parser
) - start
;
792 /* Special case: permit quote-enclosed linespecs. */
793 else if (parser
->is_quote_enclosed
794 && strchr (linespec_quote_characters
,
795 *PARSER_STREAM (parser
))
796 && is_closing_quote_enclosed (PARSER_STREAM (parser
)))
798 LS_TOKEN_STOKEN (token
).ptr
= start
;
799 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - start
;
802 /* Because commas may terminate a linespec and appear in
803 the middle of valid string input, special cases for
804 '<' and '(' are necessary. */
805 else if (*PARSER_STREAM (parser
) == '<'
806 || *PARSER_STREAM (parser
) == '(')
808 /* Don't interpret 'operator<' / 'operator<<' as a
809 template parameter list though. */
810 if (*PARSER_STREAM (parser
) == '<'
811 && (PARSER_STATE (parser
)->language
->la_language
813 && (PARSER_STREAM (parser
) - start
) >= CP_OPERATOR_LEN
)
815 const char *op
= PARSER_STREAM (parser
);
817 while (op
> start
&& isspace (op
[-1]))
819 if (op
- start
>= CP_OPERATOR_LEN
)
821 op
-= CP_OPERATOR_LEN
;
822 if (strncmp (op
, CP_OPERATOR_STR
, CP_OPERATOR_LEN
) == 0
824 || !(isalnum (op
[-1]) || op
[-1] == '_')))
826 /* This is an operator name. Keep going. */
827 ++(PARSER_STREAM (parser
));
828 if (*PARSER_STREAM (parser
) == '<')
829 ++(PARSER_STREAM (parser
));
835 const char *end
= find_parameter_list_end (PARSER_STREAM (parser
));
836 PARSER_STREAM (parser
) = end
;
838 /* Don't loop around to the normal \0 case above because
839 we don't want to misinterpret a potential keyword at
840 the end of the token when the string isn't
841 "()<>"-balanced. This handles "b
842 function(thread<tab>" in completion mode. */
845 LS_TOKEN_STOKEN (token
).ptr
= start
;
846 LS_TOKEN_STOKEN (token
).length
847 = PARSER_STREAM (parser
) - start
;
853 /* Commas are terminators, but not if they are part of an
855 else if (*PARSER_STREAM (parser
) == ',')
857 if ((PARSER_STATE (parser
)->language
->la_language
859 && (PARSER_STREAM (parser
) - start
) > CP_OPERATOR_LEN
)
861 const char *op
= strstr (start
, CP_OPERATOR_STR
);
863 if (op
!= NULL
&& is_operator_name (op
))
865 /* This is an operator name. Keep going. */
866 ++(PARSER_STREAM (parser
));
871 /* Comma terminates the string. */
872 LS_TOKEN_STOKEN (token
).ptr
= start
;
873 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - start
;
877 /* Advance the stream. */
878 gdb_assert (*(PARSER_STREAM (parser
)) != '\0');
879 ++(PARSER_STREAM (parser
));
886 /* Lex a single linespec token from PARSER. */
888 static linespec_token
889 linespec_lexer_lex_one (linespec_parser
*parser
)
893 if (parser
->lexer
.current
.type
== LSTOKEN_CONSUMED
)
895 /* Skip any whitespace. */
896 PARSER_STREAM (parser
) = skip_spaces (PARSER_STREAM (parser
));
898 /* Check for a keyword, they end the linespec. */
899 keyword
= linespec_lexer_lex_keyword (PARSER_STREAM (parser
));
902 parser
->lexer
.current
.type
= LSTOKEN_KEYWORD
;
903 LS_TOKEN_KEYWORD (parser
->lexer
.current
) = keyword
;
904 /* We do not advance the stream here intentionally:
905 we would like lexing to stop when a keyword is seen.
907 PARSER_STREAM (parser) += strlen (keyword); */
909 return parser
->lexer
.current
;
912 /* Handle other tokens. */
913 switch (*PARSER_STREAM (parser
))
916 parser
->lexer
.current
.type
= LSTOKEN_EOI
;
920 case '0': case '1': case '2': case '3': case '4':
921 case '5': case '6': case '7': case '8': case '9':
922 if (!linespec_lexer_lex_number (parser
, &(parser
->lexer
.current
)))
923 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
927 /* If we have a scope operator, lex the input as a string.
928 Otherwise, return LSTOKEN_COLON. */
929 if (PARSER_STREAM (parser
)[1] == ':')
930 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
933 parser
->lexer
.current
.type
= LSTOKEN_COLON
;
934 ++(PARSER_STREAM (parser
));
938 case '\'': case '\"':
939 /* Special case: permit quote-enclosed linespecs. */
940 if (parser
->is_quote_enclosed
941 && is_closing_quote_enclosed (PARSER_STREAM (parser
)))
943 ++(PARSER_STREAM (parser
));
944 parser
->lexer
.current
.type
= LSTOKEN_EOI
;
947 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
951 parser
->lexer
.current
.type
= LSTOKEN_COMMA
;
952 LS_TOKEN_STOKEN (parser
->lexer
.current
).ptr
953 = PARSER_STREAM (parser
);
954 LS_TOKEN_STOKEN (parser
->lexer
.current
).length
= 1;
955 ++(PARSER_STREAM (parser
));
959 /* If the input is not a number, it must be a string.
960 [Keywords were already considered above.] */
961 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
966 return parser
->lexer
.current
;
969 /* Consume the current token and return the next token in PARSER's
970 input stream. Also advance the completion word for completion
973 static linespec_token
974 linespec_lexer_consume_token (linespec_parser
*parser
)
976 gdb_assert (parser
->lexer
.current
.type
!= LSTOKEN_EOI
);
978 bool advance_word
= (parser
->lexer
.current
.type
!= LSTOKEN_STRING
979 || *PARSER_STREAM (parser
) != '\0');
981 /* If we're moving past a string to some other token, it must be the
982 quote was terminated. */
983 if (parser
->completion_quote_char
)
985 gdb_assert (parser
->lexer
.current
.type
== LSTOKEN_STRING
);
987 /* If the string was the last (non-EOI) token, we're past the
988 quote, but remember that for later. */
989 if (*PARSER_STREAM (parser
) != '\0')
991 parser
->completion_quote_char
= '\0';
992 parser
->completion_quote_end
= NULL
;;
996 parser
->lexer
.current
.type
= LSTOKEN_CONSUMED
;
997 linespec_lexer_lex_one (parser
);
999 if (parser
->lexer
.current
.type
== LSTOKEN_STRING
)
1001 /* Advance the completion word past a potential initial
1003 parser
->completion_word
= LS_TOKEN_STOKEN (parser
->lexer
.current
).ptr
;
1005 else if (advance_word
)
1007 /* Advance the completion word past any whitespace. */
1008 parser
->completion_word
= PARSER_STREAM (parser
);
1011 return parser
->lexer
.current
;
1014 /* Return the next token without consuming the current token. */
1016 static linespec_token
1017 linespec_lexer_peek_token (linespec_parser
*parser
)
1019 linespec_token next
;
1020 const char *saved_stream
= PARSER_STREAM (parser
);
1021 linespec_token saved_token
= parser
->lexer
.current
;
1022 int saved_completion_quote_char
= parser
->completion_quote_char
;
1023 const char *saved_completion_quote_end
= parser
->completion_quote_end
;
1024 const char *saved_completion_word
= parser
->completion_word
;
1026 next
= linespec_lexer_consume_token (parser
);
1027 PARSER_STREAM (parser
) = saved_stream
;
1028 parser
->lexer
.current
= saved_token
;
1029 parser
->completion_quote_char
= saved_completion_quote_char
;
1030 parser
->completion_quote_end
= saved_completion_quote_end
;
1031 parser
->completion_word
= saved_completion_word
;
1035 /* Helper functions. */
1037 /* Add SAL to SALS, and also update SELF->CANONICAL_NAMES to reflect
1038 the new sal, if needed. If not NULL, SYMNAME is the name of the
1039 symbol to use when constructing the new canonical name.
1041 If LITERAL_CANONICAL is non-zero, SYMNAME will be used as the
1042 canonical name for the SAL. */
1045 add_sal_to_sals (struct linespec_state
*self
,
1046 std::vector
<symtab_and_line
> *sals
,
1047 struct symtab_and_line
*sal
,
1048 const char *symname
, int literal_canonical
)
1050 sals
->push_back (*sal
);
1052 if (self
->canonical
)
1054 struct linespec_canonical_name
*canonical
;
1056 self
->canonical_names
= XRESIZEVEC (struct linespec_canonical_name
,
1057 self
->canonical_names
,
1059 canonical
= &self
->canonical_names
[sals
->size () - 1];
1060 if (!literal_canonical
&& sal
->symtab
)
1062 symtab_to_fullname (sal
->symtab
);
1064 /* Note that the filter doesn't have to be a valid linespec
1065 input. We only apply the ":LINE" treatment to Ada for
1067 if (symname
!= NULL
&& sal
->line
!= 0
1068 && self
->language
->la_language
== language_ada
)
1069 canonical
->suffix
= xstrprintf ("%s:%d", symname
, sal
->line
);
1070 else if (symname
!= NULL
)
1071 canonical
->suffix
= xstrdup (symname
);
1073 canonical
->suffix
= xstrprintf ("%d", sal
->line
);
1074 canonical
->symtab
= sal
->symtab
;
1078 if (symname
!= NULL
)
1079 canonical
->suffix
= xstrdup (symname
);
1081 canonical
->suffix
= xstrdup ("<unknown>");
1082 canonical
->symtab
= NULL
;
1087 /* A hash function for address_entry. */
1090 hash_address_entry (const void *p
)
1092 const struct address_entry
*aep
= (const struct address_entry
*) p
;
1095 hash
= iterative_hash_object (aep
->pspace
, 0);
1096 return iterative_hash_object (aep
->addr
, hash
);
1099 /* An equality function for address_entry. */
1102 eq_address_entry (const void *a
, const void *b
)
1104 const struct address_entry
*aea
= (const struct address_entry
*) a
;
1105 const struct address_entry
*aeb
= (const struct address_entry
*) b
;
1107 return aea
->pspace
== aeb
->pspace
&& aea
->addr
== aeb
->addr
;
1110 /* Check whether the address, represented by PSPACE and ADDR, is
1111 already in the set. If so, return 0. Otherwise, add it and return
1115 maybe_add_address (htab_t set
, struct program_space
*pspace
, CORE_ADDR addr
)
1117 struct address_entry e
, *p
;
1122 slot
= htab_find_slot (set
, &e
, INSERT
);
1126 p
= XNEW (struct address_entry
);
1127 memcpy (p
, &e
, sizeof (struct address_entry
));
1133 /* A helper that walks over all matching symtabs in all objfiles and
1134 calls CALLBACK for each symbol matching NAME. If SEARCH_PSPACE is
1135 not NULL, then the search is restricted to just that program
1136 space. If INCLUDE_INLINE is true then symbols representing
1137 inlined instances of functions will be included in the result. */
1140 iterate_over_all_matching_symtabs
1141 (struct linespec_state
*state
,
1142 const lookup_name_info
&lookup_name
,
1143 const domain_enum name_domain
,
1144 enum search_domain search_domain
,
1145 struct program_space
*search_pspace
, bool include_inline
,
1146 gdb::function_view
<symbol_found_callback_ftype
> callback
)
1148 for (struct program_space
*pspace
: program_spaces
)
1150 if (search_pspace
!= NULL
&& search_pspace
!= pspace
)
1152 if (pspace
->executing_startup
)
1155 set_current_program_space (pspace
);
1157 for (objfile
*objfile
: current_program_space
->objfiles ())
1160 objfile
->sf
->qf
->expand_symtabs_matching (objfile
,
1166 for (compunit_symtab
*cu
: objfile
->compunits ())
1168 struct symtab
*symtab
= COMPUNIT_FILETABS (cu
);
1170 iterate_over_file_blocks (symtab
, lookup_name
, name_domain
,
1175 const struct block
*block
;
1178 for (i
= FIRST_LOCAL_BLOCK
;
1179 i
< BLOCKVECTOR_NBLOCKS (SYMTAB_BLOCKVECTOR (symtab
));
1182 block
= BLOCKVECTOR_BLOCK (SYMTAB_BLOCKVECTOR (symtab
), i
);
1183 state
->language
->iterate_over_symbols
1184 (block
, lookup_name
, name_domain
,
1185 [&] (block_symbol
*bsym
)
1187 /* Restrict calls to CALLBACK to symbols
1188 representing inline symbols only. */
1189 if (SYMBOL_INLINED (bsym
->symbol
))
1190 return callback (bsym
);
1200 /* Returns the block to be used for symbol searches from
1201 the current location. */
1203 static const struct block
*
1204 get_current_search_block (void)
1206 /* get_selected_block can change the current language when there is
1207 no selected frame yet. */
1208 scoped_restore_current_language save_language
;
1209 return get_selected_block (0);
1212 /* Iterate over static and global blocks. */
1215 iterate_over_file_blocks
1216 (struct symtab
*symtab
, const lookup_name_info
&name
,
1217 domain_enum domain
, gdb::function_view
<symbol_found_callback_ftype
> callback
)
1219 const struct block
*block
;
1221 for (block
= BLOCKVECTOR_BLOCK (SYMTAB_BLOCKVECTOR (symtab
), STATIC_BLOCK
);
1223 block
= BLOCK_SUPERBLOCK (block
))
1224 current_language
->iterate_over_symbols (block
, name
, domain
, callback
);
1227 /* A helper for find_method. This finds all methods in type T of
1228 language T_LANG which match NAME. It adds matching symbol names to
1229 RESULT_NAMES, and adds T's direct superclasses to SUPERCLASSES. */
1232 find_methods (struct type
*t
, enum language t_lang
, const char *name
,
1233 std::vector
<const char *> *result_names
,
1234 std::vector
<struct type
*> *superclasses
)
1237 const char *class_name
= t
->name ();
1239 /* Ignore this class if it doesn't have a name. This is ugly, but
1240 unless we figure out how to get the physname without the name of
1241 the class, then the loop can't do any good. */
1245 lookup_name_info
lookup_name (name
, symbol_name_match_type::FULL
);
1246 symbol_name_matcher_ftype
*symbol_name_compare
1247 = language_def (t_lang
)->get_symbol_name_matcher (lookup_name
);
1249 t
= check_typedef (t
);
1251 /* Loop over each method name. At this level, all overloads of a name
1252 are counted as a single name. There is an inner loop which loops over
1255 for (method_counter
= TYPE_NFN_FIELDS (t
) - 1;
1256 method_counter
>= 0;
1259 const char *method_name
= TYPE_FN_FIELDLIST_NAME (t
, method_counter
);
1261 if (symbol_name_compare (method_name
, lookup_name
, NULL
))
1265 for (field_counter
= (TYPE_FN_FIELDLIST_LENGTH (t
, method_counter
)
1271 const char *phys_name
;
1273 f
= TYPE_FN_FIELDLIST1 (t
, method_counter
);
1274 if (TYPE_FN_FIELD_STUB (f
, field_counter
))
1276 phys_name
= TYPE_FN_FIELD_PHYSNAME (f
, field_counter
);
1277 result_names
->push_back (phys_name
);
1283 for (ibase
= 0; ibase
< TYPE_N_BASECLASSES (t
); ibase
++)
1284 superclasses
->push_back (TYPE_BASECLASS (t
, ibase
));
1287 /* Find an instance of the character C in the string S that is outside
1288 of all parenthesis pairs, single-quoted strings, and double-quoted
1289 strings. Also, ignore the char within a template name, like a ','
1290 within foo<int, int>, while considering C++ operator</operator<<. */
1293 find_toplevel_char (const char *s
, char c
)
1295 int quoted
= 0; /* zero if we're not in quotes;
1296 '"' if we're in a double-quoted string;
1297 '\'' if we're in a single-quoted string. */
1298 int depth
= 0; /* Number of unclosed parens we've seen. */
1301 for (scan
= s
; *scan
; scan
++)
1305 if (*scan
== quoted
)
1307 else if (*scan
== '\\' && *(scan
+ 1))
1310 else if (*scan
== c
&& ! quoted
&& depth
== 0)
1312 else if (*scan
== '"' || *scan
== '\'')
1314 else if (*scan
== '(' || *scan
== '<')
1316 else if ((*scan
== ')' || *scan
== '>') && depth
> 0)
1318 else if (*scan
== 'o' && !quoted
&& depth
== 0)
1320 /* Handle C++ operator names. */
1321 if (strncmp (scan
, CP_OPERATOR_STR
, CP_OPERATOR_LEN
) == 0)
1323 scan
+= CP_OPERATOR_LEN
;
1326 while (isspace (*scan
))
1337 /* Skip over one less than the appropriate number of
1338 characters: the for loop will skip over the last
1364 /* The string equivalent of find_toplevel_char. Returns a pointer
1365 to the location of NEEDLE in HAYSTACK, ignoring any occurrences
1366 inside "()" and "<>". Returns NULL if NEEDLE was not found. */
1369 find_toplevel_string (const char *haystack
, const char *needle
)
1371 const char *s
= haystack
;
1375 s
= find_toplevel_char (s
, *needle
);
1379 /* Found first char in HAYSTACK; check rest of string. */
1380 if (startswith (s
, needle
))
1383 /* Didn't find it; loop over HAYSTACK, looking for the next
1384 instance of the first character of NEEDLE. */
1388 while (s
!= NULL
&& *s
!= '\0');
1390 /* NEEDLE was not found in HAYSTACK. */
1394 /* Convert CANONICAL to its string representation using
1395 symtab_to_fullname for SYMTAB. */
1398 canonical_to_fullform (const struct linespec_canonical_name
*canonical
)
1400 if (canonical
->symtab
== NULL
)
1401 return canonical
->suffix
;
1403 return string_printf ("%s:%s", symtab_to_fullname (canonical
->symtab
),
1407 /* Given FILTERS, a list of canonical names, filter the sals in RESULT
1408 and store the result in SELF->CANONICAL. */
1411 filter_results (struct linespec_state
*self
,
1412 std::vector
<symtab_and_line
> *result
,
1413 const std::vector
<const char *> &filters
)
1415 for (const char *name
: filters
)
1419 for (size_t j
= 0; j
< result
->size (); ++j
)
1421 const struct linespec_canonical_name
*canonical
;
1423 canonical
= &self
->canonical_names
[j
];
1424 std::string fullform
= canonical_to_fullform (canonical
);
1426 if (name
== fullform
)
1427 lsal
.sals
.push_back ((*result
)[j
]);
1430 if (!lsal
.sals
.empty ())
1432 lsal
.canonical
= xstrdup (name
);
1433 self
->canonical
->lsals
.push_back (std::move (lsal
));
1437 self
->canonical
->pre_expanded
= 0;
1440 /* Store RESULT into SELF->CANONICAL. */
1443 convert_results_to_lsals (struct linespec_state
*self
,
1444 std::vector
<symtab_and_line
> *result
)
1446 struct linespec_sals lsal
;
1448 lsal
.canonical
= NULL
;
1449 lsal
.sals
= std::move (*result
);
1450 self
->canonical
->lsals
.push_back (std::move (lsal
));
1453 /* A structure that contains two string representations of a struct
1454 linespec_canonical_name:
1455 - one where the symtab's fullname is used;
1456 - one where the filename followed the "set filename-display"
1459 struct decode_line_2_item
1461 decode_line_2_item (std::string
&&fullform_
, std::string
&&displayform_
,
1463 : fullform (std::move (fullform_
)),
1464 displayform (std::move (displayform_
)),
1465 selected (selected_
)
1469 /* The form using symtab_to_fullname. */
1470 std::string fullform
;
1472 /* The form using symtab_to_filename_for_display. */
1473 std::string displayform
;
1475 /* Field is initialized to zero and it is set to one if the user
1476 requested breakpoint for this entry. */
1477 unsigned int selected
: 1;
1480 /* Helper for std::sort to sort decode_line_2_item entries by
1481 DISPLAYFORM and secondarily by FULLFORM. */
1484 decode_line_2_compare_items (const decode_line_2_item
&a
,
1485 const decode_line_2_item
&b
)
1487 if (a
.displayform
!= b
.displayform
)
1488 return a
.displayform
< b
.displayform
;
1489 return a
.fullform
< b
.fullform
;
1492 /* Handle multiple results in RESULT depending on SELECT_MODE. This
1493 will either return normally, throw an exception on multiple
1494 results, or present a menu to the user. On return, the SALS vector
1495 in SELF->CANONICAL is set up properly. */
1498 decode_line_2 (struct linespec_state
*self
,
1499 std::vector
<symtab_and_line
> *result
,
1500 const char *select_mode
)
1505 std::vector
<const char *> filters
;
1506 std::vector
<struct decode_line_2_item
> items
;
1508 gdb_assert (select_mode
!= multiple_symbols_all
);
1509 gdb_assert (self
->canonical
!= NULL
);
1510 gdb_assert (!result
->empty ());
1512 /* Prepare ITEMS array. */
1513 for (i
= 0; i
< result
->size (); ++i
)
1515 const struct linespec_canonical_name
*canonical
;
1516 std::string displayform
;
1518 canonical
= &self
->canonical_names
[i
];
1519 gdb_assert (canonical
->suffix
!= NULL
);
1521 std::string fullform
= canonical_to_fullform (canonical
);
1523 if (canonical
->symtab
== NULL
)
1524 displayform
= canonical
->suffix
;
1527 const char *fn_for_display
;
1529 fn_for_display
= symtab_to_filename_for_display (canonical
->symtab
);
1530 displayform
= string_printf ("%s:%s", fn_for_display
,
1534 items
.emplace_back (std::move (fullform
), std::move (displayform
),
1538 /* Sort the list of method names. */
1539 std::sort (items
.begin (), items
.end (), decode_line_2_compare_items
);
1541 /* Remove entries with the same FULLFORM. */
1542 items
.erase (std::unique (items
.begin (), items
.end (),
1543 [] (const struct decode_line_2_item
&a
,
1544 const struct decode_line_2_item
&b
)
1546 return a
.fullform
== b
.fullform
;
1550 if (select_mode
== multiple_symbols_cancel
&& items
.size () > 1)
1551 error (_("canceled because the command is ambiguous\n"
1552 "See set/show multiple-symbol."));
1554 if (select_mode
== multiple_symbols_all
|| items
.size () == 1)
1556 convert_results_to_lsals (self
, result
);
1560 printf_unfiltered (_("[0] cancel\n[1] all\n"));
1561 for (i
= 0; i
< items
.size (); i
++)
1562 printf_unfiltered ("[%d] %s\n", i
+ 2, items
[i
].displayform
.c_str ());
1564 prompt
= getenv ("PS2");
1569 args
= command_line_input (prompt
, "overload-choice");
1571 if (args
== 0 || *args
== 0)
1572 error_no_arg (_("one or more choice numbers"));
1574 number_or_range_parser
parser (args
);
1575 while (!parser
.finished ())
1577 int num
= parser
.get_number ();
1580 error (_("canceled"));
1583 /* We intentionally make this result in a single breakpoint,
1584 contrary to what older versions of gdb did. The
1585 rationale is that this lets a user get the
1586 multiple_symbols_all behavior even with the 'ask'
1587 setting; and he can get separate breakpoints by entering
1588 "2-57" at the query. */
1589 convert_results_to_lsals (self
, result
);
1594 if (num
>= items
.size ())
1595 printf_unfiltered (_("No choice number %d.\n"), num
);
1598 struct decode_line_2_item
*item
= &items
[num
];
1600 if (!item
->selected
)
1602 filters
.push_back (item
->fullform
.c_str ());
1607 printf_unfiltered (_("duplicate request for %d ignored.\n"),
1613 filter_results (self
, result
, filters
);
1618 /* The parser of linespec itself. */
1620 /* Throw an appropriate error when SYMBOL is not found (optionally in
1623 static void ATTRIBUTE_NORETURN
1624 symbol_not_found_error (const char *symbol
, const char *filename
)
1629 if (!have_full_symbols ()
1630 && !have_partial_symbols ()
1631 && !have_minimal_symbols ())
1632 throw_error (NOT_FOUND_ERROR
,
1633 _("No symbol table is loaded. Use the \"file\" command."));
1635 /* If SYMBOL starts with '$', the user attempted to either lookup
1636 a function/variable in his code starting with '$' or an internal
1637 variable of that name. Since we do not know which, be concise and
1638 explain both possibilities. */
1642 throw_error (NOT_FOUND_ERROR
,
1643 _("Undefined convenience variable or function \"%s\" "
1644 "not defined in \"%s\"."), symbol
, filename
);
1646 throw_error (NOT_FOUND_ERROR
,
1647 _("Undefined convenience variable or function \"%s\" "
1648 "not defined."), symbol
);
1653 throw_error (NOT_FOUND_ERROR
,
1654 _("Function \"%s\" not defined in \"%s\"."),
1657 throw_error (NOT_FOUND_ERROR
,
1658 _("Function \"%s\" not defined."), symbol
);
1662 /* Throw an appropriate error when an unexpected token is encountered
1665 static void ATTRIBUTE_NORETURN
1666 unexpected_linespec_error (linespec_parser
*parser
)
1668 linespec_token token
;
1669 static const char * token_type_strings
[]
1670 = {"keyword", "colon", "string", "number", "comma", "end of input"};
1672 /* Get the token that generated the error. */
1673 token
= linespec_lexer_lex_one (parser
);
1675 /* Finally, throw the error. */
1676 if (token
.type
== LSTOKEN_STRING
|| token
.type
== LSTOKEN_NUMBER
1677 || token
.type
== LSTOKEN_KEYWORD
)
1679 gdb::unique_xmalloc_ptr
<char> string
= copy_token_string (token
);
1680 throw_error (GENERIC_ERROR
,
1681 _("malformed linespec error: unexpected %s, \"%s\""),
1682 token_type_strings
[token
.type
], string
.get ());
1685 throw_error (GENERIC_ERROR
,
1686 _("malformed linespec error: unexpected %s"),
1687 token_type_strings
[token
.type
]);
1690 /* Throw an undefined label error. */
1692 static void ATTRIBUTE_NORETURN
1693 undefined_label_error (const char *function
, const char *label
)
1695 if (function
!= NULL
)
1696 throw_error (NOT_FOUND_ERROR
,
1697 _("No label \"%s\" defined in function \"%s\"."),
1700 throw_error (NOT_FOUND_ERROR
,
1701 _("No label \"%s\" defined in current function."),
1705 /* Throw a source file not found error. */
1707 static void ATTRIBUTE_NORETURN
1708 source_file_not_found_error (const char *name
)
1710 throw_error (NOT_FOUND_ERROR
, _("No source file named %s."), name
);
1713 /* Unless at EIO, save the current stream position as completion word
1714 point, and consume the next token. */
1716 static linespec_token
1717 save_stream_and_consume_token (linespec_parser
*parser
)
1719 if (linespec_lexer_peek_token (parser
).type
!= LSTOKEN_EOI
)
1720 parser
->completion_word
= PARSER_STREAM (parser
);
1721 return linespec_lexer_consume_token (parser
);
1724 /* See description in linespec.h. */
1727 linespec_parse_line_offset (const char *string
)
1729 const char *start
= string
;
1730 struct line_offset line_offset
= {0, LINE_OFFSET_NONE
};
1734 line_offset
.sign
= LINE_OFFSET_PLUS
;
1737 else if (*string
== '-')
1739 line_offset
.sign
= LINE_OFFSET_MINUS
;
1743 if (*string
!= '\0' && !isdigit (*string
))
1744 error (_("malformed line offset: \"%s\""), start
);
1746 /* Right now, we only allow base 10 for offsets. */
1747 line_offset
.offset
= atoi (string
);
1751 /* In completion mode, if the user is still typing the number, there's
1752 no possible completion to offer. But if there's already input past
1753 the number, setup to expect NEXT. */
1756 set_completion_after_number (linespec_parser
*parser
,
1757 linespec_complete_what next
)
1759 if (*PARSER_STREAM (parser
) == ' ')
1761 parser
->completion_word
= skip_spaces (PARSER_STREAM (parser
) + 1);
1762 parser
->complete_what
= next
;
1766 parser
->completion_word
= PARSER_STREAM (parser
);
1767 parser
->complete_what
= linespec_complete_what::NOTHING
;
1771 /* Parse the basic_spec in PARSER's input. */
1774 linespec_parse_basic (linespec_parser
*parser
)
1776 gdb::unique_xmalloc_ptr
<char> name
;
1777 linespec_token token
;
1778 std::vector
<block_symbol
> symbols
;
1779 std::vector
<block_symbol
> *labels
;
1780 std::vector
<bound_minimal_symbol
> minimal_symbols
;
1782 /* Get the next token. */
1783 token
= linespec_lexer_lex_one (parser
);
1785 /* If it is EOI or KEYWORD, issue an error. */
1786 if (token
.type
== LSTOKEN_KEYWORD
)
1788 parser
->complete_what
= linespec_complete_what::NOTHING
;
1789 unexpected_linespec_error (parser
);
1791 else if (token
.type
== LSTOKEN_EOI
)
1793 unexpected_linespec_error (parser
);
1795 /* If it is a LSTOKEN_NUMBER, we have an offset. */
1796 else if (token
.type
== LSTOKEN_NUMBER
)
1798 set_completion_after_number (parser
, linespec_complete_what::KEYWORD
);
1800 /* Record the line offset and get the next token. */
1801 name
= copy_token_string (token
);
1802 PARSER_EXPLICIT (parser
)->line_offset
1803 = linespec_parse_line_offset (name
.get ());
1805 /* Get the next token. */
1806 token
= linespec_lexer_consume_token (parser
);
1808 /* If the next token is a comma, stop parsing and return. */
1809 if (token
.type
== LSTOKEN_COMMA
)
1811 parser
->complete_what
= linespec_complete_what::NOTHING
;
1815 /* If the next token is anything but EOI or KEYWORD, issue
1817 if (token
.type
!= LSTOKEN_KEYWORD
&& token
.type
!= LSTOKEN_EOI
)
1818 unexpected_linespec_error (parser
);
1821 if (token
.type
== LSTOKEN_KEYWORD
|| token
.type
== LSTOKEN_EOI
)
1824 /* Next token must be LSTOKEN_STRING. */
1825 if (token
.type
!= LSTOKEN_STRING
)
1827 parser
->complete_what
= linespec_complete_what::NOTHING
;
1828 unexpected_linespec_error (parser
);
1831 /* The current token will contain the name of a function, method,
1833 name
= copy_token_string (token
);
1835 if (parser
->completion_tracker
!= NULL
)
1837 /* If the function name ends with a ":", then this may be an
1838 incomplete "::" scope operator instead of a label separator.
1841 which should expand to:
1844 Do a tentative completion assuming the later. If we find
1845 completions, advance the stream past the colon token and make
1846 it part of the function name/token. */
1848 if (!parser
->completion_quote_char
1849 && strcmp (PARSER_STREAM (parser
), ":") == 0)
1851 completion_tracker tmp_tracker
;
1852 const char *source_filename
1853 = PARSER_EXPLICIT (parser
)->source_filename
;
1854 symbol_name_match_type match_type
1855 = PARSER_EXPLICIT (parser
)->func_name_match_type
;
1857 linespec_complete_function (tmp_tracker
,
1858 parser
->completion_word
,
1862 if (tmp_tracker
.have_completions ())
1864 PARSER_STREAM (parser
)++;
1865 LS_TOKEN_STOKEN (token
).length
++;
1867 name
.reset (savestring (parser
->completion_word
,
1868 (PARSER_STREAM (parser
)
1869 - parser
->completion_word
)));
1873 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1877 /* Try looking it up as a function/method. */
1878 find_linespec_symbols (PARSER_STATE (parser
),
1879 PARSER_RESULT (parser
)->file_symtabs
, name
.get (),
1880 PARSER_EXPLICIT (parser
)->func_name_match_type
,
1881 &symbols
, &minimal_symbols
);
1883 if (!symbols
.empty () || !minimal_symbols
.empty ())
1885 PARSER_RESULT (parser
)->function_symbols
1886 = new std::vector
<block_symbol
> (std::move (symbols
));
1887 PARSER_RESULT (parser
)->minimal_symbols
1888 = new std::vector
<bound_minimal_symbol
>
1889 (std::move (minimal_symbols
));
1890 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1894 /* NAME was not a function or a method. So it must be a label
1895 name or user specified variable like "break foo.c:$zippo". */
1896 labels
= find_label_symbols (PARSER_STATE (parser
), NULL
,
1897 &symbols
, name
.get ());
1900 PARSER_RESULT (parser
)->labels
.label_symbols
= labels
;
1901 PARSER_RESULT (parser
)->labels
.function_symbols
1902 = new std::vector
<block_symbol
> (std::move (symbols
));
1903 PARSER_EXPLICIT (parser
)->label_name
= name
.release ();
1905 else if (token
.type
== LSTOKEN_STRING
1906 && *LS_TOKEN_STOKEN (token
).ptr
== '$')
1908 /* User specified a convenience variable or history value. */
1909 PARSER_EXPLICIT (parser
)->line_offset
1910 = linespec_parse_variable (PARSER_STATE (parser
), name
.get ());
1912 if (PARSER_EXPLICIT (parser
)->line_offset
.sign
== LINE_OFFSET_UNKNOWN
)
1914 /* The user-specified variable was not valid. Do not
1915 throw an error here. parse_linespec will do it for us. */
1916 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1922 /* The name is also not a label. Abort parsing. Do not throw
1923 an error here. parse_linespec will do it for us. */
1925 /* Save a copy of the name we were trying to lookup. */
1926 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1932 int previous_qc
= parser
->completion_quote_char
;
1934 /* Get the next token. */
1935 token
= linespec_lexer_consume_token (parser
);
1937 if (token
.type
== LSTOKEN_EOI
)
1939 if (previous_qc
&& !parser
->completion_quote_char
)
1940 parser
->complete_what
= linespec_complete_what::KEYWORD
;
1942 else if (token
.type
== LSTOKEN_COLON
)
1944 /* User specified a label or a lineno. */
1945 token
= linespec_lexer_consume_token (parser
);
1947 if (token
.type
== LSTOKEN_NUMBER
)
1949 /* User specified an offset. Record the line offset and
1950 get the next token. */
1951 set_completion_after_number (parser
, linespec_complete_what::KEYWORD
);
1953 name
= copy_token_string (token
);
1954 PARSER_EXPLICIT (parser
)->line_offset
1955 = linespec_parse_line_offset (name
.get ());
1957 /* Get the next token. */
1958 token
= linespec_lexer_consume_token (parser
);
1960 else if (token
.type
== LSTOKEN_EOI
&& parser
->completion_tracker
!= NULL
)
1962 parser
->complete_what
= linespec_complete_what::LABEL
;
1964 else if (token
.type
== LSTOKEN_STRING
)
1966 parser
->complete_what
= linespec_complete_what::LABEL
;
1968 /* If we have text after the label separated by whitespace
1969 (e.g., "b func():lab i<tab>"), don't consider it part of
1970 the label. In completion mode that should complete to
1971 "if", in normal mode, the 'i' should be treated as
1973 if (parser
->completion_quote_char
== '\0')
1975 const char *ptr
= LS_TOKEN_STOKEN (token
).ptr
;
1976 for (size_t i
= 0; i
< LS_TOKEN_STOKEN (token
).length
; i
++)
1980 LS_TOKEN_STOKEN (token
).length
= i
;
1981 PARSER_STREAM (parser
) = skip_spaces (ptr
+ i
+ 1);
1987 if (parser
->completion_tracker
!= NULL
)
1989 if (PARSER_STREAM (parser
)[-1] == ' ')
1991 parser
->completion_word
= PARSER_STREAM (parser
);
1992 parser
->complete_what
= linespec_complete_what::KEYWORD
;
1997 /* Grab a copy of the label's name and look it up. */
1998 name
= copy_token_string (token
);
2000 = find_label_symbols (PARSER_STATE (parser
),
2001 PARSER_RESULT (parser
)->function_symbols
,
2002 &symbols
, name
.get ());
2006 PARSER_RESULT (parser
)->labels
.label_symbols
= labels
;
2007 PARSER_RESULT (parser
)->labels
.function_symbols
2008 = new std::vector
<block_symbol
> (std::move (symbols
));
2009 PARSER_EXPLICIT (parser
)->label_name
= name
.release ();
2013 /* We don't know what it was, but it isn't a label. */
2014 undefined_label_error
2015 (PARSER_EXPLICIT (parser
)->function_name
, name
.get ());
2020 /* Check for a line offset. */
2021 token
= save_stream_and_consume_token (parser
);
2022 if (token
.type
== LSTOKEN_COLON
)
2024 /* Get the next token. */
2025 token
= linespec_lexer_consume_token (parser
);
2027 /* It must be a line offset. */
2028 if (token
.type
!= LSTOKEN_NUMBER
)
2029 unexpected_linespec_error (parser
);
2031 /* Record the line offset and get the next token. */
2032 name
= copy_token_string (token
);
2034 PARSER_EXPLICIT (parser
)->line_offset
2035 = linespec_parse_line_offset (name
.get ());
2037 /* Get the next token. */
2038 token
= linespec_lexer_consume_token (parser
);
2043 /* Trailing ':' in the input. Issue an error. */
2044 unexpected_linespec_error (parser
);
2049 /* Canonicalize the linespec contained in LS. The result is saved into
2050 STATE->canonical. This function handles both linespec and explicit
2054 canonicalize_linespec (struct linespec_state
*state
, const linespec_p ls
)
2056 struct event_location
*canon
;
2057 struct explicit_location
*explicit_loc
;
2059 /* If canonicalization was not requested, no need to do anything. */
2060 if (!state
->canonical
)
2063 /* Save everything as an explicit location. */
2064 state
->canonical
->location
2065 = new_explicit_location (&ls
->explicit_loc
);
2066 canon
= state
->canonical
->location
.get ();
2067 explicit_loc
= get_explicit_location (canon
);
2069 if (explicit_loc
->label_name
!= NULL
)
2071 state
->canonical
->special_display
= 1;
2073 if (explicit_loc
->function_name
== NULL
)
2075 /* No function was specified, so add the symbol name. */
2076 gdb_assert (!ls
->labels
.function_symbols
->empty ()
2077 && (ls
->labels
.function_symbols
->size () == 1));
2078 block_symbol s
= ls
->labels
.function_symbols
->front ();
2079 explicit_loc
->function_name
= xstrdup (s
.symbol
->natural_name ());
2083 /* If this location originally came from a linespec, save a string
2084 representation of it for display and saving to file. */
2085 if (state
->is_linespec
)
2087 char *linespec
= explicit_location_to_linespec (explicit_loc
);
2089 set_event_location_string (canon
, linespec
);
2094 /* Given a line offset in LS, construct the relevant SALs. */
2096 static std::vector
<symtab_and_line
>
2097 create_sals_line_offset (struct linespec_state
*self
,
2100 int use_default
= 0;
2102 /* This is where we need to make sure we have good defaults.
2103 We must guarantee that this section of code is never executed
2104 when we are called with just a function name, since
2105 set_default_source_symtab_and_line uses
2106 select_source_symtab that calls us with such an argument. */
2108 if (ls
->file_symtabs
->size () == 1
2109 && ls
->file_symtabs
->front () == nullptr)
2111 set_current_program_space (self
->program_space
);
2113 /* Make sure we have at least a default source line. */
2114 set_default_source_symtab_and_line ();
2115 initialize_defaults (&self
->default_symtab
, &self
->default_line
);
2117 = collect_symtabs_from_filename (self
->default_symtab
->filename
,
2118 self
->search_pspace
);
2122 symtab_and_line val
;
2123 val
.line
= ls
->explicit_loc
.line_offset
.offset
;
2124 switch (ls
->explicit_loc
.line_offset
.sign
)
2126 case LINE_OFFSET_PLUS
:
2127 if (ls
->explicit_loc
.line_offset
.offset
== 0)
2130 val
.line
= self
->default_line
+ val
.line
;
2133 case LINE_OFFSET_MINUS
:
2134 if (ls
->explicit_loc
.line_offset
.offset
== 0)
2137 val
.line
= self
->default_line
- val
.line
;
2139 val
.line
= -val
.line
;
2142 case LINE_OFFSET_NONE
:
2143 break; /* No need to adjust val.line. */
2146 std::vector
<symtab_and_line
> values
;
2147 if (self
->list_mode
)
2148 values
= decode_digits_list_mode (self
, ls
, val
);
2151 struct linetable_entry
*best_entry
= NULL
;
2154 std::vector
<symtab_and_line
> intermediate_results
2155 = decode_digits_ordinary (self
, ls
, val
.line
, &best_entry
);
2156 if (intermediate_results
.empty () && best_entry
!= NULL
)
2157 intermediate_results
= decode_digits_ordinary (self
, ls
,
2161 /* For optimized code, the compiler can scatter one source line
2162 across disjoint ranges of PC values, even when no duplicate
2163 functions or inline functions are involved. For example,
2164 'for (;;)' inside a non-template, non-inline, and non-ctor-or-dtor
2165 function can result in two PC ranges. In this case, we don't
2166 want to set a breakpoint on the first PC of each range. To filter
2167 such cases, we use containing blocks -- for each PC found
2168 above, we see if there are other PCs that are in the same
2169 block. If yes, the other PCs are filtered out. */
2171 gdb::def_vector
<int> filter (intermediate_results
.size ());
2172 gdb::def_vector
<const block
*> blocks (intermediate_results
.size ());
2174 for (i
= 0; i
< intermediate_results
.size (); ++i
)
2176 set_current_program_space (intermediate_results
[i
].pspace
);
2179 blocks
[i
] = block_for_pc_sect (intermediate_results
[i
].pc
,
2180 intermediate_results
[i
].section
);
2183 for (i
= 0; i
< intermediate_results
.size (); ++i
)
2185 if (blocks
[i
] != NULL
)
2186 for (j
= i
+ 1; j
< intermediate_results
.size (); ++j
)
2188 if (blocks
[j
] == blocks
[i
])
2196 for (i
= 0; i
< intermediate_results
.size (); ++i
)
2199 struct symbol
*sym
= (blocks
[i
]
2200 ? block_containing_function (blocks
[i
])
2203 if (self
->funfirstline
)
2204 skip_prologue_sal (&intermediate_results
[i
]);
2205 intermediate_results
[i
].symbol
= sym
;
2206 add_sal_to_sals (self
, &values
, &intermediate_results
[i
],
2207 sym
? sym
->natural_name () : NULL
, 0);
2211 if (values
.empty ())
2213 if (ls
->explicit_loc
.source_filename
)
2214 throw_error (NOT_FOUND_ERROR
, _("No line %d in file \"%s\"."),
2215 val
.line
, ls
->explicit_loc
.source_filename
);
2217 throw_error (NOT_FOUND_ERROR
, _("No line %d in the current file."),
2224 /* Convert the given ADDRESS into SaLs. */
2226 static std::vector
<symtab_and_line
>
2227 convert_address_location_to_sals (struct linespec_state
*self
,
2230 symtab_and_line sal
= find_pc_line (address
, 0);
2232 sal
.section
= find_pc_overlay (address
);
2233 sal
.explicit_pc
= 1;
2234 sal
.symbol
= find_pc_sect_containing_function (sal
.pc
, sal
.section
);
2236 std::vector
<symtab_and_line
> sals
;
2237 add_sal_to_sals (self
, &sals
, &sal
, core_addr_to_string (address
), 1);
2242 /* Create and return SALs from the linespec LS. */
2244 static std::vector
<symtab_and_line
>
2245 convert_linespec_to_sals (struct linespec_state
*state
, linespec_p ls
)
2247 std::vector
<symtab_and_line
> sals
;
2249 if (ls
->labels
.label_symbols
!= NULL
)
2251 /* We have just a bunch of functions/methods or labels. */
2252 struct symtab_and_line sal
;
2254 for (const auto &sym
: *ls
->labels
.label_symbols
)
2256 struct program_space
*pspace
2257 = SYMTAB_PSPACE (symbol_symtab (sym
.symbol
));
2259 if (symbol_to_sal (&sal
, state
->funfirstline
, sym
.symbol
)
2260 && maybe_add_address (state
->addr_set
, pspace
, sal
.pc
))
2261 add_sal_to_sals (state
, &sals
, &sal
,
2262 sym
.symbol
->natural_name (), 0);
2265 else if (ls
->function_symbols
!= NULL
|| ls
->minimal_symbols
!= NULL
)
2267 /* We have just a bunch of functions and/or methods. */
2268 if (ls
->function_symbols
!= NULL
)
2270 /* Sort symbols so that symbols with the same program space are next
2272 std::sort (ls
->function_symbols
->begin (),
2273 ls
->function_symbols
->end (),
2276 for (const auto &sym
: *ls
->function_symbols
)
2278 program_space
*pspace
2279 = SYMTAB_PSPACE (symbol_symtab (sym
.symbol
));
2280 set_current_program_space (pspace
);
2282 /* Don't skip to the first line of the function if we
2283 had found an ifunc minimal symbol for this function,
2284 because that means that this function is an ifunc
2285 resolver with the same name as the ifunc itself. */
2286 bool found_ifunc
= false;
2288 if (state
->funfirstline
2289 && ls
->minimal_symbols
!= NULL
2290 && SYMBOL_CLASS (sym
.symbol
) == LOC_BLOCK
)
2292 const CORE_ADDR addr
2293 = BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
.symbol
));
2295 for (const auto &elem
: *ls
->minimal_symbols
)
2297 if (MSYMBOL_TYPE (elem
.minsym
) == mst_text_gnu_ifunc
2298 || MSYMBOL_TYPE (elem
.minsym
) == mst_data_gnu_ifunc
)
2300 CORE_ADDR msym_addr
= BMSYMBOL_VALUE_ADDRESS (elem
);
2301 if (MSYMBOL_TYPE (elem
.minsym
) == mst_data_gnu_ifunc
)
2303 struct gdbarch
*gdbarch
2304 = elem
.objfile
->arch ();
2306 = (gdbarch_convert_from_func_ptr_addr
2309 current_top_target ()));
2312 if (msym_addr
== addr
)
2323 symtab_and_line sal
;
2324 if (symbol_to_sal (&sal
, state
->funfirstline
, sym
.symbol
)
2325 && maybe_add_address (state
->addr_set
, pspace
, sal
.pc
))
2326 add_sal_to_sals (state
, &sals
, &sal
,
2327 sym
.symbol
->natural_name (), 0);
2332 if (ls
->minimal_symbols
!= NULL
)
2334 /* Sort minimal symbols by program space, too */
2335 std::sort (ls
->minimal_symbols
->begin (),
2336 ls
->minimal_symbols
->end (),
2339 for (const auto &elem
: *ls
->minimal_symbols
)
2341 program_space
*pspace
= elem
.objfile
->pspace
;
2342 set_current_program_space (pspace
);
2343 minsym_found (state
, elem
.objfile
, elem
.minsym
, &sals
);
2347 else if (ls
->explicit_loc
.line_offset
.sign
!= LINE_OFFSET_UNKNOWN
)
2349 /* Only an offset was specified. */
2350 sals
= create_sals_line_offset (state
, ls
);
2352 /* Make sure we have a filename for canonicalization. */
2353 if (ls
->explicit_loc
.source_filename
== NULL
)
2355 const char *fullname
= symtab_to_fullname (state
->default_symtab
);
2357 /* It may be more appropriate to keep DEFAULT_SYMTAB in its symtab
2358 form so that displaying SOURCE_FILENAME can follow the current
2359 FILENAME_DISPLAY_STRING setting. But as it is used only rarely
2360 it has been kept for code simplicity only in absolute form. */
2361 ls
->explicit_loc
.source_filename
= xstrdup (fullname
);
2366 /* We haven't found any results... */
2370 canonicalize_linespec (state
, ls
);
2372 if (!sals
.empty () && state
->canonical
!= NULL
)
2373 state
->canonical
->pre_expanded
= 1;
2378 /* Build RESULT from the explicit location components SOURCE_FILENAME,
2379 FUNCTION_NAME, LABEL_NAME and LINE_OFFSET. */
2382 convert_explicit_location_to_linespec (struct linespec_state
*self
,
2384 const char *source_filename
,
2385 const char *function_name
,
2386 symbol_name_match_type fname_match_type
,
2387 const char *label_name
,
2388 struct line_offset line_offset
)
2390 std::vector
<block_symbol
> symbols
;
2391 std::vector
<block_symbol
> *labels
;
2392 std::vector
<bound_minimal_symbol
> minimal_symbols
;
2394 result
->explicit_loc
.func_name_match_type
= fname_match_type
;
2396 if (source_filename
!= NULL
)
2400 *result
->file_symtabs
2401 = symtabs_from_filename (source_filename
, self
->search_pspace
);
2403 catch (const gdb_exception_error
&except
)
2405 source_file_not_found_error (source_filename
);
2407 result
->explicit_loc
.source_filename
= xstrdup (source_filename
);
2411 /* A NULL entry means to use the default symtab. */
2412 result
->file_symtabs
->push_back (nullptr);
2415 if (function_name
!= NULL
)
2417 find_linespec_symbols (self
, result
->file_symtabs
,
2418 function_name
, fname_match_type
,
2419 &symbols
, &minimal_symbols
);
2421 if (symbols
.empty () && minimal_symbols
.empty ())
2422 symbol_not_found_error (function_name
,
2423 result
->explicit_loc
.source_filename
);
2425 result
->explicit_loc
.function_name
= xstrdup (function_name
);
2426 result
->function_symbols
2427 = new std::vector
<block_symbol
> (std::move (symbols
));
2428 result
->minimal_symbols
2429 = new std::vector
<bound_minimal_symbol
> (std::move (minimal_symbols
));
2432 if (label_name
!= NULL
)
2434 labels
= find_label_symbols (self
, result
->function_symbols
,
2435 &symbols
, label_name
);
2438 undefined_label_error (result
->explicit_loc
.function_name
,
2441 result
->explicit_loc
.label_name
= xstrdup (label_name
);
2442 result
->labels
.label_symbols
= labels
;
2443 result
->labels
.function_symbols
2444 = new std::vector
<block_symbol
> (std::move (symbols
));
2447 if (line_offset
.sign
!= LINE_OFFSET_UNKNOWN
)
2448 result
->explicit_loc
.line_offset
= line_offset
;
2451 /* Convert the explicit location EXPLICIT_LOC into SaLs. */
2453 static std::vector
<symtab_and_line
>
2454 convert_explicit_location_to_sals (struct linespec_state
*self
,
2456 const struct explicit_location
*explicit_loc
)
2458 convert_explicit_location_to_linespec (self
, result
,
2459 explicit_loc
->source_filename
,
2460 explicit_loc
->function_name
,
2461 explicit_loc
->func_name_match_type
,
2462 explicit_loc
->label_name
,
2463 explicit_loc
->line_offset
);
2464 return convert_linespec_to_sals (self
, result
);
2467 /* Parse a string that specifies a linespec.
2469 The basic grammar of linespecs:
2471 linespec -> var_spec | basic_spec
2472 var_spec -> '$' (STRING | NUMBER)
2474 basic_spec -> file_offset_spec | function_spec | label_spec
2475 file_offset_spec -> opt_file_spec offset_spec
2476 function_spec -> opt_file_spec function_name_spec opt_label_spec
2477 label_spec -> label_name_spec
2479 opt_file_spec -> "" | file_name_spec ':'
2480 opt_label_spec -> "" | ':' label_name_spec
2482 file_name_spec -> STRING
2483 function_name_spec -> STRING
2484 label_name_spec -> STRING
2485 function_name_spec -> STRING
2486 offset_spec -> NUMBER
2490 This may all be followed by several keywords such as "if EXPR",
2493 A comma will terminate parsing.
2495 The function may be an undebuggable function found in minimal symbol table.
2497 If the argument FUNFIRSTLINE is nonzero, we want the first line
2498 of real code inside a function when a function is specified, and it is
2499 not OK to specify a variable or type to get its line number.
2501 DEFAULT_SYMTAB specifies the file to use if none is specified.
2502 It defaults to current_source_symtab.
2503 DEFAULT_LINE specifies the line number to use for relative
2504 line numbers (that start with signs). Defaults to current_source_line.
2505 If CANONICAL is non-NULL, store an array of strings containing the canonical
2506 line specs there if necessary. Currently overloaded member functions and
2507 line numbers or static functions without a filename yield a canonical
2508 line spec. The array and the line spec strings are allocated on the heap,
2509 it is the callers responsibility to free them.
2511 Note that it is possible to return zero for the symtab
2512 if no file is validly specified. Callers must check that.
2513 Also, the line number returned may be invalid. */
2515 /* Parse the linespec in ARG. MATCH_TYPE indicates how function names
2516 should be matched. */
2518 static std::vector
<symtab_and_line
>
2519 parse_linespec (linespec_parser
*parser
, const char *arg
,
2520 symbol_name_match_type match_type
)
2522 linespec_token token
;
2523 struct gdb_exception file_exception
;
2525 /* A special case to start. It has become quite popular for
2526 IDEs to work around bugs in the previous parser by quoting
2527 the entire linespec, so we attempt to deal with this nicely. */
2528 parser
->is_quote_enclosed
= 0;
2529 if (parser
->completion_tracker
== NULL
2530 && !is_ada_operator (arg
)
2531 && strchr (linespec_quote_characters
, *arg
) != NULL
)
2535 end
= skip_quote_char (arg
+ 1, *arg
);
2536 if (end
!= NULL
&& is_closing_quote_enclosed (end
))
2538 /* Here's the special case. Skip ARG past the initial
2541 parser
->is_quote_enclosed
= 1;
2545 parser
->lexer
.saved_arg
= arg
;
2546 parser
->lexer
.stream
= arg
;
2547 parser
->completion_word
= arg
;
2548 parser
->complete_what
= linespec_complete_what::FUNCTION
;
2549 PARSER_EXPLICIT (parser
)->func_name_match_type
= match_type
;
2551 /* Initialize the default symtab and line offset. */
2552 initialize_defaults (&PARSER_STATE (parser
)->default_symtab
,
2553 &PARSER_STATE (parser
)->default_line
);
2555 /* Objective-C shortcut. */
2556 if (parser
->completion_tracker
== NULL
)
2558 std::vector
<symtab_and_line
> values
2559 = decode_objc (PARSER_STATE (parser
), PARSER_RESULT (parser
), arg
);
2560 if (!values
.empty ())
2565 /* "-"/"+" is either an objc selector, or a number. There's
2566 nothing to complete the latter to, so just let the caller
2567 complete on functions, which finds objc selectors, if there's
2569 if ((arg
[0] == '-' || arg
[0] == '+') && arg
[1] == '\0')
2573 /* Start parsing. */
2575 /* Get the first token. */
2576 token
= linespec_lexer_consume_token (parser
);
2578 /* It must be either LSTOKEN_STRING or LSTOKEN_NUMBER. */
2579 if (token
.type
== LSTOKEN_STRING
&& *LS_TOKEN_STOKEN (token
).ptr
== '$')
2581 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2582 if (parser
->completion_tracker
== NULL
)
2583 PARSER_RESULT (parser
)->file_symtabs
->push_back (nullptr);
2585 /* User specified a convenience variable or history value. */
2586 gdb::unique_xmalloc_ptr
<char> var
= copy_token_string (token
);
2587 PARSER_EXPLICIT (parser
)->line_offset
2588 = linespec_parse_variable (PARSER_STATE (parser
), var
.get ());
2590 /* If a line_offset wasn't found (VAR is the name of a user
2591 variable/function), then skip to normal symbol processing. */
2592 if (PARSER_EXPLICIT (parser
)->line_offset
.sign
!= LINE_OFFSET_UNKNOWN
)
2594 /* Consume this token. */
2595 linespec_lexer_consume_token (parser
);
2597 goto convert_to_sals
;
2600 else if (token
.type
== LSTOKEN_EOI
&& parser
->completion_tracker
!= NULL
)
2602 /* Let the default linespec_complete_what::FUNCTION kick in. */
2603 unexpected_linespec_error (parser
);
2605 else if (token
.type
!= LSTOKEN_STRING
&& token
.type
!= LSTOKEN_NUMBER
)
2607 parser
->complete_what
= linespec_complete_what::NOTHING
;
2608 unexpected_linespec_error (parser
);
2611 /* Shortcut: If the next token is not LSTOKEN_COLON, we know that
2612 this token cannot represent a filename. */
2613 token
= linespec_lexer_peek_token (parser
);
2615 if (token
.type
== LSTOKEN_COLON
)
2617 /* Get the current token again and extract the filename. */
2618 token
= linespec_lexer_lex_one (parser
);
2619 gdb::unique_xmalloc_ptr
<char> user_filename
= copy_token_string (token
);
2621 /* Check if the input is a filename. */
2624 *PARSER_RESULT (parser
)->file_symtabs
2625 = symtabs_from_filename (user_filename
.get (),
2626 PARSER_STATE (parser
)->search_pspace
);
2628 catch (gdb_exception_error
&ex
)
2630 file_exception
= std::move (ex
);
2633 if (file_exception
.reason
>= 0)
2635 /* Symtabs were found for the file. Record the filename. */
2636 PARSER_EXPLICIT (parser
)->source_filename
= user_filename
.release ();
2638 /* Get the next token. */
2639 token
= linespec_lexer_consume_token (parser
);
2641 /* This is LSTOKEN_COLON; consume it. */
2642 linespec_lexer_consume_token (parser
);
2646 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2647 PARSER_RESULT (parser
)->file_symtabs
->push_back (nullptr);
2650 /* If the next token is not EOI, KEYWORD, or COMMA, issue an error. */
2651 else if (parser
->completion_tracker
== NULL
2652 && (token
.type
!= LSTOKEN_EOI
&& token
.type
!= LSTOKEN_KEYWORD
2653 && token
.type
!= LSTOKEN_COMMA
))
2655 /* TOKEN is the _next_ token, not the one currently in the parser.
2656 Consuming the token will give the correct error message. */
2657 linespec_lexer_consume_token (parser
);
2658 unexpected_linespec_error (parser
);
2662 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2663 PARSER_RESULT (parser
)->file_symtabs
->push_back (nullptr);
2666 /* Parse the rest of the linespec. */
2667 linespec_parse_basic (parser
);
2669 if (parser
->completion_tracker
== NULL
2670 && PARSER_RESULT (parser
)->function_symbols
== NULL
2671 && PARSER_RESULT (parser
)->labels
.label_symbols
== NULL
2672 && PARSER_EXPLICIT (parser
)->line_offset
.sign
== LINE_OFFSET_UNKNOWN
2673 && PARSER_RESULT (parser
)->minimal_symbols
== NULL
)
2675 /* The linespec didn't parse. Re-throw the file exception if
2677 if (file_exception
.reason
< 0)
2678 throw_exception (std::move (file_exception
));
2680 /* Otherwise, the symbol is not found. */
2681 symbol_not_found_error (PARSER_EXPLICIT (parser
)->function_name
,
2682 PARSER_EXPLICIT (parser
)->source_filename
);
2687 /* Get the last token and record how much of the input was parsed,
2689 token
= linespec_lexer_lex_one (parser
);
2690 if (token
.type
!= LSTOKEN_EOI
&& token
.type
!= LSTOKEN_KEYWORD
)
2691 unexpected_linespec_error (parser
);
2692 else if (token
.type
== LSTOKEN_KEYWORD
)
2694 /* Setup the completion word past the keyword. Lexing never
2695 advances past a keyword automatically, so skip it
2697 parser
->completion_word
2698 = skip_spaces (skip_to_space (PARSER_STREAM (parser
)));
2699 parser
->complete_what
= linespec_complete_what::EXPRESSION
;
2702 /* Convert the data in PARSER_RESULT to SALs. */
2703 if (parser
->completion_tracker
== NULL
)
2704 return convert_linespec_to_sals (PARSER_STATE (parser
),
2705 PARSER_RESULT (parser
));
2711 /* A constructor for linespec_state. */
2714 linespec_state_constructor (struct linespec_state
*self
,
2715 int flags
, const struct language_defn
*language
,
2716 struct program_space
*search_pspace
,
2717 struct symtab
*default_symtab
,
2719 struct linespec_result
*canonical
)
2721 memset (self
, 0, sizeof (*self
));
2722 self
->language
= language
;
2723 self
->funfirstline
= (flags
& DECODE_LINE_FUNFIRSTLINE
) ? 1 : 0;
2724 self
->list_mode
= (flags
& DECODE_LINE_LIST_MODE
) ? 1 : 0;
2725 self
->search_pspace
= search_pspace
;
2726 self
->default_symtab
= default_symtab
;
2727 self
->default_line
= default_line
;
2728 self
->canonical
= canonical
;
2729 self
->program_space
= current_program_space
;
2730 self
->addr_set
= htab_create_alloc (10, hash_address_entry
, eq_address_entry
,
2731 xfree
, xcalloc
, xfree
);
2732 self
->is_linespec
= 0;
2735 /* Initialize a new linespec parser. */
2737 linespec_parser::linespec_parser (int flags
,
2738 const struct language_defn
*language
,
2739 struct program_space
*search_pspace
,
2740 struct symtab
*default_symtab
,
2742 struct linespec_result
*canonical
)
2744 lexer
.current
.type
= LSTOKEN_CONSUMED
;
2745 PARSER_RESULT (this)->file_symtabs
= new std::vector
<symtab
*> ();
2746 PARSER_EXPLICIT (this)->func_name_match_type
2747 = symbol_name_match_type::WILD
;
2748 PARSER_EXPLICIT (this)->line_offset
.sign
= LINE_OFFSET_UNKNOWN
;
2749 linespec_state_constructor (PARSER_STATE (this), flags
, language
,
2751 default_symtab
, default_line
, canonical
);
2754 /* A destructor for linespec_state. */
2757 linespec_state_destructor (struct linespec_state
*self
)
2759 htab_delete (self
->addr_set
);
2760 xfree (self
->canonical_names
);
2763 /* Delete a linespec parser. */
2765 linespec_parser::~linespec_parser ()
2767 xfree (PARSER_EXPLICIT (this)->source_filename
);
2768 xfree (PARSER_EXPLICIT (this)->label_name
);
2769 xfree (PARSER_EXPLICIT (this)->function_name
);
2771 delete PARSER_RESULT (this)->file_symtabs
;
2772 delete PARSER_RESULT (this)->function_symbols
;
2773 delete PARSER_RESULT (this)->minimal_symbols
;
2774 delete PARSER_RESULT (this)->labels
.label_symbols
;
2775 delete PARSER_RESULT (this)->labels
.function_symbols
;
2777 linespec_state_destructor (PARSER_STATE (this));
2780 /* See description in linespec.h. */
2783 linespec_lex_to_end (const char **stringp
)
2785 linespec_token token
;
2788 if (stringp
== NULL
|| *stringp
== NULL
)
2791 linespec_parser
parser (0, current_language
, NULL
, NULL
, 0, NULL
);
2792 parser
.lexer
.saved_arg
= *stringp
;
2793 PARSER_STREAM (&parser
) = orig
= *stringp
;
2797 /* Stop before any comma tokens; we need it to keep it
2798 as the next token in the string. */
2799 token
= linespec_lexer_peek_token (&parser
);
2800 if (token
.type
== LSTOKEN_COMMA
)
2802 token
= linespec_lexer_consume_token (&parser
);
2804 while (token
.type
!= LSTOKEN_EOI
&& token
.type
!= LSTOKEN_KEYWORD
);
2806 *stringp
+= PARSER_STREAM (&parser
) - orig
;
2809 /* See linespec.h. */
2812 linespec_complete_function (completion_tracker
&tracker
,
2813 const char *function
,
2814 symbol_name_match_type func_match_type
,
2815 const char *source_filename
)
2817 complete_symbol_mode mode
= complete_symbol_mode::LINESPEC
;
2819 if (source_filename
!= NULL
)
2821 collect_file_symbol_completion_matches (tracker
, mode
, func_match_type
,
2822 function
, function
, source_filename
);
2826 collect_symbol_completion_matches (tracker
, mode
, func_match_type
,
2827 function
, function
);
2832 /* Helper for complete_linespec to simplify it. SOURCE_FILENAME is
2833 only meaningful if COMPONENT is FUNCTION. */
2836 complete_linespec_component (linespec_parser
*parser
,
2837 completion_tracker
&tracker
,
2839 linespec_complete_what component
,
2840 const char *source_filename
)
2842 if (component
== linespec_complete_what::KEYWORD
)
2844 complete_on_enum (tracker
, linespec_keywords
, text
, text
);
2846 else if (component
== linespec_complete_what::EXPRESSION
)
2849 = advance_to_expression_complete_word_point (tracker
, text
);
2850 complete_expression (tracker
, text
, word
);
2852 else if (component
== linespec_complete_what::FUNCTION
)
2854 completion_list fn_list
;
2856 symbol_name_match_type match_type
2857 = PARSER_EXPLICIT (parser
)->func_name_match_type
;
2858 linespec_complete_function (tracker
, text
, match_type
, source_filename
);
2859 if (source_filename
== NULL
)
2861 /* Haven't seen a source component, like in "b
2862 file.c:function[TAB]". Maybe this wasn't a function, but
2863 a filename instead, like "b file.[TAB]". */
2864 fn_list
= complete_source_filenames (text
);
2867 /* If we only have a single filename completion, append a ':' for
2868 the user, since that's the only thing that can usefully follow
2870 if (fn_list
.size () == 1 && !tracker
.have_completions ())
2872 char *fn
= fn_list
[0].release ();
2874 /* If we also need to append a quote char, it needs to be
2875 appended before the ':'. Append it now, and make ':' the
2876 new "quote" char. */
2877 if (tracker
.quote_char ())
2879 char quote_char_str
[2] = { (char) tracker
.quote_char () };
2881 fn
= reconcat (fn
, fn
, quote_char_str
, (char *) NULL
);
2882 tracker
.set_quote_char (':');
2885 fn
= reconcat (fn
, fn
, ":", (char *) NULL
);
2886 fn_list
[0].reset (fn
);
2888 /* Tell readline to skip appending a space. */
2889 tracker
.set_suppress_append_ws (true);
2891 tracker
.add_completions (std::move (fn_list
));
2895 /* Helper for linespec_complete_label. Find labels that match
2896 LABEL_NAME in the function symbols listed in the PARSER, and add
2897 them to the tracker. */
2900 complete_label (completion_tracker
&tracker
,
2901 linespec_parser
*parser
,
2902 const char *label_name
)
2904 std::vector
<block_symbol
> label_function_symbols
;
2905 std::vector
<block_symbol
> *labels
2906 = find_label_symbols (PARSER_STATE (parser
),
2907 PARSER_RESULT (parser
)->function_symbols
,
2908 &label_function_symbols
,
2911 if (labels
!= nullptr)
2913 for (const auto &label
: *labels
)
2915 char *match
= xstrdup (label
.symbol
->search_name ());
2916 tracker
.add_completion (gdb::unique_xmalloc_ptr
<char> (match
));
2922 /* See linespec.h. */
2925 linespec_complete_label (completion_tracker
&tracker
,
2926 const struct language_defn
*language
,
2927 const char *source_filename
,
2928 const char *function_name
,
2929 symbol_name_match_type func_name_match_type
,
2930 const char *label_name
)
2932 linespec_parser
parser (0, language
, NULL
, NULL
, 0, NULL
);
2934 line_offset unknown_offset
= { 0, LINE_OFFSET_UNKNOWN
};
2938 convert_explicit_location_to_linespec (PARSER_STATE (&parser
),
2939 PARSER_RESULT (&parser
),
2942 func_name_match_type
,
2943 NULL
, unknown_offset
);
2945 catch (const gdb_exception_error
&ex
)
2950 complete_label (tracker
, &parser
, label_name
);
2953 /* See description in linespec.h. */
2956 linespec_complete (completion_tracker
&tracker
, const char *text
,
2957 symbol_name_match_type match_type
)
2959 const char *orig
= text
;
2961 linespec_parser
parser (0, current_language
, NULL
, NULL
, 0, NULL
);
2962 parser
.lexer
.saved_arg
= text
;
2963 PARSER_EXPLICIT (&parser
)->func_name_match_type
= match_type
;
2964 PARSER_STREAM (&parser
) = text
;
2966 parser
.completion_tracker
= &tracker
;
2967 PARSER_STATE (&parser
)->is_linespec
= 1;
2969 /* Parse as much as possible. parser.completion_word will hold
2970 furthest completion point we managed to parse to. */
2973 parse_linespec (&parser
, text
, match_type
);
2975 catch (const gdb_exception_error
&except
)
2979 if (parser
.completion_quote_char
!= '\0'
2980 && parser
.completion_quote_end
!= NULL
2981 && parser
.completion_quote_end
[1] == '\0')
2983 /* If completing a quoted string with the cursor right at
2984 terminating quote char, complete the completion word without
2985 interpretation, so that readline advances the cursor one
2986 whitespace past the quote, even if there's no match. This
2987 makes these cases behave the same:
2989 before: "b function()"
2990 after: "b function() "
2992 before: "b 'function()'"
2993 after: "b 'function()' "
2995 and trusts the user in this case:
2997 before: "b 'not_loaded_function_yet()'"
2998 after: "b 'not_loaded_function_yet()' "
3000 parser
.complete_what
= linespec_complete_what::NOTHING
;
3001 parser
.completion_quote_char
= '\0';
3003 gdb::unique_xmalloc_ptr
<char> text_copy
3004 (xstrdup (parser
.completion_word
));
3005 tracker
.add_completion (std::move (text_copy
));
3008 tracker
.set_quote_char (parser
.completion_quote_char
);
3010 if (parser
.complete_what
== linespec_complete_what::LABEL
)
3012 parser
.complete_what
= linespec_complete_what::NOTHING
;
3014 const char *func_name
= PARSER_EXPLICIT (&parser
)->function_name
;
3016 std::vector
<block_symbol
> function_symbols
;
3017 std::vector
<bound_minimal_symbol
> minimal_symbols
;
3018 find_linespec_symbols (PARSER_STATE (&parser
),
3019 PARSER_RESULT (&parser
)->file_symtabs
,
3020 func_name
, match_type
,
3021 &function_symbols
, &minimal_symbols
);
3023 PARSER_RESULT (&parser
)->function_symbols
3024 = new std::vector
<block_symbol
> (std::move (function_symbols
));
3025 PARSER_RESULT (&parser
)->minimal_symbols
3026 = new std::vector
<bound_minimal_symbol
> (std::move (minimal_symbols
));
3028 complete_label (tracker
, &parser
, parser
.completion_word
);
3030 else if (parser
.complete_what
== linespec_complete_what::FUNCTION
)
3032 /* While parsing/lexing, we didn't know whether the completion
3033 word completes to a unique function/source name already or
3037 "b function() <tab>"
3038 may need to complete either to:
3039 "b function() const"
3041 "b function() if/thread/task"
3045 may need to complete either to:
3046 "b foo template_fun<T>()"
3047 with "foo" being the template function's return type, or to:
3052 may need to complete either to a source file name:
3054 or this, also a filename, but a unique completion:
3056 or to a function name:
3059 Address that by completing assuming source or function, and
3060 seeing if we find a completion that matches exactly the
3061 completion word. If so, then it must be a function (see note
3062 below) and we advance the completion word to the end of input
3063 and switch to KEYWORD completion mode.
3065 Note: if we find a unique completion for a source filename,
3066 then it won't match the completion word, because the LCD will
3067 contain a trailing ':'. And if we're completing at or after
3068 the ':', then complete_linespec_component won't try to
3069 complete on source filenames. */
3071 const char *word
= parser
.completion_word
;
3073 complete_linespec_component (&parser
, tracker
,
3074 parser
.completion_word
,
3075 linespec_complete_what::FUNCTION
,
3076 PARSER_EXPLICIT (&parser
)->source_filename
);
3078 parser
.complete_what
= linespec_complete_what::NOTHING
;
3080 if (tracker
.quote_char ())
3082 /* The function/file name was not close-quoted, so this
3083 can't be a keyword. Note: complete_linespec_component
3084 may have swapped the original quote char for ':' when we
3085 get here, but that still indicates the same. */
3087 else if (!tracker
.have_completions ())
3090 size_t wordlen
= strlen (parser
.completion_word
);
3093 = string_find_incomplete_keyword_at_end (linespec_keywords
,
3094 parser
.completion_word
,
3099 && parser
.completion_word
[wordlen
- 1] == ' '))
3101 parser
.completion_word
+= key_start
;
3102 parser
.complete_what
= linespec_complete_what::KEYWORD
;
3105 else if (tracker
.completes_to_completion_word (word
))
3107 /* Skip the function and complete on keywords. */
3108 parser
.completion_word
+= strlen (word
);
3109 parser
.complete_what
= linespec_complete_what::KEYWORD
;
3110 tracker
.discard_completions ();
3114 tracker
.advance_custom_word_point_by (parser
.completion_word
- orig
);
3116 complete_linespec_component (&parser
, tracker
,
3117 parser
.completion_word
,
3118 parser
.complete_what
,
3119 PARSER_EXPLICIT (&parser
)->source_filename
);
3121 /* If we're past the "filename:function:label:offset" linespec, and
3122 didn't find any match, then assume the user might want to create
3123 a pending breakpoint anyway and offer the keyword
3125 if (!parser
.completion_quote_char
3126 && (parser
.complete_what
== linespec_complete_what::FUNCTION
3127 || parser
.complete_what
== linespec_complete_what::LABEL
3128 || parser
.complete_what
== linespec_complete_what::NOTHING
)
3129 && !tracker
.have_completions ())
3132 = parser
.completion_word
+ strlen (parser
.completion_word
);
3134 if (end
> orig
&& end
[-1] == ' ')
3136 tracker
.advance_custom_word_point_by (end
- parser
.completion_word
);
3138 complete_linespec_component (&parser
, tracker
, end
,
3139 linespec_complete_what::KEYWORD
,
3145 /* A helper function for decode_line_full and decode_line_1 to
3146 turn LOCATION into std::vector<symtab_and_line>. */
3148 static std::vector
<symtab_and_line
>
3149 event_location_to_sals (linespec_parser
*parser
,
3150 const struct event_location
*location
)
3152 std::vector
<symtab_and_line
> result
;
3154 switch (event_location_type (location
))
3156 case LINESPEC_LOCATION
:
3158 PARSER_STATE (parser
)->is_linespec
= 1;
3161 const linespec_location
*ls
= get_linespec_location (location
);
3162 result
= parse_linespec (parser
,
3163 ls
->spec_string
, ls
->match_type
);
3165 catch (const gdb_exception_error
&except
)
3172 case ADDRESS_LOCATION
:
3174 const char *addr_string
= get_address_string_location (location
);
3175 CORE_ADDR addr
= get_address_location (location
);
3177 if (addr_string
!= NULL
)
3179 addr
= linespec_expression_to_pc (&addr_string
);
3180 if (PARSER_STATE (parser
)->canonical
!= NULL
)
3181 PARSER_STATE (parser
)->canonical
->location
3182 = copy_event_location (location
);
3185 result
= convert_address_location_to_sals (PARSER_STATE (parser
),
3190 case EXPLICIT_LOCATION
:
3192 const struct explicit_location
*explicit_loc
;
3194 explicit_loc
= get_explicit_location_const (location
);
3195 result
= convert_explicit_location_to_sals (PARSER_STATE (parser
),
3196 PARSER_RESULT (parser
),
3201 case PROBE_LOCATION
:
3202 /* Probes are handled by their own decoders. */
3203 gdb_assert_not_reached ("attempt to decode probe location");
3207 gdb_assert_not_reached ("unhandled event location type");
3213 /* See linespec.h. */
3216 decode_line_full (struct event_location
*location
, int flags
,
3217 struct program_space
*search_pspace
,
3218 struct symtab
*default_symtab
,
3219 int default_line
, struct linespec_result
*canonical
,
3220 const char *select_mode
,
3223 std::vector
<const char *> filters
;
3224 struct linespec_state
*state
;
3226 gdb_assert (canonical
!= NULL
);
3227 /* The filter only makes sense for 'all'. */
3228 gdb_assert (filter
== NULL
|| select_mode
== multiple_symbols_all
);
3229 gdb_assert (select_mode
== NULL
3230 || select_mode
== multiple_symbols_all
3231 || select_mode
== multiple_symbols_ask
3232 || select_mode
== multiple_symbols_cancel
);
3233 gdb_assert ((flags
& DECODE_LINE_LIST_MODE
) == 0);
3235 linespec_parser
parser (flags
, current_language
,
3236 search_pspace
, default_symtab
,
3237 default_line
, canonical
);
3239 scoped_restore_current_program_space restore_pspace
;
3241 std::vector
<symtab_and_line
> result
= event_location_to_sals (&parser
,
3243 state
= PARSER_STATE (&parser
);
3245 if (result
.size () == 0)
3246 throw_error (NOT_SUPPORTED_ERROR
, _("Location %s not available"),
3247 event_location_to_string (location
));
3249 gdb_assert (result
.size () == 1 || canonical
->pre_expanded
);
3250 canonical
->pre_expanded
= 1;
3252 /* Arrange for allocated canonical names to be freed. */
3253 std::vector
<gdb::unique_xmalloc_ptr
<char>> hold_names
;
3254 for (int i
= 0; i
< result
.size (); ++i
)
3256 gdb_assert (state
->canonical_names
[i
].suffix
!= NULL
);
3257 hold_names
.emplace_back (state
->canonical_names
[i
].suffix
);
3260 if (select_mode
== NULL
)
3262 if (top_level_interpreter ()->interp_ui_out ()->is_mi_like_p ())
3263 select_mode
= multiple_symbols_all
;
3265 select_mode
= multiple_symbols_select_mode ();
3268 if (select_mode
== multiple_symbols_all
)
3272 filters
.push_back (filter
);
3273 filter_results (state
, &result
, filters
);
3276 convert_results_to_lsals (state
, &result
);
3279 decode_line_2 (state
, &result
, select_mode
);
3282 /* See linespec.h. */
3284 std::vector
<symtab_and_line
>
3285 decode_line_1 (const struct event_location
*location
, int flags
,
3286 struct program_space
*search_pspace
,
3287 struct symtab
*default_symtab
,
3290 linespec_parser
parser (flags
, current_language
,
3291 search_pspace
, default_symtab
,
3292 default_line
, NULL
);
3294 scoped_restore_current_program_space restore_pspace
;
3296 return event_location_to_sals (&parser
, location
);
3299 /* See linespec.h. */
3301 std::vector
<symtab_and_line
>
3302 decode_line_with_current_source (const char *string
, int flags
)
3305 error (_("Empty line specification."));
3307 /* We use whatever is set as the current source line. We do not try
3308 and get a default source symtab+line or it will recursively call us! */
3309 symtab_and_line cursal
= get_current_source_symtab_and_line ();
3311 event_location_up location
= string_to_event_location (&string
,
3313 std::vector
<symtab_and_line
> sals
3314 = decode_line_1 (location
.get (), flags
, NULL
, cursal
.symtab
, cursal
.line
);
3317 error (_("Junk at end of line specification: %s"), string
);
3322 /* See linespec.h. */
3324 std::vector
<symtab_and_line
>
3325 decode_line_with_last_displayed (const char *string
, int flags
)
3328 error (_("Empty line specification."));
3330 event_location_up location
= string_to_event_location (&string
,
3332 std::vector
<symtab_and_line
> sals
3333 = (last_displayed_sal_is_valid ()
3334 ? decode_line_1 (location
.get (), flags
, NULL
,
3335 get_last_displayed_symtab (),
3336 get_last_displayed_line ())
3337 : decode_line_1 (location
.get (), flags
, NULL
, NULL
, 0));
3340 error (_("Junk at end of line specification: %s"), string
);
3347 /* First, some functions to initialize stuff at the beginning of the
3351 initialize_defaults (struct symtab
**default_symtab
, int *default_line
)
3353 if (*default_symtab
== 0)
3355 /* Use whatever we have for the default source line. We don't use
3356 get_current_or_default_symtab_and_line as it can recurse and call
3358 struct symtab_and_line cursal
=
3359 get_current_source_symtab_and_line ();
3361 *default_symtab
= cursal
.symtab
;
3362 *default_line
= cursal
.line
;
3368 /* Evaluate the expression pointed to by EXP_PTR into a CORE_ADDR,
3369 advancing EXP_PTR past any parsed text. */
3372 linespec_expression_to_pc (const char **exp_ptr
)
3374 if (current_program_space
->executing_startup
)
3375 /* The error message doesn't really matter, because this case
3376 should only hit during breakpoint reset. */
3377 throw_error (NOT_FOUND_ERROR
, _("cannot evaluate expressions while "
3378 "program space is in startup"));
3381 return value_as_address (parse_to_comma_and_eval (exp_ptr
));
3386 /* Here's where we recognise an Objective-C Selector. An Objective C
3387 selector may be implemented by more than one class, therefore it
3388 may represent more than one method/function. This gives us a
3389 situation somewhat analogous to C++ overloading. If there's more
3390 than one method that could represent the selector, then use some of
3391 the existing C++ code to let the user choose one. */
3393 static std::vector
<symtab_and_line
>
3394 decode_objc (struct linespec_state
*self
, linespec_p ls
, const char *arg
)
3396 struct collect_info info
;
3397 std::vector
<const char *> symbol_names
;
3398 const char *new_argptr
;
3401 std::vector
<symtab
*> symtabs
;
3402 symtabs
.push_back (nullptr);
3404 info
.file_symtabs
= &symtabs
;
3406 std::vector
<block_symbol
> symbols
;
3407 info
.result
.symbols
= &symbols
;
3408 std::vector
<bound_minimal_symbol
> minimal_symbols
;
3409 info
.result
.minimal_symbols
= &minimal_symbols
;
3411 new_argptr
= find_imps (arg
, &symbol_names
);
3412 if (symbol_names
.empty ())
3415 add_all_symbol_names_from_pspace (&info
, NULL
, symbol_names
,
3418 std::vector
<symtab_and_line
> values
;
3419 if (!symbols
.empty () || !minimal_symbols
.empty ())
3423 saved_arg
= (char *) alloca (new_argptr
- arg
+ 1);
3424 memcpy (saved_arg
, arg
, new_argptr
- arg
);
3425 saved_arg
[new_argptr
- arg
] = '\0';
3427 ls
->explicit_loc
.function_name
= xstrdup (saved_arg
);
3428 ls
->function_symbols
3429 = new std::vector
<block_symbol
> (std::move (symbols
));
3431 = new std::vector
<bound_minimal_symbol
> (std::move (minimal_symbols
));
3432 values
= convert_linespec_to_sals (self
, ls
);
3434 if (self
->canonical
)
3439 self
->canonical
->pre_expanded
= 1;
3441 if (ls
->explicit_loc
.source_filename
)
3443 holder
= string_printf ("%s:%s",
3444 ls
->explicit_loc
.source_filename
,
3446 str
= holder
.c_str ();
3451 self
->canonical
->location
3452 = new_linespec_location (&str
, symbol_name_match_type::FULL
);
3461 /* A function object that serves as symbol_found_callback_ftype
3462 callback for iterate_over_symbols. This is used by
3463 lookup_prefix_sym to collect type symbols. */
3464 class decode_compound_collector
3467 decode_compound_collector ()
3468 : m_unique_syms (htab_create_alloc (1, htab_hash_pointer
,
3469 htab_eq_pointer
, NULL
,
3474 /* Return all symbols collected. */
3475 std::vector
<block_symbol
> release_symbols ()
3477 return std::move (m_symbols
);
3480 /* Callable as a symbol_found_callback_ftype callback. */
3481 bool operator () (block_symbol
*bsym
);
3484 /* A hash table of all symbols we found. We use this to avoid
3485 adding any symbol more than once. */
3486 htab_up m_unique_syms
;
3488 /* The result vector. */
3489 std::vector
<block_symbol
> m_symbols
;
3493 decode_compound_collector::operator () (block_symbol
*bsym
)
3497 struct symbol
*sym
= bsym
->symbol
;
3499 if (SYMBOL_CLASS (sym
) != LOC_TYPEDEF
)
3500 return true; /* Continue iterating. */
3502 t
= SYMBOL_TYPE (sym
);
3503 t
= check_typedef (t
);
3504 if (t
->code () != TYPE_CODE_STRUCT
3505 && t
->code () != TYPE_CODE_UNION
3506 && t
->code () != TYPE_CODE_NAMESPACE
)
3507 return true; /* Continue iterating. */
3509 slot
= htab_find_slot (m_unique_syms
.get (), sym
, INSERT
);
3513 m_symbols
.push_back (*bsym
);
3516 return true; /* Continue iterating. */
3521 /* Return any symbols corresponding to CLASS_NAME in FILE_SYMTABS. */
3523 static std::vector
<block_symbol
>
3524 lookup_prefix_sym (struct linespec_state
*state
,
3525 std::vector
<symtab
*> *file_symtabs
,
3526 const char *class_name
)
3528 decode_compound_collector collector
;
3530 lookup_name_info
lookup_name (class_name
, symbol_name_match_type::FULL
);
3532 for (const auto &elt
: *file_symtabs
)
3536 iterate_over_all_matching_symtabs (state
, lookup_name
,
3537 STRUCT_DOMAIN
, ALL_DOMAIN
,
3538 NULL
, false, collector
);
3539 iterate_over_all_matching_symtabs (state
, lookup_name
,
3540 VAR_DOMAIN
, ALL_DOMAIN
,
3541 NULL
, false, collector
);
3545 /* Program spaces that are executing startup should have
3546 been filtered out earlier. */
3547 gdb_assert (!SYMTAB_PSPACE (elt
)->executing_startup
);
3548 set_current_program_space (SYMTAB_PSPACE (elt
));
3549 iterate_over_file_blocks (elt
, lookup_name
, STRUCT_DOMAIN
, collector
);
3550 iterate_over_file_blocks (elt
, lookup_name
, VAR_DOMAIN
, collector
);
3554 return collector
.release_symbols ();
3557 /* A std::sort comparison function for symbols. The resulting order does
3558 not actually matter; we just need to be able to sort them so that
3559 symbols with the same program space end up next to each other. */
3562 compare_symbols (const block_symbol
&a
, const block_symbol
&b
)
3566 uia
= (uintptr_t) SYMTAB_PSPACE (symbol_symtab (a
.symbol
));
3567 uib
= (uintptr_t) SYMTAB_PSPACE (symbol_symtab (b
.symbol
));
3574 uia
= (uintptr_t) a
.symbol
;
3575 uib
= (uintptr_t) b
.symbol
;
3583 /* Like compare_symbols but for minimal symbols. */
3586 compare_msymbols (const bound_minimal_symbol
&a
, const bound_minimal_symbol
&b
)
3590 uia
= (uintptr_t) a
.objfile
->pspace
;
3591 uib
= (uintptr_t) a
.objfile
->pspace
;
3598 uia
= (uintptr_t) a
.minsym
;
3599 uib
= (uintptr_t) b
.minsym
;
3607 /* Look for all the matching instances of each symbol in NAMES. Only
3608 instances from PSPACE are considered; other program spaces are
3609 handled by our caller. If PSPACE is NULL, then all program spaces
3610 are considered. Results are stored into INFO. */
3613 add_all_symbol_names_from_pspace (struct collect_info
*info
,
3614 struct program_space
*pspace
,
3615 const std::vector
<const char *> &names
,
3616 enum search_domain search_domain
)
3618 for (const char *iter
: names
)
3619 add_matching_symbols_to_info (iter
,
3620 symbol_name_match_type::FULL
,
3621 search_domain
, info
, pspace
);
3625 find_superclass_methods (std::vector
<struct type
*> &&superclasses
,
3626 const char *name
, enum language name_lang
,
3627 std::vector
<const char *> *result_names
)
3629 size_t old_len
= result_names
->size ();
3633 std::vector
<struct type
*> new_supers
;
3635 for (type
*t
: superclasses
)
3636 find_methods (t
, name_lang
, name
, result_names
, &new_supers
);
3638 if (result_names
->size () != old_len
|| new_supers
.empty ())
3641 superclasses
= std::move (new_supers
);
3645 /* This finds the method METHOD_NAME in the class CLASS_NAME whose type is
3646 given by one of the symbols in SYM_CLASSES. Matches are returned
3647 in SYMBOLS (for debug symbols) and MINSYMS (for minimal symbols). */
3650 find_method (struct linespec_state
*self
, std::vector
<symtab
*> *file_symtabs
,
3651 const char *class_name
, const char *method_name
,
3652 std::vector
<block_symbol
> *sym_classes
,
3653 std::vector
<block_symbol
> *symbols
,
3654 std::vector
<bound_minimal_symbol
> *minsyms
)
3656 size_t last_result_len
;
3657 std::vector
<struct type
*> superclass_vec
;
3658 std::vector
<const char *> result_names
;
3659 struct collect_info info
;
3661 /* Sort symbols so that symbols with the same program space are next
3663 std::sort (sym_classes
->begin (), sym_classes
->end (),
3667 info
.file_symtabs
= file_symtabs
;
3668 info
.result
.symbols
= symbols
;
3669 info
.result
.minimal_symbols
= minsyms
;
3671 /* Iterate over all the types, looking for the names of existing
3672 methods matching METHOD_NAME. If we cannot find a direct method in a
3673 given program space, then we consider inherited methods; this is
3674 not ideal (ideal would be to respect C++ hiding rules), but it
3675 seems good enough and is what GDB has historically done. We only
3676 need to collect the names because later we find all symbols with
3677 those names. This loop is written in a somewhat funny way
3678 because we collect data across the program space before deciding
3680 last_result_len
= 0;
3681 for (const auto &elt
: *sym_classes
)
3684 struct program_space
*pspace
;
3685 struct symbol
*sym
= elt
.symbol
;
3686 unsigned int ix
= &elt
- &*sym_classes
->begin ();
3688 /* Program spaces that are executing startup should have
3689 been filtered out earlier. */
3690 pspace
= SYMTAB_PSPACE (symbol_symtab (sym
));
3691 gdb_assert (!pspace
->executing_startup
);
3692 set_current_program_space (pspace
);
3693 t
= check_typedef (SYMBOL_TYPE (sym
));
3694 find_methods (t
, sym
->language (),
3695 method_name
, &result_names
, &superclass_vec
);
3697 /* Handle all items from a single program space at once; and be
3698 sure not to miss the last batch. */
3699 if (ix
== sym_classes
->size () - 1
3701 != SYMTAB_PSPACE (symbol_symtab (sym_classes
->at (ix
+ 1).symbol
))))
3703 /* If we did not find a direct implementation anywhere in
3704 this program space, consider superclasses. */
3705 if (result_names
.size () == last_result_len
)
3706 find_superclass_methods (std::move (superclass_vec
), method_name
,
3707 sym
->language (), &result_names
);
3709 /* We have a list of candidate symbol names, so now we
3710 iterate over the symbol tables looking for all
3711 matches in this pspace. */
3712 add_all_symbol_names_from_pspace (&info
, pspace
, result_names
,
3715 superclass_vec
.clear ();
3716 last_result_len
= result_names
.size ();
3720 if (!symbols
->empty () || !minsyms
->empty ())
3723 /* Throw an NOT_FOUND_ERROR. This will be caught by the caller
3724 and other attempts to locate the symbol will be made. */
3725 throw_error (NOT_FOUND_ERROR
, _("see caller, this text doesn't matter"));
3732 /* This function object is a callback for iterate_over_symtabs, used
3733 when collecting all matching symtabs. */
3735 class symtab_collector
3739 : m_symtab_table (htab_create (1, htab_hash_pointer
, htab_eq_pointer
,
3744 /* Callable as a symbol_found_callback_ftype callback. */
3745 bool operator () (symtab
*sym
);
3747 /* Return an rvalue reference to the collected symtabs. */
3748 std::vector
<symtab
*> &&release_symtabs ()
3750 return std::move (m_symtabs
);
3754 /* The result vector of symtabs. */
3755 std::vector
<symtab
*> m_symtabs
;
3757 /* This is used to ensure the symtabs are unique. */
3758 htab_up m_symtab_table
;
3762 symtab_collector::operator () (struct symtab
*symtab
)
3766 slot
= htab_find_slot (m_symtab_table
.get (), symtab
, INSERT
);
3770 m_symtabs
.push_back (symtab
);
3778 /* Given a file name, return a list of all matching symtabs. If
3779 SEARCH_PSPACE is not NULL, the search is restricted to just that
3782 static std::vector
<symtab
*>
3783 collect_symtabs_from_filename (const char *file
,
3784 struct program_space
*search_pspace
)
3786 symtab_collector collector
;
3788 /* Find that file's data. */
3789 if (search_pspace
== NULL
)
3791 for (struct program_space
*pspace
: program_spaces
)
3793 if (pspace
->executing_startup
)
3796 set_current_program_space (pspace
);
3797 iterate_over_symtabs (file
, collector
);
3802 set_current_program_space (search_pspace
);
3803 iterate_over_symtabs (file
, collector
);
3806 return collector
.release_symtabs ();
3809 /* Return all the symtabs associated to the FILENAME. If SEARCH_PSPACE is
3810 not NULL, the search is restricted to just that program space. */
3812 static std::vector
<symtab
*>
3813 symtabs_from_filename (const char *filename
,
3814 struct program_space
*search_pspace
)
3816 std::vector
<symtab
*> result
3817 = collect_symtabs_from_filename (filename
, search_pspace
);
3819 if (result
.empty ())
3821 if (!have_full_symbols () && !have_partial_symbols ())
3822 throw_error (NOT_FOUND_ERROR
,
3823 _("No symbol table is loaded. "
3824 "Use the \"file\" command."));
3825 source_file_not_found_error (filename
);
3834 symbol_searcher::find_all_symbols (const std::string
&name
,
3835 const struct language_defn
*language
,
3836 enum search_domain search_domain
,
3837 std::vector
<symtab
*> *search_symtabs
,
3838 struct program_space
*search_pspace
)
3840 symbol_searcher_collect_info info
;
3841 struct linespec_state state
;
3843 memset (&state
, 0, sizeof (state
));
3844 state
.language
= language
;
3845 info
.state
= &state
;
3847 info
.result
.symbols
= &m_symbols
;
3848 info
.result
.minimal_symbols
= &m_minimal_symbols
;
3849 std::vector
<symtab
*> all_symtabs
;
3850 if (search_symtabs
== nullptr)
3852 all_symtabs
.push_back (nullptr);
3853 search_symtabs
= &all_symtabs
;
3855 info
.file_symtabs
= search_symtabs
;
3857 add_matching_symbols_to_info (name
.c_str (), symbol_name_match_type::WILD
,
3858 search_domain
, &info
, search_pspace
);
3861 /* Look up a function symbol named NAME in symtabs FILE_SYMTABS. Matching
3862 debug symbols are returned in SYMBOLS. Matching minimal symbols are
3863 returned in MINSYMS. */
3866 find_function_symbols (struct linespec_state
*state
,
3867 std::vector
<symtab
*> *file_symtabs
, const char *name
,
3868 symbol_name_match_type name_match_type
,
3869 std::vector
<block_symbol
> *symbols
,
3870 std::vector
<bound_minimal_symbol
> *minsyms
)
3872 struct collect_info info
;
3873 std::vector
<const char *> symbol_names
;
3876 info
.result
.symbols
= symbols
;
3877 info
.result
.minimal_symbols
= minsyms
;
3878 info
.file_symtabs
= file_symtabs
;
3880 /* Try NAME as an Objective-C selector. */
3881 find_imps (name
, &symbol_names
);
3882 if (!symbol_names
.empty ())
3883 add_all_symbol_names_from_pspace (&info
, state
->search_pspace
,
3884 symbol_names
, FUNCTIONS_DOMAIN
);
3886 add_matching_symbols_to_info (name
, name_match_type
, FUNCTIONS_DOMAIN
,
3887 &info
, state
->search_pspace
);
3890 /* Find all symbols named NAME in FILE_SYMTABS, returning debug symbols
3891 in SYMBOLS and minimal symbols in MINSYMS. */
3894 find_linespec_symbols (struct linespec_state
*state
,
3895 std::vector
<symtab
*> *file_symtabs
,
3896 const char *lookup_name
,
3897 symbol_name_match_type name_match_type
,
3898 std::vector
<block_symbol
> *symbols
,
3899 std::vector
<bound_minimal_symbol
> *minsyms
)
3901 gdb::unique_xmalloc_ptr
<char> canon
3902 = cp_canonicalize_string_no_typedefs (lookup_name
);
3903 if (canon
!= nullptr)
3904 lookup_name
= canon
.get ();
3906 /* It's important to not call expand_symtabs_matching unnecessarily
3907 as it can really slow things down (by unnecessarily expanding
3908 potentially 1000s of symtabs, which when debugging some apps can
3909 cost 100s of seconds). Avoid this to some extent by *first* calling
3910 find_function_symbols, and only if that doesn't find anything
3911 *then* call find_method. This handles two important cases:
3912 1) break (anonymous namespace)::foo
3913 2) break class::method where method is in class (and not a baseclass) */
3915 find_function_symbols (state
, file_symtabs
, lookup_name
,
3916 name_match_type
, symbols
, minsyms
);
3918 /* If we were unable to locate a symbol of the same name, try dividing
3919 the name into class and method names and searching the class and its
3921 if (symbols
->empty () && minsyms
->empty ())
3923 std::string klass
, method
;
3924 const char *last
, *p
, *scope_op
;
3926 /* See if we can find a scope operator and break this symbol
3927 name into namespaces${SCOPE_OPERATOR}class_name and method_name. */
3929 p
= find_toplevel_string (lookup_name
, scope_op
);
3935 p
= find_toplevel_string (p
+ strlen (scope_op
), scope_op
);
3938 /* If no scope operator was found, there is nothing more we can do;
3939 we already attempted to lookup the entire name as a symbol
3944 /* LOOKUP_NAME points to the class name.
3945 LAST points to the method name. */
3946 klass
= std::string (lookup_name
, last
- lookup_name
);
3948 /* Skip past the scope operator. */
3949 last
+= strlen (scope_op
);
3952 /* Find a list of classes named KLASS. */
3953 std::vector
<block_symbol
> classes
3954 = lookup_prefix_sym (state
, file_symtabs
, klass
.c_str ());
3955 if (!classes
.empty ())
3957 /* Now locate a list of suitable methods named METHOD. */
3960 find_method (state
, file_symtabs
,
3961 klass
.c_str (), method
.c_str (),
3962 &classes
, symbols
, minsyms
);
3965 /* If successful, we're done. If NOT_FOUND_ERROR
3966 was not thrown, rethrow the exception that we did get. */
3967 catch (const gdb_exception_error
&except
)
3969 if (except
.error
!= NOT_FOUND_ERROR
)
3976 /* Helper for find_label_symbols. Find all labels that match name
3977 NAME in BLOCK. Return all labels that match in FUNCTION_SYMBOLS.
3978 Return the actual function symbol in which the label was found in
3979 LABEL_FUNC_RET. If COMPLETION_MODE is true, then NAME is
3980 interpreted as a label name prefix. Otherwise, only a label named
3981 exactly NAME match. */
3984 find_label_symbols_in_block (const struct block
*block
,
3985 const char *name
, struct symbol
*fn_sym
,
3986 bool completion_mode
,
3987 std::vector
<block_symbol
> *result
,
3988 std::vector
<block_symbol
> *label_funcs_ret
)
3990 if (completion_mode
)
3992 struct block_iterator iter
;
3994 size_t name_len
= strlen (name
);
3996 int (*cmp
) (const char *, const char *, size_t);
3997 cmp
= case_sensitivity
== case_sensitive_on
? strncmp
: strncasecmp
;
3999 ALL_BLOCK_SYMBOLS (block
, iter
, sym
)
4001 if (symbol_matches_domain (sym
->language (),
4002 SYMBOL_DOMAIN (sym
), LABEL_DOMAIN
)
4003 && cmp (sym
->search_name (), name
, name_len
) == 0)
4005 result
->push_back ({sym
, block
});
4006 label_funcs_ret
->push_back ({fn_sym
, block
});
4012 struct block_symbol label_sym
4013 = lookup_symbol (name
, block
, LABEL_DOMAIN
, 0);
4015 if (label_sym
.symbol
!= NULL
)
4017 result
->push_back (label_sym
);
4018 label_funcs_ret
->push_back ({fn_sym
, block
});
4023 /* Return all labels that match name NAME in FUNCTION_SYMBOLS or NULL
4024 if no matches were found.
4026 Return the actual function symbol in which the label was found in
4027 LABEL_FUNC_RET. If COMPLETION_MODE is true, then NAME is
4028 interpreted as a label name prefix. Otherwise, only labels named
4029 exactly NAME match. */
4032 static std::vector
<block_symbol
> *
4033 find_label_symbols (struct linespec_state
*self
,
4034 std::vector
<block_symbol
> *function_symbols
,
4035 std::vector
<block_symbol
> *label_funcs_ret
,
4037 bool completion_mode
)
4039 const struct block
*block
;
4040 struct symbol
*fn_sym
;
4041 std::vector
<block_symbol
> result
;
4043 if (function_symbols
== NULL
)
4045 set_current_program_space (self
->program_space
);
4046 block
= get_current_search_block ();
4049 block
&& !BLOCK_FUNCTION (block
);
4050 block
= BLOCK_SUPERBLOCK (block
))
4054 fn_sym
= BLOCK_FUNCTION (block
);
4056 find_label_symbols_in_block (block
, name
, fn_sym
, completion_mode
,
4057 &result
, label_funcs_ret
);
4061 for (const auto &elt
: *function_symbols
)
4063 fn_sym
= elt
.symbol
;
4064 set_current_program_space (SYMTAB_PSPACE (symbol_symtab (fn_sym
)));
4065 block
= SYMBOL_BLOCK_VALUE (fn_sym
);
4067 find_label_symbols_in_block (block
, name
, fn_sym
, completion_mode
,
4068 &result
, label_funcs_ret
);
4072 if (!result
.empty ())
4073 return new std::vector
<block_symbol
> (std::move (result
));
4079 /* A helper for create_sals_line_offset that handles the 'list_mode' case. */
4081 static std::vector
<symtab_and_line
>
4082 decode_digits_list_mode (struct linespec_state
*self
,
4084 struct symtab_and_line val
)
4086 gdb_assert (self
->list_mode
);
4088 std::vector
<symtab_and_line
> values
;
4090 for (const auto &elt
: *ls
->file_symtabs
)
4092 /* The logic above should ensure this. */
4093 gdb_assert (elt
!= NULL
);
4095 set_current_program_space (SYMTAB_PSPACE (elt
));
4097 /* Simplistic search just for the list command. */
4098 val
.symtab
= find_line_symtab (elt
, val
.line
, NULL
, NULL
);
4099 if (val
.symtab
== NULL
)
4101 val
.pspace
= SYMTAB_PSPACE (elt
);
4103 val
.explicit_line
= true;
4105 add_sal_to_sals (self
, &values
, &val
, NULL
, 0);
4111 /* A helper for create_sals_line_offset that iterates over the symtabs
4112 associated with LS and returns a vector of corresponding symtab_and_line
4115 static std::vector
<symtab_and_line
>
4116 decode_digits_ordinary (struct linespec_state
*self
,
4119 struct linetable_entry
**best_entry
)
4121 std::vector
<symtab_and_line
> sals
;
4122 for (const auto &elt
: *ls
->file_symtabs
)
4124 std::vector
<CORE_ADDR
> pcs
;
4126 /* The logic above should ensure this. */
4127 gdb_assert (elt
!= NULL
);
4129 set_current_program_space (SYMTAB_PSPACE (elt
));
4131 pcs
= find_pcs_for_symtab_line (elt
, line
, best_entry
);
4132 for (CORE_ADDR pc
: pcs
)
4134 symtab_and_line sal
;
4135 sal
.pspace
= SYMTAB_PSPACE (elt
);
4138 sal
.explicit_line
= true;
4140 sals
.push_back (std::move (sal
));
4149 /* Return the line offset represented by VARIABLE. */
4151 static struct line_offset
4152 linespec_parse_variable (struct linespec_state
*self
, const char *variable
)
4156 struct line_offset offset
= {0, LINE_OFFSET_NONE
};
4158 p
= (variable
[1] == '$') ? variable
+ 2 : variable
+ 1;
4161 while (*p
>= '0' && *p
<= '9')
4163 if (!*p
) /* Reached end of token without hitting non-digit. */
4165 /* We have a value history reference. */
4166 struct value
*val_history
;
4168 sscanf ((variable
[1] == '$') ? variable
+ 2 : variable
+ 1, "%d", &index
);
4170 = access_value_history ((variable
[1] == '$') ? -index
: index
);
4171 if (value_type (val_history
)->code () != TYPE_CODE_INT
)
4172 error (_("History values used in line "
4173 "specs must have integer values."));
4174 offset
.offset
= value_as_long (val_history
);
4178 /* Not all digits -- may be user variable/function or a
4179 convenience variable. */
4181 struct internalvar
*ivar
;
4183 /* Try it as a convenience variable. If it is not a convenience
4184 variable, return and allow normal symbol lookup to occur. */
4185 ivar
= lookup_only_internalvar (variable
+ 1);
4187 /* No internal variable with that name. Mark the offset
4188 as unknown to allow the name to be looked up as a symbol. */
4189 offset
.sign
= LINE_OFFSET_UNKNOWN
;
4192 /* We found a valid variable name. If it is not an integer,
4194 if (!get_internalvar_integer (ivar
, &valx
))
4195 error (_("Convenience variables used in line "
4196 "specs must have integer values."));
4198 offset
.offset
= valx
;
4206 /* We've found a minimal symbol MSYMBOL in OBJFILE to associate with our
4207 linespec; return the SAL in RESULT. This function should return SALs
4208 matching those from find_function_start_sal, otherwise false
4209 multiple-locations breakpoints could be placed. */
4212 minsym_found (struct linespec_state
*self
, struct objfile
*objfile
,
4213 struct minimal_symbol
*msymbol
,
4214 std::vector
<symtab_and_line
> *result
)
4216 bool want_start_sal
;
4218 CORE_ADDR func_addr
;
4219 bool is_function
= msymbol_is_function (objfile
, msymbol
, &func_addr
);
4223 const char *msym_name
= msymbol
->linkage_name ();
4225 if (MSYMBOL_TYPE (msymbol
) == mst_text_gnu_ifunc
4226 || MSYMBOL_TYPE (msymbol
) == mst_data_gnu_ifunc
)
4227 want_start_sal
= gnu_ifunc_resolve_name (msym_name
, &func_addr
);
4229 want_start_sal
= true;
4232 symtab_and_line sal
;
4234 if (is_function
&& want_start_sal
)
4235 sal
= find_function_start_sal (func_addr
, NULL
, self
->funfirstline
);
4238 sal
.objfile
= objfile
;
4239 sal
.msymbol
= msymbol
;
4240 /* Store func_addr, not the minsym's address in case this was an
4241 ifunc that hasn't been resolved yet. */
4245 sal
.pc
= MSYMBOL_VALUE_ADDRESS (objfile
, msymbol
);
4246 sal
.pspace
= current_program_space
;
4249 sal
.section
= MSYMBOL_OBJ_SECTION (objfile
, msymbol
);
4251 if (maybe_add_address (self
->addr_set
, objfile
->pspace
, sal
.pc
))
4252 add_sal_to_sals (self
, result
, &sal
, msymbol
->natural_name (), 0);
4255 /* Helper for search_minsyms_for_name that adds the symbol to the
4259 add_minsym (struct minimal_symbol
*minsym
, struct objfile
*objfile
,
4260 struct symtab
*symtab
, int list_mode
,
4261 std::vector
<struct bound_minimal_symbol
> *msyms
)
4265 /* We're looking for a label for which we don't have debug
4267 CORE_ADDR func_addr
;
4268 if (msymbol_is_function (objfile
, minsym
, &func_addr
))
4270 symtab_and_line sal
= find_pc_sect_line (func_addr
, NULL
, 0);
4272 if (symtab
!= sal
.symtab
)
4277 /* Exclude data symbols when looking for breakpoint locations. */
4278 if (!list_mode
&& !msymbol_is_function (objfile
, minsym
))
4281 struct bound_minimal_symbol mo
= {minsym
, objfile
};
4282 msyms
->push_back (mo
);
4286 /* Search for minimal symbols called NAME. If SEARCH_PSPACE
4287 is not NULL, the search is restricted to just that program
4290 If SYMTAB is NULL, search all objfiles, otherwise
4291 restrict results to the given SYMTAB. */
4294 search_minsyms_for_name (struct collect_info
*info
,
4295 const lookup_name_info
&name
,
4296 struct program_space
*search_pspace
,
4297 struct symtab
*symtab
)
4299 std::vector
<struct bound_minimal_symbol
> minsyms
;
4303 for (struct program_space
*pspace
: program_spaces
)
4305 if (search_pspace
!= NULL
&& search_pspace
!= pspace
)
4307 if (pspace
->executing_startup
)
4310 set_current_program_space (pspace
);
4312 for (objfile
*objfile
: current_program_space
->objfiles ())
4314 iterate_over_minimal_symbols (objfile
, name
,
4315 [&] (struct minimal_symbol
*msym
)
4317 add_minsym (msym
, objfile
, nullptr,
4318 info
->state
->list_mode
,
4327 if (search_pspace
== NULL
|| SYMTAB_PSPACE (symtab
) == search_pspace
)
4329 set_current_program_space (SYMTAB_PSPACE (symtab
));
4330 iterate_over_minimal_symbols
4331 (SYMTAB_OBJFILE (symtab
), name
,
4332 [&] (struct minimal_symbol
*msym
)
4334 add_minsym (msym
, SYMTAB_OBJFILE (symtab
), symtab
,
4335 info
->state
->list_mode
, &minsyms
);
4341 /* Return true if TYPE is a static symbol. */
4342 auto msymbol_type_is_static
= [] (enum minimal_symbol_type type
)
4355 /* Add minsyms to the result set, but filter out trampoline symbols
4356 if we also found extern symbols with the same name. I.e., don't
4357 set a breakpoint on both '<foo@plt>' and 'foo', assuming that
4358 'foo' is the symbol that the plt resolves to. */
4359 for (const bound_minimal_symbol
&item
: minsyms
)
4362 if (MSYMBOL_TYPE (item
.minsym
) == mst_solib_trampoline
)
4364 for (const bound_minimal_symbol
&item2
: minsyms
)
4366 if (&item2
== &item
)
4369 /* Trampoline symbols can only jump to exported
4371 if (msymbol_type_is_static (MSYMBOL_TYPE (item2
.minsym
)))
4374 if (strcmp (item
.minsym
->linkage_name (),
4375 item2
.minsym
->linkage_name ()) != 0)
4378 /* Found a global minsym with the same name as the
4379 trampoline. Don't create a location for this
4387 info
->result
.minimal_symbols
->push_back (item
);
4391 /* A helper function to add all symbols matching NAME to INFO. If
4392 PSPACE is not NULL, the search is restricted to just that program
4396 add_matching_symbols_to_info (const char *name
,
4397 symbol_name_match_type name_match_type
,
4398 enum search_domain search_domain
,
4399 struct collect_info
*info
,
4400 struct program_space
*pspace
)
4402 lookup_name_info
lookup_name (name
, name_match_type
);
4404 for (const auto &elt
: *info
->file_symtabs
)
4408 iterate_over_all_matching_symtabs (info
->state
, lookup_name
,
4409 VAR_DOMAIN
, search_domain
,
4411 [&] (block_symbol
*bsym
)
4412 { return info
->add_symbol (bsym
); });
4413 search_minsyms_for_name (info
, lookup_name
, pspace
, NULL
);
4415 else if (pspace
== NULL
|| pspace
== SYMTAB_PSPACE (elt
))
4417 int prev_len
= info
->result
.symbols
->size ();
4419 /* Program spaces that are executing startup should have
4420 been filtered out earlier. */
4421 gdb_assert (!SYMTAB_PSPACE (elt
)->executing_startup
);
4422 set_current_program_space (SYMTAB_PSPACE (elt
));
4423 iterate_over_file_blocks (elt
, lookup_name
, VAR_DOMAIN
,
4424 [&] (block_symbol
*bsym
)
4425 { return info
->add_symbol (bsym
); });
4427 /* If no new symbols were found in this iteration and this symtab
4428 is in assembler, we might actually be looking for a label for
4429 which we don't have debug info. Check for a minimal symbol in
4431 if (prev_len
== info
->result
.symbols
->size ()
4432 && elt
->language
== language_asm
)
4433 search_minsyms_for_name (info
, lookup_name
, pspace
, elt
);
4440 /* Now come some functions that are called from multiple places within
4444 symbol_to_sal (struct symtab_and_line
*result
,
4445 int funfirstline
, struct symbol
*sym
)
4447 if (SYMBOL_CLASS (sym
) == LOC_BLOCK
)
4449 *result
= find_function_start_sal (sym
, funfirstline
);
4454 if (SYMBOL_CLASS (sym
) == LOC_LABEL
&& SYMBOL_VALUE_ADDRESS (sym
) != 0)
4457 result
->symtab
= symbol_symtab (sym
);
4458 result
->symbol
= sym
;
4459 result
->line
= SYMBOL_LINE (sym
);
4460 result
->pc
= SYMBOL_VALUE_ADDRESS (sym
);
4461 result
->pspace
= SYMTAB_PSPACE (result
->symtab
);
4462 result
->explicit_pc
= 1;
4465 else if (funfirstline
)
4469 else if (SYMBOL_LINE (sym
) != 0)
4471 /* We know its line number. */
4473 result
->symtab
= symbol_symtab (sym
);
4474 result
->symbol
= sym
;
4475 result
->line
= SYMBOL_LINE (sym
);
4476 result
->pc
= SYMBOL_VALUE_ADDRESS (sym
);
4477 result
->pspace
= SYMTAB_PSPACE (result
->symtab
);
4485 linespec_result::~linespec_result ()
4487 for (linespec_sals
&lsal
: lsals
)
4488 xfree (lsal
.canonical
);
4491 /* Return the quote characters permitted by the linespec parser. */
4494 get_gdb_linespec_parser_quote_characters (void)
4496 return linespec_quote_characters
;