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 */
263 struct linespec_token
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
;
279 #define LS_TOKEN_STOKEN(TOK) (TOK).data.string
280 #define LS_TOKEN_KEYWORD(TOK) (TOK).data.keyword
282 /* An instance of the linespec parser. */
284 struct linespec_parser
286 linespec_parser (int flags
, const struct language_defn
*language
,
287 struct program_space
*search_pspace
,
288 struct symtab
*default_symtab
,
290 struct linespec_result
*canonical
);
294 DISABLE_COPY_AND_ASSIGN (linespec_parser
);
296 /* Lexer internal data */
299 /* Save head of input stream. */
300 const char *saved_arg
;
302 /* Head of the input stream. */
304 #define PARSER_STREAM(P) ((P)->lexer.stream)
306 /* The current token. */
307 linespec_token current
;
310 /* Is the entire linespec quote-enclosed? */
311 int is_quote_enclosed
= 0;
313 /* The state of the parse. */
314 struct linespec_state state
{};
315 #define PARSER_STATE(PPTR) (&(PPTR)->state)
317 /* The result of the parse. */
318 struct linespec result
{};
319 #define PARSER_RESULT(PPTR) (&(PPTR)->result)
321 /* What the parser believes the current word point should complete
323 linespec_complete_what complete_what
= linespec_complete_what::NOTHING
;
325 /* The completion word point. The parser advances this as it skips
326 tokens. At some point the input string will end or parsing will
327 fail, and then we attempt completion at the captured completion
328 word point, interpreting the string at completion_word as
330 const char *completion_word
= nullptr;
332 /* If the current token was a quoted string, then this is the
333 quoting character (either " or '). */
334 int completion_quote_char
= 0;
336 /* If the current token was a quoted string, then this points at the
337 end of the quoted string. */
338 const char *completion_quote_end
= nullptr;
340 /* If parsing for completion, then this points at the completion
341 tracker. Otherwise, this is NULL. */
342 struct completion_tracker
*completion_tracker
= nullptr;
345 /* A convenience macro for accessing the explicit location result of
347 #define PARSER_EXPLICIT(PPTR) (&PARSER_RESULT ((PPTR))->explicit_loc)
349 /* Prototypes for local functions. */
351 static void iterate_over_file_blocks
352 (struct symtab
*symtab
, const lookup_name_info
&name
,
354 gdb::function_view
<symbol_found_callback_ftype
> callback
);
356 static void initialize_defaults (struct symtab
**default_symtab
,
359 CORE_ADDR
linespec_expression_to_pc (const char **exp_ptr
);
361 static std::vector
<symtab_and_line
> decode_objc (struct linespec_state
*self
,
365 static std::vector
<symtab
*> symtabs_from_filename
366 (const char *, struct program_space
*pspace
);
368 static std::vector
<block_symbol
> *find_label_symbols
369 (struct linespec_state
*self
, std::vector
<block_symbol
> *function_symbols
,
370 std::vector
<block_symbol
> *label_funcs_ret
, const char *name
,
371 bool completion_mode
= false);
373 static void find_linespec_symbols (struct linespec_state
*self
,
374 std::vector
<symtab
*> *file_symtabs
,
376 symbol_name_match_type name_match_type
,
377 std::vector
<block_symbol
> *symbols
,
378 std::vector
<bound_minimal_symbol
> *minsyms
);
380 static struct line_offset
381 linespec_parse_variable (struct linespec_state
*self
,
382 const char *variable
);
384 static int symbol_to_sal (struct symtab_and_line
*result
,
385 int funfirstline
, struct symbol
*sym
);
387 static void add_matching_symbols_to_info (const char *name
,
388 symbol_name_match_type name_match_type
,
389 enum search_domain search_domain
,
390 struct collect_info
*info
,
391 struct program_space
*pspace
);
393 static void add_all_symbol_names_from_pspace
394 (struct collect_info
*info
, struct program_space
*pspace
,
395 const std::vector
<const char *> &names
, enum search_domain search_domain
);
397 static std::vector
<symtab
*>
398 collect_symtabs_from_filename (const char *file
,
399 struct program_space
*pspace
);
401 static std::vector
<symtab_and_line
> decode_digits_ordinary
402 (struct linespec_state
*self
,
405 linetable_entry
**best_entry
);
407 static std::vector
<symtab_and_line
> decode_digits_list_mode
408 (struct linespec_state
*self
,
410 struct symtab_and_line val
);
412 static void minsym_found (struct linespec_state
*self
, struct objfile
*objfile
,
413 struct minimal_symbol
*msymbol
,
414 std::vector
<symtab_and_line
> *result
);
416 static bool compare_symbols (const block_symbol
&a
, const block_symbol
&b
);
418 static bool compare_msymbols (const bound_minimal_symbol
&a
,
419 const bound_minimal_symbol
&b
);
421 /* Permitted quote characters for the parser. This is different from the
422 completer's quote characters to allow backward compatibility with the
424 static const char linespec_quote_characters
[] = "\"\'";
426 /* Lexer functions. */
428 /* Lex a number from the input in PARSER. This only supports
431 Return true if input is decimal numbers. Return false if not. */
434 linespec_lexer_lex_number (linespec_parser
*parser
, linespec_token
*tokenp
)
436 tokenp
->type
= LSTOKEN_NUMBER
;
437 LS_TOKEN_STOKEN (*tokenp
).length
= 0;
438 LS_TOKEN_STOKEN (*tokenp
).ptr
= PARSER_STREAM (parser
);
440 /* Keep any sign at the start of the stream. */
441 if (*PARSER_STREAM (parser
) == '+' || *PARSER_STREAM (parser
) == '-')
443 ++LS_TOKEN_STOKEN (*tokenp
).length
;
444 ++(PARSER_STREAM (parser
));
447 while (isdigit (*PARSER_STREAM (parser
)))
449 ++LS_TOKEN_STOKEN (*tokenp
).length
;
450 ++(PARSER_STREAM (parser
));
453 /* If the next character in the input buffer is not a space, comma,
454 quote, or colon, this input does not represent a number. */
455 if (*PARSER_STREAM (parser
) != '\0'
456 && !isspace (*PARSER_STREAM (parser
)) && *PARSER_STREAM (parser
) != ','
457 && *PARSER_STREAM (parser
) != ':'
458 && !strchr (linespec_quote_characters
, *PARSER_STREAM (parser
)))
460 PARSER_STREAM (parser
) = LS_TOKEN_STOKEN (*tokenp
).ptr
;
467 /* See linespec.h. */
470 linespec_lexer_lex_keyword (const char *p
)
476 for (i
= 0; linespec_keywords
[i
] != NULL
; ++i
)
478 int len
= strlen (linespec_keywords
[i
]);
480 /* If P begins with one of the keywords and the next
481 character is whitespace, we may have found a keyword.
482 It is only a keyword if it is not followed by another
484 if (strncmp (p
, linespec_keywords
[i
], len
) == 0
489 /* Special case: "-force" is always followed by an "if". */
490 if (i
== FORCE_KEYWORD_INDEX
)
494 int nextlen
= strlen (linespec_keywords
[IF_KEYWORD_INDEX
]);
495 if (!(strncmp (p
, linespec_keywords
[IF_KEYWORD_INDEX
], nextlen
) == 0
496 && isspace (p
[nextlen
])))
500 /* Special case: "if" ALWAYS stops the lexer, since it
501 is not possible to predict what is going to appear in
502 the condition, which can only be parsed after SaLs have
504 else if (i
!= IF_KEYWORD_INDEX
)
508 for (j
= 0; linespec_keywords
[j
] != NULL
; ++j
)
510 int nextlen
= strlen (linespec_keywords
[j
]);
512 if (strncmp (p
, linespec_keywords
[j
], nextlen
) == 0
513 && isspace (p
[nextlen
]))
518 return linespec_keywords
[i
];
526 /* See description in linespec.h. */
529 is_ada_operator (const char *string
)
531 const struct ada_opname_map
*mapping
;
533 for (mapping
= ada_opname_table
;
534 mapping
->encoded
!= NULL
535 && !startswith (string
, mapping
->decoded
); ++mapping
)
538 return mapping
->decoded
== NULL
? 0 : strlen (mapping
->decoded
);
541 /* Find QUOTE_CHAR in STRING, accounting for the ':' terminal. Return
542 the location of QUOTE_CHAR, or NULL if not found. */
545 skip_quote_char (const char *string
, char quote_char
)
547 const char *p
, *last
;
549 p
= last
= find_toplevel_char (string
, quote_char
);
550 while (p
&& *p
!= '\0' && *p
!= ':')
552 p
= find_toplevel_char (p
, quote_char
);
560 /* Make a writable copy of the string given in TOKEN, trimming
561 any trailing whitespace. */
563 static gdb::unique_xmalloc_ptr
<char>
564 copy_token_string (linespec_token token
)
568 if (token
.type
== LSTOKEN_KEYWORD
)
569 return make_unique_xstrdup (LS_TOKEN_KEYWORD (token
));
571 str
= LS_TOKEN_STOKEN (token
).ptr
;
572 s
= remove_trailing_whitespace (str
, str
+ LS_TOKEN_STOKEN (token
).length
);
574 return gdb::unique_xmalloc_ptr
<char> (savestring (str
, s
- str
));
577 /* Does P represent the end of a quote-enclosed linespec? */
580 is_closing_quote_enclosed (const char *p
)
582 if (strchr (linespec_quote_characters
, *p
))
584 p
= skip_spaces ((char *) p
);
585 return (*p
== '\0' || linespec_lexer_lex_keyword (p
));
588 /* Find the end of the parameter list that starts with *INPUT.
589 This helper function assists with lexing string segments
590 which might contain valid (non-terminating) commas. */
593 find_parameter_list_end (const char *input
)
595 char end_char
, start_char
;
600 if (start_char
== '(')
602 else if (start_char
== '<')
611 if (*p
== start_char
)
613 else if (*p
== end_char
)
627 /* If the [STRING, STRING_LEN) string ends with what looks like a
628 keyword, return the keyword start offset in STRING. Return -1
632 string_find_incomplete_keyword_at_end (const char * const *keywords
,
633 const char *string
, size_t string_len
)
635 const char *end
= string
+ string_len
;
638 while (p
> string
&& *p
!= ' ')
643 size_t len
= end
- p
;
644 for (size_t i
= 0; keywords
[i
] != NULL
; ++i
)
645 if (strncmp (keywords
[i
], p
, len
) == 0)
652 /* Lex a string from the input in PARSER. */
654 static linespec_token
655 linespec_lexer_lex_string (linespec_parser
*parser
)
657 linespec_token token
;
658 const char *start
= PARSER_STREAM (parser
);
660 token
.type
= LSTOKEN_STRING
;
662 /* If the input stream starts with a quote character, skip to the next
663 quote character, regardless of the content. */
664 if (strchr (linespec_quote_characters
, *PARSER_STREAM (parser
)))
667 char quote_char
= *PARSER_STREAM (parser
);
669 /* Special case: Ada operators. */
670 if (PARSER_STATE (parser
)->language
->la_language
== language_ada
671 && quote_char
== '\"')
673 int len
= is_ada_operator (PARSER_STREAM (parser
));
677 /* The input is an Ada operator. Return the quoted string
679 LS_TOKEN_STOKEN (token
).ptr
= PARSER_STREAM (parser
);
680 LS_TOKEN_STOKEN (token
).length
= len
;
681 PARSER_STREAM (parser
) += len
;
685 /* The input does not represent an Ada operator -- fall through
686 to normal quoted string handling. */
689 /* Skip past the beginning quote. */
690 ++(PARSER_STREAM (parser
));
692 /* Mark the start of the string. */
693 LS_TOKEN_STOKEN (token
).ptr
= PARSER_STREAM (parser
);
695 /* Skip to the ending quote. */
696 end
= skip_quote_char (PARSER_STREAM (parser
), quote_char
);
698 /* This helps the completer mode decide whether we have a
700 parser
->completion_quote_char
= quote_char
;
701 parser
->completion_quote_end
= end
;
703 /* Error if the input did not terminate properly, unless in
707 if (parser
->completion_tracker
== NULL
)
708 error (_("unmatched quote"));
710 /* In completion mode, we'll try to complete the incomplete
712 token
.type
= LSTOKEN_STRING
;
713 while (*PARSER_STREAM (parser
) != '\0')
714 PARSER_STREAM (parser
)++;
715 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - 1 - start
;
719 /* Skip over the ending quote and mark the length of the string. */
720 PARSER_STREAM (parser
) = (char *) ++end
;
721 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - 2 - start
;
728 /* Otherwise, only identifier characters are permitted.
729 Spaces are the exception. In general, we keep spaces,
730 but only if the next characters in the input do not resolve
731 to one of the keywords.
733 This allows users to forgo quoting CV-qualifiers, template arguments,
734 and similar common language constructs. */
738 if (isspace (*PARSER_STREAM (parser
)))
740 p
= skip_spaces (PARSER_STREAM (parser
));
741 /* When we get here we know we've found something followed by
742 a space (we skip over parens and templates below).
743 So if we find a keyword now, we know it is a keyword and not,
744 say, a function name. */
745 if (linespec_lexer_lex_keyword (p
) != NULL
)
747 LS_TOKEN_STOKEN (token
).ptr
= start
;
748 LS_TOKEN_STOKEN (token
).length
749 = PARSER_STREAM (parser
) - start
;
753 /* Advance past the whitespace. */
754 PARSER_STREAM (parser
) = p
;
757 /* If the next character is EOI or (single) ':', the
758 string is complete; return the token. */
759 if (*PARSER_STREAM (parser
) == 0)
761 LS_TOKEN_STOKEN (token
).ptr
= start
;
762 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - start
;
765 else if (PARSER_STREAM (parser
)[0] == ':')
767 /* Do not tokenize the C++ scope operator. */
768 if (PARSER_STREAM (parser
)[1] == ':')
769 ++(PARSER_STREAM (parser
));
771 /* Do not tokenize ABI tags such as "[abi:cxx11]". */
772 else if (PARSER_STREAM (parser
) - start
> 4
773 && startswith (PARSER_STREAM (parser
) - 4, "[abi"))
778 /* Do not tokenify if the input length so far is one
779 (i.e, a single-letter drive name) and the next character
780 is a directory separator. This allows Windows-style
781 paths to be recognized as filenames without quoting it. */
782 else if ((PARSER_STREAM (parser
) - start
) != 1
783 || !IS_DIR_SEPARATOR (PARSER_STREAM (parser
)[1]))
785 LS_TOKEN_STOKEN (token
).ptr
= start
;
786 LS_TOKEN_STOKEN (token
).length
787 = PARSER_STREAM (parser
) - start
;
791 /* Special case: permit quote-enclosed linespecs. */
792 else if (parser
->is_quote_enclosed
793 && strchr (linespec_quote_characters
,
794 *PARSER_STREAM (parser
))
795 && is_closing_quote_enclosed (PARSER_STREAM (parser
)))
797 LS_TOKEN_STOKEN (token
).ptr
= start
;
798 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - start
;
801 /* Because commas may terminate a linespec and appear in
802 the middle of valid string input, special cases for
803 '<' and '(' are necessary. */
804 else if (*PARSER_STREAM (parser
) == '<'
805 || *PARSER_STREAM (parser
) == '(')
807 /* Don't interpret 'operator<' / 'operator<<' as a
808 template parameter list though. */
809 if (*PARSER_STREAM (parser
) == '<'
810 && (PARSER_STATE (parser
)->language
->la_language
812 && (PARSER_STREAM (parser
) - start
) >= CP_OPERATOR_LEN
)
814 const char *op
= PARSER_STREAM (parser
);
816 while (op
> start
&& isspace (op
[-1]))
818 if (op
- start
>= CP_OPERATOR_LEN
)
820 op
-= CP_OPERATOR_LEN
;
821 if (strncmp (op
, CP_OPERATOR_STR
, CP_OPERATOR_LEN
) == 0
823 || !(isalnum (op
[-1]) || op
[-1] == '_')))
825 /* This is an operator name. Keep going. */
826 ++(PARSER_STREAM (parser
));
827 if (*PARSER_STREAM (parser
) == '<')
828 ++(PARSER_STREAM (parser
));
834 const char *end
= find_parameter_list_end (PARSER_STREAM (parser
));
835 PARSER_STREAM (parser
) = end
;
837 /* Don't loop around to the normal \0 case above because
838 we don't want to misinterpret a potential keyword at
839 the end of the token when the string isn't
840 "()<>"-balanced. This handles "b
841 function(thread<tab>" in completion mode. */
844 LS_TOKEN_STOKEN (token
).ptr
= start
;
845 LS_TOKEN_STOKEN (token
).length
846 = PARSER_STREAM (parser
) - start
;
852 /* Commas are terminators, but not if they are part of an
854 else if (*PARSER_STREAM (parser
) == ',')
856 if ((PARSER_STATE (parser
)->language
->la_language
858 && (PARSER_STREAM (parser
) - start
) > CP_OPERATOR_LEN
)
860 const char *op
= strstr (start
, CP_OPERATOR_STR
);
862 if (op
!= NULL
&& is_operator_name (op
))
864 /* This is an operator name. Keep going. */
865 ++(PARSER_STREAM (parser
));
870 /* Comma terminates the string. */
871 LS_TOKEN_STOKEN (token
).ptr
= start
;
872 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - start
;
876 /* Advance the stream. */
877 gdb_assert (*(PARSER_STREAM (parser
)) != '\0');
878 ++(PARSER_STREAM (parser
));
885 /* Lex a single linespec token from PARSER. */
887 static linespec_token
888 linespec_lexer_lex_one (linespec_parser
*parser
)
892 if (parser
->lexer
.current
.type
== LSTOKEN_CONSUMED
)
894 /* Skip any whitespace. */
895 PARSER_STREAM (parser
) = skip_spaces (PARSER_STREAM (parser
));
897 /* Check for a keyword, they end the linespec. */
898 keyword
= linespec_lexer_lex_keyword (PARSER_STREAM (parser
));
901 parser
->lexer
.current
.type
= LSTOKEN_KEYWORD
;
902 LS_TOKEN_KEYWORD (parser
->lexer
.current
) = keyword
;
903 /* We do not advance the stream here intentionally:
904 we would like lexing to stop when a keyword is seen.
906 PARSER_STREAM (parser) += strlen (keyword); */
908 return parser
->lexer
.current
;
911 /* Handle other tokens. */
912 switch (*PARSER_STREAM (parser
))
915 parser
->lexer
.current
.type
= LSTOKEN_EOI
;
919 case '0': case '1': case '2': case '3': case '4':
920 case '5': case '6': case '7': case '8': case '9':
921 if (!linespec_lexer_lex_number (parser
, &(parser
->lexer
.current
)))
922 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
926 /* If we have a scope operator, lex the input as a string.
927 Otherwise, return LSTOKEN_COLON. */
928 if (PARSER_STREAM (parser
)[1] == ':')
929 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
932 parser
->lexer
.current
.type
= LSTOKEN_COLON
;
933 ++(PARSER_STREAM (parser
));
937 case '\'': case '\"':
938 /* Special case: permit quote-enclosed linespecs. */
939 if (parser
->is_quote_enclosed
940 && is_closing_quote_enclosed (PARSER_STREAM (parser
)))
942 ++(PARSER_STREAM (parser
));
943 parser
->lexer
.current
.type
= LSTOKEN_EOI
;
946 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
950 parser
->lexer
.current
.type
= LSTOKEN_COMMA
;
951 LS_TOKEN_STOKEN (parser
->lexer
.current
).ptr
952 = PARSER_STREAM (parser
);
953 LS_TOKEN_STOKEN (parser
->lexer
.current
).length
= 1;
954 ++(PARSER_STREAM (parser
));
958 /* If the input is not a number, it must be a string.
959 [Keywords were already considered above.] */
960 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
965 return parser
->lexer
.current
;
968 /* Consume the current token and return the next token in PARSER's
969 input stream. Also advance the completion word for completion
972 static linespec_token
973 linespec_lexer_consume_token (linespec_parser
*parser
)
975 gdb_assert (parser
->lexer
.current
.type
!= LSTOKEN_EOI
);
977 bool advance_word
= (parser
->lexer
.current
.type
!= LSTOKEN_STRING
978 || *PARSER_STREAM (parser
) != '\0');
980 /* If we're moving past a string to some other token, it must be the
981 quote was terminated. */
982 if (parser
->completion_quote_char
)
984 gdb_assert (parser
->lexer
.current
.type
== LSTOKEN_STRING
);
986 /* If the string was the last (non-EOI) token, we're past the
987 quote, but remember that for later. */
988 if (*PARSER_STREAM (parser
) != '\0')
990 parser
->completion_quote_char
= '\0';
991 parser
->completion_quote_end
= NULL
;;
995 parser
->lexer
.current
.type
= LSTOKEN_CONSUMED
;
996 linespec_lexer_lex_one (parser
);
998 if (parser
->lexer
.current
.type
== LSTOKEN_STRING
)
1000 /* Advance the completion word past a potential initial
1002 parser
->completion_word
= LS_TOKEN_STOKEN (parser
->lexer
.current
).ptr
;
1004 else if (advance_word
)
1006 /* Advance the completion word past any whitespace. */
1007 parser
->completion_word
= PARSER_STREAM (parser
);
1010 return parser
->lexer
.current
;
1013 /* Return the next token without consuming the current token. */
1015 static linespec_token
1016 linespec_lexer_peek_token (linespec_parser
*parser
)
1018 linespec_token next
;
1019 const char *saved_stream
= PARSER_STREAM (parser
);
1020 linespec_token saved_token
= parser
->lexer
.current
;
1021 int saved_completion_quote_char
= parser
->completion_quote_char
;
1022 const char *saved_completion_quote_end
= parser
->completion_quote_end
;
1023 const char *saved_completion_word
= parser
->completion_word
;
1025 next
= linespec_lexer_consume_token (parser
);
1026 PARSER_STREAM (parser
) = saved_stream
;
1027 parser
->lexer
.current
= saved_token
;
1028 parser
->completion_quote_char
= saved_completion_quote_char
;
1029 parser
->completion_quote_end
= saved_completion_quote_end
;
1030 parser
->completion_word
= saved_completion_word
;
1034 /* Helper functions. */
1036 /* Add SAL to SALS, and also update SELF->CANONICAL_NAMES to reflect
1037 the new sal, if needed. If not NULL, SYMNAME is the name of the
1038 symbol to use when constructing the new canonical name.
1040 If LITERAL_CANONICAL is non-zero, SYMNAME will be used as the
1041 canonical name for the SAL. */
1044 add_sal_to_sals (struct linespec_state
*self
,
1045 std::vector
<symtab_and_line
> *sals
,
1046 struct symtab_and_line
*sal
,
1047 const char *symname
, int literal_canonical
)
1049 sals
->push_back (*sal
);
1051 if (self
->canonical
)
1053 struct linespec_canonical_name
*canonical
;
1055 self
->canonical_names
= XRESIZEVEC (struct linespec_canonical_name
,
1056 self
->canonical_names
,
1058 canonical
= &self
->canonical_names
[sals
->size () - 1];
1059 if (!literal_canonical
&& sal
->symtab
)
1061 symtab_to_fullname (sal
->symtab
);
1063 /* Note that the filter doesn't have to be a valid linespec
1064 input. We only apply the ":LINE" treatment to Ada for
1066 if (symname
!= NULL
&& sal
->line
!= 0
1067 && self
->language
->la_language
== language_ada
)
1068 canonical
->suffix
= xstrprintf ("%s:%d", symname
, sal
->line
);
1069 else if (symname
!= NULL
)
1070 canonical
->suffix
= xstrdup (symname
);
1072 canonical
->suffix
= xstrprintf ("%d", sal
->line
);
1073 canonical
->symtab
= sal
->symtab
;
1077 if (symname
!= NULL
)
1078 canonical
->suffix
= xstrdup (symname
);
1080 canonical
->suffix
= xstrdup ("<unknown>");
1081 canonical
->symtab
= NULL
;
1086 /* A hash function for address_entry. */
1089 hash_address_entry (const void *p
)
1091 const struct address_entry
*aep
= (const struct address_entry
*) p
;
1094 hash
= iterative_hash_object (aep
->pspace
, 0);
1095 return iterative_hash_object (aep
->addr
, hash
);
1098 /* An equality function for address_entry. */
1101 eq_address_entry (const void *a
, const void *b
)
1103 const struct address_entry
*aea
= (const struct address_entry
*) a
;
1104 const struct address_entry
*aeb
= (const struct address_entry
*) b
;
1106 return aea
->pspace
== aeb
->pspace
&& aea
->addr
== aeb
->addr
;
1109 /* Check whether the address, represented by PSPACE and ADDR, is
1110 already in the set. If so, return 0. Otherwise, add it and return
1114 maybe_add_address (htab_t set
, struct program_space
*pspace
, CORE_ADDR addr
)
1116 struct address_entry e
, *p
;
1121 slot
= htab_find_slot (set
, &e
, INSERT
);
1125 p
= XNEW (struct address_entry
);
1126 memcpy (p
, &e
, sizeof (struct address_entry
));
1132 /* A helper that walks over all matching symtabs in all objfiles and
1133 calls CALLBACK for each symbol matching NAME. If SEARCH_PSPACE is
1134 not NULL, then the search is restricted to just that program
1135 space. If INCLUDE_INLINE is true then symbols representing
1136 inlined instances of functions will be included in the result. */
1139 iterate_over_all_matching_symtabs
1140 (struct linespec_state
*state
,
1141 const lookup_name_info
&lookup_name
,
1142 const domain_enum name_domain
,
1143 enum search_domain search_domain
,
1144 struct program_space
*search_pspace
, bool include_inline
,
1145 gdb::function_view
<symbol_found_callback_ftype
> callback
)
1147 for (struct program_space
*pspace
: program_spaces
)
1149 if (search_pspace
!= NULL
&& search_pspace
!= pspace
)
1151 if (pspace
->executing_startup
)
1154 set_current_program_space (pspace
);
1156 for (objfile
*objfile
: current_program_space
->objfiles ())
1159 objfile
->sf
->qf
->expand_symtabs_matching (objfile
,
1165 for (compunit_symtab
*cu
: objfile
->compunits ())
1167 struct symtab
*symtab
= COMPUNIT_FILETABS (cu
);
1169 iterate_over_file_blocks (symtab
, lookup_name
, name_domain
,
1174 const struct block
*block
;
1177 for (i
= FIRST_LOCAL_BLOCK
;
1178 i
< BLOCKVECTOR_NBLOCKS (SYMTAB_BLOCKVECTOR (symtab
));
1181 block
= BLOCKVECTOR_BLOCK (SYMTAB_BLOCKVECTOR (symtab
), i
);
1182 state
->language
->iterate_over_symbols
1183 (block
, lookup_name
, name_domain
,
1184 [&] (block_symbol
*bsym
)
1186 /* Restrict calls to CALLBACK to symbols
1187 representing inline symbols only. */
1188 if (SYMBOL_INLINED (bsym
->symbol
))
1189 return callback (bsym
);
1199 /* Returns the block to be used for symbol searches from
1200 the current location. */
1202 static const struct block
*
1203 get_current_search_block (void)
1205 /* get_selected_block can change the current language when there is
1206 no selected frame yet. */
1207 scoped_restore_current_language save_language
;
1208 return get_selected_block (0);
1211 /* Iterate over static and global blocks. */
1214 iterate_over_file_blocks
1215 (struct symtab
*symtab
, const lookup_name_info
&name
,
1216 domain_enum domain
, gdb::function_view
<symbol_found_callback_ftype
> callback
)
1218 const struct block
*block
;
1220 for (block
= BLOCKVECTOR_BLOCK (SYMTAB_BLOCKVECTOR (symtab
), STATIC_BLOCK
);
1222 block
= BLOCK_SUPERBLOCK (block
))
1223 current_language
->iterate_over_symbols (block
, name
, domain
, callback
);
1226 /* A helper for find_method. This finds all methods in type T of
1227 language T_LANG which match NAME. It adds matching symbol names to
1228 RESULT_NAMES, and adds T's direct superclasses to SUPERCLASSES. */
1231 find_methods (struct type
*t
, enum language t_lang
, const char *name
,
1232 std::vector
<const char *> *result_names
,
1233 std::vector
<struct type
*> *superclasses
)
1236 const char *class_name
= t
->name ();
1238 /* Ignore this class if it doesn't have a name. This is ugly, but
1239 unless we figure out how to get the physname without the name of
1240 the class, then the loop can't do any good. */
1244 lookup_name_info
lookup_name (name
, symbol_name_match_type::FULL
);
1245 symbol_name_matcher_ftype
*symbol_name_compare
1246 = language_def (t_lang
)->get_symbol_name_matcher (lookup_name
);
1248 t
= check_typedef (t
);
1250 /* Loop over each method name. At this level, all overloads of a name
1251 are counted as a single name. There is an inner loop which loops over
1254 for (method_counter
= TYPE_NFN_FIELDS (t
) - 1;
1255 method_counter
>= 0;
1258 const char *method_name
= TYPE_FN_FIELDLIST_NAME (t
, method_counter
);
1260 if (symbol_name_compare (method_name
, lookup_name
, NULL
))
1264 for (field_counter
= (TYPE_FN_FIELDLIST_LENGTH (t
, method_counter
)
1270 const char *phys_name
;
1272 f
= TYPE_FN_FIELDLIST1 (t
, method_counter
);
1273 if (TYPE_FN_FIELD_STUB (f
, field_counter
))
1275 phys_name
= TYPE_FN_FIELD_PHYSNAME (f
, field_counter
);
1276 result_names
->push_back (phys_name
);
1282 for (ibase
= 0; ibase
< TYPE_N_BASECLASSES (t
); ibase
++)
1283 superclasses
->push_back (TYPE_BASECLASS (t
, ibase
));
1286 /* Find an instance of the character C in the string S that is outside
1287 of all parenthesis pairs, single-quoted strings, and double-quoted
1288 strings. Also, ignore the char within a template name, like a ','
1289 within foo<int, int>, while considering C++ operator</operator<<. */
1292 find_toplevel_char (const char *s
, char c
)
1294 int quoted
= 0; /* zero if we're not in quotes;
1295 '"' if we're in a double-quoted string;
1296 '\'' if we're in a single-quoted string. */
1297 int depth
= 0; /* Number of unclosed parens we've seen. */
1300 for (scan
= s
; *scan
; scan
++)
1304 if (*scan
== quoted
)
1306 else if (*scan
== '\\' && *(scan
+ 1))
1309 else if (*scan
== c
&& ! quoted
&& depth
== 0)
1311 else if (*scan
== '"' || *scan
== '\'')
1313 else if (*scan
== '(' || *scan
== '<')
1315 else if ((*scan
== ')' || *scan
== '>') && depth
> 0)
1317 else if (*scan
== 'o' && !quoted
&& depth
== 0)
1319 /* Handle C++ operator names. */
1320 if (strncmp (scan
, CP_OPERATOR_STR
, CP_OPERATOR_LEN
) == 0)
1322 scan
+= CP_OPERATOR_LEN
;
1325 while (isspace (*scan
))
1336 /* Skip over one less than the appropriate number of
1337 characters: the for loop will skip over the last
1363 /* The string equivalent of find_toplevel_char. Returns a pointer
1364 to the location of NEEDLE in HAYSTACK, ignoring any occurrences
1365 inside "()" and "<>". Returns NULL if NEEDLE was not found. */
1368 find_toplevel_string (const char *haystack
, const char *needle
)
1370 const char *s
= haystack
;
1374 s
= find_toplevel_char (s
, *needle
);
1378 /* Found first char in HAYSTACK; check rest of string. */
1379 if (startswith (s
, needle
))
1382 /* Didn't find it; loop over HAYSTACK, looking for the next
1383 instance of the first character of NEEDLE. */
1387 while (s
!= NULL
&& *s
!= '\0');
1389 /* NEEDLE was not found in HAYSTACK. */
1393 /* Convert CANONICAL to its string representation using
1394 symtab_to_fullname for SYMTAB. */
1397 canonical_to_fullform (const struct linespec_canonical_name
*canonical
)
1399 if (canonical
->symtab
== NULL
)
1400 return canonical
->suffix
;
1402 return string_printf ("%s:%s", symtab_to_fullname (canonical
->symtab
),
1406 /* Given FILTERS, a list of canonical names, filter the sals in RESULT
1407 and store the result in SELF->CANONICAL. */
1410 filter_results (struct linespec_state
*self
,
1411 std::vector
<symtab_and_line
> *result
,
1412 const std::vector
<const char *> &filters
)
1414 for (const char *name
: filters
)
1418 for (size_t j
= 0; j
< result
->size (); ++j
)
1420 const struct linespec_canonical_name
*canonical
;
1422 canonical
= &self
->canonical_names
[j
];
1423 std::string fullform
= canonical_to_fullform (canonical
);
1425 if (name
== fullform
)
1426 lsal
.sals
.push_back ((*result
)[j
]);
1429 if (!lsal
.sals
.empty ())
1431 lsal
.canonical
= xstrdup (name
);
1432 self
->canonical
->lsals
.push_back (std::move (lsal
));
1436 self
->canonical
->pre_expanded
= 0;
1439 /* Store RESULT into SELF->CANONICAL. */
1442 convert_results_to_lsals (struct linespec_state
*self
,
1443 std::vector
<symtab_and_line
> *result
)
1445 struct linespec_sals lsal
;
1447 lsal
.canonical
= NULL
;
1448 lsal
.sals
= std::move (*result
);
1449 self
->canonical
->lsals
.push_back (std::move (lsal
));
1452 /* A structure that contains two string representations of a struct
1453 linespec_canonical_name:
1454 - one where the symtab's fullname is used;
1455 - one where the filename followed the "set filename-display"
1458 struct decode_line_2_item
1460 decode_line_2_item (std::string
&&fullform_
, std::string
&&displayform_
,
1462 : fullform (std::move (fullform_
)),
1463 displayform (std::move (displayform_
)),
1464 selected (selected_
)
1468 /* The form using symtab_to_fullname. */
1469 std::string fullform
;
1471 /* The form using symtab_to_filename_for_display. */
1472 std::string displayform
;
1474 /* Field is initialized to zero and it is set to one if the user
1475 requested breakpoint for this entry. */
1476 unsigned int selected
: 1;
1479 /* Helper for std::sort to sort decode_line_2_item entries by
1480 DISPLAYFORM and secondarily by FULLFORM. */
1483 decode_line_2_compare_items (const decode_line_2_item
&a
,
1484 const decode_line_2_item
&b
)
1486 if (a
.displayform
!= b
.displayform
)
1487 return a
.displayform
< b
.displayform
;
1488 return a
.fullform
< b
.fullform
;
1491 /* Handle multiple results in RESULT depending on SELECT_MODE. This
1492 will either return normally, throw an exception on multiple
1493 results, or present a menu to the user. On return, the SALS vector
1494 in SELF->CANONICAL is set up properly. */
1497 decode_line_2 (struct linespec_state
*self
,
1498 std::vector
<symtab_and_line
> *result
,
1499 const char *select_mode
)
1504 std::vector
<const char *> filters
;
1505 std::vector
<struct decode_line_2_item
> items
;
1507 gdb_assert (select_mode
!= multiple_symbols_all
);
1508 gdb_assert (self
->canonical
!= NULL
);
1509 gdb_assert (!result
->empty ());
1511 /* Prepare ITEMS array. */
1512 for (i
= 0; i
< result
->size (); ++i
)
1514 const struct linespec_canonical_name
*canonical
;
1515 std::string displayform
;
1517 canonical
= &self
->canonical_names
[i
];
1518 gdb_assert (canonical
->suffix
!= NULL
);
1520 std::string fullform
= canonical_to_fullform (canonical
);
1522 if (canonical
->symtab
== NULL
)
1523 displayform
= canonical
->suffix
;
1526 const char *fn_for_display
;
1528 fn_for_display
= symtab_to_filename_for_display (canonical
->symtab
);
1529 displayform
= string_printf ("%s:%s", fn_for_display
,
1533 items
.emplace_back (std::move (fullform
), std::move (displayform
),
1537 /* Sort the list of method names. */
1538 std::sort (items
.begin (), items
.end (), decode_line_2_compare_items
);
1540 /* Remove entries with the same FULLFORM. */
1541 items
.erase (std::unique (items
.begin (), items
.end (),
1542 [] (const struct decode_line_2_item
&a
,
1543 const struct decode_line_2_item
&b
)
1545 return a
.fullform
== b
.fullform
;
1549 if (select_mode
== multiple_symbols_cancel
&& items
.size () > 1)
1550 error (_("canceled because the command is ambiguous\n"
1551 "See set/show multiple-symbol."));
1553 if (select_mode
== multiple_symbols_all
|| items
.size () == 1)
1555 convert_results_to_lsals (self
, result
);
1559 printf_unfiltered (_("[0] cancel\n[1] all\n"));
1560 for (i
= 0; i
< items
.size (); i
++)
1561 printf_unfiltered ("[%d] %s\n", i
+ 2, items
[i
].displayform
.c_str ());
1563 prompt
= getenv ("PS2");
1568 args
= command_line_input (prompt
, "overload-choice");
1570 if (args
== 0 || *args
== 0)
1571 error_no_arg (_("one or more choice numbers"));
1573 number_or_range_parser
parser (args
);
1574 while (!parser
.finished ())
1576 int num
= parser
.get_number ();
1579 error (_("canceled"));
1582 /* We intentionally make this result in a single breakpoint,
1583 contrary to what older versions of gdb did. The
1584 rationale is that this lets a user get the
1585 multiple_symbols_all behavior even with the 'ask'
1586 setting; and he can get separate breakpoints by entering
1587 "2-57" at the query. */
1588 convert_results_to_lsals (self
, result
);
1593 if (num
>= items
.size ())
1594 printf_unfiltered (_("No choice number %d.\n"), num
);
1597 struct decode_line_2_item
*item
= &items
[num
];
1599 if (!item
->selected
)
1601 filters
.push_back (item
->fullform
.c_str ());
1606 printf_unfiltered (_("duplicate request for %d ignored.\n"),
1612 filter_results (self
, result
, filters
);
1617 /* The parser of linespec itself. */
1619 /* Throw an appropriate error when SYMBOL is not found (optionally in
1622 static void ATTRIBUTE_NORETURN
1623 symbol_not_found_error (const char *symbol
, const char *filename
)
1628 if (!have_full_symbols ()
1629 && !have_partial_symbols ()
1630 && !have_minimal_symbols ())
1631 throw_error (NOT_FOUND_ERROR
,
1632 _("No symbol table is loaded. Use the \"file\" command."));
1634 /* If SYMBOL starts with '$', the user attempted to either lookup
1635 a function/variable in his code starting with '$' or an internal
1636 variable of that name. Since we do not know which, be concise and
1637 explain both possibilities. */
1641 throw_error (NOT_FOUND_ERROR
,
1642 _("Undefined convenience variable or function \"%s\" "
1643 "not defined in \"%s\"."), symbol
, filename
);
1645 throw_error (NOT_FOUND_ERROR
,
1646 _("Undefined convenience variable or function \"%s\" "
1647 "not defined."), symbol
);
1652 throw_error (NOT_FOUND_ERROR
,
1653 _("Function \"%s\" not defined in \"%s\"."),
1656 throw_error (NOT_FOUND_ERROR
,
1657 _("Function \"%s\" not defined."), symbol
);
1661 /* Throw an appropriate error when an unexpected token is encountered
1664 static void ATTRIBUTE_NORETURN
1665 unexpected_linespec_error (linespec_parser
*parser
)
1667 linespec_token token
;
1668 static const char * token_type_strings
[]
1669 = {"keyword", "colon", "string", "number", "comma", "end of input"};
1671 /* Get the token that generated the error. */
1672 token
= linespec_lexer_lex_one (parser
);
1674 /* Finally, throw the error. */
1675 if (token
.type
== LSTOKEN_STRING
|| token
.type
== LSTOKEN_NUMBER
1676 || token
.type
== LSTOKEN_KEYWORD
)
1678 gdb::unique_xmalloc_ptr
<char> string
= copy_token_string (token
);
1679 throw_error (GENERIC_ERROR
,
1680 _("malformed linespec error: unexpected %s, \"%s\""),
1681 token_type_strings
[token
.type
], string
.get ());
1684 throw_error (GENERIC_ERROR
,
1685 _("malformed linespec error: unexpected %s"),
1686 token_type_strings
[token
.type
]);
1689 /* Throw an undefined label error. */
1691 static void ATTRIBUTE_NORETURN
1692 undefined_label_error (const char *function
, const char *label
)
1694 if (function
!= NULL
)
1695 throw_error (NOT_FOUND_ERROR
,
1696 _("No label \"%s\" defined in function \"%s\"."),
1699 throw_error (NOT_FOUND_ERROR
,
1700 _("No label \"%s\" defined in current function."),
1704 /* Throw a source file not found error. */
1706 static void ATTRIBUTE_NORETURN
1707 source_file_not_found_error (const char *name
)
1709 throw_error (NOT_FOUND_ERROR
, _("No source file named %s."), name
);
1712 /* Unless at EIO, save the current stream position as completion word
1713 point, and consume the next token. */
1715 static linespec_token
1716 save_stream_and_consume_token (linespec_parser
*parser
)
1718 if (linespec_lexer_peek_token (parser
).type
!= LSTOKEN_EOI
)
1719 parser
->completion_word
= PARSER_STREAM (parser
);
1720 return linespec_lexer_consume_token (parser
);
1723 /* See description in linespec.h. */
1726 linespec_parse_line_offset (const char *string
)
1728 const char *start
= string
;
1729 struct line_offset line_offset
= {0, LINE_OFFSET_NONE
};
1733 line_offset
.sign
= LINE_OFFSET_PLUS
;
1736 else if (*string
== '-')
1738 line_offset
.sign
= LINE_OFFSET_MINUS
;
1742 if (*string
!= '\0' && !isdigit (*string
))
1743 error (_("malformed line offset: \"%s\""), start
);
1745 /* Right now, we only allow base 10 for offsets. */
1746 line_offset
.offset
= atoi (string
);
1750 /* In completion mode, if the user is still typing the number, there's
1751 no possible completion to offer. But if there's already input past
1752 the number, setup to expect NEXT. */
1755 set_completion_after_number (linespec_parser
*parser
,
1756 linespec_complete_what next
)
1758 if (*PARSER_STREAM (parser
) == ' ')
1760 parser
->completion_word
= skip_spaces (PARSER_STREAM (parser
) + 1);
1761 parser
->complete_what
= next
;
1765 parser
->completion_word
= PARSER_STREAM (parser
);
1766 parser
->complete_what
= linespec_complete_what::NOTHING
;
1770 /* Parse the basic_spec in PARSER's input. */
1773 linespec_parse_basic (linespec_parser
*parser
)
1775 gdb::unique_xmalloc_ptr
<char> name
;
1776 linespec_token token
;
1777 std::vector
<block_symbol
> symbols
;
1778 std::vector
<block_symbol
> *labels
;
1779 std::vector
<bound_minimal_symbol
> minimal_symbols
;
1781 /* Get the next token. */
1782 token
= linespec_lexer_lex_one (parser
);
1784 /* If it is EOI or KEYWORD, issue an error. */
1785 if (token
.type
== LSTOKEN_KEYWORD
)
1787 parser
->complete_what
= linespec_complete_what::NOTHING
;
1788 unexpected_linespec_error (parser
);
1790 else if (token
.type
== LSTOKEN_EOI
)
1792 unexpected_linespec_error (parser
);
1794 /* If it is a LSTOKEN_NUMBER, we have an offset. */
1795 else if (token
.type
== LSTOKEN_NUMBER
)
1797 set_completion_after_number (parser
, linespec_complete_what::KEYWORD
);
1799 /* Record the line offset and get the next token. */
1800 name
= copy_token_string (token
);
1801 PARSER_EXPLICIT (parser
)->line_offset
1802 = linespec_parse_line_offset (name
.get ());
1804 /* Get the next token. */
1805 token
= linespec_lexer_consume_token (parser
);
1807 /* If the next token is a comma, stop parsing and return. */
1808 if (token
.type
== LSTOKEN_COMMA
)
1810 parser
->complete_what
= linespec_complete_what::NOTHING
;
1814 /* If the next token is anything but EOI or KEYWORD, issue
1816 if (token
.type
!= LSTOKEN_KEYWORD
&& token
.type
!= LSTOKEN_EOI
)
1817 unexpected_linespec_error (parser
);
1820 if (token
.type
== LSTOKEN_KEYWORD
|| token
.type
== LSTOKEN_EOI
)
1823 /* Next token must be LSTOKEN_STRING. */
1824 if (token
.type
!= LSTOKEN_STRING
)
1826 parser
->complete_what
= linespec_complete_what::NOTHING
;
1827 unexpected_linespec_error (parser
);
1830 /* The current token will contain the name of a function, method,
1832 name
= copy_token_string (token
);
1834 if (parser
->completion_tracker
!= NULL
)
1836 /* If the function name ends with a ":", then this may be an
1837 incomplete "::" scope operator instead of a label separator.
1840 which should expand to:
1843 Do a tentative completion assuming the later. If we find
1844 completions, advance the stream past the colon token and make
1845 it part of the function name/token. */
1847 if (!parser
->completion_quote_char
1848 && strcmp (PARSER_STREAM (parser
), ":") == 0)
1850 completion_tracker tmp_tracker
;
1851 const char *source_filename
1852 = PARSER_EXPLICIT (parser
)->source_filename
;
1853 symbol_name_match_type match_type
1854 = PARSER_EXPLICIT (parser
)->func_name_match_type
;
1856 linespec_complete_function (tmp_tracker
,
1857 parser
->completion_word
,
1861 if (tmp_tracker
.have_completions ())
1863 PARSER_STREAM (parser
)++;
1864 LS_TOKEN_STOKEN (token
).length
++;
1866 name
.reset (savestring (parser
->completion_word
,
1867 (PARSER_STREAM (parser
)
1868 - parser
->completion_word
)));
1872 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1876 /* Try looking it up as a function/method. */
1877 find_linespec_symbols (PARSER_STATE (parser
),
1878 PARSER_RESULT (parser
)->file_symtabs
, name
.get (),
1879 PARSER_EXPLICIT (parser
)->func_name_match_type
,
1880 &symbols
, &minimal_symbols
);
1882 if (!symbols
.empty () || !minimal_symbols
.empty ())
1884 PARSER_RESULT (parser
)->function_symbols
1885 = new std::vector
<block_symbol
> (std::move (symbols
));
1886 PARSER_RESULT (parser
)->minimal_symbols
1887 = new std::vector
<bound_minimal_symbol
>
1888 (std::move (minimal_symbols
));
1889 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1893 /* NAME was not a function or a method. So it must be a label
1894 name or user specified variable like "break foo.c:$zippo". */
1895 labels
= find_label_symbols (PARSER_STATE (parser
), NULL
,
1896 &symbols
, name
.get ());
1899 PARSER_RESULT (parser
)->labels
.label_symbols
= labels
;
1900 PARSER_RESULT (parser
)->labels
.function_symbols
1901 = new std::vector
<block_symbol
> (std::move (symbols
));
1902 PARSER_EXPLICIT (parser
)->label_name
= name
.release ();
1904 else if (token
.type
== LSTOKEN_STRING
1905 && *LS_TOKEN_STOKEN (token
).ptr
== '$')
1907 /* User specified a convenience variable or history value. */
1908 PARSER_EXPLICIT (parser
)->line_offset
1909 = linespec_parse_variable (PARSER_STATE (parser
), name
.get ());
1911 if (PARSER_EXPLICIT (parser
)->line_offset
.sign
== LINE_OFFSET_UNKNOWN
)
1913 /* The user-specified variable was not valid. Do not
1914 throw an error here. parse_linespec will do it for us. */
1915 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1921 /* The name is also not a label. Abort parsing. Do not throw
1922 an error here. parse_linespec will do it for us. */
1924 /* Save a copy of the name we were trying to lookup. */
1925 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1931 int previous_qc
= parser
->completion_quote_char
;
1933 /* Get the next token. */
1934 token
= linespec_lexer_consume_token (parser
);
1936 if (token
.type
== LSTOKEN_EOI
)
1938 if (previous_qc
&& !parser
->completion_quote_char
)
1939 parser
->complete_what
= linespec_complete_what::KEYWORD
;
1941 else if (token
.type
== LSTOKEN_COLON
)
1943 /* User specified a label or a lineno. */
1944 token
= linespec_lexer_consume_token (parser
);
1946 if (token
.type
== LSTOKEN_NUMBER
)
1948 /* User specified an offset. Record the line offset and
1949 get the next token. */
1950 set_completion_after_number (parser
, linespec_complete_what::KEYWORD
);
1952 name
= copy_token_string (token
);
1953 PARSER_EXPLICIT (parser
)->line_offset
1954 = linespec_parse_line_offset (name
.get ());
1956 /* Get the next token. */
1957 token
= linespec_lexer_consume_token (parser
);
1959 else if (token
.type
== LSTOKEN_EOI
&& parser
->completion_tracker
!= NULL
)
1961 parser
->complete_what
= linespec_complete_what::LABEL
;
1963 else if (token
.type
== LSTOKEN_STRING
)
1965 parser
->complete_what
= linespec_complete_what::LABEL
;
1967 /* If we have text after the label separated by whitespace
1968 (e.g., "b func():lab i<tab>"), don't consider it part of
1969 the label. In completion mode that should complete to
1970 "if", in normal mode, the 'i' should be treated as
1972 if (parser
->completion_quote_char
== '\0')
1974 const char *ptr
= LS_TOKEN_STOKEN (token
).ptr
;
1975 for (size_t i
= 0; i
< LS_TOKEN_STOKEN (token
).length
; i
++)
1979 LS_TOKEN_STOKEN (token
).length
= i
;
1980 PARSER_STREAM (parser
) = skip_spaces (ptr
+ i
+ 1);
1986 if (parser
->completion_tracker
!= NULL
)
1988 if (PARSER_STREAM (parser
)[-1] == ' ')
1990 parser
->completion_word
= PARSER_STREAM (parser
);
1991 parser
->complete_what
= linespec_complete_what::KEYWORD
;
1996 /* Grab a copy of the label's name and look it up. */
1997 name
= copy_token_string (token
);
1999 = find_label_symbols (PARSER_STATE (parser
),
2000 PARSER_RESULT (parser
)->function_symbols
,
2001 &symbols
, name
.get ());
2005 PARSER_RESULT (parser
)->labels
.label_symbols
= labels
;
2006 PARSER_RESULT (parser
)->labels
.function_symbols
2007 = new std::vector
<block_symbol
> (std::move (symbols
));
2008 PARSER_EXPLICIT (parser
)->label_name
= name
.release ();
2012 /* We don't know what it was, but it isn't a label. */
2013 undefined_label_error
2014 (PARSER_EXPLICIT (parser
)->function_name
, name
.get ());
2019 /* Check for a line offset. */
2020 token
= save_stream_and_consume_token (parser
);
2021 if (token
.type
== LSTOKEN_COLON
)
2023 /* Get the next token. */
2024 token
= linespec_lexer_consume_token (parser
);
2026 /* It must be a line offset. */
2027 if (token
.type
!= LSTOKEN_NUMBER
)
2028 unexpected_linespec_error (parser
);
2030 /* Record the line offset and get the next token. */
2031 name
= copy_token_string (token
);
2033 PARSER_EXPLICIT (parser
)->line_offset
2034 = linespec_parse_line_offset (name
.get ());
2036 /* Get the next token. */
2037 token
= linespec_lexer_consume_token (parser
);
2042 /* Trailing ':' in the input. Issue an error. */
2043 unexpected_linespec_error (parser
);
2048 /* Canonicalize the linespec contained in LS. The result is saved into
2049 STATE->canonical. This function handles both linespec and explicit
2053 canonicalize_linespec (struct linespec_state
*state
, const linespec_p ls
)
2055 struct event_location
*canon
;
2056 struct explicit_location
*explicit_loc
;
2058 /* If canonicalization was not requested, no need to do anything. */
2059 if (!state
->canonical
)
2062 /* Save everything as an explicit location. */
2063 state
->canonical
->location
2064 = new_explicit_location (&ls
->explicit_loc
);
2065 canon
= state
->canonical
->location
.get ();
2066 explicit_loc
= get_explicit_location (canon
);
2068 if (explicit_loc
->label_name
!= NULL
)
2070 state
->canonical
->special_display
= 1;
2072 if (explicit_loc
->function_name
== NULL
)
2074 /* No function was specified, so add the symbol name. */
2075 gdb_assert (!ls
->labels
.function_symbols
->empty ()
2076 && (ls
->labels
.function_symbols
->size () == 1));
2077 block_symbol s
= ls
->labels
.function_symbols
->front ();
2078 explicit_loc
->function_name
= xstrdup (s
.symbol
->natural_name ());
2082 /* If this location originally came from a linespec, save a string
2083 representation of it for display and saving to file. */
2084 if (state
->is_linespec
)
2086 char *linespec
= explicit_location_to_linespec (explicit_loc
);
2088 set_event_location_string (canon
, linespec
);
2093 /* Given a line offset in LS, construct the relevant SALs. */
2095 static std::vector
<symtab_and_line
>
2096 create_sals_line_offset (struct linespec_state
*self
,
2099 int use_default
= 0;
2101 /* This is where we need to make sure we have good defaults.
2102 We must guarantee that this section of code is never executed
2103 when we are called with just a function name, since
2104 set_default_source_symtab_and_line uses
2105 select_source_symtab that calls us with such an argument. */
2107 if (ls
->file_symtabs
->size () == 1
2108 && ls
->file_symtabs
->front () == nullptr)
2110 set_current_program_space (self
->program_space
);
2112 /* Make sure we have at least a default source line. */
2113 set_default_source_symtab_and_line ();
2114 initialize_defaults (&self
->default_symtab
, &self
->default_line
);
2116 = collect_symtabs_from_filename (self
->default_symtab
->filename
,
2117 self
->search_pspace
);
2121 symtab_and_line val
;
2122 val
.line
= ls
->explicit_loc
.line_offset
.offset
;
2123 switch (ls
->explicit_loc
.line_offset
.sign
)
2125 case LINE_OFFSET_PLUS
:
2126 if (ls
->explicit_loc
.line_offset
.offset
== 0)
2129 val
.line
= self
->default_line
+ val
.line
;
2132 case LINE_OFFSET_MINUS
:
2133 if (ls
->explicit_loc
.line_offset
.offset
== 0)
2136 val
.line
= self
->default_line
- val
.line
;
2138 val
.line
= -val
.line
;
2141 case LINE_OFFSET_NONE
:
2142 break; /* No need to adjust val.line. */
2145 std::vector
<symtab_and_line
> values
;
2146 if (self
->list_mode
)
2147 values
= decode_digits_list_mode (self
, ls
, val
);
2150 struct linetable_entry
*best_entry
= NULL
;
2153 std::vector
<symtab_and_line
> intermediate_results
2154 = decode_digits_ordinary (self
, ls
, val
.line
, &best_entry
);
2155 if (intermediate_results
.empty () && best_entry
!= NULL
)
2156 intermediate_results
= decode_digits_ordinary (self
, ls
,
2160 /* For optimized code, the compiler can scatter one source line
2161 across disjoint ranges of PC values, even when no duplicate
2162 functions or inline functions are involved. For example,
2163 'for (;;)' inside a non-template, non-inline, and non-ctor-or-dtor
2164 function can result in two PC ranges. In this case, we don't
2165 want to set a breakpoint on the first PC of each range. To filter
2166 such cases, we use containing blocks -- for each PC found
2167 above, we see if there are other PCs that are in the same
2168 block. If yes, the other PCs are filtered out. */
2170 gdb::def_vector
<int> filter (intermediate_results
.size ());
2171 gdb::def_vector
<const block
*> blocks (intermediate_results
.size ());
2173 for (i
= 0; i
< intermediate_results
.size (); ++i
)
2175 set_current_program_space (intermediate_results
[i
].pspace
);
2178 blocks
[i
] = block_for_pc_sect (intermediate_results
[i
].pc
,
2179 intermediate_results
[i
].section
);
2182 for (i
= 0; i
< intermediate_results
.size (); ++i
)
2184 if (blocks
[i
] != NULL
)
2185 for (j
= i
+ 1; j
< intermediate_results
.size (); ++j
)
2187 if (blocks
[j
] == blocks
[i
])
2195 for (i
= 0; i
< intermediate_results
.size (); ++i
)
2198 struct symbol
*sym
= (blocks
[i
]
2199 ? block_containing_function (blocks
[i
])
2202 if (self
->funfirstline
)
2203 skip_prologue_sal (&intermediate_results
[i
]);
2204 intermediate_results
[i
].symbol
= sym
;
2205 add_sal_to_sals (self
, &values
, &intermediate_results
[i
],
2206 sym
? sym
->natural_name () : NULL
, 0);
2210 if (values
.empty ())
2212 if (ls
->explicit_loc
.source_filename
)
2213 throw_error (NOT_FOUND_ERROR
, _("No line %d in file \"%s\"."),
2214 val
.line
, ls
->explicit_loc
.source_filename
);
2216 throw_error (NOT_FOUND_ERROR
, _("No line %d in the current file."),
2223 /* Convert the given ADDRESS into SaLs. */
2225 static std::vector
<symtab_and_line
>
2226 convert_address_location_to_sals (struct linespec_state
*self
,
2229 symtab_and_line sal
= find_pc_line (address
, 0);
2231 sal
.section
= find_pc_overlay (address
);
2232 sal
.explicit_pc
= 1;
2233 sal
.symbol
= find_pc_sect_containing_function (sal
.pc
, sal
.section
);
2235 std::vector
<symtab_and_line
> sals
;
2236 add_sal_to_sals (self
, &sals
, &sal
, core_addr_to_string (address
), 1);
2241 /* Create and return SALs from the linespec LS. */
2243 static std::vector
<symtab_and_line
>
2244 convert_linespec_to_sals (struct linespec_state
*state
, linespec_p ls
)
2246 std::vector
<symtab_and_line
> sals
;
2248 if (ls
->labels
.label_symbols
!= NULL
)
2250 /* We have just a bunch of functions/methods or labels. */
2251 struct symtab_and_line sal
;
2253 for (const auto &sym
: *ls
->labels
.label_symbols
)
2255 struct program_space
*pspace
2256 = SYMTAB_PSPACE (symbol_symtab (sym
.symbol
));
2258 if (symbol_to_sal (&sal
, state
->funfirstline
, sym
.symbol
)
2259 && maybe_add_address (state
->addr_set
, pspace
, sal
.pc
))
2260 add_sal_to_sals (state
, &sals
, &sal
,
2261 sym
.symbol
->natural_name (), 0);
2264 else if (ls
->function_symbols
!= NULL
|| ls
->minimal_symbols
!= NULL
)
2266 /* We have just a bunch of functions and/or methods. */
2267 if (ls
->function_symbols
!= NULL
)
2269 /* Sort symbols so that symbols with the same program space are next
2271 std::sort (ls
->function_symbols
->begin (),
2272 ls
->function_symbols
->end (),
2275 for (const auto &sym
: *ls
->function_symbols
)
2277 program_space
*pspace
2278 = SYMTAB_PSPACE (symbol_symtab (sym
.symbol
));
2279 set_current_program_space (pspace
);
2281 /* Don't skip to the first line of the function if we
2282 had found an ifunc minimal symbol for this function,
2283 because that means that this function is an ifunc
2284 resolver with the same name as the ifunc itself. */
2285 bool found_ifunc
= false;
2287 if (state
->funfirstline
2288 && ls
->minimal_symbols
!= NULL
2289 && SYMBOL_CLASS (sym
.symbol
) == LOC_BLOCK
)
2291 const CORE_ADDR addr
2292 = BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
.symbol
));
2294 for (const auto &elem
: *ls
->minimal_symbols
)
2296 if (MSYMBOL_TYPE (elem
.minsym
) == mst_text_gnu_ifunc
2297 || MSYMBOL_TYPE (elem
.minsym
) == mst_data_gnu_ifunc
)
2299 CORE_ADDR msym_addr
= BMSYMBOL_VALUE_ADDRESS (elem
);
2300 if (MSYMBOL_TYPE (elem
.minsym
) == mst_data_gnu_ifunc
)
2302 struct gdbarch
*gdbarch
2303 = elem
.objfile
->arch ();
2305 = (gdbarch_convert_from_func_ptr_addr
2308 current_top_target ()));
2311 if (msym_addr
== addr
)
2322 symtab_and_line sal
;
2323 if (symbol_to_sal (&sal
, state
->funfirstline
, sym
.symbol
)
2324 && maybe_add_address (state
->addr_set
, pspace
, sal
.pc
))
2325 add_sal_to_sals (state
, &sals
, &sal
,
2326 sym
.symbol
->natural_name (), 0);
2331 if (ls
->minimal_symbols
!= NULL
)
2333 /* Sort minimal symbols by program space, too */
2334 std::sort (ls
->minimal_symbols
->begin (),
2335 ls
->minimal_symbols
->end (),
2338 for (const auto &elem
: *ls
->minimal_symbols
)
2340 program_space
*pspace
= elem
.objfile
->pspace
;
2341 set_current_program_space (pspace
);
2342 minsym_found (state
, elem
.objfile
, elem
.minsym
, &sals
);
2346 else if (ls
->explicit_loc
.line_offset
.sign
!= LINE_OFFSET_UNKNOWN
)
2348 /* Only an offset was specified. */
2349 sals
= create_sals_line_offset (state
, ls
);
2351 /* Make sure we have a filename for canonicalization. */
2352 if (ls
->explicit_loc
.source_filename
== NULL
)
2354 const char *fullname
= symtab_to_fullname (state
->default_symtab
);
2356 /* It may be more appropriate to keep DEFAULT_SYMTAB in its symtab
2357 form so that displaying SOURCE_FILENAME can follow the current
2358 FILENAME_DISPLAY_STRING setting. But as it is used only rarely
2359 it has been kept for code simplicity only in absolute form. */
2360 ls
->explicit_loc
.source_filename
= xstrdup (fullname
);
2365 /* We haven't found any results... */
2369 canonicalize_linespec (state
, ls
);
2371 if (!sals
.empty () && state
->canonical
!= NULL
)
2372 state
->canonical
->pre_expanded
= 1;
2377 /* Build RESULT from the explicit location components SOURCE_FILENAME,
2378 FUNCTION_NAME, LABEL_NAME and LINE_OFFSET. */
2381 convert_explicit_location_to_linespec (struct linespec_state
*self
,
2383 const char *source_filename
,
2384 const char *function_name
,
2385 symbol_name_match_type fname_match_type
,
2386 const char *label_name
,
2387 struct line_offset line_offset
)
2389 std::vector
<block_symbol
> symbols
;
2390 std::vector
<block_symbol
> *labels
;
2391 std::vector
<bound_minimal_symbol
> minimal_symbols
;
2393 result
->explicit_loc
.func_name_match_type
= fname_match_type
;
2395 if (source_filename
!= NULL
)
2399 *result
->file_symtabs
2400 = symtabs_from_filename (source_filename
, self
->search_pspace
);
2402 catch (const gdb_exception_error
&except
)
2404 source_file_not_found_error (source_filename
);
2406 result
->explicit_loc
.source_filename
= xstrdup (source_filename
);
2410 /* A NULL entry means to use the default symtab. */
2411 result
->file_symtabs
->push_back (nullptr);
2414 if (function_name
!= NULL
)
2416 find_linespec_symbols (self
, result
->file_symtabs
,
2417 function_name
, fname_match_type
,
2418 &symbols
, &minimal_symbols
);
2420 if (symbols
.empty () && minimal_symbols
.empty ())
2421 symbol_not_found_error (function_name
,
2422 result
->explicit_loc
.source_filename
);
2424 result
->explicit_loc
.function_name
= xstrdup (function_name
);
2425 result
->function_symbols
2426 = new std::vector
<block_symbol
> (std::move (symbols
));
2427 result
->minimal_symbols
2428 = new std::vector
<bound_minimal_symbol
> (std::move (minimal_symbols
));
2431 if (label_name
!= NULL
)
2433 labels
= find_label_symbols (self
, result
->function_symbols
,
2434 &symbols
, label_name
);
2437 undefined_label_error (result
->explicit_loc
.function_name
,
2440 result
->explicit_loc
.label_name
= xstrdup (label_name
);
2441 result
->labels
.label_symbols
= labels
;
2442 result
->labels
.function_symbols
2443 = new std::vector
<block_symbol
> (std::move (symbols
));
2446 if (line_offset
.sign
!= LINE_OFFSET_UNKNOWN
)
2447 result
->explicit_loc
.line_offset
= line_offset
;
2450 /* Convert the explicit location EXPLICIT_LOC into SaLs. */
2452 static std::vector
<symtab_and_line
>
2453 convert_explicit_location_to_sals (struct linespec_state
*self
,
2455 const struct explicit_location
*explicit_loc
)
2457 convert_explicit_location_to_linespec (self
, result
,
2458 explicit_loc
->source_filename
,
2459 explicit_loc
->function_name
,
2460 explicit_loc
->func_name_match_type
,
2461 explicit_loc
->label_name
,
2462 explicit_loc
->line_offset
);
2463 return convert_linespec_to_sals (self
, result
);
2466 /* Parse a string that specifies a linespec.
2468 The basic grammar of linespecs:
2470 linespec -> var_spec | basic_spec
2471 var_spec -> '$' (STRING | NUMBER)
2473 basic_spec -> file_offset_spec | function_spec | label_spec
2474 file_offset_spec -> opt_file_spec offset_spec
2475 function_spec -> opt_file_spec function_name_spec opt_label_spec
2476 label_spec -> label_name_spec
2478 opt_file_spec -> "" | file_name_spec ':'
2479 opt_label_spec -> "" | ':' label_name_spec
2481 file_name_spec -> STRING
2482 function_name_spec -> STRING
2483 label_name_spec -> STRING
2484 function_name_spec -> STRING
2485 offset_spec -> NUMBER
2489 This may all be followed by several keywords such as "if EXPR",
2492 A comma will terminate parsing.
2494 The function may be an undebuggable function found in minimal symbol table.
2496 If the argument FUNFIRSTLINE is nonzero, we want the first line
2497 of real code inside a function when a function is specified, and it is
2498 not OK to specify a variable or type to get its line number.
2500 DEFAULT_SYMTAB specifies the file to use if none is specified.
2501 It defaults to current_source_symtab.
2502 DEFAULT_LINE specifies the line number to use for relative
2503 line numbers (that start with signs). Defaults to current_source_line.
2504 If CANONICAL is non-NULL, store an array of strings containing the canonical
2505 line specs there if necessary. Currently overloaded member functions and
2506 line numbers or static functions without a filename yield a canonical
2507 line spec. The array and the line spec strings are allocated on the heap,
2508 it is the callers responsibility to free them.
2510 Note that it is possible to return zero for the symtab
2511 if no file is validly specified. Callers must check that.
2512 Also, the line number returned may be invalid. */
2514 /* Parse the linespec in ARG. MATCH_TYPE indicates how function names
2515 should be matched. */
2517 static std::vector
<symtab_and_line
>
2518 parse_linespec (linespec_parser
*parser
, const char *arg
,
2519 symbol_name_match_type match_type
)
2521 linespec_token token
;
2522 struct gdb_exception file_exception
;
2524 /* A special case to start. It has become quite popular for
2525 IDEs to work around bugs in the previous parser by quoting
2526 the entire linespec, so we attempt to deal with this nicely. */
2527 parser
->is_quote_enclosed
= 0;
2528 if (parser
->completion_tracker
== NULL
2529 && !is_ada_operator (arg
)
2530 && strchr (linespec_quote_characters
, *arg
) != NULL
)
2534 end
= skip_quote_char (arg
+ 1, *arg
);
2535 if (end
!= NULL
&& is_closing_quote_enclosed (end
))
2537 /* Here's the special case. Skip ARG past the initial
2540 parser
->is_quote_enclosed
= 1;
2544 parser
->lexer
.saved_arg
= arg
;
2545 parser
->lexer
.stream
= arg
;
2546 parser
->completion_word
= arg
;
2547 parser
->complete_what
= linespec_complete_what::FUNCTION
;
2548 PARSER_EXPLICIT (parser
)->func_name_match_type
= match_type
;
2550 /* Initialize the default symtab and line offset. */
2551 initialize_defaults (&PARSER_STATE (parser
)->default_symtab
,
2552 &PARSER_STATE (parser
)->default_line
);
2554 /* Objective-C shortcut. */
2555 if (parser
->completion_tracker
== NULL
)
2557 std::vector
<symtab_and_line
> values
2558 = decode_objc (PARSER_STATE (parser
), PARSER_RESULT (parser
), arg
);
2559 if (!values
.empty ())
2564 /* "-"/"+" is either an objc selector, or a number. There's
2565 nothing to complete the latter to, so just let the caller
2566 complete on functions, which finds objc selectors, if there's
2568 if ((arg
[0] == '-' || arg
[0] == '+') && arg
[1] == '\0')
2572 /* Start parsing. */
2574 /* Get the first token. */
2575 token
= linespec_lexer_consume_token (parser
);
2577 /* It must be either LSTOKEN_STRING or LSTOKEN_NUMBER. */
2578 if (token
.type
== LSTOKEN_STRING
&& *LS_TOKEN_STOKEN (token
).ptr
== '$')
2580 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2581 if (parser
->completion_tracker
== NULL
)
2582 PARSER_RESULT (parser
)->file_symtabs
->push_back (nullptr);
2584 /* User specified a convenience variable or history value. */
2585 gdb::unique_xmalloc_ptr
<char> var
= copy_token_string (token
);
2586 PARSER_EXPLICIT (parser
)->line_offset
2587 = linespec_parse_variable (PARSER_STATE (parser
), var
.get ());
2589 /* If a line_offset wasn't found (VAR is the name of a user
2590 variable/function), then skip to normal symbol processing. */
2591 if (PARSER_EXPLICIT (parser
)->line_offset
.sign
!= LINE_OFFSET_UNKNOWN
)
2593 /* Consume this token. */
2594 linespec_lexer_consume_token (parser
);
2596 goto convert_to_sals
;
2599 else if (token
.type
== LSTOKEN_EOI
&& parser
->completion_tracker
!= NULL
)
2601 /* Let the default linespec_complete_what::FUNCTION kick in. */
2602 unexpected_linespec_error (parser
);
2604 else if (token
.type
!= LSTOKEN_STRING
&& token
.type
!= LSTOKEN_NUMBER
)
2606 parser
->complete_what
= linespec_complete_what::NOTHING
;
2607 unexpected_linespec_error (parser
);
2610 /* Shortcut: If the next token is not LSTOKEN_COLON, we know that
2611 this token cannot represent a filename. */
2612 token
= linespec_lexer_peek_token (parser
);
2614 if (token
.type
== LSTOKEN_COLON
)
2616 /* Get the current token again and extract the filename. */
2617 token
= linespec_lexer_lex_one (parser
);
2618 gdb::unique_xmalloc_ptr
<char> user_filename
= copy_token_string (token
);
2620 /* Check if the input is a filename. */
2623 *PARSER_RESULT (parser
)->file_symtabs
2624 = symtabs_from_filename (user_filename
.get (),
2625 PARSER_STATE (parser
)->search_pspace
);
2627 catch (gdb_exception_error
&ex
)
2629 file_exception
= std::move (ex
);
2632 if (file_exception
.reason
>= 0)
2634 /* Symtabs were found for the file. Record the filename. */
2635 PARSER_EXPLICIT (parser
)->source_filename
= user_filename
.release ();
2637 /* Get the next token. */
2638 token
= linespec_lexer_consume_token (parser
);
2640 /* This is LSTOKEN_COLON; consume it. */
2641 linespec_lexer_consume_token (parser
);
2645 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2646 PARSER_RESULT (parser
)->file_symtabs
->push_back (nullptr);
2649 /* If the next token is not EOI, KEYWORD, or COMMA, issue an error. */
2650 else if (parser
->completion_tracker
== NULL
2651 && (token
.type
!= LSTOKEN_EOI
&& token
.type
!= LSTOKEN_KEYWORD
2652 && token
.type
!= LSTOKEN_COMMA
))
2654 /* TOKEN is the _next_ token, not the one currently in the parser.
2655 Consuming the token will give the correct error message. */
2656 linespec_lexer_consume_token (parser
);
2657 unexpected_linespec_error (parser
);
2661 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2662 PARSER_RESULT (parser
)->file_symtabs
->push_back (nullptr);
2665 /* Parse the rest of the linespec. */
2666 linespec_parse_basic (parser
);
2668 if (parser
->completion_tracker
== NULL
2669 && PARSER_RESULT (parser
)->function_symbols
== NULL
2670 && PARSER_RESULT (parser
)->labels
.label_symbols
== NULL
2671 && PARSER_EXPLICIT (parser
)->line_offset
.sign
== LINE_OFFSET_UNKNOWN
2672 && PARSER_RESULT (parser
)->minimal_symbols
== NULL
)
2674 /* The linespec didn't parse. Re-throw the file exception if
2676 if (file_exception
.reason
< 0)
2677 throw_exception (std::move (file_exception
));
2679 /* Otherwise, the symbol is not found. */
2680 symbol_not_found_error (PARSER_EXPLICIT (parser
)->function_name
,
2681 PARSER_EXPLICIT (parser
)->source_filename
);
2686 /* Get the last token and record how much of the input was parsed,
2688 token
= linespec_lexer_lex_one (parser
);
2689 if (token
.type
!= LSTOKEN_EOI
&& token
.type
!= LSTOKEN_KEYWORD
)
2690 unexpected_linespec_error (parser
);
2691 else if (token
.type
== LSTOKEN_KEYWORD
)
2693 /* Setup the completion word past the keyword. Lexing never
2694 advances past a keyword automatically, so skip it
2696 parser
->completion_word
2697 = skip_spaces (skip_to_space (PARSER_STREAM (parser
)));
2698 parser
->complete_what
= linespec_complete_what::EXPRESSION
;
2701 /* Convert the data in PARSER_RESULT to SALs. */
2702 if (parser
->completion_tracker
== NULL
)
2703 return convert_linespec_to_sals (PARSER_STATE (parser
),
2704 PARSER_RESULT (parser
));
2710 /* A constructor for linespec_state. */
2713 linespec_state_constructor (struct linespec_state
*self
,
2714 int flags
, const struct language_defn
*language
,
2715 struct program_space
*search_pspace
,
2716 struct symtab
*default_symtab
,
2718 struct linespec_result
*canonical
)
2720 memset (self
, 0, sizeof (*self
));
2721 self
->language
= language
;
2722 self
->funfirstline
= (flags
& DECODE_LINE_FUNFIRSTLINE
) ? 1 : 0;
2723 self
->list_mode
= (flags
& DECODE_LINE_LIST_MODE
) ? 1 : 0;
2724 self
->search_pspace
= search_pspace
;
2725 self
->default_symtab
= default_symtab
;
2726 self
->default_line
= default_line
;
2727 self
->canonical
= canonical
;
2728 self
->program_space
= current_program_space
;
2729 self
->addr_set
= htab_create_alloc (10, hash_address_entry
, eq_address_entry
,
2730 xfree
, xcalloc
, xfree
);
2731 self
->is_linespec
= 0;
2734 /* Initialize a new linespec parser. */
2736 linespec_parser::linespec_parser (int flags
,
2737 const struct language_defn
*language
,
2738 struct program_space
*search_pspace
,
2739 struct symtab
*default_symtab
,
2741 struct linespec_result
*canonical
)
2743 lexer
.current
.type
= LSTOKEN_CONSUMED
;
2744 PARSER_RESULT (this)->file_symtabs
= new std::vector
<symtab
*> ();
2745 PARSER_EXPLICIT (this)->func_name_match_type
2746 = symbol_name_match_type::WILD
;
2747 PARSER_EXPLICIT (this)->line_offset
.sign
= LINE_OFFSET_UNKNOWN
;
2748 linespec_state_constructor (PARSER_STATE (this), flags
, language
,
2750 default_symtab
, default_line
, canonical
);
2753 /* A destructor for linespec_state. */
2756 linespec_state_destructor (struct linespec_state
*self
)
2758 htab_delete (self
->addr_set
);
2759 xfree (self
->canonical_names
);
2762 /* Delete a linespec parser. */
2764 linespec_parser::~linespec_parser ()
2766 xfree (PARSER_EXPLICIT (this)->source_filename
);
2767 xfree (PARSER_EXPLICIT (this)->label_name
);
2768 xfree (PARSER_EXPLICIT (this)->function_name
);
2770 delete PARSER_RESULT (this)->file_symtabs
;
2771 delete PARSER_RESULT (this)->function_symbols
;
2772 delete PARSER_RESULT (this)->minimal_symbols
;
2773 delete PARSER_RESULT (this)->labels
.label_symbols
;
2774 delete PARSER_RESULT (this)->labels
.function_symbols
;
2776 linespec_state_destructor (PARSER_STATE (this));
2779 /* See description in linespec.h. */
2782 linespec_lex_to_end (const char **stringp
)
2784 linespec_token token
;
2787 if (stringp
== NULL
|| *stringp
== NULL
)
2790 linespec_parser
parser (0, current_language
, NULL
, NULL
, 0, NULL
);
2791 parser
.lexer
.saved_arg
= *stringp
;
2792 PARSER_STREAM (&parser
) = orig
= *stringp
;
2796 /* Stop before any comma tokens; we need it to keep it
2797 as the next token in the string. */
2798 token
= linespec_lexer_peek_token (&parser
);
2799 if (token
.type
== LSTOKEN_COMMA
)
2801 token
= linespec_lexer_consume_token (&parser
);
2803 while (token
.type
!= LSTOKEN_EOI
&& token
.type
!= LSTOKEN_KEYWORD
);
2805 *stringp
+= PARSER_STREAM (&parser
) - orig
;
2808 /* See linespec.h. */
2811 linespec_complete_function (completion_tracker
&tracker
,
2812 const char *function
,
2813 symbol_name_match_type func_match_type
,
2814 const char *source_filename
)
2816 complete_symbol_mode mode
= complete_symbol_mode::LINESPEC
;
2818 if (source_filename
!= NULL
)
2820 collect_file_symbol_completion_matches (tracker
, mode
, func_match_type
,
2821 function
, function
, source_filename
);
2825 collect_symbol_completion_matches (tracker
, mode
, func_match_type
,
2826 function
, function
);
2831 /* Helper for complete_linespec to simplify it. SOURCE_FILENAME is
2832 only meaningful if COMPONENT is FUNCTION. */
2835 complete_linespec_component (linespec_parser
*parser
,
2836 completion_tracker
&tracker
,
2838 linespec_complete_what component
,
2839 const char *source_filename
)
2841 if (component
== linespec_complete_what::KEYWORD
)
2843 complete_on_enum (tracker
, linespec_keywords
, text
, text
);
2845 else if (component
== linespec_complete_what::EXPRESSION
)
2848 = advance_to_expression_complete_word_point (tracker
, text
);
2849 complete_expression (tracker
, text
, word
);
2851 else if (component
== linespec_complete_what::FUNCTION
)
2853 completion_list fn_list
;
2855 symbol_name_match_type match_type
2856 = PARSER_EXPLICIT (parser
)->func_name_match_type
;
2857 linespec_complete_function (tracker
, text
, match_type
, source_filename
);
2858 if (source_filename
== NULL
)
2860 /* Haven't seen a source component, like in "b
2861 file.c:function[TAB]". Maybe this wasn't a function, but
2862 a filename instead, like "b file.[TAB]". */
2863 fn_list
= complete_source_filenames (text
);
2866 /* If we only have a single filename completion, append a ':' for
2867 the user, since that's the only thing that can usefully follow
2869 if (fn_list
.size () == 1 && !tracker
.have_completions ())
2871 char *fn
= fn_list
[0].release ();
2873 /* If we also need to append a quote char, it needs to be
2874 appended before the ':'. Append it now, and make ':' the
2875 new "quote" char. */
2876 if (tracker
.quote_char ())
2878 char quote_char_str
[2] = { (char) tracker
.quote_char () };
2880 fn
= reconcat (fn
, fn
, quote_char_str
, (char *) NULL
);
2881 tracker
.set_quote_char (':');
2884 fn
= reconcat (fn
, fn
, ":", (char *) NULL
);
2885 fn_list
[0].reset (fn
);
2887 /* Tell readline to skip appending a space. */
2888 tracker
.set_suppress_append_ws (true);
2890 tracker
.add_completions (std::move (fn_list
));
2894 /* Helper for linespec_complete_label. Find labels that match
2895 LABEL_NAME in the function symbols listed in the PARSER, and add
2896 them to the tracker. */
2899 complete_label (completion_tracker
&tracker
,
2900 linespec_parser
*parser
,
2901 const char *label_name
)
2903 std::vector
<block_symbol
> label_function_symbols
;
2904 std::vector
<block_symbol
> *labels
2905 = find_label_symbols (PARSER_STATE (parser
),
2906 PARSER_RESULT (parser
)->function_symbols
,
2907 &label_function_symbols
,
2910 if (labels
!= nullptr)
2912 for (const auto &label
: *labels
)
2914 char *match
= xstrdup (label
.symbol
->search_name ());
2915 tracker
.add_completion (gdb::unique_xmalloc_ptr
<char> (match
));
2921 /* See linespec.h. */
2924 linespec_complete_label (completion_tracker
&tracker
,
2925 const struct language_defn
*language
,
2926 const char *source_filename
,
2927 const char *function_name
,
2928 symbol_name_match_type func_name_match_type
,
2929 const char *label_name
)
2931 linespec_parser
parser (0, language
, NULL
, NULL
, 0, NULL
);
2933 line_offset unknown_offset
= { 0, LINE_OFFSET_UNKNOWN
};
2937 convert_explicit_location_to_linespec (PARSER_STATE (&parser
),
2938 PARSER_RESULT (&parser
),
2941 func_name_match_type
,
2942 NULL
, unknown_offset
);
2944 catch (const gdb_exception_error
&ex
)
2949 complete_label (tracker
, &parser
, label_name
);
2952 /* See description in linespec.h. */
2955 linespec_complete (completion_tracker
&tracker
, const char *text
,
2956 symbol_name_match_type match_type
)
2958 const char *orig
= text
;
2960 linespec_parser
parser (0, current_language
, NULL
, NULL
, 0, NULL
);
2961 parser
.lexer
.saved_arg
= text
;
2962 PARSER_EXPLICIT (&parser
)->func_name_match_type
= match_type
;
2963 PARSER_STREAM (&parser
) = text
;
2965 parser
.completion_tracker
= &tracker
;
2966 PARSER_STATE (&parser
)->is_linespec
= 1;
2968 /* Parse as much as possible. parser.completion_word will hold
2969 furthest completion point we managed to parse to. */
2972 parse_linespec (&parser
, text
, match_type
);
2974 catch (const gdb_exception_error
&except
)
2978 if (parser
.completion_quote_char
!= '\0'
2979 && parser
.completion_quote_end
!= NULL
2980 && parser
.completion_quote_end
[1] == '\0')
2982 /* If completing a quoted string with the cursor right at
2983 terminating quote char, complete the completion word without
2984 interpretation, so that readline advances the cursor one
2985 whitespace past the quote, even if there's no match. This
2986 makes these cases behave the same:
2988 before: "b function()"
2989 after: "b function() "
2991 before: "b 'function()'"
2992 after: "b 'function()' "
2994 and trusts the user in this case:
2996 before: "b 'not_loaded_function_yet()'"
2997 after: "b 'not_loaded_function_yet()' "
2999 parser
.complete_what
= linespec_complete_what::NOTHING
;
3000 parser
.completion_quote_char
= '\0';
3002 gdb::unique_xmalloc_ptr
<char> text_copy
3003 (xstrdup (parser
.completion_word
));
3004 tracker
.add_completion (std::move (text_copy
));
3007 tracker
.set_quote_char (parser
.completion_quote_char
);
3009 if (parser
.complete_what
== linespec_complete_what::LABEL
)
3011 parser
.complete_what
= linespec_complete_what::NOTHING
;
3013 const char *func_name
= PARSER_EXPLICIT (&parser
)->function_name
;
3015 std::vector
<block_symbol
> function_symbols
;
3016 std::vector
<bound_minimal_symbol
> minimal_symbols
;
3017 find_linespec_symbols (PARSER_STATE (&parser
),
3018 PARSER_RESULT (&parser
)->file_symtabs
,
3019 func_name
, match_type
,
3020 &function_symbols
, &minimal_symbols
);
3022 PARSER_RESULT (&parser
)->function_symbols
3023 = new std::vector
<block_symbol
> (std::move (function_symbols
));
3024 PARSER_RESULT (&parser
)->minimal_symbols
3025 = new std::vector
<bound_minimal_symbol
> (std::move (minimal_symbols
));
3027 complete_label (tracker
, &parser
, parser
.completion_word
);
3029 else if (parser
.complete_what
== linespec_complete_what::FUNCTION
)
3031 /* While parsing/lexing, we didn't know whether the completion
3032 word completes to a unique function/source name already or
3036 "b function() <tab>"
3037 may need to complete either to:
3038 "b function() const"
3040 "b function() if/thread/task"
3044 may need to complete either to:
3045 "b foo template_fun<T>()"
3046 with "foo" being the template function's return type, or to:
3051 may need to complete either to a source file name:
3053 or this, also a filename, but a unique completion:
3055 or to a function name:
3058 Address that by completing assuming source or function, and
3059 seeing if we find a completion that matches exactly the
3060 completion word. If so, then it must be a function (see note
3061 below) and we advance the completion word to the end of input
3062 and switch to KEYWORD completion mode.
3064 Note: if we find a unique completion for a source filename,
3065 then it won't match the completion word, because the LCD will
3066 contain a trailing ':'. And if we're completing at or after
3067 the ':', then complete_linespec_component won't try to
3068 complete on source filenames. */
3070 const char *word
= parser
.completion_word
;
3072 complete_linespec_component (&parser
, tracker
,
3073 parser
.completion_word
,
3074 linespec_complete_what::FUNCTION
,
3075 PARSER_EXPLICIT (&parser
)->source_filename
);
3077 parser
.complete_what
= linespec_complete_what::NOTHING
;
3079 if (tracker
.quote_char ())
3081 /* The function/file name was not close-quoted, so this
3082 can't be a keyword. Note: complete_linespec_component
3083 may have swapped the original quote char for ':' when we
3084 get here, but that still indicates the same. */
3086 else if (!tracker
.have_completions ())
3089 size_t wordlen
= strlen (parser
.completion_word
);
3092 = string_find_incomplete_keyword_at_end (linespec_keywords
,
3093 parser
.completion_word
,
3098 && parser
.completion_word
[wordlen
- 1] == ' '))
3100 parser
.completion_word
+= key_start
;
3101 parser
.complete_what
= linespec_complete_what::KEYWORD
;
3104 else if (tracker
.completes_to_completion_word (word
))
3106 /* Skip the function and complete on keywords. */
3107 parser
.completion_word
+= strlen (word
);
3108 parser
.complete_what
= linespec_complete_what::KEYWORD
;
3109 tracker
.discard_completions ();
3113 tracker
.advance_custom_word_point_by (parser
.completion_word
- orig
);
3115 complete_linespec_component (&parser
, tracker
,
3116 parser
.completion_word
,
3117 parser
.complete_what
,
3118 PARSER_EXPLICIT (&parser
)->source_filename
);
3120 /* If we're past the "filename:function:label:offset" linespec, and
3121 didn't find any match, then assume the user might want to create
3122 a pending breakpoint anyway and offer the keyword
3124 if (!parser
.completion_quote_char
3125 && (parser
.complete_what
== linespec_complete_what::FUNCTION
3126 || parser
.complete_what
== linespec_complete_what::LABEL
3127 || parser
.complete_what
== linespec_complete_what::NOTHING
)
3128 && !tracker
.have_completions ())
3131 = parser
.completion_word
+ strlen (parser
.completion_word
);
3133 if (end
> orig
&& end
[-1] == ' ')
3135 tracker
.advance_custom_word_point_by (end
- parser
.completion_word
);
3137 complete_linespec_component (&parser
, tracker
, end
,
3138 linespec_complete_what::KEYWORD
,
3144 /* A helper function for decode_line_full and decode_line_1 to
3145 turn LOCATION into std::vector<symtab_and_line>. */
3147 static std::vector
<symtab_and_line
>
3148 event_location_to_sals (linespec_parser
*parser
,
3149 const struct event_location
*location
)
3151 std::vector
<symtab_and_line
> result
;
3153 switch (event_location_type (location
))
3155 case LINESPEC_LOCATION
:
3157 PARSER_STATE (parser
)->is_linespec
= 1;
3160 const linespec_location
*ls
= get_linespec_location (location
);
3161 result
= parse_linespec (parser
,
3162 ls
->spec_string
, ls
->match_type
);
3164 catch (const gdb_exception_error
&except
)
3171 case ADDRESS_LOCATION
:
3173 const char *addr_string
= get_address_string_location (location
);
3174 CORE_ADDR addr
= get_address_location (location
);
3176 if (addr_string
!= NULL
)
3178 addr
= linespec_expression_to_pc (&addr_string
);
3179 if (PARSER_STATE (parser
)->canonical
!= NULL
)
3180 PARSER_STATE (parser
)->canonical
->location
3181 = copy_event_location (location
);
3184 result
= convert_address_location_to_sals (PARSER_STATE (parser
),
3189 case EXPLICIT_LOCATION
:
3191 const struct explicit_location
*explicit_loc
;
3193 explicit_loc
= get_explicit_location_const (location
);
3194 result
= convert_explicit_location_to_sals (PARSER_STATE (parser
),
3195 PARSER_RESULT (parser
),
3200 case PROBE_LOCATION
:
3201 /* Probes are handled by their own decoders. */
3202 gdb_assert_not_reached ("attempt to decode probe location");
3206 gdb_assert_not_reached ("unhandled event location type");
3212 /* See linespec.h. */
3215 decode_line_full (struct event_location
*location
, int flags
,
3216 struct program_space
*search_pspace
,
3217 struct symtab
*default_symtab
,
3218 int default_line
, struct linespec_result
*canonical
,
3219 const char *select_mode
,
3222 std::vector
<const char *> filters
;
3223 struct linespec_state
*state
;
3225 gdb_assert (canonical
!= NULL
);
3226 /* The filter only makes sense for 'all'. */
3227 gdb_assert (filter
== NULL
|| select_mode
== multiple_symbols_all
);
3228 gdb_assert (select_mode
== NULL
3229 || select_mode
== multiple_symbols_all
3230 || select_mode
== multiple_symbols_ask
3231 || select_mode
== multiple_symbols_cancel
);
3232 gdb_assert ((flags
& DECODE_LINE_LIST_MODE
) == 0);
3234 linespec_parser
parser (flags
, current_language
,
3235 search_pspace
, default_symtab
,
3236 default_line
, canonical
);
3238 scoped_restore_current_program_space restore_pspace
;
3240 std::vector
<symtab_and_line
> result
= event_location_to_sals (&parser
,
3242 state
= PARSER_STATE (&parser
);
3244 if (result
.size () == 0)
3245 throw_error (NOT_SUPPORTED_ERROR
, _("Location %s not available"),
3246 event_location_to_string (location
));
3248 gdb_assert (result
.size () == 1 || canonical
->pre_expanded
);
3249 canonical
->pre_expanded
= 1;
3251 /* Arrange for allocated canonical names to be freed. */
3252 std::vector
<gdb::unique_xmalloc_ptr
<char>> hold_names
;
3253 for (int i
= 0; i
< result
.size (); ++i
)
3255 gdb_assert (state
->canonical_names
[i
].suffix
!= NULL
);
3256 hold_names
.emplace_back (state
->canonical_names
[i
].suffix
);
3259 if (select_mode
== NULL
)
3261 if (top_level_interpreter ()->interp_ui_out ()->is_mi_like_p ())
3262 select_mode
= multiple_symbols_all
;
3264 select_mode
= multiple_symbols_select_mode ();
3267 if (select_mode
== multiple_symbols_all
)
3271 filters
.push_back (filter
);
3272 filter_results (state
, &result
, filters
);
3275 convert_results_to_lsals (state
, &result
);
3278 decode_line_2 (state
, &result
, select_mode
);
3281 /* See linespec.h. */
3283 std::vector
<symtab_and_line
>
3284 decode_line_1 (const struct event_location
*location
, int flags
,
3285 struct program_space
*search_pspace
,
3286 struct symtab
*default_symtab
,
3289 linespec_parser
parser (flags
, current_language
,
3290 search_pspace
, default_symtab
,
3291 default_line
, NULL
);
3293 scoped_restore_current_program_space restore_pspace
;
3295 return event_location_to_sals (&parser
, location
);
3298 /* See linespec.h. */
3300 std::vector
<symtab_and_line
>
3301 decode_line_with_current_source (const char *string
, int flags
)
3304 error (_("Empty line specification."));
3306 /* We use whatever is set as the current source line. We do not try
3307 and get a default source symtab+line or it will recursively call us! */
3308 symtab_and_line cursal
= get_current_source_symtab_and_line ();
3310 event_location_up location
= string_to_event_location (&string
,
3312 std::vector
<symtab_and_line
> sals
3313 = decode_line_1 (location
.get (), flags
, NULL
, cursal
.symtab
, cursal
.line
);
3316 error (_("Junk at end of line specification: %s"), string
);
3321 /* See linespec.h. */
3323 std::vector
<symtab_and_line
>
3324 decode_line_with_last_displayed (const char *string
, int flags
)
3327 error (_("Empty line specification."));
3329 event_location_up location
= string_to_event_location (&string
,
3331 std::vector
<symtab_and_line
> sals
3332 = (last_displayed_sal_is_valid ()
3333 ? decode_line_1 (location
.get (), flags
, NULL
,
3334 get_last_displayed_symtab (),
3335 get_last_displayed_line ())
3336 : decode_line_1 (location
.get (), flags
, NULL
, NULL
, 0));
3339 error (_("Junk at end of line specification: %s"), string
);
3346 /* First, some functions to initialize stuff at the beginning of the
3350 initialize_defaults (struct symtab
**default_symtab
, int *default_line
)
3352 if (*default_symtab
== 0)
3354 /* Use whatever we have for the default source line. We don't use
3355 get_current_or_default_symtab_and_line as it can recurse and call
3357 struct symtab_and_line cursal
=
3358 get_current_source_symtab_and_line ();
3360 *default_symtab
= cursal
.symtab
;
3361 *default_line
= cursal
.line
;
3367 /* Evaluate the expression pointed to by EXP_PTR into a CORE_ADDR,
3368 advancing EXP_PTR past any parsed text. */
3371 linespec_expression_to_pc (const char **exp_ptr
)
3373 if (current_program_space
->executing_startup
)
3374 /* The error message doesn't really matter, because this case
3375 should only hit during breakpoint reset. */
3376 throw_error (NOT_FOUND_ERROR
, _("cannot evaluate expressions while "
3377 "program space is in startup"));
3380 return value_as_address (parse_to_comma_and_eval (exp_ptr
));
3385 /* Here's where we recognise an Objective-C Selector. An Objective C
3386 selector may be implemented by more than one class, therefore it
3387 may represent more than one method/function. This gives us a
3388 situation somewhat analogous to C++ overloading. If there's more
3389 than one method that could represent the selector, then use some of
3390 the existing C++ code to let the user choose one. */
3392 static std::vector
<symtab_and_line
>
3393 decode_objc (struct linespec_state
*self
, linespec_p ls
, const char *arg
)
3395 struct collect_info info
;
3396 std::vector
<const char *> symbol_names
;
3397 const char *new_argptr
;
3400 std::vector
<symtab
*> symtabs
;
3401 symtabs
.push_back (nullptr);
3403 info
.file_symtabs
= &symtabs
;
3405 std::vector
<block_symbol
> symbols
;
3406 info
.result
.symbols
= &symbols
;
3407 std::vector
<bound_minimal_symbol
> minimal_symbols
;
3408 info
.result
.minimal_symbols
= &minimal_symbols
;
3410 new_argptr
= find_imps (arg
, &symbol_names
);
3411 if (symbol_names
.empty ())
3414 add_all_symbol_names_from_pspace (&info
, NULL
, symbol_names
,
3417 std::vector
<symtab_and_line
> values
;
3418 if (!symbols
.empty () || !minimal_symbols
.empty ())
3422 saved_arg
= (char *) alloca (new_argptr
- arg
+ 1);
3423 memcpy (saved_arg
, arg
, new_argptr
- arg
);
3424 saved_arg
[new_argptr
- arg
] = '\0';
3426 ls
->explicit_loc
.function_name
= xstrdup (saved_arg
);
3427 ls
->function_symbols
3428 = new std::vector
<block_symbol
> (std::move (symbols
));
3430 = new std::vector
<bound_minimal_symbol
> (std::move (minimal_symbols
));
3431 values
= convert_linespec_to_sals (self
, ls
);
3433 if (self
->canonical
)
3438 self
->canonical
->pre_expanded
= 1;
3440 if (ls
->explicit_loc
.source_filename
)
3442 holder
= string_printf ("%s:%s",
3443 ls
->explicit_loc
.source_filename
,
3445 str
= holder
.c_str ();
3450 self
->canonical
->location
3451 = new_linespec_location (&str
, symbol_name_match_type::FULL
);
3460 /* A function object that serves as symbol_found_callback_ftype
3461 callback for iterate_over_symbols. This is used by
3462 lookup_prefix_sym to collect type symbols. */
3463 class decode_compound_collector
3466 decode_compound_collector ()
3467 : m_unique_syms (htab_create_alloc (1, htab_hash_pointer
,
3468 htab_eq_pointer
, NULL
,
3473 /* Return all symbols collected. */
3474 std::vector
<block_symbol
> release_symbols ()
3476 return std::move (m_symbols
);
3479 /* Callable as a symbol_found_callback_ftype callback. */
3480 bool operator () (block_symbol
*bsym
);
3483 /* A hash table of all symbols we found. We use this to avoid
3484 adding any symbol more than once. */
3485 htab_up m_unique_syms
;
3487 /* The result vector. */
3488 std::vector
<block_symbol
> m_symbols
;
3492 decode_compound_collector::operator () (block_symbol
*bsym
)
3496 struct symbol
*sym
= bsym
->symbol
;
3498 if (SYMBOL_CLASS (sym
) != LOC_TYPEDEF
)
3499 return true; /* Continue iterating. */
3501 t
= SYMBOL_TYPE (sym
);
3502 t
= check_typedef (t
);
3503 if (t
->code () != TYPE_CODE_STRUCT
3504 && t
->code () != TYPE_CODE_UNION
3505 && t
->code () != TYPE_CODE_NAMESPACE
)
3506 return true; /* Continue iterating. */
3508 slot
= htab_find_slot (m_unique_syms
.get (), sym
, INSERT
);
3512 m_symbols
.push_back (*bsym
);
3515 return true; /* Continue iterating. */
3520 /* Return any symbols corresponding to CLASS_NAME in FILE_SYMTABS. */
3522 static std::vector
<block_symbol
>
3523 lookup_prefix_sym (struct linespec_state
*state
,
3524 std::vector
<symtab
*> *file_symtabs
,
3525 const char *class_name
)
3527 decode_compound_collector collector
;
3529 lookup_name_info
lookup_name (class_name
, symbol_name_match_type::FULL
);
3531 for (const auto &elt
: *file_symtabs
)
3535 iterate_over_all_matching_symtabs (state
, lookup_name
,
3536 STRUCT_DOMAIN
, ALL_DOMAIN
,
3537 NULL
, false, collector
);
3538 iterate_over_all_matching_symtabs (state
, lookup_name
,
3539 VAR_DOMAIN
, ALL_DOMAIN
,
3540 NULL
, false, collector
);
3544 /* Program spaces that are executing startup should have
3545 been filtered out earlier. */
3546 gdb_assert (!SYMTAB_PSPACE (elt
)->executing_startup
);
3547 set_current_program_space (SYMTAB_PSPACE (elt
));
3548 iterate_over_file_blocks (elt
, lookup_name
, STRUCT_DOMAIN
, collector
);
3549 iterate_over_file_blocks (elt
, lookup_name
, VAR_DOMAIN
, collector
);
3553 return collector
.release_symbols ();
3556 /* A std::sort comparison function for symbols. The resulting order does
3557 not actually matter; we just need to be able to sort them so that
3558 symbols with the same program space end up next to each other. */
3561 compare_symbols (const block_symbol
&a
, const block_symbol
&b
)
3565 uia
= (uintptr_t) SYMTAB_PSPACE (symbol_symtab (a
.symbol
));
3566 uib
= (uintptr_t) SYMTAB_PSPACE (symbol_symtab (b
.symbol
));
3573 uia
= (uintptr_t) a
.symbol
;
3574 uib
= (uintptr_t) b
.symbol
;
3582 /* Like compare_symbols but for minimal symbols. */
3585 compare_msymbols (const bound_minimal_symbol
&a
, const bound_minimal_symbol
&b
)
3589 uia
= (uintptr_t) a
.objfile
->pspace
;
3590 uib
= (uintptr_t) a
.objfile
->pspace
;
3597 uia
= (uintptr_t) a
.minsym
;
3598 uib
= (uintptr_t) b
.minsym
;
3606 /* Look for all the matching instances of each symbol in NAMES. Only
3607 instances from PSPACE are considered; other program spaces are
3608 handled by our caller. If PSPACE is NULL, then all program spaces
3609 are considered. Results are stored into INFO. */
3612 add_all_symbol_names_from_pspace (struct collect_info
*info
,
3613 struct program_space
*pspace
,
3614 const std::vector
<const char *> &names
,
3615 enum search_domain search_domain
)
3617 for (const char *iter
: names
)
3618 add_matching_symbols_to_info (iter
,
3619 symbol_name_match_type::FULL
,
3620 search_domain
, info
, pspace
);
3624 find_superclass_methods (std::vector
<struct type
*> &&superclasses
,
3625 const char *name
, enum language name_lang
,
3626 std::vector
<const char *> *result_names
)
3628 size_t old_len
= result_names
->size ();
3632 std::vector
<struct type
*> new_supers
;
3634 for (type
*t
: superclasses
)
3635 find_methods (t
, name_lang
, name
, result_names
, &new_supers
);
3637 if (result_names
->size () != old_len
|| new_supers
.empty ())
3640 superclasses
= std::move (new_supers
);
3644 /* This finds the method METHOD_NAME in the class CLASS_NAME whose type is
3645 given by one of the symbols in SYM_CLASSES. Matches are returned
3646 in SYMBOLS (for debug symbols) and MINSYMS (for minimal symbols). */
3649 find_method (struct linespec_state
*self
, std::vector
<symtab
*> *file_symtabs
,
3650 const char *class_name
, const char *method_name
,
3651 std::vector
<block_symbol
> *sym_classes
,
3652 std::vector
<block_symbol
> *symbols
,
3653 std::vector
<bound_minimal_symbol
> *minsyms
)
3655 size_t last_result_len
;
3656 std::vector
<struct type
*> superclass_vec
;
3657 std::vector
<const char *> result_names
;
3658 struct collect_info info
;
3660 /* Sort symbols so that symbols with the same program space are next
3662 std::sort (sym_classes
->begin (), sym_classes
->end (),
3666 info
.file_symtabs
= file_symtabs
;
3667 info
.result
.symbols
= symbols
;
3668 info
.result
.minimal_symbols
= minsyms
;
3670 /* Iterate over all the types, looking for the names of existing
3671 methods matching METHOD_NAME. If we cannot find a direct method in a
3672 given program space, then we consider inherited methods; this is
3673 not ideal (ideal would be to respect C++ hiding rules), but it
3674 seems good enough and is what GDB has historically done. We only
3675 need to collect the names because later we find all symbols with
3676 those names. This loop is written in a somewhat funny way
3677 because we collect data across the program space before deciding
3679 last_result_len
= 0;
3680 for (const auto &elt
: *sym_classes
)
3683 struct program_space
*pspace
;
3684 struct symbol
*sym
= elt
.symbol
;
3685 unsigned int ix
= &elt
- &*sym_classes
->begin ();
3687 /* Program spaces that are executing startup should have
3688 been filtered out earlier. */
3689 pspace
= SYMTAB_PSPACE (symbol_symtab (sym
));
3690 gdb_assert (!pspace
->executing_startup
);
3691 set_current_program_space (pspace
);
3692 t
= check_typedef (SYMBOL_TYPE (sym
));
3693 find_methods (t
, sym
->language (),
3694 method_name
, &result_names
, &superclass_vec
);
3696 /* Handle all items from a single program space at once; and be
3697 sure not to miss the last batch. */
3698 if (ix
== sym_classes
->size () - 1
3700 != SYMTAB_PSPACE (symbol_symtab (sym_classes
->at (ix
+ 1).symbol
))))
3702 /* If we did not find a direct implementation anywhere in
3703 this program space, consider superclasses. */
3704 if (result_names
.size () == last_result_len
)
3705 find_superclass_methods (std::move (superclass_vec
), method_name
,
3706 sym
->language (), &result_names
);
3708 /* We have a list of candidate symbol names, so now we
3709 iterate over the symbol tables looking for all
3710 matches in this pspace. */
3711 add_all_symbol_names_from_pspace (&info
, pspace
, result_names
,
3714 superclass_vec
.clear ();
3715 last_result_len
= result_names
.size ();
3719 if (!symbols
->empty () || !minsyms
->empty ())
3722 /* Throw an NOT_FOUND_ERROR. This will be caught by the caller
3723 and other attempts to locate the symbol will be made. */
3724 throw_error (NOT_FOUND_ERROR
, _("see caller, this text doesn't matter"));
3731 /* This function object is a callback for iterate_over_symtabs, used
3732 when collecting all matching symtabs. */
3734 class symtab_collector
3738 : m_symtab_table (htab_create (1, htab_hash_pointer
, htab_eq_pointer
,
3743 /* Callable as a symbol_found_callback_ftype callback. */
3744 bool operator () (symtab
*sym
);
3746 /* Return an rvalue reference to the collected symtabs. */
3747 std::vector
<symtab
*> &&release_symtabs ()
3749 return std::move (m_symtabs
);
3753 /* The result vector of symtabs. */
3754 std::vector
<symtab
*> m_symtabs
;
3756 /* This is used to ensure the symtabs are unique. */
3757 htab_up m_symtab_table
;
3761 symtab_collector::operator () (struct symtab
*symtab
)
3765 slot
= htab_find_slot (m_symtab_table
.get (), symtab
, INSERT
);
3769 m_symtabs
.push_back (symtab
);
3777 /* Given a file name, return a list of all matching symtabs. If
3778 SEARCH_PSPACE is not NULL, the search is restricted to just that
3781 static std::vector
<symtab
*>
3782 collect_symtabs_from_filename (const char *file
,
3783 struct program_space
*search_pspace
)
3785 symtab_collector collector
;
3787 /* Find that file's data. */
3788 if (search_pspace
== NULL
)
3790 for (struct program_space
*pspace
: program_spaces
)
3792 if (pspace
->executing_startup
)
3795 set_current_program_space (pspace
);
3796 iterate_over_symtabs (file
, collector
);
3801 set_current_program_space (search_pspace
);
3802 iterate_over_symtabs (file
, collector
);
3805 return collector
.release_symtabs ();
3808 /* Return all the symtabs associated to the FILENAME. If SEARCH_PSPACE is
3809 not NULL, the search is restricted to just that program space. */
3811 static std::vector
<symtab
*>
3812 symtabs_from_filename (const char *filename
,
3813 struct program_space
*search_pspace
)
3815 std::vector
<symtab
*> result
3816 = collect_symtabs_from_filename (filename
, search_pspace
);
3818 if (result
.empty ())
3820 if (!have_full_symbols () && !have_partial_symbols ())
3821 throw_error (NOT_FOUND_ERROR
,
3822 _("No symbol table is loaded. "
3823 "Use the \"file\" command."));
3824 source_file_not_found_error (filename
);
3833 symbol_searcher::find_all_symbols (const std::string
&name
,
3834 const struct language_defn
*language
,
3835 enum search_domain search_domain
,
3836 std::vector
<symtab
*> *search_symtabs
,
3837 struct program_space
*search_pspace
)
3839 symbol_searcher_collect_info info
;
3840 struct linespec_state state
;
3842 memset (&state
, 0, sizeof (state
));
3843 state
.language
= language
;
3844 info
.state
= &state
;
3846 info
.result
.symbols
= &m_symbols
;
3847 info
.result
.minimal_symbols
= &m_minimal_symbols
;
3848 std::vector
<symtab
*> all_symtabs
;
3849 if (search_symtabs
== nullptr)
3851 all_symtabs
.push_back (nullptr);
3852 search_symtabs
= &all_symtabs
;
3854 info
.file_symtabs
= search_symtabs
;
3856 add_matching_symbols_to_info (name
.c_str (), symbol_name_match_type::WILD
,
3857 search_domain
, &info
, search_pspace
);
3860 /* Look up a function symbol named NAME in symtabs FILE_SYMTABS. Matching
3861 debug symbols are returned in SYMBOLS. Matching minimal symbols are
3862 returned in MINSYMS. */
3865 find_function_symbols (struct linespec_state
*state
,
3866 std::vector
<symtab
*> *file_symtabs
, const char *name
,
3867 symbol_name_match_type name_match_type
,
3868 std::vector
<block_symbol
> *symbols
,
3869 std::vector
<bound_minimal_symbol
> *minsyms
)
3871 struct collect_info info
;
3872 std::vector
<const char *> symbol_names
;
3875 info
.result
.symbols
= symbols
;
3876 info
.result
.minimal_symbols
= minsyms
;
3877 info
.file_symtabs
= file_symtabs
;
3879 /* Try NAME as an Objective-C selector. */
3880 find_imps (name
, &symbol_names
);
3881 if (!symbol_names
.empty ())
3882 add_all_symbol_names_from_pspace (&info
, state
->search_pspace
,
3883 symbol_names
, FUNCTIONS_DOMAIN
);
3885 add_matching_symbols_to_info (name
, name_match_type
, FUNCTIONS_DOMAIN
,
3886 &info
, state
->search_pspace
);
3889 /* Find all symbols named NAME in FILE_SYMTABS, returning debug symbols
3890 in SYMBOLS and minimal symbols in MINSYMS. */
3893 find_linespec_symbols (struct linespec_state
*state
,
3894 std::vector
<symtab
*> *file_symtabs
,
3895 const char *lookup_name
,
3896 symbol_name_match_type name_match_type
,
3897 std::vector
<block_symbol
> *symbols
,
3898 std::vector
<bound_minimal_symbol
> *minsyms
)
3900 gdb::unique_xmalloc_ptr
<char> canon
3901 = cp_canonicalize_string_no_typedefs (lookup_name
);
3902 if (canon
!= nullptr)
3903 lookup_name
= canon
.get ();
3905 /* It's important to not call expand_symtabs_matching unnecessarily
3906 as it can really slow things down (by unnecessarily expanding
3907 potentially 1000s of symtabs, which when debugging some apps can
3908 cost 100s of seconds). Avoid this to some extent by *first* calling
3909 find_function_symbols, and only if that doesn't find anything
3910 *then* call find_method. This handles two important cases:
3911 1) break (anonymous namespace)::foo
3912 2) break class::method where method is in class (and not a baseclass) */
3914 find_function_symbols (state
, file_symtabs
, lookup_name
,
3915 name_match_type
, symbols
, minsyms
);
3917 /* If we were unable to locate a symbol of the same name, try dividing
3918 the name into class and method names and searching the class and its
3920 if (symbols
->empty () && minsyms
->empty ())
3922 std::string klass
, method
;
3923 const char *last
, *p
, *scope_op
;
3925 /* See if we can find a scope operator and break this symbol
3926 name into namespaces${SCOPE_OPERATOR}class_name and method_name. */
3928 p
= find_toplevel_string (lookup_name
, scope_op
);
3934 p
= find_toplevel_string (p
+ strlen (scope_op
), scope_op
);
3937 /* If no scope operator was found, there is nothing more we can do;
3938 we already attempted to lookup the entire name as a symbol
3943 /* LOOKUP_NAME points to the class name.
3944 LAST points to the method name. */
3945 klass
= std::string (lookup_name
, last
- lookup_name
);
3947 /* Skip past the scope operator. */
3948 last
+= strlen (scope_op
);
3951 /* Find a list of classes named KLASS. */
3952 std::vector
<block_symbol
> classes
3953 = lookup_prefix_sym (state
, file_symtabs
, klass
.c_str ());
3954 if (!classes
.empty ())
3956 /* Now locate a list of suitable methods named METHOD. */
3959 find_method (state
, file_symtabs
,
3960 klass
.c_str (), method
.c_str (),
3961 &classes
, symbols
, minsyms
);
3964 /* If successful, we're done. If NOT_FOUND_ERROR
3965 was not thrown, rethrow the exception that we did get. */
3966 catch (const gdb_exception_error
&except
)
3968 if (except
.error
!= NOT_FOUND_ERROR
)
3975 /* Helper for find_label_symbols. Find all labels that match name
3976 NAME in BLOCK. Return all labels that match in FUNCTION_SYMBOLS.
3977 Return the actual function symbol in which the label was found in
3978 LABEL_FUNC_RET. If COMPLETION_MODE is true, then NAME is
3979 interpreted as a label name prefix. Otherwise, only a label named
3980 exactly NAME match. */
3983 find_label_symbols_in_block (const struct block
*block
,
3984 const char *name
, struct symbol
*fn_sym
,
3985 bool completion_mode
,
3986 std::vector
<block_symbol
> *result
,
3987 std::vector
<block_symbol
> *label_funcs_ret
)
3989 if (completion_mode
)
3991 struct block_iterator iter
;
3993 size_t name_len
= strlen (name
);
3995 int (*cmp
) (const char *, const char *, size_t);
3996 cmp
= case_sensitivity
== case_sensitive_on
? strncmp
: strncasecmp
;
3998 ALL_BLOCK_SYMBOLS (block
, iter
, sym
)
4000 if (symbol_matches_domain (sym
->language (),
4001 SYMBOL_DOMAIN (sym
), LABEL_DOMAIN
)
4002 && cmp (sym
->search_name (), name
, name_len
) == 0)
4004 result
->push_back ({sym
, block
});
4005 label_funcs_ret
->push_back ({fn_sym
, block
});
4011 struct block_symbol label_sym
4012 = lookup_symbol (name
, block
, LABEL_DOMAIN
, 0);
4014 if (label_sym
.symbol
!= NULL
)
4016 result
->push_back (label_sym
);
4017 label_funcs_ret
->push_back ({fn_sym
, block
});
4022 /* Return all labels that match name NAME in FUNCTION_SYMBOLS or NULL
4023 if no matches were found.
4025 Return the actual function symbol in which the label was found in
4026 LABEL_FUNC_RET. If COMPLETION_MODE is true, then NAME is
4027 interpreted as a label name prefix. Otherwise, only labels named
4028 exactly NAME match. */
4031 static std::vector
<block_symbol
> *
4032 find_label_symbols (struct linespec_state
*self
,
4033 std::vector
<block_symbol
> *function_symbols
,
4034 std::vector
<block_symbol
> *label_funcs_ret
,
4036 bool completion_mode
)
4038 const struct block
*block
;
4039 struct symbol
*fn_sym
;
4040 std::vector
<block_symbol
> result
;
4042 if (function_symbols
== NULL
)
4044 set_current_program_space (self
->program_space
);
4045 block
= get_current_search_block ();
4048 block
&& !BLOCK_FUNCTION (block
);
4049 block
= BLOCK_SUPERBLOCK (block
))
4053 fn_sym
= BLOCK_FUNCTION (block
);
4055 find_label_symbols_in_block (block
, name
, fn_sym
, completion_mode
,
4056 &result
, label_funcs_ret
);
4060 for (const auto &elt
: *function_symbols
)
4062 fn_sym
= elt
.symbol
;
4063 set_current_program_space (SYMTAB_PSPACE (symbol_symtab (fn_sym
)));
4064 block
= SYMBOL_BLOCK_VALUE (fn_sym
);
4066 find_label_symbols_in_block (block
, name
, fn_sym
, completion_mode
,
4067 &result
, label_funcs_ret
);
4071 if (!result
.empty ())
4072 return new std::vector
<block_symbol
> (std::move (result
));
4078 /* A helper for create_sals_line_offset that handles the 'list_mode' case. */
4080 static std::vector
<symtab_and_line
>
4081 decode_digits_list_mode (struct linespec_state
*self
,
4083 struct symtab_and_line val
)
4085 gdb_assert (self
->list_mode
);
4087 std::vector
<symtab_and_line
> values
;
4089 for (const auto &elt
: *ls
->file_symtabs
)
4091 /* The logic above should ensure this. */
4092 gdb_assert (elt
!= NULL
);
4094 set_current_program_space (SYMTAB_PSPACE (elt
));
4096 /* Simplistic search just for the list command. */
4097 val
.symtab
= find_line_symtab (elt
, val
.line
, NULL
, NULL
);
4098 if (val
.symtab
== NULL
)
4100 val
.pspace
= SYMTAB_PSPACE (elt
);
4102 val
.explicit_line
= true;
4104 add_sal_to_sals (self
, &values
, &val
, NULL
, 0);
4110 /* A helper for create_sals_line_offset that iterates over the symtabs
4111 associated with LS and returns a vector of corresponding symtab_and_line
4114 static std::vector
<symtab_and_line
>
4115 decode_digits_ordinary (struct linespec_state
*self
,
4118 struct linetable_entry
**best_entry
)
4120 std::vector
<symtab_and_line
> sals
;
4121 for (const auto &elt
: *ls
->file_symtabs
)
4123 std::vector
<CORE_ADDR
> pcs
;
4125 /* The logic above should ensure this. */
4126 gdb_assert (elt
!= NULL
);
4128 set_current_program_space (SYMTAB_PSPACE (elt
));
4130 pcs
= find_pcs_for_symtab_line (elt
, line
, best_entry
);
4131 for (CORE_ADDR pc
: pcs
)
4133 symtab_and_line sal
;
4134 sal
.pspace
= SYMTAB_PSPACE (elt
);
4137 sal
.explicit_line
= true;
4139 sals
.push_back (std::move (sal
));
4148 /* Return the line offset represented by VARIABLE. */
4150 static struct line_offset
4151 linespec_parse_variable (struct linespec_state
*self
, const char *variable
)
4155 struct line_offset offset
= {0, LINE_OFFSET_NONE
};
4157 p
= (variable
[1] == '$') ? variable
+ 2 : variable
+ 1;
4160 while (*p
>= '0' && *p
<= '9')
4162 if (!*p
) /* Reached end of token without hitting non-digit. */
4164 /* We have a value history reference. */
4165 struct value
*val_history
;
4167 sscanf ((variable
[1] == '$') ? variable
+ 2 : variable
+ 1, "%d", &index
);
4169 = access_value_history ((variable
[1] == '$') ? -index
: index
);
4170 if (value_type (val_history
)->code () != TYPE_CODE_INT
)
4171 error (_("History values used in line "
4172 "specs must have integer values."));
4173 offset
.offset
= value_as_long (val_history
);
4177 /* Not all digits -- may be user variable/function or a
4178 convenience variable. */
4180 struct internalvar
*ivar
;
4182 /* Try it as a convenience variable. If it is not a convenience
4183 variable, return and allow normal symbol lookup to occur. */
4184 ivar
= lookup_only_internalvar (variable
+ 1);
4186 /* No internal variable with that name. Mark the offset
4187 as unknown to allow the name to be looked up as a symbol. */
4188 offset
.sign
= LINE_OFFSET_UNKNOWN
;
4191 /* We found a valid variable name. If it is not an integer,
4193 if (!get_internalvar_integer (ivar
, &valx
))
4194 error (_("Convenience variables used in line "
4195 "specs must have integer values."));
4197 offset
.offset
= valx
;
4205 /* We've found a minimal symbol MSYMBOL in OBJFILE to associate with our
4206 linespec; return the SAL in RESULT. This function should return SALs
4207 matching those from find_function_start_sal, otherwise false
4208 multiple-locations breakpoints could be placed. */
4211 minsym_found (struct linespec_state
*self
, struct objfile
*objfile
,
4212 struct minimal_symbol
*msymbol
,
4213 std::vector
<symtab_and_line
> *result
)
4215 bool want_start_sal
;
4217 CORE_ADDR func_addr
;
4218 bool is_function
= msymbol_is_function (objfile
, msymbol
, &func_addr
);
4222 const char *msym_name
= msymbol
->linkage_name ();
4224 if (MSYMBOL_TYPE (msymbol
) == mst_text_gnu_ifunc
4225 || MSYMBOL_TYPE (msymbol
) == mst_data_gnu_ifunc
)
4226 want_start_sal
= gnu_ifunc_resolve_name (msym_name
, &func_addr
);
4228 want_start_sal
= true;
4231 symtab_and_line sal
;
4233 if (is_function
&& want_start_sal
)
4234 sal
= find_function_start_sal (func_addr
, NULL
, self
->funfirstline
);
4237 sal
.objfile
= objfile
;
4238 sal
.msymbol
= msymbol
;
4239 /* Store func_addr, not the minsym's address in case this was an
4240 ifunc that hasn't been resolved yet. */
4244 sal
.pc
= MSYMBOL_VALUE_ADDRESS (objfile
, msymbol
);
4245 sal
.pspace
= current_program_space
;
4248 sal
.section
= MSYMBOL_OBJ_SECTION (objfile
, msymbol
);
4250 if (maybe_add_address (self
->addr_set
, objfile
->pspace
, sal
.pc
))
4251 add_sal_to_sals (self
, result
, &sal
, msymbol
->natural_name (), 0);
4254 /* Helper for search_minsyms_for_name that adds the symbol to the
4258 add_minsym (struct minimal_symbol
*minsym
, struct objfile
*objfile
,
4259 struct symtab
*symtab
, int list_mode
,
4260 std::vector
<struct bound_minimal_symbol
> *msyms
)
4264 /* We're looking for a label for which we don't have debug
4266 CORE_ADDR func_addr
;
4267 if (msymbol_is_function (objfile
, minsym
, &func_addr
))
4269 symtab_and_line sal
= find_pc_sect_line (func_addr
, NULL
, 0);
4271 if (symtab
!= sal
.symtab
)
4276 /* Exclude data symbols when looking for breakpoint locations. */
4277 if (!list_mode
&& !msymbol_is_function (objfile
, minsym
))
4280 struct bound_minimal_symbol mo
= {minsym
, objfile
};
4281 msyms
->push_back (mo
);
4285 /* Search for minimal symbols called NAME. If SEARCH_PSPACE
4286 is not NULL, the search is restricted to just that program
4289 If SYMTAB is NULL, search all objfiles, otherwise
4290 restrict results to the given SYMTAB. */
4293 search_minsyms_for_name (struct collect_info
*info
,
4294 const lookup_name_info
&name
,
4295 struct program_space
*search_pspace
,
4296 struct symtab
*symtab
)
4298 std::vector
<struct bound_minimal_symbol
> minsyms
;
4302 for (struct program_space
*pspace
: program_spaces
)
4304 if (search_pspace
!= NULL
&& search_pspace
!= pspace
)
4306 if (pspace
->executing_startup
)
4309 set_current_program_space (pspace
);
4311 for (objfile
*objfile
: current_program_space
->objfiles ())
4313 iterate_over_minimal_symbols (objfile
, name
,
4314 [&] (struct minimal_symbol
*msym
)
4316 add_minsym (msym
, objfile
, nullptr,
4317 info
->state
->list_mode
,
4326 if (search_pspace
== NULL
|| SYMTAB_PSPACE (symtab
) == search_pspace
)
4328 set_current_program_space (SYMTAB_PSPACE (symtab
));
4329 iterate_over_minimal_symbols
4330 (SYMTAB_OBJFILE (symtab
), name
,
4331 [&] (struct minimal_symbol
*msym
)
4333 add_minsym (msym
, SYMTAB_OBJFILE (symtab
), symtab
,
4334 info
->state
->list_mode
, &minsyms
);
4340 /* Return true if TYPE is a static symbol. */
4341 auto msymbol_type_is_static
= [] (enum minimal_symbol_type type
)
4354 /* Add minsyms to the result set, but filter out trampoline symbols
4355 if we also found extern symbols with the same name. I.e., don't
4356 set a breakpoint on both '<foo@plt>' and 'foo', assuming that
4357 'foo' is the symbol that the plt resolves to. */
4358 for (const bound_minimal_symbol
&item
: minsyms
)
4361 if (MSYMBOL_TYPE (item
.minsym
) == mst_solib_trampoline
)
4363 for (const bound_minimal_symbol
&item2
: minsyms
)
4365 if (&item2
== &item
)
4368 /* Trampoline symbols can only jump to exported
4370 if (msymbol_type_is_static (MSYMBOL_TYPE (item2
.minsym
)))
4373 if (strcmp (item
.minsym
->linkage_name (),
4374 item2
.minsym
->linkage_name ()) != 0)
4377 /* Found a global minsym with the same name as the
4378 trampoline. Don't create a location for this
4386 info
->result
.minimal_symbols
->push_back (item
);
4390 /* A helper function to add all symbols matching NAME to INFO. If
4391 PSPACE is not NULL, the search is restricted to just that program
4395 add_matching_symbols_to_info (const char *name
,
4396 symbol_name_match_type name_match_type
,
4397 enum search_domain search_domain
,
4398 struct collect_info
*info
,
4399 struct program_space
*pspace
)
4401 lookup_name_info
lookup_name (name
, name_match_type
);
4403 for (const auto &elt
: *info
->file_symtabs
)
4407 iterate_over_all_matching_symtabs (info
->state
, lookup_name
,
4408 VAR_DOMAIN
, search_domain
,
4410 [&] (block_symbol
*bsym
)
4411 { return info
->add_symbol (bsym
); });
4412 search_minsyms_for_name (info
, lookup_name
, pspace
, NULL
);
4414 else if (pspace
== NULL
|| pspace
== SYMTAB_PSPACE (elt
))
4416 int prev_len
= info
->result
.symbols
->size ();
4418 /* Program spaces that are executing startup should have
4419 been filtered out earlier. */
4420 gdb_assert (!SYMTAB_PSPACE (elt
)->executing_startup
);
4421 set_current_program_space (SYMTAB_PSPACE (elt
));
4422 iterate_over_file_blocks (elt
, lookup_name
, VAR_DOMAIN
,
4423 [&] (block_symbol
*bsym
)
4424 { return info
->add_symbol (bsym
); });
4426 /* If no new symbols were found in this iteration and this symtab
4427 is in assembler, we might actually be looking for a label for
4428 which we don't have debug info. Check for a minimal symbol in
4430 if (prev_len
== info
->result
.symbols
->size ()
4431 && elt
->language
== language_asm
)
4432 search_minsyms_for_name (info
, lookup_name
, pspace
, elt
);
4439 /* Now come some functions that are called from multiple places within
4443 symbol_to_sal (struct symtab_and_line
*result
,
4444 int funfirstline
, struct symbol
*sym
)
4446 if (SYMBOL_CLASS (sym
) == LOC_BLOCK
)
4448 *result
= find_function_start_sal (sym
, funfirstline
);
4453 if (SYMBOL_CLASS (sym
) == LOC_LABEL
&& SYMBOL_VALUE_ADDRESS (sym
) != 0)
4456 result
->symtab
= symbol_symtab (sym
);
4457 result
->symbol
= sym
;
4458 result
->line
= SYMBOL_LINE (sym
);
4459 result
->pc
= SYMBOL_VALUE_ADDRESS (sym
);
4460 result
->pspace
= SYMTAB_PSPACE (result
->symtab
);
4461 result
->explicit_pc
= 1;
4464 else if (funfirstline
)
4468 else if (SYMBOL_LINE (sym
) != 0)
4470 /* We know its line number. */
4472 result
->symtab
= symbol_symtab (sym
);
4473 result
->symbol
= sym
;
4474 result
->line
= SYMBOL_LINE (sym
);
4475 result
->pc
= SYMBOL_VALUE_ADDRESS (sym
);
4476 result
->pspace
= SYMTAB_PSPACE (result
->symtab
);
4484 linespec_result::~linespec_result ()
4486 for (linespec_sals
&lsal
: lsals
)
4487 xfree (lsal
.canonical
);
4490 /* Return the quote characters permitted by the linespec parser. */
4493 get_gdb_linespec_parser_quote_characters (void)
4495 return linespec_quote_characters
;