1 /* Parser for linespec for the GNU debugger, GDB.
3 Copyright (C) 1986-2018 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 /* Typedef for unique_ptrs of vectors of symtabs. */
82 typedef std::unique_ptr
<std::vector
<symtab
*>> symtab_vector_up
;
84 typedef struct symbol
*symbolp
;
87 /* An address entry is used to ensure that any given location is only
88 added to the result a single time. It holds an address and the
89 program space from which the address came. */
93 struct program_space
*pspace
;
97 typedef struct bound_minimal_symbol bound_minimal_symbol_d
;
99 DEF_VEC_O (bound_minimal_symbol_d
);
101 /* A linespec. Elements of this structure are filled in by a parser
102 (either parse_linespec or some other function). The structure is
103 then converted into SALs by convert_linespec_to_sals. */
107 /* An explicit location describing the SaLs. */
108 struct explicit_location explicit_loc
;
110 /* The list of symtabs to search to which to limit the search. May not
111 be NULL. If explicit.SOURCE_FILENAME is NULL (no user-specified
112 filename), FILE_SYMTABS should contain one single NULL member. This
113 will cause the code to use the default symtab. */
114 std::vector
<symtab
*> *file_symtabs
;
116 /* A list of matching function symbols and minimal symbols. Both lists
117 may be NULL if no matching symbols were found. */
118 VEC (symbolp
) *function_symbols
;
119 VEC (bound_minimal_symbol_d
) *minimal_symbols
;
121 /* A structure of matching label symbols and the corresponding
122 function symbol in which the label was found. Both may be NULL
123 or both must be non-NULL. */
126 VEC (symbolp
) *label_symbols
;
127 VEC (symbolp
) *function_symbols
;
130 typedef struct linespec
*linespec_p
;
132 /* A canonical linespec represented as a symtab-related string.
134 Each entry represents the "SYMTAB:SUFFIX" linespec string.
135 SYMTAB can be converted for example by symtab_to_fullname or
136 symtab_to_filename_for_display as needed. */
138 struct linespec_canonical_name
140 /* Remaining text part of the linespec string. */
143 /* If NULL then SUFFIX is the whole linespec string. */
144 struct symtab
*symtab
;
147 /* An instance of this is used to keep all state while linespec
148 operates. This instance is passed around as a 'this' pointer to
149 the various implementation methods. */
151 struct linespec_state
153 /* The language in use during linespec processing. */
154 const struct language_defn
*language
;
156 /* The program space as seen when the module was entered. */
157 struct program_space
*program_space
;
159 /* If not NULL, the search is restricted to just this program
161 struct program_space
*search_pspace
;
163 /* The default symtab to use, if no other symtab is specified. */
164 struct symtab
*default_symtab
;
166 /* The default line to use. */
169 /* The 'funfirstline' value that was passed in to decode_line_1 or
173 /* Nonzero if we are running in 'list' mode; see decode_line_list. */
176 /* The 'canonical' value passed to decode_line_full, or NULL. */
177 struct linespec_result
*canonical
;
179 /* Canonical strings that mirror the std::vector<symtab_and_line> result. */
180 struct linespec_canonical_name
*canonical_names
;
182 /* This is a set of address_entry objects which is used to prevent
183 duplicate symbols from being entered into the result. */
186 /* Are we building a linespec? */
190 /* This is a helper object that is used when collecting symbols into a
195 /* The linespec object in use. */
196 struct linespec_state
*state
;
198 /* A list of symtabs to which to restrict matches. */
199 std::vector
<symtab
*> *file_symtabs
;
201 /* The result being accumulated. */
204 VEC (symbolp
) *symbols
;
205 VEC (bound_minimal_symbol_d
) *minimal_symbols
;
208 /* Possibly add a symbol to the results. */
209 bool add_symbol (symbol
*sym
);
213 collect_info::add_symbol (symbol
*sym
)
215 /* In list mode, add all matching symbols, regardless of class.
216 This allows the user to type "list a_global_variable". */
217 if (SYMBOL_CLASS (sym
) == LOC_BLOCK
|| this->state
->list_mode
)
218 VEC_safe_push (symbolp
, this->result
.symbols
, sym
);
220 /* Continue iterating. */
231 /* A colon "separator" */
243 /* EOI (end of input) */
249 typedef enum ls_token_type linespec_token_type
;
251 /* List of keywords. This is NULL-terminated so that it can be used
252 as enum completer. */
253 const char * const linespec_keywords
[] = { "if", "thread", "task", NULL
};
254 #define IF_KEYWORD_INDEX 0
256 /* A token of the linespec lexer */
260 /* The type of the token */
261 linespec_token_type type
;
263 /* Data for the token */
266 /* A string, given as a stoken */
267 struct stoken string
;
273 typedef struct ls_token linespec_token
;
275 #define LS_TOKEN_STOKEN(TOK) (TOK).data.string
276 #define LS_TOKEN_KEYWORD(TOK) (TOK).data.keyword
278 /* An instance of the linespec parser. */
282 /* Lexer internal data */
285 /* Save head of input stream. */
286 const char *saved_arg
;
288 /* Head of the input stream. */
290 #define PARSER_STREAM(P) ((P)->lexer.stream)
292 /* The current token. */
293 linespec_token current
;
296 /* Is the entire linespec quote-enclosed? */
297 int is_quote_enclosed
;
299 /* The state of the parse. */
300 struct linespec_state state
;
301 #define PARSER_STATE(PPTR) (&(PPTR)->state)
303 /* The result of the parse. */
304 struct linespec result
;
305 #define PARSER_RESULT(PPTR) (&(PPTR)->result)
307 /* What the parser believes the current word point should complete
309 linespec_complete_what complete_what
;
311 /* The completion word point. The parser advances this as it skips
312 tokens. At some point the input string will end or parsing will
313 fail, and then we attempt completion at the captured completion
314 word point, interpreting the string at completion_word as
316 const char *completion_word
;
318 /* If the current token was a quoted string, then this is the
319 quoting character (either " or '). */
320 int completion_quote_char
;
322 /* If the current token was a quoted string, then this points at the
323 end of the quoted string. */
324 const char *completion_quote_end
;
326 /* If parsing for completion, then this points at the completion
327 tracker. Otherwise, this is NULL. */
328 struct completion_tracker
*completion_tracker
;
330 typedef struct ls_parser linespec_parser
;
332 /* A convenience macro for accessing the explicit location result of
334 #define PARSER_EXPLICIT(PPTR) (&PARSER_RESULT ((PPTR))->explicit_loc)
336 /* Prototypes for local functions. */
338 static void iterate_over_file_blocks
339 (struct symtab
*symtab
, const lookup_name_info
&name
,
341 gdb::function_view
<symbol_found_callback_ftype
> callback
);
343 static void initialize_defaults (struct symtab
**default_symtab
,
346 CORE_ADDR
linespec_expression_to_pc (const char **exp_ptr
);
348 static std::vector
<symtab_and_line
> decode_objc (struct linespec_state
*self
,
352 static symtab_vector_up symtabs_from_filename
353 (const char *, struct program_space
*pspace
);
355 static VEC (symbolp
) *find_label_symbols (struct linespec_state
*self
,
356 VEC (symbolp
) *function_symbols
,
357 VEC (symbolp
) **label_funcs_ret
,
359 bool completion_mode
= false);
361 static void find_linespec_symbols (struct linespec_state
*self
,
362 std::vector
<symtab
*> *file_symtabs
,
364 symbol_name_match_type name_match_type
,
365 VEC (symbolp
) **symbols
,
366 VEC (bound_minimal_symbol_d
) **minsyms
);
368 static struct line_offset
369 linespec_parse_variable (struct linespec_state
*self
,
370 const char *variable
);
372 static int symbol_to_sal (struct symtab_and_line
*result
,
373 int funfirstline
, struct symbol
*sym
);
375 static void add_matching_symbols_to_info (const char *name
,
376 symbol_name_match_type name_match_type
,
377 enum search_domain search_domain
,
378 struct collect_info
*info
,
379 struct program_space
*pspace
);
381 static void add_all_symbol_names_from_pspace
382 (struct collect_info
*info
, struct program_space
*pspace
,
383 const std::vector
<const char *> &names
, enum search_domain search_domain
);
385 static symtab_vector_up
386 collect_symtabs_from_filename (const char *file
,
387 struct program_space
*pspace
);
389 static std::vector
<symtab_and_line
> decode_digits_ordinary
390 (struct linespec_state
*self
,
393 linetable_entry
**best_entry
);
395 static std::vector
<symtab_and_line
> decode_digits_list_mode
396 (struct linespec_state
*self
,
398 struct symtab_and_line val
);
400 static void minsym_found (struct linespec_state
*self
, struct objfile
*objfile
,
401 struct minimal_symbol
*msymbol
,
402 std::vector
<symtab_and_line
> *result
);
404 static int compare_symbols (const void *a
, const void *b
);
406 static int compare_msymbols (const void *a
, const void *b
);
408 /* Permitted quote characters for the parser. This is different from the
409 completer's quote characters to allow backward compatibility with the
411 static const char *const linespec_quote_characters
= "\"\'";
413 /* Lexer functions. */
415 /* Lex a number from the input in PARSER. This only supports
418 Return true if input is decimal numbers. Return false if not. */
421 linespec_lexer_lex_number (linespec_parser
*parser
, linespec_token
*tokenp
)
423 tokenp
->type
= LSTOKEN_NUMBER
;
424 LS_TOKEN_STOKEN (*tokenp
).length
= 0;
425 LS_TOKEN_STOKEN (*tokenp
).ptr
= PARSER_STREAM (parser
);
427 /* Keep any sign at the start of the stream. */
428 if (*PARSER_STREAM (parser
) == '+' || *PARSER_STREAM (parser
) == '-')
430 ++LS_TOKEN_STOKEN (*tokenp
).length
;
431 ++(PARSER_STREAM (parser
));
434 while (isdigit (*PARSER_STREAM (parser
)))
436 ++LS_TOKEN_STOKEN (*tokenp
).length
;
437 ++(PARSER_STREAM (parser
));
440 /* If the next character in the input buffer is not a space, comma,
441 quote, or colon, this input does not represent a number. */
442 if (*PARSER_STREAM (parser
) != '\0'
443 && !isspace (*PARSER_STREAM (parser
)) && *PARSER_STREAM (parser
) != ','
444 && *PARSER_STREAM (parser
) != ':'
445 && !strchr (linespec_quote_characters
, *PARSER_STREAM (parser
)))
447 PARSER_STREAM (parser
) = LS_TOKEN_STOKEN (*tokenp
).ptr
;
454 /* See linespec.h. */
457 linespec_lexer_lex_keyword (const char *p
)
463 for (i
= 0; linespec_keywords
[i
] != NULL
; ++i
)
465 int len
= strlen (linespec_keywords
[i
]);
467 /* If P begins with one of the keywords and the next
468 character is whitespace, we may have found a keyword.
469 It is only a keyword if it is not followed by another
471 if (strncmp (p
, linespec_keywords
[i
], len
) == 0
476 /* Special case: "if" ALWAYS stops the lexer, since it
477 is not possible to predict what is going to appear in
478 the condition, which can only be parsed after SaLs have
480 if (i
!= IF_KEYWORD_INDEX
)
484 for (j
= 0; linespec_keywords
[j
] != NULL
; ++j
)
486 int nextlen
= strlen (linespec_keywords
[j
]);
488 if (strncmp (p
, linespec_keywords
[j
], nextlen
) == 0
489 && isspace (p
[nextlen
]))
494 return linespec_keywords
[i
];
502 /* See description in linespec.h. */
505 is_ada_operator (const char *string
)
507 const struct ada_opname_map
*mapping
;
509 for (mapping
= ada_opname_table
;
510 mapping
->encoded
!= NULL
511 && !startswith (string
, mapping
->decoded
); ++mapping
)
514 return mapping
->decoded
== NULL
? 0 : strlen (mapping
->decoded
);
517 /* Find QUOTE_CHAR in STRING, accounting for the ':' terminal. Return
518 the location of QUOTE_CHAR, or NULL if not found. */
521 skip_quote_char (const char *string
, char quote_char
)
523 const char *p
, *last
;
525 p
= last
= find_toplevel_char (string
, quote_char
);
526 while (p
&& *p
!= '\0' && *p
!= ':')
528 p
= find_toplevel_char (p
, quote_char
);
536 /* Make a writable copy of the string given in TOKEN, trimming
537 any trailing whitespace. */
539 static gdb::unique_xmalloc_ptr
<char>
540 copy_token_string (linespec_token token
)
544 if (token
.type
== LSTOKEN_KEYWORD
)
545 return gdb::unique_xmalloc_ptr
<char> (xstrdup (LS_TOKEN_KEYWORD (token
)));
547 str
= LS_TOKEN_STOKEN (token
).ptr
;
548 s
= remove_trailing_whitespace (str
, str
+ LS_TOKEN_STOKEN (token
).length
);
550 return gdb::unique_xmalloc_ptr
<char> (savestring (str
, s
- str
));
553 /* Does P represent the end of a quote-enclosed linespec? */
556 is_closing_quote_enclosed (const char *p
)
558 if (strchr (linespec_quote_characters
, *p
))
560 p
= skip_spaces ((char *) p
);
561 return (*p
== '\0' || linespec_lexer_lex_keyword (p
));
564 /* Find the end of the parameter list that starts with *INPUT.
565 This helper function assists with lexing string segments
566 which might contain valid (non-terminating) commas. */
569 find_parameter_list_end (const char *input
)
571 char end_char
, start_char
;
576 if (start_char
== '(')
578 else if (start_char
== '<')
587 if (*p
== start_char
)
589 else if (*p
== end_char
)
603 /* If the [STRING, STRING_LEN) string ends with what looks like a
604 keyword, return the keyword start offset in STRING. Return -1
608 string_find_incomplete_keyword_at_end (const char * const *keywords
,
609 const char *string
, size_t string_len
)
611 const char *end
= string
+ string_len
;
614 while (p
> string
&& *p
!= ' ')
619 size_t len
= end
- p
;
620 for (size_t i
= 0; keywords
[i
] != NULL
; ++i
)
621 if (strncmp (keywords
[i
], p
, len
) == 0)
628 /* Lex a string from the input in PARSER. */
630 static linespec_token
631 linespec_lexer_lex_string (linespec_parser
*parser
)
633 linespec_token token
;
634 const char *start
= PARSER_STREAM (parser
);
636 token
.type
= LSTOKEN_STRING
;
638 /* If the input stream starts with a quote character, skip to the next
639 quote character, regardless of the content. */
640 if (strchr (linespec_quote_characters
, *PARSER_STREAM (parser
)))
643 char quote_char
= *PARSER_STREAM (parser
);
645 /* Special case: Ada operators. */
646 if (PARSER_STATE (parser
)->language
->la_language
== language_ada
647 && quote_char
== '\"')
649 int len
= is_ada_operator (PARSER_STREAM (parser
));
653 /* The input is an Ada operator. Return the quoted string
655 LS_TOKEN_STOKEN (token
).ptr
= PARSER_STREAM (parser
);
656 LS_TOKEN_STOKEN (token
).length
= len
;
657 PARSER_STREAM (parser
) += len
;
661 /* The input does not represent an Ada operator -- fall through
662 to normal quoted string handling. */
665 /* Skip past the beginning quote. */
666 ++(PARSER_STREAM (parser
));
668 /* Mark the start of the string. */
669 LS_TOKEN_STOKEN (token
).ptr
= PARSER_STREAM (parser
);
671 /* Skip to the ending quote. */
672 end
= skip_quote_char (PARSER_STREAM (parser
), quote_char
);
674 /* This helps the completer mode decide whether we have a
676 parser
->completion_quote_char
= quote_char
;
677 parser
->completion_quote_end
= end
;
679 /* Error if the input did not terminate properly, unless in
683 if (parser
->completion_tracker
== NULL
)
684 error (_("unmatched quote"));
686 /* In completion mode, we'll try to complete the incomplete
688 token
.type
= LSTOKEN_STRING
;
689 while (*PARSER_STREAM (parser
) != '\0')
690 PARSER_STREAM (parser
)++;
691 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - 1 - start
;
695 /* Skip over the ending quote and mark the length of the string. */
696 PARSER_STREAM (parser
) = (char *) ++end
;
697 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - 2 - start
;
704 /* Otherwise, only identifier characters are permitted.
705 Spaces are the exception. In general, we keep spaces,
706 but only if the next characters in the input do not resolve
707 to one of the keywords.
709 This allows users to forgo quoting CV-qualifiers, template arguments,
710 and similar common language constructs. */
714 if (isspace (*PARSER_STREAM (parser
)))
716 p
= skip_spaces (PARSER_STREAM (parser
));
717 /* When we get here we know we've found something followed by
718 a space (we skip over parens and templates below).
719 So if we find a keyword now, we know it is a keyword and not,
720 say, a function name. */
721 if (linespec_lexer_lex_keyword (p
) != NULL
)
723 LS_TOKEN_STOKEN (token
).ptr
= start
;
724 LS_TOKEN_STOKEN (token
).length
725 = PARSER_STREAM (parser
) - start
;
729 /* Advance past the whitespace. */
730 PARSER_STREAM (parser
) = p
;
733 /* If the next character is EOI or (single) ':', the
734 string is complete; return the token. */
735 if (*PARSER_STREAM (parser
) == 0)
737 LS_TOKEN_STOKEN (token
).ptr
= start
;
738 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - start
;
741 else if (PARSER_STREAM (parser
)[0] == ':')
743 /* Do not tokenize the C++ scope operator. */
744 if (PARSER_STREAM (parser
)[1] == ':')
745 ++(PARSER_STREAM (parser
));
747 /* Do not tokenize ABI tags such as "[abi:cxx11]". */
748 else if (PARSER_STREAM (parser
) - start
> 4
749 && startswith (PARSER_STREAM (parser
) - 4, "[abi"))
750 ++(PARSER_STREAM (parser
));
752 /* Do not tokenify if the input length so far is one
753 (i.e, a single-letter drive name) and the next character
754 is a directory separator. This allows Windows-style
755 paths to be recognized as filenames without quoting it. */
756 else if ((PARSER_STREAM (parser
) - start
) != 1
757 || !IS_DIR_SEPARATOR (PARSER_STREAM (parser
)[1]))
759 LS_TOKEN_STOKEN (token
).ptr
= start
;
760 LS_TOKEN_STOKEN (token
).length
761 = PARSER_STREAM (parser
) - start
;
765 /* Special case: permit quote-enclosed linespecs. */
766 else if (parser
->is_quote_enclosed
767 && strchr (linespec_quote_characters
,
768 *PARSER_STREAM (parser
))
769 && is_closing_quote_enclosed (PARSER_STREAM (parser
)))
771 LS_TOKEN_STOKEN (token
).ptr
= start
;
772 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - start
;
775 /* Because commas may terminate a linespec and appear in
776 the middle of valid string input, special cases for
777 '<' and '(' are necessary. */
778 else if (*PARSER_STREAM (parser
) == '<'
779 || *PARSER_STREAM (parser
) == '(')
781 /* Don't interpret 'operator<' / 'operator<<' as a
782 template parameter list though. */
783 if (*PARSER_STREAM (parser
) == '<'
784 && (PARSER_STATE (parser
)->language
->la_language
786 && (PARSER_STREAM (parser
) - start
) >= CP_OPERATOR_LEN
)
788 const char *p
= PARSER_STREAM (parser
);
790 while (p
> start
&& isspace (p
[-1]))
792 if (p
- start
>= CP_OPERATOR_LEN
)
794 p
-= CP_OPERATOR_LEN
;
795 if (strncmp (p
, CP_OPERATOR_STR
, CP_OPERATOR_LEN
) == 0
797 || !(isalnum (p
[-1]) || p
[-1] == '_')))
799 /* This is an operator name. Keep going. */
800 ++(PARSER_STREAM (parser
));
801 if (*PARSER_STREAM (parser
) == '<')
802 ++(PARSER_STREAM (parser
));
808 const char *p
= find_parameter_list_end (PARSER_STREAM (parser
));
809 PARSER_STREAM (parser
) = p
;
811 /* Don't loop around to the normal \0 case above because
812 we don't want to misinterpret a potential keyword at
813 the end of the token when the string isn't
814 "()<>"-balanced. This handles "b
815 function(thread<tab>" in completion mode. */
818 LS_TOKEN_STOKEN (token
).ptr
= start
;
819 LS_TOKEN_STOKEN (token
).length
820 = PARSER_STREAM (parser
) - start
;
826 /* Commas are terminators, but not if they are part of an
828 else if (*PARSER_STREAM (parser
) == ',')
830 if ((PARSER_STATE (parser
)->language
->la_language
832 && (PARSER_STREAM (parser
) - start
) > CP_OPERATOR_LEN
)
834 const char *p
= strstr (start
, CP_OPERATOR_STR
);
836 if (p
!= NULL
&& is_operator_name (p
))
838 /* This is an operator name. Keep going. */
839 ++(PARSER_STREAM (parser
));
844 /* Comma terminates the string. */
845 LS_TOKEN_STOKEN (token
).ptr
= start
;
846 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - start
;
850 /* Advance the stream. */
851 ++(PARSER_STREAM (parser
));
858 /* Lex a single linespec token from PARSER. */
860 static linespec_token
861 linespec_lexer_lex_one (linespec_parser
*parser
)
865 if (parser
->lexer
.current
.type
== LSTOKEN_CONSUMED
)
867 /* Skip any whitespace. */
868 PARSER_STREAM (parser
) = skip_spaces (PARSER_STREAM (parser
));
870 /* Check for a keyword, they end the linespec. */
871 keyword
= linespec_lexer_lex_keyword (PARSER_STREAM (parser
));
874 parser
->lexer
.current
.type
= LSTOKEN_KEYWORD
;
875 LS_TOKEN_KEYWORD (parser
->lexer
.current
) = keyword
;
876 /* We do not advance the stream here intentionally:
877 we would like lexing to stop when a keyword is seen.
879 PARSER_STREAM (parser) += strlen (keyword); */
881 return parser
->lexer
.current
;
884 /* Handle other tokens. */
885 switch (*PARSER_STREAM (parser
))
888 parser
->lexer
.current
.type
= LSTOKEN_EOI
;
892 case '0': case '1': case '2': case '3': case '4':
893 case '5': case '6': case '7': case '8': case '9':
894 if (!linespec_lexer_lex_number (parser
, &(parser
->lexer
.current
)))
895 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
899 /* If we have a scope operator, lex the input as a string.
900 Otherwise, return LSTOKEN_COLON. */
901 if (PARSER_STREAM (parser
)[1] == ':')
902 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
905 parser
->lexer
.current
.type
= LSTOKEN_COLON
;
906 ++(PARSER_STREAM (parser
));
910 case '\'': case '\"':
911 /* Special case: permit quote-enclosed linespecs. */
912 if (parser
->is_quote_enclosed
913 && is_closing_quote_enclosed (PARSER_STREAM (parser
)))
915 ++(PARSER_STREAM (parser
));
916 parser
->lexer
.current
.type
= LSTOKEN_EOI
;
919 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
923 parser
->lexer
.current
.type
= LSTOKEN_COMMA
;
924 LS_TOKEN_STOKEN (parser
->lexer
.current
).ptr
925 = PARSER_STREAM (parser
);
926 LS_TOKEN_STOKEN (parser
->lexer
.current
).length
= 1;
927 ++(PARSER_STREAM (parser
));
931 /* If the input is not a number, it must be a string.
932 [Keywords were already considered above.] */
933 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
938 return parser
->lexer
.current
;
941 /* Consume the current token and return the next token in PARSER's
942 input stream. Also advance the completion word for completion
945 static linespec_token
946 linespec_lexer_consume_token (linespec_parser
*parser
)
948 gdb_assert (parser
->lexer
.current
.type
!= LSTOKEN_EOI
);
950 bool advance_word
= (parser
->lexer
.current
.type
!= LSTOKEN_STRING
951 || *PARSER_STREAM (parser
) != '\0');
953 /* If we're moving past a string to some other token, it must be the
954 quote was terminated. */
955 if (parser
->completion_quote_char
)
957 gdb_assert (parser
->lexer
.current
.type
== LSTOKEN_STRING
);
959 /* If the string was the last (non-EOI) token, we're past the
960 quote, but remember that for later. */
961 if (*PARSER_STREAM (parser
) != '\0')
963 parser
->completion_quote_char
= '\0';
964 parser
->completion_quote_end
= NULL
;;
968 parser
->lexer
.current
.type
= LSTOKEN_CONSUMED
;
969 linespec_lexer_lex_one (parser
);
971 if (parser
->lexer
.current
.type
== LSTOKEN_STRING
)
973 /* Advance the completion word past a potential initial
975 parser
->completion_word
= LS_TOKEN_STOKEN (parser
->lexer
.current
).ptr
;
977 else if (advance_word
)
979 /* Advance the completion word past any whitespace. */
980 parser
->completion_word
= PARSER_STREAM (parser
);
983 return parser
->lexer
.current
;
986 /* Return the next token without consuming the current token. */
988 static linespec_token
989 linespec_lexer_peek_token (linespec_parser
*parser
)
992 const char *saved_stream
= PARSER_STREAM (parser
);
993 linespec_token saved_token
= parser
->lexer
.current
;
994 int saved_completion_quote_char
= parser
->completion_quote_char
;
995 const char *saved_completion_quote_end
= parser
->completion_quote_end
;
996 const char *saved_completion_word
= parser
->completion_word
;
998 next
= linespec_lexer_consume_token (parser
);
999 PARSER_STREAM (parser
) = saved_stream
;
1000 parser
->lexer
.current
= saved_token
;
1001 parser
->completion_quote_char
= saved_completion_quote_char
;
1002 parser
->completion_quote_end
= saved_completion_quote_end
;
1003 parser
->completion_word
= saved_completion_word
;
1007 /* Helper functions. */
1009 /* Add SAL to SALS, and also update SELF->CANONICAL_NAMES to reflect
1010 the new sal, if needed. If not NULL, SYMNAME is the name of the
1011 symbol to use when constructing the new canonical name.
1013 If LITERAL_CANONICAL is non-zero, SYMNAME will be used as the
1014 canonical name for the SAL. */
1017 add_sal_to_sals (struct linespec_state
*self
,
1018 std::vector
<symtab_and_line
> *sals
,
1019 struct symtab_and_line
*sal
,
1020 const char *symname
, int literal_canonical
)
1022 sals
->push_back (*sal
);
1024 if (self
->canonical
)
1026 struct linespec_canonical_name
*canonical
;
1028 self
->canonical_names
= XRESIZEVEC (struct linespec_canonical_name
,
1029 self
->canonical_names
,
1031 canonical
= &self
->canonical_names
[sals
->size () - 1];
1032 if (!literal_canonical
&& sal
->symtab
)
1034 symtab_to_fullname (sal
->symtab
);
1036 /* Note that the filter doesn't have to be a valid linespec
1037 input. We only apply the ":LINE" treatment to Ada for
1039 if (symname
!= NULL
&& sal
->line
!= 0
1040 && self
->language
->la_language
== language_ada
)
1041 canonical
->suffix
= xstrprintf ("%s:%d", symname
, sal
->line
);
1042 else if (symname
!= NULL
)
1043 canonical
->suffix
= xstrdup (symname
);
1045 canonical
->suffix
= xstrprintf ("%d", sal
->line
);
1046 canonical
->symtab
= sal
->symtab
;
1050 if (symname
!= NULL
)
1051 canonical
->suffix
= xstrdup (symname
);
1053 canonical
->suffix
= xstrdup ("<unknown>");
1054 canonical
->symtab
= NULL
;
1059 /* A hash function for address_entry. */
1062 hash_address_entry (const void *p
)
1064 const struct address_entry
*aep
= (const struct address_entry
*) p
;
1067 hash
= iterative_hash_object (aep
->pspace
, 0);
1068 return iterative_hash_object (aep
->addr
, hash
);
1071 /* An equality function for address_entry. */
1074 eq_address_entry (const void *a
, const void *b
)
1076 const struct address_entry
*aea
= (const struct address_entry
*) a
;
1077 const struct address_entry
*aeb
= (const struct address_entry
*) b
;
1079 return aea
->pspace
== aeb
->pspace
&& aea
->addr
== aeb
->addr
;
1082 /* Check whether the address, represented by PSPACE and ADDR, is
1083 already in the set. If so, return 0. Otherwise, add it and return
1087 maybe_add_address (htab_t set
, struct program_space
*pspace
, CORE_ADDR addr
)
1089 struct address_entry e
, *p
;
1094 slot
= htab_find_slot (set
, &e
, INSERT
);
1098 p
= XNEW (struct address_entry
);
1099 memcpy (p
, &e
, sizeof (struct address_entry
));
1105 /* A helper that walks over all matching symtabs in all objfiles and
1106 calls CALLBACK for each symbol matching NAME. If SEARCH_PSPACE is
1107 not NULL, then the search is restricted to just that program
1108 space. If INCLUDE_INLINE is true then symbols representing
1109 inlined instances of functions will be included in the result. */
1112 iterate_over_all_matching_symtabs
1113 (struct linespec_state
*state
,
1114 const lookup_name_info
&lookup_name
,
1115 const domain_enum name_domain
,
1116 enum search_domain search_domain
,
1117 struct program_space
*search_pspace
, bool include_inline
,
1118 gdb::function_view
<symbol_found_callback_ftype
> callback
)
1120 struct objfile
*objfile
;
1121 struct program_space
*pspace
;
1123 ALL_PSPACES (pspace
)
1125 if (search_pspace
!= NULL
&& search_pspace
!= pspace
)
1127 if (pspace
->executing_startup
)
1130 set_current_program_space (pspace
);
1132 ALL_OBJFILES (objfile
)
1134 struct compunit_symtab
*cu
;
1137 objfile
->sf
->qf
->expand_symtabs_matching (objfile
,
1143 ALL_OBJFILE_COMPUNITS (objfile
, cu
)
1145 struct symtab
*symtab
= COMPUNIT_FILETABS (cu
);
1147 iterate_over_file_blocks (symtab
, lookup_name
, name_domain
, callback
);
1151 struct block
*block
;
1154 for (i
= FIRST_LOCAL_BLOCK
;
1155 i
< BLOCKVECTOR_NBLOCKS (SYMTAB_BLOCKVECTOR (symtab
));
1158 block
= BLOCKVECTOR_BLOCK (SYMTAB_BLOCKVECTOR (symtab
), i
);
1159 state
->language
->la_iterate_over_symbols
1160 (block
, lookup_name
, name_domain
, [&] (symbol
*sym
)
1162 /* Restrict calls to CALLBACK to symbols
1163 representing inline symbols only. */
1164 if (SYMBOL_INLINED (sym
))
1165 return callback (sym
);
1175 /* Returns the block to be used for symbol searches from
1176 the current location. */
1178 static const struct block
*
1179 get_current_search_block (void)
1181 const struct block
*block
;
1182 enum language save_language
;
1184 /* get_selected_block can change the current language when there is
1185 no selected frame yet. */
1186 save_language
= current_language
->la_language
;
1187 block
= get_selected_block (0);
1188 set_language (save_language
);
1193 /* Iterate over static and global blocks. */
1196 iterate_over_file_blocks
1197 (struct symtab
*symtab
, const lookup_name_info
&name
,
1198 domain_enum domain
, gdb::function_view
<symbol_found_callback_ftype
> callback
)
1200 struct block
*block
;
1202 for (block
= BLOCKVECTOR_BLOCK (SYMTAB_BLOCKVECTOR (symtab
), STATIC_BLOCK
);
1204 block
= BLOCK_SUPERBLOCK (block
))
1205 LA_ITERATE_OVER_SYMBOLS (block
, name
, domain
, callback
);
1208 /* A helper for find_method. This finds all methods in type T of
1209 language T_LANG which match NAME. It adds matching symbol names to
1210 RESULT_NAMES, and adds T's direct superclasses to SUPERCLASSES. */
1213 find_methods (struct type
*t
, enum language t_lang
, const char *name
,
1214 std::vector
<const char *> *result_names
,
1215 std::vector
<struct type
*> *superclasses
)
1218 const char *class_name
= TYPE_NAME (t
);
1220 /* Ignore this class if it doesn't have a name. This is ugly, but
1221 unless we figure out how to get the physname without the name of
1222 the class, then the loop can't do any good. */
1226 lookup_name_info
lookup_name (name
, symbol_name_match_type::FULL
);
1227 symbol_name_matcher_ftype
*symbol_name_compare
1228 = get_symbol_name_matcher (language_def (t_lang
), lookup_name
);
1230 t
= check_typedef (t
);
1232 /* Loop over each method name. At this level, all overloads of a name
1233 are counted as a single name. There is an inner loop which loops over
1236 for (method_counter
= TYPE_NFN_FIELDS (t
) - 1;
1237 method_counter
>= 0;
1240 const char *method_name
= TYPE_FN_FIELDLIST_NAME (t
, method_counter
);
1241 char dem_opname
[64];
1243 if (startswith (method_name
, "__") ||
1244 startswith (method_name
, "op") ||
1245 startswith (method_name
, "type"))
1247 if (cplus_demangle_opname (method_name
, dem_opname
, DMGL_ANSI
))
1248 method_name
= dem_opname
;
1249 else if (cplus_demangle_opname (method_name
, dem_opname
, 0))
1250 method_name
= dem_opname
;
1253 if (symbol_name_compare (method_name
, lookup_name
, NULL
))
1257 for (field_counter
= (TYPE_FN_FIELDLIST_LENGTH (t
, method_counter
)
1263 const char *phys_name
;
1265 f
= TYPE_FN_FIELDLIST1 (t
, method_counter
);
1266 if (TYPE_FN_FIELD_STUB (f
, field_counter
))
1268 phys_name
= TYPE_FN_FIELD_PHYSNAME (f
, field_counter
);
1269 result_names
->push_back (phys_name
);
1275 for (ibase
= 0; ibase
< TYPE_N_BASECLASSES (t
); ibase
++)
1276 superclasses
->push_back (TYPE_BASECLASS (t
, ibase
));
1279 /* Find an instance of the character C in the string S that is outside
1280 of all parenthesis pairs, single-quoted strings, and double-quoted
1281 strings. Also, ignore the char within a template name, like a ','
1282 within foo<int, int>, while considering C++ operator</operator<<. */
1285 find_toplevel_char (const char *s
, char c
)
1287 int quoted
= 0; /* zero if we're not in quotes;
1288 '"' if we're in a double-quoted string;
1289 '\'' if we're in a single-quoted string. */
1290 int depth
= 0; /* Number of unclosed parens we've seen. */
1293 for (scan
= s
; *scan
; scan
++)
1297 if (*scan
== quoted
)
1299 else if (*scan
== '\\' && *(scan
+ 1))
1302 else if (*scan
== c
&& ! quoted
&& depth
== 0)
1304 else if (*scan
== '"' || *scan
== '\'')
1306 else if (*scan
== '(' || *scan
== '<')
1308 else if ((*scan
== ')' || *scan
== '>') && depth
> 0)
1310 else if (*scan
== 'o' && !quoted
&& depth
== 0)
1312 /* Handle C++ operator names. */
1313 if (strncmp (scan
, CP_OPERATOR_STR
, CP_OPERATOR_LEN
) == 0)
1315 scan
+= CP_OPERATOR_LEN
;
1318 while (isspace (*scan
))
1329 /* Skip over one less than the appropriate number of
1330 characters: the for loop will skip over the last
1356 /* The string equivalent of find_toplevel_char. Returns a pointer
1357 to the location of NEEDLE in HAYSTACK, ignoring any occurrences
1358 inside "()" and "<>". Returns NULL if NEEDLE was not found. */
1361 find_toplevel_string (const char *haystack
, const char *needle
)
1363 const char *s
= haystack
;
1367 s
= find_toplevel_char (s
, *needle
);
1371 /* Found first char in HAYSTACK; check rest of string. */
1372 if (startswith (s
, needle
))
1375 /* Didn't find it; loop over HAYSTACK, looking for the next
1376 instance of the first character of NEEDLE. */
1380 while (s
!= NULL
&& *s
!= '\0');
1382 /* NEEDLE was not found in HAYSTACK. */
1386 /* Convert CANONICAL to its string representation using
1387 symtab_to_fullname for SYMTAB. */
1390 canonical_to_fullform (const struct linespec_canonical_name
*canonical
)
1392 if (canonical
->symtab
== NULL
)
1393 return canonical
->suffix
;
1395 return string_printf ("%s:%s", symtab_to_fullname (canonical
->symtab
),
1399 /* Given FILTERS, a list of canonical names, filter the sals in RESULT
1400 and store the result in SELF->CANONICAL. */
1403 filter_results (struct linespec_state
*self
,
1404 std::vector
<symtab_and_line
> *result
,
1405 const std::vector
<const char *> &filters
)
1407 for (const char *name
: filters
)
1411 for (size_t j
= 0; j
< result
->size (); ++j
)
1413 const struct linespec_canonical_name
*canonical
;
1415 canonical
= &self
->canonical_names
[j
];
1416 std::string fullform
= canonical_to_fullform (canonical
);
1418 if (name
== fullform
)
1419 lsal
.sals
.push_back ((*result
)[j
]);
1422 if (!lsal
.sals
.empty ())
1424 lsal
.canonical
= xstrdup (name
);
1425 self
->canonical
->lsals
.push_back (std::move (lsal
));
1429 self
->canonical
->pre_expanded
= 0;
1432 /* Store RESULT into SELF->CANONICAL. */
1435 convert_results_to_lsals (struct linespec_state
*self
,
1436 std::vector
<symtab_and_line
> *result
)
1438 struct linespec_sals lsal
;
1440 lsal
.canonical
= NULL
;
1441 lsal
.sals
= std::move (*result
);
1442 self
->canonical
->lsals
.push_back (std::move (lsal
));
1445 /* A structure that contains two string representations of a struct
1446 linespec_canonical_name:
1447 - one where the the symtab's fullname is used;
1448 - one where the filename followed the "set filename-display"
1451 struct decode_line_2_item
1453 decode_line_2_item (std::string
&&fullform_
, std::string
&&displayform_
,
1455 : fullform (std::move (fullform_
)),
1456 displayform (std::move (displayform_
)),
1457 selected (selected_
)
1461 /* The form using symtab_to_fullname. */
1462 std::string fullform
;
1464 /* The form using symtab_to_filename_for_display. */
1465 std::string displayform
;
1467 /* Field is initialized to zero and it is set to one if the user
1468 requested breakpoint for this entry. */
1469 unsigned int selected
: 1;
1472 /* Helper for std::sort to sort decode_line_2_item entries by
1473 DISPLAYFORM and secondarily by FULLFORM. */
1476 decode_line_2_compare_items (const decode_line_2_item
&a
,
1477 const decode_line_2_item
&b
)
1479 if (a
.displayform
!= b
.displayform
)
1480 return a
.displayform
< b
.displayform
;
1481 return a
.fullform
< b
.fullform
;
1484 /* Handle multiple results in RESULT depending on SELECT_MODE. This
1485 will either return normally, throw an exception on multiple
1486 results, or present a menu to the user. On return, the SALS vector
1487 in SELF->CANONICAL is set up properly. */
1490 decode_line_2 (struct linespec_state
*self
,
1491 std::vector
<symtab_and_line
> *result
,
1492 const char *select_mode
)
1497 std::vector
<const char *> filters
;
1498 std::vector
<struct decode_line_2_item
> items
;
1500 gdb_assert (select_mode
!= multiple_symbols_all
);
1501 gdb_assert (self
->canonical
!= NULL
);
1502 gdb_assert (!result
->empty ());
1504 /* Prepare ITEMS array. */
1505 for (i
= 0; i
< result
->size (); ++i
)
1507 const struct linespec_canonical_name
*canonical
;
1508 std::string displayform
;
1510 canonical
= &self
->canonical_names
[i
];
1511 gdb_assert (canonical
->suffix
!= NULL
);
1513 std::string fullform
= canonical_to_fullform (canonical
);
1515 if (canonical
->symtab
== NULL
)
1516 displayform
= canonical
->suffix
;
1519 const char *fn_for_display
;
1521 fn_for_display
= symtab_to_filename_for_display (canonical
->symtab
);
1522 displayform
= string_printf ("%s:%s", fn_for_display
,
1526 items
.emplace_back (std::move (fullform
), std::move (displayform
),
1530 /* Sort the list of method names. */
1531 std::sort (items
.begin (), items
.end (), decode_line_2_compare_items
);
1533 /* Remove entries with the same FULLFORM. */
1534 items
.erase (std::unique (items
.begin (), items
.end (),
1535 [] (const struct decode_line_2_item
&a
,
1536 const struct decode_line_2_item
&b
)
1538 return a
.fullform
== b
.fullform
;
1542 if (select_mode
== multiple_symbols_cancel
&& items
.size () > 1)
1543 error (_("canceled because the command is ambiguous\n"
1544 "See set/show multiple-symbol."));
1546 if (select_mode
== multiple_symbols_all
|| items
.size () == 1)
1548 convert_results_to_lsals (self
, result
);
1552 printf_unfiltered (_("[0] cancel\n[1] all\n"));
1553 for (i
= 0; i
< items
.size (); i
++)
1554 printf_unfiltered ("[%d] %s\n", i
+ 2, items
[i
].displayform
.c_str ());
1556 prompt
= getenv ("PS2");
1561 args
= command_line_input (prompt
, "overload-choice");
1563 if (args
== 0 || *args
== 0)
1564 error_no_arg (_("one or more choice numbers"));
1566 number_or_range_parser
parser (args
);
1567 while (!parser
.finished ())
1569 int num
= parser
.get_number ();
1572 error (_("canceled"));
1575 /* We intentionally make this result in a single breakpoint,
1576 contrary to what older versions of gdb did. The
1577 rationale is that this lets a user get the
1578 multiple_symbols_all behavior even with the 'ask'
1579 setting; and he can get separate breakpoints by entering
1580 "2-57" at the query. */
1581 convert_results_to_lsals (self
, result
);
1586 if (num
>= items
.size ())
1587 printf_unfiltered (_("No choice number %d.\n"), num
);
1590 struct decode_line_2_item
*item
= &items
[num
];
1592 if (!item
->selected
)
1594 filters
.push_back (item
->fullform
.c_str ());
1599 printf_unfiltered (_("duplicate request for %d ignored.\n"),
1605 filter_results (self
, result
, filters
);
1610 /* The parser of linespec itself. */
1612 /* Throw an appropriate error when SYMBOL is not found (optionally in
1615 static void ATTRIBUTE_NORETURN
1616 symbol_not_found_error (const char *symbol
, const char *filename
)
1621 if (!have_full_symbols ()
1622 && !have_partial_symbols ()
1623 && !have_minimal_symbols ())
1624 throw_error (NOT_FOUND_ERROR
,
1625 _("No symbol table is loaded. Use the \"file\" command."));
1627 /* If SYMBOL starts with '$', the user attempted to either lookup
1628 a function/variable in his code starting with '$' or an internal
1629 variable of that name. Since we do not know which, be concise and
1630 explain both possibilities. */
1634 throw_error (NOT_FOUND_ERROR
,
1635 _("Undefined convenience variable or function \"%s\" "
1636 "not defined in \"%s\"."), symbol
, filename
);
1638 throw_error (NOT_FOUND_ERROR
,
1639 _("Undefined convenience variable or function \"%s\" "
1640 "not defined."), symbol
);
1645 throw_error (NOT_FOUND_ERROR
,
1646 _("Function \"%s\" not defined in \"%s\"."),
1649 throw_error (NOT_FOUND_ERROR
,
1650 _("Function \"%s\" not defined."), symbol
);
1654 /* Throw an appropriate error when an unexpected token is encountered
1657 static void ATTRIBUTE_NORETURN
1658 unexpected_linespec_error (linespec_parser
*parser
)
1660 linespec_token token
;
1661 static const char * token_type_strings
[]
1662 = {"keyword", "colon", "string", "number", "comma", "end of input"};
1664 /* Get the token that generated the error. */
1665 token
= linespec_lexer_lex_one (parser
);
1667 /* Finally, throw the error. */
1668 if (token
.type
== LSTOKEN_STRING
|| token
.type
== LSTOKEN_NUMBER
1669 || token
.type
== LSTOKEN_KEYWORD
)
1671 gdb::unique_xmalloc_ptr
<char> string
= copy_token_string (token
);
1672 throw_error (GENERIC_ERROR
,
1673 _("malformed linespec error: unexpected %s, \"%s\""),
1674 token_type_strings
[token
.type
], string
.get ());
1677 throw_error (GENERIC_ERROR
,
1678 _("malformed linespec error: unexpected %s"),
1679 token_type_strings
[token
.type
]);
1682 /* Throw an undefined label error. */
1684 static void ATTRIBUTE_NORETURN
1685 undefined_label_error (const char *function
, const char *label
)
1687 if (function
!= NULL
)
1688 throw_error (NOT_FOUND_ERROR
,
1689 _("No label \"%s\" defined in function \"%s\"."),
1692 throw_error (NOT_FOUND_ERROR
,
1693 _("No label \"%s\" defined in current function."),
1697 /* Throw a source file not found error. */
1699 static void ATTRIBUTE_NORETURN
1700 source_file_not_found_error (const char *name
)
1702 throw_error (NOT_FOUND_ERROR
, _("No source file named %s."), name
);
1705 /* Unless at EIO, save the current stream position as completion word
1706 point, and consume the next token. */
1708 static linespec_token
1709 save_stream_and_consume_token (linespec_parser
*parser
)
1711 if (linespec_lexer_peek_token (parser
).type
!= LSTOKEN_EOI
)
1712 parser
->completion_word
= PARSER_STREAM (parser
);
1713 return linespec_lexer_consume_token (parser
);
1716 /* See description in linespec.h. */
1719 linespec_parse_line_offset (const char *string
)
1721 const char *start
= string
;
1722 struct line_offset line_offset
= {0, LINE_OFFSET_NONE
};
1726 line_offset
.sign
= LINE_OFFSET_PLUS
;
1729 else if (*string
== '-')
1731 line_offset
.sign
= LINE_OFFSET_MINUS
;
1735 if (*string
!= '\0' && !isdigit (*string
))
1736 error (_("malformed line offset: \"%s\""), start
);
1738 /* Right now, we only allow base 10 for offsets. */
1739 line_offset
.offset
= atoi (string
);
1743 /* In completion mode, if the user is still typing the number, there's
1744 no possible completion to offer. But if there's already input past
1745 the number, setup to expect NEXT. */
1748 set_completion_after_number (linespec_parser
*parser
,
1749 linespec_complete_what next
)
1751 if (*PARSER_STREAM (parser
) == ' ')
1753 parser
->completion_word
= skip_spaces (PARSER_STREAM (parser
) + 1);
1754 parser
->complete_what
= next
;
1758 parser
->completion_word
= PARSER_STREAM (parser
);
1759 parser
->complete_what
= linespec_complete_what::NOTHING
;
1763 /* Parse the basic_spec in PARSER's input. */
1766 linespec_parse_basic (linespec_parser
*parser
)
1768 gdb::unique_xmalloc_ptr
<char> name
;
1769 linespec_token token
;
1770 VEC (symbolp
) *symbols
, *labels
;
1771 VEC (bound_minimal_symbol_d
) *minimal_symbols
;
1773 /* Get the next token. */
1774 token
= linespec_lexer_lex_one (parser
);
1776 /* If it is EOI or KEYWORD, issue an error. */
1777 if (token
.type
== LSTOKEN_KEYWORD
)
1779 parser
->complete_what
= linespec_complete_what::NOTHING
;
1780 unexpected_linespec_error (parser
);
1782 else if (token
.type
== LSTOKEN_EOI
)
1784 unexpected_linespec_error (parser
);
1786 /* If it is a LSTOKEN_NUMBER, we have an offset. */
1787 else if (token
.type
== LSTOKEN_NUMBER
)
1789 set_completion_after_number (parser
, linespec_complete_what::KEYWORD
);
1791 /* Record the line offset and get the next token. */
1792 name
= copy_token_string (token
);
1793 PARSER_EXPLICIT (parser
)->line_offset
1794 = linespec_parse_line_offset (name
.get ());
1796 /* Get the next token. */
1797 token
= linespec_lexer_consume_token (parser
);
1799 /* If the next token is a comma, stop parsing and return. */
1800 if (token
.type
== LSTOKEN_COMMA
)
1802 parser
->complete_what
= linespec_complete_what::NOTHING
;
1806 /* If the next token is anything but EOI or KEYWORD, issue
1808 if (token
.type
!= LSTOKEN_KEYWORD
&& token
.type
!= LSTOKEN_EOI
)
1809 unexpected_linespec_error (parser
);
1812 if (token
.type
== LSTOKEN_KEYWORD
|| token
.type
== LSTOKEN_EOI
)
1815 /* Next token must be LSTOKEN_STRING. */
1816 if (token
.type
!= LSTOKEN_STRING
)
1818 parser
->complete_what
= linespec_complete_what::NOTHING
;
1819 unexpected_linespec_error (parser
);
1822 /* The current token will contain the name of a function, method,
1824 name
= copy_token_string (token
);
1826 if (parser
->completion_tracker
!= NULL
)
1828 /* If the function name ends with a ":", then this may be an
1829 incomplete "::" scope operator instead of a label separator.
1832 which should expand to:
1835 Do a tentative completion assuming the later. If we find
1836 completions, advance the stream past the colon token and make
1837 it part of the function name/token. */
1839 if (!parser
->completion_quote_char
1840 && strcmp (PARSER_STREAM (parser
), ":") == 0)
1842 completion_tracker tmp_tracker
;
1843 const char *source_filename
1844 = PARSER_EXPLICIT (parser
)->source_filename
;
1845 symbol_name_match_type match_type
1846 = PARSER_EXPLICIT (parser
)->func_name_match_type
;
1848 linespec_complete_function (tmp_tracker
,
1849 parser
->completion_word
,
1853 if (tmp_tracker
.have_completions ())
1855 PARSER_STREAM (parser
)++;
1856 LS_TOKEN_STOKEN (token
).length
++;
1858 name
.reset (savestring (parser
->completion_word
,
1859 (PARSER_STREAM (parser
)
1860 - parser
->completion_word
)));
1864 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1868 /* Try looking it up as a function/method. */
1869 find_linespec_symbols (PARSER_STATE (parser
),
1870 PARSER_RESULT (parser
)->file_symtabs
, name
.get (),
1871 PARSER_EXPLICIT (parser
)->func_name_match_type
,
1872 &symbols
, &minimal_symbols
);
1874 if (symbols
!= NULL
|| minimal_symbols
!= NULL
)
1876 PARSER_RESULT (parser
)->function_symbols
= symbols
;
1877 PARSER_RESULT (parser
)->minimal_symbols
= minimal_symbols
;
1878 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1883 /* NAME was not a function or a method. So it must be a label
1884 name or user specified variable like "break foo.c:$zippo". */
1885 labels
= find_label_symbols (PARSER_STATE (parser
), NULL
,
1886 &symbols
, name
.get ());
1889 PARSER_RESULT (parser
)->labels
.label_symbols
= labels
;
1890 PARSER_RESULT (parser
)->labels
.function_symbols
= symbols
;
1891 PARSER_EXPLICIT (parser
)->label_name
= name
.release ();
1894 else if (token
.type
== LSTOKEN_STRING
1895 && *LS_TOKEN_STOKEN (token
).ptr
== '$')
1897 /* User specified a convenience variable or history value. */
1898 PARSER_EXPLICIT (parser
)->line_offset
1899 = linespec_parse_variable (PARSER_STATE (parser
), name
.get ());
1901 if (PARSER_EXPLICIT (parser
)->line_offset
.sign
== LINE_OFFSET_UNKNOWN
)
1903 /* The user-specified variable was not valid. Do not
1904 throw an error here. parse_linespec will do it for us. */
1905 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1911 /* The name is also not a label. Abort parsing. Do not throw
1912 an error here. parse_linespec will do it for us. */
1914 /* Save a copy of the name we were trying to lookup. */
1915 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1921 int previous_qc
= parser
->completion_quote_char
;
1923 /* Get the next token. */
1924 token
= linespec_lexer_consume_token (parser
);
1926 if (token
.type
== LSTOKEN_EOI
)
1928 if (previous_qc
&& !parser
->completion_quote_char
)
1929 parser
->complete_what
= linespec_complete_what::KEYWORD
;
1931 else if (token
.type
== LSTOKEN_COLON
)
1933 /* User specified a label or a lineno. */
1934 token
= linespec_lexer_consume_token (parser
);
1936 if (token
.type
== LSTOKEN_NUMBER
)
1938 /* User specified an offset. Record the line offset and
1939 get the next token. */
1940 set_completion_after_number (parser
, linespec_complete_what::KEYWORD
);
1942 name
= copy_token_string (token
);
1943 PARSER_EXPLICIT (parser
)->line_offset
1944 = linespec_parse_line_offset (name
.get ());
1946 /* Get the next token. */
1947 token
= linespec_lexer_consume_token (parser
);
1949 else if (token
.type
== LSTOKEN_EOI
&& parser
->completion_tracker
!= NULL
)
1951 parser
->complete_what
= linespec_complete_what::LABEL
;
1953 else if (token
.type
== LSTOKEN_STRING
)
1955 parser
->complete_what
= linespec_complete_what::LABEL
;
1957 /* If we have text after the label separated by whitespace
1958 (e.g., "b func():lab i<tab>"), don't consider it part of
1959 the label. In completion mode that should complete to
1960 "if", in normal mode, the 'i' should be treated as
1962 if (parser
->completion_quote_char
== '\0')
1964 const char *ptr
= LS_TOKEN_STOKEN (token
).ptr
;
1965 for (size_t i
= 0; i
< LS_TOKEN_STOKEN (token
).length
; i
++)
1969 LS_TOKEN_STOKEN (token
).length
= i
;
1970 PARSER_STREAM (parser
) = skip_spaces (ptr
+ i
+ 1);
1976 if (parser
->completion_tracker
!= NULL
)
1978 if (PARSER_STREAM (parser
)[-1] == ' ')
1980 parser
->completion_word
= PARSER_STREAM (parser
);
1981 parser
->complete_what
= linespec_complete_what::KEYWORD
;
1986 /* Grab a copy of the label's name and look it up. */
1987 name
= copy_token_string (token
);
1989 = find_label_symbols (PARSER_STATE (parser
),
1990 PARSER_RESULT (parser
)->function_symbols
,
1991 &symbols
, name
.get ());
1995 PARSER_RESULT (parser
)->labels
.label_symbols
= labels
;
1996 PARSER_RESULT (parser
)->labels
.function_symbols
= symbols
;
1997 PARSER_EXPLICIT (parser
)->label_name
= name
.release ();
2002 /* We don't know what it was, but it isn't a label. */
2003 undefined_label_error
2004 (PARSER_EXPLICIT (parser
)->function_name
, name
.get ());
2009 /* Check for a line offset. */
2010 token
= save_stream_and_consume_token (parser
);
2011 if (token
.type
== LSTOKEN_COLON
)
2013 /* Get the next token. */
2014 token
= linespec_lexer_consume_token (parser
);
2016 /* It must be a line offset. */
2017 if (token
.type
!= LSTOKEN_NUMBER
)
2018 unexpected_linespec_error (parser
);
2020 /* Record the line offset and get the next token. */
2021 name
= copy_token_string (token
);
2023 PARSER_EXPLICIT (parser
)->line_offset
2024 = linespec_parse_line_offset (name
.get ());
2026 /* Get the next token. */
2027 token
= linespec_lexer_consume_token (parser
);
2032 /* Trailing ':' in the input. Issue an error. */
2033 unexpected_linespec_error (parser
);
2038 /* Canonicalize the linespec contained in LS. The result is saved into
2039 STATE->canonical. This function handles both linespec and explicit
2043 canonicalize_linespec (struct linespec_state
*state
, const linespec_p ls
)
2045 struct event_location
*canon
;
2046 struct explicit_location
*explicit_loc
;
2048 /* If canonicalization was not requested, no need to do anything. */
2049 if (!state
->canonical
)
2052 /* Save everything as an explicit location. */
2053 state
->canonical
->location
2054 = new_explicit_location (&ls
->explicit_loc
);
2055 canon
= state
->canonical
->location
.get ();
2056 explicit_loc
= get_explicit_location (canon
);
2058 if (explicit_loc
->label_name
!= NULL
)
2060 state
->canonical
->special_display
= 1;
2062 if (explicit_loc
->function_name
== NULL
)
2066 /* No function was specified, so add the symbol name. */
2067 gdb_assert (ls
->labels
.function_symbols
!= NULL
2068 && (VEC_length (symbolp
, ls
->labels
.function_symbols
)
2070 s
= VEC_index (symbolp
, ls
->labels
.function_symbols
, 0);
2071 explicit_loc
->function_name
= xstrdup (SYMBOL_NATURAL_NAME (s
));
2075 /* If this location originally came from a linespec, save a string
2076 representation of it for display and saving to file. */
2077 if (state
->is_linespec
)
2079 char *linespec
= explicit_location_to_linespec (explicit_loc
);
2081 set_event_location_string (canon
, linespec
);
2086 /* Given a line offset in LS, construct the relevant SALs. */
2088 static std::vector
<symtab_and_line
>
2089 create_sals_line_offset (struct linespec_state
*self
,
2092 int use_default
= 0;
2094 /* This is where we need to make sure we have good defaults.
2095 We must guarantee that this section of code is never executed
2096 when we are called with just a function name, since
2097 set_default_source_symtab_and_line uses
2098 select_source_symtab that calls us with such an argument. */
2100 if (ls
->file_symtabs
->size () == 1
2101 && ls
->file_symtabs
->front () == nullptr)
2103 const char *fullname
;
2105 set_current_program_space (self
->program_space
);
2107 /* Make sure we have at least a default source line. */
2108 set_default_source_symtab_and_line ();
2109 initialize_defaults (&self
->default_symtab
, &self
->default_line
);
2110 fullname
= symtab_to_fullname (self
->default_symtab
);
2111 symtab_vector_up r
=
2112 collect_symtabs_from_filename (fullname
, self
->search_pspace
);
2113 ls
->file_symtabs
= r
.release ();
2117 symtab_and_line val
;
2118 val
.line
= ls
->explicit_loc
.line_offset
.offset
;
2119 switch (ls
->explicit_loc
.line_offset
.sign
)
2121 case LINE_OFFSET_PLUS
:
2122 if (ls
->explicit_loc
.line_offset
.offset
== 0)
2125 val
.line
= self
->default_line
+ val
.line
;
2128 case LINE_OFFSET_MINUS
:
2129 if (ls
->explicit_loc
.line_offset
.offset
== 0)
2132 val
.line
= self
->default_line
- val
.line
;
2134 val
.line
= -val
.line
;
2137 case LINE_OFFSET_NONE
:
2138 break; /* No need to adjust val.line. */
2141 std::vector
<symtab_and_line
> values
;
2142 if (self
->list_mode
)
2143 values
= decode_digits_list_mode (self
, ls
, val
);
2146 struct linetable_entry
*best_entry
= NULL
;
2149 std::vector
<symtab_and_line
> intermediate_results
2150 = decode_digits_ordinary (self
, ls
, val
.line
, &best_entry
);
2151 if (intermediate_results
.empty () && best_entry
!= NULL
)
2152 intermediate_results
= decode_digits_ordinary (self
, ls
,
2156 /* For optimized code, the compiler can scatter one source line
2157 across disjoint ranges of PC values, even when no duplicate
2158 functions or inline functions are involved. For example,
2159 'for (;;)' inside a non-template, non-inline, and non-ctor-or-dtor
2160 function can result in two PC ranges. In this case, we don't
2161 want to set a breakpoint on the first PC of each range. To filter
2162 such cases, we use containing blocks -- for each PC found
2163 above, we see if there are other PCs that are in the same
2164 block. If yes, the other PCs are filtered out. */
2166 gdb::def_vector
<int> filter (intermediate_results
.size ());
2167 gdb::def_vector
<const block
*> blocks (intermediate_results
.size ());
2169 for (i
= 0; i
< intermediate_results
.size (); ++i
)
2171 set_current_program_space (intermediate_results
[i
].pspace
);
2174 blocks
[i
] = block_for_pc_sect (intermediate_results
[i
].pc
,
2175 intermediate_results
[i
].section
);
2178 for (i
= 0; i
< intermediate_results
.size (); ++i
)
2180 if (blocks
[i
] != NULL
)
2181 for (j
= i
+ 1; j
< intermediate_results
.size (); ++j
)
2183 if (blocks
[j
] == blocks
[i
])
2191 for (i
= 0; i
< intermediate_results
.size (); ++i
)
2194 struct symbol
*sym
= (blocks
[i
]
2195 ? block_containing_function (blocks
[i
])
2198 if (self
->funfirstline
)
2199 skip_prologue_sal (&intermediate_results
[i
]);
2200 intermediate_results
[i
].symbol
= sym
;
2201 add_sal_to_sals (self
, &values
, &intermediate_results
[i
],
2202 sym
? SYMBOL_NATURAL_NAME (sym
) : NULL
, 0);
2206 if (values
.empty ())
2208 if (ls
->explicit_loc
.source_filename
)
2209 throw_error (NOT_FOUND_ERROR
, _("No line %d in file \"%s\"."),
2210 val
.line
, ls
->explicit_loc
.source_filename
);
2212 throw_error (NOT_FOUND_ERROR
, _("No line %d in the current file."),
2219 /* Convert the given ADDRESS into SaLs. */
2221 static std::vector
<symtab_and_line
>
2222 convert_address_location_to_sals (struct linespec_state
*self
,
2225 symtab_and_line sal
= find_pc_line (address
, 0);
2227 sal
.section
= find_pc_overlay (address
);
2228 sal
.explicit_pc
= 1;
2229 sal
.symbol
= find_pc_sect_containing_function (sal
.pc
, sal
.section
);
2231 std::vector
<symtab_and_line
> sals
;
2232 add_sal_to_sals (self
, &sals
, &sal
, core_addr_to_string (address
), 1);
2237 /* Create and return SALs from the linespec LS. */
2239 static std::vector
<symtab_and_line
>
2240 convert_linespec_to_sals (struct linespec_state
*state
, linespec_p ls
)
2242 std::vector
<symtab_and_line
> sals
;
2244 if (ls
->labels
.label_symbols
!= NULL
)
2246 /* We have just a bunch of functions/methods or labels. */
2248 struct symtab_and_line sal
;
2251 for (i
= 0; VEC_iterate (symbolp
, ls
->labels
.label_symbols
, i
, sym
); ++i
)
2253 struct program_space
*pspace
= SYMTAB_PSPACE (symbol_symtab (sym
));
2255 if (symbol_to_sal (&sal
, state
->funfirstline
, sym
)
2256 && maybe_add_address (state
->addr_set
, pspace
, sal
.pc
))
2257 add_sal_to_sals (state
, &sals
, &sal
,
2258 SYMBOL_NATURAL_NAME (sym
), 0);
2261 else if (ls
->function_symbols
!= NULL
|| ls
->minimal_symbols
!= NULL
)
2263 /* We have just a bunch of functions and/or methods. */
2264 if (ls
->function_symbols
!= NULL
)
2266 /* Sort symbols so that symbols with the same program space are next
2268 qsort (VEC_address (symbolp
, ls
->function_symbols
),
2269 VEC_length (symbolp
, ls
->function_symbols
),
2270 sizeof (symbolp
), compare_symbols
);
2273 for (int i
= 0; VEC_iterate (symbolp
, ls
->function_symbols
, i
, sym
); ++i
)
2275 program_space
*pspace
= SYMTAB_PSPACE (symbol_symtab (sym
));
2276 set_current_program_space (pspace
);
2278 /* Don't skip to the first line of the function if we
2279 had found an ifunc minimal symbol for this function,
2280 because that means that this function is an ifunc
2281 resolver with the same name as the ifunc itself. */
2282 bool found_ifunc
= false;
2284 if (state
->funfirstline
2285 && ls
->minimal_symbols
!= NULL
2286 && SYMBOL_CLASS (sym
) == LOC_BLOCK
)
2288 const CORE_ADDR addr
2289 = BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
));
2291 bound_minimal_symbol_d
*elem
;
2293 VEC_iterate (bound_minimal_symbol_d
, ls
->minimal_symbols
,
2297 if (MSYMBOL_TYPE (elem
->minsym
) == mst_text_gnu_ifunc
2298 || MSYMBOL_TYPE (elem
->minsym
) == mst_data_gnu_ifunc
)
2300 CORE_ADDR msym_addr
= BMSYMBOL_VALUE_ADDRESS (*elem
);
2301 if (MSYMBOL_TYPE (elem
->minsym
) == mst_data_gnu_ifunc
)
2303 struct gdbarch
*gdbarch
2304 = get_objfile_arch (elem
->objfile
);
2306 = (gdbarch_convert_from_func_ptr_addr
2309 current_top_target ()));
2312 if (msym_addr
== addr
)
2323 symtab_and_line sal
;
2324 if (symbol_to_sal (&sal
, state
->funfirstline
, sym
)
2325 && maybe_add_address (state
->addr_set
, pspace
, sal
.pc
))
2326 add_sal_to_sals (state
, &sals
, &sal
,
2327 SYMBOL_NATURAL_NAME (sym
), 0);
2332 if (ls
->minimal_symbols
!= NULL
)
2334 /* Sort minimal symbols by program space, too */
2335 qsort (VEC_address (bound_minimal_symbol_d
, ls
->minimal_symbols
),
2336 VEC_length (bound_minimal_symbol_d
, ls
->minimal_symbols
),
2337 sizeof (bound_minimal_symbol_d
), compare_msymbols
);
2339 bound_minimal_symbol_d
*elem
;
2342 VEC_iterate (bound_minimal_symbol_d
, ls
->minimal_symbols
,
2346 program_space
*pspace
= elem
->objfile
->pspace
;
2347 set_current_program_space (pspace
);
2348 minsym_found (state
, elem
->objfile
, elem
->minsym
, &sals
);
2352 else if (ls
->explicit_loc
.line_offset
.sign
!= LINE_OFFSET_UNKNOWN
)
2354 /* Only an offset was specified. */
2355 sals
= create_sals_line_offset (state
, ls
);
2357 /* Make sure we have a filename for canonicalization. */
2358 if (ls
->explicit_loc
.source_filename
== NULL
)
2360 const char *fullname
= symtab_to_fullname (state
->default_symtab
);
2362 /* It may be more appropriate to keep DEFAULT_SYMTAB in its symtab
2363 form so that displaying SOURCE_FILENAME can follow the current
2364 FILENAME_DISPLAY_STRING setting. But as it is used only rarely
2365 it has been kept for code simplicity only in absolute form. */
2366 ls
->explicit_loc
.source_filename
= xstrdup (fullname
);
2371 /* We haven't found any results... */
2375 canonicalize_linespec (state
, ls
);
2377 if (!sals
.empty () && state
->canonical
!= NULL
)
2378 state
->canonical
->pre_expanded
= 1;
2383 /* Build RESULT from the explicit location components SOURCE_FILENAME,
2384 FUNCTION_NAME, LABEL_NAME and LINE_OFFSET. */
2387 convert_explicit_location_to_linespec (struct linespec_state
*self
,
2389 const char *source_filename
,
2390 const char *function_name
,
2391 symbol_name_match_type fname_match_type
,
2392 const char *label_name
,
2393 struct line_offset line_offset
)
2395 VEC (symbolp
) *symbols
, *labels
;
2396 VEC (bound_minimal_symbol_d
) *minimal_symbols
;
2398 result
->explicit_loc
.func_name_match_type
= fname_match_type
;
2400 if (source_filename
!= NULL
)
2404 result
->file_symtabs
2405 = symtabs_from_filename (source_filename
,
2406 self
->search_pspace
).release ();
2408 CATCH (except
, RETURN_MASK_ERROR
)
2410 source_file_not_found_error (source_filename
);
2413 result
->explicit_loc
.source_filename
= xstrdup (source_filename
);
2417 /* A NULL entry means to use the default symtab. */
2418 result
->file_symtabs
->push_back (nullptr);
2421 if (function_name
!= NULL
)
2423 find_linespec_symbols (self
, result
->file_symtabs
,
2424 function_name
, fname_match_type
,
2425 &symbols
, &minimal_symbols
);
2427 if (symbols
== NULL
&& minimal_symbols
== NULL
)
2428 symbol_not_found_error (function_name
,
2429 result
->explicit_loc
.source_filename
);
2431 result
->explicit_loc
.function_name
= xstrdup (function_name
);
2432 result
->function_symbols
= symbols
;
2433 result
->minimal_symbols
= minimal_symbols
;
2436 if (label_name
!= NULL
)
2439 labels
= find_label_symbols (self
, result
->function_symbols
,
2440 &symbols
, label_name
);
2443 undefined_label_error (result
->explicit_loc
.function_name
,
2446 result
->explicit_loc
.label_name
= xstrdup (label_name
);
2447 result
->labels
.label_symbols
= labels
;
2448 result
->labels
.function_symbols
= symbols
;
2451 if (line_offset
.sign
!= LINE_OFFSET_UNKNOWN
)
2452 result
->explicit_loc
.line_offset
= line_offset
;
2455 /* Convert the explicit location EXPLICIT_LOC into SaLs. */
2457 static std::vector
<symtab_and_line
>
2458 convert_explicit_location_to_sals (struct linespec_state
*self
,
2460 const struct explicit_location
*explicit_loc
)
2462 convert_explicit_location_to_linespec (self
, result
,
2463 explicit_loc
->source_filename
,
2464 explicit_loc
->function_name
,
2465 explicit_loc
->func_name_match_type
,
2466 explicit_loc
->label_name
,
2467 explicit_loc
->line_offset
);
2468 return convert_linespec_to_sals (self
, result
);
2471 /* Parse a string that specifies a linespec.
2473 The basic grammar of linespecs:
2475 linespec -> var_spec | basic_spec
2476 var_spec -> '$' (STRING | NUMBER)
2478 basic_spec -> file_offset_spec | function_spec | label_spec
2479 file_offset_spec -> opt_file_spec offset_spec
2480 function_spec -> opt_file_spec function_name_spec opt_label_spec
2481 label_spec -> label_name_spec
2483 opt_file_spec -> "" | file_name_spec ':'
2484 opt_label_spec -> "" | ':' label_name_spec
2486 file_name_spec -> STRING
2487 function_name_spec -> STRING
2488 label_name_spec -> STRING
2489 function_name_spec -> STRING
2490 offset_spec -> NUMBER
2494 This may all be followed by several keywords such as "if EXPR",
2497 A comma will terminate parsing.
2499 The function may be an undebuggable function found in minimal symbol table.
2501 If the argument FUNFIRSTLINE is nonzero, we want the first line
2502 of real code inside a function when a function is specified, and it is
2503 not OK to specify a variable or type to get its line number.
2505 DEFAULT_SYMTAB specifies the file to use if none is specified.
2506 It defaults to current_source_symtab.
2507 DEFAULT_LINE specifies the line number to use for relative
2508 line numbers (that start with signs). Defaults to current_source_line.
2509 If CANONICAL is non-NULL, store an array of strings containing the canonical
2510 line specs there if necessary. Currently overloaded member functions and
2511 line numbers or static functions without a filename yield a canonical
2512 line spec. The array and the line spec strings are allocated on the heap,
2513 it is the callers responsibility to free them.
2515 Note that it is possible to return zero for the symtab
2516 if no file is validly specified. Callers must check that.
2517 Also, the line number returned may be invalid. */
2519 /* Parse the linespec in ARG. MATCH_TYPE indicates how function names
2520 should be matched. */
2522 static std::vector
<symtab_and_line
>
2523 parse_linespec (linespec_parser
*parser
, const char *arg
,
2524 symbol_name_match_type match_type
)
2526 linespec_token token
;
2527 struct gdb_exception file_exception
= exception_none
;
2529 /* A special case to start. It has become quite popular for
2530 IDEs to work around bugs in the previous parser by quoting
2531 the entire linespec, so we attempt to deal with this nicely. */
2532 parser
->is_quote_enclosed
= 0;
2533 if (parser
->completion_tracker
== NULL
2534 && !is_ada_operator (arg
)
2535 && strchr (linespec_quote_characters
, *arg
) != NULL
)
2539 end
= skip_quote_char (arg
+ 1, *arg
);
2540 if (end
!= NULL
&& is_closing_quote_enclosed (end
))
2542 /* Here's the special case. Skip ARG past the initial
2545 parser
->is_quote_enclosed
= 1;
2549 parser
->lexer
.saved_arg
= arg
;
2550 parser
->lexer
.stream
= arg
;
2551 parser
->completion_word
= arg
;
2552 parser
->complete_what
= linespec_complete_what::FUNCTION
;
2553 PARSER_EXPLICIT (parser
)->func_name_match_type
= match_type
;
2555 /* Initialize the default symtab and line offset. */
2556 initialize_defaults (&PARSER_STATE (parser
)->default_symtab
,
2557 &PARSER_STATE (parser
)->default_line
);
2559 /* Objective-C shortcut. */
2560 if (parser
->completion_tracker
== NULL
)
2562 std::vector
<symtab_and_line
> values
2563 = decode_objc (PARSER_STATE (parser
), PARSER_RESULT (parser
), arg
);
2564 if (!values
.empty ())
2569 /* "-"/"+" is either an objc selector, or a number. There's
2570 nothing to complete the latter to, so just let the caller
2571 complete on functions, which finds objc selectors, if there's
2573 if ((arg
[0] == '-' || arg
[0] == '+') && arg
[1] == '\0')
2577 /* Start parsing. */
2579 /* Get the first token. */
2580 token
= linespec_lexer_consume_token (parser
);
2582 /* It must be either LSTOKEN_STRING or LSTOKEN_NUMBER. */
2583 if (token
.type
== LSTOKEN_STRING
&& *LS_TOKEN_STOKEN (token
).ptr
== '$')
2585 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2586 if (parser
->completion_tracker
== NULL
)
2587 PARSER_RESULT (parser
)->file_symtabs
->push_back (nullptr);
2589 /* User specified a convenience variable or history value. */
2590 gdb::unique_xmalloc_ptr
<char> var
= copy_token_string (token
);
2591 PARSER_EXPLICIT (parser
)->line_offset
2592 = linespec_parse_variable (PARSER_STATE (parser
), var
.get ());
2594 /* If a line_offset wasn't found (VAR is the name of a user
2595 variable/function), then skip to normal symbol processing. */
2596 if (PARSER_EXPLICIT (parser
)->line_offset
.sign
!= LINE_OFFSET_UNKNOWN
)
2598 /* Consume this token. */
2599 linespec_lexer_consume_token (parser
);
2601 goto convert_to_sals
;
2604 else if (token
.type
== LSTOKEN_EOI
&& parser
->completion_tracker
!= NULL
)
2606 /* Let the default linespec_complete_what::FUNCTION kick in. */
2607 unexpected_linespec_error (parser
);
2609 else if (token
.type
!= LSTOKEN_STRING
&& token
.type
!= LSTOKEN_NUMBER
)
2611 parser
->complete_what
= linespec_complete_what::NOTHING
;
2612 unexpected_linespec_error (parser
);
2615 /* Shortcut: If the next token is not LSTOKEN_COLON, we know that
2616 this token cannot represent a filename. */
2617 token
= linespec_lexer_peek_token (parser
);
2619 if (token
.type
== LSTOKEN_COLON
)
2621 /* Get the current token again and extract the filename. */
2622 token
= linespec_lexer_lex_one (parser
);
2623 gdb::unique_xmalloc_ptr
<char> user_filename
= copy_token_string (token
);
2625 /* Check if the input is a filename. */
2629 = symtabs_from_filename (user_filename
.get (),
2630 PARSER_STATE (parser
)->search_pspace
);
2631 PARSER_RESULT (parser
)->file_symtabs
= r
.release ();
2633 CATCH (ex
, RETURN_MASK_ERROR
)
2635 file_exception
= ex
;
2639 if (file_exception
.reason
>= 0)
2641 /* Symtabs were found for the file. Record the filename. */
2642 PARSER_EXPLICIT (parser
)->source_filename
= user_filename
.release ();
2644 /* Get the next token. */
2645 token
= linespec_lexer_consume_token (parser
);
2647 /* This is LSTOKEN_COLON; consume it. */
2648 linespec_lexer_consume_token (parser
);
2652 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2653 PARSER_RESULT (parser
)->file_symtabs
->push_back (nullptr);
2656 /* If the next token is not EOI, KEYWORD, or COMMA, issue an error. */
2657 else if (parser
->completion_tracker
== NULL
2658 && (token
.type
!= LSTOKEN_EOI
&& token
.type
!= LSTOKEN_KEYWORD
2659 && token
.type
!= LSTOKEN_COMMA
))
2661 /* TOKEN is the _next_ token, not the one currently in the parser.
2662 Consuming the token will give the correct error message. */
2663 linespec_lexer_consume_token (parser
);
2664 unexpected_linespec_error (parser
);
2668 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2669 PARSER_RESULT (parser
)->file_symtabs
->push_back (nullptr);
2672 /* Parse the rest of the linespec. */
2673 linespec_parse_basic (parser
);
2675 if (parser
->completion_tracker
== NULL
2676 && PARSER_RESULT (parser
)->function_symbols
== NULL
2677 && PARSER_RESULT (parser
)->labels
.label_symbols
== NULL
2678 && PARSER_EXPLICIT (parser
)->line_offset
.sign
== LINE_OFFSET_UNKNOWN
2679 && PARSER_RESULT (parser
)->minimal_symbols
== NULL
)
2681 /* The linespec didn't parse. Re-throw the file exception if
2683 if (file_exception
.reason
< 0)
2684 throw_exception (file_exception
);
2686 /* Otherwise, the symbol is not found. */
2687 symbol_not_found_error (PARSER_EXPLICIT (parser
)->function_name
,
2688 PARSER_EXPLICIT (parser
)->source_filename
);
2693 /* Get the last token and record how much of the input was parsed,
2695 token
= linespec_lexer_lex_one (parser
);
2696 if (token
.type
!= LSTOKEN_EOI
&& token
.type
!= LSTOKEN_KEYWORD
)
2697 unexpected_linespec_error (parser
);
2698 else if (token
.type
== LSTOKEN_KEYWORD
)
2700 /* Setup the completion word past the keyword. Lexing never
2701 advances past a keyword automatically, so skip it
2703 parser
->completion_word
2704 = skip_spaces (skip_to_space (PARSER_STREAM (parser
)));
2705 parser
->complete_what
= linespec_complete_what::EXPRESSION
;
2708 /* Convert the data in PARSER_RESULT to SALs. */
2709 if (parser
->completion_tracker
== NULL
)
2710 return convert_linespec_to_sals (PARSER_STATE (parser
),
2711 PARSER_RESULT (parser
));
2717 /* A constructor for linespec_state. */
2720 linespec_state_constructor (struct linespec_state
*self
,
2721 int flags
, const struct language_defn
*language
,
2722 struct program_space
*search_pspace
,
2723 struct symtab
*default_symtab
,
2725 struct linespec_result
*canonical
)
2727 memset (self
, 0, sizeof (*self
));
2728 self
->language
= language
;
2729 self
->funfirstline
= (flags
& DECODE_LINE_FUNFIRSTLINE
) ? 1 : 0;
2730 self
->list_mode
= (flags
& DECODE_LINE_LIST_MODE
) ? 1 : 0;
2731 self
->search_pspace
= search_pspace
;
2732 self
->default_symtab
= default_symtab
;
2733 self
->default_line
= default_line
;
2734 self
->canonical
= canonical
;
2735 self
->program_space
= current_program_space
;
2736 self
->addr_set
= htab_create_alloc (10, hash_address_entry
, eq_address_entry
,
2737 xfree
, xcalloc
, xfree
);
2738 self
->is_linespec
= 0;
2741 /* Initialize a new linespec parser. */
2744 linespec_parser_new (linespec_parser
*parser
,
2745 int flags
, const struct language_defn
*language
,
2746 struct program_space
*search_pspace
,
2747 struct symtab
*default_symtab
,
2749 struct linespec_result
*canonical
)
2751 memset (parser
, 0, sizeof (linespec_parser
));
2752 parser
->lexer
.current
.type
= LSTOKEN_CONSUMED
;
2753 memset (PARSER_RESULT (parser
), 0, sizeof (struct linespec
));
2754 PARSER_RESULT (parser
)->file_symtabs
= new std::vector
<symtab
*> ();
2755 PARSER_EXPLICIT (parser
)->func_name_match_type
2756 = symbol_name_match_type::WILD
;
2757 PARSER_EXPLICIT (parser
)->line_offset
.sign
= LINE_OFFSET_UNKNOWN
;
2758 linespec_state_constructor (PARSER_STATE (parser
), flags
, language
,
2760 default_symtab
, default_line
, canonical
);
2763 /* A destructor for linespec_state. */
2766 linespec_state_destructor (struct linespec_state
*self
)
2768 htab_delete (self
->addr_set
);
2771 /* Delete a linespec parser. */
2774 linespec_parser_delete (void *arg
)
2776 linespec_parser
*parser
= (linespec_parser
*) arg
;
2778 xfree (PARSER_EXPLICIT (parser
)->source_filename
);
2779 xfree (PARSER_EXPLICIT (parser
)->label_name
);
2780 xfree (PARSER_EXPLICIT (parser
)->function_name
);
2782 delete PARSER_RESULT (parser
)->file_symtabs
;
2784 if (PARSER_RESULT (parser
)->function_symbols
!= NULL
)
2785 VEC_free (symbolp
, PARSER_RESULT (parser
)->function_symbols
);
2787 if (PARSER_RESULT (parser
)->minimal_symbols
!= NULL
)
2788 VEC_free (bound_minimal_symbol_d
, PARSER_RESULT (parser
)->minimal_symbols
);
2790 if (PARSER_RESULT (parser
)->labels
.label_symbols
!= NULL
)
2791 VEC_free (symbolp
, PARSER_RESULT (parser
)->labels
.label_symbols
);
2793 if (PARSER_RESULT (parser
)->labels
.function_symbols
!= NULL
)
2794 VEC_free (symbolp
, PARSER_RESULT (parser
)->labels
.function_symbols
);
2796 linespec_state_destructor (PARSER_STATE (parser
));
2799 /* See description in linespec.h. */
2802 linespec_lex_to_end (const char **stringp
)
2804 linespec_parser parser
;
2805 struct cleanup
*cleanup
;
2806 linespec_token token
;
2809 if (stringp
== NULL
|| *stringp
== NULL
)
2812 linespec_parser_new (&parser
, 0, current_language
, NULL
, NULL
, 0, NULL
);
2813 cleanup
= make_cleanup (linespec_parser_delete
, &parser
);
2814 parser
.lexer
.saved_arg
= *stringp
;
2815 PARSER_STREAM (&parser
) = orig
= *stringp
;
2819 /* Stop before any comma tokens; we need it to keep it
2820 as the next token in the string. */
2821 token
= linespec_lexer_peek_token (&parser
);
2822 if (token
.type
== LSTOKEN_COMMA
)
2824 token
= linespec_lexer_consume_token (&parser
);
2826 while (token
.type
!= LSTOKEN_EOI
&& token
.type
!= LSTOKEN_KEYWORD
);
2828 *stringp
+= PARSER_STREAM (&parser
) - orig
;
2829 do_cleanups (cleanup
);
2832 /* See linespec.h. */
2835 linespec_complete_function (completion_tracker
&tracker
,
2836 const char *function
,
2837 symbol_name_match_type func_match_type
,
2838 const char *source_filename
)
2840 complete_symbol_mode mode
= complete_symbol_mode::LINESPEC
;
2842 if (source_filename
!= NULL
)
2844 collect_file_symbol_completion_matches (tracker
, mode
, func_match_type
,
2845 function
, function
, source_filename
);
2849 collect_symbol_completion_matches (tracker
, mode
, func_match_type
,
2850 function
, function
);
2855 /* Helper for complete_linespec to simplify it. SOURCE_FILENAME is
2856 only meaningful if COMPONENT is FUNCTION. */
2859 complete_linespec_component (linespec_parser
*parser
,
2860 completion_tracker
&tracker
,
2862 linespec_complete_what component
,
2863 const char *source_filename
)
2865 if (component
== linespec_complete_what::KEYWORD
)
2867 complete_on_enum (tracker
, linespec_keywords
, text
, text
);
2869 else if (component
== linespec_complete_what::EXPRESSION
)
2872 = advance_to_expression_complete_word_point (tracker
, text
);
2873 complete_expression (tracker
, text
, word
);
2875 else if (component
== linespec_complete_what::FUNCTION
)
2877 completion_list fn_list
;
2879 symbol_name_match_type match_type
2880 = PARSER_EXPLICIT (parser
)->func_name_match_type
;
2881 linespec_complete_function (tracker
, text
, match_type
, source_filename
);
2882 if (source_filename
== NULL
)
2884 /* Haven't seen a source component, like in "b
2885 file.c:function[TAB]". Maybe this wasn't a function, but
2886 a filename instead, like "b file.[TAB]". */
2887 fn_list
= complete_source_filenames (text
);
2890 /* If we only have a single filename completion, append a ':' for
2891 the user, since that's the only thing that can usefully follow
2893 if (fn_list
.size () == 1 && !tracker
.have_completions ())
2895 char *fn
= fn_list
[0].release ();
2897 /* If we also need to append a quote char, it needs to be
2898 appended before the ':'. Append it now, and make ':' the
2899 new "quote" char. */
2900 if (tracker
.quote_char ())
2902 char quote_char_str
[2] = { (char) tracker
.quote_char () };
2904 fn
= reconcat (fn
, fn
, quote_char_str
, (char *) NULL
);
2905 tracker
.set_quote_char (':');
2908 fn
= reconcat (fn
, fn
, ":", (char *) NULL
);
2909 fn_list
[0].reset (fn
);
2911 /* Tell readline to skip appending a space. */
2912 tracker
.set_suppress_append_ws (true);
2914 tracker
.add_completions (std::move (fn_list
));
2918 /* Helper for linespec_complete_label. Find labels that match
2919 LABEL_NAME in the function symbols listed in the PARSER, and add
2920 them to the tracker. */
2923 complete_label (completion_tracker
&tracker
,
2924 linespec_parser
*parser
,
2925 const char *label_name
)
2927 VEC (symbolp
) *label_function_symbols
= NULL
;
2928 VEC (symbolp
) *labels
2929 = find_label_symbols (PARSER_STATE (parser
),
2930 PARSER_RESULT (parser
)->function_symbols
,
2931 &label_function_symbols
,
2936 VEC_iterate (symbolp
, labels
, ix
, label
); ++ix
)
2938 char *match
= xstrdup (SYMBOL_SEARCH_NAME (label
));
2939 tracker
.add_completion (gdb::unique_xmalloc_ptr
<char> (match
));
2941 VEC_free (symbolp
, labels
);
2944 /* See linespec.h. */
2947 linespec_complete_label (completion_tracker
&tracker
,
2948 const struct language_defn
*language
,
2949 const char *source_filename
,
2950 const char *function_name
,
2951 symbol_name_match_type func_name_match_type
,
2952 const char *label_name
)
2954 linespec_parser parser
;
2955 struct cleanup
*cleanup
;
2957 linespec_parser_new (&parser
, 0, language
, NULL
, NULL
, 0, NULL
);
2958 cleanup
= make_cleanup (linespec_parser_delete
, &parser
);
2960 line_offset unknown_offset
= { 0, LINE_OFFSET_UNKNOWN
};
2964 convert_explicit_location_to_linespec (PARSER_STATE (&parser
),
2965 PARSER_RESULT (&parser
),
2968 func_name_match_type
,
2969 NULL
, unknown_offset
);
2971 CATCH (ex
, RETURN_MASK_ERROR
)
2973 do_cleanups (cleanup
);
2978 complete_label (tracker
, &parser
, label_name
);
2980 do_cleanups (cleanup
);
2983 /* See description in linespec.h. */
2986 linespec_complete (completion_tracker
&tracker
, const char *text
,
2987 symbol_name_match_type match_type
)
2989 linespec_parser parser
;
2990 struct cleanup
*cleanup
;
2991 const char *orig
= text
;
2993 linespec_parser_new (&parser
, 0, current_language
, NULL
, NULL
, 0, NULL
);
2994 cleanup
= make_cleanup (linespec_parser_delete
, &parser
);
2995 parser
.lexer
.saved_arg
= text
;
2996 PARSER_EXPLICIT (&parser
)->func_name_match_type
= match_type
;
2997 PARSER_STREAM (&parser
) = text
;
2999 parser
.completion_tracker
= &tracker
;
3000 PARSER_STATE (&parser
)->is_linespec
= 1;
3002 /* Parse as much as possible. parser.completion_word will hold
3003 furthest completion point we managed to parse to. */
3006 parse_linespec (&parser
, text
, match_type
);
3008 CATCH (except
, RETURN_MASK_ERROR
)
3013 if (parser
.completion_quote_char
!= '\0'
3014 && parser
.completion_quote_end
!= NULL
3015 && parser
.completion_quote_end
[1] == '\0')
3017 /* If completing a quoted string with the cursor right at
3018 terminating quote char, complete the completion word without
3019 interpretation, so that readline advances the cursor one
3020 whitespace past the quote, even if there's no match. This
3021 makes these cases behave the same:
3023 before: "b function()"
3024 after: "b function() "
3026 before: "b 'function()'"
3027 after: "b 'function()' "
3029 and trusts the user in this case:
3031 before: "b 'not_loaded_function_yet()'"
3032 after: "b 'not_loaded_function_yet()' "
3034 parser
.complete_what
= linespec_complete_what::NOTHING
;
3035 parser
.completion_quote_char
= '\0';
3037 gdb::unique_xmalloc_ptr
<char> text_copy
3038 (xstrdup (parser
.completion_word
));
3039 tracker
.add_completion (std::move (text_copy
));
3042 tracker
.set_quote_char (parser
.completion_quote_char
);
3044 if (parser
.complete_what
== linespec_complete_what::LABEL
)
3046 parser
.complete_what
= linespec_complete_what::NOTHING
;
3048 const char *func_name
= PARSER_EXPLICIT (&parser
)->function_name
;
3050 VEC (symbolp
) *function_symbols
;
3051 VEC (bound_minimal_symbol_d
) *minimal_symbols
;
3052 find_linespec_symbols (PARSER_STATE (&parser
),
3053 PARSER_RESULT (&parser
)->file_symtabs
,
3054 func_name
, match_type
,
3055 &function_symbols
, &minimal_symbols
);
3057 PARSER_RESULT (&parser
)->function_symbols
= function_symbols
;
3058 PARSER_RESULT (&parser
)->minimal_symbols
= minimal_symbols
;
3060 complete_label (tracker
, &parser
, parser
.completion_word
);
3062 else if (parser
.complete_what
== linespec_complete_what::FUNCTION
)
3064 /* While parsing/lexing, we didn't know whether the completion
3065 word completes to a unique function/source name already or
3069 "b function() <tab>"
3070 may need to complete either to:
3071 "b function() const"
3073 "b function() if/thread/task"
3077 may need to complete either to:
3078 "b foo template_fun<T>()"
3079 with "foo" being the template function's return type, or to:
3084 may need to complete either to a source file name:
3086 or this, also a filename, but a unique completion:
3088 or to a function name:
3091 Address that by completing assuming source or function, and
3092 seeing if we find a completion that matches exactly the
3093 completion word. If so, then it must be a function (see note
3094 below) and we advance the completion word to the end of input
3095 and switch to KEYWORD completion mode.
3097 Note: if we find a unique completion for a source filename,
3098 then it won't match the completion word, because the LCD will
3099 contain a trailing ':'. And if we're completing at or after
3100 the ':', then complete_linespec_component won't try to
3101 complete on source filenames. */
3103 const char *word
= parser
.completion_word
;
3105 complete_linespec_component (&parser
, tracker
,
3106 parser
.completion_word
,
3107 linespec_complete_what::FUNCTION
,
3108 PARSER_EXPLICIT (&parser
)->source_filename
);
3110 parser
.complete_what
= linespec_complete_what::NOTHING
;
3112 if (tracker
.quote_char ())
3114 /* The function/file name was not close-quoted, so this
3115 can't be a keyword. Note: complete_linespec_component
3116 may have swapped the original quote char for ':' when we
3117 get here, but that still indicates the same. */
3119 else if (!tracker
.have_completions ())
3122 size_t wordlen
= strlen (parser
.completion_word
);
3125 = string_find_incomplete_keyword_at_end (linespec_keywords
,
3126 parser
.completion_word
,
3131 && parser
.completion_word
[wordlen
- 1] == ' '))
3133 parser
.completion_word
+= key_start
;
3134 parser
.complete_what
= linespec_complete_what::KEYWORD
;
3137 else if (tracker
.completes_to_completion_word (word
))
3139 /* Skip the function and complete on keywords. */
3140 parser
.completion_word
+= strlen (word
);
3141 parser
.complete_what
= linespec_complete_what::KEYWORD
;
3142 tracker
.discard_completions ();
3146 tracker
.advance_custom_word_point_by (parser
.completion_word
- orig
);
3148 complete_linespec_component (&parser
, tracker
,
3149 parser
.completion_word
,
3150 parser
.complete_what
,
3151 PARSER_EXPLICIT (&parser
)->source_filename
);
3153 /* If we're past the "filename:function:label:offset" linespec, and
3154 didn't find any match, then assume the user might want to create
3155 a pending breakpoint anyway and offer the keyword
3157 if (!parser
.completion_quote_char
3158 && (parser
.complete_what
== linespec_complete_what::FUNCTION
3159 || parser
.complete_what
== linespec_complete_what::LABEL
3160 || parser
.complete_what
== linespec_complete_what::NOTHING
)
3161 && !tracker
.have_completions ())
3164 = parser
.completion_word
+ strlen (parser
.completion_word
);
3166 if (end
> orig
&& end
[-1] == ' ')
3168 tracker
.advance_custom_word_point_by (end
- parser
.completion_word
);
3170 complete_linespec_component (&parser
, tracker
, end
,
3171 linespec_complete_what::KEYWORD
,
3176 do_cleanups (cleanup
);
3179 /* A helper function for decode_line_full and decode_line_1 to
3180 turn LOCATION into std::vector<symtab_and_line>. */
3182 static std::vector
<symtab_and_line
>
3183 event_location_to_sals (linespec_parser
*parser
,
3184 const struct event_location
*location
)
3186 std::vector
<symtab_and_line
> result
;
3188 switch (event_location_type (location
))
3190 case LINESPEC_LOCATION
:
3192 PARSER_STATE (parser
)->is_linespec
= 1;
3195 const linespec_location
*ls
= get_linespec_location (location
);
3196 result
= parse_linespec (parser
,
3197 ls
->spec_string
, ls
->match_type
);
3199 CATCH (except
, RETURN_MASK_ERROR
)
3201 throw_exception (except
);
3207 case ADDRESS_LOCATION
:
3209 const char *addr_string
= get_address_string_location (location
);
3210 CORE_ADDR addr
= get_address_location (location
);
3212 if (addr_string
!= NULL
)
3214 addr
= linespec_expression_to_pc (&addr_string
);
3215 if (PARSER_STATE (parser
)->canonical
!= NULL
)
3216 PARSER_STATE (parser
)->canonical
->location
3217 = copy_event_location (location
);
3220 result
= convert_address_location_to_sals (PARSER_STATE (parser
),
3225 case EXPLICIT_LOCATION
:
3227 const struct explicit_location
*explicit_loc
;
3229 explicit_loc
= get_explicit_location_const (location
);
3230 result
= convert_explicit_location_to_sals (PARSER_STATE (parser
),
3231 PARSER_RESULT (parser
),
3236 case PROBE_LOCATION
:
3237 /* Probes are handled by their own decoders. */
3238 gdb_assert_not_reached ("attempt to decode probe location");
3242 gdb_assert_not_reached ("unhandled event location type");
3248 /* See linespec.h. */
3251 decode_line_full (const struct event_location
*location
, int flags
,
3252 struct program_space
*search_pspace
,
3253 struct symtab
*default_symtab
,
3254 int default_line
, struct linespec_result
*canonical
,
3255 const char *select_mode
,
3258 struct cleanup
*cleanups
;
3259 std::vector
<const char *> filters
;
3260 linespec_parser parser
;
3261 struct linespec_state
*state
;
3263 gdb_assert (canonical
!= NULL
);
3264 /* The filter only makes sense for 'all'. */
3265 gdb_assert (filter
== NULL
|| select_mode
== multiple_symbols_all
);
3266 gdb_assert (select_mode
== NULL
3267 || select_mode
== multiple_symbols_all
3268 || select_mode
== multiple_symbols_ask
3269 || select_mode
== multiple_symbols_cancel
);
3270 gdb_assert ((flags
& DECODE_LINE_LIST_MODE
) == 0);
3272 linespec_parser_new (&parser
, flags
, current_language
,
3273 search_pspace
, default_symtab
,
3274 default_line
, canonical
);
3275 cleanups
= make_cleanup (linespec_parser_delete
, &parser
);
3277 scoped_restore_current_program_space restore_pspace
;
3279 std::vector
<symtab_and_line
> result
= event_location_to_sals (&parser
,
3281 state
= PARSER_STATE (&parser
);
3283 gdb_assert (result
.size () == 1 || canonical
->pre_expanded
);
3284 canonical
->pre_expanded
= 1;
3286 /* Arrange for allocated canonical names to be freed. */
3287 if (!result
.empty ())
3291 make_cleanup (xfree
, state
->canonical_names
);
3292 for (i
= 0; i
< result
.size (); ++i
)
3294 gdb_assert (state
->canonical_names
[i
].suffix
!= NULL
);
3295 make_cleanup (xfree
, state
->canonical_names
[i
].suffix
);
3299 if (select_mode
== NULL
)
3301 if (top_level_interpreter ()->interp_ui_out ()->is_mi_like_p ())
3302 select_mode
= multiple_symbols_all
;
3304 select_mode
= multiple_symbols_select_mode ();
3307 if (select_mode
== multiple_symbols_all
)
3311 filters
.push_back (filter
);
3312 filter_results (state
, &result
, filters
);
3315 convert_results_to_lsals (state
, &result
);
3318 decode_line_2 (state
, &result
, select_mode
);
3320 do_cleanups (cleanups
);
3323 /* See linespec.h. */
3325 std::vector
<symtab_and_line
>
3326 decode_line_1 (const struct event_location
*location
, int flags
,
3327 struct program_space
*search_pspace
,
3328 struct symtab
*default_symtab
,
3331 linespec_parser parser
;
3332 struct cleanup
*cleanups
;
3334 linespec_parser_new (&parser
, flags
, current_language
,
3335 search_pspace
, default_symtab
,
3336 default_line
, NULL
);
3337 cleanups
= make_cleanup (linespec_parser_delete
, &parser
);
3339 scoped_restore_current_program_space restore_pspace
;
3341 std::vector
<symtab_and_line
> result
= event_location_to_sals (&parser
,
3344 do_cleanups (cleanups
);
3348 /* See linespec.h. */
3350 std::vector
<symtab_and_line
>
3351 decode_line_with_current_source (const char *string
, int flags
)
3354 error (_("Empty line specification."));
3356 /* We use whatever is set as the current source line. We do not try
3357 and get a default source symtab+line or it will recursively call us! */
3358 symtab_and_line cursal
= get_current_source_symtab_and_line ();
3360 event_location_up location
= string_to_event_location (&string
,
3362 std::vector
<symtab_and_line
> sals
3363 = decode_line_1 (location
.get (), flags
, NULL
, cursal
.symtab
, cursal
.line
);
3366 error (_("Junk at end of line specification: %s"), string
);
3371 /* See linespec.h. */
3373 std::vector
<symtab_and_line
>
3374 decode_line_with_last_displayed (const char *string
, int flags
)
3377 error (_("Empty line specification."));
3379 event_location_up location
= string_to_event_location (&string
,
3381 std::vector
<symtab_and_line
> sals
3382 = (last_displayed_sal_is_valid ()
3383 ? decode_line_1 (location
.get (), flags
, NULL
,
3384 get_last_displayed_symtab (),
3385 get_last_displayed_line ())
3386 : decode_line_1 (location
.get (), flags
, NULL
,
3387 (struct symtab
*) NULL
, 0));
3390 error (_("Junk at end of line specification: %s"), string
);
3397 /* First, some functions to initialize stuff at the beggining of the
3401 initialize_defaults (struct symtab
**default_symtab
, int *default_line
)
3403 if (*default_symtab
== 0)
3405 /* Use whatever we have for the default source line. We don't use
3406 get_current_or_default_symtab_and_line as it can recurse and call
3408 struct symtab_and_line cursal
=
3409 get_current_source_symtab_and_line ();
3411 *default_symtab
= cursal
.symtab
;
3412 *default_line
= cursal
.line
;
3418 /* Evaluate the expression pointed to by EXP_PTR into a CORE_ADDR,
3419 advancing EXP_PTR past any parsed text. */
3422 linespec_expression_to_pc (const char **exp_ptr
)
3424 if (current_program_space
->executing_startup
)
3425 /* The error message doesn't really matter, because this case
3426 should only hit during breakpoint reset. */
3427 throw_error (NOT_FOUND_ERROR
, _("cannot evaluate expressions while "
3428 "program space is in startup"));
3431 return value_as_address (parse_to_comma_and_eval (exp_ptr
));
3436 /* Here's where we recognise an Objective-C Selector. An Objective C
3437 selector may be implemented by more than one class, therefore it
3438 may represent more than one method/function. This gives us a
3439 situation somewhat analogous to C++ overloading. If there's more
3440 than one method that could represent the selector, then use some of
3441 the existing C++ code to let the user choose one. */
3443 static std::vector
<symtab_and_line
>
3444 decode_objc (struct linespec_state
*self
, linespec_p ls
, const char *arg
)
3446 struct collect_info info
;
3447 std::vector
<const char *> symbol_names
;
3448 const char *new_argptr
;
3451 std::vector
<symtab
*> symtabs
;
3452 symtabs
.push_back (nullptr);
3454 info
.file_symtabs
= &symtabs
;
3455 info
.result
.symbols
= NULL
;
3456 info
.result
.minimal_symbols
= NULL
;
3458 new_argptr
= find_imps (arg
, &symbol_names
);
3459 if (symbol_names
.empty ())
3462 add_all_symbol_names_from_pspace (&info
, NULL
, symbol_names
,
3465 std::vector
<symtab_and_line
> values
;
3466 if (!VEC_empty (symbolp
, info
.result
.symbols
)
3467 || !VEC_empty (bound_minimal_symbol_d
, info
.result
.minimal_symbols
))
3471 saved_arg
= (char *) alloca (new_argptr
- arg
+ 1);
3472 memcpy (saved_arg
, arg
, new_argptr
- arg
);
3473 saved_arg
[new_argptr
- arg
] = '\0';
3475 ls
->explicit_loc
.function_name
= xstrdup (saved_arg
);
3476 ls
->function_symbols
= info
.result
.symbols
;
3477 ls
->minimal_symbols
= info
.result
.minimal_symbols
;
3478 values
= convert_linespec_to_sals (self
, ls
);
3480 if (self
->canonical
)
3485 self
->canonical
->pre_expanded
= 1;
3487 if (ls
->explicit_loc
.source_filename
)
3489 holder
= string_printf ("%s:%s",
3490 ls
->explicit_loc
.source_filename
,
3492 str
= holder
.c_str ();
3497 self
->canonical
->location
3498 = new_linespec_location (&str
, symbol_name_match_type::FULL
);
3507 /* A function object that serves as symbol_found_callback_ftype
3508 callback for iterate_over_symbols. This is used by
3509 lookup_prefix_sym to collect type symbols. */
3510 class decode_compound_collector
3513 decode_compound_collector ()
3516 m_unique_syms
= htab_create_alloc (1, htab_hash_pointer
,
3517 htab_eq_pointer
, NULL
,
3521 ~decode_compound_collector ()
3523 if (m_unique_syms
!= NULL
)
3524 htab_delete (m_unique_syms
);
3527 /* Releases ownership of the collected symbols and returns them. */
3528 VEC (symbolp
) *release_symbols ()
3530 VEC (symbolp
) *res
= m_symbols
;
3535 /* Callable as a symbol_found_callback_ftype callback. */
3536 bool operator () (symbol
*sym
);
3539 /* A hash table of all symbols we found. We use this to avoid
3540 adding any symbol more than once. */
3541 htab_t m_unique_syms
;
3543 /* The result vector. */
3544 VEC (symbolp
) *m_symbols
;
3548 decode_compound_collector::operator () (symbol
*sym
)
3553 if (SYMBOL_CLASS (sym
) != LOC_TYPEDEF
)
3554 return true; /* Continue iterating. */
3556 t
= SYMBOL_TYPE (sym
);
3557 t
= check_typedef (t
);
3558 if (TYPE_CODE (t
) != TYPE_CODE_STRUCT
3559 && TYPE_CODE (t
) != TYPE_CODE_UNION
3560 && TYPE_CODE (t
) != TYPE_CODE_NAMESPACE
)
3561 return true; /* Continue iterating. */
3563 slot
= htab_find_slot (m_unique_syms
, sym
, INSERT
);
3567 VEC_safe_push (symbolp
, m_symbols
, sym
);
3570 return true; /* Continue iterating. */
3575 /* Return any symbols corresponding to CLASS_NAME in FILE_SYMTABS. */
3577 static VEC (symbolp
) *
3578 lookup_prefix_sym (struct linespec_state
*state
,
3579 std::vector
<symtab
*> *file_symtabs
,
3580 const char *class_name
)
3582 decode_compound_collector collector
;
3584 lookup_name_info
lookup_name (class_name
, symbol_name_match_type::FULL
);
3586 for (const auto &elt
: *file_symtabs
)
3590 iterate_over_all_matching_symtabs (state
, lookup_name
,
3591 STRUCT_DOMAIN
, ALL_DOMAIN
,
3592 NULL
, false, collector
);
3593 iterate_over_all_matching_symtabs (state
, lookup_name
,
3594 VAR_DOMAIN
, ALL_DOMAIN
,
3595 NULL
, false, collector
);
3599 /* Program spaces that are executing startup should have
3600 been filtered out earlier. */
3601 gdb_assert (!SYMTAB_PSPACE (elt
)->executing_startup
);
3602 set_current_program_space (SYMTAB_PSPACE (elt
));
3603 iterate_over_file_blocks (elt
, lookup_name
, STRUCT_DOMAIN
, collector
);
3604 iterate_over_file_blocks (elt
, lookup_name
, VAR_DOMAIN
, collector
);
3608 return collector
.release_symbols ();
3611 /* A qsort comparison function for symbols. The resulting order does
3612 not actually matter; we just need to be able to sort them so that
3613 symbols with the same program space end up next to each other. */
3616 compare_symbols (const void *a
, const void *b
)
3618 struct symbol
* const *sa
= (struct symbol
* const*) a
;
3619 struct symbol
* const *sb
= (struct symbol
* const*) b
;
3622 uia
= (uintptr_t) SYMTAB_PSPACE (symbol_symtab (*sa
));
3623 uib
= (uintptr_t) SYMTAB_PSPACE (symbol_symtab (*sb
));
3630 uia
= (uintptr_t) *sa
;
3631 uib
= (uintptr_t) *sb
;
3641 /* Like compare_symbols but for minimal symbols. */
3644 compare_msymbols (const void *a
, const void *b
)
3646 const struct bound_minimal_symbol
*sa
3647 = (const struct bound_minimal_symbol
*) a
;
3648 const struct bound_minimal_symbol
*sb
3649 = (const struct bound_minimal_symbol
*) b
;
3652 uia
= (uintptr_t) sa
->objfile
->pspace
;
3653 uib
= (uintptr_t) sa
->objfile
->pspace
;
3660 uia
= (uintptr_t) sa
->minsym
;
3661 uib
= (uintptr_t) sb
->minsym
;
3671 /* Look for all the matching instances of each symbol in NAMES. Only
3672 instances from PSPACE are considered; other program spaces are
3673 handled by our caller. If PSPACE is NULL, then all program spaces
3674 are considered. Results are stored into INFO. */
3677 add_all_symbol_names_from_pspace (struct collect_info
*info
,
3678 struct program_space
*pspace
,
3679 const std::vector
<const char *> &names
,
3680 enum search_domain search_domain
)
3682 for (const char *iter
: names
)
3683 add_matching_symbols_to_info (iter
,
3684 symbol_name_match_type::FULL
,
3685 search_domain
, info
, pspace
);
3689 find_superclass_methods (std::vector
<struct type
*> &&superclasses
,
3690 const char *name
, enum language name_lang
,
3691 std::vector
<const char *> *result_names
)
3693 size_t old_len
= result_names
->size ();
3697 std::vector
<struct type
*> new_supers
;
3699 for (type
*t
: superclasses
)
3700 find_methods (t
, name_lang
, name
, result_names
, &new_supers
);
3702 if (result_names
->size () != old_len
|| new_supers
.empty ())
3705 superclasses
= std::move (new_supers
);
3709 /* This finds the method METHOD_NAME in the class CLASS_NAME whose type is
3710 given by one of the symbols in SYM_CLASSES. Matches are returned
3711 in SYMBOLS (for debug symbols) and MINSYMS (for minimal symbols). */
3714 find_method (struct linespec_state
*self
, std::vector
<symtab
*> *file_symtabs
,
3715 const char *class_name
, const char *method_name
,
3716 VEC (symbolp
) *sym_classes
, VEC (symbolp
) **symbols
,
3717 VEC (bound_minimal_symbol_d
) **minsyms
)
3721 size_t last_result_len
;
3722 std::vector
<struct type
*> superclass_vec
;
3723 std::vector
<const char *> result_names
;
3724 struct collect_info info
;
3726 /* Sort symbols so that symbols with the same program space are next
3728 qsort (VEC_address (symbolp
, sym_classes
),
3729 VEC_length (symbolp
, sym_classes
),
3734 info
.file_symtabs
= file_symtabs
;
3735 info
.result
.symbols
= NULL
;
3736 info
.result
.minimal_symbols
= NULL
;
3738 /* Iterate over all the types, looking for the names of existing
3739 methods matching METHOD_NAME. If we cannot find a direct method in a
3740 given program space, then we consider inherited methods; this is
3741 not ideal (ideal would be to respect C++ hiding rules), but it
3742 seems good enough and is what GDB has historically done. We only
3743 need to collect the names because later we find all symbols with
3744 those names. This loop is written in a somewhat funny way
3745 because we collect data across the program space before deciding
3747 last_result_len
= 0;
3748 for (ix
= 0; VEC_iterate (symbolp
, sym_classes
, ix
, sym
); ++ix
)
3751 struct program_space
*pspace
;
3753 /* Program spaces that are executing startup should have
3754 been filtered out earlier. */
3755 pspace
= SYMTAB_PSPACE (symbol_symtab (sym
));
3756 gdb_assert (!pspace
->executing_startup
);
3757 set_current_program_space (pspace
);
3758 t
= check_typedef (SYMBOL_TYPE (sym
));
3759 find_methods (t
, SYMBOL_LANGUAGE (sym
),
3760 method_name
, &result_names
, &superclass_vec
);
3762 /* Handle all items from a single program space at once; and be
3763 sure not to miss the last batch. */
3764 if (ix
== VEC_length (symbolp
, sym_classes
) - 1
3766 != SYMTAB_PSPACE (symbol_symtab (VEC_index (symbolp
, sym_classes
,
3769 /* If we did not find a direct implementation anywhere in
3770 this program space, consider superclasses. */
3771 if (result_names
.size () == last_result_len
)
3772 find_superclass_methods (std::move (superclass_vec
), method_name
,
3773 SYMBOL_LANGUAGE (sym
), &result_names
);
3775 /* We have a list of candidate symbol names, so now we
3776 iterate over the symbol tables looking for all
3777 matches in this pspace. */
3778 add_all_symbol_names_from_pspace (&info
, pspace
, result_names
,
3781 superclass_vec
.clear ();
3782 last_result_len
= result_names
.size ();
3786 if (!VEC_empty (symbolp
, info
.result
.symbols
)
3787 || !VEC_empty (bound_minimal_symbol_d
, info
.result
.minimal_symbols
))
3789 *symbols
= info
.result
.symbols
;
3790 *minsyms
= info
.result
.minimal_symbols
;
3794 /* Throw an NOT_FOUND_ERROR. This will be caught by the caller
3795 and other attempts to locate the symbol will be made. */
3796 throw_error (NOT_FOUND_ERROR
, _("see caller, this text doesn't matter"));
3803 /* This function object is a callback for iterate_over_symtabs, used
3804 when collecting all matching symtabs. */
3806 class symtab_collector
3810 : m_symtabs (new std::vector
<symtab
*> ())
3812 m_symtab_table
= htab_create (1, htab_hash_pointer
, htab_eq_pointer
,
3816 ~symtab_collector ()
3818 if (m_symtab_table
!= NULL
)
3819 htab_delete (m_symtab_table
);
3822 /* Callable as a symbol_found_callback_ftype callback. */
3823 bool operator () (symtab
*sym
);
3825 /* Releases ownership of the collected symtabs and returns them. */
3826 symtab_vector_up
release_symtabs ()
3828 return std::move (m_symtabs
);
3832 /* The result vector of symtabs. */
3833 symtab_vector_up m_symtabs
;
3835 /* This is used to ensure the symtabs are unique. */
3836 htab_t m_symtab_table
;
3840 symtab_collector::operator () (struct symtab
*symtab
)
3844 slot
= htab_find_slot (m_symtab_table
, symtab
, INSERT
);
3848 m_symtabs
->push_back (symtab
);
3856 /* Given a file name, return a list of all matching symtabs. If
3857 SEARCH_PSPACE is not NULL, the search is restricted to just that
3860 static symtab_vector_up
3861 collect_symtabs_from_filename (const char *file
,
3862 struct program_space
*search_pspace
)
3864 symtab_collector collector
;
3866 /* Find that file's data. */
3867 if (search_pspace
== NULL
)
3869 struct program_space
*pspace
;
3871 ALL_PSPACES (pspace
)
3873 if (pspace
->executing_startup
)
3876 set_current_program_space (pspace
);
3877 iterate_over_symtabs (file
, collector
);
3882 set_current_program_space (search_pspace
);
3883 iterate_over_symtabs (file
, collector
);
3886 return collector
.release_symtabs ();
3889 /* Return all the symtabs associated to the FILENAME. If SEARCH_PSPACE is
3890 not NULL, the search is restricted to just that program space. */
3892 static symtab_vector_up
3893 symtabs_from_filename (const char *filename
,
3894 struct program_space
*search_pspace
)
3896 symtab_vector_up result
3897 = collect_symtabs_from_filename (filename
, search_pspace
);
3899 if (result
->empty ())
3901 if (!have_full_symbols () && !have_partial_symbols ())
3902 throw_error (NOT_FOUND_ERROR
,
3903 _("No symbol table is loaded. "
3904 "Use the \"file\" command."));
3905 source_file_not_found_error (filename
);
3911 /* Look up a function symbol named NAME in symtabs FILE_SYMTABS. Matching
3912 debug symbols are returned in SYMBOLS. Matching minimal symbols are
3913 returned in MINSYMS. */
3916 find_function_symbols (struct linespec_state
*state
,
3917 std::vector
<symtab
*> *file_symtabs
, const char *name
,
3918 symbol_name_match_type name_match_type
,
3919 VEC (symbolp
) **symbols
,
3920 VEC (bound_minimal_symbol_d
) **minsyms
)
3922 struct collect_info info
;
3923 std::vector
<const char *> symbol_names
;
3926 info
.result
.symbols
= NULL
;
3927 info
.result
.minimal_symbols
= NULL
;
3928 info
.file_symtabs
= file_symtabs
;
3930 /* Try NAME as an Objective-C selector. */
3931 find_imps (name
, &symbol_names
);
3932 if (!symbol_names
.empty ())
3933 add_all_symbol_names_from_pspace (&info
, state
->search_pspace
,
3934 symbol_names
, FUNCTIONS_DOMAIN
);
3936 add_matching_symbols_to_info (name
, name_match_type
, FUNCTIONS_DOMAIN
,
3937 &info
, state
->search_pspace
);
3939 if (VEC_empty (symbolp
, info
.result
.symbols
))
3941 VEC_free (symbolp
, info
.result
.symbols
);
3945 *symbols
= info
.result
.symbols
;
3947 if (VEC_empty (bound_minimal_symbol_d
, info
.result
.minimal_symbols
))
3949 VEC_free (bound_minimal_symbol_d
, info
.result
.minimal_symbols
);
3953 *minsyms
= info
.result
.minimal_symbols
;
3956 /* Find all symbols named NAME in FILE_SYMTABS, returning debug symbols
3957 in SYMBOLS and minimal symbols in MINSYMS. */
3960 find_linespec_symbols (struct linespec_state
*state
,
3961 std::vector
<symtab
*> *file_symtabs
,
3962 const char *lookup_name
,
3963 symbol_name_match_type name_match_type
,
3964 VEC (symbolp
) **symbols
,
3965 VEC (bound_minimal_symbol_d
) **minsyms
)
3967 std::string canon
= cp_canonicalize_string_no_typedefs (lookup_name
);
3968 if (!canon
.empty ())
3969 lookup_name
= canon
.c_str ();
3971 /* It's important to not call expand_symtabs_matching unnecessarily
3972 as it can really slow things down (by unnecessarily expanding
3973 potentially 1000s of symtabs, which when debugging some apps can
3974 cost 100s of seconds). Avoid this to some extent by *first* calling
3975 find_function_symbols, and only if that doesn't find anything
3976 *then* call find_method. This handles two important cases:
3977 1) break (anonymous namespace)::foo
3978 2) break class::method where method is in class (and not a baseclass) */
3980 find_function_symbols (state
, file_symtabs
, lookup_name
,
3984 /* If we were unable to locate a symbol of the same name, try dividing
3985 the name into class and method names and searching the class and its
3987 if (VEC_empty (symbolp
, *symbols
)
3988 && VEC_empty (bound_minimal_symbol_d
, *minsyms
))
3990 std::string klass
, method
;
3991 const char *last
, *p
, *scope_op
;
3992 VEC (symbolp
) *classes
;
3994 /* See if we can find a scope operator and break this symbol
3995 name into namespaces${SCOPE_OPERATOR}class_name and method_name. */
3997 p
= find_toplevel_string (lookup_name
, scope_op
);
4003 p
= find_toplevel_string (p
+ strlen (scope_op
), scope_op
);
4006 /* If no scope operator was found, there is nothing more we can do;
4007 we already attempted to lookup the entire name as a symbol
4012 /* LOOKUP_NAME points to the class name.
4013 LAST points to the method name. */
4014 klass
= std::string (lookup_name
, last
- lookup_name
);
4016 /* Skip past the scope operator. */
4017 last
+= strlen (scope_op
);
4020 /* Find a list of classes named KLASS. */
4021 classes
= lookup_prefix_sym (state
, file_symtabs
, klass
.c_str ());
4022 struct cleanup
*old_chain
4023 = make_cleanup (VEC_cleanup (symbolp
), &classes
);
4025 if (!VEC_empty (symbolp
, classes
))
4027 /* Now locate a list of suitable methods named METHOD. */
4030 find_method (state
, file_symtabs
,
4031 klass
.c_str (), method
.c_str (),
4032 classes
, symbols
, minsyms
);
4035 /* If successful, we're done. If NOT_FOUND_ERROR
4036 was not thrown, rethrow the exception that we did get. */
4037 CATCH (except
, RETURN_MASK_ERROR
)
4039 if (except
.error
!= NOT_FOUND_ERROR
)
4040 throw_exception (except
);
4045 do_cleanups (old_chain
);
4049 /* Helper for find_label_symbols. Find all labels that match name
4050 NAME in BLOCK. Return all labels that match in FUNCTION_SYMBOLS.
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 a label named
4054 exactly NAME match. */
4057 find_label_symbols_in_block (const struct block
*block
,
4058 const char *name
, struct symbol
*fn_sym
,
4059 bool completion_mode
,
4060 VEC (symbolp
) **result
,
4061 VEC (symbolp
) **label_funcs_ret
)
4063 if (completion_mode
)
4065 struct block_iterator iter
;
4067 size_t name_len
= strlen (name
);
4069 int (*cmp
) (const char *, const char *, size_t);
4070 cmp
= case_sensitivity
== case_sensitive_on
? strncmp
: strncasecmp
;
4072 ALL_BLOCK_SYMBOLS (block
, iter
, sym
)
4074 if (symbol_matches_domain (SYMBOL_LANGUAGE (sym
),
4075 SYMBOL_DOMAIN (sym
), LABEL_DOMAIN
)
4076 && cmp (SYMBOL_SEARCH_NAME (sym
), name
, name_len
) == 0)
4078 VEC_safe_push (symbolp
, *result
, sym
);
4079 VEC_safe_push (symbolp
, *label_funcs_ret
, fn_sym
);
4085 struct symbol
*sym
= lookup_symbol (name
, block
, LABEL_DOMAIN
, 0).symbol
;
4089 VEC_safe_push (symbolp
, *result
, sym
);
4090 VEC_safe_push (symbolp
, *label_funcs_ret
, fn_sym
);
4095 /* Return all labels that match name NAME in FUNCTION_SYMBOLS. Return
4096 the actual function symbol in which the label was found in
4097 LABEL_FUNC_RET. If COMPLETION_MODE is true, then NAME is
4098 interpreted as a label name prefix. Otherwise, only labels named
4099 exactly NAME match. */
4101 static VEC (symbolp
) *
4102 find_label_symbols (struct linespec_state
*self
,
4103 VEC (symbolp
) *function_symbols
,
4104 VEC (symbolp
) **label_funcs_ret
, const char *name
,
4105 bool completion_mode
)
4108 const struct block
*block
;
4109 struct symbol
*fn_sym
;
4110 VEC (symbolp
) *result
= NULL
;
4112 if (function_symbols
== NULL
)
4114 set_current_program_space (self
->program_space
);
4115 block
= get_current_search_block ();
4118 block
&& !BLOCK_FUNCTION (block
);
4119 block
= BLOCK_SUPERBLOCK (block
))
4123 fn_sym
= BLOCK_FUNCTION (block
);
4125 find_label_symbols_in_block (block
, name
, fn_sym
, completion_mode
,
4126 &result
, label_funcs_ret
);
4131 VEC_iterate (symbolp
, function_symbols
, ix
, fn_sym
); ++ix
)
4133 set_current_program_space (SYMTAB_PSPACE (symbol_symtab (fn_sym
)));
4134 block
= SYMBOL_BLOCK_VALUE (fn_sym
);
4136 find_label_symbols_in_block (block
, name
, fn_sym
, completion_mode
,
4137 &result
, label_funcs_ret
);
4146 /* A helper for create_sals_line_offset that handles the 'list_mode' case. */
4148 static std::vector
<symtab_and_line
>
4149 decode_digits_list_mode (struct linespec_state
*self
,
4151 struct symtab_and_line val
)
4153 gdb_assert (self
->list_mode
);
4155 std::vector
<symtab_and_line
> values
;
4157 for (const auto &elt
: *ls
->file_symtabs
)
4159 /* The logic above should ensure this. */
4160 gdb_assert (elt
!= NULL
);
4162 set_current_program_space (SYMTAB_PSPACE (elt
));
4164 /* Simplistic search just for the list command. */
4165 val
.symtab
= find_line_symtab (elt
, val
.line
, NULL
, NULL
);
4166 if (val
.symtab
== NULL
)
4168 val
.pspace
= SYMTAB_PSPACE (elt
);
4170 val
.explicit_line
= 1;
4172 add_sal_to_sals (self
, &values
, &val
, NULL
, 0);
4178 /* A helper for create_sals_line_offset that iterates over the symtabs,
4179 adding lines to the VEC. */
4181 static std::vector
<symtab_and_line
>
4182 decode_digits_ordinary (struct linespec_state
*self
,
4185 struct linetable_entry
**best_entry
)
4187 std::vector
<symtab_and_line
> sals
;
4188 for (const auto &elt
: *ls
->file_symtabs
)
4190 std::vector
<CORE_ADDR
> pcs
;
4192 /* The logic above should ensure this. */
4193 gdb_assert (elt
!= NULL
);
4195 set_current_program_space (SYMTAB_PSPACE (elt
));
4197 pcs
= find_pcs_for_symtab_line (elt
, line
, best_entry
);
4198 for (CORE_ADDR pc
: pcs
)
4200 symtab_and_line sal
;
4201 sal
.pspace
= SYMTAB_PSPACE (elt
);
4205 sals
.push_back (std::move (sal
));
4214 /* Return the line offset represented by VARIABLE. */
4216 static struct line_offset
4217 linespec_parse_variable (struct linespec_state
*self
, const char *variable
)
4221 struct line_offset offset
= {0, LINE_OFFSET_NONE
};
4223 p
= (variable
[1] == '$') ? variable
+ 2 : variable
+ 1;
4226 while (*p
>= '0' && *p
<= '9')
4228 if (!*p
) /* Reached end of token without hitting non-digit. */
4230 /* We have a value history reference. */
4231 struct value
*val_history
;
4233 sscanf ((variable
[1] == '$') ? variable
+ 2 : variable
+ 1, "%d", &index
);
4235 = access_value_history ((variable
[1] == '$') ? -index
: index
);
4236 if (TYPE_CODE (value_type (val_history
)) != TYPE_CODE_INT
)
4237 error (_("History values used in line "
4238 "specs must have integer values."));
4239 offset
.offset
= value_as_long (val_history
);
4243 /* Not all digits -- may be user variable/function or a
4244 convenience variable. */
4246 struct internalvar
*ivar
;
4248 /* Try it as a convenience variable. If it is not a convenience
4249 variable, return and allow normal symbol lookup to occur. */
4250 ivar
= lookup_only_internalvar (variable
+ 1);
4252 /* No internal variable with that name. Mark the offset
4253 as unknown to allow the name to be looked up as a symbol. */
4254 offset
.sign
= LINE_OFFSET_UNKNOWN
;
4257 /* We found a valid variable name. If it is not an integer,
4259 if (!get_internalvar_integer (ivar
, &valx
))
4260 error (_("Convenience variables used in line "
4261 "specs must have integer values."));
4263 offset
.offset
= valx
;
4271 /* We've found a minimal symbol MSYMBOL in OBJFILE to associate with our
4272 linespec; return the SAL in RESULT. This function should return SALs
4273 matching those from find_function_start_sal, otherwise false
4274 multiple-locations breakpoints could be placed. */
4277 minsym_found (struct linespec_state
*self
, struct objfile
*objfile
,
4278 struct minimal_symbol
*msymbol
,
4279 std::vector
<symtab_and_line
> *result
)
4281 bool want_start_sal
;
4283 CORE_ADDR func_addr
;
4284 bool is_function
= msymbol_is_function (objfile
, msymbol
, &func_addr
);
4288 const char *msym_name
= MSYMBOL_LINKAGE_NAME (msymbol
);
4290 if (MSYMBOL_TYPE (msymbol
) == mst_text_gnu_ifunc
4291 || MSYMBOL_TYPE (msymbol
) == mst_data_gnu_ifunc
)
4292 want_start_sal
= gnu_ifunc_resolve_name (msym_name
, &func_addr
);
4294 want_start_sal
= true;
4297 symtab_and_line sal
;
4299 if (is_function
&& want_start_sal
)
4300 sal
= find_function_start_sal (func_addr
, NULL
, self
->funfirstline
);
4303 sal
.objfile
= objfile
;
4304 sal
.msymbol
= msymbol
;
4305 /* Store func_addr, not the minsym's address in case this was an
4306 ifunc that hasn't been resolved yet. */
4310 sal
.pc
= MSYMBOL_VALUE_ADDRESS (objfile
, msymbol
);
4311 sal
.pspace
= current_program_space
;
4314 sal
.section
= MSYMBOL_OBJ_SECTION (objfile
, msymbol
);
4316 if (maybe_add_address (self
->addr_set
, objfile
->pspace
, sal
.pc
))
4317 add_sal_to_sals (self
, result
, &sal
, MSYMBOL_NATURAL_NAME (msymbol
), 0);
4320 /* A helper function to classify a minimal_symbol_type according to
4324 classify_mtype (enum minimal_symbol_type t
)
4331 /* Intermediate priority. */
4334 case mst_solib_trampoline
:
4335 /* Lowest priority. */
4339 /* Highest priority. */
4344 /* Callback for std::sort that sorts symbols by priority. */
4347 compare_msyms (const bound_minimal_symbol
&a
, const bound_minimal_symbol
&b
)
4349 enum minimal_symbol_type ta
= MSYMBOL_TYPE (a
.minsym
);
4350 enum minimal_symbol_type tb
= MSYMBOL_TYPE (b
.minsym
);
4352 return classify_mtype (ta
) < classify_mtype (tb
);
4355 /* Helper for search_minsyms_for_name that adds the symbol to the
4359 add_minsym (struct minimal_symbol
*minsym
, struct objfile
*objfile
,
4360 struct symtab
*symtab
, int list_mode
,
4361 std::vector
<struct bound_minimal_symbol
> *msyms
)
4365 /* We're looking for a label for which we don't have debug
4367 CORE_ADDR func_addr
;
4368 if (msymbol_is_function (objfile
, minsym
, &func_addr
))
4370 symtab_and_line sal
= find_pc_sect_line (func_addr
, NULL
, 0);
4372 if (symtab
!= sal
.symtab
)
4377 /* Exclude data symbols when looking for breakpoint locations. */
4378 if (!list_mode
&& !msymbol_is_function (objfile
, minsym
))
4381 struct bound_minimal_symbol mo
= {minsym
, objfile
};
4382 msyms
->push_back (mo
);
4386 /* Search for minimal symbols called NAME. If SEARCH_PSPACE
4387 is not NULL, the search is restricted to just that program
4390 If SYMTAB is NULL, search all objfiles, otherwise
4391 restrict results to the given SYMTAB. */
4394 search_minsyms_for_name (struct collect_info
*info
,
4395 const lookup_name_info
&name
,
4396 struct program_space
*search_pspace
,
4397 struct symtab
*symtab
)
4399 std::vector
<struct bound_minimal_symbol
> minsyms
;
4403 struct program_space
*pspace
;
4405 ALL_PSPACES (pspace
)
4407 struct objfile
*objfile
;
4409 if (search_pspace
!= NULL
&& search_pspace
!= pspace
)
4411 if (pspace
->executing_startup
)
4414 set_current_program_space (pspace
);
4416 ALL_OBJFILES (objfile
)
4418 iterate_over_minimal_symbols (objfile
, name
,
4419 [&] (struct minimal_symbol
*msym
)
4421 add_minsym (msym
, objfile
, nullptr,
4422 info
->state
->list_mode
,
4431 if (search_pspace
== NULL
|| SYMTAB_PSPACE (symtab
) == search_pspace
)
4433 set_current_program_space (SYMTAB_PSPACE (symtab
));
4434 iterate_over_minimal_symbols
4435 (SYMTAB_OBJFILE (symtab
), name
,
4436 [&] (struct minimal_symbol
*msym
)
4438 add_minsym (msym
, SYMTAB_OBJFILE (symtab
), symtab
,
4439 info
->state
->list_mode
, &minsyms
);
4445 if (!minsyms
.empty ())
4449 std::sort (minsyms
.begin (), minsyms
.end (), compare_msyms
);
4451 /* Now the minsyms are in classification order. So, we walk
4452 over them and process just the minsyms with the same
4453 classification as the very first minsym in the list. */
4454 classification
= classify_mtype (MSYMBOL_TYPE (minsyms
[0].minsym
));
4456 for (const bound_minimal_symbol
&item
: minsyms
)
4458 if (classify_mtype (MSYMBOL_TYPE (item
.minsym
)) != classification
)
4461 VEC_safe_push (bound_minimal_symbol_d
,
4462 info
->result
.minimal_symbols
, &item
);
4467 /* A helper function to add all symbols matching NAME to INFO. If
4468 PSPACE is not NULL, the search is restricted to just that program
4472 add_matching_symbols_to_info (const char *name
,
4473 symbol_name_match_type name_match_type
,
4474 enum search_domain search_domain
,
4475 struct collect_info
*info
,
4476 struct program_space
*pspace
)
4478 lookup_name_info
lookup_name (name
, name_match_type
);
4480 for (const auto &elt
: *info
->file_symtabs
)
4484 iterate_over_all_matching_symtabs (info
->state
, lookup_name
,
4485 VAR_DOMAIN
, search_domain
,
4486 pspace
, true, [&] (symbol
*sym
)
4487 { return info
->add_symbol (sym
); });
4488 search_minsyms_for_name (info
, lookup_name
, pspace
, NULL
);
4490 else if (pspace
== NULL
|| pspace
== SYMTAB_PSPACE (elt
))
4492 int prev_len
= VEC_length (symbolp
, info
->result
.symbols
);
4494 /* Program spaces that are executing startup should have
4495 been filtered out earlier. */
4496 gdb_assert (!SYMTAB_PSPACE (elt
)->executing_startup
);
4497 set_current_program_space (SYMTAB_PSPACE (elt
));
4498 iterate_over_file_blocks (elt
, lookup_name
, VAR_DOMAIN
,
4500 { return info
->add_symbol (sym
); });
4502 /* If no new symbols were found in this iteration and this symtab
4503 is in assembler, we might actually be looking for a label for
4504 which we don't have debug info. Check for a minimal symbol in
4506 if (prev_len
== VEC_length (symbolp
, info
->result
.symbols
)
4507 && elt
->language
== language_asm
)
4508 search_minsyms_for_name (info
, lookup_name
, pspace
, elt
);
4515 /* Now come some functions that are called from multiple places within
4519 symbol_to_sal (struct symtab_and_line
*result
,
4520 int funfirstline
, struct symbol
*sym
)
4522 if (SYMBOL_CLASS (sym
) == LOC_BLOCK
)
4524 *result
= find_function_start_sal (sym
, funfirstline
);
4529 if (SYMBOL_CLASS (sym
) == LOC_LABEL
&& SYMBOL_VALUE_ADDRESS (sym
) != 0)
4532 result
->symtab
= symbol_symtab (sym
);
4533 result
->symbol
= sym
;
4534 result
->line
= SYMBOL_LINE (sym
);
4535 result
->pc
= SYMBOL_VALUE_ADDRESS (sym
);
4536 result
->pspace
= SYMTAB_PSPACE (result
->symtab
);
4537 result
->explicit_pc
= 1;
4540 else if (funfirstline
)
4544 else if (SYMBOL_LINE (sym
) != 0)
4546 /* We know its line number. */
4548 result
->symtab
= symbol_symtab (sym
);
4549 result
->symbol
= sym
;
4550 result
->line
= SYMBOL_LINE (sym
);
4551 result
->pc
= SYMBOL_VALUE_ADDRESS (sym
);
4552 result
->pspace
= SYMTAB_PSPACE (result
->symtab
);
4560 linespec_result::~linespec_result ()
4562 for (linespec_sals
&lsal
: lsals
)
4563 xfree (lsal
.canonical
);
4566 /* Return the quote characters permitted by the linespec parser. */
4569 get_gdb_linespec_parser_quote_characters (void)
4571 return linespec_quote_characters
;