1 /* Parser for linespec for the GNU debugger, GDB.
3 Copyright (C) 1986-2019 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
29 #include "completer.h"
31 #include "cp-support.h"
32 #include "parser-defs.h"
34 #include "objc-lang.h"
38 #include "mi/mi-cmds.h"
40 #include "arch-utils.h"
42 #include "cli/cli-utils.h"
43 #include "filenames.h"
47 #include "common/function-view.h"
48 #include "common/def-vector.h"
51 /* An enumeration of the various things a user might attempt to
52 complete for a linespec location. */
54 enum class linespec_complete_what
56 /* Nothing, no possible completion. */
59 /* A function/method name. Due to ambiguity between
65 this can also indicate a source filename, iff we haven't seen a
66 separate source filename component, as in "b source.c:function". */
69 /* A label symbol. E.g., break file.c:function:LABEL. */
72 /* An expression. E.g., "break foo if EXPR", or "break *EXPR". */
75 /* A linespec keyword ("if"/"thread"/"task").
76 E.g., "break func threa<tab>". */
80 /* An address entry is used to ensure that any given location is only
81 added to the result a single time. It holds an address and the
82 program space from which the address came. */
86 struct program_space
*pspace
;
90 /* A linespec. Elements of this structure are filled in by a parser
91 (either parse_linespec or some other function). The structure is
92 then converted into SALs by convert_linespec_to_sals. */
96 /* An explicit location describing the SaLs. */
97 struct explicit_location explicit_loc
;
99 /* The list of symtabs to search to which to limit the search. May not
100 be NULL. If explicit.SOURCE_FILENAME is NULL (no user-specified
101 filename), FILE_SYMTABS should contain one single NULL member. This
102 will cause the code to use the default symtab. */
103 std::vector
<symtab
*> *file_symtabs
;
105 /* A list of matching function symbols and minimal symbols. Both lists
106 may be NULL (or empty) if no matching symbols were found. */
107 std::vector
<block_symbol
> *function_symbols
;
108 std::vector
<bound_minimal_symbol
> *minimal_symbols
;
110 /* A structure of matching label symbols and the corresponding
111 function symbol in which the label was found. Both may be NULL
112 or both must be non-NULL. */
115 std::vector
<block_symbol
> *label_symbols
;
116 std::vector
<block_symbol
> *function_symbols
;
119 typedef struct linespec
*linespec_p
;
121 /* A canonical linespec represented as a symtab-related string.
123 Each entry represents the "SYMTAB:SUFFIX" linespec string.
124 SYMTAB can be converted for example by symtab_to_fullname or
125 symtab_to_filename_for_display as needed. */
127 struct linespec_canonical_name
129 /* Remaining text part of the linespec string. */
132 /* If NULL then SUFFIX is the whole linespec string. */
133 struct symtab
*symtab
;
136 /* An instance of this is used to keep all state while linespec
137 operates. This instance is passed around as a 'this' pointer to
138 the various implementation methods. */
140 struct linespec_state
142 /* The language in use during linespec processing. */
143 const struct language_defn
*language
;
145 /* The program space as seen when the module was entered. */
146 struct program_space
*program_space
;
148 /* If not NULL, the search is restricted to just this program
150 struct program_space
*search_pspace
;
152 /* The default symtab to use, if no other symtab is specified. */
153 struct symtab
*default_symtab
;
155 /* The default line to use. */
158 /* The 'funfirstline' value that was passed in to decode_line_1 or
162 /* Nonzero if we are running in 'list' mode; see decode_line_list. */
165 /* The 'canonical' value passed to decode_line_full, or NULL. */
166 struct linespec_result
*canonical
;
168 /* Canonical strings that mirror the std::vector<symtab_and_line> result. */
169 struct linespec_canonical_name
*canonical_names
;
171 /* This is a set of address_entry objects which is used to prevent
172 duplicate symbols from being entered into the result. */
175 /* Are we building a linespec? */
179 /* This is a helper object that is used when collecting symbols into a
184 /* The linespec object in use. */
185 struct linespec_state
*state
;
187 /* A list of symtabs to which to restrict matches. */
188 std::vector
<symtab
*> *file_symtabs
;
190 /* The result being accumulated. */
193 std::vector
<block_symbol
> *symbols
;
194 std::vector
<bound_minimal_symbol
> *minimal_symbols
;
197 /* Possibly add a symbol to the results. */
198 virtual bool add_symbol (block_symbol
*bsym
);
202 collect_info::add_symbol (block_symbol
*bsym
)
204 /* In list mode, add all matching symbols, regardless of class.
205 This allows the user to type "list a_global_variable". */
206 if (SYMBOL_CLASS (bsym
->symbol
) == LOC_BLOCK
|| this->state
->list_mode
)
207 this->result
.symbols
->push_back (*bsym
);
209 /* Continue iterating. */
213 /* Custom collect_info for symbol_searcher. */
215 struct symbol_searcher_collect_info
218 bool add_symbol (block_symbol
*bsym
) override
220 /* Add everything. */
221 this->result
.symbols
->push_back (*bsym
);
223 /* Continue iterating. */
235 /* A colon "separator" */
247 /* EOI (end of input) */
253 typedef enum ls_token_type linespec_token_type
;
255 /* List of keywords. This is NULL-terminated so that it can be used
256 as enum completer. */
257 const char * const linespec_keywords
[] = { "if", "thread", "task", NULL
};
258 #define IF_KEYWORD_INDEX 0
260 /* A token of the linespec lexer */
264 /* The type of the token */
265 linespec_token_type type
;
267 /* Data for the token */
270 /* A string, given as a stoken */
271 struct stoken string
;
277 typedef struct ls_token linespec_token
;
279 #define LS_TOKEN_STOKEN(TOK) (TOK).data.string
280 #define LS_TOKEN_KEYWORD(TOK) (TOK).data.keyword
282 /* An instance of the linespec parser. */
284 struct linespec_parser
286 linespec_parser (int flags
, const struct language_defn
*language
,
287 struct program_space
*search_pspace
,
288 struct symtab
*default_symtab
,
290 struct linespec_result
*canonical
);
294 DISABLE_COPY_AND_ASSIGN (linespec_parser
);
296 /* Lexer internal data */
299 /* Save head of input stream. */
300 const char *saved_arg
;
302 /* Head of the input stream. */
304 #define PARSER_STREAM(P) ((P)->lexer.stream)
306 /* The current token. */
307 linespec_token current
;
310 /* Is the entire linespec quote-enclosed? */
311 int is_quote_enclosed
= 0;
313 /* The state of the parse. */
314 struct linespec_state state
{};
315 #define PARSER_STATE(PPTR) (&(PPTR)->state)
317 /* The result of the parse. */
318 struct linespec result
{};
319 #define PARSER_RESULT(PPTR) (&(PPTR)->result)
321 /* What the parser believes the current word point should complete
323 linespec_complete_what complete_what
= linespec_complete_what::NOTHING
;
325 /* The completion word point. The parser advances this as it skips
326 tokens. At some point the input string will end or parsing will
327 fail, and then we attempt completion at the captured completion
328 word point, interpreting the string at completion_word as
330 const char *completion_word
= nullptr;
332 /* If the current token was a quoted string, then this is the
333 quoting character (either " or '). */
334 int completion_quote_char
= 0;
336 /* If the current token was a quoted string, then this points at the
337 end of the quoted string. */
338 const char *completion_quote_end
= nullptr;
340 /* If parsing for completion, then this points at the completion
341 tracker. Otherwise, this is NULL. */
342 struct completion_tracker
*completion_tracker
= nullptr;
345 /* A convenience macro for accessing the explicit location result of
347 #define PARSER_EXPLICIT(PPTR) (&PARSER_RESULT ((PPTR))->explicit_loc)
349 /* Prototypes for local functions. */
351 static void iterate_over_file_blocks
352 (struct symtab
*symtab
, const lookup_name_info
&name
,
354 gdb::function_view
<symbol_found_callback_ftype
> callback
);
356 static void initialize_defaults (struct symtab
**default_symtab
,
359 CORE_ADDR
linespec_expression_to_pc (const char **exp_ptr
);
361 static std::vector
<symtab_and_line
> decode_objc (struct linespec_state
*self
,
365 static std::vector
<symtab
*> symtabs_from_filename
366 (const char *, struct program_space
*pspace
);
368 static std::vector
<block_symbol
> *find_label_symbols
369 (struct linespec_state
*self
, std::vector
<block_symbol
> *function_symbols
,
370 std::vector
<block_symbol
> *label_funcs_ret
, const char *name
,
371 bool completion_mode
= false);
373 static void find_linespec_symbols (struct linespec_state
*self
,
374 std::vector
<symtab
*> *file_symtabs
,
376 symbol_name_match_type name_match_type
,
377 std::vector
<block_symbol
> *symbols
,
378 std::vector
<bound_minimal_symbol
> *minsyms
);
380 static struct line_offset
381 linespec_parse_variable (struct linespec_state
*self
,
382 const char *variable
);
384 static int symbol_to_sal (struct symtab_and_line
*result
,
385 int funfirstline
, struct symbol
*sym
);
387 static void add_matching_symbols_to_info (const char *name
,
388 symbol_name_match_type name_match_type
,
389 enum search_domain search_domain
,
390 struct collect_info
*info
,
391 struct program_space
*pspace
);
393 static void add_all_symbol_names_from_pspace
394 (struct collect_info
*info
, struct program_space
*pspace
,
395 const std::vector
<const char *> &names
, enum search_domain search_domain
);
397 static std::vector
<symtab
*>
398 collect_symtabs_from_filename (const char *file
,
399 struct program_space
*pspace
);
401 static std::vector
<symtab_and_line
> decode_digits_ordinary
402 (struct linespec_state
*self
,
405 linetable_entry
**best_entry
);
407 static std::vector
<symtab_and_line
> decode_digits_list_mode
408 (struct linespec_state
*self
,
410 struct symtab_and_line val
);
412 static void minsym_found (struct linespec_state
*self
, struct objfile
*objfile
,
413 struct minimal_symbol
*msymbol
,
414 std::vector
<symtab_and_line
> *result
);
416 static bool compare_symbols (const block_symbol
&a
, const block_symbol
&b
);
418 static bool compare_msymbols (const bound_minimal_symbol
&a
,
419 const bound_minimal_symbol
&b
);
421 /* Permitted quote characters for the parser. This is different from the
422 completer's quote characters to allow backward compatibility with the
424 static const char *const linespec_quote_characters
= "\"\'";
426 /* Lexer functions. */
428 /* Lex a number from the input in PARSER. This only supports
431 Return true if input is decimal numbers. Return false if not. */
434 linespec_lexer_lex_number (linespec_parser
*parser
, linespec_token
*tokenp
)
436 tokenp
->type
= LSTOKEN_NUMBER
;
437 LS_TOKEN_STOKEN (*tokenp
).length
= 0;
438 LS_TOKEN_STOKEN (*tokenp
).ptr
= PARSER_STREAM (parser
);
440 /* Keep any sign at the start of the stream. */
441 if (*PARSER_STREAM (parser
) == '+' || *PARSER_STREAM (parser
) == '-')
443 ++LS_TOKEN_STOKEN (*tokenp
).length
;
444 ++(PARSER_STREAM (parser
));
447 while (isdigit (*PARSER_STREAM (parser
)))
449 ++LS_TOKEN_STOKEN (*tokenp
).length
;
450 ++(PARSER_STREAM (parser
));
453 /* If the next character in the input buffer is not a space, comma,
454 quote, or colon, this input does not represent a number. */
455 if (*PARSER_STREAM (parser
) != '\0'
456 && !isspace (*PARSER_STREAM (parser
)) && *PARSER_STREAM (parser
) != ','
457 && *PARSER_STREAM (parser
) != ':'
458 && !strchr (linespec_quote_characters
, *PARSER_STREAM (parser
)))
460 PARSER_STREAM (parser
) = LS_TOKEN_STOKEN (*tokenp
).ptr
;
467 /* See linespec.h. */
470 linespec_lexer_lex_keyword (const char *p
)
476 for (i
= 0; linespec_keywords
[i
] != NULL
; ++i
)
478 int len
= strlen (linespec_keywords
[i
]);
480 /* If P begins with one of the keywords and the next
481 character is whitespace, we may have found a keyword.
482 It is only a keyword if it is not followed by another
484 if (strncmp (p
, linespec_keywords
[i
], len
) == 0
489 /* Special case: "if" ALWAYS stops the lexer, since it
490 is not possible to predict what is going to appear in
491 the condition, which can only be parsed after SaLs have
493 if (i
!= IF_KEYWORD_INDEX
)
497 for (j
= 0; linespec_keywords
[j
] != NULL
; ++j
)
499 int nextlen
= strlen (linespec_keywords
[j
]);
501 if (strncmp (p
, linespec_keywords
[j
], nextlen
) == 0
502 && isspace (p
[nextlen
]))
507 return linespec_keywords
[i
];
515 /* See description in linespec.h. */
518 is_ada_operator (const char *string
)
520 const struct ada_opname_map
*mapping
;
522 for (mapping
= ada_opname_table
;
523 mapping
->encoded
!= NULL
524 && !startswith (string
, mapping
->decoded
); ++mapping
)
527 return mapping
->decoded
== NULL
? 0 : strlen (mapping
->decoded
);
530 /* Find QUOTE_CHAR in STRING, accounting for the ':' terminal. Return
531 the location of QUOTE_CHAR, or NULL if not found. */
534 skip_quote_char (const char *string
, char quote_char
)
536 const char *p
, *last
;
538 p
= last
= find_toplevel_char (string
, quote_char
);
539 while (p
&& *p
!= '\0' && *p
!= ':')
541 p
= find_toplevel_char (p
, quote_char
);
549 /* Make a writable copy of the string given in TOKEN, trimming
550 any trailing whitespace. */
552 static gdb::unique_xmalloc_ptr
<char>
553 copy_token_string (linespec_token token
)
557 if (token
.type
== LSTOKEN_KEYWORD
)
558 return gdb::unique_xmalloc_ptr
<char> (xstrdup (LS_TOKEN_KEYWORD (token
)));
560 str
= LS_TOKEN_STOKEN (token
).ptr
;
561 s
= remove_trailing_whitespace (str
, str
+ LS_TOKEN_STOKEN (token
).length
);
563 return gdb::unique_xmalloc_ptr
<char> (savestring (str
, s
- str
));
566 /* Does P represent the end of a quote-enclosed linespec? */
569 is_closing_quote_enclosed (const char *p
)
571 if (strchr (linespec_quote_characters
, *p
))
573 p
= skip_spaces ((char *) p
);
574 return (*p
== '\0' || linespec_lexer_lex_keyword (p
));
577 /* Find the end of the parameter list that starts with *INPUT.
578 This helper function assists with lexing string segments
579 which might contain valid (non-terminating) commas. */
582 find_parameter_list_end (const char *input
)
584 char end_char
, start_char
;
589 if (start_char
== '(')
591 else if (start_char
== '<')
600 if (*p
== start_char
)
602 else if (*p
== end_char
)
616 /* If the [STRING, STRING_LEN) string ends with what looks like a
617 keyword, return the keyword start offset in STRING. Return -1
621 string_find_incomplete_keyword_at_end (const char * const *keywords
,
622 const char *string
, size_t string_len
)
624 const char *end
= string
+ string_len
;
627 while (p
> string
&& *p
!= ' ')
632 size_t len
= end
- p
;
633 for (size_t i
= 0; keywords
[i
] != NULL
; ++i
)
634 if (strncmp (keywords
[i
], p
, len
) == 0)
641 /* Lex a string from the input in PARSER. */
643 static linespec_token
644 linespec_lexer_lex_string (linespec_parser
*parser
)
646 linespec_token token
;
647 const char *start
= PARSER_STREAM (parser
);
649 token
.type
= LSTOKEN_STRING
;
651 /* If the input stream starts with a quote character, skip to the next
652 quote character, regardless of the content. */
653 if (strchr (linespec_quote_characters
, *PARSER_STREAM (parser
)))
656 char quote_char
= *PARSER_STREAM (parser
);
658 /* Special case: Ada operators. */
659 if (PARSER_STATE (parser
)->language
->la_language
== language_ada
660 && quote_char
== '\"')
662 int len
= is_ada_operator (PARSER_STREAM (parser
));
666 /* The input is an Ada operator. Return the quoted string
668 LS_TOKEN_STOKEN (token
).ptr
= PARSER_STREAM (parser
);
669 LS_TOKEN_STOKEN (token
).length
= len
;
670 PARSER_STREAM (parser
) += len
;
674 /* The input does not represent an Ada operator -- fall through
675 to normal quoted string handling. */
678 /* Skip past the beginning quote. */
679 ++(PARSER_STREAM (parser
));
681 /* Mark the start of the string. */
682 LS_TOKEN_STOKEN (token
).ptr
= PARSER_STREAM (parser
);
684 /* Skip to the ending quote. */
685 end
= skip_quote_char (PARSER_STREAM (parser
), quote_char
);
687 /* This helps the completer mode decide whether we have a
689 parser
->completion_quote_char
= quote_char
;
690 parser
->completion_quote_end
= end
;
692 /* Error if the input did not terminate properly, unless in
696 if (parser
->completion_tracker
== NULL
)
697 error (_("unmatched quote"));
699 /* In completion mode, we'll try to complete the incomplete
701 token
.type
= LSTOKEN_STRING
;
702 while (*PARSER_STREAM (parser
) != '\0')
703 PARSER_STREAM (parser
)++;
704 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - 1 - start
;
708 /* Skip over the ending quote and mark the length of the string. */
709 PARSER_STREAM (parser
) = (char *) ++end
;
710 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - 2 - start
;
717 /* Otherwise, only identifier characters are permitted.
718 Spaces are the exception. In general, we keep spaces,
719 but only if the next characters in the input do not resolve
720 to one of the keywords.
722 This allows users to forgo quoting CV-qualifiers, template arguments,
723 and similar common language constructs. */
727 if (isspace (*PARSER_STREAM (parser
)))
729 p
= skip_spaces (PARSER_STREAM (parser
));
730 /* When we get here we know we've found something followed by
731 a space (we skip over parens and templates below).
732 So if we find a keyword now, we know it is a keyword and not,
733 say, a function name. */
734 if (linespec_lexer_lex_keyword (p
) != NULL
)
736 LS_TOKEN_STOKEN (token
).ptr
= start
;
737 LS_TOKEN_STOKEN (token
).length
738 = PARSER_STREAM (parser
) - start
;
742 /* Advance past the whitespace. */
743 PARSER_STREAM (parser
) = p
;
746 /* If the next character is EOI or (single) ':', the
747 string is complete; return the token. */
748 if (*PARSER_STREAM (parser
) == 0)
750 LS_TOKEN_STOKEN (token
).ptr
= start
;
751 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - start
;
754 else if (PARSER_STREAM (parser
)[0] == ':')
756 /* Do not tokenize the C++ scope operator. */
757 if (PARSER_STREAM (parser
)[1] == ':')
758 ++(PARSER_STREAM (parser
));
760 /* Do not tokenize ABI tags such as "[abi:cxx11]". */
761 else if (PARSER_STREAM (parser
) - start
> 4
762 && startswith (PARSER_STREAM (parser
) - 4, "[abi"))
763 ++(PARSER_STREAM (parser
));
765 /* Do not tokenify if the input length so far is one
766 (i.e, a single-letter drive name) and the next character
767 is a directory separator. This allows Windows-style
768 paths to be recognized as filenames without quoting it. */
769 else if ((PARSER_STREAM (parser
) - start
) != 1
770 || !IS_DIR_SEPARATOR (PARSER_STREAM (parser
)[1]))
772 LS_TOKEN_STOKEN (token
).ptr
= start
;
773 LS_TOKEN_STOKEN (token
).length
774 = PARSER_STREAM (parser
) - start
;
778 /* Special case: permit quote-enclosed linespecs. */
779 else if (parser
->is_quote_enclosed
780 && strchr (linespec_quote_characters
,
781 *PARSER_STREAM (parser
))
782 && is_closing_quote_enclosed (PARSER_STREAM (parser
)))
784 LS_TOKEN_STOKEN (token
).ptr
= start
;
785 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - start
;
788 /* Because commas may terminate a linespec and appear in
789 the middle of valid string input, special cases for
790 '<' and '(' are necessary. */
791 else if (*PARSER_STREAM (parser
) == '<'
792 || *PARSER_STREAM (parser
) == '(')
794 /* Don't interpret 'operator<' / 'operator<<' as a
795 template parameter list though. */
796 if (*PARSER_STREAM (parser
) == '<'
797 && (PARSER_STATE (parser
)->language
->la_language
799 && (PARSER_STREAM (parser
) - start
) >= CP_OPERATOR_LEN
)
801 const char *op
= PARSER_STREAM (parser
);
803 while (op
> start
&& isspace (op
[-1]))
805 if (op
- start
>= CP_OPERATOR_LEN
)
807 op
-= CP_OPERATOR_LEN
;
808 if (strncmp (op
, CP_OPERATOR_STR
, CP_OPERATOR_LEN
) == 0
810 || !(isalnum (op
[-1]) || op
[-1] == '_')))
812 /* This is an operator name. Keep going. */
813 ++(PARSER_STREAM (parser
));
814 if (*PARSER_STREAM (parser
) == '<')
815 ++(PARSER_STREAM (parser
));
821 const char *end
= find_parameter_list_end (PARSER_STREAM (parser
));
822 PARSER_STREAM (parser
) = end
;
824 /* Don't loop around to the normal \0 case above because
825 we don't want to misinterpret a potential keyword at
826 the end of the token when the string isn't
827 "()<>"-balanced. This handles "b
828 function(thread<tab>" in completion mode. */
831 LS_TOKEN_STOKEN (token
).ptr
= start
;
832 LS_TOKEN_STOKEN (token
).length
833 = PARSER_STREAM (parser
) - start
;
839 /* Commas are terminators, but not if they are part of an
841 else if (*PARSER_STREAM (parser
) == ',')
843 if ((PARSER_STATE (parser
)->language
->la_language
845 && (PARSER_STREAM (parser
) - start
) > CP_OPERATOR_LEN
)
847 const char *op
= strstr (start
, CP_OPERATOR_STR
);
849 if (op
!= NULL
&& is_operator_name (op
))
851 /* This is an operator name. Keep going. */
852 ++(PARSER_STREAM (parser
));
857 /* Comma terminates the string. */
858 LS_TOKEN_STOKEN (token
).ptr
= start
;
859 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - start
;
863 /* Advance the stream. */
864 ++(PARSER_STREAM (parser
));
871 /* Lex a single linespec token from PARSER. */
873 static linespec_token
874 linespec_lexer_lex_one (linespec_parser
*parser
)
878 if (parser
->lexer
.current
.type
== LSTOKEN_CONSUMED
)
880 /* Skip any whitespace. */
881 PARSER_STREAM (parser
) = skip_spaces (PARSER_STREAM (parser
));
883 /* Check for a keyword, they end the linespec. */
884 keyword
= linespec_lexer_lex_keyword (PARSER_STREAM (parser
));
887 parser
->lexer
.current
.type
= LSTOKEN_KEYWORD
;
888 LS_TOKEN_KEYWORD (parser
->lexer
.current
) = keyword
;
889 /* We do not advance the stream here intentionally:
890 we would like lexing to stop when a keyword is seen.
892 PARSER_STREAM (parser) += strlen (keyword); */
894 return parser
->lexer
.current
;
897 /* Handle other tokens. */
898 switch (*PARSER_STREAM (parser
))
901 parser
->lexer
.current
.type
= LSTOKEN_EOI
;
905 case '0': case '1': case '2': case '3': case '4':
906 case '5': case '6': case '7': case '8': case '9':
907 if (!linespec_lexer_lex_number (parser
, &(parser
->lexer
.current
)))
908 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
912 /* If we have a scope operator, lex the input as a string.
913 Otherwise, return LSTOKEN_COLON. */
914 if (PARSER_STREAM (parser
)[1] == ':')
915 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
918 parser
->lexer
.current
.type
= LSTOKEN_COLON
;
919 ++(PARSER_STREAM (parser
));
923 case '\'': case '\"':
924 /* Special case: permit quote-enclosed linespecs. */
925 if (parser
->is_quote_enclosed
926 && is_closing_quote_enclosed (PARSER_STREAM (parser
)))
928 ++(PARSER_STREAM (parser
));
929 parser
->lexer
.current
.type
= LSTOKEN_EOI
;
932 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
936 parser
->lexer
.current
.type
= LSTOKEN_COMMA
;
937 LS_TOKEN_STOKEN (parser
->lexer
.current
).ptr
938 = PARSER_STREAM (parser
);
939 LS_TOKEN_STOKEN (parser
->lexer
.current
).length
= 1;
940 ++(PARSER_STREAM (parser
));
944 /* If the input is not a number, it must be a string.
945 [Keywords were already considered above.] */
946 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
951 return parser
->lexer
.current
;
954 /* Consume the current token and return the next token in PARSER's
955 input stream. Also advance the completion word for completion
958 static linespec_token
959 linespec_lexer_consume_token (linespec_parser
*parser
)
961 gdb_assert (parser
->lexer
.current
.type
!= LSTOKEN_EOI
);
963 bool advance_word
= (parser
->lexer
.current
.type
!= LSTOKEN_STRING
964 || *PARSER_STREAM (parser
) != '\0');
966 /* If we're moving past a string to some other token, it must be the
967 quote was terminated. */
968 if (parser
->completion_quote_char
)
970 gdb_assert (parser
->lexer
.current
.type
== LSTOKEN_STRING
);
972 /* If the string was the last (non-EOI) token, we're past the
973 quote, but remember that for later. */
974 if (*PARSER_STREAM (parser
) != '\0')
976 parser
->completion_quote_char
= '\0';
977 parser
->completion_quote_end
= NULL
;;
981 parser
->lexer
.current
.type
= LSTOKEN_CONSUMED
;
982 linespec_lexer_lex_one (parser
);
984 if (parser
->lexer
.current
.type
== LSTOKEN_STRING
)
986 /* Advance the completion word past a potential initial
988 parser
->completion_word
= LS_TOKEN_STOKEN (parser
->lexer
.current
).ptr
;
990 else if (advance_word
)
992 /* Advance the completion word past any whitespace. */
993 parser
->completion_word
= PARSER_STREAM (parser
);
996 return parser
->lexer
.current
;
999 /* Return the next token without consuming the current token. */
1001 static linespec_token
1002 linespec_lexer_peek_token (linespec_parser
*parser
)
1004 linespec_token next
;
1005 const char *saved_stream
= PARSER_STREAM (parser
);
1006 linespec_token saved_token
= parser
->lexer
.current
;
1007 int saved_completion_quote_char
= parser
->completion_quote_char
;
1008 const char *saved_completion_quote_end
= parser
->completion_quote_end
;
1009 const char *saved_completion_word
= parser
->completion_word
;
1011 next
= linespec_lexer_consume_token (parser
);
1012 PARSER_STREAM (parser
) = saved_stream
;
1013 parser
->lexer
.current
= saved_token
;
1014 parser
->completion_quote_char
= saved_completion_quote_char
;
1015 parser
->completion_quote_end
= saved_completion_quote_end
;
1016 parser
->completion_word
= saved_completion_word
;
1020 /* Helper functions. */
1022 /* Add SAL to SALS, and also update SELF->CANONICAL_NAMES to reflect
1023 the new sal, if needed. If not NULL, SYMNAME is the name of the
1024 symbol to use when constructing the new canonical name.
1026 If LITERAL_CANONICAL is non-zero, SYMNAME will be used as the
1027 canonical name for the SAL. */
1030 add_sal_to_sals (struct linespec_state
*self
,
1031 std::vector
<symtab_and_line
> *sals
,
1032 struct symtab_and_line
*sal
,
1033 const char *symname
, int literal_canonical
)
1035 sals
->push_back (*sal
);
1037 if (self
->canonical
)
1039 struct linespec_canonical_name
*canonical
;
1041 self
->canonical_names
= XRESIZEVEC (struct linespec_canonical_name
,
1042 self
->canonical_names
,
1044 canonical
= &self
->canonical_names
[sals
->size () - 1];
1045 if (!literal_canonical
&& sal
->symtab
)
1047 symtab_to_fullname (sal
->symtab
);
1049 /* Note that the filter doesn't have to be a valid linespec
1050 input. We only apply the ":LINE" treatment to Ada for
1052 if (symname
!= NULL
&& sal
->line
!= 0
1053 && self
->language
->la_language
== language_ada
)
1054 canonical
->suffix
= xstrprintf ("%s:%d", symname
, sal
->line
);
1055 else if (symname
!= NULL
)
1056 canonical
->suffix
= xstrdup (symname
);
1058 canonical
->suffix
= xstrprintf ("%d", sal
->line
);
1059 canonical
->symtab
= sal
->symtab
;
1063 if (symname
!= NULL
)
1064 canonical
->suffix
= xstrdup (symname
);
1066 canonical
->suffix
= xstrdup ("<unknown>");
1067 canonical
->symtab
= NULL
;
1072 /* A hash function for address_entry. */
1075 hash_address_entry (const void *p
)
1077 const struct address_entry
*aep
= (const struct address_entry
*) p
;
1080 hash
= iterative_hash_object (aep
->pspace
, 0);
1081 return iterative_hash_object (aep
->addr
, hash
);
1084 /* An equality function for address_entry. */
1087 eq_address_entry (const void *a
, const void *b
)
1089 const struct address_entry
*aea
= (const struct address_entry
*) a
;
1090 const struct address_entry
*aeb
= (const struct address_entry
*) b
;
1092 return aea
->pspace
== aeb
->pspace
&& aea
->addr
== aeb
->addr
;
1095 /* Check whether the address, represented by PSPACE and ADDR, is
1096 already in the set. If so, return 0. Otherwise, add it and return
1100 maybe_add_address (htab_t set
, struct program_space
*pspace
, CORE_ADDR addr
)
1102 struct address_entry e
, *p
;
1107 slot
= htab_find_slot (set
, &e
, INSERT
);
1111 p
= XNEW (struct address_entry
);
1112 memcpy (p
, &e
, sizeof (struct address_entry
));
1118 /* A helper that walks over all matching symtabs in all objfiles and
1119 calls CALLBACK for each symbol matching NAME. If SEARCH_PSPACE is
1120 not NULL, then the search is restricted to just that program
1121 space. If INCLUDE_INLINE is true then symbols representing
1122 inlined instances of functions will be included in the result. */
1125 iterate_over_all_matching_symtabs
1126 (struct linespec_state
*state
,
1127 const lookup_name_info
&lookup_name
,
1128 const domain_enum name_domain
,
1129 enum search_domain search_domain
,
1130 struct program_space
*search_pspace
, bool include_inline
,
1131 gdb::function_view
<symbol_found_callback_ftype
> callback
)
1133 struct objfile
*objfile
;
1134 struct program_space
*pspace
;
1136 ALL_PSPACES (pspace
)
1138 if (search_pspace
!= NULL
&& search_pspace
!= pspace
)
1140 if (pspace
->executing_startup
)
1143 set_current_program_space (pspace
);
1145 ALL_OBJFILES (objfile
)
1147 struct compunit_symtab
*cu
;
1150 objfile
->sf
->qf
->expand_symtabs_matching (objfile
,
1156 ALL_OBJFILE_COMPUNITS (objfile
, cu
)
1158 struct symtab
*symtab
= COMPUNIT_FILETABS (cu
);
1160 iterate_over_file_blocks (symtab
, lookup_name
, name_domain
, callback
);
1164 struct block
*block
;
1167 for (i
= FIRST_LOCAL_BLOCK
;
1168 i
< BLOCKVECTOR_NBLOCKS (SYMTAB_BLOCKVECTOR (symtab
));
1171 block
= BLOCKVECTOR_BLOCK (SYMTAB_BLOCKVECTOR (symtab
), i
);
1172 state
->language
->la_iterate_over_symbols
1173 (block
, lookup_name
, name_domain
, [&] (block_symbol
*bsym
)
1175 /* Restrict calls to CALLBACK to symbols
1176 representing inline symbols only. */
1177 if (SYMBOL_INLINED (bsym
->symbol
))
1178 return callback (bsym
);
1188 /* Returns the block to be used for symbol searches from
1189 the current location. */
1191 static const struct block
*
1192 get_current_search_block (void)
1194 const struct block
*block
;
1195 enum language save_language
;
1197 /* get_selected_block can change the current language when there is
1198 no selected frame yet. */
1199 save_language
= current_language
->la_language
;
1200 block
= get_selected_block (0);
1201 set_language (save_language
);
1206 /* Iterate over static and global blocks. */
1209 iterate_over_file_blocks
1210 (struct symtab
*symtab
, const lookup_name_info
&name
,
1211 domain_enum domain
, gdb::function_view
<symbol_found_callback_ftype
> callback
)
1213 struct block
*block
;
1215 for (block
= BLOCKVECTOR_BLOCK (SYMTAB_BLOCKVECTOR (symtab
), STATIC_BLOCK
);
1217 block
= BLOCK_SUPERBLOCK (block
))
1218 LA_ITERATE_OVER_SYMBOLS (block
, name
, domain
, callback
);
1221 /* A helper for find_method. This finds all methods in type T of
1222 language T_LANG which match NAME. It adds matching symbol names to
1223 RESULT_NAMES, and adds T's direct superclasses to SUPERCLASSES. */
1226 find_methods (struct type
*t
, enum language t_lang
, const char *name
,
1227 std::vector
<const char *> *result_names
,
1228 std::vector
<struct type
*> *superclasses
)
1231 const char *class_name
= TYPE_NAME (t
);
1233 /* Ignore this class if it doesn't have a name. This is ugly, but
1234 unless we figure out how to get the physname without the name of
1235 the class, then the loop can't do any good. */
1239 lookup_name_info
lookup_name (name
, symbol_name_match_type::FULL
);
1240 symbol_name_matcher_ftype
*symbol_name_compare
1241 = get_symbol_name_matcher (language_def (t_lang
), lookup_name
);
1243 t
= check_typedef (t
);
1245 /* Loop over each method name. At this level, all overloads of a name
1246 are counted as a single name. There is an inner loop which loops over
1249 for (method_counter
= TYPE_NFN_FIELDS (t
) - 1;
1250 method_counter
>= 0;
1253 const char *method_name
= TYPE_FN_FIELDLIST_NAME (t
, method_counter
);
1254 char dem_opname
[64];
1256 if (startswith (method_name
, "__") ||
1257 startswith (method_name
, "op") ||
1258 startswith (method_name
, "type"))
1260 if (cplus_demangle_opname (method_name
, dem_opname
, DMGL_ANSI
))
1261 method_name
= dem_opname
;
1262 else if (cplus_demangle_opname (method_name
, dem_opname
, 0))
1263 method_name
= dem_opname
;
1266 if (symbol_name_compare (method_name
, lookup_name
, NULL
))
1270 for (field_counter
= (TYPE_FN_FIELDLIST_LENGTH (t
, method_counter
)
1276 const char *phys_name
;
1278 f
= TYPE_FN_FIELDLIST1 (t
, method_counter
);
1279 if (TYPE_FN_FIELD_STUB (f
, field_counter
))
1281 phys_name
= TYPE_FN_FIELD_PHYSNAME (f
, field_counter
);
1282 result_names
->push_back (phys_name
);
1288 for (ibase
= 0; ibase
< TYPE_N_BASECLASSES (t
); ibase
++)
1289 superclasses
->push_back (TYPE_BASECLASS (t
, ibase
));
1292 /* Find an instance of the character C in the string S that is outside
1293 of all parenthesis pairs, single-quoted strings, and double-quoted
1294 strings. Also, ignore the char within a template name, like a ','
1295 within foo<int, int>, while considering C++ operator</operator<<. */
1298 find_toplevel_char (const char *s
, char c
)
1300 int quoted
= 0; /* zero if we're not in quotes;
1301 '"' if we're in a double-quoted string;
1302 '\'' if we're in a single-quoted string. */
1303 int depth
= 0; /* Number of unclosed parens we've seen. */
1306 for (scan
= s
; *scan
; scan
++)
1310 if (*scan
== quoted
)
1312 else if (*scan
== '\\' && *(scan
+ 1))
1315 else if (*scan
== c
&& ! quoted
&& depth
== 0)
1317 else if (*scan
== '"' || *scan
== '\'')
1319 else if (*scan
== '(' || *scan
== '<')
1321 else if ((*scan
== ')' || *scan
== '>') && depth
> 0)
1323 else if (*scan
== 'o' && !quoted
&& depth
== 0)
1325 /* Handle C++ operator names. */
1326 if (strncmp (scan
, CP_OPERATOR_STR
, CP_OPERATOR_LEN
) == 0)
1328 scan
+= CP_OPERATOR_LEN
;
1331 while (isspace (*scan
))
1342 /* Skip over one less than the appropriate number of
1343 characters: the for loop will skip over the last
1369 /* The string equivalent of find_toplevel_char. Returns a pointer
1370 to the location of NEEDLE in HAYSTACK, ignoring any occurrences
1371 inside "()" and "<>". Returns NULL if NEEDLE was not found. */
1374 find_toplevel_string (const char *haystack
, const char *needle
)
1376 const char *s
= haystack
;
1380 s
= find_toplevel_char (s
, *needle
);
1384 /* Found first char in HAYSTACK; check rest of string. */
1385 if (startswith (s
, needle
))
1388 /* Didn't find it; loop over HAYSTACK, looking for the next
1389 instance of the first character of NEEDLE. */
1393 while (s
!= NULL
&& *s
!= '\0');
1395 /* NEEDLE was not found in HAYSTACK. */
1399 /* Convert CANONICAL to its string representation using
1400 symtab_to_fullname for SYMTAB. */
1403 canonical_to_fullform (const struct linespec_canonical_name
*canonical
)
1405 if (canonical
->symtab
== NULL
)
1406 return canonical
->suffix
;
1408 return string_printf ("%s:%s", symtab_to_fullname (canonical
->symtab
),
1412 /* Given FILTERS, a list of canonical names, filter the sals in RESULT
1413 and store the result in SELF->CANONICAL. */
1416 filter_results (struct linespec_state
*self
,
1417 std::vector
<symtab_and_line
> *result
,
1418 const std::vector
<const char *> &filters
)
1420 for (const char *name
: filters
)
1424 for (size_t j
= 0; j
< result
->size (); ++j
)
1426 const struct linespec_canonical_name
*canonical
;
1428 canonical
= &self
->canonical_names
[j
];
1429 std::string fullform
= canonical_to_fullform (canonical
);
1431 if (name
== fullform
)
1432 lsal
.sals
.push_back ((*result
)[j
]);
1435 if (!lsal
.sals
.empty ())
1437 lsal
.canonical
= xstrdup (name
);
1438 self
->canonical
->lsals
.push_back (std::move (lsal
));
1442 self
->canonical
->pre_expanded
= 0;
1445 /* Store RESULT into SELF->CANONICAL. */
1448 convert_results_to_lsals (struct linespec_state
*self
,
1449 std::vector
<symtab_and_line
> *result
)
1451 struct linespec_sals lsal
;
1453 lsal
.canonical
= NULL
;
1454 lsal
.sals
= std::move (*result
);
1455 self
->canonical
->lsals
.push_back (std::move (lsal
));
1458 /* A structure that contains two string representations of a struct
1459 linespec_canonical_name:
1460 - one where the the symtab's fullname is used;
1461 - one where the filename followed the "set filename-display"
1464 struct decode_line_2_item
1466 decode_line_2_item (std::string
&&fullform_
, std::string
&&displayform_
,
1468 : fullform (std::move (fullform_
)),
1469 displayform (std::move (displayform_
)),
1470 selected (selected_
)
1474 /* The form using symtab_to_fullname. */
1475 std::string fullform
;
1477 /* The form using symtab_to_filename_for_display. */
1478 std::string displayform
;
1480 /* Field is initialized to zero and it is set to one if the user
1481 requested breakpoint for this entry. */
1482 unsigned int selected
: 1;
1485 /* Helper for std::sort to sort decode_line_2_item entries by
1486 DISPLAYFORM and secondarily by FULLFORM. */
1489 decode_line_2_compare_items (const decode_line_2_item
&a
,
1490 const decode_line_2_item
&b
)
1492 if (a
.displayform
!= b
.displayform
)
1493 return a
.displayform
< b
.displayform
;
1494 return a
.fullform
< b
.fullform
;
1497 /* Handle multiple results in RESULT depending on SELECT_MODE. This
1498 will either return normally, throw an exception on multiple
1499 results, or present a menu to the user. On return, the SALS vector
1500 in SELF->CANONICAL is set up properly. */
1503 decode_line_2 (struct linespec_state
*self
,
1504 std::vector
<symtab_and_line
> *result
,
1505 const char *select_mode
)
1510 std::vector
<const char *> filters
;
1511 std::vector
<struct decode_line_2_item
> items
;
1513 gdb_assert (select_mode
!= multiple_symbols_all
);
1514 gdb_assert (self
->canonical
!= NULL
);
1515 gdb_assert (!result
->empty ());
1517 /* Prepare ITEMS array. */
1518 for (i
= 0; i
< result
->size (); ++i
)
1520 const struct linespec_canonical_name
*canonical
;
1521 std::string displayform
;
1523 canonical
= &self
->canonical_names
[i
];
1524 gdb_assert (canonical
->suffix
!= NULL
);
1526 std::string fullform
= canonical_to_fullform (canonical
);
1528 if (canonical
->symtab
== NULL
)
1529 displayform
= canonical
->suffix
;
1532 const char *fn_for_display
;
1534 fn_for_display
= symtab_to_filename_for_display (canonical
->symtab
);
1535 displayform
= string_printf ("%s:%s", fn_for_display
,
1539 items
.emplace_back (std::move (fullform
), std::move (displayform
),
1543 /* Sort the list of method names. */
1544 std::sort (items
.begin (), items
.end (), decode_line_2_compare_items
);
1546 /* Remove entries with the same FULLFORM. */
1547 items
.erase (std::unique (items
.begin (), items
.end (),
1548 [] (const struct decode_line_2_item
&a
,
1549 const struct decode_line_2_item
&b
)
1551 return a
.fullform
== b
.fullform
;
1555 if (select_mode
== multiple_symbols_cancel
&& items
.size () > 1)
1556 error (_("canceled because the command is ambiguous\n"
1557 "See set/show multiple-symbol."));
1559 if (select_mode
== multiple_symbols_all
|| items
.size () == 1)
1561 convert_results_to_lsals (self
, result
);
1565 printf_unfiltered (_("[0] cancel\n[1] all\n"));
1566 for (i
= 0; i
< items
.size (); i
++)
1567 printf_unfiltered ("[%d] %s\n", i
+ 2, items
[i
].displayform
.c_str ());
1569 prompt
= getenv ("PS2");
1574 args
= command_line_input (prompt
, "overload-choice");
1576 if (args
== 0 || *args
== 0)
1577 error_no_arg (_("one or more choice numbers"));
1579 number_or_range_parser
parser (args
);
1580 while (!parser
.finished ())
1582 int num
= parser
.get_number ();
1585 error (_("canceled"));
1588 /* We intentionally make this result in a single breakpoint,
1589 contrary to what older versions of gdb did. The
1590 rationale is that this lets a user get the
1591 multiple_symbols_all behavior even with the 'ask'
1592 setting; and he can get separate breakpoints by entering
1593 "2-57" at the query. */
1594 convert_results_to_lsals (self
, result
);
1599 if (num
>= items
.size ())
1600 printf_unfiltered (_("No choice number %d.\n"), num
);
1603 struct decode_line_2_item
*item
= &items
[num
];
1605 if (!item
->selected
)
1607 filters
.push_back (item
->fullform
.c_str ());
1612 printf_unfiltered (_("duplicate request for %d ignored.\n"),
1618 filter_results (self
, result
, filters
);
1623 /* The parser of linespec itself. */
1625 /* Throw an appropriate error when SYMBOL is not found (optionally in
1628 static void ATTRIBUTE_NORETURN
1629 symbol_not_found_error (const char *symbol
, const char *filename
)
1634 if (!have_full_symbols ()
1635 && !have_partial_symbols ()
1636 && !have_minimal_symbols ())
1637 throw_error (NOT_FOUND_ERROR
,
1638 _("No symbol table is loaded. Use the \"file\" command."));
1640 /* If SYMBOL starts with '$', the user attempted to either lookup
1641 a function/variable in his code starting with '$' or an internal
1642 variable of that name. Since we do not know which, be concise and
1643 explain both possibilities. */
1647 throw_error (NOT_FOUND_ERROR
,
1648 _("Undefined convenience variable or function \"%s\" "
1649 "not defined in \"%s\"."), symbol
, filename
);
1651 throw_error (NOT_FOUND_ERROR
,
1652 _("Undefined convenience variable or function \"%s\" "
1653 "not defined."), symbol
);
1658 throw_error (NOT_FOUND_ERROR
,
1659 _("Function \"%s\" not defined in \"%s\"."),
1662 throw_error (NOT_FOUND_ERROR
,
1663 _("Function \"%s\" not defined."), symbol
);
1667 /* Throw an appropriate error when an unexpected token is encountered
1670 static void ATTRIBUTE_NORETURN
1671 unexpected_linespec_error (linespec_parser
*parser
)
1673 linespec_token token
;
1674 static const char * token_type_strings
[]
1675 = {"keyword", "colon", "string", "number", "comma", "end of input"};
1677 /* Get the token that generated the error. */
1678 token
= linespec_lexer_lex_one (parser
);
1680 /* Finally, throw the error. */
1681 if (token
.type
== LSTOKEN_STRING
|| token
.type
== LSTOKEN_NUMBER
1682 || token
.type
== LSTOKEN_KEYWORD
)
1684 gdb::unique_xmalloc_ptr
<char> string
= copy_token_string (token
);
1685 throw_error (GENERIC_ERROR
,
1686 _("malformed linespec error: unexpected %s, \"%s\""),
1687 token_type_strings
[token
.type
], string
.get ());
1690 throw_error (GENERIC_ERROR
,
1691 _("malformed linespec error: unexpected %s"),
1692 token_type_strings
[token
.type
]);
1695 /* Throw an undefined label error. */
1697 static void ATTRIBUTE_NORETURN
1698 undefined_label_error (const char *function
, const char *label
)
1700 if (function
!= NULL
)
1701 throw_error (NOT_FOUND_ERROR
,
1702 _("No label \"%s\" defined in function \"%s\"."),
1705 throw_error (NOT_FOUND_ERROR
,
1706 _("No label \"%s\" defined in current function."),
1710 /* Throw a source file not found error. */
1712 static void ATTRIBUTE_NORETURN
1713 source_file_not_found_error (const char *name
)
1715 throw_error (NOT_FOUND_ERROR
, _("No source file named %s."), name
);
1718 /* Unless at EIO, save the current stream position as completion word
1719 point, and consume the next token. */
1721 static linespec_token
1722 save_stream_and_consume_token (linespec_parser
*parser
)
1724 if (linespec_lexer_peek_token (parser
).type
!= LSTOKEN_EOI
)
1725 parser
->completion_word
= PARSER_STREAM (parser
);
1726 return linespec_lexer_consume_token (parser
);
1729 /* See description in linespec.h. */
1732 linespec_parse_line_offset (const char *string
)
1734 const char *start
= string
;
1735 struct line_offset line_offset
= {0, LINE_OFFSET_NONE
};
1739 line_offset
.sign
= LINE_OFFSET_PLUS
;
1742 else if (*string
== '-')
1744 line_offset
.sign
= LINE_OFFSET_MINUS
;
1748 if (*string
!= '\0' && !isdigit (*string
))
1749 error (_("malformed line offset: \"%s\""), start
);
1751 /* Right now, we only allow base 10 for offsets. */
1752 line_offset
.offset
= atoi (string
);
1756 /* In completion mode, if the user is still typing the number, there's
1757 no possible completion to offer. But if there's already input past
1758 the number, setup to expect NEXT. */
1761 set_completion_after_number (linespec_parser
*parser
,
1762 linespec_complete_what next
)
1764 if (*PARSER_STREAM (parser
) == ' ')
1766 parser
->completion_word
= skip_spaces (PARSER_STREAM (parser
) + 1);
1767 parser
->complete_what
= next
;
1771 parser
->completion_word
= PARSER_STREAM (parser
);
1772 parser
->complete_what
= linespec_complete_what::NOTHING
;
1776 /* Parse the basic_spec in PARSER's input. */
1779 linespec_parse_basic (linespec_parser
*parser
)
1781 gdb::unique_xmalloc_ptr
<char> name
;
1782 linespec_token token
;
1783 std::vector
<block_symbol
> symbols
;
1784 std::vector
<block_symbol
> *labels
;
1785 std::vector
<bound_minimal_symbol
> minimal_symbols
;
1787 /* Get the next token. */
1788 token
= linespec_lexer_lex_one (parser
);
1790 /* If it is EOI or KEYWORD, issue an error. */
1791 if (token
.type
== LSTOKEN_KEYWORD
)
1793 parser
->complete_what
= linespec_complete_what::NOTHING
;
1794 unexpected_linespec_error (parser
);
1796 else if (token
.type
== LSTOKEN_EOI
)
1798 unexpected_linespec_error (parser
);
1800 /* If it is a LSTOKEN_NUMBER, we have an offset. */
1801 else if (token
.type
== LSTOKEN_NUMBER
)
1803 set_completion_after_number (parser
, linespec_complete_what::KEYWORD
);
1805 /* Record the line offset and get the next token. */
1806 name
= copy_token_string (token
);
1807 PARSER_EXPLICIT (parser
)->line_offset
1808 = linespec_parse_line_offset (name
.get ());
1810 /* Get the next token. */
1811 token
= linespec_lexer_consume_token (parser
);
1813 /* If the next token is a comma, stop parsing and return. */
1814 if (token
.type
== LSTOKEN_COMMA
)
1816 parser
->complete_what
= linespec_complete_what::NOTHING
;
1820 /* If the next token is anything but EOI or KEYWORD, issue
1822 if (token
.type
!= LSTOKEN_KEYWORD
&& token
.type
!= LSTOKEN_EOI
)
1823 unexpected_linespec_error (parser
);
1826 if (token
.type
== LSTOKEN_KEYWORD
|| token
.type
== LSTOKEN_EOI
)
1829 /* Next token must be LSTOKEN_STRING. */
1830 if (token
.type
!= LSTOKEN_STRING
)
1832 parser
->complete_what
= linespec_complete_what::NOTHING
;
1833 unexpected_linespec_error (parser
);
1836 /* The current token will contain the name of a function, method,
1838 name
= copy_token_string (token
);
1840 if (parser
->completion_tracker
!= NULL
)
1842 /* If the function name ends with a ":", then this may be an
1843 incomplete "::" scope operator instead of a label separator.
1846 which should expand to:
1849 Do a tentative completion assuming the later. If we find
1850 completions, advance the stream past the colon token and make
1851 it part of the function name/token. */
1853 if (!parser
->completion_quote_char
1854 && strcmp (PARSER_STREAM (parser
), ":") == 0)
1856 completion_tracker tmp_tracker
;
1857 const char *source_filename
1858 = PARSER_EXPLICIT (parser
)->source_filename
;
1859 symbol_name_match_type match_type
1860 = PARSER_EXPLICIT (parser
)->func_name_match_type
;
1862 linespec_complete_function (tmp_tracker
,
1863 parser
->completion_word
,
1867 if (tmp_tracker
.have_completions ())
1869 PARSER_STREAM (parser
)++;
1870 LS_TOKEN_STOKEN (token
).length
++;
1872 name
.reset (savestring (parser
->completion_word
,
1873 (PARSER_STREAM (parser
)
1874 - parser
->completion_word
)));
1878 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1882 /* Try looking it up as a function/method. */
1883 find_linespec_symbols (PARSER_STATE (parser
),
1884 PARSER_RESULT (parser
)->file_symtabs
, name
.get (),
1885 PARSER_EXPLICIT (parser
)->func_name_match_type
,
1886 &symbols
, &minimal_symbols
);
1888 if (!symbols
.empty () || !minimal_symbols
.empty ())
1890 PARSER_RESULT (parser
)->function_symbols
1891 = new std::vector
<block_symbol
> (std::move (symbols
));
1892 PARSER_RESULT (parser
)->minimal_symbols
1893 = new std::vector
<bound_minimal_symbol
>
1894 (std::move (minimal_symbols
));
1895 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1899 /* NAME was not a function or a method. So it must be a label
1900 name or user specified variable like "break foo.c:$zippo". */
1901 labels
= find_label_symbols (PARSER_STATE (parser
), NULL
,
1902 &symbols
, name
.get ());
1905 PARSER_RESULT (parser
)->labels
.label_symbols
= labels
;
1906 PARSER_RESULT (parser
)->labels
.function_symbols
1907 = new std::vector
<block_symbol
> (std::move (symbols
));
1908 PARSER_EXPLICIT (parser
)->label_name
= name
.release ();
1910 else if (token
.type
== LSTOKEN_STRING
1911 && *LS_TOKEN_STOKEN (token
).ptr
== '$')
1913 /* User specified a convenience variable or history value. */
1914 PARSER_EXPLICIT (parser
)->line_offset
1915 = linespec_parse_variable (PARSER_STATE (parser
), name
.get ());
1917 if (PARSER_EXPLICIT (parser
)->line_offset
.sign
== LINE_OFFSET_UNKNOWN
)
1919 /* The user-specified variable was not valid. Do not
1920 throw an error here. parse_linespec will do it for us. */
1921 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1927 /* The name is also not a label. Abort parsing. Do not throw
1928 an error here. parse_linespec will do it for us. */
1930 /* Save a copy of the name we were trying to lookup. */
1931 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1937 int previous_qc
= parser
->completion_quote_char
;
1939 /* Get the next token. */
1940 token
= linespec_lexer_consume_token (parser
);
1942 if (token
.type
== LSTOKEN_EOI
)
1944 if (previous_qc
&& !parser
->completion_quote_char
)
1945 parser
->complete_what
= linespec_complete_what::KEYWORD
;
1947 else if (token
.type
== LSTOKEN_COLON
)
1949 /* User specified a label or a lineno. */
1950 token
= linespec_lexer_consume_token (parser
);
1952 if (token
.type
== LSTOKEN_NUMBER
)
1954 /* User specified an offset. Record the line offset and
1955 get the next token. */
1956 set_completion_after_number (parser
, linespec_complete_what::KEYWORD
);
1958 name
= copy_token_string (token
);
1959 PARSER_EXPLICIT (parser
)->line_offset
1960 = linespec_parse_line_offset (name
.get ());
1962 /* Get the next token. */
1963 token
= linespec_lexer_consume_token (parser
);
1965 else if (token
.type
== LSTOKEN_EOI
&& parser
->completion_tracker
!= NULL
)
1967 parser
->complete_what
= linespec_complete_what::LABEL
;
1969 else if (token
.type
== LSTOKEN_STRING
)
1971 parser
->complete_what
= linespec_complete_what::LABEL
;
1973 /* If we have text after the label separated by whitespace
1974 (e.g., "b func():lab i<tab>"), don't consider it part of
1975 the label. In completion mode that should complete to
1976 "if", in normal mode, the 'i' should be treated as
1978 if (parser
->completion_quote_char
== '\0')
1980 const char *ptr
= LS_TOKEN_STOKEN (token
).ptr
;
1981 for (size_t i
= 0; i
< LS_TOKEN_STOKEN (token
).length
; i
++)
1985 LS_TOKEN_STOKEN (token
).length
= i
;
1986 PARSER_STREAM (parser
) = skip_spaces (ptr
+ i
+ 1);
1992 if (parser
->completion_tracker
!= NULL
)
1994 if (PARSER_STREAM (parser
)[-1] == ' ')
1996 parser
->completion_word
= PARSER_STREAM (parser
);
1997 parser
->complete_what
= linespec_complete_what::KEYWORD
;
2002 /* Grab a copy of the label's name and look it up. */
2003 name
= copy_token_string (token
);
2005 = find_label_symbols (PARSER_STATE (parser
),
2006 PARSER_RESULT (parser
)->function_symbols
,
2007 &symbols
, name
.get ());
2011 PARSER_RESULT (parser
)->labels
.label_symbols
= labels
;
2012 PARSER_RESULT (parser
)->labels
.function_symbols
2013 = new std::vector
<block_symbol
> (std::move (symbols
));
2014 PARSER_EXPLICIT (parser
)->label_name
= name
.release ();
2018 /* We don't know what it was, but it isn't a label. */
2019 undefined_label_error
2020 (PARSER_EXPLICIT (parser
)->function_name
, name
.get ());
2025 /* Check for a line offset. */
2026 token
= save_stream_and_consume_token (parser
);
2027 if (token
.type
== LSTOKEN_COLON
)
2029 /* Get the next token. */
2030 token
= linespec_lexer_consume_token (parser
);
2032 /* It must be a line offset. */
2033 if (token
.type
!= LSTOKEN_NUMBER
)
2034 unexpected_linespec_error (parser
);
2036 /* Record the line offset and get the next token. */
2037 name
= copy_token_string (token
);
2039 PARSER_EXPLICIT (parser
)->line_offset
2040 = linespec_parse_line_offset (name
.get ());
2042 /* Get the next token. */
2043 token
= linespec_lexer_consume_token (parser
);
2048 /* Trailing ':' in the input. Issue an error. */
2049 unexpected_linespec_error (parser
);
2054 /* Canonicalize the linespec contained in LS. The result is saved into
2055 STATE->canonical. This function handles both linespec and explicit
2059 canonicalize_linespec (struct linespec_state
*state
, const linespec_p ls
)
2061 struct event_location
*canon
;
2062 struct explicit_location
*explicit_loc
;
2064 /* If canonicalization was not requested, no need to do anything. */
2065 if (!state
->canonical
)
2068 /* Save everything as an explicit location. */
2069 state
->canonical
->location
2070 = new_explicit_location (&ls
->explicit_loc
);
2071 canon
= state
->canonical
->location
.get ();
2072 explicit_loc
= get_explicit_location (canon
);
2074 if (explicit_loc
->label_name
!= NULL
)
2076 state
->canonical
->special_display
= 1;
2078 if (explicit_loc
->function_name
== NULL
)
2080 /* No function was specified, so add the symbol name. */
2081 gdb_assert (!ls
->labels
.function_symbols
->empty ()
2082 && (ls
->labels
.function_symbols
->size () == 1));
2083 block_symbol s
= ls
->labels
.function_symbols
->front ();
2084 explicit_loc
->function_name
2085 = xstrdup (SYMBOL_NATURAL_NAME (s
.symbol
));
2089 /* If this location originally came from a linespec, save a string
2090 representation of it for display and saving to file. */
2091 if (state
->is_linespec
)
2093 char *linespec
= explicit_location_to_linespec (explicit_loc
);
2095 set_event_location_string (canon
, linespec
);
2100 /* Given a line offset in LS, construct the relevant SALs. */
2102 static std::vector
<symtab_and_line
>
2103 create_sals_line_offset (struct linespec_state
*self
,
2106 int use_default
= 0;
2108 /* This is where we need to make sure we have good defaults.
2109 We must guarantee that this section of code is never executed
2110 when we are called with just a function name, since
2111 set_default_source_symtab_and_line uses
2112 select_source_symtab that calls us with such an argument. */
2114 if (ls
->file_symtabs
->size () == 1
2115 && ls
->file_symtabs
->front () == nullptr)
2117 const char *fullname
;
2119 set_current_program_space (self
->program_space
);
2121 /* Make sure we have at least a default source line. */
2122 set_default_source_symtab_and_line ();
2123 initialize_defaults (&self
->default_symtab
, &self
->default_line
);
2124 fullname
= symtab_to_fullname (self
->default_symtab
);
2126 = collect_symtabs_from_filename (fullname
, self
->search_pspace
);
2130 symtab_and_line val
;
2131 val
.line
= ls
->explicit_loc
.line_offset
.offset
;
2132 switch (ls
->explicit_loc
.line_offset
.sign
)
2134 case LINE_OFFSET_PLUS
:
2135 if (ls
->explicit_loc
.line_offset
.offset
== 0)
2138 val
.line
= self
->default_line
+ val
.line
;
2141 case LINE_OFFSET_MINUS
:
2142 if (ls
->explicit_loc
.line_offset
.offset
== 0)
2145 val
.line
= self
->default_line
- val
.line
;
2147 val
.line
= -val
.line
;
2150 case LINE_OFFSET_NONE
:
2151 break; /* No need to adjust val.line. */
2154 std::vector
<symtab_and_line
> values
;
2155 if (self
->list_mode
)
2156 values
= decode_digits_list_mode (self
, ls
, val
);
2159 struct linetable_entry
*best_entry
= NULL
;
2162 std::vector
<symtab_and_line
> intermediate_results
2163 = decode_digits_ordinary (self
, ls
, val
.line
, &best_entry
);
2164 if (intermediate_results
.empty () && best_entry
!= NULL
)
2165 intermediate_results
= decode_digits_ordinary (self
, ls
,
2169 /* For optimized code, the compiler can scatter one source line
2170 across disjoint ranges of PC values, even when no duplicate
2171 functions or inline functions are involved. For example,
2172 'for (;;)' inside a non-template, non-inline, and non-ctor-or-dtor
2173 function can result in two PC ranges. In this case, we don't
2174 want to set a breakpoint on the first PC of each range. To filter
2175 such cases, we use containing blocks -- for each PC found
2176 above, we see if there are other PCs that are in the same
2177 block. If yes, the other PCs are filtered out. */
2179 gdb::def_vector
<int> filter (intermediate_results
.size ());
2180 gdb::def_vector
<const block
*> blocks (intermediate_results
.size ());
2182 for (i
= 0; i
< intermediate_results
.size (); ++i
)
2184 set_current_program_space (intermediate_results
[i
].pspace
);
2187 blocks
[i
] = block_for_pc_sect (intermediate_results
[i
].pc
,
2188 intermediate_results
[i
].section
);
2191 for (i
= 0; i
< intermediate_results
.size (); ++i
)
2193 if (blocks
[i
] != NULL
)
2194 for (j
= i
+ 1; j
< intermediate_results
.size (); ++j
)
2196 if (blocks
[j
] == blocks
[i
])
2204 for (i
= 0; i
< intermediate_results
.size (); ++i
)
2207 struct symbol
*sym
= (blocks
[i
]
2208 ? block_containing_function (blocks
[i
])
2211 if (self
->funfirstline
)
2212 skip_prologue_sal (&intermediate_results
[i
]);
2213 intermediate_results
[i
].symbol
= sym
;
2214 add_sal_to_sals (self
, &values
, &intermediate_results
[i
],
2215 sym
? SYMBOL_NATURAL_NAME (sym
) : NULL
, 0);
2219 if (values
.empty ())
2221 if (ls
->explicit_loc
.source_filename
)
2222 throw_error (NOT_FOUND_ERROR
, _("No line %d in file \"%s\"."),
2223 val
.line
, ls
->explicit_loc
.source_filename
);
2225 throw_error (NOT_FOUND_ERROR
, _("No line %d in the current file."),
2232 /* Convert the given ADDRESS into SaLs. */
2234 static std::vector
<symtab_and_line
>
2235 convert_address_location_to_sals (struct linespec_state
*self
,
2238 symtab_and_line sal
= find_pc_line (address
, 0);
2240 sal
.section
= find_pc_overlay (address
);
2241 sal
.explicit_pc
= 1;
2242 sal
.symbol
= find_pc_sect_containing_function (sal
.pc
, sal
.section
);
2244 std::vector
<symtab_and_line
> sals
;
2245 add_sal_to_sals (self
, &sals
, &sal
, core_addr_to_string (address
), 1);
2250 /* Create and return SALs from the linespec LS. */
2252 static std::vector
<symtab_and_line
>
2253 convert_linespec_to_sals (struct linespec_state
*state
, linespec_p ls
)
2255 std::vector
<symtab_and_line
> sals
;
2257 if (ls
->labels
.label_symbols
!= NULL
)
2259 /* We have just a bunch of functions/methods or labels. */
2260 struct symtab_and_line sal
;
2262 for (const auto &sym
: *ls
->labels
.label_symbols
)
2264 struct program_space
*pspace
2265 = SYMTAB_PSPACE (symbol_symtab (sym
.symbol
));
2267 if (symbol_to_sal (&sal
, state
->funfirstline
, sym
.symbol
)
2268 && maybe_add_address (state
->addr_set
, pspace
, sal
.pc
))
2269 add_sal_to_sals (state
, &sals
, &sal
,
2270 SYMBOL_NATURAL_NAME (sym
.symbol
), 0);
2273 else if (ls
->function_symbols
!= NULL
|| ls
->minimal_symbols
!= NULL
)
2275 /* We have just a bunch of functions and/or methods. */
2276 if (ls
->function_symbols
!= NULL
)
2278 /* Sort symbols so that symbols with the same program space are next
2280 std::sort (ls
->function_symbols
->begin (),
2281 ls
->function_symbols
->end (),
2284 for (const auto &sym
: *ls
->function_symbols
)
2286 program_space
*pspace
2287 = SYMTAB_PSPACE (symbol_symtab (sym
.symbol
));
2288 set_current_program_space (pspace
);
2290 /* Don't skip to the first line of the function if we
2291 had found an ifunc minimal symbol for this function,
2292 because that means that this function is an ifunc
2293 resolver with the same name as the ifunc itself. */
2294 bool found_ifunc
= false;
2296 if (state
->funfirstline
2297 && ls
->minimal_symbols
!= NULL
2298 && SYMBOL_CLASS (sym
.symbol
) == LOC_BLOCK
)
2300 const CORE_ADDR addr
2301 = BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
.symbol
));
2303 for (const auto &elem
: *ls
->minimal_symbols
)
2305 if (MSYMBOL_TYPE (elem
.minsym
) == mst_text_gnu_ifunc
2306 || MSYMBOL_TYPE (elem
.minsym
) == mst_data_gnu_ifunc
)
2308 CORE_ADDR msym_addr
= BMSYMBOL_VALUE_ADDRESS (elem
);
2309 if (MSYMBOL_TYPE (elem
.minsym
) == mst_data_gnu_ifunc
)
2311 struct gdbarch
*gdbarch
2312 = get_objfile_arch (elem
.objfile
);
2314 = (gdbarch_convert_from_func_ptr_addr
2317 current_top_target ()));
2320 if (msym_addr
== addr
)
2331 symtab_and_line sal
;
2332 if (symbol_to_sal (&sal
, state
->funfirstline
, sym
.symbol
)
2333 && maybe_add_address (state
->addr_set
, pspace
, sal
.pc
))
2334 add_sal_to_sals (state
, &sals
, &sal
,
2335 SYMBOL_NATURAL_NAME (sym
.symbol
), 0);
2340 if (ls
->minimal_symbols
!= NULL
)
2342 /* Sort minimal symbols by program space, too */
2343 std::sort (ls
->minimal_symbols
->begin (),
2344 ls
->minimal_symbols
->end (),
2347 for (const auto &elem
: *ls
->minimal_symbols
)
2349 program_space
*pspace
= elem
.objfile
->pspace
;
2350 set_current_program_space (pspace
);
2351 minsym_found (state
, elem
.objfile
, elem
.minsym
, &sals
);
2355 else if (ls
->explicit_loc
.line_offset
.sign
!= LINE_OFFSET_UNKNOWN
)
2357 /* Only an offset was specified. */
2358 sals
= create_sals_line_offset (state
, ls
);
2360 /* Make sure we have a filename for canonicalization. */
2361 if (ls
->explicit_loc
.source_filename
== NULL
)
2363 const char *fullname
= symtab_to_fullname (state
->default_symtab
);
2365 /* It may be more appropriate to keep DEFAULT_SYMTAB in its symtab
2366 form so that displaying SOURCE_FILENAME can follow the current
2367 FILENAME_DISPLAY_STRING setting. But as it is used only rarely
2368 it has been kept for code simplicity only in absolute form. */
2369 ls
->explicit_loc
.source_filename
= xstrdup (fullname
);
2374 /* We haven't found any results... */
2378 canonicalize_linespec (state
, ls
);
2380 if (!sals
.empty () && state
->canonical
!= NULL
)
2381 state
->canonical
->pre_expanded
= 1;
2386 /* Build RESULT from the explicit location components SOURCE_FILENAME,
2387 FUNCTION_NAME, LABEL_NAME and LINE_OFFSET. */
2390 convert_explicit_location_to_linespec (struct linespec_state
*self
,
2392 const char *source_filename
,
2393 const char *function_name
,
2394 symbol_name_match_type fname_match_type
,
2395 const char *label_name
,
2396 struct line_offset line_offset
)
2398 std::vector
<block_symbol
> symbols
;
2399 std::vector
<block_symbol
> *labels
;
2400 std::vector
<bound_minimal_symbol
> minimal_symbols
;
2402 result
->explicit_loc
.func_name_match_type
= fname_match_type
;
2404 if (source_filename
!= NULL
)
2408 *result
->file_symtabs
2409 = symtabs_from_filename (source_filename
, self
->search_pspace
);
2411 CATCH (except
, RETURN_MASK_ERROR
)
2413 source_file_not_found_error (source_filename
);
2416 result
->explicit_loc
.source_filename
= xstrdup (source_filename
);
2420 /* A NULL entry means to use the default symtab. */
2421 result
->file_symtabs
->push_back (nullptr);
2424 if (function_name
!= NULL
)
2426 find_linespec_symbols (self
, result
->file_symtabs
,
2427 function_name
, fname_match_type
,
2428 &symbols
, &minimal_symbols
);
2430 if (symbols
.empty () && minimal_symbols
.empty ())
2431 symbol_not_found_error (function_name
,
2432 result
->explicit_loc
.source_filename
);
2434 result
->explicit_loc
.function_name
= xstrdup (function_name
);
2435 result
->function_symbols
2436 = new std::vector
<block_symbol
> (std::move (symbols
));
2437 result
->minimal_symbols
2438 = new std::vector
<bound_minimal_symbol
> (std::move (minimal_symbols
));
2441 if (label_name
!= NULL
)
2443 labels
= find_label_symbols (self
, result
->function_symbols
,
2444 &symbols
, label_name
);
2447 undefined_label_error (result
->explicit_loc
.function_name
,
2450 result
->explicit_loc
.label_name
= xstrdup (label_name
);
2451 result
->labels
.label_symbols
= labels
;
2452 result
->labels
.function_symbols
2453 = new std::vector
<block_symbol
> (std::move (symbols
));
2456 if (line_offset
.sign
!= LINE_OFFSET_UNKNOWN
)
2457 result
->explicit_loc
.line_offset
= line_offset
;
2460 /* Convert the explicit location EXPLICIT_LOC into SaLs. */
2462 static std::vector
<symtab_and_line
>
2463 convert_explicit_location_to_sals (struct linespec_state
*self
,
2465 const struct explicit_location
*explicit_loc
)
2467 convert_explicit_location_to_linespec (self
, result
,
2468 explicit_loc
->source_filename
,
2469 explicit_loc
->function_name
,
2470 explicit_loc
->func_name_match_type
,
2471 explicit_loc
->label_name
,
2472 explicit_loc
->line_offset
);
2473 return convert_linespec_to_sals (self
, result
);
2476 /* Parse a string that specifies a linespec.
2478 The basic grammar of linespecs:
2480 linespec -> var_spec | basic_spec
2481 var_spec -> '$' (STRING | NUMBER)
2483 basic_spec -> file_offset_spec | function_spec | label_spec
2484 file_offset_spec -> opt_file_spec offset_spec
2485 function_spec -> opt_file_spec function_name_spec opt_label_spec
2486 label_spec -> label_name_spec
2488 opt_file_spec -> "" | file_name_spec ':'
2489 opt_label_spec -> "" | ':' label_name_spec
2491 file_name_spec -> STRING
2492 function_name_spec -> STRING
2493 label_name_spec -> STRING
2494 function_name_spec -> STRING
2495 offset_spec -> NUMBER
2499 This may all be followed by several keywords such as "if EXPR",
2502 A comma will terminate parsing.
2504 The function may be an undebuggable function found in minimal symbol table.
2506 If the argument FUNFIRSTLINE is nonzero, we want the first line
2507 of real code inside a function when a function is specified, and it is
2508 not OK to specify a variable or type to get its line number.
2510 DEFAULT_SYMTAB specifies the file to use if none is specified.
2511 It defaults to current_source_symtab.
2512 DEFAULT_LINE specifies the line number to use for relative
2513 line numbers (that start with signs). Defaults to current_source_line.
2514 If CANONICAL is non-NULL, store an array of strings containing the canonical
2515 line specs there if necessary. Currently overloaded member functions and
2516 line numbers or static functions without a filename yield a canonical
2517 line spec. The array and the line spec strings are allocated on the heap,
2518 it is the callers responsibility to free them.
2520 Note that it is possible to return zero for the symtab
2521 if no file is validly specified. Callers must check that.
2522 Also, the line number returned may be invalid. */
2524 /* Parse the linespec in ARG. MATCH_TYPE indicates how function names
2525 should be matched. */
2527 static std::vector
<symtab_and_line
>
2528 parse_linespec (linespec_parser
*parser
, const char *arg
,
2529 symbol_name_match_type match_type
)
2531 linespec_token token
;
2532 struct gdb_exception file_exception
= exception_none
;
2534 /* A special case to start. It has become quite popular for
2535 IDEs to work around bugs in the previous parser by quoting
2536 the entire linespec, so we attempt to deal with this nicely. */
2537 parser
->is_quote_enclosed
= 0;
2538 if (parser
->completion_tracker
== NULL
2539 && !is_ada_operator (arg
)
2540 && strchr (linespec_quote_characters
, *arg
) != NULL
)
2544 end
= skip_quote_char (arg
+ 1, *arg
);
2545 if (end
!= NULL
&& is_closing_quote_enclosed (end
))
2547 /* Here's the special case. Skip ARG past the initial
2550 parser
->is_quote_enclosed
= 1;
2554 parser
->lexer
.saved_arg
= arg
;
2555 parser
->lexer
.stream
= arg
;
2556 parser
->completion_word
= arg
;
2557 parser
->complete_what
= linespec_complete_what::FUNCTION
;
2558 PARSER_EXPLICIT (parser
)->func_name_match_type
= match_type
;
2560 /* Initialize the default symtab and line offset. */
2561 initialize_defaults (&PARSER_STATE (parser
)->default_symtab
,
2562 &PARSER_STATE (parser
)->default_line
);
2564 /* Objective-C shortcut. */
2565 if (parser
->completion_tracker
== NULL
)
2567 std::vector
<symtab_and_line
> values
2568 = decode_objc (PARSER_STATE (parser
), PARSER_RESULT (parser
), arg
);
2569 if (!values
.empty ())
2574 /* "-"/"+" is either an objc selector, or a number. There's
2575 nothing to complete the latter to, so just let the caller
2576 complete on functions, which finds objc selectors, if there's
2578 if ((arg
[0] == '-' || arg
[0] == '+') && arg
[1] == '\0')
2582 /* Start parsing. */
2584 /* Get the first token. */
2585 token
= linespec_lexer_consume_token (parser
);
2587 /* It must be either LSTOKEN_STRING or LSTOKEN_NUMBER. */
2588 if (token
.type
== LSTOKEN_STRING
&& *LS_TOKEN_STOKEN (token
).ptr
== '$')
2590 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2591 if (parser
->completion_tracker
== NULL
)
2592 PARSER_RESULT (parser
)->file_symtabs
->push_back (nullptr);
2594 /* User specified a convenience variable or history value. */
2595 gdb::unique_xmalloc_ptr
<char> var
= copy_token_string (token
);
2596 PARSER_EXPLICIT (parser
)->line_offset
2597 = linespec_parse_variable (PARSER_STATE (parser
), var
.get ());
2599 /* If a line_offset wasn't found (VAR is the name of a user
2600 variable/function), then skip to normal symbol processing. */
2601 if (PARSER_EXPLICIT (parser
)->line_offset
.sign
!= LINE_OFFSET_UNKNOWN
)
2603 /* Consume this token. */
2604 linespec_lexer_consume_token (parser
);
2606 goto convert_to_sals
;
2609 else if (token
.type
== LSTOKEN_EOI
&& parser
->completion_tracker
!= NULL
)
2611 /* Let the default linespec_complete_what::FUNCTION kick in. */
2612 unexpected_linespec_error (parser
);
2614 else if (token
.type
!= LSTOKEN_STRING
&& token
.type
!= LSTOKEN_NUMBER
)
2616 parser
->complete_what
= linespec_complete_what::NOTHING
;
2617 unexpected_linespec_error (parser
);
2620 /* Shortcut: If the next token is not LSTOKEN_COLON, we know that
2621 this token cannot represent a filename. */
2622 token
= linespec_lexer_peek_token (parser
);
2624 if (token
.type
== LSTOKEN_COLON
)
2626 /* Get the current token again and extract the filename. */
2627 token
= linespec_lexer_lex_one (parser
);
2628 gdb::unique_xmalloc_ptr
<char> user_filename
= copy_token_string (token
);
2630 /* Check if the input is a filename. */
2633 *PARSER_RESULT (parser
)->file_symtabs
2634 = symtabs_from_filename (user_filename
.get (),
2635 PARSER_STATE (parser
)->search_pspace
);
2637 CATCH (ex
, RETURN_MASK_ERROR
)
2639 file_exception
= ex
;
2643 if (file_exception
.reason
>= 0)
2645 /* Symtabs were found for the file. Record the filename. */
2646 PARSER_EXPLICIT (parser
)->source_filename
= user_filename
.release ();
2648 /* Get the next token. */
2649 token
= linespec_lexer_consume_token (parser
);
2651 /* This is LSTOKEN_COLON; consume it. */
2652 linespec_lexer_consume_token (parser
);
2656 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2657 PARSER_RESULT (parser
)->file_symtabs
->push_back (nullptr);
2660 /* If the next token is not EOI, KEYWORD, or COMMA, issue an error. */
2661 else if (parser
->completion_tracker
== NULL
2662 && (token
.type
!= LSTOKEN_EOI
&& token
.type
!= LSTOKEN_KEYWORD
2663 && token
.type
!= LSTOKEN_COMMA
))
2665 /* TOKEN is the _next_ token, not the one currently in the parser.
2666 Consuming the token will give the correct error message. */
2667 linespec_lexer_consume_token (parser
);
2668 unexpected_linespec_error (parser
);
2672 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2673 PARSER_RESULT (parser
)->file_symtabs
->push_back (nullptr);
2676 /* Parse the rest of the linespec. */
2677 linespec_parse_basic (parser
);
2679 if (parser
->completion_tracker
== NULL
2680 && PARSER_RESULT (parser
)->function_symbols
== NULL
2681 && PARSER_RESULT (parser
)->labels
.label_symbols
== NULL
2682 && PARSER_EXPLICIT (parser
)->line_offset
.sign
== LINE_OFFSET_UNKNOWN
2683 && PARSER_RESULT (parser
)->minimal_symbols
== NULL
)
2685 /* The linespec didn't parse. Re-throw the file exception if
2687 if (file_exception
.reason
< 0)
2688 throw_exception (file_exception
);
2690 /* Otherwise, the symbol is not found. */
2691 symbol_not_found_error (PARSER_EXPLICIT (parser
)->function_name
,
2692 PARSER_EXPLICIT (parser
)->source_filename
);
2697 /* Get the last token and record how much of the input was parsed,
2699 token
= linespec_lexer_lex_one (parser
);
2700 if (token
.type
!= LSTOKEN_EOI
&& token
.type
!= LSTOKEN_KEYWORD
)
2701 unexpected_linespec_error (parser
);
2702 else if (token
.type
== LSTOKEN_KEYWORD
)
2704 /* Setup the completion word past the keyword. Lexing never
2705 advances past a keyword automatically, so skip it
2707 parser
->completion_word
2708 = skip_spaces (skip_to_space (PARSER_STREAM (parser
)));
2709 parser
->complete_what
= linespec_complete_what::EXPRESSION
;
2712 /* Convert the data in PARSER_RESULT to SALs. */
2713 if (parser
->completion_tracker
== NULL
)
2714 return convert_linespec_to_sals (PARSER_STATE (parser
),
2715 PARSER_RESULT (parser
));
2721 /* A constructor for linespec_state. */
2724 linespec_state_constructor (struct linespec_state
*self
,
2725 int flags
, const struct language_defn
*language
,
2726 struct program_space
*search_pspace
,
2727 struct symtab
*default_symtab
,
2729 struct linespec_result
*canonical
)
2731 memset (self
, 0, sizeof (*self
));
2732 self
->language
= language
;
2733 self
->funfirstline
= (flags
& DECODE_LINE_FUNFIRSTLINE
) ? 1 : 0;
2734 self
->list_mode
= (flags
& DECODE_LINE_LIST_MODE
) ? 1 : 0;
2735 self
->search_pspace
= search_pspace
;
2736 self
->default_symtab
= default_symtab
;
2737 self
->default_line
= default_line
;
2738 self
->canonical
= canonical
;
2739 self
->program_space
= current_program_space
;
2740 self
->addr_set
= htab_create_alloc (10, hash_address_entry
, eq_address_entry
,
2741 xfree
, xcalloc
, xfree
);
2742 self
->is_linespec
= 0;
2745 /* Initialize a new linespec parser. */
2747 linespec_parser::linespec_parser (int flags
,
2748 const struct language_defn
*language
,
2749 struct program_space
*search_pspace
,
2750 struct symtab
*default_symtab
,
2752 struct linespec_result
*canonical
)
2754 lexer
.current
.type
= LSTOKEN_CONSUMED
;
2755 PARSER_RESULT (this)->file_symtabs
= new std::vector
<symtab
*> ();
2756 PARSER_EXPLICIT (this)->func_name_match_type
2757 = symbol_name_match_type::WILD
;
2758 PARSER_EXPLICIT (this)->line_offset
.sign
= LINE_OFFSET_UNKNOWN
;
2759 linespec_state_constructor (PARSER_STATE (this), flags
, language
,
2761 default_symtab
, default_line
, canonical
);
2764 /* A destructor for linespec_state. */
2767 linespec_state_destructor (struct linespec_state
*self
)
2769 htab_delete (self
->addr_set
);
2770 xfree (self
->canonical_names
);
2773 /* Delete a linespec parser. */
2775 linespec_parser::~linespec_parser ()
2777 xfree (PARSER_EXPLICIT (this)->source_filename
);
2778 xfree (PARSER_EXPLICIT (this)->label_name
);
2779 xfree (PARSER_EXPLICIT (this)->function_name
);
2781 delete PARSER_RESULT (this)->file_symtabs
;
2782 delete PARSER_RESULT (this)->function_symbols
;
2783 delete PARSER_RESULT (this)->minimal_symbols
;
2784 delete PARSER_RESULT (this)->labels
.label_symbols
;
2785 delete PARSER_RESULT (this)->labels
.function_symbols
;
2787 linespec_state_destructor (PARSER_STATE (this));
2790 /* See description in linespec.h. */
2793 linespec_lex_to_end (const char **stringp
)
2795 linespec_token token
;
2798 if (stringp
== NULL
|| *stringp
== NULL
)
2801 linespec_parser
parser (0, current_language
, NULL
, NULL
, 0, NULL
);
2802 parser
.lexer
.saved_arg
= *stringp
;
2803 PARSER_STREAM (&parser
) = orig
= *stringp
;
2807 /* Stop before any comma tokens; we need it to keep it
2808 as the next token in the string. */
2809 token
= linespec_lexer_peek_token (&parser
);
2810 if (token
.type
== LSTOKEN_COMMA
)
2812 token
= linespec_lexer_consume_token (&parser
);
2814 while (token
.type
!= LSTOKEN_EOI
&& token
.type
!= LSTOKEN_KEYWORD
);
2816 *stringp
+= PARSER_STREAM (&parser
) - orig
;
2819 /* See linespec.h. */
2822 linespec_complete_function (completion_tracker
&tracker
,
2823 const char *function
,
2824 symbol_name_match_type func_match_type
,
2825 const char *source_filename
)
2827 complete_symbol_mode mode
= complete_symbol_mode::LINESPEC
;
2829 if (source_filename
!= NULL
)
2831 collect_file_symbol_completion_matches (tracker
, mode
, func_match_type
,
2832 function
, function
, source_filename
);
2836 collect_symbol_completion_matches (tracker
, mode
, func_match_type
,
2837 function
, function
);
2842 /* Helper for complete_linespec to simplify it. SOURCE_FILENAME is
2843 only meaningful if COMPONENT is FUNCTION. */
2846 complete_linespec_component (linespec_parser
*parser
,
2847 completion_tracker
&tracker
,
2849 linespec_complete_what component
,
2850 const char *source_filename
)
2852 if (component
== linespec_complete_what::KEYWORD
)
2854 complete_on_enum (tracker
, linespec_keywords
, text
, text
);
2856 else if (component
== linespec_complete_what::EXPRESSION
)
2859 = advance_to_expression_complete_word_point (tracker
, text
);
2860 complete_expression (tracker
, text
, word
);
2862 else if (component
== linespec_complete_what::FUNCTION
)
2864 completion_list fn_list
;
2866 symbol_name_match_type match_type
2867 = PARSER_EXPLICIT (parser
)->func_name_match_type
;
2868 linespec_complete_function (tracker
, text
, match_type
, source_filename
);
2869 if (source_filename
== NULL
)
2871 /* Haven't seen a source component, like in "b
2872 file.c:function[TAB]". Maybe this wasn't a function, but
2873 a filename instead, like "b file.[TAB]". */
2874 fn_list
= complete_source_filenames (text
);
2877 /* If we only have a single filename completion, append a ':' for
2878 the user, since that's the only thing that can usefully follow
2880 if (fn_list
.size () == 1 && !tracker
.have_completions ())
2882 char *fn
= fn_list
[0].release ();
2884 /* If we also need to append a quote char, it needs to be
2885 appended before the ':'. Append it now, and make ':' the
2886 new "quote" char. */
2887 if (tracker
.quote_char ())
2889 char quote_char_str
[2] = { (char) tracker
.quote_char () };
2891 fn
= reconcat (fn
, fn
, quote_char_str
, (char *) NULL
);
2892 tracker
.set_quote_char (':');
2895 fn
= reconcat (fn
, fn
, ":", (char *) NULL
);
2896 fn_list
[0].reset (fn
);
2898 /* Tell readline to skip appending a space. */
2899 tracker
.set_suppress_append_ws (true);
2901 tracker
.add_completions (std::move (fn_list
));
2905 /* Helper for linespec_complete_label. Find labels that match
2906 LABEL_NAME in the function symbols listed in the PARSER, and add
2907 them to the tracker. */
2910 complete_label (completion_tracker
&tracker
,
2911 linespec_parser
*parser
,
2912 const char *label_name
)
2914 std::vector
<block_symbol
> label_function_symbols
;
2915 std::vector
<block_symbol
> *labels
2916 = find_label_symbols (PARSER_STATE (parser
),
2917 PARSER_RESULT (parser
)->function_symbols
,
2918 &label_function_symbols
,
2921 if (labels
!= nullptr)
2923 for (const auto &label
: *labels
)
2925 char *match
= xstrdup (SYMBOL_SEARCH_NAME (label
.symbol
));
2926 tracker
.add_completion (gdb::unique_xmalloc_ptr
<char> (match
));
2932 /* See linespec.h. */
2935 linespec_complete_label (completion_tracker
&tracker
,
2936 const struct language_defn
*language
,
2937 const char *source_filename
,
2938 const char *function_name
,
2939 symbol_name_match_type func_name_match_type
,
2940 const char *label_name
)
2942 linespec_parser
parser (0, language
, NULL
, NULL
, 0, NULL
);
2944 line_offset unknown_offset
= { 0, LINE_OFFSET_UNKNOWN
};
2948 convert_explicit_location_to_linespec (PARSER_STATE (&parser
),
2949 PARSER_RESULT (&parser
),
2952 func_name_match_type
,
2953 NULL
, unknown_offset
);
2955 CATCH (ex
, RETURN_MASK_ERROR
)
2961 complete_label (tracker
, &parser
, label_name
);
2964 /* See description in linespec.h. */
2967 linespec_complete (completion_tracker
&tracker
, const char *text
,
2968 symbol_name_match_type match_type
)
2970 const char *orig
= text
;
2972 linespec_parser
parser (0, current_language
, NULL
, NULL
, 0, NULL
);
2973 parser
.lexer
.saved_arg
= text
;
2974 PARSER_EXPLICIT (&parser
)->func_name_match_type
= match_type
;
2975 PARSER_STREAM (&parser
) = text
;
2977 parser
.completion_tracker
= &tracker
;
2978 PARSER_STATE (&parser
)->is_linespec
= 1;
2980 /* Parse as much as possible. parser.completion_word will hold
2981 furthest completion point we managed to parse to. */
2984 parse_linespec (&parser
, text
, match_type
);
2986 CATCH (except
, RETURN_MASK_ERROR
)
2991 if (parser
.completion_quote_char
!= '\0'
2992 && parser
.completion_quote_end
!= NULL
2993 && parser
.completion_quote_end
[1] == '\0')
2995 /* If completing a quoted string with the cursor right at
2996 terminating quote char, complete the completion word without
2997 interpretation, so that readline advances the cursor one
2998 whitespace past the quote, even if there's no match. This
2999 makes these cases behave the same:
3001 before: "b function()"
3002 after: "b function() "
3004 before: "b 'function()'"
3005 after: "b 'function()' "
3007 and trusts the user in this case:
3009 before: "b 'not_loaded_function_yet()'"
3010 after: "b 'not_loaded_function_yet()' "
3012 parser
.complete_what
= linespec_complete_what::NOTHING
;
3013 parser
.completion_quote_char
= '\0';
3015 gdb::unique_xmalloc_ptr
<char> text_copy
3016 (xstrdup (parser
.completion_word
));
3017 tracker
.add_completion (std::move (text_copy
));
3020 tracker
.set_quote_char (parser
.completion_quote_char
);
3022 if (parser
.complete_what
== linespec_complete_what::LABEL
)
3024 parser
.complete_what
= linespec_complete_what::NOTHING
;
3026 const char *func_name
= PARSER_EXPLICIT (&parser
)->function_name
;
3028 std::vector
<block_symbol
> function_symbols
;
3029 std::vector
<bound_minimal_symbol
> minimal_symbols
;
3030 find_linespec_symbols (PARSER_STATE (&parser
),
3031 PARSER_RESULT (&parser
)->file_symtabs
,
3032 func_name
, match_type
,
3033 &function_symbols
, &minimal_symbols
);
3035 PARSER_RESULT (&parser
)->function_symbols
3036 = new std::vector
<block_symbol
> (std::move (function_symbols
));
3037 PARSER_RESULT (&parser
)->minimal_symbols
3038 = new std::vector
<bound_minimal_symbol
> (std::move (minimal_symbols
));
3040 complete_label (tracker
, &parser
, parser
.completion_word
);
3042 else if (parser
.complete_what
== linespec_complete_what::FUNCTION
)
3044 /* While parsing/lexing, we didn't know whether the completion
3045 word completes to a unique function/source name already or
3049 "b function() <tab>"
3050 may need to complete either to:
3051 "b function() const"
3053 "b function() if/thread/task"
3057 may need to complete either to:
3058 "b foo template_fun<T>()"
3059 with "foo" being the template function's return type, or to:
3064 may need to complete either to a source file name:
3066 or this, also a filename, but a unique completion:
3068 or to a function name:
3071 Address that by completing assuming source or function, and
3072 seeing if we find a completion that matches exactly the
3073 completion word. If so, then it must be a function (see note
3074 below) and we advance the completion word to the end of input
3075 and switch to KEYWORD completion mode.
3077 Note: if we find a unique completion for a source filename,
3078 then it won't match the completion word, because the LCD will
3079 contain a trailing ':'. And if we're completing at or after
3080 the ':', then complete_linespec_component won't try to
3081 complete on source filenames. */
3083 const char *word
= parser
.completion_word
;
3085 complete_linespec_component (&parser
, tracker
,
3086 parser
.completion_word
,
3087 linespec_complete_what::FUNCTION
,
3088 PARSER_EXPLICIT (&parser
)->source_filename
);
3090 parser
.complete_what
= linespec_complete_what::NOTHING
;
3092 if (tracker
.quote_char ())
3094 /* The function/file name was not close-quoted, so this
3095 can't be a keyword. Note: complete_linespec_component
3096 may have swapped the original quote char for ':' when we
3097 get here, but that still indicates the same. */
3099 else if (!tracker
.have_completions ())
3102 size_t wordlen
= strlen (parser
.completion_word
);
3105 = string_find_incomplete_keyword_at_end (linespec_keywords
,
3106 parser
.completion_word
,
3111 && parser
.completion_word
[wordlen
- 1] == ' '))
3113 parser
.completion_word
+= key_start
;
3114 parser
.complete_what
= linespec_complete_what::KEYWORD
;
3117 else if (tracker
.completes_to_completion_word (word
))
3119 /* Skip the function and complete on keywords. */
3120 parser
.completion_word
+= strlen (word
);
3121 parser
.complete_what
= linespec_complete_what::KEYWORD
;
3122 tracker
.discard_completions ();
3126 tracker
.advance_custom_word_point_by (parser
.completion_word
- orig
);
3128 complete_linespec_component (&parser
, tracker
,
3129 parser
.completion_word
,
3130 parser
.complete_what
,
3131 PARSER_EXPLICIT (&parser
)->source_filename
);
3133 /* If we're past the "filename:function:label:offset" linespec, and
3134 didn't find any match, then assume the user might want to create
3135 a pending breakpoint anyway and offer the keyword
3137 if (!parser
.completion_quote_char
3138 && (parser
.complete_what
== linespec_complete_what::FUNCTION
3139 || parser
.complete_what
== linespec_complete_what::LABEL
3140 || parser
.complete_what
== linespec_complete_what::NOTHING
)
3141 && !tracker
.have_completions ())
3144 = parser
.completion_word
+ strlen (parser
.completion_word
);
3146 if (end
> orig
&& end
[-1] == ' ')
3148 tracker
.advance_custom_word_point_by (end
- parser
.completion_word
);
3150 complete_linespec_component (&parser
, tracker
, end
,
3151 linespec_complete_what::KEYWORD
,
3157 /* A helper function for decode_line_full and decode_line_1 to
3158 turn LOCATION into std::vector<symtab_and_line>. */
3160 static std::vector
<symtab_and_line
>
3161 event_location_to_sals (linespec_parser
*parser
,
3162 const struct event_location
*location
)
3164 std::vector
<symtab_and_line
> result
;
3166 switch (event_location_type (location
))
3168 case LINESPEC_LOCATION
:
3170 PARSER_STATE (parser
)->is_linespec
= 1;
3173 const linespec_location
*ls
= get_linespec_location (location
);
3174 result
= parse_linespec (parser
,
3175 ls
->spec_string
, ls
->match_type
);
3177 CATCH (except
, RETURN_MASK_ERROR
)
3179 throw_exception (except
);
3185 case ADDRESS_LOCATION
:
3187 const char *addr_string
= get_address_string_location (location
);
3188 CORE_ADDR addr
= get_address_location (location
);
3190 if (addr_string
!= NULL
)
3192 addr
= linespec_expression_to_pc (&addr_string
);
3193 if (PARSER_STATE (parser
)->canonical
!= NULL
)
3194 PARSER_STATE (parser
)->canonical
->location
3195 = copy_event_location (location
);
3198 result
= convert_address_location_to_sals (PARSER_STATE (parser
),
3203 case EXPLICIT_LOCATION
:
3205 const struct explicit_location
*explicit_loc
;
3207 explicit_loc
= get_explicit_location_const (location
);
3208 result
= convert_explicit_location_to_sals (PARSER_STATE (parser
),
3209 PARSER_RESULT (parser
),
3214 case PROBE_LOCATION
:
3215 /* Probes are handled by their own decoders. */
3216 gdb_assert_not_reached ("attempt to decode probe location");
3220 gdb_assert_not_reached ("unhandled event location type");
3226 /* See linespec.h. */
3229 decode_line_full (const struct event_location
*location
, int flags
,
3230 struct program_space
*search_pspace
,
3231 struct symtab
*default_symtab
,
3232 int default_line
, struct linespec_result
*canonical
,
3233 const char *select_mode
,
3236 std::vector
<const char *> filters
;
3237 struct linespec_state
*state
;
3239 gdb_assert (canonical
!= NULL
);
3240 /* The filter only makes sense for 'all'. */
3241 gdb_assert (filter
== NULL
|| select_mode
== multiple_symbols_all
);
3242 gdb_assert (select_mode
== NULL
3243 || select_mode
== multiple_symbols_all
3244 || select_mode
== multiple_symbols_ask
3245 || select_mode
== multiple_symbols_cancel
);
3246 gdb_assert ((flags
& DECODE_LINE_LIST_MODE
) == 0);
3248 linespec_parser
parser (flags
, current_language
,
3249 search_pspace
, default_symtab
,
3250 default_line
, canonical
);
3252 scoped_restore_current_program_space restore_pspace
;
3254 std::vector
<symtab_and_line
> result
= event_location_to_sals (&parser
,
3256 state
= PARSER_STATE (&parser
);
3258 gdb_assert (result
.size () == 1 || canonical
->pre_expanded
);
3259 canonical
->pre_expanded
= 1;
3261 /* Arrange for allocated canonical names to be freed. */
3262 std::vector
<gdb::unique_xmalloc_ptr
<char>> hold_names
;
3263 for (int i
= 0; i
< result
.size (); ++i
)
3265 gdb_assert (state
->canonical_names
[i
].suffix
!= NULL
);
3266 hold_names
.emplace_back (state
->canonical_names
[i
].suffix
);
3269 if (select_mode
== NULL
)
3271 if (top_level_interpreter ()->interp_ui_out ()->is_mi_like_p ())
3272 select_mode
= multiple_symbols_all
;
3274 select_mode
= multiple_symbols_select_mode ();
3277 if (select_mode
== multiple_symbols_all
)
3281 filters
.push_back (filter
);
3282 filter_results (state
, &result
, filters
);
3285 convert_results_to_lsals (state
, &result
);
3288 decode_line_2 (state
, &result
, select_mode
);
3291 /* See linespec.h. */
3293 std::vector
<symtab_and_line
>
3294 decode_line_1 (const struct event_location
*location
, int flags
,
3295 struct program_space
*search_pspace
,
3296 struct symtab
*default_symtab
,
3299 linespec_parser
parser (flags
, current_language
,
3300 search_pspace
, default_symtab
,
3301 default_line
, NULL
);
3303 scoped_restore_current_program_space restore_pspace
;
3305 return event_location_to_sals (&parser
, location
);
3308 /* See linespec.h. */
3310 std::vector
<symtab_and_line
>
3311 decode_line_with_current_source (const char *string
, int flags
)
3314 error (_("Empty line specification."));
3316 /* We use whatever is set as the current source line. We do not try
3317 and get a default source symtab+line or it will recursively call us! */
3318 symtab_and_line cursal
= get_current_source_symtab_and_line ();
3320 event_location_up location
= string_to_event_location (&string
,
3322 std::vector
<symtab_and_line
> sals
3323 = decode_line_1 (location
.get (), flags
, NULL
, cursal
.symtab
, cursal
.line
);
3326 error (_("Junk at end of line specification: %s"), string
);
3331 /* See linespec.h. */
3333 std::vector
<symtab_and_line
>
3334 decode_line_with_last_displayed (const char *string
, int flags
)
3337 error (_("Empty line specification."));
3339 event_location_up location
= string_to_event_location (&string
,
3341 std::vector
<symtab_and_line
> sals
3342 = (last_displayed_sal_is_valid ()
3343 ? decode_line_1 (location
.get (), flags
, NULL
,
3344 get_last_displayed_symtab (),
3345 get_last_displayed_line ())
3346 : decode_line_1 (location
.get (), flags
, NULL
,
3347 (struct symtab
*) NULL
, 0));
3350 error (_("Junk at end of line specification: %s"), string
);
3357 /* First, some functions to initialize stuff at the beggining of the
3361 initialize_defaults (struct symtab
**default_symtab
, int *default_line
)
3363 if (*default_symtab
== 0)
3365 /* Use whatever we have for the default source line. We don't use
3366 get_current_or_default_symtab_and_line as it can recurse and call
3368 struct symtab_and_line cursal
=
3369 get_current_source_symtab_and_line ();
3371 *default_symtab
= cursal
.symtab
;
3372 *default_line
= cursal
.line
;
3378 /* Evaluate the expression pointed to by EXP_PTR into a CORE_ADDR,
3379 advancing EXP_PTR past any parsed text. */
3382 linespec_expression_to_pc (const char **exp_ptr
)
3384 if (current_program_space
->executing_startup
)
3385 /* The error message doesn't really matter, because this case
3386 should only hit during breakpoint reset. */
3387 throw_error (NOT_FOUND_ERROR
, _("cannot evaluate expressions while "
3388 "program space is in startup"));
3391 return value_as_address (parse_to_comma_and_eval (exp_ptr
));
3396 /* Here's where we recognise an Objective-C Selector. An Objective C
3397 selector may be implemented by more than one class, therefore it
3398 may represent more than one method/function. This gives us a
3399 situation somewhat analogous to C++ overloading. If there's more
3400 than one method that could represent the selector, then use some of
3401 the existing C++ code to let the user choose one. */
3403 static std::vector
<symtab_and_line
>
3404 decode_objc (struct linespec_state
*self
, linespec_p ls
, const char *arg
)
3406 struct collect_info info
;
3407 std::vector
<const char *> symbol_names
;
3408 const char *new_argptr
;
3411 std::vector
<symtab
*> symtabs
;
3412 symtabs
.push_back (nullptr);
3414 info
.file_symtabs
= &symtabs
;
3416 std::vector
<block_symbol
> symbols
;
3417 info
.result
.symbols
= &symbols
;
3418 std::vector
<bound_minimal_symbol
> minimal_symbols
;
3419 info
.result
.minimal_symbols
= &minimal_symbols
;
3421 new_argptr
= find_imps (arg
, &symbol_names
);
3422 if (symbol_names
.empty ())
3425 add_all_symbol_names_from_pspace (&info
, NULL
, symbol_names
,
3428 std::vector
<symtab_and_line
> values
;
3429 if (!symbols
.empty () || !minimal_symbols
.empty ())
3433 saved_arg
= (char *) alloca (new_argptr
- arg
+ 1);
3434 memcpy (saved_arg
, arg
, new_argptr
- arg
);
3435 saved_arg
[new_argptr
- arg
] = '\0';
3437 ls
->explicit_loc
.function_name
= xstrdup (saved_arg
);
3438 ls
->function_symbols
3439 = new std::vector
<block_symbol
> (std::move (symbols
));
3441 = new std::vector
<bound_minimal_symbol
> (std::move (minimal_symbols
));
3442 values
= convert_linespec_to_sals (self
, ls
);
3444 if (self
->canonical
)
3449 self
->canonical
->pre_expanded
= 1;
3451 if (ls
->explicit_loc
.source_filename
)
3453 holder
= string_printf ("%s:%s",
3454 ls
->explicit_loc
.source_filename
,
3456 str
= holder
.c_str ();
3461 self
->canonical
->location
3462 = new_linespec_location (&str
, symbol_name_match_type::FULL
);
3471 /* A function object that serves as symbol_found_callback_ftype
3472 callback for iterate_over_symbols. This is used by
3473 lookup_prefix_sym to collect type symbols. */
3474 class decode_compound_collector
3477 decode_compound_collector ()
3479 m_unique_syms
= htab_create_alloc (1, htab_hash_pointer
,
3480 htab_eq_pointer
, NULL
,
3484 ~decode_compound_collector ()
3486 if (m_unique_syms
!= NULL
)
3487 htab_delete (m_unique_syms
);
3490 /* Return all symbols collected. */
3491 std::vector
<block_symbol
> release_symbols ()
3493 return std::move (m_symbols
);
3496 /* Callable as a symbol_found_callback_ftype callback. */
3497 bool operator () (block_symbol
*bsym
);
3500 /* A hash table of all symbols we found. We use this to avoid
3501 adding any symbol more than once. */
3502 htab_t m_unique_syms
;
3504 /* The result vector. */
3505 std::vector
<block_symbol
> m_symbols
;
3509 decode_compound_collector::operator () (block_symbol
*bsym
)
3513 struct symbol
*sym
= bsym
->symbol
;
3515 if (SYMBOL_CLASS (sym
) != LOC_TYPEDEF
)
3516 return true; /* Continue iterating. */
3518 t
= SYMBOL_TYPE (sym
);
3519 t
= check_typedef (t
);
3520 if (TYPE_CODE (t
) != TYPE_CODE_STRUCT
3521 && TYPE_CODE (t
) != TYPE_CODE_UNION
3522 && TYPE_CODE (t
) != TYPE_CODE_NAMESPACE
)
3523 return true; /* Continue iterating. */
3525 slot
= htab_find_slot (m_unique_syms
, sym
, INSERT
);
3529 m_symbols
.push_back (*bsym
);
3532 return true; /* Continue iterating. */
3537 /* Return any symbols corresponding to CLASS_NAME in FILE_SYMTABS. */
3539 static std::vector
<block_symbol
>
3540 lookup_prefix_sym (struct linespec_state
*state
,
3541 std::vector
<symtab
*> *file_symtabs
,
3542 const char *class_name
)
3544 decode_compound_collector collector
;
3546 lookup_name_info
lookup_name (class_name
, symbol_name_match_type::FULL
);
3548 for (const auto &elt
: *file_symtabs
)
3552 iterate_over_all_matching_symtabs (state
, lookup_name
,
3553 STRUCT_DOMAIN
, ALL_DOMAIN
,
3554 NULL
, false, collector
);
3555 iterate_over_all_matching_symtabs (state
, lookup_name
,
3556 VAR_DOMAIN
, ALL_DOMAIN
,
3557 NULL
, false, collector
);
3561 /* Program spaces that are executing startup should have
3562 been filtered out earlier. */
3563 gdb_assert (!SYMTAB_PSPACE (elt
)->executing_startup
);
3564 set_current_program_space (SYMTAB_PSPACE (elt
));
3565 iterate_over_file_blocks (elt
, lookup_name
, STRUCT_DOMAIN
, collector
);
3566 iterate_over_file_blocks (elt
, lookup_name
, VAR_DOMAIN
, collector
);
3570 return collector
.release_symbols ();
3573 /* A std::sort comparison function for symbols. The resulting order does
3574 not actually matter; we just need to be able to sort them so that
3575 symbols with the same program space end up next to each other. */
3578 compare_symbols (const block_symbol
&a
, const block_symbol
&b
)
3582 uia
= (uintptr_t) SYMTAB_PSPACE (symbol_symtab (a
.symbol
));
3583 uib
= (uintptr_t) SYMTAB_PSPACE (symbol_symtab (b
.symbol
));
3590 uia
= (uintptr_t) a
.symbol
;
3591 uib
= (uintptr_t) b
.symbol
;
3599 /* Like compare_symbols but for minimal symbols. */
3602 compare_msymbols (const bound_minimal_symbol
&a
, const bound_minimal_symbol
&b
)
3606 uia
= (uintptr_t) a
.objfile
->pspace
;
3607 uib
= (uintptr_t) a
.objfile
->pspace
;
3614 uia
= (uintptr_t) a
.minsym
;
3615 uib
= (uintptr_t) b
.minsym
;
3623 /* Look for all the matching instances of each symbol in NAMES. Only
3624 instances from PSPACE are considered; other program spaces are
3625 handled by our caller. If PSPACE is NULL, then all program spaces
3626 are considered. Results are stored into INFO. */
3629 add_all_symbol_names_from_pspace (struct collect_info
*info
,
3630 struct program_space
*pspace
,
3631 const std::vector
<const char *> &names
,
3632 enum search_domain search_domain
)
3634 for (const char *iter
: names
)
3635 add_matching_symbols_to_info (iter
,
3636 symbol_name_match_type::FULL
,
3637 search_domain
, info
, pspace
);
3641 find_superclass_methods (std::vector
<struct type
*> &&superclasses
,
3642 const char *name
, enum language name_lang
,
3643 std::vector
<const char *> *result_names
)
3645 size_t old_len
= result_names
->size ();
3649 std::vector
<struct type
*> new_supers
;
3651 for (type
*t
: superclasses
)
3652 find_methods (t
, name_lang
, name
, result_names
, &new_supers
);
3654 if (result_names
->size () != old_len
|| new_supers
.empty ())
3657 superclasses
= std::move (new_supers
);
3661 /* This finds the method METHOD_NAME in the class CLASS_NAME whose type is
3662 given by one of the symbols in SYM_CLASSES. Matches are returned
3663 in SYMBOLS (for debug symbols) and MINSYMS (for minimal symbols). */
3666 find_method (struct linespec_state
*self
, std::vector
<symtab
*> *file_symtabs
,
3667 const char *class_name
, const char *method_name
,
3668 std::vector
<block_symbol
> *sym_classes
,
3669 std::vector
<block_symbol
> *symbols
,
3670 std::vector
<bound_minimal_symbol
> *minsyms
)
3672 size_t last_result_len
;
3673 std::vector
<struct type
*> superclass_vec
;
3674 std::vector
<const char *> result_names
;
3675 struct collect_info info
;
3677 /* Sort symbols so that symbols with the same program space are next
3679 std::sort (sym_classes
->begin (), sym_classes
->end (),
3683 info
.file_symtabs
= file_symtabs
;
3684 info
.result
.symbols
= symbols
;
3685 info
.result
.minimal_symbols
= minsyms
;
3687 /* Iterate over all the types, looking for the names of existing
3688 methods matching METHOD_NAME. If we cannot find a direct method in a
3689 given program space, then we consider inherited methods; this is
3690 not ideal (ideal would be to respect C++ hiding rules), but it
3691 seems good enough and is what GDB has historically done. We only
3692 need to collect the names because later we find all symbols with
3693 those names. This loop is written in a somewhat funny way
3694 because we collect data across the program space before deciding
3696 last_result_len
= 0;
3697 unsigned int ix
= 0;
3698 for (const auto &elt
: *sym_classes
)
3701 struct program_space
*pspace
;
3702 struct symbol
*sym
= elt
.symbol
;
3704 /* Program spaces that are executing startup should have
3705 been filtered out earlier. */
3706 pspace
= SYMTAB_PSPACE (symbol_symtab (sym
));
3707 gdb_assert (!pspace
->executing_startup
);
3708 set_current_program_space (pspace
);
3709 t
= check_typedef (SYMBOL_TYPE (sym
));
3710 find_methods (t
, SYMBOL_LANGUAGE (sym
),
3711 method_name
, &result_names
, &superclass_vec
);
3713 /* Handle all items from a single program space at once; and be
3714 sure not to miss the last batch. */
3715 if (ix
== sym_classes
->size () - 1
3717 != SYMTAB_PSPACE (symbol_symtab (sym_classes
->at (ix
+ 1).symbol
))))
3719 /* If we did not find a direct implementation anywhere in
3720 this program space, consider superclasses. */
3721 if (result_names
.size () == last_result_len
)
3722 find_superclass_methods (std::move (superclass_vec
), method_name
,
3723 SYMBOL_LANGUAGE (sym
), &result_names
);
3725 /* We have a list of candidate symbol names, so now we
3726 iterate over the symbol tables looking for all
3727 matches in this pspace. */
3728 add_all_symbol_names_from_pspace (&info
, pspace
, result_names
,
3731 superclass_vec
.clear ();
3732 last_result_len
= result_names
.size ();
3737 if (!symbols
->empty () || !minsyms
->empty ())
3740 /* Throw an NOT_FOUND_ERROR. This will be caught by the caller
3741 and other attempts to locate the symbol will be made. */
3742 throw_error (NOT_FOUND_ERROR
, _("see caller, this text doesn't matter"));
3749 /* This function object is a callback for iterate_over_symtabs, used
3750 when collecting all matching symtabs. */
3752 class symtab_collector
3757 m_symtab_table
= htab_create (1, htab_hash_pointer
, htab_eq_pointer
,
3761 ~symtab_collector ()
3763 if (m_symtab_table
!= NULL
)
3764 htab_delete (m_symtab_table
);
3767 /* Callable as a symbol_found_callback_ftype callback. */
3768 bool operator () (symtab
*sym
);
3770 /* Return an rvalue reference to the collected symtabs. */
3771 std::vector
<symtab
*> &&release_symtabs ()
3773 return std::move (m_symtabs
);
3777 /* The result vector of symtabs. */
3778 std::vector
<symtab
*> m_symtabs
;
3780 /* This is used to ensure the symtabs are unique. */
3781 htab_t m_symtab_table
;
3785 symtab_collector::operator () (struct symtab
*symtab
)
3789 slot
= htab_find_slot (m_symtab_table
, symtab
, INSERT
);
3793 m_symtabs
.push_back (symtab
);
3801 /* Given a file name, return a list of all matching symtabs. If
3802 SEARCH_PSPACE is not NULL, the search is restricted to just that
3805 static std::vector
<symtab
*>
3806 collect_symtabs_from_filename (const char *file
,
3807 struct program_space
*search_pspace
)
3809 symtab_collector collector
;
3811 /* Find that file's data. */
3812 if (search_pspace
== NULL
)
3814 struct program_space
*pspace
;
3816 ALL_PSPACES (pspace
)
3818 if (pspace
->executing_startup
)
3821 set_current_program_space (pspace
);
3822 iterate_over_symtabs (file
, collector
);
3827 set_current_program_space (search_pspace
);
3828 iterate_over_symtabs (file
, collector
);
3831 return collector
.release_symtabs ();
3834 /* Return all the symtabs associated to the FILENAME. If SEARCH_PSPACE is
3835 not NULL, the search is restricted to just that program space. */
3837 static std::vector
<symtab
*>
3838 symtabs_from_filename (const char *filename
,
3839 struct program_space
*search_pspace
)
3841 std::vector
<symtab
*> result
3842 = collect_symtabs_from_filename (filename
, search_pspace
);
3844 if (result
.empty ())
3846 if (!have_full_symbols () && !have_partial_symbols ())
3847 throw_error (NOT_FOUND_ERROR
,
3848 _("No symbol table is loaded. "
3849 "Use the \"file\" command."));
3850 source_file_not_found_error (filename
);
3859 symbol_searcher::find_all_symbols (const std::string
&name
,
3860 const struct language_defn
*language
,
3861 enum search_domain search_domain
,
3862 std::vector
<symtab
*> *search_symtabs
,
3863 struct program_space
*search_pspace
)
3865 symbol_searcher_collect_info info
;
3866 struct linespec_state state
;
3868 memset (&state
, 0, sizeof (state
));
3869 state
.language
= language
;
3870 info
.state
= &state
;
3872 info
.result
.symbols
= &m_symbols
;
3873 info
.result
.minimal_symbols
= &m_minimal_symbols
;
3874 std::vector
<symtab
*> all_symtabs
;
3875 if (search_symtabs
== nullptr)
3877 all_symtabs
.push_back (nullptr);
3878 search_symtabs
= &all_symtabs
;
3880 info
.file_symtabs
= search_symtabs
;
3882 add_matching_symbols_to_info (name
.c_str (), symbol_name_match_type::WILD
,
3883 search_domain
, &info
, search_pspace
);
3886 /* Look up a function symbol named NAME in symtabs FILE_SYMTABS. Matching
3887 debug symbols are returned in SYMBOLS. Matching minimal symbols are
3888 returned in MINSYMS. */
3891 find_function_symbols (struct linespec_state
*state
,
3892 std::vector
<symtab
*> *file_symtabs
, const char *name
,
3893 symbol_name_match_type name_match_type
,
3894 std::vector
<block_symbol
> *symbols
,
3895 std::vector
<bound_minimal_symbol
> *minsyms
)
3897 struct collect_info info
;
3898 std::vector
<const char *> symbol_names
;
3901 info
.result
.symbols
= symbols
;
3902 info
.result
.minimal_symbols
= minsyms
;
3903 info
.file_symtabs
= file_symtabs
;
3905 /* Try NAME as an Objective-C selector. */
3906 find_imps (name
, &symbol_names
);
3907 if (!symbol_names
.empty ())
3908 add_all_symbol_names_from_pspace (&info
, state
->search_pspace
,
3909 symbol_names
, FUNCTIONS_DOMAIN
);
3911 add_matching_symbols_to_info (name
, name_match_type
, FUNCTIONS_DOMAIN
,
3912 &info
, state
->search_pspace
);
3915 /* Find all symbols named NAME in FILE_SYMTABS, returning debug symbols
3916 in SYMBOLS and minimal symbols in MINSYMS. */
3919 find_linespec_symbols (struct linespec_state
*state
,
3920 std::vector
<symtab
*> *file_symtabs
,
3921 const char *lookup_name
,
3922 symbol_name_match_type name_match_type
,
3923 std::vector
<block_symbol
> *symbols
,
3924 std::vector
<bound_minimal_symbol
> *minsyms
)
3926 std::string canon
= cp_canonicalize_string_no_typedefs (lookup_name
);
3927 if (!canon
.empty ())
3928 lookup_name
= canon
.c_str ();
3930 /* It's important to not call expand_symtabs_matching unnecessarily
3931 as it can really slow things down (by unnecessarily expanding
3932 potentially 1000s of symtabs, which when debugging some apps can
3933 cost 100s of seconds). Avoid this to some extent by *first* calling
3934 find_function_symbols, and only if that doesn't find anything
3935 *then* call find_method. This handles two important cases:
3936 1) break (anonymous namespace)::foo
3937 2) break class::method where method is in class (and not a baseclass) */
3939 find_function_symbols (state
, file_symtabs
, lookup_name
,
3940 name_match_type
, symbols
, minsyms
);
3942 /* If we were unable to locate a symbol of the same name, try dividing
3943 the name into class and method names and searching the class and its
3945 if (symbols
->empty () && minsyms
->empty ())
3947 std::string klass
, method
;
3948 const char *last
, *p
, *scope_op
;
3950 /* See if we can find a scope operator and break this symbol
3951 name into namespaces${SCOPE_OPERATOR}class_name and method_name. */
3953 p
= find_toplevel_string (lookup_name
, scope_op
);
3959 p
= find_toplevel_string (p
+ strlen (scope_op
), scope_op
);
3962 /* If no scope operator was found, there is nothing more we can do;
3963 we already attempted to lookup the entire name as a symbol
3968 /* LOOKUP_NAME points to the class name.
3969 LAST points to the method name. */
3970 klass
= std::string (lookup_name
, last
- lookup_name
);
3972 /* Skip past the scope operator. */
3973 last
+= strlen (scope_op
);
3976 /* Find a list of classes named KLASS. */
3977 std::vector
<block_symbol
> classes
3978 = lookup_prefix_sym (state
, file_symtabs
, klass
.c_str ());
3979 if (!classes
.empty ())
3981 /* Now locate a list of suitable methods named METHOD. */
3984 find_method (state
, file_symtabs
,
3985 klass
.c_str (), method
.c_str (),
3986 &classes
, symbols
, minsyms
);
3989 /* If successful, we're done. If NOT_FOUND_ERROR
3990 was not thrown, rethrow the exception that we did get. */
3991 CATCH (except
, RETURN_MASK_ERROR
)
3993 if (except
.error
!= NOT_FOUND_ERROR
)
3994 throw_exception (except
);
4001 /* Helper for find_label_symbols. Find all labels that match name
4002 NAME in BLOCK. Return all labels that match in FUNCTION_SYMBOLS.
4003 Return the actual function symbol in which the label was found in
4004 LABEL_FUNC_RET. If COMPLETION_MODE is true, then NAME is
4005 interpreted as a label name prefix. Otherwise, only a label named
4006 exactly NAME match. */
4009 find_label_symbols_in_block (const struct block
*block
,
4010 const char *name
, struct symbol
*fn_sym
,
4011 bool completion_mode
,
4012 std::vector
<block_symbol
> *result
,
4013 std::vector
<block_symbol
> *label_funcs_ret
)
4015 if (completion_mode
)
4017 struct block_iterator iter
;
4019 size_t name_len
= strlen (name
);
4021 int (*cmp
) (const char *, const char *, size_t);
4022 cmp
= case_sensitivity
== case_sensitive_on
? strncmp
: strncasecmp
;
4024 ALL_BLOCK_SYMBOLS (block
, iter
, sym
)
4026 if (symbol_matches_domain (SYMBOL_LANGUAGE (sym
),
4027 SYMBOL_DOMAIN (sym
), LABEL_DOMAIN
)
4028 && cmp (SYMBOL_SEARCH_NAME (sym
), name
, name_len
) == 0)
4030 result
->push_back ({sym
, block
});
4031 label_funcs_ret
->push_back ({fn_sym
, block
});
4037 struct block_symbol label_sym
4038 = lookup_symbol (name
, block
, LABEL_DOMAIN
, 0);
4040 if (label_sym
.symbol
!= NULL
)
4042 result
->push_back (label_sym
);
4043 label_funcs_ret
->push_back ({fn_sym
, block
});
4048 /* Return all labels that match name NAME in FUNCTION_SYMBOLS or NULL
4049 if no matches were found.
4051 Return the actual function symbol in which the label was found in
4052 LABEL_FUNC_RET. If COMPLETION_MODE is true, then NAME is
4053 interpreted as a label name prefix. Otherwise, only labels named
4054 exactly NAME match. */
4057 static std::vector
<block_symbol
> *
4058 find_label_symbols (struct linespec_state
*self
,
4059 std::vector
<block_symbol
> *function_symbols
,
4060 std::vector
<block_symbol
> *label_funcs_ret
,
4062 bool completion_mode
)
4064 const struct block
*block
;
4065 struct symbol
*fn_sym
;
4066 std::vector
<block_symbol
> result
;
4068 if (function_symbols
== NULL
)
4070 set_current_program_space (self
->program_space
);
4071 block
= get_current_search_block ();
4074 block
&& !BLOCK_FUNCTION (block
);
4075 block
= BLOCK_SUPERBLOCK (block
))
4079 fn_sym
= BLOCK_FUNCTION (block
);
4081 find_label_symbols_in_block (block
, name
, fn_sym
, completion_mode
,
4082 &result
, label_funcs_ret
);
4086 for (const auto &elt
: *function_symbols
)
4088 fn_sym
= elt
.symbol
;
4089 set_current_program_space (SYMTAB_PSPACE (symbol_symtab (fn_sym
)));
4090 block
= SYMBOL_BLOCK_VALUE (fn_sym
);
4092 find_label_symbols_in_block (block
, name
, fn_sym
, completion_mode
,
4093 &result
, label_funcs_ret
);
4097 if (!result
.empty ())
4098 return new std::vector
<block_symbol
> (std::move (result
));
4104 /* A helper for create_sals_line_offset that handles the 'list_mode' case. */
4106 static std::vector
<symtab_and_line
>
4107 decode_digits_list_mode (struct linespec_state
*self
,
4109 struct symtab_and_line val
)
4111 gdb_assert (self
->list_mode
);
4113 std::vector
<symtab_and_line
> values
;
4115 for (const auto &elt
: *ls
->file_symtabs
)
4117 /* The logic above should ensure this. */
4118 gdb_assert (elt
!= NULL
);
4120 set_current_program_space (SYMTAB_PSPACE (elt
));
4122 /* Simplistic search just for the list command. */
4123 val
.symtab
= find_line_symtab (elt
, val
.line
, NULL
, NULL
);
4124 if (val
.symtab
== NULL
)
4126 val
.pspace
= SYMTAB_PSPACE (elt
);
4128 val
.explicit_line
= 1;
4130 add_sal_to_sals (self
, &values
, &val
, NULL
, 0);
4136 /* A helper for create_sals_line_offset that iterates over the symtabs,
4137 adding lines to the VEC. */
4139 static std::vector
<symtab_and_line
>
4140 decode_digits_ordinary (struct linespec_state
*self
,
4143 struct linetable_entry
**best_entry
)
4145 std::vector
<symtab_and_line
> sals
;
4146 for (const auto &elt
: *ls
->file_symtabs
)
4148 std::vector
<CORE_ADDR
> pcs
;
4150 /* The logic above should ensure this. */
4151 gdb_assert (elt
!= NULL
);
4153 set_current_program_space (SYMTAB_PSPACE (elt
));
4155 pcs
= find_pcs_for_symtab_line (elt
, line
, best_entry
);
4156 for (CORE_ADDR pc
: pcs
)
4158 symtab_and_line sal
;
4159 sal
.pspace
= SYMTAB_PSPACE (elt
);
4163 sals
.push_back (std::move (sal
));
4172 /* Return the line offset represented by VARIABLE. */
4174 static struct line_offset
4175 linespec_parse_variable (struct linespec_state
*self
, const char *variable
)
4179 struct line_offset offset
= {0, LINE_OFFSET_NONE
};
4181 p
= (variable
[1] == '$') ? variable
+ 2 : variable
+ 1;
4184 while (*p
>= '0' && *p
<= '9')
4186 if (!*p
) /* Reached end of token without hitting non-digit. */
4188 /* We have a value history reference. */
4189 struct value
*val_history
;
4191 sscanf ((variable
[1] == '$') ? variable
+ 2 : variable
+ 1, "%d", &index
);
4193 = access_value_history ((variable
[1] == '$') ? -index
: index
);
4194 if (TYPE_CODE (value_type (val_history
)) != TYPE_CODE_INT
)
4195 error (_("History values used in line "
4196 "specs must have integer values."));
4197 offset
.offset
= value_as_long (val_history
);
4201 /* Not all digits -- may be user variable/function or a
4202 convenience variable. */
4204 struct internalvar
*ivar
;
4206 /* Try it as a convenience variable. If it is not a convenience
4207 variable, return and allow normal symbol lookup to occur. */
4208 ivar
= lookup_only_internalvar (variable
+ 1);
4210 /* No internal variable with that name. Mark the offset
4211 as unknown to allow the name to be looked up as a symbol. */
4212 offset
.sign
= LINE_OFFSET_UNKNOWN
;
4215 /* We found a valid variable name. If it is not an integer,
4217 if (!get_internalvar_integer (ivar
, &valx
))
4218 error (_("Convenience variables used in line "
4219 "specs must have integer values."));
4221 offset
.offset
= valx
;
4229 /* We've found a minimal symbol MSYMBOL in OBJFILE to associate with our
4230 linespec; return the SAL in RESULT. This function should return SALs
4231 matching those from find_function_start_sal, otherwise false
4232 multiple-locations breakpoints could be placed. */
4235 minsym_found (struct linespec_state
*self
, struct objfile
*objfile
,
4236 struct minimal_symbol
*msymbol
,
4237 std::vector
<symtab_and_line
> *result
)
4239 bool want_start_sal
;
4241 CORE_ADDR func_addr
;
4242 bool is_function
= msymbol_is_function (objfile
, msymbol
, &func_addr
);
4246 const char *msym_name
= MSYMBOL_LINKAGE_NAME (msymbol
);
4248 if (MSYMBOL_TYPE (msymbol
) == mst_text_gnu_ifunc
4249 || MSYMBOL_TYPE (msymbol
) == mst_data_gnu_ifunc
)
4250 want_start_sal
= gnu_ifunc_resolve_name (msym_name
, &func_addr
);
4252 want_start_sal
= true;
4255 symtab_and_line sal
;
4257 if (is_function
&& want_start_sal
)
4258 sal
= find_function_start_sal (func_addr
, NULL
, self
->funfirstline
);
4261 sal
.objfile
= objfile
;
4262 sal
.msymbol
= msymbol
;
4263 /* Store func_addr, not the minsym's address in case this was an
4264 ifunc that hasn't been resolved yet. */
4268 sal
.pc
= MSYMBOL_VALUE_ADDRESS (objfile
, msymbol
);
4269 sal
.pspace
= current_program_space
;
4272 sal
.section
= MSYMBOL_OBJ_SECTION (objfile
, msymbol
);
4274 if (maybe_add_address (self
->addr_set
, objfile
->pspace
, sal
.pc
))
4275 add_sal_to_sals (self
, result
, &sal
, MSYMBOL_NATURAL_NAME (msymbol
), 0);
4278 /* A helper function to classify a minimal_symbol_type according to
4282 classify_mtype (enum minimal_symbol_type t
)
4289 /* Intermediate priority. */
4292 case mst_solib_trampoline
:
4293 /* Lowest priority. */
4297 /* Highest priority. */
4302 /* Callback for std::sort that sorts symbols by priority. */
4305 compare_msyms (const bound_minimal_symbol
&a
, const bound_minimal_symbol
&b
)
4307 enum minimal_symbol_type ta
= MSYMBOL_TYPE (a
.minsym
);
4308 enum minimal_symbol_type tb
= MSYMBOL_TYPE (b
.minsym
);
4310 return classify_mtype (ta
) < classify_mtype (tb
);
4313 /* Helper for search_minsyms_for_name that adds the symbol to the
4317 add_minsym (struct minimal_symbol
*minsym
, struct objfile
*objfile
,
4318 struct symtab
*symtab
, int list_mode
,
4319 std::vector
<struct bound_minimal_symbol
> *msyms
)
4323 /* We're looking for a label for which we don't have debug
4325 CORE_ADDR func_addr
;
4326 if (msymbol_is_function (objfile
, minsym
, &func_addr
))
4328 symtab_and_line sal
= find_pc_sect_line (func_addr
, NULL
, 0);
4330 if (symtab
!= sal
.symtab
)
4335 /* Exclude data symbols when looking for breakpoint locations. */
4336 if (!list_mode
&& !msymbol_is_function (objfile
, minsym
))
4339 struct bound_minimal_symbol mo
= {minsym
, objfile
};
4340 msyms
->push_back (mo
);
4344 /* Search for minimal symbols called NAME. If SEARCH_PSPACE
4345 is not NULL, the search is restricted to just that program
4348 If SYMTAB is NULL, search all objfiles, otherwise
4349 restrict results to the given SYMTAB. */
4352 search_minsyms_for_name (struct collect_info
*info
,
4353 const lookup_name_info
&name
,
4354 struct program_space
*search_pspace
,
4355 struct symtab
*symtab
)
4357 std::vector
<struct bound_minimal_symbol
> minsyms
;
4361 struct program_space
*pspace
;
4363 ALL_PSPACES (pspace
)
4365 struct objfile
*objfile
;
4367 if (search_pspace
!= NULL
&& search_pspace
!= pspace
)
4369 if (pspace
->executing_startup
)
4372 set_current_program_space (pspace
);
4374 ALL_OBJFILES (objfile
)
4376 iterate_over_minimal_symbols (objfile
, name
,
4377 [&] (struct minimal_symbol
*msym
)
4379 add_minsym (msym
, objfile
, nullptr,
4380 info
->state
->list_mode
,
4389 if (search_pspace
== NULL
|| SYMTAB_PSPACE (symtab
) == search_pspace
)
4391 set_current_program_space (SYMTAB_PSPACE (symtab
));
4392 iterate_over_minimal_symbols
4393 (SYMTAB_OBJFILE (symtab
), name
,
4394 [&] (struct minimal_symbol
*msym
)
4396 add_minsym (msym
, SYMTAB_OBJFILE (symtab
), symtab
,
4397 info
->state
->list_mode
, &minsyms
);
4403 if (!minsyms
.empty ())
4407 std::sort (minsyms
.begin (), minsyms
.end (), compare_msyms
);
4409 /* Now the minsyms are in classification order. So, we walk
4410 over them and process just the minsyms with the same
4411 classification as the very first minsym in the list. */
4412 classification
= classify_mtype (MSYMBOL_TYPE (minsyms
[0].minsym
));
4414 for (const bound_minimal_symbol
&item
: minsyms
)
4416 if (classify_mtype (MSYMBOL_TYPE (item
.minsym
)) != classification
)
4419 info
->result
.minimal_symbols
->push_back (item
);
4424 /* A helper function to add all symbols matching NAME to INFO. If
4425 PSPACE is not NULL, the search is restricted to just that program
4429 add_matching_symbols_to_info (const char *name
,
4430 symbol_name_match_type name_match_type
,
4431 enum search_domain search_domain
,
4432 struct collect_info
*info
,
4433 struct program_space
*pspace
)
4435 lookup_name_info
lookup_name (name
, name_match_type
);
4437 for (const auto &elt
: *info
->file_symtabs
)
4441 iterate_over_all_matching_symtabs (info
->state
, lookup_name
,
4442 VAR_DOMAIN
, search_domain
,
4444 [&] (block_symbol
*bsym
)
4445 { return info
->add_symbol (bsym
); });
4446 search_minsyms_for_name (info
, lookup_name
, pspace
, NULL
);
4448 else if (pspace
== NULL
|| pspace
== SYMTAB_PSPACE (elt
))
4450 int prev_len
= info
->result
.symbols
->size ();
4452 /* Program spaces that are executing startup should have
4453 been filtered out earlier. */
4454 gdb_assert (!SYMTAB_PSPACE (elt
)->executing_startup
);
4455 set_current_program_space (SYMTAB_PSPACE (elt
));
4456 iterate_over_file_blocks (elt
, lookup_name
, VAR_DOMAIN
,
4457 [&] (block_symbol
*bsym
)
4458 { return info
->add_symbol (bsym
); });
4460 /* If no new symbols were found in this iteration and this symtab
4461 is in assembler, we might actually be looking for a label for
4462 which we don't have debug info. Check for a minimal symbol in
4464 if (prev_len
== info
->result
.symbols
->size ()
4465 && elt
->language
== language_asm
)
4466 search_minsyms_for_name (info
, lookup_name
, pspace
, elt
);
4473 /* Now come some functions that are called from multiple places within
4477 symbol_to_sal (struct symtab_and_line
*result
,
4478 int funfirstline
, struct symbol
*sym
)
4480 if (SYMBOL_CLASS (sym
) == LOC_BLOCK
)
4482 *result
= find_function_start_sal (sym
, funfirstline
);
4487 if (SYMBOL_CLASS (sym
) == LOC_LABEL
&& SYMBOL_VALUE_ADDRESS (sym
) != 0)
4490 result
->symtab
= symbol_symtab (sym
);
4491 result
->symbol
= sym
;
4492 result
->line
= SYMBOL_LINE (sym
);
4493 result
->pc
= SYMBOL_VALUE_ADDRESS (sym
);
4494 result
->pspace
= SYMTAB_PSPACE (result
->symtab
);
4495 result
->explicit_pc
= 1;
4498 else if (funfirstline
)
4502 else if (SYMBOL_LINE (sym
) != 0)
4504 /* We know its line number. */
4506 result
->symtab
= symbol_symtab (sym
);
4507 result
->symbol
= sym
;
4508 result
->line
= SYMBOL_LINE (sym
);
4509 result
->pc
= SYMBOL_VALUE_ADDRESS (sym
);
4510 result
->pspace
= SYMTAB_PSPACE (result
->symtab
);
4518 linespec_result::~linespec_result ()
4520 for (linespec_sals
&lsal
: lsals
)
4521 xfree (lsal
.canonical
);
4524 /* Return the quote characters permitted by the linespec parser. */
4527 get_gdb_linespec_parser_quote_characters (void)
4529 return linespec_quote_characters
;