1 /* Parser for linespec for the GNU debugger, GDB.
3 Copyright (C) 1986-2019 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
29 #include "completer.h"
31 #include "cp-support.h"
32 #include "parser-defs.h"
34 #include "objc-lang.h"
38 #include "mi/mi-cmds.h"
40 #include "arch-utils.h"
42 #include "cli/cli-utils.h"
43 #include "filenames.h"
47 #include "common/function-view.h"
48 #include "common/def-vector.h"
51 /* An enumeration of the various things a user might attempt to
52 complete for a linespec location. */
54 enum class linespec_complete_what
56 /* Nothing, no possible completion. */
59 /* A function/method name. Due to ambiguity between
65 this can also indicate a source filename, iff we haven't seen a
66 separate source filename component, as in "b source.c:function". */
69 /* A label symbol. E.g., break file.c:function:LABEL. */
72 /* An expression. E.g., "break foo if EXPR", or "break *EXPR". */
75 /* A linespec keyword ("if"/"thread"/"task").
76 E.g., "break func threa<tab>". */
80 /* An address entry is used to ensure that any given location is only
81 added to the result a single time. It holds an address and the
82 program space from which the address came. */
86 struct program_space
*pspace
;
90 /* A linespec. Elements of this structure are filled in by a parser
91 (either parse_linespec or some other function). The structure is
92 then converted into SALs by convert_linespec_to_sals. */
96 /* An explicit location describing the SaLs. */
97 struct explicit_location explicit_loc
;
99 /* The list of symtabs to search to which to limit the search. May not
100 be NULL. If explicit.SOURCE_FILENAME is NULL (no user-specified
101 filename), FILE_SYMTABS should contain one single NULL member. This
102 will cause the code to use the default symtab. */
103 std::vector
<symtab
*> *file_symtabs
;
105 /* A list of matching function symbols and minimal symbols. Both lists
106 may be NULL (or empty) if no matching symbols were found. */
107 std::vector
<block_symbol
> *function_symbols
;
108 std::vector
<bound_minimal_symbol
> *minimal_symbols
;
110 /* A structure of matching label symbols and the corresponding
111 function symbol in which the label was found. Both may be NULL
112 or both must be non-NULL. */
115 std::vector
<block_symbol
> *label_symbols
;
116 std::vector
<block_symbol
> *function_symbols
;
119 typedef struct linespec
*linespec_p
;
121 /* A canonical linespec represented as a symtab-related string.
123 Each entry represents the "SYMTAB:SUFFIX" linespec string.
124 SYMTAB can be converted for example by symtab_to_fullname or
125 symtab_to_filename_for_display as needed. */
127 struct linespec_canonical_name
129 /* Remaining text part of the linespec string. */
132 /* If NULL then SUFFIX is the whole linespec string. */
133 struct symtab
*symtab
;
136 /* An instance of this is used to keep all state while linespec
137 operates. This instance is passed around as a 'this' pointer to
138 the various implementation methods. */
140 struct linespec_state
142 /* The language in use during linespec processing. */
143 const struct language_defn
*language
;
145 /* The program space as seen when the module was entered. */
146 struct program_space
*program_space
;
148 /* If not NULL, the search is restricted to just this program
150 struct program_space
*search_pspace
;
152 /* The default symtab to use, if no other symtab is specified. */
153 struct symtab
*default_symtab
;
155 /* The default line to use. */
158 /* The 'funfirstline' value that was passed in to decode_line_1 or
162 /* Nonzero if we are running in 'list' mode; see decode_line_list. */
165 /* The 'canonical' value passed to decode_line_full, or NULL. */
166 struct linespec_result
*canonical
;
168 /* Canonical strings that mirror the std::vector<symtab_and_line> result. */
169 struct linespec_canonical_name
*canonical_names
;
171 /* This is a set of address_entry objects which is used to prevent
172 duplicate symbols from being entered into the result. */
175 /* Are we building a linespec? */
179 /* This is a helper object that is used when collecting symbols into a
184 /* The linespec object in use. */
185 struct linespec_state
*state
;
187 /* A list of symtabs to which to restrict matches. */
188 std::vector
<symtab
*> *file_symtabs
;
190 /* The result being accumulated. */
193 std::vector
<block_symbol
> *symbols
;
194 std::vector
<bound_minimal_symbol
> *minimal_symbols
;
197 /* Possibly add a symbol to the results. */
198 virtual bool add_symbol (block_symbol
*bsym
);
202 collect_info::add_symbol (block_symbol
*bsym
)
204 /* In list mode, add all matching symbols, regardless of class.
205 This allows the user to type "list a_global_variable". */
206 if (SYMBOL_CLASS (bsym
->symbol
) == LOC_BLOCK
|| this->state
->list_mode
)
207 this->result
.symbols
->push_back (*bsym
);
209 /* Continue iterating. */
213 /* Custom collect_info for symbol_searcher. */
215 struct symbol_searcher_collect_info
218 bool add_symbol (block_symbol
*bsym
) override
220 /* Add everything. */
221 this->result
.symbols
->push_back (*bsym
);
223 /* Continue iterating. */
235 /* A colon "separator" */
247 /* EOI (end of input) */
253 typedef enum ls_token_type linespec_token_type
;
255 /* List of keywords. This is NULL-terminated so that it can be used
256 as enum completer. */
257 const char * const linespec_keywords
[] = { "if", "thread", "task", NULL
};
258 #define IF_KEYWORD_INDEX 0
260 /* A token of the linespec lexer */
264 /* The type of the token */
265 linespec_token_type type
;
267 /* Data for the token */
270 /* A string, given as a stoken */
271 struct stoken string
;
277 typedef struct ls_token linespec_token
;
279 #define LS_TOKEN_STOKEN(TOK) (TOK).data.string
280 #define LS_TOKEN_KEYWORD(TOK) (TOK).data.keyword
282 /* An instance of the linespec parser. */
284 struct linespec_parser
286 linespec_parser (int flags
, const struct language_defn
*language
,
287 struct program_space
*search_pspace
,
288 struct symtab
*default_symtab
,
290 struct linespec_result
*canonical
);
294 DISABLE_COPY_AND_ASSIGN (linespec_parser
);
296 /* Lexer internal data */
299 /* Save head of input stream. */
300 const char *saved_arg
;
302 /* Head of the input stream. */
304 #define PARSER_STREAM(P) ((P)->lexer.stream)
306 /* The current token. */
307 linespec_token current
;
310 /* Is the entire linespec quote-enclosed? */
311 int is_quote_enclosed
= 0;
313 /* The state of the parse. */
314 struct linespec_state state
{};
315 #define PARSER_STATE(PPTR) (&(PPTR)->state)
317 /* The result of the parse. */
318 struct linespec result
{};
319 #define PARSER_RESULT(PPTR) (&(PPTR)->result)
321 /* What the parser believes the current word point should complete
323 linespec_complete_what complete_what
= linespec_complete_what::NOTHING
;
325 /* The completion word point. The parser advances this as it skips
326 tokens. At some point the input string will end or parsing will
327 fail, and then we attempt completion at the captured completion
328 word point, interpreting the string at completion_word as
330 const char *completion_word
= nullptr;
332 /* If the current token was a quoted string, then this is the
333 quoting character (either " or '). */
334 int completion_quote_char
= 0;
336 /* If the current token was a quoted string, then this points at the
337 end of the quoted string. */
338 const char *completion_quote_end
= nullptr;
340 /* If parsing for completion, then this points at the completion
341 tracker. Otherwise, this is NULL. */
342 struct completion_tracker
*completion_tracker
= nullptr;
345 /* A convenience macro for accessing the explicit location result of
347 #define PARSER_EXPLICIT(PPTR) (&PARSER_RESULT ((PPTR))->explicit_loc)
349 /* Prototypes for local functions. */
351 static void iterate_over_file_blocks
352 (struct symtab
*symtab
, const lookup_name_info
&name
,
354 gdb::function_view
<symbol_found_callback_ftype
> callback
);
356 static void initialize_defaults (struct symtab
**default_symtab
,
359 CORE_ADDR
linespec_expression_to_pc (const char **exp_ptr
);
361 static std::vector
<symtab_and_line
> decode_objc (struct linespec_state
*self
,
365 static std::vector
<symtab
*> symtabs_from_filename
366 (const char *, struct program_space
*pspace
);
368 static std::vector
<block_symbol
> *find_label_symbols
369 (struct linespec_state
*self
, std::vector
<block_symbol
> *function_symbols
,
370 std::vector
<block_symbol
> *label_funcs_ret
, const char *name
,
371 bool completion_mode
= false);
373 static void find_linespec_symbols (struct linespec_state
*self
,
374 std::vector
<symtab
*> *file_symtabs
,
376 symbol_name_match_type name_match_type
,
377 std::vector
<block_symbol
> *symbols
,
378 std::vector
<bound_minimal_symbol
> *minsyms
);
380 static struct line_offset
381 linespec_parse_variable (struct linespec_state
*self
,
382 const char *variable
);
384 static int symbol_to_sal (struct symtab_and_line
*result
,
385 int funfirstline
, struct symbol
*sym
);
387 static void add_matching_symbols_to_info (const char *name
,
388 symbol_name_match_type name_match_type
,
389 enum search_domain search_domain
,
390 struct collect_info
*info
,
391 struct program_space
*pspace
);
393 static void add_all_symbol_names_from_pspace
394 (struct collect_info
*info
, struct program_space
*pspace
,
395 const std::vector
<const char *> &names
, enum search_domain search_domain
);
397 static std::vector
<symtab
*>
398 collect_symtabs_from_filename (const char *file
,
399 struct program_space
*pspace
);
401 static std::vector
<symtab_and_line
> decode_digits_ordinary
402 (struct linespec_state
*self
,
405 linetable_entry
**best_entry
);
407 static std::vector
<symtab_and_line
> decode_digits_list_mode
408 (struct linespec_state
*self
,
410 struct symtab_and_line val
);
412 static void minsym_found (struct linespec_state
*self
, struct objfile
*objfile
,
413 struct minimal_symbol
*msymbol
,
414 std::vector
<symtab_and_line
> *result
);
416 static bool compare_symbols (const block_symbol
&a
, const block_symbol
&b
);
418 static bool compare_msymbols (const bound_minimal_symbol
&a
,
419 const bound_minimal_symbol
&b
);
421 /* Permitted quote characters for the parser. This is different from the
422 completer's quote characters to allow backward compatibility with the
424 static const char *const linespec_quote_characters
= "\"\'";
426 /* Lexer functions. */
428 /* Lex a number from the input in PARSER. This only supports
431 Return true if input is decimal numbers. Return false if not. */
434 linespec_lexer_lex_number (linespec_parser
*parser
, linespec_token
*tokenp
)
436 tokenp
->type
= LSTOKEN_NUMBER
;
437 LS_TOKEN_STOKEN (*tokenp
).length
= 0;
438 LS_TOKEN_STOKEN (*tokenp
).ptr
= PARSER_STREAM (parser
);
440 /* Keep any sign at the start of the stream. */
441 if (*PARSER_STREAM (parser
) == '+' || *PARSER_STREAM (parser
) == '-')
443 ++LS_TOKEN_STOKEN (*tokenp
).length
;
444 ++(PARSER_STREAM (parser
));
447 while (isdigit (*PARSER_STREAM (parser
)))
449 ++LS_TOKEN_STOKEN (*tokenp
).length
;
450 ++(PARSER_STREAM (parser
));
453 /* If the next character in the input buffer is not a space, comma,
454 quote, or colon, this input does not represent a number. */
455 if (*PARSER_STREAM (parser
) != '\0'
456 && !isspace (*PARSER_STREAM (parser
)) && *PARSER_STREAM (parser
) != ','
457 && *PARSER_STREAM (parser
) != ':'
458 && !strchr (linespec_quote_characters
, *PARSER_STREAM (parser
)))
460 PARSER_STREAM (parser
) = LS_TOKEN_STOKEN (*tokenp
).ptr
;
467 /* See linespec.h. */
470 linespec_lexer_lex_keyword (const char *p
)
476 for (i
= 0; linespec_keywords
[i
] != NULL
; ++i
)
478 int len
= strlen (linespec_keywords
[i
]);
480 /* If P begins with one of the keywords and the next
481 character is whitespace, we may have found a keyword.
482 It is only a keyword if it is not followed by another
484 if (strncmp (p
, linespec_keywords
[i
], len
) == 0
489 /* Special case: "if" ALWAYS stops the lexer, since it
490 is not possible to predict what is going to appear in
491 the condition, which can only be parsed after SaLs have
493 if (i
!= IF_KEYWORD_INDEX
)
497 for (j
= 0; linespec_keywords
[j
] != NULL
; ++j
)
499 int nextlen
= strlen (linespec_keywords
[j
]);
501 if (strncmp (p
, linespec_keywords
[j
], nextlen
) == 0
502 && isspace (p
[nextlen
]))
507 return linespec_keywords
[i
];
515 /* See description in linespec.h. */
518 is_ada_operator (const char *string
)
520 const struct ada_opname_map
*mapping
;
522 for (mapping
= ada_opname_table
;
523 mapping
->encoded
!= NULL
524 && !startswith (string
, mapping
->decoded
); ++mapping
)
527 return mapping
->decoded
== NULL
? 0 : strlen (mapping
->decoded
);
530 /* Find QUOTE_CHAR in STRING, accounting for the ':' terminal. Return
531 the location of QUOTE_CHAR, or NULL if not found. */
534 skip_quote_char (const char *string
, char quote_char
)
536 const char *p
, *last
;
538 p
= last
= find_toplevel_char (string
, quote_char
);
539 while (p
&& *p
!= '\0' && *p
!= ':')
541 p
= find_toplevel_char (p
, quote_char
);
549 /* Make a writable copy of the string given in TOKEN, trimming
550 any trailing whitespace. */
552 static gdb::unique_xmalloc_ptr
<char>
553 copy_token_string (linespec_token token
)
557 if (token
.type
== LSTOKEN_KEYWORD
)
558 return gdb::unique_xmalloc_ptr
<char> (xstrdup (LS_TOKEN_KEYWORD (token
)));
560 str
= LS_TOKEN_STOKEN (token
).ptr
;
561 s
= remove_trailing_whitespace (str
, str
+ LS_TOKEN_STOKEN (token
).length
);
563 return gdb::unique_xmalloc_ptr
<char> (savestring (str
, s
- str
));
566 /* Does P represent the end of a quote-enclosed linespec? */
569 is_closing_quote_enclosed (const char *p
)
571 if (strchr (linespec_quote_characters
, *p
))
573 p
= skip_spaces ((char *) p
);
574 return (*p
== '\0' || linespec_lexer_lex_keyword (p
));
577 /* Find the end of the parameter list that starts with *INPUT.
578 This helper function assists with lexing string segments
579 which might contain valid (non-terminating) commas. */
582 find_parameter_list_end (const char *input
)
584 char end_char
, start_char
;
589 if (start_char
== '(')
591 else if (start_char
== '<')
600 if (*p
== start_char
)
602 else if (*p
== end_char
)
616 /* If the [STRING, STRING_LEN) string ends with what looks like a
617 keyword, return the keyword start offset in STRING. Return -1
621 string_find_incomplete_keyword_at_end (const char * const *keywords
,
622 const char *string
, size_t string_len
)
624 const char *end
= string
+ string_len
;
627 while (p
> string
&& *p
!= ' ')
632 size_t len
= end
- p
;
633 for (size_t i
= 0; keywords
[i
] != NULL
; ++i
)
634 if (strncmp (keywords
[i
], p
, len
) == 0)
641 /* Lex a string from the input in PARSER. */
643 static linespec_token
644 linespec_lexer_lex_string (linespec_parser
*parser
)
646 linespec_token token
;
647 const char *start
= PARSER_STREAM (parser
);
649 token
.type
= LSTOKEN_STRING
;
651 /* If the input stream starts with a quote character, skip to the next
652 quote character, regardless of the content. */
653 if (strchr (linespec_quote_characters
, *PARSER_STREAM (parser
)))
656 char quote_char
= *PARSER_STREAM (parser
);
658 /* Special case: Ada operators. */
659 if (PARSER_STATE (parser
)->language
->la_language
== language_ada
660 && quote_char
== '\"')
662 int len
= is_ada_operator (PARSER_STREAM (parser
));
666 /* The input is an Ada operator. Return the quoted string
668 LS_TOKEN_STOKEN (token
).ptr
= PARSER_STREAM (parser
);
669 LS_TOKEN_STOKEN (token
).length
= len
;
670 PARSER_STREAM (parser
) += len
;
674 /* The input does not represent an Ada operator -- fall through
675 to normal quoted string handling. */
678 /* Skip past the beginning quote. */
679 ++(PARSER_STREAM (parser
));
681 /* Mark the start of the string. */
682 LS_TOKEN_STOKEN (token
).ptr
= PARSER_STREAM (parser
);
684 /* Skip to the ending quote. */
685 end
= skip_quote_char (PARSER_STREAM (parser
), quote_char
);
687 /* This helps the completer mode decide whether we have a
689 parser
->completion_quote_char
= quote_char
;
690 parser
->completion_quote_end
= end
;
692 /* Error if the input did not terminate properly, unless in
696 if (parser
->completion_tracker
== NULL
)
697 error (_("unmatched quote"));
699 /* In completion mode, we'll try to complete the incomplete
701 token
.type
= LSTOKEN_STRING
;
702 while (*PARSER_STREAM (parser
) != '\0')
703 PARSER_STREAM (parser
)++;
704 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - 1 - start
;
708 /* Skip over the ending quote and mark the length of the string. */
709 PARSER_STREAM (parser
) = (char *) ++end
;
710 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - 2 - start
;
717 /* Otherwise, only identifier characters are permitted.
718 Spaces are the exception. In general, we keep spaces,
719 but only if the next characters in the input do not resolve
720 to one of the keywords.
722 This allows users to forgo quoting CV-qualifiers, template arguments,
723 and similar common language constructs. */
727 if (isspace (*PARSER_STREAM (parser
)))
729 p
= skip_spaces (PARSER_STREAM (parser
));
730 /* When we get here we know we've found something followed by
731 a space (we skip over parens and templates below).
732 So if we find a keyword now, we know it is a keyword and not,
733 say, a function name. */
734 if (linespec_lexer_lex_keyword (p
) != NULL
)
736 LS_TOKEN_STOKEN (token
).ptr
= start
;
737 LS_TOKEN_STOKEN (token
).length
738 = PARSER_STREAM (parser
) - start
;
742 /* Advance past the whitespace. */
743 PARSER_STREAM (parser
) = p
;
746 /* If the next character is EOI or (single) ':', the
747 string is complete; return the token. */
748 if (*PARSER_STREAM (parser
) == 0)
750 LS_TOKEN_STOKEN (token
).ptr
= start
;
751 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - start
;
754 else if (PARSER_STREAM (parser
)[0] == ':')
756 /* Do not tokenize the C++ scope operator. */
757 if (PARSER_STREAM (parser
)[1] == ':')
758 ++(PARSER_STREAM (parser
));
760 /* Do not tokenize ABI tags such as "[abi:cxx11]". */
761 else if (PARSER_STREAM (parser
) - start
> 4
762 && startswith (PARSER_STREAM (parser
) - 4, "[abi"))
763 ++(PARSER_STREAM (parser
));
765 /* Do not tokenify if the input length so far is one
766 (i.e, a single-letter drive name) and the next character
767 is a directory separator. This allows Windows-style
768 paths to be recognized as filenames without quoting it. */
769 else if ((PARSER_STREAM (parser
) - start
) != 1
770 || !IS_DIR_SEPARATOR (PARSER_STREAM (parser
)[1]))
772 LS_TOKEN_STOKEN (token
).ptr
= start
;
773 LS_TOKEN_STOKEN (token
).length
774 = PARSER_STREAM (parser
) - start
;
778 /* Special case: permit quote-enclosed linespecs. */
779 else if (parser
->is_quote_enclosed
780 && strchr (linespec_quote_characters
,
781 *PARSER_STREAM (parser
))
782 && is_closing_quote_enclosed (PARSER_STREAM (parser
)))
784 LS_TOKEN_STOKEN (token
).ptr
= start
;
785 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - start
;
788 /* Because commas may terminate a linespec and appear in
789 the middle of valid string input, special cases for
790 '<' and '(' are necessary. */
791 else if (*PARSER_STREAM (parser
) == '<'
792 || *PARSER_STREAM (parser
) == '(')
794 /* Don't interpret 'operator<' / 'operator<<' as a
795 template parameter list though. */
796 if (*PARSER_STREAM (parser
) == '<'
797 && (PARSER_STATE (parser
)->language
->la_language
799 && (PARSER_STREAM (parser
) - start
) >= CP_OPERATOR_LEN
)
801 const char *op
= PARSER_STREAM (parser
);
803 while (op
> start
&& isspace (op
[-1]))
805 if (op
- start
>= CP_OPERATOR_LEN
)
807 op
-= CP_OPERATOR_LEN
;
808 if (strncmp (op
, CP_OPERATOR_STR
, CP_OPERATOR_LEN
) == 0
810 || !(isalnum (op
[-1]) || op
[-1] == '_')))
812 /* This is an operator name. Keep going. */
813 ++(PARSER_STREAM (parser
));
814 if (*PARSER_STREAM (parser
) == '<')
815 ++(PARSER_STREAM (parser
));
821 const char *end
= find_parameter_list_end (PARSER_STREAM (parser
));
822 PARSER_STREAM (parser
) = end
;
824 /* Don't loop around to the normal \0 case above because
825 we don't want to misinterpret a potential keyword at
826 the end of the token when the string isn't
827 "()<>"-balanced. This handles "b
828 function(thread<tab>" in completion mode. */
831 LS_TOKEN_STOKEN (token
).ptr
= start
;
832 LS_TOKEN_STOKEN (token
).length
833 = PARSER_STREAM (parser
) - start
;
839 /* Commas are terminators, but not if they are part of an
841 else if (*PARSER_STREAM (parser
) == ',')
843 if ((PARSER_STATE (parser
)->language
->la_language
845 && (PARSER_STREAM (parser
) - start
) > CP_OPERATOR_LEN
)
847 const char *op
= strstr (start
, CP_OPERATOR_STR
);
849 if (op
!= NULL
&& is_operator_name (op
))
851 /* This is an operator name. Keep going. */
852 ++(PARSER_STREAM (parser
));
857 /* Comma terminates the string. */
858 LS_TOKEN_STOKEN (token
).ptr
= start
;
859 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - start
;
863 /* Advance the stream. */
864 ++(PARSER_STREAM (parser
));
871 /* Lex a single linespec token from PARSER. */
873 static linespec_token
874 linespec_lexer_lex_one (linespec_parser
*parser
)
878 if (parser
->lexer
.current
.type
== LSTOKEN_CONSUMED
)
880 /* Skip any whitespace. */
881 PARSER_STREAM (parser
) = skip_spaces (PARSER_STREAM (parser
));
883 /* Check for a keyword, they end the linespec. */
884 keyword
= linespec_lexer_lex_keyword (PARSER_STREAM (parser
));
887 parser
->lexer
.current
.type
= LSTOKEN_KEYWORD
;
888 LS_TOKEN_KEYWORD (parser
->lexer
.current
) = keyword
;
889 /* We do not advance the stream here intentionally:
890 we would like lexing to stop when a keyword is seen.
892 PARSER_STREAM (parser) += strlen (keyword); */
894 return parser
->lexer
.current
;
897 /* Handle other tokens. */
898 switch (*PARSER_STREAM (parser
))
901 parser
->lexer
.current
.type
= LSTOKEN_EOI
;
905 case '0': case '1': case '2': case '3': case '4':
906 case '5': case '6': case '7': case '8': case '9':
907 if (!linespec_lexer_lex_number (parser
, &(parser
->lexer
.current
)))
908 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
912 /* If we have a scope operator, lex the input as a string.
913 Otherwise, return LSTOKEN_COLON. */
914 if (PARSER_STREAM (parser
)[1] == ':')
915 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
918 parser
->lexer
.current
.type
= LSTOKEN_COLON
;
919 ++(PARSER_STREAM (parser
));
923 case '\'': case '\"':
924 /* Special case: permit quote-enclosed linespecs. */
925 if (parser
->is_quote_enclosed
926 && is_closing_quote_enclosed (PARSER_STREAM (parser
)))
928 ++(PARSER_STREAM (parser
));
929 parser
->lexer
.current
.type
= LSTOKEN_EOI
;
932 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
936 parser
->lexer
.current
.type
= LSTOKEN_COMMA
;
937 LS_TOKEN_STOKEN (parser
->lexer
.current
).ptr
938 = PARSER_STREAM (parser
);
939 LS_TOKEN_STOKEN (parser
->lexer
.current
).length
= 1;
940 ++(PARSER_STREAM (parser
));
944 /* If the input is not a number, it must be a string.
945 [Keywords were already considered above.] */
946 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
951 return parser
->lexer
.current
;
954 /* Consume the current token and return the next token in PARSER's
955 input stream. Also advance the completion word for completion
958 static linespec_token
959 linespec_lexer_consume_token (linespec_parser
*parser
)
961 gdb_assert (parser
->lexer
.current
.type
!= LSTOKEN_EOI
);
963 bool advance_word
= (parser
->lexer
.current
.type
!= LSTOKEN_STRING
964 || *PARSER_STREAM (parser
) != '\0');
966 /* If we're moving past a string to some other token, it must be the
967 quote was terminated. */
968 if (parser
->completion_quote_char
)
970 gdb_assert (parser
->lexer
.current
.type
== LSTOKEN_STRING
);
972 /* If the string was the last (non-EOI) token, we're past the
973 quote, but remember that for later. */
974 if (*PARSER_STREAM (parser
) != '\0')
976 parser
->completion_quote_char
= '\0';
977 parser
->completion_quote_end
= NULL
;;
981 parser
->lexer
.current
.type
= LSTOKEN_CONSUMED
;
982 linespec_lexer_lex_one (parser
);
984 if (parser
->lexer
.current
.type
== LSTOKEN_STRING
)
986 /* Advance the completion word past a potential initial
988 parser
->completion_word
= LS_TOKEN_STOKEN (parser
->lexer
.current
).ptr
;
990 else if (advance_word
)
992 /* Advance the completion word past any whitespace. */
993 parser
->completion_word
= PARSER_STREAM (parser
);
996 return parser
->lexer
.current
;
999 /* Return the next token without consuming the current token. */
1001 static linespec_token
1002 linespec_lexer_peek_token (linespec_parser
*parser
)
1004 linespec_token next
;
1005 const char *saved_stream
= PARSER_STREAM (parser
);
1006 linespec_token saved_token
= parser
->lexer
.current
;
1007 int saved_completion_quote_char
= parser
->completion_quote_char
;
1008 const char *saved_completion_quote_end
= parser
->completion_quote_end
;
1009 const char *saved_completion_word
= parser
->completion_word
;
1011 next
= linespec_lexer_consume_token (parser
);
1012 PARSER_STREAM (parser
) = saved_stream
;
1013 parser
->lexer
.current
= saved_token
;
1014 parser
->completion_quote_char
= saved_completion_quote_char
;
1015 parser
->completion_quote_end
= saved_completion_quote_end
;
1016 parser
->completion_word
= saved_completion_word
;
1020 /* Helper functions. */
1022 /* Add SAL to SALS, and also update SELF->CANONICAL_NAMES to reflect
1023 the new sal, if needed. If not NULL, SYMNAME is the name of the
1024 symbol to use when constructing the new canonical name.
1026 If LITERAL_CANONICAL is non-zero, SYMNAME will be used as the
1027 canonical name for the SAL. */
1030 add_sal_to_sals (struct linespec_state
*self
,
1031 std::vector
<symtab_and_line
> *sals
,
1032 struct symtab_and_line
*sal
,
1033 const char *symname
, int literal_canonical
)
1035 sals
->push_back (*sal
);
1037 if (self
->canonical
)
1039 struct linespec_canonical_name
*canonical
;
1041 self
->canonical_names
= XRESIZEVEC (struct linespec_canonical_name
,
1042 self
->canonical_names
,
1044 canonical
= &self
->canonical_names
[sals
->size () - 1];
1045 if (!literal_canonical
&& sal
->symtab
)
1047 symtab_to_fullname (sal
->symtab
);
1049 /* Note that the filter doesn't have to be a valid linespec
1050 input. We only apply the ":LINE" treatment to Ada for
1052 if (symname
!= NULL
&& sal
->line
!= 0
1053 && self
->language
->la_language
== language_ada
)
1054 canonical
->suffix
= xstrprintf ("%s:%d", symname
, sal
->line
);
1055 else if (symname
!= NULL
)
1056 canonical
->suffix
= xstrdup (symname
);
1058 canonical
->suffix
= xstrprintf ("%d", sal
->line
);
1059 canonical
->symtab
= sal
->symtab
;
1063 if (symname
!= NULL
)
1064 canonical
->suffix
= xstrdup (symname
);
1066 canonical
->suffix
= xstrdup ("<unknown>");
1067 canonical
->symtab
= NULL
;
1072 /* A hash function for address_entry. */
1075 hash_address_entry (const void *p
)
1077 const struct address_entry
*aep
= (const struct address_entry
*) p
;
1080 hash
= iterative_hash_object (aep
->pspace
, 0);
1081 return iterative_hash_object (aep
->addr
, hash
);
1084 /* An equality function for address_entry. */
1087 eq_address_entry (const void *a
, const void *b
)
1089 const struct address_entry
*aea
= (const struct address_entry
*) a
;
1090 const struct address_entry
*aeb
= (const struct address_entry
*) b
;
1092 return aea
->pspace
== aeb
->pspace
&& aea
->addr
== aeb
->addr
;
1095 /* Check whether the address, represented by PSPACE and ADDR, is
1096 already in the set. If so, return 0. Otherwise, add it and return
1100 maybe_add_address (htab_t set
, struct program_space
*pspace
, CORE_ADDR addr
)
1102 struct address_entry e
, *p
;
1107 slot
= htab_find_slot (set
, &e
, INSERT
);
1111 p
= XNEW (struct address_entry
);
1112 memcpy (p
, &e
, sizeof (struct address_entry
));
1118 /* A helper that walks over all matching symtabs in all objfiles and
1119 calls CALLBACK for each symbol matching NAME. If SEARCH_PSPACE is
1120 not NULL, then the search is restricted to just that program
1121 space. If INCLUDE_INLINE is true then symbols representing
1122 inlined instances of functions will be included in the result. */
1125 iterate_over_all_matching_symtabs
1126 (struct linespec_state
*state
,
1127 const lookup_name_info
&lookup_name
,
1128 const domain_enum name_domain
,
1129 enum search_domain search_domain
,
1130 struct program_space
*search_pspace
, bool include_inline
,
1131 gdb::function_view
<symbol_found_callback_ftype
> callback
)
1133 struct program_space
*pspace
;
1135 ALL_PSPACES (pspace
)
1137 if (search_pspace
!= NULL
&& search_pspace
!= pspace
)
1139 if (pspace
->executing_startup
)
1142 set_current_program_space (pspace
);
1144 for (objfile
*objfile
: current_program_space
->objfiles ())
1147 objfile
->sf
->qf
->expand_symtabs_matching (objfile
,
1153 for (compunit_symtab
*cu
: objfile
->compunits ())
1155 struct symtab
*symtab
= COMPUNIT_FILETABS (cu
);
1157 iterate_over_file_blocks (symtab
, lookup_name
, name_domain
,
1162 const struct block
*block
;
1165 for (i
= FIRST_LOCAL_BLOCK
;
1166 i
< BLOCKVECTOR_NBLOCKS (SYMTAB_BLOCKVECTOR (symtab
));
1169 block
= BLOCKVECTOR_BLOCK (SYMTAB_BLOCKVECTOR (symtab
), i
);
1170 state
->language
->la_iterate_over_symbols
1171 (block
, lookup_name
, name_domain
,
1172 [&] (block_symbol
*bsym
)
1174 /* Restrict calls to CALLBACK to symbols
1175 representing inline symbols only. */
1176 if (SYMBOL_INLINED (bsym
->symbol
))
1177 return callback (bsym
);
1187 /* Returns the block to be used for symbol searches from
1188 the current location. */
1190 static const struct block
*
1191 get_current_search_block (void)
1193 /* get_selected_block can change the current language when there is
1194 no selected frame yet. */
1195 scoped_restore_current_language save_language
;
1196 return get_selected_block (0);
1199 /* Iterate over static and global blocks. */
1202 iterate_over_file_blocks
1203 (struct symtab
*symtab
, const lookup_name_info
&name
,
1204 domain_enum domain
, gdb::function_view
<symbol_found_callback_ftype
> callback
)
1206 const struct block
*block
;
1208 for (block
= BLOCKVECTOR_BLOCK (SYMTAB_BLOCKVECTOR (symtab
), STATIC_BLOCK
);
1210 block
= BLOCK_SUPERBLOCK (block
))
1211 LA_ITERATE_OVER_SYMBOLS (block
, name
, domain
, callback
);
1214 /* A helper for find_method. This finds all methods in type T of
1215 language T_LANG which match NAME. It adds matching symbol names to
1216 RESULT_NAMES, and adds T's direct superclasses to SUPERCLASSES. */
1219 find_methods (struct type
*t
, enum language t_lang
, const char *name
,
1220 std::vector
<const char *> *result_names
,
1221 std::vector
<struct type
*> *superclasses
)
1224 const char *class_name
= TYPE_NAME (t
);
1226 /* Ignore this class if it doesn't have a name. This is ugly, but
1227 unless we figure out how to get the physname without the name of
1228 the class, then the loop can't do any good. */
1232 lookup_name_info
lookup_name (name
, symbol_name_match_type::FULL
);
1233 symbol_name_matcher_ftype
*symbol_name_compare
1234 = get_symbol_name_matcher (language_def (t_lang
), lookup_name
);
1236 t
= check_typedef (t
);
1238 /* Loop over each method name. At this level, all overloads of a name
1239 are counted as a single name. There is an inner loop which loops over
1242 for (method_counter
= TYPE_NFN_FIELDS (t
) - 1;
1243 method_counter
>= 0;
1246 const char *method_name
= TYPE_FN_FIELDLIST_NAME (t
, method_counter
);
1248 if (symbol_name_compare (method_name
, lookup_name
, NULL
))
1252 for (field_counter
= (TYPE_FN_FIELDLIST_LENGTH (t
, method_counter
)
1258 const char *phys_name
;
1260 f
= TYPE_FN_FIELDLIST1 (t
, method_counter
);
1261 if (TYPE_FN_FIELD_STUB (f
, field_counter
))
1263 phys_name
= TYPE_FN_FIELD_PHYSNAME (f
, field_counter
);
1264 result_names
->push_back (phys_name
);
1270 for (ibase
= 0; ibase
< TYPE_N_BASECLASSES (t
); ibase
++)
1271 superclasses
->push_back (TYPE_BASECLASS (t
, ibase
));
1274 /* Find an instance of the character C in the string S that is outside
1275 of all parenthesis pairs, single-quoted strings, and double-quoted
1276 strings. Also, ignore the char within a template name, like a ','
1277 within foo<int, int>, while considering C++ operator</operator<<. */
1280 find_toplevel_char (const char *s
, char c
)
1282 int quoted
= 0; /* zero if we're not in quotes;
1283 '"' if we're in a double-quoted string;
1284 '\'' if we're in a single-quoted string. */
1285 int depth
= 0; /* Number of unclosed parens we've seen. */
1288 for (scan
= s
; *scan
; scan
++)
1292 if (*scan
== quoted
)
1294 else if (*scan
== '\\' && *(scan
+ 1))
1297 else if (*scan
== c
&& ! quoted
&& depth
== 0)
1299 else if (*scan
== '"' || *scan
== '\'')
1301 else if (*scan
== '(' || *scan
== '<')
1303 else if ((*scan
== ')' || *scan
== '>') && depth
> 0)
1305 else if (*scan
== 'o' && !quoted
&& depth
== 0)
1307 /* Handle C++ operator names. */
1308 if (strncmp (scan
, CP_OPERATOR_STR
, CP_OPERATOR_LEN
) == 0)
1310 scan
+= CP_OPERATOR_LEN
;
1313 while (isspace (*scan
))
1324 /* Skip over one less than the appropriate number of
1325 characters: the for loop will skip over the last
1351 /* The string equivalent of find_toplevel_char. Returns a pointer
1352 to the location of NEEDLE in HAYSTACK, ignoring any occurrences
1353 inside "()" and "<>". Returns NULL if NEEDLE was not found. */
1356 find_toplevel_string (const char *haystack
, const char *needle
)
1358 const char *s
= haystack
;
1362 s
= find_toplevel_char (s
, *needle
);
1366 /* Found first char in HAYSTACK; check rest of string. */
1367 if (startswith (s
, needle
))
1370 /* Didn't find it; loop over HAYSTACK, looking for the next
1371 instance of the first character of NEEDLE. */
1375 while (s
!= NULL
&& *s
!= '\0');
1377 /* NEEDLE was not found in HAYSTACK. */
1381 /* Convert CANONICAL to its string representation using
1382 symtab_to_fullname for SYMTAB. */
1385 canonical_to_fullform (const struct linespec_canonical_name
*canonical
)
1387 if (canonical
->symtab
== NULL
)
1388 return canonical
->suffix
;
1390 return string_printf ("%s:%s", symtab_to_fullname (canonical
->symtab
),
1394 /* Given FILTERS, a list of canonical names, filter the sals in RESULT
1395 and store the result in SELF->CANONICAL. */
1398 filter_results (struct linespec_state
*self
,
1399 std::vector
<symtab_and_line
> *result
,
1400 const std::vector
<const char *> &filters
)
1402 for (const char *name
: filters
)
1406 for (size_t j
= 0; j
< result
->size (); ++j
)
1408 const struct linespec_canonical_name
*canonical
;
1410 canonical
= &self
->canonical_names
[j
];
1411 std::string fullform
= canonical_to_fullform (canonical
);
1413 if (name
== fullform
)
1414 lsal
.sals
.push_back ((*result
)[j
]);
1417 if (!lsal
.sals
.empty ())
1419 lsal
.canonical
= xstrdup (name
);
1420 self
->canonical
->lsals
.push_back (std::move (lsal
));
1424 self
->canonical
->pre_expanded
= 0;
1427 /* Store RESULT into SELF->CANONICAL. */
1430 convert_results_to_lsals (struct linespec_state
*self
,
1431 std::vector
<symtab_and_line
> *result
)
1433 struct linespec_sals lsal
;
1435 lsal
.canonical
= NULL
;
1436 lsal
.sals
= std::move (*result
);
1437 self
->canonical
->lsals
.push_back (std::move (lsal
));
1440 /* A structure that contains two string representations of a struct
1441 linespec_canonical_name:
1442 - one where the symtab's fullname is used;
1443 - one where the filename followed the "set filename-display"
1446 struct decode_line_2_item
1448 decode_line_2_item (std::string
&&fullform_
, std::string
&&displayform_
,
1450 : fullform (std::move (fullform_
)),
1451 displayform (std::move (displayform_
)),
1452 selected (selected_
)
1456 /* The form using symtab_to_fullname. */
1457 std::string fullform
;
1459 /* The form using symtab_to_filename_for_display. */
1460 std::string displayform
;
1462 /* Field is initialized to zero and it is set to one if the user
1463 requested breakpoint for this entry. */
1464 unsigned int selected
: 1;
1467 /* Helper for std::sort to sort decode_line_2_item entries by
1468 DISPLAYFORM and secondarily by FULLFORM. */
1471 decode_line_2_compare_items (const decode_line_2_item
&a
,
1472 const decode_line_2_item
&b
)
1474 if (a
.displayform
!= b
.displayform
)
1475 return a
.displayform
< b
.displayform
;
1476 return a
.fullform
< b
.fullform
;
1479 /* Handle multiple results in RESULT depending on SELECT_MODE. This
1480 will either return normally, throw an exception on multiple
1481 results, or present a menu to the user. On return, the SALS vector
1482 in SELF->CANONICAL is set up properly. */
1485 decode_line_2 (struct linespec_state
*self
,
1486 std::vector
<symtab_and_line
> *result
,
1487 const char *select_mode
)
1492 std::vector
<const char *> filters
;
1493 std::vector
<struct decode_line_2_item
> items
;
1495 gdb_assert (select_mode
!= multiple_symbols_all
);
1496 gdb_assert (self
->canonical
!= NULL
);
1497 gdb_assert (!result
->empty ());
1499 /* Prepare ITEMS array. */
1500 for (i
= 0; i
< result
->size (); ++i
)
1502 const struct linespec_canonical_name
*canonical
;
1503 std::string displayform
;
1505 canonical
= &self
->canonical_names
[i
];
1506 gdb_assert (canonical
->suffix
!= NULL
);
1508 std::string fullform
= canonical_to_fullform (canonical
);
1510 if (canonical
->symtab
== NULL
)
1511 displayform
= canonical
->suffix
;
1514 const char *fn_for_display
;
1516 fn_for_display
= symtab_to_filename_for_display (canonical
->symtab
);
1517 displayform
= string_printf ("%s:%s", fn_for_display
,
1521 items
.emplace_back (std::move (fullform
), std::move (displayform
),
1525 /* Sort the list of method names. */
1526 std::sort (items
.begin (), items
.end (), decode_line_2_compare_items
);
1528 /* Remove entries with the same FULLFORM. */
1529 items
.erase (std::unique (items
.begin (), items
.end (),
1530 [] (const struct decode_line_2_item
&a
,
1531 const struct decode_line_2_item
&b
)
1533 return a
.fullform
== b
.fullform
;
1537 if (select_mode
== multiple_symbols_cancel
&& items
.size () > 1)
1538 error (_("canceled because the command is ambiguous\n"
1539 "See set/show multiple-symbol."));
1541 if (select_mode
== multiple_symbols_all
|| items
.size () == 1)
1543 convert_results_to_lsals (self
, result
);
1547 printf_unfiltered (_("[0] cancel\n[1] all\n"));
1548 for (i
= 0; i
< items
.size (); i
++)
1549 printf_unfiltered ("[%d] %s\n", i
+ 2, items
[i
].displayform
.c_str ());
1551 prompt
= getenv ("PS2");
1556 args
= command_line_input (prompt
, "overload-choice");
1558 if (args
== 0 || *args
== 0)
1559 error_no_arg (_("one or more choice numbers"));
1561 number_or_range_parser
parser (args
);
1562 while (!parser
.finished ())
1564 int num
= parser
.get_number ();
1567 error (_("canceled"));
1570 /* We intentionally make this result in a single breakpoint,
1571 contrary to what older versions of gdb did. The
1572 rationale is that this lets a user get the
1573 multiple_symbols_all behavior even with the 'ask'
1574 setting; and he can get separate breakpoints by entering
1575 "2-57" at the query. */
1576 convert_results_to_lsals (self
, result
);
1581 if (num
>= items
.size ())
1582 printf_unfiltered (_("No choice number %d.\n"), num
);
1585 struct decode_line_2_item
*item
= &items
[num
];
1587 if (!item
->selected
)
1589 filters
.push_back (item
->fullform
.c_str ());
1594 printf_unfiltered (_("duplicate request for %d ignored.\n"),
1600 filter_results (self
, result
, filters
);
1605 /* The parser of linespec itself. */
1607 /* Throw an appropriate error when SYMBOL is not found (optionally in
1610 static void ATTRIBUTE_NORETURN
1611 symbol_not_found_error (const char *symbol
, const char *filename
)
1616 if (!have_full_symbols ()
1617 && !have_partial_symbols ()
1618 && !have_minimal_symbols ())
1619 throw_error (NOT_FOUND_ERROR
,
1620 _("No symbol table is loaded. Use the \"file\" command."));
1622 /* If SYMBOL starts with '$', the user attempted to either lookup
1623 a function/variable in his code starting with '$' or an internal
1624 variable of that name. Since we do not know which, be concise and
1625 explain both possibilities. */
1629 throw_error (NOT_FOUND_ERROR
,
1630 _("Undefined convenience variable or function \"%s\" "
1631 "not defined in \"%s\"."), symbol
, filename
);
1633 throw_error (NOT_FOUND_ERROR
,
1634 _("Undefined convenience variable or function \"%s\" "
1635 "not defined."), symbol
);
1640 throw_error (NOT_FOUND_ERROR
,
1641 _("Function \"%s\" not defined in \"%s\"."),
1644 throw_error (NOT_FOUND_ERROR
,
1645 _("Function \"%s\" not defined."), symbol
);
1649 /* Throw an appropriate error when an unexpected token is encountered
1652 static void ATTRIBUTE_NORETURN
1653 unexpected_linespec_error (linespec_parser
*parser
)
1655 linespec_token token
;
1656 static const char * token_type_strings
[]
1657 = {"keyword", "colon", "string", "number", "comma", "end of input"};
1659 /* Get the token that generated the error. */
1660 token
= linespec_lexer_lex_one (parser
);
1662 /* Finally, throw the error. */
1663 if (token
.type
== LSTOKEN_STRING
|| token
.type
== LSTOKEN_NUMBER
1664 || token
.type
== LSTOKEN_KEYWORD
)
1666 gdb::unique_xmalloc_ptr
<char> string
= copy_token_string (token
);
1667 throw_error (GENERIC_ERROR
,
1668 _("malformed linespec error: unexpected %s, \"%s\""),
1669 token_type_strings
[token
.type
], string
.get ());
1672 throw_error (GENERIC_ERROR
,
1673 _("malformed linespec error: unexpected %s"),
1674 token_type_strings
[token
.type
]);
1677 /* Throw an undefined label error. */
1679 static void ATTRIBUTE_NORETURN
1680 undefined_label_error (const char *function
, const char *label
)
1682 if (function
!= NULL
)
1683 throw_error (NOT_FOUND_ERROR
,
1684 _("No label \"%s\" defined in function \"%s\"."),
1687 throw_error (NOT_FOUND_ERROR
,
1688 _("No label \"%s\" defined in current function."),
1692 /* Throw a source file not found error. */
1694 static void ATTRIBUTE_NORETURN
1695 source_file_not_found_error (const char *name
)
1697 throw_error (NOT_FOUND_ERROR
, _("No source file named %s."), name
);
1700 /* Unless at EIO, save the current stream position as completion word
1701 point, and consume the next token. */
1703 static linespec_token
1704 save_stream_and_consume_token (linespec_parser
*parser
)
1706 if (linespec_lexer_peek_token (parser
).type
!= LSTOKEN_EOI
)
1707 parser
->completion_word
= PARSER_STREAM (parser
);
1708 return linespec_lexer_consume_token (parser
);
1711 /* See description in linespec.h. */
1714 linespec_parse_line_offset (const char *string
)
1716 const char *start
= string
;
1717 struct line_offset line_offset
= {0, LINE_OFFSET_NONE
};
1721 line_offset
.sign
= LINE_OFFSET_PLUS
;
1724 else if (*string
== '-')
1726 line_offset
.sign
= LINE_OFFSET_MINUS
;
1730 if (*string
!= '\0' && !isdigit (*string
))
1731 error (_("malformed line offset: \"%s\""), start
);
1733 /* Right now, we only allow base 10 for offsets. */
1734 line_offset
.offset
= atoi (string
);
1738 /* In completion mode, if the user is still typing the number, there's
1739 no possible completion to offer. But if there's already input past
1740 the number, setup to expect NEXT. */
1743 set_completion_after_number (linespec_parser
*parser
,
1744 linespec_complete_what next
)
1746 if (*PARSER_STREAM (parser
) == ' ')
1748 parser
->completion_word
= skip_spaces (PARSER_STREAM (parser
) + 1);
1749 parser
->complete_what
= next
;
1753 parser
->completion_word
= PARSER_STREAM (parser
);
1754 parser
->complete_what
= linespec_complete_what::NOTHING
;
1758 /* Parse the basic_spec in PARSER's input. */
1761 linespec_parse_basic (linespec_parser
*parser
)
1763 gdb::unique_xmalloc_ptr
<char> name
;
1764 linespec_token token
;
1765 std::vector
<block_symbol
> symbols
;
1766 std::vector
<block_symbol
> *labels
;
1767 std::vector
<bound_minimal_symbol
> minimal_symbols
;
1769 /* Get the next token. */
1770 token
= linespec_lexer_lex_one (parser
);
1772 /* If it is EOI or KEYWORD, issue an error. */
1773 if (token
.type
== LSTOKEN_KEYWORD
)
1775 parser
->complete_what
= linespec_complete_what::NOTHING
;
1776 unexpected_linespec_error (parser
);
1778 else if (token
.type
== LSTOKEN_EOI
)
1780 unexpected_linespec_error (parser
);
1782 /* If it is a LSTOKEN_NUMBER, we have an offset. */
1783 else if (token
.type
== LSTOKEN_NUMBER
)
1785 set_completion_after_number (parser
, linespec_complete_what::KEYWORD
);
1787 /* Record the line offset and get the next token. */
1788 name
= copy_token_string (token
);
1789 PARSER_EXPLICIT (parser
)->line_offset
1790 = linespec_parse_line_offset (name
.get ());
1792 /* Get the next token. */
1793 token
= linespec_lexer_consume_token (parser
);
1795 /* If the next token is a comma, stop parsing and return. */
1796 if (token
.type
== LSTOKEN_COMMA
)
1798 parser
->complete_what
= linespec_complete_what::NOTHING
;
1802 /* If the next token is anything but EOI or KEYWORD, issue
1804 if (token
.type
!= LSTOKEN_KEYWORD
&& token
.type
!= LSTOKEN_EOI
)
1805 unexpected_linespec_error (parser
);
1808 if (token
.type
== LSTOKEN_KEYWORD
|| token
.type
== LSTOKEN_EOI
)
1811 /* Next token must be LSTOKEN_STRING. */
1812 if (token
.type
!= LSTOKEN_STRING
)
1814 parser
->complete_what
= linespec_complete_what::NOTHING
;
1815 unexpected_linespec_error (parser
);
1818 /* The current token will contain the name of a function, method,
1820 name
= copy_token_string (token
);
1822 if (parser
->completion_tracker
!= NULL
)
1824 /* If the function name ends with a ":", then this may be an
1825 incomplete "::" scope operator instead of a label separator.
1828 which should expand to:
1831 Do a tentative completion assuming the later. If we find
1832 completions, advance the stream past the colon token and make
1833 it part of the function name/token. */
1835 if (!parser
->completion_quote_char
1836 && strcmp (PARSER_STREAM (parser
), ":") == 0)
1838 completion_tracker tmp_tracker
;
1839 const char *source_filename
1840 = PARSER_EXPLICIT (parser
)->source_filename
;
1841 symbol_name_match_type match_type
1842 = PARSER_EXPLICIT (parser
)->func_name_match_type
;
1844 linespec_complete_function (tmp_tracker
,
1845 parser
->completion_word
,
1849 if (tmp_tracker
.have_completions ())
1851 PARSER_STREAM (parser
)++;
1852 LS_TOKEN_STOKEN (token
).length
++;
1854 name
.reset (savestring (parser
->completion_word
,
1855 (PARSER_STREAM (parser
)
1856 - parser
->completion_word
)));
1860 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1864 /* Try looking it up as a function/method. */
1865 find_linespec_symbols (PARSER_STATE (parser
),
1866 PARSER_RESULT (parser
)->file_symtabs
, name
.get (),
1867 PARSER_EXPLICIT (parser
)->func_name_match_type
,
1868 &symbols
, &minimal_symbols
);
1870 if (!symbols
.empty () || !minimal_symbols
.empty ())
1872 PARSER_RESULT (parser
)->function_symbols
1873 = new std::vector
<block_symbol
> (std::move (symbols
));
1874 PARSER_RESULT (parser
)->minimal_symbols
1875 = new std::vector
<bound_minimal_symbol
>
1876 (std::move (minimal_symbols
));
1877 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1881 /* NAME was not a function or a method. So it must be a label
1882 name or user specified variable like "break foo.c:$zippo". */
1883 labels
= find_label_symbols (PARSER_STATE (parser
), NULL
,
1884 &symbols
, name
.get ());
1887 PARSER_RESULT (parser
)->labels
.label_symbols
= labels
;
1888 PARSER_RESULT (parser
)->labels
.function_symbols
1889 = new std::vector
<block_symbol
> (std::move (symbols
));
1890 PARSER_EXPLICIT (parser
)->label_name
= name
.release ();
1892 else if (token
.type
== LSTOKEN_STRING
1893 && *LS_TOKEN_STOKEN (token
).ptr
== '$')
1895 /* User specified a convenience variable or history value. */
1896 PARSER_EXPLICIT (parser
)->line_offset
1897 = linespec_parse_variable (PARSER_STATE (parser
), name
.get ());
1899 if (PARSER_EXPLICIT (parser
)->line_offset
.sign
== LINE_OFFSET_UNKNOWN
)
1901 /* The user-specified variable was not valid. Do not
1902 throw an error here. parse_linespec will do it for us. */
1903 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1909 /* The name is also not a label. Abort parsing. Do not throw
1910 an error here. parse_linespec will do it for us. */
1912 /* Save a copy of the name we were trying to lookup. */
1913 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1919 int previous_qc
= parser
->completion_quote_char
;
1921 /* Get the next token. */
1922 token
= linespec_lexer_consume_token (parser
);
1924 if (token
.type
== LSTOKEN_EOI
)
1926 if (previous_qc
&& !parser
->completion_quote_char
)
1927 parser
->complete_what
= linespec_complete_what::KEYWORD
;
1929 else if (token
.type
== LSTOKEN_COLON
)
1931 /* User specified a label or a lineno. */
1932 token
= linespec_lexer_consume_token (parser
);
1934 if (token
.type
== LSTOKEN_NUMBER
)
1936 /* User specified an offset. Record the line offset and
1937 get the next token. */
1938 set_completion_after_number (parser
, linespec_complete_what::KEYWORD
);
1940 name
= copy_token_string (token
);
1941 PARSER_EXPLICIT (parser
)->line_offset
1942 = linespec_parse_line_offset (name
.get ());
1944 /* Get the next token. */
1945 token
= linespec_lexer_consume_token (parser
);
1947 else if (token
.type
== LSTOKEN_EOI
&& parser
->completion_tracker
!= NULL
)
1949 parser
->complete_what
= linespec_complete_what::LABEL
;
1951 else if (token
.type
== LSTOKEN_STRING
)
1953 parser
->complete_what
= linespec_complete_what::LABEL
;
1955 /* If we have text after the label separated by whitespace
1956 (e.g., "b func():lab i<tab>"), don't consider it part of
1957 the label. In completion mode that should complete to
1958 "if", in normal mode, the 'i' should be treated as
1960 if (parser
->completion_quote_char
== '\0')
1962 const char *ptr
= LS_TOKEN_STOKEN (token
).ptr
;
1963 for (size_t i
= 0; i
< LS_TOKEN_STOKEN (token
).length
; i
++)
1967 LS_TOKEN_STOKEN (token
).length
= i
;
1968 PARSER_STREAM (parser
) = skip_spaces (ptr
+ i
+ 1);
1974 if (parser
->completion_tracker
!= NULL
)
1976 if (PARSER_STREAM (parser
)[-1] == ' ')
1978 parser
->completion_word
= PARSER_STREAM (parser
);
1979 parser
->complete_what
= linespec_complete_what::KEYWORD
;
1984 /* Grab a copy of the label's name and look it up. */
1985 name
= copy_token_string (token
);
1987 = find_label_symbols (PARSER_STATE (parser
),
1988 PARSER_RESULT (parser
)->function_symbols
,
1989 &symbols
, name
.get ());
1993 PARSER_RESULT (parser
)->labels
.label_symbols
= labels
;
1994 PARSER_RESULT (parser
)->labels
.function_symbols
1995 = new std::vector
<block_symbol
> (std::move (symbols
));
1996 PARSER_EXPLICIT (parser
)->label_name
= name
.release ();
2000 /* We don't know what it was, but it isn't a label. */
2001 undefined_label_error
2002 (PARSER_EXPLICIT (parser
)->function_name
, name
.get ());
2007 /* Check for a line offset. */
2008 token
= save_stream_and_consume_token (parser
);
2009 if (token
.type
== LSTOKEN_COLON
)
2011 /* Get the next token. */
2012 token
= linespec_lexer_consume_token (parser
);
2014 /* It must be a line offset. */
2015 if (token
.type
!= LSTOKEN_NUMBER
)
2016 unexpected_linespec_error (parser
);
2018 /* Record the line offset and get the next token. */
2019 name
= copy_token_string (token
);
2021 PARSER_EXPLICIT (parser
)->line_offset
2022 = linespec_parse_line_offset (name
.get ());
2024 /* Get the next token. */
2025 token
= linespec_lexer_consume_token (parser
);
2030 /* Trailing ':' in the input. Issue an error. */
2031 unexpected_linespec_error (parser
);
2036 /* Canonicalize the linespec contained in LS. The result is saved into
2037 STATE->canonical. This function handles both linespec and explicit
2041 canonicalize_linespec (struct linespec_state
*state
, const linespec_p ls
)
2043 struct event_location
*canon
;
2044 struct explicit_location
*explicit_loc
;
2046 /* If canonicalization was not requested, no need to do anything. */
2047 if (!state
->canonical
)
2050 /* Save everything as an explicit location. */
2051 state
->canonical
->location
2052 = new_explicit_location (&ls
->explicit_loc
);
2053 canon
= state
->canonical
->location
.get ();
2054 explicit_loc
= get_explicit_location (canon
);
2056 if (explicit_loc
->label_name
!= NULL
)
2058 state
->canonical
->special_display
= 1;
2060 if (explicit_loc
->function_name
== NULL
)
2062 /* No function was specified, so add the symbol name. */
2063 gdb_assert (!ls
->labels
.function_symbols
->empty ()
2064 && (ls
->labels
.function_symbols
->size () == 1));
2065 block_symbol s
= ls
->labels
.function_symbols
->front ();
2066 explicit_loc
->function_name
2067 = xstrdup (SYMBOL_NATURAL_NAME (s
.symbol
));
2071 /* If this location originally came from a linespec, save a string
2072 representation of it for display and saving to file. */
2073 if (state
->is_linespec
)
2075 char *linespec
= explicit_location_to_linespec (explicit_loc
);
2077 set_event_location_string (canon
, linespec
);
2082 /* Given a line offset in LS, construct the relevant SALs. */
2084 static std::vector
<symtab_and_line
>
2085 create_sals_line_offset (struct linespec_state
*self
,
2088 int use_default
= 0;
2090 /* This is where we need to make sure we have good defaults.
2091 We must guarantee that this section of code is never executed
2092 when we are called with just a function name, since
2093 set_default_source_symtab_and_line uses
2094 select_source_symtab that calls us with such an argument. */
2096 if (ls
->file_symtabs
->size () == 1
2097 && ls
->file_symtabs
->front () == nullptr)
2099 set_current_program_space (self
->program_space
);
2101 /* Make sure we have at least a default source line. */
2102 set_default_source_symtab_and_line ();
2103 initialize_defaults (&self
->default_symtab
, &self
->default_line
);
2105 = collect_symtabs_from_filename (self
->default_symtab
->filename
,
2106 self
->search_pspace
);
2110 symtab_and_line val
;
2111 val
.line
= ls
->explicit_loc
.line_offset
.offset
;
2112 switch (ls
->explicit_loc
.line_offset
.sign
)
2114 case LINE_OFFSET_PLUS
:
2115 if (ls
->explicit_loc
.line_offset
.offset
== 0)
2118 val
.line
= self
->default_line
+ val
.line
;
2121 case LINE_OFFSET_MINUS
:
2122 if (ls
->explicit_loc
.line_offset
.offset
== 0)
2125 val
.line
= self
->default_line
- val
.line
;
2127 val
.line
= -val
.line
;
2130 case LINE_OFFSET_NONE
:
2131 break; /* No need to adjust val.line. */
2134 std::vector
<symtab_and_line
> values
;
2135 if (self
->list_mode
)
2136 values
= decode_digits_list_mode (self
, ls
, val
);
2139 struct linetable_entry
*best_entry
= NULL
;
2142 std::vector
<symtab_and_line
> intermediate_results
2143 = decode_digits_ordinary (self
, ls
, val
.line
, &best_entry
);
2144 if (intermediate_results
.empty () && best_entry
!= NULL
)
2145 intermediate_results
= decode_digits_ordinary (self
, ls
,
2149 /* For optimized code, the compiler can scatter one source line
2150 across disjoint ranges of PC values, even when no duplicate
2151 functions or inline functions are involved. For example,
2152 'for (;;)' inside a non-template, non-inline, and non-ctor-or-dtor
2153 function can result in two PC ranges. In this case, we don't
2154 want to set a breakpoint on the first PC of each range. To filter
2155 such cases, we use containing blocks -- for each PC found
2156 above, we see if there are other PCs that are in the same
2157 block. If yes, the other PCs are filtered out. */
2159 gdb::def_vector
<int> filter (intermediate_results
.size ());
2160 gdb::def_vector
<const block
*> blocks (intermediate_results
.size ());
2162 for (i
= 0; i
< intermediate_results
.size (); ++i
)
2164 set_current_program_space (intermediate_results
[i
].pspace
);
2167 blocks
[i
] = block_for_pc_sect (intermediate_results
[i
].pc
,
2168 intermediate_results
[i
].section
);
2171 for (i
= 0; i
< intermediate_results
.size (); ++i
)
2173 if (blocks
[i
] != NULL
)
2174 for (j
= i
+ 1; j
< intermediate_results
.size (); ++j
)
2176 if (blocks
[j
] == blocks
[i
])
2184 for (i
= 0; i
< intermediate_results
.size (); ++i
)
2187 struct symbol
*sym
= (blocks
[i
]
2188 ? block_containing_function (blocks
[i
])
2191 if (self
->funfirstline
)
2192 skip_prologue_sal (&intermediate_results
[i
]);
2193 intermediate_results
[i
].symbol
= sym
;
2194 add_sal_to_sals (self
, &values
, &intermediate_results
[i
],
2195 sym
? SYMBOL_NATURAL_NAME (sym
) : NULL
, 0);
2199 if (values
.empty ())
2201 if (ls
->explicit_loc
.source_filename
)
2202 throw_error (NOT_FOUND_ERROR
, _("No line %d in file \"%s\"."),
2203 val
.line
, ls
->explicit_loc
.source_filename
);
2205 throw_error (NOT_FOUND_ERROR
, _("No line %d in the current file."),
2212 /* Convert the given ADDRESS into SaLs. */
2214 static std::vector
<symtab_and_line
>
2215 convert_address_location_to_sals (struct linespec_state
*self
,
2218 symtab_and_line sal
= find_pc_line (address
, 0);
2220 sal
.section
= find_pc_overlay (address
);
2221 sal
.explicit_pc
= 1;
2222 sal
.symbol
= find_pc_sect_containing_function (sal
.pc
, sal
.section
);
2224 std::vector
<symtab_and_line
> sals
;
2225 add_sal_to_sals (self
, &sals
, &sal
, core_addr_to_string (address
), 1);
2230 /* Create and return SALs from the linespec LS. */
2232 static std::vector
<symtab_and_line
>
2233 convert_linespec_to_sals (struct linespec_state
*state
, linespec_p ls
)
2235 std::vector
<symtab_and_line
> sals
;
2237 if (ls
->labels
.label_symbols
!= NULL
)
2239 /* We have just a bunch of functions/methods or labels. */
2240 struct symtab_and_line sal
;
2242 for (const auto &sym
: *ls
->labels
.label_symbols
)
2244 struct program_space
*pspace
2245 = SYMTAB_PSPACE (symbol_symtab (sym
.symbol
));
2247 if (symbol_to_sal (&sal
, state
->funfirstline
, sym
.symbol
)
2248 && maybe_add_address (state
->addr_set
, pspace
, sal
.pc
))
2249 add_sal_to_sals (state
, &sals
, &sal
,
2250 SYMBOL_NATURAL_NAME (sym
.symbol
), 0);
2253 else if (ls
->function_symbols
!= NULL
|| ls
->minimal_symbols
!= NULL
)
2255 /* We have just a bunch of functions and/or methods. */
2256 if (ls
->function_symbols
!= NULL
)
2258 /* Sort symbols so that symbols with the same program space are next
2260 std::sort (ls
->function_symbols
->begin (),
2261 ls
->function_symbols
->end (),
2264 for (const auto &sym
: *ls
->function_symbols
)
2266 program_space
*pspace
2267 = SYMTAB_PSPACE (symbol_symtab (sym
.symbol
));
2268 set_current_program_space (pspace
);
2270 /* Don't skip to the first line of the function if we
2271 had found an ifunc minimal symbol for this function,
2272 because that means that this function is an ifunc
2273 resolver with the same name as the ifunc itself. */
2274 bool found_ifunc
= false;
2276 if (state
->funfirstline
2277 && ls
->minimal_symbols
!= NULL
2278 && SYMBOL_CLASS (sym
.symbol
) == LOC_BLOCK
)
2280 const CORE_ADDR addr
2281 = BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
.symbol
));
2283 for (const auto &elem
: *ls
->minimal_symbols
)
2285 if (MSYMBOL_TYPE (elem
.minsym
) == mst_text_gnu_ifunc
2286 || MSYMBOL_TYPE (elem
.minsym
) == mst_data_gnu_ifunc
)
2288 CORE_ADDR msym_addr
= BMSYMBOL_VALUE_ADDRESS (elem
);
2289 if (MSYMBOL_TYPE (elem
.minsym
) == mst_data_gnu_ifunc
)
2291 struct gdbarch
*gdbarch
2292 = get_objfile_arch (elem
.objfile
);
2294 = (gdbarch_convert_from_func_ptr_addr
2297 current_top_target ()));
2300 if (msym_addr
== addr
)
2311 symtab_and_line sal
;
2312 if (symbol_to_sal (&sal
, state
->funfirstline
, sym
.symbol
)
2313 && maybe_add_address (state
->addr_set
, pspace
, sal
.pc
))
2314 add_sal_to_sals (state
, &sals
, &sal
,
2315 SYMBOL_NATURAL_NAME (sym
.symbol
), 0);
2320 if (ls
->minimal_symbols
!= NULL
)
2322 /* Sort minimal symbols by program space, too */
2323 std::sort (ls
->minimal_symbols
->begin (),
2324 ls
->minimal_symbols
->end (),
2327 for (const auto &elem
: *ls
->minimal_symbols
)
2329 program_space
*pspace
= elem
.objfile
->pspace
;
2330 set_current_program_space (pspace
);
2331 minsym_found (state
, elem
.objfile
, elem
.minsym
, &sals
);
2335 else if (ls
->explicit_loc
.line_offset
.sign
!= LINE_OFFSET_UNKNOWN
)
2337 /* Only an offset was specified. */
2338 sals
= create_sals_line_offset (state
, ls
);
2340 /* Make sure we have a filename for canonicalization. */
2341 if (ls
->explicit_loc
.source_filename
== NULL
)
2343 const char *fullname
= symtab_to_fullname (state
->default_symtab
);
2345 /* It may be more appropriate to keep DEFAULT_SYMTAB in its symtab
2346 form so that displaying SOURCE_FILENAME can follow the current
2347 FILENAME_DISPLAY_STRING setting. But as it is used only rarely
2348 it has been kept for code simplicity only in absolute form. */
2349 ls
->explicit_loc
.source_filename
= xstrdup (fullname
);
2354 /* We haven't found any results... */
2358 canonicalize_linespec (state
, ls
);
2360 if (!sals
.empty () && state
->canonical
!= NULL
)
2361 state
->canonical
->pre_expanded
= 1;
2366 /* Build RESULT from the explicit location components SOURCE_FILENAME,
2367 FUNCTION_NAME, LABEL_NAME and LINE_OFFSET. */
2370 convert_explicit_location_to_linespec (struct linespec_state
*self
,
2372 const char *source_filename
,
2373 const char *function_name
,
2374 symbol_name_match_type fname_match_type
,
2375 const char *label_name
,
2376 struct line_offset line_offset
)
2378 std::vector
<block_symbol
> symbols
;
2379 std::vector
<block_symbol
> *labels
;
2380 std::vector
<bound_minimal_symbol
> minimal_symbols
;
2382 result
->explicit_loc
.func_name_match_type
= fname_match_type
;
2384 if (source_filename
!= NULL
)
2388 *result
->file_symtabs
2389 = symtabs_from_filename (source_filename
, self
->search_pspace
);
2391 CATCH (except
, RETURN_MASK_ERROR
)
2393 source_file_not_found_error (source_filename
);
2396 result
->explicit_loc
.source_filename
= xstrdup (source_filename
);
2400 /* A NULL entry means to use the default symtab. */
2401 result
->file_symtabs
->push_back (nullptr);
2404 if (function_name
!= NULL
)
2406 find_linespec_symbols (self
, result
->file_symtabs
,
2407 function_name
, fname_match_type
,
2408 &symbols
, &minimal_symbols
);
2410 if (symbols
.empty () && minimal_symbols
.empty ())
2411 symbol_not_found_error (function_name
,
2412 result
->explicit_loc
.source_filename
);
2414 result
->explicit_loc
.function_name
= xstrdup (function_name
);
2415 result
->function_symbols
2416 = new std::vector
<block_symbol
> (std::move (symbols
));
2417 result
->minimal_symbols
2418 = new std::vector
<bound_minimal_symbol
> (std::move (minimal_symbols
));
2421 if (label_name
!= NULL
)
2423 labels
= find_label_symbols (self
, result
->function_symbols
,
2424 &symbols
, label_name
);
2427 undefined_label_error (result
->explicit_loc
.function_name
,
2430 result
->explicit_loc
.label_name
= xstrdup (label_name
);
2431 result
->labels
.label_symbols
= labels
;
2432 result
->labels
.function_symbols
2433 = new std::vector
<block_symbol
> (std::move (symbols
));
2436 if (line_offset
.sign
!= LINE_OFFSET_UNKNOWN
)
2437 result
->explicit_loc
.line_offset
= line_offset
;
2440 /* Convert the explicit location EXPLICIT_LOC into SaLs. */
2442 static std::vector
<symtab_and_line
>
2443 convert_explicit_location_to_sals (struct linespec_state
*self
,
2445 const struct explicit_location
*explicit_loc
)
2447 convert_explicit_location_to_linespec (self
, result
,
2448 explicit_loc
->source_filename
,
2449 explicit_loc
->function_name
,
2450 explicit_loc
->func_name_match_type
,
2451 explicit_loc
->label_name
,
2452 explicit_loc
->line_offset
);
2453 return convert_linespec_to_sals (self
, result
);
2456 /* Parse a string that specifies a linespec.
2458 The basic grammar of linespecs:
2460 linespec -> var_spec | basic_spec
2461 var_spec -> '$' (STRING | NUMBER)
2463 basic_spec -> file_offset_spec | function_spec | label_spec
2464 file_offset_spec -> opt_file_spec offset_spec
2465 function_spec -> opt_file_spec function_name_spec opt_label_spec
2466 label_spec -> label_name_spec
2468 opt_file_spec -> "" | file_name_spec ':'
2469 opt_label_spec -> "" | ':' label_name_spec
2471 file_name_spec -> STRING
2472 function_name_spec -> STRING
2473 label_name_spec -> STRING
2474 function_name_spec -> STRING
2475 offset_spec -> NUMBER
2479 This may all be followed by several keywords such as "if EXPR",
2482 A comma will terminate parsing.
2484 The function may be an undebuggable function found in minimal symbol table.
2486 If the argument FUNFIRSTLINE is nonzero, we want the first line
2487 of real code inside a function when a function is specified, and it is
2488 not OK to specify a variable or type to get its line number.
2490 DEFAULT_SYMTAB specifies the file to use if none is specified.
2491 It defaults to current_source_symtab.
2492 DEFAULT_LINE specifies the line number to use for relative
2493 line numbers (that start with signs). Defaults to current_source_line.
2494 If CANONICAL is non-NULL, store an array of strings containing the canonical
2495 line specs there if necessary. Currently overloaded member functions and
2496 line numbers or static functions without a filename yield a canonical
2497 line spec. The array and the line spec strings are allocated on the heap,
2498 it is the callers responsibility to free them.
2500 Note that it is possible to return zero for the symtab
2501 if no file is validly specified. Callers must check that.
2502 Also, the line number returned may be invalid. */
2504 /* Parse the linespec in ARG. MATCH_TYPE indicates how function names
2505 should be matched. */
2507 static std::vector
<symtab_and_line
>
2508 parse_linespec (linespec_parser
*parser
, const char *arg
,
2509 symbol_name_match_type match_type
)
2511 linespec_token token
;
2512 struct gdb_exception file_exception
= exception_none
;
2514 /* A special case to start. It has become quite popular for
2515 IDEs to work around bugs in the previous parser by quoting
2516 the entire linespec, so we attempt to deal with this nicely. */
2517 parser
->is_quote_enclosed
= 0;
2518 if (parser
->completion_tracker
== NULL
2519 && !is_ada_operator (arg
)
2520 && strchr (linespec_quote_characters
, *arg
) != NULL
)
2524 end
= skip_quote_char (arg
+ 1, *arg
);
2525 if (end
!= NULL
&& is_closing_quote_enclosed (end
))
2527 /* Here's the special case. Skip ARG past the initial
2530 parser
->is_quote_enclosed
= 1;
2534 parser
->lexer
.saved_arg
= arg
;
2535 parser
->lexer
.stream
= arg
;
2536 parser
->completion_word
= arg
;
2537 parser
->complete_what
= linespec_complete_what::FUNCTION
;
2538 PARSER_EXPLICIT (parser
)->func_name_match_type
= match_type
;
2540 /* Initialize the default symtab and line offset. */
2541 initialize_defaults (&PARSER_STATE (parser
)->default_symtab
,
2542 &PARSER_STATE (parser
)->default_line
);
2544 /* Objective-C shortcut. */
2545 if (parser
->completion_tracker
== NULL
)
2547 std::vector
<symtab_and_line
> values
2548 = decode_objc (PARSER_STATE (parser
), PARSER_RESULT (parser
), arg
);
2549 if (!values
.empty ())
2554 /* "-"/"+" is either an objc selector, or a number. There's
2555 nothing to complete the latter to, so just let the caller
2556 complete on functions, which finds objc selectors, if there's
2558 if ((arg
[0] == '-' || arg
[0] == '+') && arg
[1] == '\0')
2562 /* Start parsing. */
2564 /* Get the first token. */
2565 token
= linespec_lexer_consume_token (parser
);
2567 /* It must be either LSTOKEN_STRING or LSTOKEN_NUMBER. */
2568 if (token
.type
== LSTOKEN_STRING
&& *LS_TOKEN_STOKEN (token
).ptr
== '$')
2570 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2571 if (parser
->completion_tracker
== NULL
)
2572 PARSER_RESULT (parser
)->file_symtabs
->push_back (nullptr);
2574 /* User specified a convenience variable or history value. */
2575 gdb::unique_xmalloc_ptr
<char> var
= copy_token_string (token
);
2576 PARSER_EXPLICIT (parser
)->line_offset
2577 = linespec_parse_variable (PARSER_STATE (parser
), var
.get ());
2579 /* If a line_offset wasn't found (VAR is the name of a user
2580 variable/function), then skip to normal symbol processing. */
2581 if (PARSER_EXPLICIT (parser
)->line_offset
.sign
!= LINE_OFFSET_UNKNOWN
)
2583 /* Consume this token. */
2584 linespec_lexer_consume_token (parser
);
2586 goto convert_to_sals
;
2589 else if (token
.type
== LSTOKEN_EOI
&& parser
->completion_tracker
!= NULL
)
2591 /* Let the default linespec_complete_what::FUNCTION kick in. */
2592 unexpected_linespec_error (parser
);
2594 else if (token
.type
!= LSTOKEN_STRING
&& token
.type
!= LSTOKEN_NUMBER
)
2596 parser
->complete_what
= linespec_complete_what::NOTHING
;
2597 unexpected_linespec_error (parser
);
2600 /* Shortcut: If the next token is not LSTOKEN_COLON, we know that
2601 this token cannot represent a filename. */
2602 token
= linespec_lexer_peek_token (parser
);
2604 if (token
.type
== LSTOKEN_COLON
)
2606 /* Get the current token again and extract the filename. */
2607 token
= linespec_lexer_lex_one (parser
);
2608 gdb::unique_xmalloc_ptr
<char> user_filename
= copy_token_string (token
);
2610 /* Check if the input is a filename. */
2613 *PARSER_RESULT (parser
)->file_symtabs
2614 = symtabs_from_filename (user_filename
.get (),
2615 PARSER_STATE (parser
)->search_pspace
);
2617 CATCH (ex
, RETURN_MASK_ERROR
)
2619 file_exception
= ex
;
2623 if (file_exception
.reason
>= 0)
2625 /* Symtabs were found for the file. Record the filename. */
2626 PARSER_EXPLICIT (parser
)->source_filename
= user_filename
.release ();
2628 /* Get the next token. */
2629 token
= linespec_lexer_consume_token (parser
);
2631 /* This is LSTOKEN_COLON; consume it. */
2632 linespec_lexer_consume_token (parser
);
2636 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2637 PARSER_RESULT (parser
)->file_symtabs
->push_back (nullptr);
2640 /* If the next token is not EOI, KEYWORD, or COMMA, issue an error. */
2641 else if (parser
->completion_tracker
== NULL
2642 && (token
.type
!= LSTOKEN_EOI
&& token
.type
!= LSTOKEN_KEYWORD
2643 && token
.type
!= LSTOKEN_COMMA
))
2645 /* TOKEN is the _next_ token, not the one currently in the parser.
2646 Consuming the token will give the correct error message. */
2647 linespec_lexer_consume_token (parser
);
2648 unexpected_linespec_error (parser
);
2652 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2653 PARSER_RESULT (parser
)->file_symtabs
->push_back (nullptr);
2656 /* Parse the rest of the linespec. */
2657 linespec_parse_basic (parser
);
2659 if (parser
->completion_tracker
== NULL
2660 && PARSER_RESULT (parser
)->function_symbols
== NULL
2661 && PARSER_RESULT (parser
)->labels
.label_symbols
== NULL
2662 && PARSER_EXPLICIT (parser
)->line_offset
.sign
== LINE_OFFSET_UNKNOWN
2663 && PARSER_RESULT (parser
)->minimal_symbols
== NULL
)
2665 /* The linespec didn't parse. Re-throw the file exception if
2667 if (file_exception
.reason
< 0)
2668 throw_exception (file_exception
);
2670 /* Otherwise, the symbol is not found. */
2671 symbol_not_found_error (PARSER_EXPLICIT (parser
)->function_name
,
2672 PARSER_EXPLICIT (parser
)->source_filename
);
2677 /* Get the last token and record how much of the input was parsed,
2679 token
= linespec_lexer_lex_one (parser
);
2680 if (token
.type
!= LSTOKEN_EOI
&& token
.type
!= LSTOKEN_KEYWORD
)
2681 unexpected_linespec_error (parser
);
2682 else if (token
.type
== LSTOKEN_KEYWORD
)
2684 /* Setup the completion word past the keyword. Lexing never
2685 advances past a keyword automatically, so skip it
2687 parser
->completion_word
2688 = skip_spaces (skip_to_space (PARSER_STREAM (parser
)));
2689 parser
->complete_what
= linespec_complete_what::EXPRESSION
;
2692 /* Convert the data in PARSER_RESULT to SALs. */
2693 if (parser
->completion_tracker
== NULL
)
2694 return convert_linespec_to_sals (PARSER_STATE (parser
),
2695 PARSER_RESULT (parser
));
2701 /* A constructor for linespec_state. */
2704 linespec_state_constructor (struct linespec_state
*self
,
2705 int flags
, const struct language_defn
*language
,
2706 struct program_space
*search_pspace
,
2707 struct symtab
*default_symtab
,
2709 struct linespec_result
*canonical
)
2711 memset (self
, 0, sizeof (*self
));
2712 self
->language
= language
;
2713 self
->funfirstline
= (flags
& DECODE_LINE_FUNFIRSTLINE
) ? 1 : 0;
2714 self
->list_mode
= (flags
& DECODE_LINE_LIST_MODE
) ? 1 : 0;
2715 self
->search_pspace
= search_pspace
;
2716 self
->default_symtab
= default_symtab
;
2717 self
->default_line
= default_line
;
2718 self
->canonical
= canonical
;
2719 self
->program_space
= current_program_space
;
2720 self
->addr_set
= htab_create_alloc (10, hash_address_entry
, eq_address_entry
,
2721 xfree
, xcalloc
, xfree
);
2722 self
->is_linespec
= 0;
2725 /* Initialize a new linespec parser. */
2727 linespec_parser::linespec_parser (int flags
,
2728 const struct language_defn
*language
,
2729 struct program_space
*search_pspace
,
2730 struct symtab
*default_symtab
,
2732 struct linespec_result
*canonical
)
2734 lexer
.current
.type
= LSTOKEN_CONSUMED
;
2735 PARSER_RESULT (this)->file_symtabs
= new std::vector
<symtab
*> ();
2736 PARSER_EXPLICIT (this)->func_name_match_type
2737 = symbol_name_match_type::WILD
;
2738 PARSER_EXPLICIT (this)->line_offset
.sign
= LINE_OFFSET_UNKNOWN
;
2739 linespec_state_constructor (PARSER_STATE (this), flags
, language
,
2741 default_symtab
, default_line
, canonical
);
2744 /* A destructor for linespec_state. */
2747 linespec_state_destructor (struct linespec_state
*self
)
2749 htab_delete (self
->addr_set
);
2750 xfree (self
->canonical_names
);
2753 /* Delete a linespec parser. */
2755 linespec_parser::~linespec_parser ()
2757 xfree (PARSER_EXPLICIT (this)->source_filename
);
2758 xfree (PARSER_EXPLICIT (this)->label_name
);
2759 xfree (PARSER_EXPLICIT (this)->function_name
);
2761 delete PARSER_RESULT (this)->file_symtabs
;
2762 delete PARSER_RESULT (this)->function_symbols
;
2763 delete PARSER_RESULT (this)->minimal_symbols
;
2764 delete PARSER_RESULT (this)->labels
.label_symbols
;
2765 delete PARSER_RESULT (this)->labels
.function_symbols
;
2767 linespec_state_destructor (PARSER_STATE (this));
2770 /* See description in linespec.h. */
2773 linespec_lex_to_end (const char **stringp
)
2775 linespec_token token
;
2778 if (stringp
== NULL
|| *stringp
== NULL
)
2781 linespec_parser
parser (0, current_language
, NULL
, NULL
, 0, NULL
);
2782 parser
.lexer
.saved_arg
= *stringp
;
2783 PARSER_STREAM (&parser
) = orig
= *stringp
;
2787 /* Stop before any comma tokens; we need it to keep it
2788 as the next token in the string. */
2789 token
= linespec_lexer_peek_token (&parser
);
2790 if (token
.type
== LSTOKEN_COMMA
)
2792 token
= linespec_lexer_consume_token (&parser
);
2794 while (token
.type
!= LSTOKEN_EOI
&& token
.type
!= LSTOKEN_KEYWORD
);
2796 *stringp
+= PARSER_STREAM (&parser
) - orig
;
2799 /* See linespec.h. */
2802 linespec_complete_function (completion_tracker
&tracker
,
2803 const char *function
,
2804 symbol_name_match_type func_match_type
,
2805 const char *source_filename
)
2807 complete_symbol_mode mode
= complete_symbol_mode::LINESPEC
;
2809 if (source_filename
!= NULL
)
2811 collect_file_symbol_completion_matches (tracker
, mode
, func_match_type
,
2812 function
, function
, source_filename
);
2816 collect_symbol_completion_matches (tracker
, mode
, func_match_type
,
2817 function
, function
);
2822 /* Helper for complete_linespec to simplify it. SOURCE_FILENAME is
2823 only meaningful if COMPONENT is FUNCTION. */
2826 complete_linespec_component (linespec_parser
*parser
,
2827 completion_tracker
&tracker
,
2829 linespec_complete_what component
,
2830 const char *source_filename
)
2832 if (component
== linespec_complete_what::KEYWORD
)
2834 complete_on_enum (tracker
, linespec_keywords
, text
, text
);
2836 else if (component
== linespec_complete_what::EXPRESSION
)
2839 = advance_to_expression_complete_word_point (tracker
, text
);
2840 complete_expression (tracker
, text
, word
);
2842 else if (component
== linespec_complete_what::FUNCTION
)
2844 completion_list fn_list
;
2846 symbol_name_match_type match_type
2847 = PARSER_EXPLICIT (parser
)->func_name_match_type
;
2848 linespec_complete_function (tracker
, text
, match_type
, source_filename
);
2849 if (source_filename
== NULL
)
2851 /* Haven't seen a source component, like in "b
2852 file.c:function[TAB]". Maybe this wasn't a function, but
2853 a filename instead, like "b file.[TAB]". */
2854 fn_list
= complete_source_filenames (text
);
2857 /* If we only have a single filename completion, append a ':' for
2858 the user, since that's the only thing that can usefully follow
2860 if (fn_list
.size () == 1 && !tracker
.have_completions ())
2862 char *fn
= fn_list
[0].release ();
2864 /* If we also need to append a quote char, it needs to be
2865 appended before the ':'. Append it now, and make ':' the
2866 new "quote" char. */
2867 if (tracker
.quote_char ())
2869 char quote_char_str
[2] = { (char) tracker
.quote_char () };
2871 fn
= reconcat (fn
, fn
, quote_char_str
, (char *) NULL
);
2872 tracker
.set_quote_char (':');
2875 fn
= reconcat (fn
, fn
, ":", (char *) NULL
);
2876 fn_list
[0].reset (fn
);
2878 /* Tell readline to skip appending a space. */
2879 tracker
.set_suppress_append_ws (true);
2881 tracker
.add_completions (std::move (fn_list
));
2885 /* Helper for linespec_complete_label. Find labels that match
2886 LABEL_NAME in the function symbols listed in the PARSER, and add
2887 them to the tracker. */
2890 complete_label (completion_tracker
&tracker
,
2891 linespec_parser
*parser
,
2892 const char *label_name
)
2894 std::vector
<block_symbol
> label_function_symbols
;
2895 std::vector
<block_symbol
> *labels
2896 = find_label_symbols (PARSER_STATE (parser
),
2897 PARSER_RESULT (parser
)->function_symbols
,
2898 &label_function_symbols
,
2901 if (labels
!= nullptr)
2903 for (const auto &label
: *labels
)
2905 char *match
= xstrdup (SYMBOL_SEARCH_NAME (label
.symbol
));
2906 tracker
.add_completion (gdb::unique_xmalloc_ptr
<char> (match
));
2912 /* See linespec.h. */
2915 linespec_complete_label (completion_tracker
&tracker
,
2916 const struct language_defn
*language
,
2917 const char *source_filename
,
2918 const char *function_name
,
2919 symbol_name_match_type func_name_match_type
,
2920 const char *label_name
)
2922 linespec_parser
parser (0, language
, NULL
, NULL
, 0, NULL
);
2924 line_offset unknown_offset
= { 0, LINE_OFFSET_UNKNOWN
};
2928 convert_explicit_location_to_linespec (PARSER_STATE (&parser
),
2929 PARSER_RESULT (&parser
),
2932 func_name_match_type
,
2933 NULL
, unknown_offset
);
2935 CATCH (ex
, RETURN_MASK_ERROR
)
2941 complete_label (tracker
, &parser
, label_name
);
2944 /* See description in linespec.h. */
2947 linespec_complete (completion_tracker
&tracker
, const char *text
,
2948 symbol_name_match_type match_type
)
2950 const char *orig
= text
;
2952 linespec_parser
parser (0, current_language
, NULL
, NULL
, 0, NULL
);
2953 parser
.lexer
.saved_arg
= text
;
2954 PARSER_EXPLICIT (&parser
)->func_name_match_type
= match_type
;
2955 PARSER_STREAM (&parser
) = text
;
2957 parser
.completion_tracker
= &tracker
;
2958 PARSER_STATE (&parser
)->is_linespec
= 1;
2960 /* Parse as much as possible. parser.completion_word will hold
2961 furthest completion point we managed to parse to. */
2964 parse_linespec (&parser
, text
, match_type
);
2966 CATCH (except
, RETURN_MASK_ERROR
)
2971 if (parser
.completion_quote_char
!= '\0'
2972 && parser
.completion_quote_end
!= NULL
2973 && parser
.completion_quote_end
[1] == '\0')
2975 /* If completing a quoted string with the cursor right at
2976 terminating quote char, complete the completion word without
2977 interpretation, so that readline advances the cursor one
2978 whitespace past the quote, even if there's no match. This
2979 makes these cases behave the same:
2981 before: "b function()"
2982 after: "b function() "
2984 before: "b 'function()'"
2985 after: "b 'function()' "
2987 and trusts the user in this case:
2989 before: "b 'not_loaded_function_yet()'"
2990 after: "b 'not_loaded_function_yet()' "
2992 parser
.complete_what
= linespec_complete_what::NOTHING
;
2993 parser
.completion_quote_char
= '\0';
2995 gdb::unique_xmalloc_ptr
<char> text_copy
2996 (xstrdup (parser
.completion_word
));
2997 tracker
.add_completion (std::move (text_copy
));
3000 tracker
.set_quote_char (parser
.completion_quote_char
);
3002 if (parser
.complete_what
== linespec_complete_what::LABEL
)
3004 parser
.complete_what
= linespec_complete_what::NOTHING
;
3006 const char *func_name
= PARSER_EXPLICIT (&parser
)->function_name
;
3008 std::vector
<block_symbol
> function_symbols
;
3009 std::vector
<bound_minimal_symbol
> minimal_symbols
;
3010 find_linespec_symbols (PARSER_STATE (&parser
),
3011 PARSER_RESULT (&parser
)->file_symtabs
,
3012 func_name
, match_type
,
3013 &function_symbols
, &minimal_symbols
);
3015 PARSER_RESULT (&parser
)->function_symbols
3016 = new std::vector
<block_symbol
> (std::move (function_symbols
));
3017 PARSER_RESULT (&parser
)->minimal_symbols
3018 = new std::vector
<bound_minimal_symbol
> (std::move (minimal_symbols
));
3020 complete_label (tracker
, &parser
, parser
.completion_word
);
3022 else if (parser
.complete_what
== linespec_complete_what::FUNCTION
)
3024 /* While parsing/lexing, we didn't know whether the completion
3025 word completes to a unique function/source name already or
3029 "b function() <tab>"
3030 may need to complete either to:
3031 "b function() const"
3033 "b function() if/thread/task"
3037 may need to complete either to:
3038 "b foo template_fun<T>()"
3039 with "foo" being the template function's return type, or to:
3044 may need to complete either to a source file name:
3046 or this, also a filename, but a unique completion:
3048 or to a function name:
3051 Address that by completing assuming source or function, and
3052 seeing if we find a completion that matches exactly the
3053 completion word. If so, then it must be a function (see note
3054 below) and we advance the completion word to the end of input
3055 and switch to KEYWORD completion mode.
3057 Note: if we find a unique completion for a source filename,
3058 then it won't match the completion word, because the LCD will
3059 contain a trailing ':'. And if we're completing at or after
3060 the ':', then complete_linespec_component won't try to
3061 complete on source filenames. */
3063 const char *word
= parser
.completion_word
;
3065 complete_linespec_component (&parser
, tracker
,
3066 parser
.completion_word
,
3067 linespec_complete_what::FUNCTION
,
3068 PARSER_EXPLICIT (&parser
)->source_filename
);
3070 parser
.complete_what
= linespec_complete_what::NOTHING
;
3072 if (tracker
.quote_char ())
3074 /* The function/file name was not close-quoted, so this
3075 can't be a keyword. Note: complete_linespec_component
3076 may have swapped the original quote char for ':' when we
3077 get here, but that still indicates the same. */
3079 else if (!tracker
.have_completions ())
3082 size_t wordlen
= strlen (parser
.completion_word
);
3085 = string_find_incomplete_keyword_at_end (linespec_keywords
,
3086 parser
.completion_word
,
3091 && parser
.completion_word
[wordlen
- 1] == ' '))
3093 parser
.completion_word
+= key_start
;
3094 parser
.complete_what
= linespec_complete_what::KEYWORD
;
3097 else if (tracker
.completes_to_completion_word (word
))
3099 /* Skip the function and complete on keywords. */
3100 parser
.completion_word
+= strlen (word
);
3101 parser
.complete_what
= linespec_complete_what::KEYWORD
;
3102 tracker
.discard_completions ();
3106 tracker
.advance_custom_word_point_by (parser
.completion_word
- orig
);
3108 complete_linespec_component (&parser
, tracker
,
3109 parser
.completion_word
,
3110 parser
.complete_what
,
3111 PARSER_EXPLICIT (&parser
)->source_filename
);
3113 /* If we're past the "filename:function:label:offset" linespec, and
3114 didn't find any match, then assume the user might want to create
3115 a pending breakpoint anyway and offer the keyword
3117 if (!parser
.completion_quote_char
3118 && (parser
.complete_what
== linespec_complete_what::FUNCTION
3119 || parser
.complete_what
== linespec_complete_what::LABEL
3120 || parser
.complete_what
== linespec_complete_what::NOTHING
)
3121 && !tracker
.have_completions ())
3124 = parser
.completion_word
+ strlen (parser
.completion_word
);
3126 if (end
> orig
&& end
[-1] == ' ')
3128 tracker
.advance_custom_word_point_by (end
- parser
.completion_word
);
3130 complete_linespec_component (&parser
, tracker
, end
,
3131 linespec_complete_what::KEYWORD
,
3137 /* A helper function for decode_line_full and decode_line_1 to
3138 turn LOCATION into std::vector<symtab_and_line>. */
3140 static std::vector
<symtab_and_line
>
3141 event_location_to_sals (linespec_parser
*parser
,
3142 const struct event_location
*location
)
3144 std::vector
<symtab_and_line
> result
;
3146 switch (event_location_type (location
))
3148 case LINESPEC_LOCATION
:
3150 PARSER_STATE (parser
)->is_linespec
= 1;
3153 const linespec_location
*ls
= get_linespec_location (location
);
3154 result
= parse_linespec (parser
,
3155 ls
->spec_string
, ls
->match_type
);
3157 CATCH (except
, RETURN_MASK_ERROR
)
3159 throw_exception (except
);
3165 case ADDRESS_LOCATION
:
3167 const char *addr_string
= get_address_string_location (location
);
3168 CORE_ADDR addr
= get_address_location (location
);
3170 if (addr_string
!= NULL
)
3172 addr
= linespec_expression_to_pc (&addr_string
);
3173 if (PARSER_STATE (parser
)->canonical
!= NULL
)
3174 PARSER_STATE (parser
)->canonical
->location
3175 = copy_event_location (location
);
3178 result
= convert_address_location_to_sals (PARSER_STATE (parser
),
3183 case EXPLICIT_LOCATION
:
3185 const struct explicit_location
*explicit_loc
;
3187 explicit_loc
= get_explicit_location_const (location
);
3188 result
= convert_explicit_location_to_sals (PARSER_STATE (parser
),
3189 PARSER_RESULT (parser
),
3194 case PROBE_LOCATION
:
3195 /* Probes are handled by their own decoders. */
3196 gdb_assert_not_reached ("attempt to decode probe location");
3200 gdb_assert_not_reached ("unhandled event location type");
3206 /* See linespec.h. */
3209 decode_line_full (const struct event_location
*location
, int flags
,
3210 struct program_space
*search_pspace
,
3211 struct symtab
*default_symtab
,
3212 int default_line
, struct linespec_result
*canonical
,
3213 const char *select_mode
,
3216 std::vector
<const char *> filters
;
3217 struct linespec_state
*state
;
3219 gdb_assert (canonical
!= NULL
);
3220 /* The filter only makes sense for 'all'. */
3221 gdb_assert (filter
== NULL
|| select_mode
== multiple_symbols_all
);
3222 gdb_assert (select_mode
== NULL
3223 || select_mode
== multiple_symbols_all
3224 || select_mode
== multiple_symbols_ask
3225 || select_mode
== multiple_symbols_cancel
);
3226 gdb_assert ((flags
& DECODE_LINE_LIST_MODE
) == 0);
3228 linespec_parser
parser (flags
, current_language
,
3229 search_pspace
, default_symtab
,
3230 default_line
, canonical
);
3232 scoped_restore_current_program_space restore_pspace
;
3234 std::vector
<symtab_and_line
> result
= event_location_to_sals (&parser
,
3236 state
= PARSER_STATE (&parser
);
3238 gdb_assert (result
.size () == 1 || canonical
->pre_expanded
);
3239 canonical
->pre_expanded
= 1;
3241 /* Arrange for allocated canonical names to be freed. */
3242 std::vector
<gdb::unique_xmalloc_ptr
<char>> hold_names
;
3243 for (int i
= 0; i
< result
.size (); ++i
)
3245 gdb_assert (state
->canonical_names
[i
].suffix
!= NULL
);
3246 hold_names
.emplace_back (state
->canonical_names
[i
].suffix
);
3249 if (select_mode
== NULL
)
3251 if (top_level_interpreter ()->interp_ui_out ()->is_mi_like_p ())
3252 select_mode
= multiple_symbols_all
;
3254 select_mode
= multiple_symbols_select_mode ();
3257 if (select_mode
== multiple_symbols_all
)
3261 filters
.push_back (filter
);
3262 filter_results (state
, &result
, filters
);
3265 convert_results_to_lsals (state
, &result
);
3268 decode_line_2 (state
, &result
, select_mode
);
3271 /* See linespec.h. */
3273 std::vector
<symtab_and_line
>
3274 decode_line_1 (const struct event_location
*location
, int flags
,
3275 struct program_space
*search_pspace
,
3276 struct symtab
*default_symtab
,
3279 linespec_parser
parser (flags
, current_language
,
3280 search_pspace
, default_symtab
,
3281 default_line
, NULL
);
3283 scoped_restore_current_program_space restore_pspace
;
3285 return event_location_to_sals (&parser
, location
);
3288 /* See linespec.h. */
3290 std::vector
<symtab_and_line
>
3291 decode_line_with_current_source (const char *string
, int flags
)
3294 error (_("Empty line specification."));
3296 /* We use whatever is set as the current source line. We do not try
3297 and get a default source symtab+line or it will recursively call us! */
3298 symtab_and_line cursal
= get_current_source_symtab_and_line ();
3300 event_location_up location
= string_to_event_location (&string
,
3302 std::vector
<symtab_and_line
> sals
3303 = decode_line_1 (location
.get (), flags
, NULL
, cursal
.symtab
, cursal
.line
);
3306 error (_("Junk at end of line specification: %s"), string
);
3311 /* See linespec.h. */
3313 std::vector
<symtab_and_line
>
3314 decode_line_with_last_displayed (const char *string
, int flags
)
3317 error (_("Empty line specification."));
3319 event_location_up location
= string_to_event_location (&string
,
3321 std::vector
<symtab_and_line
> sals
3322 = (last_displayed_sal_is_valid ()
3323 ? decode_line_1 (location
.get (), flags
, NULL
,
3324 get_last_displayed_symtab (),
3325 get_last_displayed_line ())
3326 : decode_line_1 (location
.get (), flags
, NULL
,
3327 (struct symtab
*) NULL
, 0));
3330 error (_("Junk at end of line specification: %s"), string
);
3337 /* First, some functions to initialize stuff at the beggining of the
3341 initialize_defaults (struct symtab
**default_symtab
, int *default_line
)
3343 if (*default_symtab
== 0)
3345 /* Use whatever we have for the default source line. We don't use
3346 get_current_or_default_symtab_and_line as it can recurse and call
3348 struct symtab_and_line cursal
=
3349 get_current_source_symtab_and_line ();
3351 *default_symtab
= cursal
.symtab
;
3352 *default_line
= cursal
.line
;
3358 /* Evaluate the expression pointed to by EXP_PTR into a CORE_ADDR,
3359 advancing EXP_PTR past any parsed text. */
3362 linespec_expression_to_pc (const char **exp_ptr
)
3364 if (current_program_space
->executing_startup
)
3365 /* The error message doesn't really matter, because this case
3366 should only hit during breakpoint reset. */
3367 throw_error (NOT_FOUND_ERROR
, _("cannot evaluate expressions while "
3368 "program space is in startup"));
3371 return value_as_address (parse_to_comma_and_eval (exp_ptr
));
3376 /* Here's where we recognise an Objective-C Selector. An Objective C
3377 selector may be implemented by more than one class, therefore it
3378 may represent more than one method/function. This gives us a
3379 situation somewhat analogous to C++ overloading. If there's more
3380 than one method that could represent the selector, then use some of
3381 the existing C++ code to let the user choose one. */
3383 static std::vector
<symtab_and_line
>
3384 decode_objc (struct linespec_state
*self
, linespec_p ls
, const char *arg
)
3386 struct collect_info info
;
3387 std::vector
<const char *> symbol_names
;
3388 const char *new_argptr
;
3391 std::vector
<symtab
*> symtabs
;
3392 symtabs
.push_back (nullptr);
3394 info
.file_symtabs
= &symtabs
;
3396 std::vector
<block_symbol
> symbols
;
3397 info
.result
.symbols
= &symbols
;
3398 std::vector
<bound_minimal_symbol
> minimal_symbols
;
3399 info
.result
.minimal_symbols
= &minimal_symbols
;
3401 new_argptr
= find_imps (arg
, &symbol_names
);
3402 if (symbol_names
.empty ())
3405 add_all_symbol_names_from_pspace (&info
, NULL
, symbol_names
,
3408 std::vector
<symtab_and_line
> values
;
3409 if (!symbols
.empty () || !minimal_symbols
.empty ())
3413 saved_arg
= (char *) alloca (new_argptr
- arg
+ 1);
3414 memcpy (saved_arg
, arg
, new_argptr
- arg
);
3415 saved_arg
[new_argptr
- arg
] = '\0';
3417 ls
->explicit_loc
.function_name
= xstrdup (saved_arg
);
3418 ls
->function_symbols
3419 = new std::vector
<block_symbol
> (std::move (symbols
));
3421 = new std::vector
<bound_minimal_symbol
> (std::move (minimal_symbols
));
3422 values
= convert_linespec_to_sals (self
, ls
);
3424 if (self
->canonical
)
3429 self
->canonical
->pre_expanded
= 1;
3431 if (ls
->explicit_loc
.source_filename
)
3433 holder
= string_printf ("%s:%s",
3434 ls
->explicit_loc
.source_filename
,
3436 str
= holder
.c_str ();
3441 self
->canonical
->location
3442 = new_linespec_location (&str
, symbol_name_match_type::FULL
);
3451 /* A function object that serves as symbol_found_callback_ftype
3452 callback for iterate_over_symbols. This is used by
3453 lookup_prefix_sym to collect type symbols. */
3454 class decode_compound_collector
3457 decode_compound_collector ()
3459 m_unique_syms
= htab_create_alloc (1, htab_hash_pointer
,
3460 htab_eq_pointer
, NULL
,
3464 ~decode_compound_collector ()
3466 if (m_unique_syms
!= NULL
)
3467 htab_delete (m_unique_syms
);
3470 /* Return all symbols collected. */
3471 std::vector
<block_symbol
> release_symbols ()
3473 return std::move (m_symbols
);
3476 /* Callable as a symbol_found_callback_ftype callback. */
3477 bool operator () (block_symbol
*bsym
);
3480 /* A hash table of all symbols we found. We use this to avoid
3481 adding any symbol more than once. */
3482 htab_t m_unique_syms
;
3484 /* The result vector. */
3485 std::vector
<block_symbol
> m_symbols
;
3489 decode_compound_collector::operator () (block_symbol
*bsym
)
3493 struct symbol
*sym
= bsym
->symbol
;
3495 if (SYMBOL_CLASS (sym
) != LOC_TYPEDEF
)
3496 return true; /* Continue iterating. */
3498 t
= SYMBOL_TYPE (sym
);
3499 t
= check_typedef (t
);
3500 if (TYPE_CODE (t
) != TYPE_CODE_STRUCT
3501 && TYPE_CODE (t
) != TYPE_CODE_UNION
3502 && TYPE_CODE (t
) != TYPE_CODE_NAMESPACE
)
3503 return true; /* Continue iterating. */
3505 slot
= htab_find_slot (m_unique_syms
, sym
, INSERT
);
3509 m_symbols
.push_back (*bsym
);
3512 return true; /* Continue iterating. */
3517 /* Return any symbols corresponding to CLASS_NAME in FILE_SYMTABS. */
3519 static std::vector
<block_symbol
>
3520 lookup_prefix_sym (struct linespec_state
*state
,
3521 std::vector
<symtab
*> *file_symtabs
,
3522 const char *class_name
)
3524 decode_compound_collector collector
;
3526 lookup_name_info
lookup_name (class_name
, symbol_name_match_type::FULL
);
3528 for (const auto &elt
: *file_symtabs
)
3532 iterate_over_all_matching_symtabs (state
, lookup_name
,
3533 STRUCT_DOMAIN
, ALL_DOMAIN
,
3534 NULL
, false, collector
);
3535 iterate_over_all_matching_symtabs (state
, lookup_name
,
3536 VAR_DOMAIN
, ALL_DOMAIN
,
3537 NULL
, false, collector
);
3541 /* Program spaces that are executing startup should have
3542 been filtered out earlier. */
3543 gdb_assert (!SYMTAB_PSPACE (elt
)->executing_startup
);
3544 set_current_program_space (SYMTAB_PSPACE (elt
));
3545 iterate_over_file_blocks (elt
, lookup_name
, STRUCT_DOMAIN
, collector
);
3546 iterate_over_file_blocks (elt
, lookup_name
, VAR_DOMAIN
, collector
);
3550 return collector
.release_symbols ();
3553 /* A std::sort comparison function for symbols. The resulting order does
3554 not actually matter; we just need to be able to sort them so that
3555 symbols with the same program space end up next to each other. */
3558 compare_symbols (const block_symbol
&a
, const block_symbol
&b
)
3562 uia
= (uintptr_t) SYMTAB_PSPACE (symbol_symtab (a
.symbol
));
3563 uib
= (uintptr_t) SYMTAB_PSPACE (symbol_symtab (b
.symbol
));
3570 uia
= (uintptr_t) a
.symbol
;
3571 uib
= (uintptr_t) b
.symbol
;
3579 /* Like compare_symbols but for minimal symbols. */
3582 compare_msymbols (const bound_minimal_symbol
&a
, const bound_minimal_symbol
&b
)
3586 uia
= (uintptr_t) a
.objfile
->pspace
;
3587 uib
= (uintptr_t) a
.objfile
->pspace
;
3594 uia
= (uintptr_t) a
.minsym
;
3595 uib
= (uintptr_t) b
.minsym
;
3603 /* Look for all the matching instances of each symbol in NAMES. Only
3604 instances from PSPACE are considered; other program spaces are
3605 handled by our caller. If PSPACE is NULL, then all program spaces
3606 are considered. Results are stored into INFO. */
3609 add_all_symbol_names_from_pspace (struct collect_info
*info
,
3610 struct program_space
*pspace
,
3611 const std::vector
<const char *> &names
,
3612 enum search_domain search_domain
)
3614 for (const char *iter
: names
)
3615 add_matching_symbols_to_info (iter
,
3616 symbol_name_match_type::FULL
,
3617 search_domain
, info
, pspace
);
3621 find_superclass_methods (std::vector
<struct type
*> &&superclasses
,
3622 const char *name
, enum language name_lang
,
3623 std::vector
<const char *> *result_names
)
3625 size_t old_len
= result_names
->size ();
3629 std::vector
<struct type
*> new_supers
;
3631 for (type
*t
: superclasses
)
3632 find_methods (t
, name_lang
, name
, result_names
, &new_supers
);
3634 if (result_names
->size () != old_len
|| new_supers
.empty ())
3637 superclasses
= std::move (new_supers
);
3641 /* This finds the method METHOD_NAME in the class CLASS_NAME whose type is
3642 given by one of the symbols in SYM_CLASSES. Matches are returned
3643 in SYMBOLS (for debug symbols) and MINSYMS (for minimal symbols). */
3646 find_method (struct linespec_state
*self
, std::vector
<symtab
*> *file_symtabs
,
3647 const char *class_name
, const char *method_name
,
3648 std::vector
<block_symbol
> *sym_classes
,
3649 std::vector
<block_symbol
> *symbols
,
3650 std::vector
<bound_minimal_symbol
> *minsyms
)
3652 size_t last_result_len
;
3653 std::vector
<struct type
*> superclass_vec
;
3654 std::vector
<const char *> result_names
;
3655 struct collect_info info
;
3657 /* Sort symbols so that symbols with the same program space are next
3659 std::sort (sym_classes
->begin (), sym_classes
->end (),
3663 info
.file_symtabs
= file_symtabs
;
3664 info
.result
.symbols
= symbols
;
3665 info
.result
.minimal_symbols
= minsyms
;
3667 /* Iterate over all the types, looking for the names of existing
3668 methods matching METHOD_NAME. If we cannot find a direct method in a
3669 given program space, then we consider inherited methods; this is
3670 not ideal (ideal would be to respect C++ hiding rules), but it
3671 seems good enough and is what GDB has historically done. We only
3672 need to collect the names because later we find all symbols with
3673 those names. This loop is written in a somewhat funny way
3674 because we collect data across the program space before deciding
3676 last_result_len
= 0;
3677 unsigned int ix
= 0;
3678 for (const auto &elt
: *sym_classes
)
3681 struct program_space
*pspace
;
3682 struct symbol
*sym
= elt
.symbol
;
3684 /* Program spaces that are executing startup should have
3685 been filtered out earlier. */
3686 pspace
= SYMTAB_PSPACE (symbol_symtab (sym
));
3687 gdb_assert (!pspace
->executing_startup
);
3688 set_current_program_space (pspace
);
3689 t
= check_typedef (SYMBOL_TYPE (sym
));
3690 find_methods (t
, SYMBOL_LANGUAGE (sym
),
3691 method_name
, &result_names
, &superclass_vec
);
3693 /* Handle all items from a single program space at once; and be
3694 sure not to miss the last batch. */
3695 if (ix
== sym_classes
->size () - 1
3697 != SYMTAB_PSPACE (symbol_symtab (sym_classes
->at (ix
+ 1).symbol
))))
3699 /* If we did not find a direct implementation anywhere in
3700 this program space, consider superclasses. */
3701 if (result_names
.size () == last_result_len
)
3702 find_superclass_methods (std::move (superclass_vec
), method_name
,
3703 SYMBOL_LANGUAGE (sym
), &result_names
);
3705 /* We have a list of candidate symbol names, so now we
3706 iterate over the symbol tables looking for all
3707 matches in this pspace. */
3708 add_all_symbol_names_from_pspace (&info
, pspace
, result_names
,
3711 superclass_vec
.clear ();
3712 last_result_len
= result_names
.size ();
3717 if (!symbols
->empty () || !minsyms
->empty ())
3720 /* Throw an NOT_FOUND_ERROR. This will be caught by the caller
3721 and other attempts to locate the symbol will be made. */
3722 throw_error (NOT_FOUND_ERROR
, _("see caller, this text doesn't matter"));
3729 /* This function object is a callback for iterate_over_symtabs, used
3730 when collecting all matching symtabs. */
3732 class symtab_collector
3737 m_symtab_table
= htab_create (1, htab_hash_pointer
, htab_eq_pointer
,
3741 ~symtab_collector ()
3743 if (m_symtab_table
!= NULL
)
3744 htab_delete (m_symtab_table
);
3747 /* Callable as a symbol_found_callback_ftype callback. */
3748 bool operator () (symtab
*sym
);
3750 /* Return an rvalue reference to the collected symtabs. */
3751 std::vector
<symtab
*> &&release_symtabs ()
3753 return std::move (m_symtabs
);
3757 /* The result vector of symtabs. */
3758 std::vector
<symtab
*> m_symtabs
;
3760 /* This is used to ensure the symtabs are unique. */
3761 htab_t m_symtab_table
;
3765 symtab_collector::operator () (struct symtab
*symtab
)
3769 slot
= htab_find_slot (m_symtab_table
, symtab
, INSERT
);
3773 m_symtabs
.push_back (symtab
);
3781 /* Given a file name, return a list of all matching symtabs. If
3782 SEARCH_PSPACE is not NULL, the search is restricted to just that
3785 static std::vector
<symtab
*>
3786 collect_symtabs_from_filename (const char *file
,
3787 struct program_space
*search_pspace
)
3789 symtab_collector collector
;
3791 /* Find that file's data. */
3792 if (search_pspace
== NULL
)
3794 struct program_space
*pspace
;
3796 ALL_PSPACES (pspace
)
3798 if (pspace
->executing_startup
)
3801 set_current_program_space (pspace
);
3802 iterate_over_symtabs (file
, collector
);
3807 set_current_program_space (search_pspace
);
3808 iterate_over_symtabs (file
, collector
);
3811 return collector
.release_symtabs ();
3814 /* Return all the symtabs associated to the FILENAME. If SEARCH_PSPACE is
3815 not NULL, the search is restricted to just that program space. */
3817 static std::vector
<symtab
*>
3818 symtabs_from_filename (const char *filename
,
3819 struct program_space
*search_pspace
)
3821 std::vector
<symtab
*> result
3822 = collect_symtabs_from_filename (filename
, search_pspace
);
3824 if (result
.empty ())
3826 if (!have_full_symbols () && !have_partial_symbols ())
3827 throw_error (NOT_FOUND_ERROR
,
3828 _("No symbol table is loaded. "
3829 "Use the \"file\" command."));
3830 source_file_not_found_error (filename
);
3839 symbol_searcher::find_all_symbols (const std::string
&name
,
3840 const struct language_defn
*language
,
3841 enum search_domain search_domain
,
3842 std::vector
<symtab
*> *search_symtabs
,
3843 struct program_space
*search_pspace
)
3845 symbol_searcher_collect_info info
;
3846 struct linespec_state state
;
3848 memset (&state
, 0, sizeof (state
));
3849 state
.language
= language
;
3850 info
.state
= &state
;
3852 info
.result
.symbols
= &m_symbols
;
3853 info
.result
.minimal_symbols
= &m_minimal_symbols
;
3854 std::vector
<symtab
*> all_symtabs
;
3855 if (search_symtabs
== nullptr)
3857 all_symtabs
.push_back (nullptr);
3858 search_symtabs
= &all_symtabs
;
3860 info
.file_symtabs
= search_symtabs
;
3862 add_matching_symbols_to_info (name
.c_str (), symbol_name_match_type::WILD
,
3863 search_domain
, &info
, search_pspace
);
3866 /* Look up a function symbol named NAME in symtabs FILE_SYMTABS. Matching
3867 debug symbols are returned in SYMBOLS. Matching minimal symbols are
3868 returned in MINSYMS. */
3871 find_function_symbols (struct linespec_state
*state
,
3872 std::vector
<symtab
*> *file_symtabs
, const char *name
,
3873 symbol_name_match_type name_match_type
,
3874 std::vector
<block_symbol
> *symbols
,
3875 std::vector
<bound_minimal_symbol
> *minsyms
)
3877 struct collect_info info
;
3878 std::vector
<const char *> symbol_names
;
3881 info
.result
.symbols
= symbols
;
3882 info
.result
.minimal_symbols
= minsyms
;
3883 info
.file_symtabs
= file_symtabs
;
3885 /* Try NAME as an Objective-C selector. */
3886 find_imps (name
, &symbol_names
);
3887 if (!symbol_names
.empty ())
3888 add_all_symbol_names_from_pspace (&info
, state
->search_pspace
,
3889 symbol_names
, FUNCTIONS_DOMAIN
);
3891 add_matching_symbols_to_info (name
, name_match_type
, FUNCTIONS_DOMAIN
,
3892 &info
, state
->search_pspace
);
3895 /* Find all symbols named NAME in FILE_SYMTABS, returning debug symbols
3896 in SYMBOLS and minimal symbols in MINSYMS. */
3899 find_linespec_symbols (struct linespec_state
*state
,
3900 std::vector
<symtab
*> *file_symtabs
,
3901 const char *lookup_name
,
3902 symbol_name_match_type name_match_type
,
3903 std::vector
<block_symbol
> *symbols
,
3904 std::vector
<bound_minimal_symbol
> *minsyms
)
3906 std::string canon
= cp_canonicalize_string_no_typedefs (lookup_name
);
3907 if (!canon
.empty ())
3908 lookup_name
= canon
.c_str ();
3910 /* It's important to not call expand_symtabs_matching unnecessarily
3911 as it can really slow things down (by unnecessarily expanding
3912 potentially 1000s of symtabs, which when debugging some apps can
3913 cost 100s of seconds). Avoid this to some extent by *first* calling
3914 find_function_symbols, and only if that doesn't find anything
3915 *then* call find_method. This handles two important cases:
3916 1) break (anonymous namespace)::foo
3917 2) break class::method where method is in class (and not a baseclass) */
3919 find_function_symbols (state
, file_symtabs
, lookup_name
,
3920 name_match_type
, symbols
, minsyms
);
3922 /* If we were unable to locate a symbol of the same name, try dividing
3923 the name into class and method names and searching the class and its
3925 if (symbols
->empty () && minsyms
->empty ())
3927 std::string klass
, method
;
3928 const char *last
, *p
, *scope_op
;
3930 /* See if we can find a scope operator and break this symbol
3931 name into namespaces${SCOPE_OPERATOR}class_name and method_name. */
3933 p
= find_toplevel_string (lookup_name
, scope_op
);
3939 p
= find_toplevel_string (p
+ strlen (scope_op
), scope_op
);
3942 /* If no scope operator was found, there is nothing more we can do;
3943 we already attempted to lookup the entire name as a symbol
3948 /* LOOKUP_NAME points to the class name.
3949 LAST points to the method name. */
3950 klass
= std::string (lookup_name
, last
- lookup_name
);
3952 /* Skip past the scope operator. */
3953 last
+= strlen (scope_op
);
3956 /* Find a list of classes named KLASS. */
3957 std::vector
<block_symbol
> classes
3958 = lookup_prefix_sym (state
, file_symtabs
, klass
.c_str ());
3959 if (!classes
.empty ())
3961 /* Now locate a list of suitable methods named METHOD. */
3964 find_method (state
, file_symtabs
,
3965 klass
.c_str (), method
.c_str (),
3966 &classes
, symbols
, minsyms
);
3969 /* If successful, we're done. If NOT_FOUND_ERROR
3970 was not thrown, rethrow the exception that we did get. */
3971 CATCH (except
, RETURN_MASK_ERROR
)
3973 if (except
.error
!= NOT_FOUND_ERROR
)
3974 throw_exception (except
);
3981 /* Helper for find_label_symbols. Find all labels that match name
3982 NAME in BLOCK. Return all labels that match in FUNCTION_SYMBOLS.
3983 Return the actual function symbol in which the label was found in
3984 LABEL_FUNC_RET. If COMPLETION_MODE is true, then NAME is
3985 interpreted as a label name prefix. Otherwise, only a label named
3986 exactly NAME match. */
3989 find_label_symbols_in_block (const struct block
*block
,
3990 const char *name
, struct symbol
*fn_sym
,
3991 bool completion_mode
,
3992 std::vector
<block_symbol
> *result
,
3993 std::vector
<block_symbol
> *label_funcs_ret
)
3995 if (completion_mode
)
3997 struct block_iterator iter
;
3999 size_t name_len
= strlen (name
);
4001 int (*cmp
) (const char *, const char *, size_t);
4002 cmp
= case_sensitivity
== case_sensitive_on
? strncmp
: strncasecmp
;
4004 ALL_BLOCK_SYMBOLS (block
, iter
, sym
)
4006 if (symbol_matches_domain (SYMBOL_LANGUAGE (sym
),
4007 SYMBOL_DOMAIN (sym
), LABEL_DOMAIN
)
4008 && cmp (SYMBOL_SEARCH_NAME (sym
), name
, name_len
) == 0)
4010 result
->push_back ({sym
, block
});
4011 label_funcs_ret
->push_back ({fn_sym
, block
});
4017 struct block_symbol label_sym
4018 = lookup_symbol (name
, block
, LABEL_DOMAIN
, 0);
4020 if (label_sym
.symbol
!= NULL
)
4022 result
->push_back (label_sym
);
4023 label_funcs_ret
->push_back ({fn_sym
, block
});
4028 /* Return all labels that match name NAME in FUNCTION_SYMBOLS or NULL
4029 if no matches were found.
4031 Return the actual function symbol in which the label was found in
4032 LABEL_FUNC_RET. If COMPLETION_MODE is true, then NAME is
4033 interpreted as a label name prefix. Otherwise, only labels named
4034 exactly NAME match. */
4037 static std::vector
<block_symbol
> *
4038 find_label_symbols (struct linespec_state
*self
,
4039 std::vector
<block_symbol
> *function_symbols
,
4040 std::vector
<block_symbol
> *label_funcs_ret
,
4042 bool completion_mode
)
4044 const struct block
*block
;
4045 struct symbol
*fn_sym
;
4046 std::vector
<block_symbol
> result
;
4048 if (function_symbols
== NULL
)
4050 set_current_program_space (self
->program_space
);
4051 block
= get_current_search_block ();
4054 block
&& !BLOCK_FUNCTION (block
);
4055 block
= BLOCK_SUPERBLOCK (block
))
4059 fn_sym
= BLOCK_FUNCTION (block
);
4061 find_label_symbols_in_block (block
, name
, fn_sym
, completion_mode
,
4062 &result
, label_funcs_ret
);
4066 for (const auto &elt
: *function_symbols
)
4068 fn_sym
= elt
.symbol
;
4069 set_current_program_space (SYMTAB_PSPACE (symbol_symtab (fn_sym
)));
4070 block
= SYMBOL_BLOCK_VALUE (fn_sym
);
4072 find_label_symbols_in_block (block
, name
, fn_sym
, completion_mode
,
4073 &result
, label_funcs_ret
);
4077 if (!result
.empty ())
4078 return new std::vector
<block_symbol
> (std::move (result
));
4084 /* A helper for create_sals_line_offset that handles the 'list_mode' case. */
4086 static std::vector
<symtab_and_line
>
4087 decode_digits_list_mode (struct linespec_state
*self
,
4089 struct symtab_and_line val
)
4091 gdb_assert (self
->list_mode
);
4093 std::vector
<symtab_and_line
> values
;
4095 for (const auto &elt
: *ls
->file_symtabs
)
4097 /* The logic above should ensure this. */
4098 gdb_assert (elt
!= NULL
);
4100 set_current_program_space (SYMTAB_PSPACE (elt
));
4102 /* Simplistic search just for the list command. */
4103 val
.symtab
= find_line_symtab (elt
, val
.line
, NULL
, NULL
);
4104 if (val
.symtab
== NULL
)
4106 val
.pspace
= SYMTAB_PSPACE (elt
);
4108 val
.explicit_line
= 1;
4110 add_sal_to_sals (self
, &values
, &val
, NULL
, 0);
4116 /* A helper for create_sals_line_offset that iterates over the symtabs,
4117 adding lines to the VEC. */
4119 static std::vector
<symtab_and_line
>
4120 decode_digits_ordinary (struct linespec_state
*self
,
4123 struct linetable_entry
**best_entry
)
4125 std::vector
<symtab_and_line
> sals
;
4126 for (const auto &elt
: *ls
->file_symtabs
)
4128 std::vector
<CORE_ADDR
> pcs
;
4130 /* The logic above should ensure this. */
4131 gdb_assert (elt
!= NULL
);
4133 set_current_program_space (SYMTAB_PSPACE (elt
));
4135 pcs
= find_pcs_for_symtab_line (elt
, line
, best_entry
);
4136 for (CORE_ADDR pc
: pcs
)
4138 symtab_and_line sal
;
4139 sal
.pspace
= SYMTAB_PSPACE (elt
);
4143 sals
.push_back (std::move (sal
));
4152 /* Return the line offset represented by VARIABLE. */
4154 static struct line_offset
4155 linespec_parse_variable (struct linespec_state
*self
, const char *variable
)
4159 struct line_offset offset
= {0, LINE_OFFSET_NONE
};
4161 p
= (variable
[1] == '$') ? variable
+ 2 : variable
+ 1;
4164 while (*p
>= '0' && *p
<= '9')
4166 if (!*p
) /* Reached end of token without hitting non-digit. */
4168 /* We have a value history reference. */
4169 struct value
*val_history
;
4171 sscanf ((variable
[1] == '$') ? variable
+ 2 : variable
+ 1, "%d", &index
);
4173 = access_value_history ((variable
[1] == '$') ? -index
: index
);
4174 if (TYPE_CODE (value_type (val_history
)) != TYPE_CODE_INT
)
4175 error (_("History values used in line "
4176 "specs must have integer values."));
4177 offset
.offset
= value_as_long (val_history
);
4181 /* Not all digits -- may be user variable/function or a
4182 convenience variable. */
4184 struct internalvar
*ivar
;
4186 /* Try it as a convenience variable. If it is not a convenience
4187 variable, return and allow normal symbol lookup to occur. */
4188 ivar
= lookup_only_internalvar (variable
+ 1);
4190 /* No internal variable with that name. Mark the offset
4191 as unknown to allow the name to be looked up as a symbol. */
4192 offset
.sign
= LINE_OFFSET_UNKNOWN
;
4195 /* We found a valid variable name. If it is not an integer,
4197 if (!get_internalvar_integer (ivar
, &valx
))
4198 error (_("Convenience variables used in line "
4199 "specs must have integer values."));
4201 offset
.offset
= valx
;
4209 /* We've found a minimal symbol MSYMBOL in OBJFILE to associate with our
4210 linespec; return the SAL in RESULT. This function should return SALs
4211 matching those from find_function_start_sal, otherwise false
4212 multiple-locations breakpoints could be placed. */
4215 minsym_found (struct linespec_state
*self
, struct objfile
*objfile
,
4216 struct minimal_symbol
*msymbol
,
4217 std::vector
<symtab_and_line
> *result
)
4219 bool want_start_sal
;
4221 CORE_ADDR func_addr
;
4222 bool is_function
= msymbol_is_function (objfile
, msymbol
, &func_addr
);
4226 const char *msym_name
= MSYMBOL_LINKAGE_NAME (msymbol
);
4228 if (MSYMBOL_TYPE (msymbol
) == mst_text_gnu_ifunc
4229 || MSYMBOL_TYPE (msymbol
) == mst_data_gnu_ifunc
)
4230 want_start_sal
= gnu_ifunc_resolve_name (msym_name
, &func_addr
);
4232 want_start_sal
= true;
4235 symtab_and_line sal
;
4237 if (is_function
&& want_start_sal
)
4238 sal
= find_function_start_sal (func_addr
, NULL
, self
->funfirstline
);
4241 sal
.objfile
= objfile
;
4242 sal
.msymbol
= msymbol
;
4243 /* Store func_addr, not the minsym's address in case this was an
4244 ifunc that hasn't been resolved yet. */
4248 sal
.pc
= MSYMBOL_VALUE_ADDRESS (objfile
, msymbol
);
4249 sal
.pspace
= current_program_space
;
4252 sal
.section
= MSYMBOL_OBJ_SECTION (objfile
, msymbol
);
4254 if (maybe_add_address (self
->addr_set
, objfile
->pspace
, sal
.pc
))
4255 add_sal_to_sals (self
, result
, &sal
, MSYMBOL_NATURAL_NAME (msymbol
), 0);
4258 /* A helper function to classify a minimal_symbol_type according to
4262 classify_mtype (enum minimal_symbol_type t
)
4269 /* Intermediate priority. */
4272 case mst_solib_trampoline
:
4273 /* Lowest priority. */
4277 /* Highest priority. */
4282 /* Callback for std::sort that sorts symbols by priority. */
4285 compare_msyms (const bound_minimal_symbol
&a
, const bound_minimal_symbol
&b
)
4287 enum minimal_symbol_type ta
= MSYMBOL_TYPE (a
.minsym
);
4288 enum minimal_symbol_type tb
= MSYMBOL_TYPE (b
.minsym
);
4290 return classify_mtype (ta
) < classify_mtype (tb
);
4293 /* Helper for search_minsyms_for_name that adds the symbol to the
4297 add_minsym (struct minimal_symbol
*minsym
, struct objfile
*objfile
,
4298 struct symtab
*symtab
, int list_mode
,
4299 std::vector
<struct bound_minimal_symbol
> *msyms
)
4303 /* We're looking for a label for which we don't have debug
4305 CORE_ADDR func_addr
;
4306 if (msymbol_is_function (objfile
, minsym
, &func_addr
))
4308 symtab_and_line sal
= find_pc_sect_line (func_addr
, NULL
, 0);
4310 if (symtab
!= sal
.symtab
)
4315 /* Exclude data symbols when looking for breakpoint locations. */
4316 if (!list_mode
&& !msymbol_is_function (objfile
, minsym
))
4319 struct bound_minimal_symbol mo
= {minsym
, objfile
};
4320 msyms
->push_back (mo
);
4324 /* Search for minimal symbols called NAME. If SEARCH_PSPACE
4325 is not NULL, the search is restricted to just that program
4328 If SYMTAB is NULL, search all objfiles, otherwise
4329 restrict results to the given SYMTAB. */
4332 search_minsyms_for_name (struct collect_info
*info
,
4333 const lookup_name_info
&name
,
4334 struct program_space
*search_pspace
,
4335 struct symtab
*symtab
)
4337 std::vector
<struct bound_minimal_symbol
> minsyms
;
4341 struct program_space
*pspace
;
4343 ALL_PSPACES (pspace
)
4345 if (search_pspace
!= NULL
&& search_pspace
!= pspace
)
4347 if (pspace
->executing_startup
)
4350 set_current_program_space (pspace
);
4352 for (objfile
*objfile
: current_program_space
->objfiles ())
4354 iterate_over_minimal_symbols (objfile
, name
,
4355 [&] (struct minimal_symbol
*msym
)
4357 add_minsym (msym
, objfile
, nullptr,
4358 info
->state
->list_mode
,
4367 if (search_pspace
== NULL
|| SYMTAB_PSPACE (symtab
) == search_pspace
)
4369 set_current_program_space (SYMTAB_PSPACE (symtab
));
4370 iterate_over_minimal_symbols
4371 (SYMTAB_OBJFILE (symtab
), name
,
4372 [&] (struct minimal_symbol
*msym
)
4374 add_minsym (msym
, SYMTAB_OBJFILE (symtab
), symtab
,
4375 info
->state
->list_mode
, &minsyms
);
4381 if (!minsyms
.empty ())
4385 std::sort (minsyms
.begin (), minsyms
.end (), compare_msyms
);
4387 /* Now the minsyms are in classification order. So, we walk
4388 over them and process just the minsyms with the same
4389 classification as the very first minsym in the list. */
4390 classification
= classify_mtype (MSYMBOL_TYPE (minsyms
[0].minsym
));
4392 for (const bound_minimal_symbol
&item
: minsyms
)
4394 if (classify_mtype (MSYMBOL_TYPE (item
.minsym
)) != classification
)
4397 info
->result
.minimal_symbols
->push_back (item
);
4402 /* A helper function to add all symbols matching NAME to INFO. If
4403 PSPACE is not NULL, the search is restricted to just that program
4407 add_matching_symbols_to_info (const char *name
,
4408 symbol_name_match_type name_match_type
,
4409 enum search_domain search_domain
,
4410 struct collect_info
*info
,
4411 struct program_space
*pspace
)
4413 lookup_name_info
lookup_name (name
, name_match_type
);
4415 for (const auto &elt
: *info
->file_symtabs
)
4419 iterate_over_all_matching_symtabs (info
->state
, lookup_name
,
4420 VAR_DOMAIN
, search_domain
,
4422 [&] (block_symbol
*bsym
)
4423 { return info
->add_symbol (bsym
); });
4424 search_minsyms_for_name (info
, lookup_name
, pspace
, NULL
);
4426 else if (pspace
== NULL
|| pspace
== SYMTAB_PSPACE (elt
))
4428 int prev_len
= info
->result
.symbols
->size ();
4430 /* Program spaces that are executing startup should have
4431 been filtered out earlier. */
4432 gdb_assert (!SYMTAB_PSPACE (elt
)->executing_startup
);
4433 set_current_program_space (SYMTAB_PSPACE (elt
));
4434 iterate_over_file_blocks (elt
, lookup_name
, VAR_DOMAIN
,
4435 [&] (block_symbol
*bsym
)
4436 { return info
->add_symbol (bsym
); });
4438 /* If no new symbols were found in this iteration and this symtab
4439 is in assembler, we might actually be looking for a label for
4440 which we don't have debug info. Check for a minimal symbol in
4442 if (prev_len
== info
->result
.symbols
->size ()
4443 && elt
->language
== language_asm
)
4444 search_minsyms_for_name (info
, lookup_name
, pspace
, elt
);
4451 /* Now come some functions that are called from multiple places within
4455 symbol_to_sal (struct symtab_and_line
*result
,
4456 int funfirstline
, struct symbol
*sym
)
4458 if (SYMBOL_CLASS (sym
) == LOC_BLOCK
)
4460 *result
= find_function_start_sal (sym
, funfirstline
);
4465 if (SYMBOL_CLASS (sym
) == LOC_LABEL
&& SYMBOL_VALUE_ADDRESS (sym
) != 0)
4468 result
->symtab
= symbol_symtab (sym
);
4469 result
->symbol
= sym
;
4470 result
->line
= SYMBOL_LINE (sym
);
4471 result
->pc
= SYMBOL_VALUE_ADDRESS (sym
);
4472 result
->pspace
= SYMTAB_PSPACE (result
->symtab
);
4473 result
->explicit_pc
= 1;
4476 else if (funfirstline
)
4480 else if (SYMBOL_LINE (sym
) != 0)
4482 /* We know its line number. */
4484 result
->symtab
= symbol_symtab (sym
);
4485 result
->symbol
= sym
;
4486 result
->line
= SYMBOL_LINE (sym
);
4487 result
->pc
= SYMBOL_VALUE_ADDRESS (sym
);
4488 result
->pspace
= SYMTAB_PSPACE (result
->symtab
);
4496 linespec_result::~linespec_result ()
4498 for (linespec_sals
&lsal
: lsals
)
4499 xfree (lsal
.canonical
);
4502 /* Return the quote characters permitted by the linespec parser. */
4505 get_gdb_linespec_parser_quote_characters (void)
4507 return linespec_quote_characters
;