1 /* Parser for linespec for the GNU debugger, GDB.
3 Copyright (C) 1986-2020 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
29 #include "completer.h"
31 #include "cp-support.h"
32 #include "parser-defs.h"
34 #include "objc-lang.h"
38 #include "mi/mi-cmds.h"
40 #include "arch-utils.h"
42 #include "cli/cli-utils.h"
43 #include "filenames.h"
47 #include "gdbsupport/function-view.h"
48 #include "gdbsupport/def-vector.h"
51 /* An enumeration of the various things a user might attempt to
52 complete for a linespec location. */
54 enum class linespec_complete_what
56 /* Nothing, no possible completion. */
59 /* A function/method name. Due to ambiguity between
65 this can also indicate a source filename, iff we haven't seen a
66 separate source filename component, as in "b source.c:function". */
69 /* A label symbol. E.g., break file.c:function:LABEL. */
72 /* An expression. E.g., "break foo if EXPR", or "break *EXPR". */
75 /* A linespec keyword ("if"/"thread"/"task").
76 E.g., "break func threa<tab>". */
80 /* An address entry is used to ensure that any given location is only
81 added to the result a single time. It holds an address and the
82 program space from which the address came. */
86 struct program_space
*pspace
;
90 /* A linespec. Elements of this structure are filled in by a parser
91 (either parse_linespec or some other function). The structure is
92 then converted into SALs by convert_linespec_to_sals. */
96 /* An explicit location describing the SaLs. */
97 struct explicit_location explicit_loc
;
99 /* The list of symtabs to search to which to limit the search. May not
100 be NULL. If explicit.SOURCE_FILENAME is NULL (no user-specified
101 filename), FILE_SYMTABS should contain one single NULL member. This
102 will cause the code to use the default symtab. */
103 std::vector
<symtab
*> *file_symtabs
;
105 /* A list of matching function symbols and minimal symbols. Both lists
106 may be NULL (or empty) if no matching symbols were found. */
107 std::vector
<block_symbol
> *function_symbols
;
108 std::vector
<bound_minimal_symbol
> *minimal_symbols
;
110 /* A structure of matching label symbols and the corresponding
111 function symbol in which the label was found. Both may be NULL
112 or both must be non-NULL. */
115 std::vector
<block_symbol
> *label_symbols
;
116 std::vector
<block_symbol
> *function_symbols
;
119 typedef struct linespec
*linespec_p
;
121 /* A canonical linespec represented as a symtab-related string.
123 Each entry represents the "SYMTAB:SUFFIX" linespec string.
124 SYMTAB can be converted for example by symtab_to_fullname or
125 symtab_to_filename_for_display as needed. */
127 struct linespec_canonical_name
129 /* Remaining text part of the linespec string. */
132 /* If NULL then SUFFIX is the whole linespec string. */
133 struct symtab
*symtab
;
136 /* An instance of this is used to keep all state while linespec
137 operates. This instance is passed around as a 'this' pointer to
138 the various implementation methods. */
140 struct linespec_state
142 /* The language in use during linespec processing. */
143 const struct language_defn
*language
;
145 /* The program space as seen when the module was entered. */
146 struct program_space
*program_space
;
148 /* If not NULL, the search is restricted to just this program
150 struct program_space
*search_pspace
;
152 /* The default symtab to use, if no other symtab is specified. */
153 struct symtab
*default_symtab
;
155 /* The default line to use. */
158 /* The 'funfirstline' value that was passed in to decode_line_1 or
162 /* Nonzero if we are running in 'list' mode; see decode_line_list. */
165 /* The 'canonical' value passed to decode_line_full, or NULL. */
166 struct linespec_result
*canonical
;
168 /* Canonical strings that mirror the std::vector<symtab_and_line> result. */
169 struct linespec_canonical_name
*canonical_names
;
171 /* This is a set of address_entry objects which is used to prevent
172 duplicate symbols from being entered into the result. */
175 /* Are we building a linespec? */
179 /* This is a helper object that is used when collecting symbols into a
184 /* The linespec object in use. */
185 struct linespec_state
*state
;
187 /* A list of symtabs to which to restrict matches. */
188 std::vector
<symtab
*> *file_symtabs
;
190 /* The result being accumulated. */
193 std::vector
<block_symbol
> *symbols
;
194 std::vector
<bound_minimal_symbol
> *minimal_symbols
;
197 /* Possibly add a symbol to the results. */
198 virtual bool add_symbol (block_symbol
*bsym
);
202 collect_info::add_symbol (block_symbol
*bsym
)
204 /* In list mode, add all matching symbols, regardless of class.
205 This allows the user to type "list a_global_variable". */
206 if (SYMBOL_CLASS (bsym
->symbol
) == LOC_BLOCK
|| this->state
->list_mode
)
207 this->result
.symbols
->push_back (*bsym
);
209 /* Continue iterating. */
213 /* Custom collect_info for symbol_searcher. */
215 struct symbol_searcher_collect_info
218 bool add_symbol (block_symbol
*bsym
) override
220 /* Add everything. */
221 this->result
.symbols
->push_back (*bsym
);
223 /* Continue iterating. */
235 /* A colon "separator" */
247 /* EOI (end of input) */
253 typedef enum ls_token_type linespec_token_type
;
255 /* List of keywords. This is NULL-terminated so that it can be used
256 as enum completer. */
257 const char * const linespec_keywords
[] = { "if", "thread", "task", NULL
};
258 #define IF_KEYWORD_INDEX 0
260 /* A token of the linespec lexer */
264 /* The type of the token */
265 linespec_token_type type
;
267 /* Data for the token */
270 /* A string, given as a stoken */
271 struct stoken string
;
277 typedef struct ls_token linespec_token
;
279 #define LS_TOKEN_STOKEN(TOK) (TOK).data.string
280 #define LS_TOKEN_KEYWORD(TOK) (TOK).data.keyword
282 /* An instance of the linespec parser. */
284 struct linespec_parser
286 linespec_parser (int flags
, const struct language_defn
*language
,
287 struct program_space
*search_pspace
,
288 struct symtab
*default_symtab
,
290 struct linespec_result
*canonical
);
294 DISABLE_COPY_AND_ASSIGN (linespec_parser
);
296 /* Lexer internal data */
299 /* Save head of input stream. */
300 const char *saved_arg
;
302 /* Head of the input stream. */
304 #define PARSER_STREAM(P) ((P)->lexer.stream)
306 /* The current token. */
307 linespec_token current
;
310 /* Is the entire linespec quote-enclosed? */
311 int is_quote_enclosed
= 0;
313 /* The state of the parse. */
314 struct linespec_state state
{};
315 #define PARSER_STATE(PPTR) (&(PPTR)->state)
317 /* The result of the parse. */
318 struct linespec result
{};
319 #define PARSER_RESULT(PPTR) (&(PPTR)->result)
321 /* What the parser believes the current word point should complete
323 linespec_complete_what complete_what
= linespec_complete_what::NOTHING
;
325 /* The completion word point. The parser advances this as it skips
326 tokens. At some point the input string will end or parsing will
327 fail, and then we attempt completion at the captured completion
328 word point, interpreting the string at completion_word as
330 const char *completion_word
= nullptr;
332 /* If the current token was a quoted string, then this is the
333 quoting character (either " or '). */
334 int completion_quote_char
= 0;
336 /* If the current token was a quoted string, then this points at the
337 end of the quoted string. */
338 const char *completion_quote_end
= nullptr;
340 /* If parsing for completion, then this points at the completion
341 tracker. Otherwise, this is NULL. */
342 struct completion_tracker
*completion_tracker
= nullptr;
345 /* A convenience macro for accessing the explicit location result of
347 #define PARSER_EXPLICIT(PPTR) (&PARSER_RESULT ((PPTR))->explicit_loc)
349 /* Prototypes for local functions. */
351 static void iterate_over_file_blocks
352 (struct symtab
*symtab
, const lookup_name_info
&name
,
354 gdb::function_view
<symbol_found_callback_ftype
> callback
);
356 static void initialize_defaults (struct symtab
**default_symtab
,
359 CORE_ADDR
linespec_expression_to_pc (const char **exp_ptr
);
361 static std::vector
<symtab_and_line
> decode_objc (struct linespec_state
*self
,
365 static std::vector
<symtab
*> symtabs_from_filename
366 (const char *, struct program_space
*pspace
);
368 static std::vector
<block_symbol
> *find_label_symbols
369 (struct linespec_state
*self
, std::vector
<block_symbol
> *function_symbols
,
370 std::vector
<block_symbol
> *label_funcs_ret
, const char *name
,
371 bool completion_mode
= false);
373 static void find_linespec_symbols (struct linespec_state
*self
,
374 std::vector
<symtab
*> *file_symtabs
,
376 symbol_name_match_type name_match_type
,
377 std::vector
<block_symbol
> *symbols
,
378 std::vector
<bound_minimal_symbol
> *minsyms
);
380 static struct line_offset
381 linespec_parse_variable (struct linespec_state
*self
,
382 const char *variable
);
384 static int symbol_to_sal (struct symtab_and_line
*result
,
385 int funfirstline
, struct symbol
*sym
);
387 static void add_matching_symbols_to_info (const char *name
,
388 symbol_name_match_type name_match_type
,
389 enum search_domain search_domain
,
390 struct collect_info
*info
,
391 struct program_space
*pspace
);
393 static void add_all_symbol_names_from_pspace
394 (struct collect_info
*info
, struct program_space
*pspace
,
395 const std::vector
<const char *> &names
, enum search_domain search_domain
);
397 static std::vector
<symtab
*>
398 collect_symtabs_from_filename (const char *file
,
399 struct program_space
*pspace
);
401 static std::vector
<symtab_and_line
> decode_digits_ordinary
402 (struct linespec_state
*self
,
405 linetable_entry
**best_entry
);
407 static std::vector
<symtab_and_line
> decode_digits_list_mode
408 (struct linespec_state
*self
,
410 struct symtab_and_line val
);
412 static void minsym_found (struct linespec_state
*self
, struct objfile
*objfile
,
413 struct minimal_symbol
*msymbol
,
414 std::vector
<symtab_and_line
> *result
);
416 static bool compare_symbols (const block_symbol
&a
, const block_symbol
&b
);
418 static bool compare_msymbols (const bound_minimal_symbol
&a
,
419 const bound_minimal_symbol
&b
);
421 /* Permitted quote characters for the parser. This is different from the
422 completer's quote characters to allow backward compatibility with the
424 static const char *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 make_unique_xstrdup (LS_TOKEN_KEYWORD (token
));
560 str
= LS_TOKEN_STOKEN (token
).ptr
;
561 s
= remove_trailing_whitespace (str
, str
+ LS_TOKEN_STOKEN (token
).length
);
563 return gdb::unique_xmalloc_ptr
<char> (savestring (str
, s
- str
));
566 /* Does P represent the end of a quote-enclosed linespec? */
569 is_closing_quote_enclosed (const char *p
)
571 if (strchr (linespec_quote_characters
, *p
))
573 p
= skip_spaces ((char *) p
);
574 return (*p
== '\0' || linespec_lexer_lex_keyword (p
));
577 /* Find the end of the parameter list that starts with *INPUT.
578 This helper function assists with lexing string segments
579 which might contain valid (non-terminating) commas. */
582 find_parameter_list_end (const char *input
)
584 char end_char
, start_char
;
589 if (start_char
== '(')
591 else if (start_char
== '<')
600 if (*p
== start_char
)
602 else if (*p
== end_char
)
616 /* If the [STRING, STRING_LEN) string ends with what looks like a
617 keyword, return the keyword start offset in STRING. Return -1
621 string_find_incomplete_keyword_at_end (const char * const *keywords
,
622 const char *string
, size_t string_len
)
624 const char *end
= string
+ string_len
;
627 while (p
> string
&& *p
!= ' ')
632 size_t len
= end
- p
;
633 for (size_t i
= 0; keywords
[i
] != NULL
; ++i
)
634 if (strncmp (keywords
[i
], p
, len
) == 0)
641 /* Lex a string from the input in PARSER. */
643 static linespec_token
644 linespec_lexer_lex_string (linespec_parser
*parser
)
646 linespec_token token
;
647 const char *start
= PARSER_STREAM (parser
);
649 token
.type
= LSTOKEN_STRING
;
651 /* If the input stream starts with a quote character, skip to the next
652 quote character, regardless of the content. */
653 if (strchr (linespec_quote_characters
, *PARSER_STREAM (parser
)))
656 char quote_char
= *PARSER_STREAM (parser
);
658 /* Special case: Ada operators. */
659 if (PARSER_STATE (parser
)->language
->la_language
== language_ada
660 && quote_char
== '\"')
662 int len
= is_ada_operator (PARSER_STREAM (parser
));
666 /* The input is an Ada operator. Return the quoted string
668 LS_TOKEN_STOKEN (token
).ptr
= PARSER_STREAM (parser
);
669 LS_TOKEN_STOKEN (token
).length
= len
;
670 PARSER_STREAM (parser
) += len
;
674 /* The input does not represent an Ada operator -- fall through
675 to normal quoted string handling. */
678 /* Skip past the beginning quote. */
679 ++(PARSER_STREAM (parser
));
681 /* Mark the start of the string. */
682 LS_TOKEN_STOKEN (token
).ptr
= PARSER_STREAM (parser
);
684 /* Skip to the ending quote. */
685 end
= skip_quote_char (PARSER_STREAM (parser
), quote_char
);
687 /* This helps the completer mode decide whether we have a
689 parser
->completion_quote_char
= quote_char
;
690 parser
->completion_quote_end
= end
;
692 /* Error if the input did not terminate properly, unless in
696 if (parser
->completion_tracker
== NULL
)
697 error (_("unmatched quote"));
699 /* In completion mode, we'll try to complete the incomplete
701 token
.type
= LSTOKEN_STRING
;
702 while (*PARSER_STREAM (parser
) != '\0')
703 PARSER_STREAM (parser
)++;
704 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - 1 - start
;
708 /* Skip over the ending quote and mark the length of the string. */
709 PARSER_STREAM (parser
) = (char *) ++end
;
710 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - 2 - start
;
717 /* Otherwise, only identifier characters are permitted.
718 Spaces are the exception. In general, we keep spaces,
719 but only if the next characters in the input do not resolve
720 to one of the keywords.
722 This allows users to forgo quoting CV-qualifiers, template arguments,
723 and similar common language constructs. */
727 if (isspace (*PARSER_STREAM (parser
)))
729 p
= skip_spaces (PARSER_STREAM (parser
));
730 /* When we get here we know we've found something followed by
731 a space (we skip over parens and templates below).
732 So if we find a keyword now, we know it is a keyword and not,
733 say, a function name. */
734 if (linespec_lexer_lex_keyword (p
) != NULL
)
736 LS_TOKEN_STOKEN (token
).ptr
= start
;
737 LS_TOKEN_STOKEN (token
).length
738 = PARSER_STREAM (parser
) - start
;
742 /* Advance past the whitespace. */
743 PARSER_STREAM (parser
) = p
;
746 /* If the next character is EOI or (single) ':', the
747 string is complete; return the token. */
748 if (*PARSER_STREAM (parser
) == 0)
750 LS_TOKEN_STOKEN (token
).ptr
= start
;
751 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - start
;
754 else if (PARSER_STREAM (parser
)[0] == ':')
756 /* Do not tokenize the C++ scope operator. */
757 if (PARSER_STREAM (parser
)[1] == ':')
758 ++(PARSER_STREAM (parser
));
760 /* Do not tokenize ABI tags such as "[abi:cxx11]". */
761 else if (PARSER_STREAM (parser
) - start
> 4
762 && startswith (PARSER_STREAM (parser
) - 4, "[abi"))
767 /* Do not tokenify if the input length so far is one
768 (i.e, a single-letter drive name) and the next character
769 is a directory separator. This allows Windows-style
770 paths to be recognized as filenames without quoting it. */
771 else if ((PARSER_STREAM (parser
) - start
) != 1
772 || !IS_DIR_SEPARATOR (PARSER_STREAM (parser
)[1]))
774 LS_TOKEN_STOKEN (token
).ptr
= start
;
775 LS_TOKEN_STOKEN (token
).length
776 = PARSER_STREAM (parser
) - start
;
780 /* Special case: permit quote-enclosed linespecs. */
781 else if (parser
->is_quote_enclosed
782 && strchr (linespec_quote_characters
,
783 *PARSER_STREAM (parser
))
784 && is_closing_quote_enclosed (PARSER_STREAM (parser
)))
786 LS_TOKEN_STOKEN (token
).ptr
= start
;
787 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - start
;
790 /* Because commas may terminate a linespec and appear in
791 the middle of valid string input, special cases for
792 '<' and '(' are necessary. */
793 else if (*PARSER_STREAM (parser
) == '<'
794 || *PARSER_STREAM (parser
) == '(')
796 /* Don't interpret 'operator<' / 'operator<<' as a
797 template parameter list though. */
798 if (*PARSER_STREAM (parser
) == '<'
799 && (PARSER_STATE (parser
)->language
->la_language
801 && (PARSER_STREAM (parser
) - start
) >= CP_OPERATOR_LEN
)
803 const char *op
= PARSER_STREAM (parser
);
805 while (op
> start
&& isspace (op
[-1]))
807 if (op
- start
>= CP_OPERATOR_LEN
)
809 op
-= CP_OPERATOR_LEN
;
810 if (strncmp (op
, CP_OPERATOR_STR
, CP_OPERATOR_LEN
) == 0
812 || !(isalnum (op
[-1]) || op
[-1] == '_')))
814 /* This is an operator name. Keep going. */
815 ++(PARSER_STREAM (parser
));
816 if (*PARSER_STREAM (parser
) == '<')
817 ++(PARSER_STREAM (parser
));
823 const char *end
= find_parameter_list_end (PARSER_STREAM (parser
));
824 PARSER_STREAM (parser
) = end
;
826 /* Don't loop around to the normal \0 case above because
827 we don't want to misinterpret a potential keyword at
828 the end of the token when the string isn't
829 "()<>"-balanced. This handles "b
830 function(thread<tab>" in completion mode. */
833 LS_TOKEN_STOKEN (token
).ptr
= start
;
834 LS_TOKEN_STOKEN (token
).length
835 = PARSER_STREAM (parser
) - start
;
841 /* Commas are terminators, but not if they are part of an
843 else if (*PARSER_STREAM (parser
) == ',')
845 if ((PARSER_STATE (parser
)->language
->la_language
847 && (PARSER_STREAM (parser
) - start
) > CP_OPERATOR_LEN
)
849 const char *op
= strstr (start
, CP_OPERATOR_STR
);
851 if (op
!= NULL
&& is_operator_name (op
))
853 /* This is an operator name. Keep going. */
854 ++(PARSER_STREAM (parser
));
859 /* Comma terminates the string. */
860 LS_TOKEN_STOKEN (token
).ptr
= start
;
861 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - start
;
865 /* Advance the stream. */
866 gdb_assert (*(PARSER_STREAM (parser
)) != '\0');
867 ++(PARSER_STREAM (parser
));
874 /* Lex a single linespec token from PARSER. */
876 static linespec_token
877 linespec_lexer_lex_one (linespec_parser
*parser
)
881 if (parser
->lexer
.current
.type
== LSTOKEN_CONSUMED
)
883 /* Skip any whitespace. */
884 PARSER_STREAM (parser
) = skip_spaces (PARSER_STREAM (parser
));
886 /* Check for a keyword, they end the linespec. */
887 keyword
= linespec_lexer_lex_keyword (PARSER_STREAM (parser
));
890 parser
->lexer
.current
.type
= LSTOKEN_KEYWORD
;
891 LS_TOKEN_KEYWORD (parser
->lexer
.current
) = keyword
;
892 /* We do not advance the stream here intentionally:
893 we would like lexing to stop when a keyword is seen.
895 PARSER_STREAM (parser) += strlen (keyword); */
897 return parser
->lexer
.current
;
900 /* Handle other tokens. */
901 switch (*PARSER_STREAM (parser
))
904 parser
->lexer
.current
.type
= LSTOKEN_EOI
;
908 case '0': case '1': case '2': case '3': case '4':
909 case '5': case '6': case '7': case '8': case '9':
910 if (!linespec_lexer_lex_number (parser
, &(parser
->lexer
.current
)))
911 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
915 /* If we have a scope operator, lex the input as a string.
916 Otherwise, return LSTOKEN_COLON. */
917 if (PARSER_STREAM (parser
)[1] == ':')
918 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
921 parser
->lexer
.current
.type
= LSTOKEN_COLON
;
922 ++(PARSER_STREAM (parser
));
926 case '\'': case '\"':
927 /* Special case: permit quote-enclosed linespecs. */
928 if (parser
->is_quote_enclosed
929 && is_closing_quote_enclosed (PARSER_STREAM (parser
)))
931 ++(PARSER_STREAM (parser
));
932 parser
->lexer
.current
.type
= LSTOKEN_EOI
;
935 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
939 parser
->lexer
.current
.type
= LSTOKEN_COMMA
;
940 LS_TOKEN_STOKEN (parser
->lexer
.current
).ptr
941 = PARSER_STREAM (parser
);
942 LS_TOKEN_STOKEN (parser
->lexer
.current
).length
= 1;
943 ++(PARSER_STREAM (parser
));
947 /* If the input is not a number, it must be a string.
948 [Keywords were already considered above.] */
949 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
954 return parser
->lexer
.current
;
957 /* Consume the current token and return the next token in PARSER's
958 input stream. Also advance the completion word for completion
961 static linespec_token
962 linespec_lexer_consume_token (linespec_parser
*parser
)
964 gdb_assert (parser
->lexer
.current
.type
!= LSTOKEN_EOI
);
966 bool advance_word
= (parser
->lexer
.current
.type
!= LSTOKEN_STRING
967 || *PARSER_STREAM (parser
) != '\0');
969 /* If we're moving past a string to some other token, it must be the
970 quote was terminated. */
971 if (parser
->completion_quote_char
)
973 gdb_assert (parser
->lexer
.current
.type
== LSTOKEN_STRING
);
975 /* If the string was the last (non-EOI) token, we're past the
976 quote, but remember that for later. */
977 if (*PARSER_STREAM (parser
) != '\0')
979 parser
->completion_quote_char
= '\0';
980 parser
->completion_quote_end
= NULL
;;
984 parser
->lexer
.current
.type
= LSTOKEN_CONSUMED
;
985 linespec_lexer_lex_one (parser
);
987 if (parser
->lexer
.current
.type
== LSTOKEN_STRING
)
989 /* Advance the completion word past a potential initial
991 parser
->completion_word
= LS_TOKEN_STOKEN (parser
->lexer
.current
).ptr
;
993 else if (advance_word
)
995 /* Advance the completion word past any whitespace. */
996 parser
->completion_word
= PARSER_STREAM (parser
);
999 return parser
->lexer
.current
;
1002 /* Return the next token without consuming the current token. */
1004 static linespec_token
1005 linespec_lexer_peek_token (linespec_parser
*parser
)
1007 linespec_token next
;
1008 const char *saved_stream
= PARSER_STREAM (parser
);
1009 linespec_token saved_token
= parser
->lexer
.current
;
1010 int saved_completion_quote_char
= parser
->completion_quote_char
;
1011 const char *saved_completion_quote_end
= parser
->completion_quote_end
;
1012 const char *saved_completion_word
= parser
->completion_word
;
1014 next
= linespec_lexer_consume_token (parser
);
1015 PARSER_STREAM (parser
) = saved_stream
;
1016 parser
->lexer
.current
= saved_token
;
1017 parser
->completion_quote_char
= saved_completion_quote_char
;
1018 parser
->completion_quote_end
= saved_completion_quote_end
;
1019 parser
->completion_word
= saved_completion_word
;
1023 /* Helper functions. */
1025 /* Add SAL to SALS, and also update SELF->CANONICAL_NAMES to reflect
1026 the new sal, if needed. If not NULL, SYMNAME is the name of the
1027 symbol to use when constructing the new canonical name.
1029 If LITERAL_CANONICAL is non-zero, SYMNAME will be used as the
1030 canonical name for the SAL. */
1033 add_sal_to_sals (struct linespec_state
*self
,
1034 std::vector
<symtab_and_line
> *sals
,
1035 struct symtab_and_line
*sal
,
1036 const char *symname
, int literal_canonical
)
1038 sals
->push_back (*sal
);
1040 if (self
->canonical
)
1042 struct linespec_canonical_name
*canonical
;
1044 self
->canonical_names
= XRESIZEVEC (struct linespec_canonical_name
,
1045 self
->canonical_names
,
1047 canonical
= &self
->canonical_names
[sals
->size () - 1];
1048 if (!literal_canonical
&& sal
->symtab
)
1050 symtab_to_fullname (sal
->symtab
);
1052 /* Note that the filter doesn't have to be a valid linespec
1053 input. We only apply the ":LINE" treatment to Ada for
1055 if (symname
!= NULL
&& sal
->line
!= 0
1056 && self
->language
->la_language
== language_ada
)
1057 canonical
->suffix
= xstrprintf ("%s:%d", symname
, sal
->line
);
1058 else if (symname
!= NULL
)
1059 canonical
->suffix
= xstrdup (symname
);
1061 canonical
->suffix
= xstrprintf ("%d", sal
->line
);
1062 canonical
->symtab
= sal
->symtab
;
1066 if (symname
!= NULL
)
1067 canonical
->suffix
= xstrdup (symname
);
1069 canonical
->suffix
= xstrdup ("<unknown>");
1070 canonical
->symtab
= NULL
;
1075 /* A hash function for address_entry. */
1078 hash_address_entry (const void *p
)
1080 const struct address_entry
*aep
= (const struct address_entry
*) p
;
1083 hash
= iterative_hash_object (aep
->pspace
, 0);
1084 return iterative_hash_object (aep
->addr
, hash
);
1087 /* An equality function for address_entry. */
1090 eq_address_entry (const void *a
, const void *b
)
1092 const struct address_entry
*aea
= (const struct address_entry
*) a
;
1093 const struct address_entry
*aeb
= (const struct address_entry
*) b
;
1095 return aea
->pspace
== aeb
->pspace
&& aea
->addr
== aeb
->addr
;
1098 /* Check whether the address, represented by PSPACE and ADDR, is
1099 already in the set. If so, return 0. Otherwise, add it and return
1103 maybe_add_address (htab_t set
, struct program_space
*pspace
, CORE_ADDR addr
)
1105 struct address_entry e
, *p
;
1110 slot
= htab_find_slot (set
, &e
, INSERT
);
1114 p
= XNEW (struct address_entry
);
1115 memcpy (p
, &e
, sizeof (struct address_entry
));
1121 /* A helper that walks over all matching symtabs in all objfiles and
1122 calls CALLBACK for each symbol matching NAME. If SEARCH_PSPACE is
1123 not NULL, then the search is restricted to just that program
1124 space. If INCLUDE_INLINE is true then symbols representing
1125 inlined instances of functions will be included in the result. */
1128 iterate_over_all_matching_symtabs
1129 (struct linespec_state
*state
,
1130 const lookup_name_info
&lookup_name
,
1131 const domain_enum name_domain
,
1132 enum search_domain search_domain
,
1133 struct program_space
*search_pspace
, bool include_inline
,
1134 gdb::function_view
<symbol_found_callback_ftype
> callback
)
1136 struct program_space
*pspace
;
1138 ALL_PSPACES (pspace
)
1140 if (search_pspace
!= NULL
&& search_pspace
!= pspace
)
1142 if (pspace
->executing_startup
)
1145 set_current_program_space (pspace
);
1147 for (objfile
*objfile
: current_program_space
->objfiles ())
1150 objfile
->sf
->qf
->expand_symtabs_matching (objfile
,
1156 for (compunit_symtab
*cu
: objfile
->compunits ())
1158 struct symtab
*symtab
= COMPUNIT_FILETABS (cu
);
1160 iterate_over_file_blocks (symtab
, lookup_name
, name_domain
,
1165 const struct block
*block
;
1168 for (i
= FIRST_LOCAL_BLOCK
;
1169 i
< BLOCKVECTOR_NBLOCKS (SYMTAB_BLOCKVECTOR (symtab
));
1172 block
= BLOCKVECTOR_BLOCK (SYMTAB_BLOCKVECTOR (symtab
), i
);
1173 state
->language
->la_iterate_over_symbols
1174 (block
, lookup_name
, name_domain
,
1175 [&] (block_symbol
*bsym
)
1177 /* Restrict calls to CALLBACK to symbols
1178 representing inline symbols only. */
1179 if (SYMBOL_INLINED (bsym
->symbol
))
1180 return callback (bsym
);
1190 /* Returns the block to be used for symbol searches from
1191 the current location. */
1193 static const struct block
*
1194 get_current_search_block (void)
1196 /* get_selected_block can change the current language when there is
1197 no selected frame yet. */
1198 scoped_restore_current_language save_language
;
1199 return get_selected_block (0);
1202 /* Iterate over static and global blocks. */
1205 iterate_over_file_blocks
1206 (struct symtab
*symtab
, const lookup_name_info
&name
,
1207 domain_enum domain
, gdb::function_view
<symbol_found_callback_ftype
> callback
)
1209 const struct block
*block
;
1211 for (block
= BLOCKVECTOR_BLOCK (SYMTAB_BLOCKVECTOR (symtab
), STATIC_BLOCK
);
1213 block
= BLOCK_SUPERBLOCK (block
))
1214 LA_ITERATE_OVER_SYMBOLS (block
, name
, domain
, callback
);
1217 /* A helper for find_method. This finds all methods in type T of
1218 language T_LANG which match NAME. It adds matching symbol names to
1219 RESULT_NAMES, and adds T's direct superclasses to SUPERCLASSES. */
1222 find_methods (struct type
*t
, enum language t_lang
, const char *name
,
1223 std::vector
<const char *> *result_names
,
1224 std::vector
<struct type
*> *superclasses
)
1227 const char *class_name
= TYPE_NAME (t
);
1229 /* Ignore this class if it doesn't have a name. This is ugly, but
1230 unless we figure out how to get the physname without the name of
1231 the class, then the loop can't do any good. */
1235 lookup_name_info
lookup_name (name
, symbol_name_match_type::FULL
);
1236 symbol_name_matcher_ftype
*symbol_name_compare
1237 = get_symbol_name_matcher (language_def (t_lang
), lookup_name
);
1239 t
= check_typedef (t
);
1241 /* Loop over each method name. At this level, all overloads of a name
1242 are counted as a single name. There is an inner loop which loops over
1245 for (method_counter
= TYPE_NFN_FIELDS (t
) - 1;
1246 method_counter
>= 0;
1249 const char *method_name
= TYPE_FN_FIELDLIST_NAME (t
, method_counter
);
1251 if (symbol_name_compare (method_name
, lookup_name
, NULL
))
1255 for (field_counter
= (TYPE_FN_FIELDLIST_LENGTH (t
, method_counter
)
1261 const char *phys_name
;
1263 f
= TYPE_FN_FIELDLIST1 (t
, method_counter
);
1264 if (TYPE_FN_FIELD_STUB (f
, field_counter
))
1266 phys_name
= TYPE_FN_FIELD_PHYSNAME (f
, field_counter
);
1267 result_names
->push_back (phys_name
);
1273 for (ibase
= 0; ibase
< TYPE_N_BASECLASSES (t
); ibase
++)
1274 superclasses
->push_back (TYPE_BASECLASS (t
, ibase
));
1277 /* Find an instance of the character C in the string S that is outside
1278 of all parenthesis pairs, single-quoted strings, and double-quoted
1279 strings. Also, ignore the char within a template name, like a ','
1280 within foo<int, int>, while considering C++ operator</operator<<. */
1283 find_toplevel_char (const char *s
, char c
)
1285 int quoted
= 0; /* zero if we're not in quotes;
1286 '"' if we're in a double-quoted string;
1287 '\'' if we're in a single-quoted string. */
1288 int depth
= 0; /* Number of unclosed parens we've seen. */
1291 for (scan
= s
; *scan
; scan
++)
1295 if (*scan
== quoted
)
1297 else if (*scan
== '\\' && *(scan
+ 1))
1300 else if (*scan
== c
&& ! quoted
&& depth
== 0)
1302 else if (*scan
== '"' || *scan
== '\'')
1304 else if (*scan
== '(' || *scan
== '<')
1306 else if ((*scan
== ')' || *scan
== '>') && depth
> 0)
1308 else if (*scan
== 'o' && !quoted
&& depth
== 0)
1310 /* Handle C++ operator names. */
1311 if (strncmp (scan
, CP_OPERATOR_STR
, CP_OPERATOR_LEN
) == 0)
1313 scan
+= CP_OPERATOR_LEN
;
1316 while (isspace (*scan
))
1327 /* Skip over one less than the appropriate number of
1328 characters: the for loop will skip over the last
1354 /* The string equivalent of find_toplevel_char. Returns a pointer
1355 to the location of NEEDLE in HAYSTACK, ignoring any occurrences
1356 inside "()" and "<>". Returns NULL if NEEDLE was not found. */
1359 find_toplevel_string (const char *haystack
, const char *needle
)
1361 const char *s
= haystack
;
1365 s
= find_toplevel_char (s
, *needle
);
1369 /* Found first char in HAYSTACK; check rest of string. */
1370 if (startswith (s
, needle
))
1373 /* Didn't find it; loop over HAYSTACK, looking for the next
1374 instance of the first character of NEEDLE. */
1378 while (s
!= NULL
&& *s
!= '\0');
1380 /* NEEDLE was not found in HAYSTACK. */
1384 /* Convert CANONICAL to its string representation using
1385 symtab_to_fullname for SYMTAB. */
1388 canonical_to_fullform (const struct linespec_canonical_name
*canonical
)
1390 if (canonical
->symtab
== NULL
)
1391 return canonical
->suffix
;
1393 return string_printf ("%s:%s", symtab_to_fullname (canonical
->symtab
),
1397 /* Given FILTERS, a list of canonical names, filter the sals in RESULT
1398 and store the result in SELF->CANONICAL. */
1401 filter_results (struct linespec_state
*self
,
1402 std::vector
<symtab_and_line
> *result
,
1403 const std::vector
<const char *> &filters
)
1405 for (const char *name
: filters
)
1409 for (size_t j
= 0; j
< result
->size (); ++j
)
1411 const struct linespec_canonical_name
*canonical
;
1413 canonical
= &self
->canonical_names
[j
];
1414 std::string fullform
= canonical_to_fullform (canonical
);
1416 if (name
== fullform
)
1417 lsal
.sals
.push_back ((*result
)[j
]);
1420 if (!lsal
.sals
.empty ())
1422 lsal
.canonical
= xstrdup (name
);
1423 self
->canonical
->lsals
.push_back (std::move (lsal
));
1427 self
->canonical
->pre_expanded
= 0;
1430 /* Store RESULT into SELF->CANONICAL. */
1433 convert_results_to_lsals (struct linespec_state
*self
,
1434 std::vector
<symtab_and_line
> *result
)
1436 struct linespec_sals lsal
;
1438 lsal
.canonical
= NULL
;
1439 lsal
.sals
= std::move (*result
);
1440 self
->canonical
->lsals
.push_back (std::move (lsal
));
1443 /* A structure that contains two string representations of a struct
1444 linespec_canonical_name:
1445 - one where the symtab's fullname is used;
1446 - one where the filename followed the "set filename-display"
1449 struct decode_line_2_item
1451 decode_line_2_item (std::string
&&fullform_
, std::string
&&displayform_
,
1453 : fullform (std::move (fullform_
)),
1454 displayform (std::move (displayform_
)),
1455 selected (selected_
)
1459 /* The form using symtab_to_fullname. */
1460 std::string fullform
;
1462 /* The form using symtab_to_filename_for_display. */
1463 std::string displayform
;
1465 /* Field is initialized to zero and it is set to one if the user
1466 requested breakpoint for this entry. */
1467 unsigned int selected
: 1;
1470 /* Helper for std::sort to sort decode_line_2_item entries by
1471 DISPLAYFORM and secondarily by FULLFORM. */
1474 decode_line_2_compare_items (const decode_line_2_item
&a
,
1475 const decode_line_2_item
&b
)
1477 if (a
.displayform
!= b
.displayform
)
1478 return a
.displayform
< b
.displayform
;
1479 return a
.fullform
< b
.fullform
;
1482 /* Handle multiple results in RESULT depending on SELECT_MODE. This
1483 will either return normally, throw an exception on multiple
1484 results, or present a menu to the user. On return, the SALS vector
1485 in SELF->CANONICAL is set up properly. */
1488 decode_line_2 (struct linespec_state
*self
,
1489 std::vector
<symtab_and_line
> *result
,
1490 const char *select_mode
)
1495 std::vector
<const char *> filters
;
1496 std::vector
<struct decode_line_2_item
> items
;
1498 gdb_assert (select_mode
!= multiple_symbols_all
);
1499 gdb_assert (self
->canonical
!= NULL
);
1500 gdb_assert (!result
->empty ());
1502 /* Prepare ITEMS array. */
1503 for (i
= 0; i
< result
->size (); ++i
)
1505 const struct linespec_canonical_name
*canonical
;
1506 std::string displayform
;
1508 canonical
= &self
->canonical_names
[i
];
1509 gdb_assert (canonical
->suffix
!= NULL
);
1511 std::string fullform
= canonical_to_fullform (canonical
);
1513 if (canonical
->symtab
== NULL
)
1514 displayform
= canonical
->suffix
;
1517 const char *fn_for_display
;
1519 fn_for_display
= symtab_to_filename_for_display (canonical
->symtab
);
1520 displayform
= string_printf ("%s:%s", fn_for_display
,
1524 items
.emplace_back (std::move (fullform
), std::move (displayform
),
1528 /* Sort the list of method names. */
1529 std::sort (items
.begin (), items
.end (), decode_line_2_compare_items
);
1531 /* Remove entries with the same FULLFORM. */
1532 items
.erase (std::unique (items
.begin (), items
.end (),
1533 [] (const struct decode_line_2_item
&a
,
1534 const struct decode_line_2_item
&b
)
1536 return a
.fullform
== b
.fullform
;
1540 if (select_mode
== multiple_symbols_cancel
&& items
.size () > 1)
1541 error (_("canceled because the command is ambiguous\n"
1542 "See set/show multiple-symbol."));
1544 if (select_mode
== multiple_symbols_all
|| items
.size () == 1)
1546 convert_results_to_lsals (self
, result
);
1550 printf_unfiltered (_("[0] cancel\n[1] all\n"));
1551 for (i
= 0; i
< items
.size (); i
++)
1552 printf_unfiltered ("[%d] %s\n", i
+ 2, items
[i
].displayform
.c_str ());
1554 prompt
= getenv ("PS2");
1559 args
= command_line_input (prompt
, "overload-choice");
1561 if (args
== 0 || *args
== 0)
1562 error_no_arg (_("one or more choice numbers"));
1564 number_or_range_parser
parser (args
);
1565 while (!parser
.finished ())
1567 int num
= parser
.get_number ();
1570 error (_("canceled"));
1573 /* We intentionally make this result in a single breakpoint,
1574 contrary to what older versions of gdb did. The
1575 rationale is that this lets a user get the
1576 multiple_symbols_all behavior even with the 'ask'
1577 setting; and he can get separate breakpoints by entering
1578 "2-57" at the query. */
1579 convert_results_to_lsals (self
, result
);
1584 if (num
>= items
.size ())
1585 printf_unfiltered (_("No choice number %d.\n"), num
);
1588 struct decode_line_2_item
*item
= &items
[num
];
1590 if (!item
->selected
)
1592 filters
.push_back (item
->fullform
.c_str ());
1597 printf_unfiltered (_("duplicate request for %d ignored.\n"),
1603 filter_results (self
, result
, filters
);
1608 /* The parser of linespec itself. */
1610 /* Throw an appropriate error when SYMBOL is not found (optionally in
1613 static void ATTRIBUTE_NORETURN
1614 symbol_not_found_error (const char *symbol
, const char *filename
)
1619 if (!have_full_symbols ()
1620 && !have_partial_symbols ()
1621 && !have_minimal_symbols ())
1622 throw_error (NOT_FOUND_ERROR
,
1623 _("No symbol table is loaded. Use the \"file\" command."));
1625 /* If SYMBOL starts with '$', the user attempted to either lookup
1626 a function/variable in his code starting with '$' or an internal
1627 variable of that name. Since we do not know which, be concise and
1628 explain both possibilities. */
1632 throw_error (NOT_FOUND_ERROR
,
1633 _("Undefined convenience variable or function \"%s\" "
1634 "not defined in \"%s\"."), symbol
, filename
);
1636 throw_error (NOT_FOUND_ERROR
,
1637 _("Undefined convenience variable or function \"%s\" "
1638 "not defined."), symbol
);
1643 throw_error (NOT_FOUND_ERROR
,
1644 _("Function \"%s\" not defined in \"%s\"."),
1647 throw_error (NOT_FOUND_ERROR
,
1648 _("Function \"%s\" not defined."), symbol
);
1652 /* Throw an appropriate error when an unexpected token is encountered
1655 static void ATTRIBUTE_NORETURN
1656 unexpected_linespec_error (linespec_parser
*parser
)
1658 linespec_token token
;
1659 static const char * token_type_strings
[]
1660 = {"keyword", "colon", "string", "number", "comma", "end of input"};
1662 /* Get the token that generated the error. */
1663 token
= linespec_lexer_lex_one (parser
);
1665 /* Finally, throw the error. */
1666 if (token
.type
== LSTOKEN_STRING
|| token
.type
== LSTOKEN_NUMBER
1667 || token
.type
== LSTOKEN_KEYWORD
)
1669 gdb::unique_xmalloc_ptr
<char> string
= copy_token_string (token
);
1670 throw_error (GENERIC_ERROR
,
1671 _("malformed linespec error: unexpected %s, \"%s\""),
1672 token_type_strings
[token
.type
], string
.get ());
1675 throw_error (GENERIC_ERROR
,
1676 _("malformed linespec error: unexpected %s"),
1677 token_type_strings
[token
.type
]);
1680 /* Throw an undefined label error. */
1682 static void ATTRIBUTE_NORETURN
1683 undefined_label_error (const char *function
, const char *label
)
1685 if (function
!= NULL
)
1686 throw_error (NOT_FOUND_ERROR
,
1687 _("No label \"%s\" defined in function \"%s\"."),
1690 throw_error (NOT_FOUND_ERROR
,
1691 _("No label \"%s\" defined in current function."),
1695 /* Throw a source file not found error. */
1697 static void ATTRIBUTE_NORETURN
1698 source_file_not_found_error (const char *name
)
1700 throw_error (NOT_FOUND_ERROR
, _("No source file named %s."), name
);
1703 /* Unless at EIO, save the current stream position as completion word
1704 point, and consume the next token. */
1706 static linespec_token
1707 save_stream_and_consume_token (linespec_parser
*parser
)
1709 if (linespec_lexer_peek_token (parser
).type
!= LSTOKEN_EOI
)
1710 parser
->completion_word
= PARSER_STREAM (parser
);
1711 return linespec_lexer_consume_token (parser
);
1714 /* See description in linespec.h. */
1717 linespec_parse_line_offset (const char *string
)
1719 const char *start
= string
;
1720 struct line_offset line_offset
= {0, LINE_OFFSET_NONE
};
1724 line_offset
.sign
= LINE_OFFSET_PLUS
;
1727 else if (*string
== '-')
1729 line_offset
.sign
= LINE_OFFSET_MINUS
;
1733 if (*string
!= '\0' && !isdigit (*string
))
1734 error (_("malformed line offset: \"%s\""), start
);
1736 /* Right now, we only allow base 10 for offsets. */
1737 line_offset
.offset
= atoi (string
);
1741 /* In completion mode, if the user is still typing the number, there's
1742 no possible completion to offer. But if there's already input past
1743 the number, setup to expect NEXT. */
1746 set_completion_after_number (linespec_parser
*parser
,
1747 linespec_complete_what next
)
1749 if (*PARSER_STREAM (parser
) == ' ')
1751 parser
->completion_word
= skip_spaces (PARSER_STREAM (parser
) + 1);
1752 parser
->complete_what
= next
;
1756 parser
->completion_word
= PARSER_STREAM (parser
);
1757 parser
->complete_what
= linespec_complete_what::NOTHING
;
1761 /* Parse the basic_spec in PARSER's input. */
1764 linespec_parse_basic (linespec_parser
*parser
)
1766 gdb::unique_xmalloc_ptr
<char> name
;
1767 linespec_token token
;
1768 std::vector
<block_symbol
> symbols
;
1769 std::vector
<block_symbol
> *labels
;
1770 std::vector
<bound_minimal_symbol
> minimal_symbols
;
1772 /* Get the next token. */
1773 token
= linespec_lexer_lex_one (parser
);
1775 /* If it is EOI or KEYWORD, issue an error. */
1776 if (token
.type
== LSTOKEN_KEYWORD
)
1778 parser
->complete_what
= linespec_complete_what::NOTHING
;
1779 unexpected_linespec_error (parser
);
1781 else if (token
.type
== LSTOKEN_EOI
)
1783 unexpected_linespec_error (parser
);
1785 /* If it is a LSTOKEN_NUMBER, we have an offset. */
1786 else if (token
.type
== LSTOKEN_NUMBER
)
1788 set_completion_after_number (parser
, linespec_complete_what::KEYWORD
);
1790 /* Record the line offset and get the next token. */
1791 name
= copy_token_string (token
);
1792 PARSER_EXPLICIT (parser
)->line_offset
1793 = linespec_parse_line_offset (name
.get ());
1795 /* Get the next token. */
1796 token
= linespec_lexer_consume_token (parser
);
1798 /* If the next token is a comma, stop parsing and return. */
1799 if (token
.type
== LSTOKEN_COMMA
)
1801 parser
->complete_what
= linespec_complete_what::NOTHING
;
1805 /* If the next token is anything but EOI or KEYWORD, issue
1807 if (token
.type
!= LSTOKEN_KEYWORD
&& token
.type
!= LSTOKEN_EOI
)
1808 unexpected_linespec_error (parser
);
1811 if (token
.type
== LSTOKEN_KEYWORD
|| token
.type
== LSTOKEN_EOI
)
1814 /* Next token must be LSTOKEN_STRING. */
1815 if (token
.type
!= LSTOKEN_STRING
)
1817 parser
->complete_what
= linespec_complete_what::NOTHING
;
1818 unexpected_linespec_error (parser
);
1821 /* The current token will contain the name of a function, method,
1823 name
= copy_token_string (token
);
1825 if (parser
->completion_tracker
!= NULL
)
1827 /* If the function name ends with a ":", then this may be an
1828 incomplete "::" scope operator instead of a label separator.
1831 which should expand to:
1834 Do a tentative completion assuming the later. If we find
1835 completions, advance the stream past the colon token and make
1836 it part of the function name/token. */
1838 if (!parser
->completion_quote_char
1839 && strcmp (PARSER_STREAM (parser
), ":") == 0)
1841 completion_tracker tmp_tracker
;
1842 const char *source_filename
1843 = PARSER_EXPLICIT (parser
)->source_filename
;
1844 symbol_name_match_type match_type
1845 = PARSER_EXPLICIT (parser
)->func_name_match_type
;
1847 linespec_complete_function (tmp_tracker
,
1848 parser
->completion_word
,
1852 if (tmp_tracker
.have_completions ())
1854 PARSER_STREAM (parser
)++;
1855 LS_TOKEN_STOKEN (token
).length
++;
1857 name
.reset (savestring (parser
->completion_word
,
1858 (PARSER_STREAM (parser
)
1859 - parser
->completion_word
)));
1863 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1867 /* Try looking it up as a function/method. */
1868 find_linespec_symbols (PARSER_STATE (parser
),
1869 PARSER_RESULT (parser
)->file_symtabs
, name
.get (),
1870 PARSER_EXPLICIT (parser
)->func_name_match_type
,
1871 &symbols
, &minimal_symbols
);
1873 if (!symbols
.empty () || !minimal_symbols
.empty ())
1875 PARSER_RESULT (parser
)->function_symbols
1876 = new std::vector
<block_symbol
> (std::move (symbols
));
1877 PARSER_RESULT (parser
)->minimal_symbols
1878 = new std::vector
<bound_minimal_symbol
>
1879 (std::move (minimal_symbols
));
1880 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1884 /* NAME was not a function or a method. So it must be a label
1885 name or user specified variable like "break foo.c:$zippo". */
1886 labels
= find_label_symbols (PARSER_STATE (parser
), NULL
,
1887 &symbols
, name
.get ());
1890 PARSER_RESULT (parser
)->labels
.label_symbols
= labels
;
1891 PARSER_RESULT (parser
)->labels
.function_symbols
1892 = new std::vector
<block_symbol
> (std::move (symbols
));
1893 PARSER_EXPLICIT (parser
)->label_name
= name
.release ();
1895 else if (token
.type
== LSTOKEN_STRING
1896 && *LS_TOKEN_STOKEN (token
).ptr
== '$')
1898 /* User specified a convenience variable or history value. */
1899 PARSER_EXPLICIT (parser
)->line_offset
1900 = linespec_parse_variable (PARSER_STATE (parser
), name
.get ());
1902 if (PARSER_EXPLICIT (parser
)->line_offset
.sign
== LINE_OFFSET_UNKNOWN
)
1904 /* The user-specified variable was not valid. Do not
1905 throw an error here. parse_linespec will do it for us. */
1906 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1912 /* The name is also not a label. Abort parsing. Do not throw
1913 an error here. parse_linespec will do it for us. */
1915 /* Save a copy of the name we were trying to lookup. */
1916 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1922 int previous_qc
= parser
->completion_quote_char
;
1924 /* Get the next token. */
1925 token
= linespec_lexer_consume_token (parser
);
1927 if (token
.type
== LSTOKEN_EOI
)
1929 if (previous_qc
&& !parser
->completion_quote_char
)
1930 parser
->complete_what
= linespec_complete_what::KEYWORD
;
1932 else if (token
.type
== LSTOKEN_COLON
)
1934 /* User specified a label or a lineno. */
1935 token
= linespec_lexer_consume_token (parser
);
1937 if (token
.type
== LSTOKEN_NUMBER
)
1939 /* User specified an offset. Record the line offset and
1940 get the next token. */
1941 set_completion_after_number (parser
, linespec_complete_what::KEYWORD
);
1943 name
= copy_token_string (token
);
1944 PARSER_EXPLICIT (parser
)->line_offset
1945 = linespec_parse_line_offset (name
.get ());
1947 /* Get the next token. */
1948 token
= linespec_lexer_consume_token (parser
);
1950 else if (token
.type
== LSTOKEN_EOI
&& parser
->completion_tracker
!= NULL
)
1952 parser
->complete_what
= linespec_complete_what::LABEL
;
1954 else if (token
.type
== LSTOKEN_STRING
)
1956 parser
->complete_what
= linespec_complete_what::LABEL
;
1958 /* If we have text after the label separated by whitespace
1959 (e.g., "b func():lab i<tab>"), don't consider it part of
1960 the label. In completion mode that should complete to
1961 "if", in normal mode, the 'i' should be treated as
1963 if (parser
->completion_quote_char
== '\0')
1965 const char *ptr
= LS_TOKEN_STOKEN (token
).ptr
;
1966 for (size_t i
= 0; i
< LS_TOKEN_STOKEN (token
).length
; i
++)
1970 LS_TOKEN_STOKEN (token
).length
= i
;
1971 PARSER_STREAM (parser
) = skip_spaces (ptr
+ i
+ 1);
1977 if (parser
->completion_tracker
!= NULL
)
1979 if (PARSER_STREAM (parser
)[-1] == ' ')
1981 parser
->completion_word
= PARSER_STREAM (parser
);
1982 parser
->complete_what
= linespec_complete_what::KEYWORD
;
1987 /* Grab a copy of the label's name and look it up. */
1988 name
= copy_token_string (token
);
1990 = find_label_symbols (PARSER_STATE (parser
),
1991 PARSER_RESULT (parser
)->function_symbols
,
1992 &symbols
, name
.get ());
1996 PARSER_RESULT (parser
)->labels
.label_symbols
= labels
;
1997 PARSER_RESULT (parser
)->labels
.function_symbols
1998 = new std::vector
<block_symbol
> (std::move (symbols
));
1999 PARSER_EXPLICIT (parser
)->label_name
= name
.release ();
2003 /* We don't know what it was, but it isn't a label. */
2004 undefined_label_error
2005 (PARSER_EXPLICIT (parser
)->function_name
, name
.get ());
2010 /* Check for a line offset. */
2011 token
= save_stream_and_consume_token (parser
);
2012 if (token
.type
== LSTOKEN_COLON
)
2014 /* Get the next token. */
2015 token
= linespec_lexer_consume_token (parser
);
2017 /* It must be a line offset. */
2018 if (token
.type
!= LSTOKEN_NUMBER
)
2019 unexpected_linespec_error (parser
);
2021 /* Record the line offset and get the next token. */
2022 name
= copy_token_string (token
);
2024 PARSER_EXPLICIT (parser
)->line_offset
2025 = linespec_parse_line_offset (name
.get ());
2027 /* Get the next token. */
2028 token
= linespec_lexer_consume_token (parser
);
2033 /* Trailing ':' in the input. Issue an error. */
2034 unexpected_linespec_error (parser
);
2039 /* Canonicalize the linespec contained in LS. The result is saved into
2040 STATE->canonical. This function handles both linespec and explicit
2044 canonicalize_linespec (struct linespec_state
*state
, const linespec_p ls
)
2046 struct event_location
*canon
;
2047 struct explicit_location
*explicit_loc
;
2049 /* If canonicalization was not requested, no need to do anything. */
2050 if (!state
->canonical
)
2053 /* Save everything as an explicit location. */
2054 state
->canonical
->location
2055 = new_explicit_location (&ls
->explicit_loc
);
2056 canon
= state
->canonical
->location
.get ();
2057 explicit_loc
= get_explicit_location (canon
);
2059 if (explicit_loc
->label_name
!= NULL
)
2061 state
->canonical
->special_display
= 1;
2063 if (explicit_loc
->function_name
== NULL
)
2065 /* No function was specified, so add the symbol name. */
2066 gdb_assert (!ls
->labels
.function_symbols
->empty ()
2067 && (ls
->labels
.function_symbols
->size () == 1));
2068 block_symbol s
= ls
->labels
.function_symbols
->front ();
2069 explicit_loc
->function_name
= xstrdup (s
.symbol
->natural_name ());
2073 /* If this location originally came from a linespec, save a string
2074 representation of it for display and saving to file. */
2075 if (state
->is_linespec
)
2077 char *linespec
= explicit_location_to_linespec (explicit_loc
);
2079 set_event_location_string (canon
, linespec
);
2084 /* Given a line offset in LS, construct the relevant SALs. */
2086 static std::vector
<symtab_and_line
>
2087 create_sals_line_offset (struct linespec_state
*self
,
2090 int use_default
= 0;
2092 /* This is where we need to make sure we have good defaults.
2093 We must guarantee that this section of code is never executed
2094 when we are called with just a function name, since
2095 set_default_source_symtab_and_line uses
2096 select_source_symtab that calls us with such an argument. */
2098 if (ls
->file_symtabs
->size () == 1
2099 && ls
->file_symtabs
->front () == nullptr)
2101 set_current_program_space (self
->program_space
);
2103 /* Make sure we have at least a default source line. */
2104 set_default_source_symtab_and_line ();
2105 initialize_defaults (&self
->default_symtab
, &self
->default_line
);
2107 = collect_symtabs_from_filename (self
->default_symtab
->filename
,
2108 self
->search_pspace
);
2112 symtab_and_line val
;
2113 val
.line
= ls
->explicit_loc
.line_offset
.offset
;
2114 switch (ls
->explicit_loc
.line_offset
.sign
)
2116 case LINE_OFFSET_PLUS
:
2117 if (ls
->explicit_loc
.line_offset
.offset
== 0)
2120 val
.line
= self
->default_line
+ val
.line
;
2123 case LINE_OFFSET_MINUS
:
2124 if (ls
->explicit_loc
.line_offset
.offset
== 0)
2127 val
.line
= self
->default_line
- val
.line
;
2129 val
.line
= -val
.line
;
2132 case LINE_OFFSET_NONE
:
2133 break; /* No need to adjust val.line. */
2136 std::vector
<symtab_and_line
> values
;
2137 if (self
->list_mode
)
2138 values
= decode_digits_list_mode (self
, ls
, val
);
2141 struct linetable_entry
*best_entry
= NULL
;
2144 std::vector
<symtab_and_line
> intermediate_results
2145 = decode_digits_ordinary (self
, ls
, val
.line
, &best_entry
);
2146 if (intermediate_results
.empty () && best_entry
!= NULL
)
2147 intermediate_results
= decode_digits_ordinary (self
, ls
,
2151 /* For optimized code, the compiler can scatter one source line
2152 across disjoint ranges of PC values, even when no duplicate
2153 functions or inline functions are involved. For example,
2154 'for (;;)' inside a non-template, non-inline, and non-ctor-or-dtor
2155 function can result in two PC ranges. In this case, we don't
2156 want to set a breakpoint on the first PC of each range. To filter
2157 such cases, we use containing blocks -- for each PC found
2158 above, we see if there are other PCs that are in the same
2159 block. If yes, the other PCs are filtered out. */
2161 gdb::def_vector
<int> filter (intermediate_results
.size ());
2162 gdb::def_vector
<const block
*> blocks (intermediate_results
.size ());
2164 for (i
= 0; i
< intermediate_results
.size (); ++i
)
2166 set_current_program_space (intermediate_results
[i
].pspace
);
2169 blocks
[i
] = block_for_pc_sect (intermediate_results
[i
].pc
,
2170 intermediate_results
[i
].section
);
2173 for (i
= 0; i
< intermediate_results
.size (); ++i
)
2175 if (blocks
[i
] != NULL
)
2176 for (j
= i
+ 1; j
< intermediate_results
.size (); ++j
)
2178 if (blocks
[j
] == blocks
[i
])
2186 for (i
= 0; i
< intermediate_results
.size (); ++i
)
2189 struct symbol
*sym
= (blocks
[i
]
2190 ? block_containing_function (blocks
[i
])
2193 if (self
->funfirstline
)
2194 skip_prologue_sal (&intermediate_results
[i
]);
2195 intermediate_results
[i
].symbol
= sym
;
2196 add_sal_to_sals (self
, &values
, &intermediate_results
[i
],
2197 sym
? sym
->natural_name () : NULL
, 0);
2201 if (values
.empty ())
2203 if (ls
->explicit_loc
.source_filename
)
2204 throw_error (NOT_FOUND_ERROR
, _("No line %d in file \"%s\"."),
2205 val
.line
, ls
->explicit_loc
.source_filename
);
2207 throw_error (NOT_FOUND_ERROR
, _("No line %d in the current file."),
2214 /* Convert the given ADDRESS into SaLs. */
2216 static std::vector
<symtab_and_line
>
2217 convert_address_location_to_sals (struct linespec_state
*self
,
2220 symtab_and_line sal
= find_pc_line (address
, 0);
2222 sal
.section
= find_pc_overlay (address
);
2223 sal
.explicit_pc
= 1;
2224 sal
.symbol
= find_pc_sect_containing_function (sal
.pc
, sal
.section
);
2226 std::vector
<symtab_and_line
> sals
;
2227 add_sal_to_sals (self
, &sals
, &sal
, core_addr_to_string (address
), 1);
2232 /* Create and return SALs from the linespec LS. */
2234 static std::vector
<symtab_and_line
>
2235 convert_linespec_to_sals (struct linespec_state
*state
, linespec_p ls
)
2237 std::vector
<symtab_and_line
> sals
;
2239 if (ls
->labels
.label_symbols
!= NULL
)
2241 /* We have just a bunch of functions/methods or labels. */
2242 struct symtab_and_line sal
;
2244 for (const auto &sym
: *ls
->labels
.label_symbols
)
2246 struct program_space
*pspace
2247 = SYMTAB_PSPACE (symbol_symtab (sym
.symbol
));
2249 if (symbol_to_sal (&sal
, state
->funfirstline
, sym
.symbol
)
2250 && maybe_add_address (state
->addr_set
, pspace
, sal
.pc
))
2251 add_sal_to_sals (state
, &sals
, &sal
,
2252 sym
.symbol
->natural_name (), 0);
2255 else if (ls
->function_symbols
!= NULL
|| ls
->minimal_symbols
!= NULL
)
2257 /* We have just a bunch of functions and/or methods. */
2258 if (ls
->function_symbols
!= NULL
)
2260 /* Sort symbols so that symbols with the same program space are next
2262 std::sort (ls
->function_symbols
->begin (),
2263 ls
->function_symbols
->end (),
2266 for (const auto &sym
: *ls
->function_symbols
)
2268 program_space
*pspace
2269 = SYMTAB_PSPACE (symbol_symtab (sym
.symbol
));
2270 set_current_program_space (pspace
);
2272 /* Don't skip to the first line of the function if we
2273 had found an ifunc minimal symbol for this function,
2274 because that means that this function is an ifunc
2275 resolver with the same name as the ifunc itself. */
2276 bool found_ifunc
= false;
2278 if (state
->funfirstline
2279 && ls
->minimal_symbols
!= NULL
2280 && SYMBOL_CLASS (sym
.symbol
) == LOC_BLOCK
)
2282 const CORE_ADDR addr
2283 = BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
.symbol
));
2285 for (const auto &elem
: *ls
->minimal_symbols
)
2287 if (MSYMBOL_TYPE (elem
.minsym
) == mst_text_gnu_ifunc
2288 || MSYMBOL_TYPE (elem
.minsym
) == mst_data_gnu_ifunc
)
2290 CORE_ADDR msym_addr
= BMSYMBOL_VALUE_ADDRESS (elem
);
2291 if (MSYMBOL_TYPE (elem
.minsym
) == mst_data_gnu_ifunc
)
2293 struct gdbarch
*gdbarch
2294 = elem
.objfile
->arch ();
2296 = (gdbarch_convert_from_func_ptr_addr
2299 current_top_target ()));
2302 if (msym_addr
== addr
)
2313 symtab_and_line sal
;
2314 if (symbol_to_sal (&sal
, state
->funfirstline
, sym
.symbol
)
2315 && maybe_add_address (state
->addr_set
, pspace
, sal
.pc
))
2316 add_sal_to_sals (state
, &sals
, &sal
,
2317 sym
.symbol
->natural_name (), 0);
2322 if (ls
->minimal_symbols
!= NULL
)
2324 /* Sort minimal symbols by program space, too */
2325 std::sort (ls
->minimal_symbols
->begin (),
2326 ls
->minimal_symbols
->end (),
2329 for (const auto &elem
: *ls
->minimal_symbols
)
2331 program_space
*pspace
= elem
.objfile
->pspace
;
2332 set_current_program_space (pspace
);
2333 minsym_found (state
, elem
.objfile
, elem
.minsym
, &sals
);
2337 else if (ls
->explicit_loc
.line_offset
.sign
!= LINE_OFFSET_UNKNOWN
)
2339 /* Only an offset was specified. */
2340 sals
= create_sals_line_offset (state
, ls
);
2342 /* Make sure we have a filename for canonicalization. */
2343 if (ls
->explicit_loc
.source_filename
== NULL
)
2345 const char *fullname
= symtab_to_fullname (state
->default_symtab
);
2347 /* It may be more appropriate to keep DEFAULT_SYMTAB in its symtab
2348 form so that displaying SOURCE_FILENAME can follow the current
2349 FILENAME_DISPLAY_STRING setting. But as it is used only rarely
2350 it has been kept for code simplicity only in absolute form. */
2351 ls
->explicit_loc
.source_filename
= xstrdup (fullname
);
2356 /* We haven't found any results... */
2360 canonicalize_linespec (state
, ls
);
2362 if (!sals
.empty () && state
->canonical
!= NULL
)
2363 state
->canonical
->pre_expanded
= 1;
2368 /* Build RESULT from the explicit location components SOURCE_FILENAME,
2369 FUNCTION_NAME, LABEL_NAME and LINE_OFFSET. */
2372 convert_explicit_location_to_linespec (struct linespec_state
*self
,
2374 const char *source_filename
,
2375 const char *function_name
,
2376 symbol_name_match_type fname_match_type
,
2377 const char *label_name
,
2378 struct line_offset line_offset
)
2380 std::vector
<block_symbol
> symbols
;
2381 std::vector
<block_symbol
> *labels
;
2382 std::vector
<bound_minimal_symbol
> minimal_symbols
;
2384 result
->explicit_loc
.func_name_match_type
= fname_match_type
;
2386 if (source_filename
!= NULL
)
2390 *result
->file_symtabs
2391 = symtabs_from_filename (source_filename
, self
->search_pspace
);
2393 catch (const gdb_exception_error
&except
)
2395 source_file_not_found_error (source_filename
);
2397 result
->explicit_loc
.source_filename
= xstrdup (source_filename
);
2401 /* A NULL entry means to use the default symtab. */
2402 result
->file_symtabs
->push_back (nullptr);
2405 if (function_name
!= NULL
)
2407 find_linespec_symbols (self
, result
->file_symtabs
,
2408 function_name
, fname_match_type
,
2409 &symbols
, &minimal_symbols
);
2411 if (symbols
.empty () && minimal_symbols
.empty ())
2412 symbol_not_found_error (function_name
,
2413 result
->explicit_loc
.source_filename
);
2415 result
->explicit_loc
.function_name
= xstrdup (function_name
);
2416 result
->function_symbols
2417 = new std::vector
<block_symbol
> (std::move (symbols
));
2418 result
->minimal_symbols
2419 = new std::vector
<bound_minimal_symbol
> (std::move (minimal_symbols
));
2422 if (label_name
!= NULL
)
2424 labels
= find_label_symbols (self
, result
->function_symbols
,
2425 &symbols
, label_name
);
2428 undefined_label_error (result
->explicit_loc
.function_name
,
2431 result
->explicit_loc
.label_name
= xstrdup (label_name
);
2432 result
->labels
.label_symbols
= labels
;
2433 result
->labels
.function_symbols
2434 = new std::vector
<block_symbol
> (std::move (symbols
));
2437 if (line_offset
.sign
!= LINE_OFFSET_UNKNOWN
)
2438 result
->explicit_loc
.line_offset
= line_offset
;
2441 /* Convert the explicit location EXPLICIT_LOC into SaLs. */
2443 static std::vector
<symtab_and_line
>
2444 convert_explicit_location_to_sals (struct linespec_state
*self
,
2446 const struct explicit_location
*explicit_loc
)
2448 convert_explicit_location_to_linespec (self
, result
,
2449 explicit_loc
->source_filename
,
2450 explicit_loc
->function_name
,
2451 explicit_loc
->func_name_match_type
,
2452 explicit_loc
->label_name
,
2453 explicit_loc
->line_offset
);
2454 return convert_linespec_to_sals (self
, result
);
2457 /* Parse a string that specifies a linespec.
2459 The basic grammar of linespecs:
2461 linespec -> var_spec | basic_spec
2462 var_spec -> '$' (STRING | NUMBER)
2464 basic_spec -> file_offset_spec | function_spec | label_spec
2465 file_offset_spec -> opt_file_spec offset_spec
2466 function_spec -> opt_file_spec function_name_spec opt_label_spec
2467 label_spec -> label_name_spec
2469 opt_file_spec -> "" | file_name_spec ':'
2470 opt_label_spec -> "" | ':' label_name_spec
2472 file_name_spec -> STRING
2473 function_name_spec -> STRING
2474 label_name_spec -> STRING
2475 function_name_spec -> STRING
2476 offset_spec -> NUMBER
2480 This may all be followed by several keywords such as "if EXPR",
2483 A comma will terminate parsing.
2485 The function may be an undebuggable function found in minimal symbol table.
2487 If the argument FUNFIRSTLINE is nonzero, we want the first line
2488 of real code inside a function when a function is specified, and it is
2489 not OK to specify a variable or type to get its line number.
2491 DEFAULT_SYMTAB specifies the file to use if none is specified.
2492 It defaults to current_source_symtab.
2493 DEFAULT_LINE specifies the line number to use for relative
2494 line numbers (that start with signs). Defaults to current_source_line.
2495 If CANONICAL is non-NULL, store an array of strings containing the canonical
2496 line specs there if necessary. Currently overloaded member functions and
2497 line numbers or static functions without a filename yield a canonical
2498 line spec. The array and the line spec strings are allocated on the heap,
2499 it is the callers responsibility to free them.
2501 Note that it is possible to return zero for the symtab
2502 if no file is validly specified. Callers must check that.
2503 Also, the line number returned may be invalid. */
2505 /* Parse the linespec in ARG. MATCH_TYPE indicates how function names
2506 should be matched. */
2508 static std::vector
<symtab_and_line
>
2509 parse_linespec (linespec_parser
*parser
, const char *arg
,
2510 symbol_name_match_type match_type
)
2512 linespec_token token
;
2513 struct gdb_exception file_exception
;
2515 /* A special case to start. It has become quite popular for
2516 IDEs to work around bugs in the previous parser by quoting
2517 the entire linespec, so we attempt to deal with this nicely. */
2518 parser
->is_quote_enclosed
= 0;
2519 if (parser
->completion_tracker
== NULL
2520 && !is_ada_operator (arg
)
2521 && strchr (linespec_quote_characters
, *arg
) != NULL
)
2525 end
= skip_quote_char (arg
+ 1, *arg
);
2526 if (end
!= NULL
&& is_closing_quote_enclosed (end
))
2528 /* Here's the special case. Skip ARG past the initial
2531 parser
->is_quote_enclosed
= 1;
2535 parser
->lexer
.saved_arg
= arg
;
2536 parser
->lexer
.stream
= arg
;
2537 parser
->completion_word
= arg
;
2538 parser
->complete_what
= linespec_complete_what::FUNCTION
;
2539 PARSER_EXPLICIT (parser
)->func_name_match_type
= match_type
;
2541 /* Initialize the default symtab and line offset. */
2542 initialize_defaults (&PARSER_STATE (parser
)->default_symtab
,
2543 &PARSER_STATE (parser
)->default_line
);
2545 /* Objective-C shortcut. */
2546 if (parser
->completion_tracker
== NULL
)
2548 std::vector
<symtab_and_line
> values
2549 = decode_objc (PARSER_STATE (parser
), PARSER_RESULT (parser
), arg
);
2550 if (!values
.empty ())
2555 /* "-"/"+" is either an objc selector, or a number. There's
2556 nothing to complete the latter to, so just let the caller
2557 complete on functions, which finds objc selectors, if there's
2559 if ((arg
[0] == '-' || arg
[0] == '+') && arg
[1] == '\0')
2563 /* Start parsing. */
2565 /* Get the first token. */
2566 token
= linespec_lexer_consume_token (parser
);
2568 /* It must be either LSTOKEN_STRING or LSTOKEN_NUMBER. */
2569 if (token
.type
== LSTOKEN_STRING
&& *LS_TOKEN_STOKEN (token
).ptr
== '$')
2571 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2572 if (parser
->completion_tracker
== NULL
)
2573 PARSER_RESULT (parser
)->file_symtabs
->push_back (nullptr);
2575 /* User specified a convenience variable or history value. */
2576 gdb::unique_xmalloc_ptr
<char> var
= copy_token_string (token
);
2577 PARSER_EXPLICIT (parser
)->line_offset
2578 = linespec_parse_variable (PARSER_STATE (parser
), var
.get ());
2580 /* If a line_offset wasn't found (VAR is the name of a user
2581 variable/function), then skip to normal symbol processing. */
2582 if (PARSER_EXPLICIT (parser
)->line_offset
.sign
!= LINE_OFFSET_UNKNOWN
)
2584 /* Consume this token. */
2585 linespec_lexer_consume_token (parser
);
2587 goto convert_to_sals
;
2590 else if (token
.type
== LSTOKEN_EOI
&& parser
->completion_tracker
!= NULL
)
2592 /* Let the default linespec_complete_what::FUNCTION kick in. */
2593 unexpected_linespec_error (parser
);
2595 else if (token
.type
!= LSTOKEN_STRING
&& token
.type
!= LSTOKEN_NUMBER
)
2597 parser
->complete_what
= linespec_complete_what::NOTHING
;
2598 unexpected_linespec_error (parser
);
2601 /* Shortcut: If the next token is not LSTOKEN_COLON, we know that
2602 this token cannot represent a filename. */
2603 token
= linespec_lexer_peek_token (parser
);
2605 if (token
.type
== LSTOKEN_COLON
)
2607 /* Get the current token again and extract the filename. */
2608 token
= linespec_lexer_lex_one (parser
);
2609 gdb::unique_xmalloc_ptr
<char> user_filename
= copy_token_string (token
);
2611 /* Check if the input is a filename. */
2614 *PARSER_RESULT (parser
)->file_symtabs
2615 = symtabs_from_filename (user_filename
.get (),
2616 PARSER_STATE (parser
)->search_pspace
);
2618 catch (gdb_exception_error
&ex
)
2620 file_exception
= std::move (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 (std::move (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 (label
.symbol
->search_name ());
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 (const gdb_exception_error
&ex
)
2940 complete_label (tracker
, &parser
, label_name
);
2943 /* See description in linespec.h. */
2946 linespec_complete (completion_tracker
&tracker
, const char *text
,
2947 symbol_name_match_type match_type
)
2949 const char *orig
= text
;
2951 linespec_parser
parser (0, current_language
, NULL
, NULL
, 0, NULL
);
2952 parser
.lexer
.saved_arg
= text
;
2953 PARSER_EXPLICIT (&parser
)->func_name_match_type
= match_type
;
2954 PARSER_STREAM (&parser
) = text
;
2956 parser
.completion_tracker
= &tracker
;
2957 PARSER_STATE (&parser
)->is_linespec
= 1;
2959 /* Parse as much as possible. parser.completion_word will hold
2960 furthest completion point we managed to parse to. */
2963 parse_linespec (&parser
, text
, match_type
);
2965 catch (const gdb_exception_error
&except
)
2969 if (parser
.completion_quote_char
!= '\0'
2970 && parser
.completion_quote_end
!= NULL
2971 && parser
.completion_quote_end
[1] == '\0')
2973 /* If completing a quoted string with the cursor right at
2974 terminating quote char, complete the completion word without
2975 interpretation, so that readline advances the cursor one
2976 whitespace past the quote, even if there's no match. This
2977 makes these cases behave the same:
2979 before: "b function()"
2980 after: "b function() "
2982 before: "b 'function()'"
2983 after: "b 'function()' "
2985 and trusts the user in this case:
2987 before: "b 'not_loaded_function_yet()'"
2988 after: "b 'not_loaded_function_yet()' "
2990 parser
.complete_what
= linespec_complete_what::NOTHING
;
2991 parser
.completion_quote_char
= '\0';
2993 gdb::unique_xmalloc_ptr
<char> text_copy
2994 (xstrdup (parser
.completion_word
));
2995 tracker
.add_completion (std::move (text_copy
));
2998 tracker
.set_quote_char (parser
.completion_quote_char
);
3000 if (parser
.complete_what
== linespec_complete_what::LABEL
)
3002 parser
.complete_what
= linespec_complete_what::NOTHING
;
3004 const char *func_name
= PARSER_EXPLICIT (&parser
)->function_name
;
3006 std::vector
<block_symbol
> function_symbols
;
3007 std::vector
<bound_minimal_symbol
> minimal_symbols
;
3008 find_linespec_symbols (PARSER_STATE (&parser
),
3009 PARSER_RESULT (&parser
)->file_symtabs
,
3010 func_name
, match_type
,
3011 &function_symbols
, &minimal_symbols
);
3013 PARSER_RESULT (&parser
)->function_symbols
3014 = new std::vector
<block_symbol
> (std::move (function_symbols
));
3015 PARSER_RESULT (&parser
)->minimal_symbols
3016 = new std::vector
<bound_minimal_symbol
> (std::move (minimal_symbols
));
3018 complete_label (tracker
, &parser
, parser
.completion_word
);
3020 else if (parser
.complete_what
== linespec_complete_what::FUNCTION
)
3022 /* While parsing/lexing, we didn't know whether the completion
3023 word completes to a unique function/source name already or
3027 "b function() <tab>"
3028 may need to complete either to:
3029 "b function() const"
3031 "b function() if/thread/task"
3035 may need to complete either to:
3036 "b foo template_fun<T>()"
3037 with "foo" being the template function's return type, or to:
3042 may need to complete either to a source file name:
3044 or this, also a filename, but a unique completion:
3046 or to a function name:
3049 Address that by completing assuming source or function, and
3050 seeing if we find a completion that matches exactly the
3051 completion word. If so, then it must be a function (see note
3052 below) and we advance the completion word to the end of input
3053 and switch to KEYWORD completion mode.
3055 Note: if we find a unique completion for a source filename,
3056 then it won't match the completion word, because the LCD will
3057 contain a trailing ':'. And if we're completing at or after
3058 the ':', then complete_linespec_component won't try to
3059 complete on source filenames. */
3061 const char *word
= parser
.completion_word
;
3063 complete_linespec_component (&parser
, tracker
,
3064 parser
.completion_word
,
3065 linespec_complete_what::FUNCTION
,
3066 PARSER_EXPLICIT (&parser
)->source_filename
);
3068 parser
.complete_what
= linespec_complete_what::NOTHING
;
3070 if (tracker
.quote_char ())
3072 /* The function/file name was not close-quoted, so this
3073 can't be a keyword. Note: complete_linespec_component
3074 may have swapped the original quote char for ':' when we
3075 get here, but that still indicates the same. */
3077 else if (!tracker
.have_completions ())
3080 size_t wordlen
= strlen (parser
.completion_word
);
3083 = string_find_incomplete_keyword_at_end (linespec_keywords
,
3084 parser
.completion_word
,
3089 && parser
.completion_word
[wordlen
- 1] == ' '))
3091 parser
.completion_word
+= key_start
;
3092 parser
.complete_what
= linespec_complete_what::KEYWORD
;
3095 else if (tracker
.completes_to_completion_word (word
))
3097 /* Skip the function and complete on keywords. */
3098 parser
.completion_word
+= strlen (word
);
3099 parser
.complete_what
= linespec_complete_what::KEYWORD
;
3100 tracker
.discard_completions ();
3104 tracker
.advance_custom_word_point_by (parser
.completion_word
- orig
);
3106 complete_linespec_component (&parser
, tracker
,
3107 parser
.completion_word
,
3108 parser
.complete_what
,
3109 PARSER_EXPLICIT (&parser
)->source_filename
);
3111 /* If we're past the "filename:function:label:offset" linespec, and
3112 didn't find any match, then assume the user might want to create
3113 a pending breakpoint anyway and offer the keyword
3115 if (!parser
.completion_quote_char
3116 && (parser
.complete_what
== linespec_complete_what::FUNCTION
3117 || parser
.complete_what
== linespec_complete_what::LABEL
3118 || parser
.complete_what
== linespec_complete_what::NOTHING
)
3119 && !tracker
.have_completions ())
3122 = parser
.completion_word
+ strlen (parser
.completion_word
);
3124 if (end
> orig
&& end
[-1] == ' ')
3126 tracker
.advance_custom_word_point_by (end
- parser
.completion_word
);
3128 complete_linespec_component (&parser
, tracker
, end
,
3129 linespec_complete_what::KEYWORD
,
3135 /* A helper function for decode_line_full and decode_line_1 to
3136 turn LOCATION into std::vector<symtab_and_line>. */
3138 static std::vector
<symtab_and_line
>
3139 event_location_to_sals (linespec_parser
*parser
,
3140 const struct event_location
*location
)
3142 std::vector
<symtab_and_line
> result
;
3144 switch (event_location_type (location
))
3146 case LINESPEC_LOCATION
:
3148 PARSER_STATE (parser
)->is_linespec
= 1;
3151 const linespec_location
*ls
= get_linespec_location (location
);
3152 result
= parse_linespec (parser
,
3153 ls
->spec_string
, ls
->match_type
);
3155 catch (const gdb_exception_error
&except
)
3162 case ADDRESS_LOCATION
:
3164 const char *addr_string
= get_address_string_location (location
);
3165 CORE_ADDR addr
= get_address_location (location
);
3167 if (addr_string
!= NULL
)
3169 addr
= linespec_expression_to_pc (&addr_string
);
3170 if (PARSER_STATE (parser
)->canonical
!= NULL
)
3171 PARSER_STATE (parser
)->canonical
->location
3172 = copy_event_location (location
);
3175 result
= convert_address_location_to_sals (PARSER_STATE (parser
),
3180 case EXPLICIT_LOCATION
:
3182 const struct explicit_location
*explicit_loc
;
3184 explicit_loc
= get_explicit_location_const (location
);
3185 result
= convert_explicit_location_to_sals (PARSER_STATE (parser
),
3186 PARSER_RESULT (parser
),
3191 case PROBE_LOCATION
:
3192 /* Probes are handled by their own decoders. */
3193 gdb_assert_not_reached ("attempt to decode probe location");
3197 gdb_assert_not_reached ("unhandled event location type");
3203 /* See linespec.h. */
3206 decode_line_full (const struct event_location
*location
, int flags
,
3207 struct program_space
*search_pspace
,
3208 struct symtab
*default_symtab
,
3209 int default_line
, struct linespec_result
*canonical
,
3210 const char *select_mode
,
3213 std::vector
<const char *> filters
;
3214 struct linespec_state
*state
;
3216 gdb_assert (canonical
!= NULL
);
3217 /* The filter only makes sense for 'all'. */
3218 gdb_assert (filter
== NULL
|| select_mode
== multiple_symbols_all
);
3219 gdb_assert (select_mode
== NULL
3220 || select_mode
== multiple_symbols_all
3221 || select_mode
== multiple_symbols_ask
3222 || select_mode
== multiple_symbols_cancel
);
3223 gdb_assert ((flags
& DECODE_LINE_LIST_MODE
) == 0);
3225 linespec_parser
parser (flags
, current_language
,
3226 search_pspace
, default_symtab
,
3227 default_line
, canonical
);
3229 scoped_restore_current_program_space restore_pspace
;
3231 std::vector
<symtab_and_line
> result
= event_location_to_sals (&parser
,
3233 state
= PARSER_STATE (&parser
);
3235 gdb_assert (result
.size () == 1 || canonical
->pre_expanded
);
3236 canonical
->pre_expanded
= 1;
3238 /* Arrange for allocated canonical names to be freed. */
3239 std::vector
<gdb::unique_xmalloc_ptr
<char>> hold_names
;
3240 for (int i
= 0; i
< result
.size (); ++i
)
3242 gdb_assert (state
->canonical_names
[i
].suffix
!= NULL
);
3243 hold_names
.emplace_back (state
->canonical_names
[i
].suffix
);
3246 if (select_mode
== NULL
)
3248 if (top_level_interpreter ()->interp_ui_out ()->is_mi_like_p ())
3249 select_mode
= multiple_symbols_all
;
3251 select_mode
= multiple_symbols_select_mode ();
3254 if (select_mode
== multiple_symbols_all
)
3258 filters
.push_back (filter
);
3259 filter_results (state
, &result
, filters
);
3262 convert_results_to_lsals (state
, &result
);
3265 decode_line_2 (state
, &result
, select_mode
);
3268 /* See linespec.h. */
3270 std::vector
<symtab_and_line
>
3271 decode_line_1 (const struct event_location
*location
, int flags
,
3272 struct program_space
*search_pspace
,
3273 struct symtab
*default_symtab
,
3276 linespec_parser
parser (flags
, current_language
,
3277 search_pspace
, default_symtab
,
3278 default_line
, NULL
);
3280 scoped_restore_current_program_space restore_pspace
;
3282 return event_location_to_sals (&parser
, location
);
3285 /* See linespec.h. */
3287 std::vector
<symtab_and_line
>
3288 decode_line_with_current_source (const char *string
, int flags
)
3291 error (_("Empty line specification."));
3293 /* We use whatever is set as the current source line. We do not try
3294 and get a default source symtab+line or it will recursively call us! */
3295 symtab_and_line cursal
= get_current_source_symtab_and_line ();
3297 event_location_up location
= string_to_event_location (&string
,
3299 std::vector
<symtab_and_line
> sals
3300 = decode_line_1 (location
.get (), flags
, NULL
, cursal
.symtab
, cursal
.line
);
3303 error (_("Junk at end of line specification: %s"), string
);
3308 /* See linespec.h. */
3310 std::vector
<symtab_and_line
>
3311 decode_line_with_last_displayed (const char *string
, int flags
)
3314 error (_("Empty line specification."));
3316 event_location_up location
= string_to_event_location (&string
,
3318 std::vector
<symtab_and_line
> sals
3319 = (last_displayed_sal_is_valid ()
3320 ? decode_line_1 (location
.get (), flags
, NULL
,
3321 get_last_displayed_symtab (),
3322 get_last_displayed_line ())
3323 : decode_line_1 (location
.get (), flags
, NULL
, NULL
, 0));
3326 error (_("Junk at end of line specification: %s"), string
);
3333 /* First, some functions to initialize stuff at the beginning of the
3337 initialize_defaults (struct symtab
**default_symtab
, int *default_line
)
3339 if (*default_symtab
== 0)
3341 /* Use whatever we have for the default source line. We don't use
3342 get_current_or_default_symtab_and_line as it can recurse and call
3344 struct symtab_and_line cursal
=
3345 get_current_source_symtab_and_line ();
3347 *default_symtab
= cursal
.symtab
;
3348 *default_line
= cursal
.line
;
3354 /* Evaluate the expression pointed to by EXP_PTR into a CORE_ADDR,
3355 advancing EXP_PTR past any parsed text. */
3358 linespec_expression_to_pc (const char **exp_ptr
)
3360 if (current_program_space
->executing_startup
)
3361 /* The error message doesn't really matter, because this case
3362 should only hit during breakpoint reset. */
3363 throw_error (NOT_FOUND_ERROR
, _("cannot evaluate expressions while "
3364 "program space is in startup"));
3367 return value_as_address (parse_to_comma_and_eval (exp_ptr
));
3372 /* Here's where we recognise an Objective-C Selector. An Objective C
3373 selector may be implemented by more than one class, therefore it
3374 may represent more than one method/function. This gives us a
3375 situation somewhat analogous to C++ overloading. If there's more
3376 than one method that could represent the selector, then use some of
3377 the existing C++ code to let the user choose one. */
3379 static std::vector
<symtab_and_line
>
3380 decode_objc (struct linespec_state
*self
, linespec_p ls
, const char *arg
)
3382 struct collect_info info
;
3383 std::vector
<const char *> symbol_names
;
3384 const char *new_argptr
;
3387 std::vector
<symtab
*> symtabs
;
3388 symtabs
.push_back (nullptr);
3390 info
.file_symtabs
= &symtabs
;
3392 std::vector
<block_symbol
> symbols
;
3393 info
.result
.symbols
= &symbols
;
3394 std::vector
<bound_minimal_symbol
> minimal_symbols
;
3395 info
.result
.minimal_symbols
= &minimal_symbols
;
3397 new_argptr
= find_imps (arg
, &symbol_names
);
3398 if (symbol_names
.empty ())
3401 add_all_symbol_names_from_pspace (&info
, NULL
, symbol_names
,
3404 std::vector
<symtab_and_line
> values
;
3405 if (!symbols
.empty () || !minimal_symbols
.empty ())
3409 saved_arg
= (char *) alloca (new_argptr
- arg
+ 1);
3410 memcpy (saved_arg
, arg
, new_argptr
- arg
);
3411 saved_arg
[new_argptr
- arg
] = '\0';
3413 ls
->explicit_loc
.function_name
= xstrdup (saved_arg
);
3414 ls
->function_symbols
3415 = new std::vector
<block_symbol
> (std::move (symbols
));
3417 = new std::vector
<bound_minimal_symbol
> (std::move (minimal_symbols
));
3418 values
= convert_linespec_to_sals (self
, ls
);
3420 if (self
->canonical
)
3425 self
->canonical
->pre_expanded
= 1;
3427 if (ls
->explicit_loc
.source_filename
)
3429 holder
= string_printf ("%s:%s",
3430 ls
->explicit_loc
.source_filename
,
3432 str
= holder
.c_str ();
3437 self
->canonical
->location
3438 = new_linespec_location (&str
, symbol_name_match_type::FULL
);
3447 /* A function object that serves as symbol_found_callback_ftype
3448 callback for iterate_over_symbols. This is used by
3449 lookup_prefix_sym to collect type symbols. */
3450 class decode_compound_collector
3453 decode_compound_collector ()
3455 m_unique_syms
= htab_create_alloc (1, htab_hash_pointer
,
3456 htab_eq_pointer
, NULL
,
3460 ~decode_compound_collector ()
3462 if (m_unique_syms
!= NULL
)
3463 htab_delete (m_unique_syms
);
3466 /* Return all symbols collected. */
3467 std::vector
<block_symbol
> release_symbols ()
3469 return std::move (m_symbols
);
3472 /* Callable as a symbol_found_callback_ftype callback. */
3473 bool operator () (block_symbol
*bsym
);
3476 /* A hash table of all symbols we found. We use this to avoid
3477 adding any symbol more than once. */
3478 htab_t m_unique_syms
;
3480 /* The result vector. */
3481 std::vector
<block_symbol
> m_symbols
;
3485 decode_compound_collector::operator () (block_symbol
*bsym
)
3489 struct symbol
*sym
= bsym
->symbol
;
3491 if (SYMBOL_CLASS (sym
) != LOC_TYPEDEF
)
3492 return true; /* Continue iterating. */
3494 t
= SYMBOL_TYPE (sym
);
3495 t
= check_typedef (t
);
3496 if (TYPE_CODE (t
) != TYPE_CODE_STRUCT
3497 && TYPE_CODE (t
) != TYPE_CODE_UNION
3498 && TYPE_CODE (t
) != TYPE_CODE_NAMESPACE
)
3499 return true; /* Continue iterating. */
3501 slot
= htab_find_slot (m_unique_syms
, sym
, INSERT
);
3505 m_symbols
.push_back (*bsym
);
3508 return true; /* Continue iterating. */
3513 /* Return any symbols corresponding to CLASS_NAME in FILE_SYMTABS. */
3515 static std::vector
<block_symbol
>
3516 lookup_prefix_sym (struct linespec_state
*state
,
3517 std::vector
<symtab
*> *file_symtabs
,
3518 const char *class_name
)
3520 decode_compound_collector collector
;
3522 lookup_name_info
lookup_name (class_name
, symbol_name_match_type::FULL
);
3524 for (const auto &elt
: *file_symtabs
)
3528 iterate_over_all_matching_symtabs (state
, lookup_name
,
3529 STRUCT_DOMAIN
, ALL_DOMAIN
,
3530 NULL
, false, collector
);
3531 iterate_over_all_matching_symtabs (state
, lookup_name
,
3532 VAR_DOMAIN
, ALL_DOMAIN
,
3533 NULL
, false, collector
);
3537 /* Program spaces that are executing startup should have
3538 been filtered out earlier. */
3539 gdb_assert (!SYMTAB_PSPACE (elt
)->executing_startup
);
3540 set_current_program_space (SYMTAB_PSPACE (elt
));
3541 iterate_over_file_blocks (elt
, lookup_name
, STRUCT_DOMAIN
, collector
);
3542 iterate_over_file_blocks (elt
, lookup_name
, VAR_DOMAIN
, collector
);
3546 return collector
.release_symbols ();
3549 /* A std::sort comparison function for symbols. The resulting order does
3550 not actually matter; we just need to be able to sort them so that
3551 symbols with the same program space end up next to each other. */
3554 compare_symbols (const block_symbol
&a
, const block_symbol
&b
)
3558 uia
= (uintptr_t) SYMTAB_PSPACE (symbol_symtab (a
.symbol
));
3559 uib
= (uintptr_t) SYMTAB_PSPACE (symbol_symtab (b
.symbol
));
3566 uia
= (uintptr_t) a
.symbol
;
3567 uib
= (uintptr_t) b
.symbol
;
3575 /* Like compare_symbols but for minimal symbols. */
3578 compare_msymbols (const bound_minimal_symbol
&a
, const bound_minimal_symbol
&b
)
3582 uia
= (uintptr_t) a
.objfile
->pspace
;
3583 uib
= (uintptr_t) a
.objfile
->pspace
;
3590 uia
= (uintptr_t) a
.minsym
;
3591 uib
= (uintptr_t) b
.minsym
;
3599 /* Look for all the matching instances of each symbol in NAMES. Only
3600 instances from PSPACE are considered; other program spaces are
3601 handled by our caller. If PSPACE is NULL, then all program spaces
3602 are considered. Results are stored into INFO. */
3605 add_all_symbol_names_from_pspace (struct collect_info
*info
,
3606 struct program_space
*pspace
,
3607 const std::vector
<const char *> &names
,
3608 enum search_domain search_domain
)
3610 for (const char *iter
: names
)
3611 add_matching_symbols_to_info (iter
,
3612 symbol_name_match_type::FULL
,
3613 search_domain
, info
, pspace
);
3617 find_superclass_methods (std::vector
<struct type
*> &&superclasses
,
3618 const char *name
, enum language name_lang
,
3619 std::vector
<const char *> *result_names
)
3621 size_t old_len
= result_names
->size ();
3625 std::vector
<struct type
*> new_supers
;
3627 for (type
*t
: superclasses
)
3628 find_methods (t
, name_lang
, name
, result_names
, &new_supers
);
3630 if (result_names
->size () != old_len
|| new_supers
.empty ())
3633 superclasses
= std::move (new_supers
);
3637 /* This finds the method METHOD_NAME in the class CLASS_NAME whose type is
3638 given by one of the symbols in SYM_CLASSES. Matches are returned
3639 in SYMBOLS (for debug symbols) and MINSYMS (for minimal symbols). */
3642 find_method (struct linespec_state
*self
, std::vector
<symtab
*> *file_symtabs
,
3643 const char *class_name
, const char *method_name
,
3644 std::vector
<block_symbol
> *sym_classes
,
3645 std::vector
<block_symbol
> *symbols
,
3646 std::vector
<bound_minimal_symbol
> *minsyms
)
3648 size_t last_result_len
;
3649 std::vector
<struct type
*> superclass_vec
;
3650 std::vector
<const char *> result_names
;
3651 struct collect_info info
;
3653 /* Sort symbols so that symbols with the same program space are next
3655 std::sort (sym_classes
->begin (), sym_classes
->end (),
3659 info
.file_symtabs
= file_symtabs
;
3660 info
.result
.symbols
= symbols
;
3661 info
.result
.minimal_symbols
= minsyms
;
3663 /* Iterate over all the types, looking for the names of existing
3664 methods matching METHOD_NAME. If we cannot find a direct method in a
3665 given program space, then we consider inherited methods; this is
3666 not ideal (ideal would be to respect C++ hiding rules), but it
3667 seems good enough and is what GDB has historically done. We only
3668 need to collect the names because later we find all symbols with
3669 those names. This loop is written in a somewhat funny way
3670 because we collect data across the program space before deciding
3672 last_result_len
= 0;
3673 for (const auto &elt
: *sym_classes
)
3676 struct program_space
*pspace
;
3677 struct symbol
*sym
= elt
.symbol
;
3678 unsigned int ix
= &elt
- &*sym_classes
->begin ();
3680 /* Program spaces that are executing startup should have
3681 been filtered out earlier. */
3682 pspace
= SYMTAB_PSPACE (symbol_symtab (sym
));
3683 gdb_assert (!pspace
->executing_startup
);
3684 set_current_program_space (pspace
);
3685 t
= check_typedef (SYMBOL_TYPE (sym
));
3686 find_methods (t
, sym
->language (),
3687 method_name
, &result_names
, &superclass_vec
);
3689 /* Handle all items from a single program space at once; and be
3690 sure not to miss the last batch. */
3691 if (ix
== sym_classes
->size () - 1
3693 != SYMTAB_PSPACE (symbol_symtab (sym_classes
->at (ix
+ 1).symbol
))))
3695 /* If we did not find a direct implementation anywhere in
3696 this program space, consider superclasses. */
3697 if (result_names
.size () == last_result_len
)
3698 find_superclass_methods (std::move (superclass_vec
), method_name
,
3699 sym
->language (), &result_names
);
3701 /* We have a list of candidate symbol names, so now we
3702 iterate over the symbol tables looking for all
3703 matches in this pspace. */
3704 add_all_symbol_names_from_pspace (&info
, pspace
, result_names
,
3707 superclass_vec
.clear ();
3708 last_result_len
= result_names
.size ();
3712 if (!symbols
->empty () || !minsyms
->empty ())
3715 /* Throw an NOT_FOUND_ERROR. This will be caught by the caller
3716 and other attempts to locate the symbol will be made. */
3717 throw_error (NOT_FOUND_ERROR
, _("see caller, this text doesn't matter"));
3724 /* This function object is a callback for iterate_over_symtabs, used
3725 when collecting all matching symtabs. */
3727 class symtab_collector
3732 m_symtab_table
= htab_create (1, htab_hash_pointer
, htab_eq_pointer
,
3736 ~symtab_collector ()
3738 if (m_symtab_table
!= NULL
)
3739 htab_delete (m_symtab_table
);
3742 /* Callable as a symbol_found_callback_ftype callback. */
3743 bool operator () (symtab
*sym
);
3745 /* Return an rvalue reference to the collected symtabs. */
3746 std::vector
<symtab
*> &&release_symtabs ()
3748 return std::move (m_symtabs
);
3752 /* The result vector of symtabs. */
3753 std::vector
<symtab
*> m_symtabs
;
3755 /* This is used to ensure the symtabs are unique. */
3756 htab_t m_symtab_table
;
3760 symtab_collector::operator () (struct symtab
*symtab
)
3764 slot
= htab_find_slot (m_symtab_table
, symtab
, INSERT
);
3768 m_symtabs
.push_back (symtab
);
3776 /* Given a file name, return a list of all matching symtabs. If
3777 SEARCH_PSPACE is not NULL, the search is restricted to just that
3780 static std::vector
<symtab
*>
3781 collect_symtabs_from_filename (const char *file
,
3782 struct program_space
*search_pspace
)
3784 symtab_collector collector
;
3786 /* Find that file's data. */
3787 if (search_pspace
== NULL
)
3789 struct program_space
*pspace
;
3791 ALL_PSPACES (pspace
)
3793 if (pspace
->executing_startup
)
3796 set_current_program_space (pspace
);
3797 iterate_over_symtabs (file
, collector
);
3802 set_current_program_space (search_pspace
);
3803 iterate_over_symtabs (file
, collector
);
3806 return collector
.release_symtabs ();
3809 /* Return all the symtabs associated to the FILENAME. If SEARCH_PSPACE is
3810 not NULL, the search is restricted to just that program space. */
3812 static std::vector
<symtab
*>
3813 symtabs_from_filename (const char *filename
,
3814 struct program_space
*search_pspace
)
3816 std::vector
<symtab
*> result
3817 = collect_symtabs_from_filename (filename
, search_pspace
);
3819 if (result
.empty ())
3821 if (!have_full_symbols () && !have_partial_symbols ())
3822 throw_error (NOT_FOUND_ERROR
,
3823 _("No symbol table is loaded. "
3824 "Use the \"file\" command."));
3825 source_file_not_found_error (filename
);
3834 symbol_searcher::find_all_symbols (const std::string
&name
,
3835 const struct language_defn
*language
,
3836 enum search_domain search_domain
,
3837 std::vector
<symtab
*> *search_symtabs
,
3838 struct program_space
*search_pspace
)
3840 symbol_searcher_collect_info info
;
3841 struct linespec_state state
;
3843 memset (&state
, 0, sizeof (state
));
3844 state
.language
= language
;
3845 info
.state
= &state
;
3847 info
.result
.symbols
= &m_symbols
;
3848 info
.result
.minimal_symbols
= &m_minimal_symbols
;
3849 std::vector
<symtab
*> all_symtabs
;
3850 if (search_symtabs
== nullptr)
3852 all_symtabs
.push_back (nullptr);
3853 search_symtabs
= &all_symtabs
;
3855 info
.file_symtabs
= search_symtabs
;
3857 add_matching_symbols_to_info (name
.c_str (), symbol_name_match_type::WILD
,
3858 search_domain
, &info
, search_pspace
);
3861 /* Look up a function symbol named NAME in symtabs FILE_SYMTABS. Matching
3862 debug symbols are returned in SYMBOLS. Matching minimal symbols are
3863 returned in MINSYMS. */
3866 find_function_symbols (struct linespec_state
*state
,
3867 std::vector
<symtab
*> *file_symtabs
, const char *name
,
3868 symbol_name_match_type name_match_type
,
3869 std::vector
<block_symbol
> *symbols
,
3870 std::vector
<bound_minimal_symbol
> *minsyms
)
3872 struct collect_info info
;
3873 std::vector
<const char *> symbol_names
;
3876 info
.result
.symbols
= symbols
;
3877 info
.result
.minimal_symbols
= minsyms
;
3878 info
.file_symtabs
= file_symtabs
;
3880 /* Try NAME as an Objective-C selector. */
3881 find_imps (name
, &symbol_names
);
3882 if (!symbol_names
.empty ())
3883 add_all_symbol_names_from_pspace (&info
, state
->search_pspace
,
3884 symbol_names
, FUNCTIONS_DOMAIN
);
3886 add_matching_symbols_to_info (name
, name_match_type
, FUNCTIONS_DOMAIN
,
3887 &info
, state
->search_pspace
);
3890 /* Find all symbols named NAME in FILE_SYMTABS, returning debug symbols
3891 in SYMBOLS and minimal symbols in MINSYMS. */
3894 find_linespec_symbols (struct linespec_state
*state
,
3895 std::vector
<symtab
*> *file_symtabs
,
3896 const char *lookup_name
,
3897 symbol_name_match_type name_match_type
,
3898 std::vector
<block_symbol
> *symbols
,
3899 std::vector
<bound_minimal_symbol
> *minsyms
)
3901 gdb::unique_xmalloc_ptr
<char> canon
3902 = cp_canonicalize_string_no_typedefs (lookup_name
);
3903 if (canon
!= nullptr)
3904 lookup_name
= canon
.get ();
3906 /* It's important to not call expand_symtabs_matching unnecessarily
3907 as it can really slow things down (by unnecessarily expanding
3908 potentially 1000s of symtabs, which when debugging some apps can
3909 cost 100s of seconds). Avoid this to some extent by *first* calling
3910 find_function_symbols, and only if that doesn't find anything
3911 *then* call find_method. This handles two important cases:
3912 1) break (anonymous namespace)::foo
3913 2) break class::method where method is in class (and not a baseclass) */
3915 find_function_symbols (state
, file_symtabs
, lookup_name
,
3916 name_match_type
, symbols
, minsyms
);
3918 /* If we were unable to locate a symbol of the same name, try dividing
3919 the name into class and method names and searching the class and its
3921 if (symbols
->empty () && minsyms
->empty ())
3923 std::string klass
, method
;
3924 const char *last
, *p
, *scope_op
;
3926 /* See if we can find a scope operator and break this symbol
3927 name into namespaces${SCOPE_OPERATOR}class_name and method_name. */
3929 p
= find_toplevel_string (lookup_name
, scope_op
);
3935 p
= find_toplevel_string (p
+ strlen (scope_op
), scope_op
);
3938 /* If no scope operator was found, there is nothing more we can do;
3939 we already attempted to lookup the entire name as a symbol
3944 /* LOOKUP_NAME points to the class name.
3945 LAST points to the method name. */
3946 klass
= std::string (lookup_name
, last
- lookup_name
);
3948 /* Skip past the scope operator. */
3949 last
+= strlen (scope_op
);
3952 /* Find a list of classes named KLASS. */
3953 std::vector
<block_symbol
> classes
3954 = lookup_prefix_sym (state
, file_symtabs
, klass
.c_str ());
3955 if (!classes
.empty ())
3957 /* Now locate a list of suitable methods named METHOD. */
3960 find_method (state
, file_symtabs
,
3961 klass
.c_str (), method
.c_str (),
3962 &classes
, symbols
, minsyms
);
3965 /* If successful, we're done. If NOT_FOUND_ERROR
3966 was not thrown, rethrow the exception that we did get. */
3967 catch (const gdb_exception_error
&except
)
3969 if (except
.error
!= NOT_FOUND_ERROR
)
3976 /* Helper for find_label_symbols. Find all labels that match name
3977 NAME in BLOCK. Return all labels that match in FUNCTION_SYMBOLS.
3978 Return the actual function symbol in which the label was found in
3979 LABEL_FUNC_RET. If COMPLETION_MODE is true, then NAME is
3980 interpreted as a label name prefix. Otherwise, only a label named
3981 exactly NAME match. */
3984 find_label_symbols_in_block (const struct block
*block
,
3985 const char *name
, struct symbol
*fn_sym
,
3986 bool completion_mode
,
3987 std::vector
<block_symbol
> *result
,
3988 std::vector
<block_symbol
> *label_funcs_ret
)
3990 if (completion_mode
)
3992 struct block_iterator iter
;
3994 size_t name_len
= strlen (name
);
3996 int (*cmp
) (const char *, const char *, size_t);
3997 cmp
= case_sensitivity
== case_sensitive_on
? strncmp
: strncasecmp
;
3999 ALL_BLOCK_SYMBOLS (block
, iter
, sym
)
4001 if (symbol_matches_domain (sym
->language (),
4002 SYMBOL_DOMAIN (sym
), LABEL_DOMAIN
)
4003 && cmp (sym
->search_name (), name
, name_len
) == 0)
4005 result
->push_back ({sym
, block
});
4006 label_funcs_ret
->push_back ({fn_sym
, block
});
4012 struct block_symbol label_sym
4013 = lookup_symbol (name
, block
, LABEL_DOMAIN
, 0);
4015 if (label_sym
.symbol
!= NULL
)
4017 result
->push_back (label_sym
);
4018 label_funcs_ret
->push_back ({fn_sym
, block
});
4023 /* Return all labels that match name NAME in FUNCTION_SYMBOLS or NULL
4024 if no matches were found.
4026 Return the actual function symbol in which the label was found in
4027 LABEL_FUNC_RET. If COMPLETION_MODE is true, then NAME is
4028 interpreted as a label name prefix. Otherwise, only labels named
4029 exactly NAME match. */
4032 static std::vector
<block_symbol
> *
4033 find_label_symbols (struct linespec_state
*self
,
4034 std::vector
<block_symbol
> *function_symbols
,
4035 std::vector
<block_symbol
> *label_funcs_ret
,
4037 bool completion_mode
)
4039 const struct block
*block
;
4040 struct symbol
*fn_sym
;
4041 std::vector
<block_symbol
> result
;
4043 if (function_symbols
== NULL
)
4045 set_current_program_space (self
->program_space
);
4046 block
= get_current_search_block ();
4049 block
&& !BLOCK_FUNCTION (block
);
4050 block
= BLOCK_SUPERBLOCK (block
))
4054 fn_sym
= BLOCK_FUNCTION (block
);
4056 find_label_symbols_in_block (block
, name
, fn_sym
, completion_mode
,
4057 &result
, label_funcs_ret
);
4061 for (const auto &elt
: *function_symbols
)
4063 fn_sym
= elt
.symbol
;
4064 set_current_program_space (SYMTAB_PSPACE (symbol_symtab (fn_sym
)));
4065 block
= SYMBOL_BLOCK_VALUE (fn_sym
);
4067 find_label_symbols_in_block (block
, name
, fn_sym
, completion_mode
,
4068 &result
, label_funcs_ret
);
4072 if (!result
.empty ())
4073 return new std::vector
<block_symbol
> (std::move (result
));
4079 /* A helper for create_sals_line_offset that handles the 'list_mode' case. */
4081 static std::vector
<symtab_and_line
>
4082 decode_digits_list_mode (struct linespec_state
*self
,
4084 struct symtab_and_line val
)
4086 gdb_assert (self
->list_mode
);
4088 std::vector
<symtab_and_line
> values
;
4090 for (const auto &elt
: *ls
->file_symtabs
)
4092 /* The logic above should ensure this. */
4093 gdb_assert (elt
!= NULL
);
4095 set_current_program_space (SYMTAB_PSPACE (elt
));
4097 /* Simplistic search just for the list command. */
4098 val
.symtab
= find_line_symtab (elt
, val
.line
, NULL
, NULL
);
4099 if (val
.symtab
== NULL
)
4101 val
.pspace
= SYMTAB_PSPACE (elt
);
4103 val
.explicit_line
= true;
4105 add_sal_to_sals (self
, &values
, &val
, NULL
, 0);
4111 /* A helper for create_sals_line_offset that iterates over the symtabs
4112 associated with LS and returns a vector of corresponding symtab_and_line
4115 static std::vector
<symtab_and_line
>
4116 decode_digits_ordinary (struct linespec_state
*self
,
4119 struct linetable_entry
**best_entry
)
4121 std::vector
<symtab_and_line
> sals
;
4122 for (const auto &elt
: *ls
->file_symtabs
)
4124 std::vector
<CORE_ADDR
> pcs
;
4126 /* The logic above should ensure this. */
4127 gdb_assert (elt
!= NULL
);
4129 set_current_program_space (SYMTAB_PSPACE (elt
));
4131 pcs
= find_pcs_for_symtab_line (elt
, line
, best_entry
);
4132 for (CORE_ADDR pc
: pcs
)
4134 symtab_and_line sal
;
4135 sal
.pspace
= SYMTAB_PSPACE (elt
);
4138 sal
.explicit_line
= true;
4140 sals
.push_back (std::move (sal
));
4149 /* Return the line offset represented by VARIABLE. */
4151 static struct line_offset
4152 linespec_parse_variable (struct linespec_state
*self
, const char *variable
)
4156 struct line_offset offset
= {0, LINE_OFFSET_NONE
};
4158 p
= (variable
[1] == '$') ? variable
+ 2 : variable
+ 1;
4161 while (*p
>= '0' && *p
<= '9')
4163 if (!*p
) /* Reached end of token without hitting non-digit. */
4165 /* We have a value history reference. */
4166 struct value
*val_history
;
4168 sscanf ((variable
[1] == '$') ? variable
+ 2 : variable
+ 1, "%d", &index
);
4170 = access_value_history ((variable
[1] == '$') ? -index
: index
);
4171 if (TYPE_CODE (value_type (val_history
)) != TYPE_CODE_INT
)
4172 error (_("History values used in line "
4173 "specs must have integer values."));
4174 offset
.offset
= value_as_long (val_history
);
4178 /* Not all digits -- may be user variable/function or a
4179 convenience variable. */
4181 struct internalvar
*ivar
;
4183 /* Try it as a convenience variable. If it is not a convenience
4184 variable, return and allow normal symbol lookup to occur. */
4185 ivar
= lookup_only_internalvar (variable
+ 1);
4187 /* No internal variable with that name. Mark the offset
4188 as unknown to allow the name to be looked up as a symbol. */
4189 offset
.sign
= LINE_OFFSET_UNKNOWN
;
4192 /* We found a valid variable name. If it is not an integer,
4194 if (!get_internalvar_integer (ivar
, &valx
))
4195 error (_("Convenience variables used in line "
4196 "specs must have integer values."));
4198 offset
.offset
= valx
;
4206 /* We've found a minimal symbol MSYMBOL in OBJFILE to associate with our
4207 linespec; return the SAL in RESULT. This function should return SALs
4208 matching those from find_function_start_sal, otherwise false
4209 multiple-locations breakpoints could be placed. */
4212 minsym_found (struct linespec_state
*self
, struct objfile
*objfile
,
4213 struct minimal_symbol
*msymbol
,
4214 std::vector
<symtab_and_line
> *result
)
4216 bool want_start_sal
;
4218 CORE_ADDR func_addr
;
4219 bool is_function
= msymbol_is_function (objfile
, msymbol
, &func_addr
);
4223 const char *msym_name
= msymbol
->linkage_name ();
4225 if (MSYMBOL_TYPE (msymbol
) == mst_text_gnu_ifunc
4226 || MSYMBOL_TYPE (msymbol
) == mst_data_gnu_ifunc
)
4227 want_start_sal
= gnu_ifunc_resolve_name (msym_name
, &func_addr
);
4229 want_start_sal
= true;
4232 symtab_and_line sal
;
4234 if (is_function
&& want_start_sal
)
4235 sal
= find_function_start_sal (func_addr
, NULL
, self
->funfirstline
);
4238 sal
.objfile
= objfile
;
4239 sal
.msymbol
= msymbol
;
4240 /* Store func_addr, not the minsym's address in case this was an
4241 ifunc that hasn't been resolved yet. */
4245 sal
.pc
= MSYMBOL_VALUE_ADDRESS (objfile
, msymbol
);
4246 sal
.pspace
= current_program_space
;
4249 sal
.section
= MSYMBOL_OBJ_SECTION (objfile
, msymbol
);
4251 if (maybe_add_address (self
->addr_set
, objfile
->pspace
, sal
.pc
))
4252 add_sal_to_sals (self
, result
, &sal
, msymbol
->natural_name (), 0);
4255 /* A helper function to classify a minimal_symbol_type according to
4259 classify_mtype (enum minimal_symbol_type t
)
4266 /* Intermediate priority. */
4269 case mst_solib_trampoline
:
4270 /* Lowest priority. */
4274 /* Highest priority. */
4279 /* Callback for std::sort that sorts symbols by priority. */
4282 compare_msyms (const bound_minimal_symbol
&a
, const bound_minimal_symbol
&b
)
4284 enum minimal_symbol_type ta
= MSYMBOL_TYPE (a
.minsym
);
4285 enum minimal_symbol_type tb
= MSYMBOL_TYPE (b
.minsym
);
4287 return classify_mtype (ta
) < classify_mtype (tb
);
4290 /* Helper for search_minsyms_for_name that adds the symbol to the
4294 add_minsym (struct minimal_symbol
*minsym
, struct objfile
*objfile
,
4295 struct symtab
*symtab
, int list_mode
,
4296 std::vector
<struct bound_minimal_symbol
> *msyms
)
4300 /* We're looking for a label for which we don't have debug
4302 CORE_ADDR func_addr
;
4303 if (msymbol_is_function (objfile
, minsym
, &func_addr
))
4305 symtab_and_line sal
= find_pc_sect_line (func_addr
, NULL
, 0);
4307 if (symtab
!= sal
.symtab
)
4312 /* Exclude data symbols when looking for breakpoint locations. */
4313 if (!list_mode
&& !msymbol_is_function (objfile
, minsym
))
4316 struct bound_minimal_symbol mo
= {minsym
, objfile
};
4317 msyms
->push_back (mo
);
4321 /* Search for minimal symbols called NAME. If SEARCH_PSPACE
4322 is not NULL, the search is restricted to just that program
4325 If SYMTAB is NULL, search all objfiles, otherwise
4326 restrict results to the given SYMTAB. */
4329 search_minsyms_for_name (struct collect_info
*info
,
4330 const lookup_name_info
&name
,
4331 struct program_space
*search_pspace
,
4332 struct symtab
*symtab
)
4334 std::vector
<struct bound_minimal_symbol
> minsyms
;
4338 struct program_space
*pspace
;
4340 ALL_PSPACES (pspace
)
4342 if (search_pspace
!= NULL
&& search_pspace
!= pspace
)
4344 if (pspace
->executing_startup
)
4347 set_current_program_space (pspace
);
4349 for (objfile
*objfile
: current_program_space
->objfiles ())
4351 iterate_over_minimal_symbols (objfile
, name
,
4352 [&] (struct minimal_symbol
*msym
)
4354 add_minsym (msym
, objfile
, nullptr,
4355 info
->state
->list_mode
,
4364 if (search_pspace
== NULL
|| SYMTAB_PSPACE (symtab
) == search_pspace
)
4366 set_current_program_space (SYMTAB_PSPACE (symtab
));
4367 iterate_over_minimal_symbols
4368 (SYMTAB_OBJFILE (symtab
), name
,
4369 [&] (struct minimal_symbol
*msym
)
4371 add_minsym (msym
, SYMTAB_OBJFILE (symtab
), symtab
,
4372 info
->state
->list_mode
, &minsyms
);
4378 if (!minsyms
.empty ())
4382 std::sort (minsyms
.begin (), minsyms
.end (), compare_msyms
);
4384 /* Now the minsyms are in classification order. So, we walk
4385 over them and process just the minsyms with the same
4386 classification as the very first minsym in the list. */
4387 classification
= classify_mtype (MSYMBOL_TYPE (minsyms
[0].minsym
));
4389 for (const bound_minimal_symbol
&item
: minsyms
)
4391 if (classify_mtype (MSYMBOL_TYPE (item
.minsym
)) != classification
)
4394 info
->result
.minimal_symbols
->push_back (item
);
4399 /* A helper function to add all symbols matching NAME to INFO. If
4400 PSPACE is not NULL, the search is restricted to just that program
4404 add_matching_symbols_to_info (const char *name
,
4405 symbol_name_match_type name_match_type
,
4406 enum search_domain search_domain
,
4407 struct collect_info
*info
,
4408 struct program_space
*pspace
)
4410 lookup_name_info
lookup_name (name
, name_match_type
);
4412 for (const auto &elt
: *info
->file_symtabs
)
4416 iterate_over_all_matching_symtabs (info
->state
, lookup_name
,
4417 VAR_DOMAIN
, search_domain
,
4419 [&] (block_symbol
*bsym
)
4420 { return info
->add_symbol (bsym
); });
4421 search_minsyms_for_name (info
, lookup_name
, pspace
, NULL
);
4423 else if (pspace
== NULL
|| pspace
== SYMTAB_PSPACE (elt
))
4425 int prev_len
= info
->result
.symbols
->size ();
4427 /* Program spaces that are executing startup should have
4428 been filtered out earlier. */
4429 gdb_assert (!SYMTAB_PSPACE (elt
)->executing_startup
);
4430 set_current_program_space (SYMTAB_PSPACE (elt
));
4431 iterate_over_file_blocks (elt
, lookup_name
, VAR_DOMAIN
,
4432 [&] (block_symbol
*bsym
)
4433 { return info
->add_symbol (bsym
); });
4435 /* If no new symbols were found in this iteration and this symtab
4436 is in assembler, we might actually be looking for a label for
4437 which we don't have debug info. Check for a minimal symbol in
4439 if (prev_len
== info
->result
.symbols
->size ()
4440 && elt
->language
== language_asm
)
4441 search_minsyms_for_name (info
, lookup_name
, pspace
, elt
);
4448 /* Now come some functions that are called from multiple places within
4452 symbol_to_sal (struct symtab_and_line
*result
,
4453 int funfirstline
, struct symbol
*sym
)
4455 if (SYMBOL_CLASS (sym
) == LOC_BLOCK
)
4457 *result
= find_function_start_sal (sym
, funfirstline
);
4462 if (SYMBOL_CLASS (sym
) == LOC_LABEL
&& SYMBOL_VALUE_ADDRESS (sym
) != 0)
4465 result
->symtab
= symbol_symtab (sym
);
4466 result
->symbol
= sym
;
4467 result
->line
= SYMBOL_LINE (sym
);
4468 result
->pc
= SYMBOL_VALUE_ADDRESS (sym
);
4469 result
->pspace
= SYMTAB_PSPACE (result
->symtab
);
4470 result
->explicit_pc
= 1;
4473 else if (funfirstline
)
4477 else if (SYMBOL_LINE (sym
) != 0)
4479 /* We know its line number. */
4481 result
->symtab
= symbol_symtab (sym
);
4482 result
->symbol
= sym
;
4483 result
->line
= SYMBOL_LINE (sym
);
4484 result
->pc
= SYMBOL_VALUE_ADDRESS (sym
);
4485 result
->pspace
= SYMTAB_PSPACE (result
->symtab
);
4493 linespec_result::~linespec_result ()
4495 for (linespec_sals
&lsal
: lsals
)
4496 xfree (lsal
.canonical
);
4499 /* Return the quote characters permitted by the linespec parser. */
4502 get_gdb_linespec_parser_quote_characters (void)
4504 return linespec_quote_characters
;