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 (or empty) if no matching symbols were found. */
118 std::vector
<symbol
*> *function_symbols
;
119 std::vector
<bound_minimal_symbol
> *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 std::vector
<symbol
*> *label_symbols
;
127 std::vector
<symbol
*> *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 std::vector
<symbol
*> *symbols
;
205 std::vector
<bound_minimal_symbol
> *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 this->result
.symbols
->push_back (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 std::vector
<symbol
*> *find_label_symbols
356 (struct linespec_state
*self
, std::vector
<symbol
*> *function_symbols
,
357 std::vector
<symbol
*> *label_funcs_ret
, const char *name
,
358 bool completion_mode
= false);
360 static void find_linespec_symbols (struct linespec_state
*self
,
361 std::vector
<symtab
*> *file_symtabs
,
363 symbol_name_match_type name_match_type
,
364 std::vector
<symbol
*> *symbols
,
365 std::vector
<bound_minimal_symbol
> *minsyms
);
367 static struct line_offset
368 linespec_parse_variable (struct linespec_state
*self
,
369 const char *variable
);
371 static int symbol_to_sal (struct symtab_and_line
*result
,
372 int funfirstline
, struct symbol
*sym
);
374 static void add_matching_symbols_to_info (const char *name
,
375 symbol_name_match_type name_match_type
,
376 enum search_domain search_domain
,
377 struct collect_info
*info
,
378 struct program_space
*pspace
);
380 static void add_all_symbol_names_from_pspace
381 (struct collect_info
*info
, struct program_space
*pspace
,
382 const std::vector
<const char *> &names
, enum search_domain search_domain
);
384 static symtab_vector_up
385 collect_symtabs_from_filename (const char *file
,
386 struct program_space
*pspace
);
388 static std::vector
<symtab_and_line
> decode_digits_ordinary
389 (struct linespec_state
*self
,
392 linetable_entry
**best_entry
);
394 static std::vector
<symtab_and_line
> decode_digits_list_mode
395 (struct linespec_state
*self
,
397 struct symtab_and_line val
);
399 static void minsym_found (struct linespec_state
*self
, struct objfile
*objfile
,
400 struct minimal_symbol
*msymbol
,
401 std::vector
<symtab_and_line
> *result
);
403 static int compare_symbols (const void *a
, const void *b
);
404 static bool std_compare_symbols (const struct symbol
*a
,
405 const struct symbol
*b
);
407 static bool compare_msymbols (const bound_minimal_symbol
&a
,
408 const bound_minimal_symbol
&b
);
410 /* Permitted quote characters for the parser. This is different from the
411 completer's quote characters to allow backward compatibility with the
413 static const char *const linespec_quote_characters
= "\"\'";
415 /* Lexer functions. */
417 /* Lex a number from the input in PARSER. This only supports
420 Return true if input is decimal numbers. Return false if not. */
423 linespec_lexer_lex_number (linespec_parser
*parser
, linespec_token
*tokenp
)
425 tokenp
->type
= LSTOKEN_NUMBER
;
426 LS_TOKEN_STOKEN (*tokenp
).length
= 0;
427 LS_TOKEN_STOKEN (*tokenp
).ptr
= PARSER_STREAM (parser
);
429 /* Keep any sign at the start of the stream. */
430 if (*PARSER_STREAM (parser
) == '+' || *PARSER_STREAM (parser
) == '-')
432 ++LS_TOKEN_STOKEN (*tokenp
).length
;
433 ++(PARSER_STREAM (parser
));
436 while (isdigit (*PARSER_STREAM (parser
)))
438 ++LS_TOKEN_STOKEN (*tokenp
).length
;
439 ++(PARSER_STREAM (parser
));
442 /* If the next character in the input buffer is not a space, comma,
443 quote, or colon, this input does not represent a number. */
444 if (*PARSER_STREAM (parser
) != '\0'
445 && !isspace (*PARSER_STREAM (parser
)) && *PARSER_STREAM (parser
) != ','
446 && *PARSER_STREAM (parser
) != ':'
447 && !strchr (linespec_quote_characters
, *PARSER_STREAM (parser
)))
449 PARSER_STREAM (parser
) = LS_TOKEN_STOKEN (*tokenp
).ptr
;
456 /* See linespec.h. */
459 linespec_lexer_lex_keyword (const char *p
)
465 for (i
= 0; linespec_keywords
[i
] != NULL
; ++i
)
467 int len
= strlen (linespec_keywords
[i
]);
469 /* If P begins with one of the keywords and the next
470 character is whitespace, we may have found a keyword.
471 It is only a keyword if it is not followed by another
473 if (strncmp (p
, linespec_keywords
[i
], len
) == 0
478 /* Special case: "if" ALWAYS stops the lexer, since it
479 is not possible to predict what is going to appear in
480 the condition, which can only be parsed after SaLs have
482 if (i
!= IF_KEYWORD_INDEX
)
486 for (j
= 0; linespec_keywords
[j
] != NULL
; ++j
)
488 int nextlen
= strlen (linespec_keywords
[j
]);
490 if (strncmp (p
, linespec_keywords
[j
], nextlen
) == 0
491 && isspace (p
[nextlen
]))
496 return linespec_keywords
[i
];
504 /* See description in linespec.h. */
507 is_ada_operator (const char *string
)
509 const struct ada_opname_map
*mapping
;
511 for (mapping
= ada_opname_table
;
512 mapping
->encoded
!= NULL
513 && !startswith (string
, mapping
->decoded
); ++mapping
)
516 return mapping
->decoded
== NULL
? 0 : strlen (mapping
->decoded
);
519 /* Find QUOTE_CHAR in STRING, accounting for the ':' terminal. Return
520 the location of QUOTE_CHAR, or NULL if not found. */
523 skip_quote_char (const char *string
, char quote_char
)
525 const char *p
, *last
;
527 p
= last
= find_toplevel_char (string
, quote_char
);
528 while (p
&& *p
!= '\0' && *p
!= ':')
530 p
= find_toplevel_char (p
, quote_char
);
538 /* Make a writable copy of the string given in TOKEN, trimming
539 any trailing whitespace. */
541 static gdb::unique_xmalloc_ptr
<char>
542 copy_token_string (linespec_token token
)
546 if (token
.type
== LSTOKEN_KEYWORD
)
547 return gdb::unique_xmalloc_ptr
<char> (xstrdup (LS_TOKEN_KEYWORD (token
)));
549 str
= LS_TOKEN_STOKEN (token
).ptr
;
550 s
= remove_trailing_whitespace (str
, str
+ LS_TOKEN_STOKEN (token
).length
);
552 return gdb::unique_xmalloc_ptr
<char> (savestring (str
, s
- str
));
555 /* Does P represent the end of a quote-enclosed linespec? */
558 is_closing_quote_enclosed (const char *p
)
560 if (strchr (linespec_quote_characters
, *p
))
562 p
= skip_spaces ((char *) p
);
563 return (*p
== '\0' || linespec_lexer_lex_keyword (p
));
566 /* Find the end of the parameter list that starts with *INPUT.
567 This helper function assists with lexing string segments
568 which might contain valid (non-terminating) commas. */
571 find_parameter_list_end (const char *input
)
573 char end_char
, start_char
;
578 if (start_char
== '(')
580 else if (start_char
== '<')
589 if (*p
== start_char
)
591 else if (*p
== end_char
)
605 /* If the [STRING, STRING_LEN) string ends with what looks like a
606 keyword, return the keyword start offset in STRING. Return -1
610 string_find_incomplete_keyword_at_end (const char * const *keywords
,
611 const char *string
, size_t string_len
)
613 const char *end
= string
+ string_len
;
616 while (p
> string
&& *p
!= ' ')
621 size_t len
= end
- p
;
622 for (size_t i
= 0; keywords
[i
] != NULL
; ++i
)
623 if (strncmp (keywords
[i
], p
, len
) == 0)
630 /* Lex a string from the input in PARSER. */
632 static linespec_token
633 linespec_lexer_lex_string (linespec_parser
*parser
)
635 linespec_token token
;
636 const char *start
= PARSER_STREAM (parser
);
638 token
.type
= LSTOKEN_STRING
;
640 /* If the input stream starts with a quote character, skip to the next
641 quote character, regardless of the content. */
642 if (strchr (linespec_quote_characters
, *PARSER_STREAM (parser
)))
645 char quote_char
= *PARSER_STREAM (parser
);
647 /* Special case: Ada operators. */
648 if (PARSER_STATE (parser
)->language
->la_language
== language_ada
649 && quote_char
== '\"')
651 int len
= is_ada_operator (PARSER_STREAM (parser
));
655 /* The input is an Ada operator. Return the quoted string
657 LS_TOKEN_STOKEN (token
).ptr
= PARSER_STREAM (parser
);
658 LS_TOKEN_STOKEN (token
).length
= len
;
659 PARSER_STREAM (parser
) += len
;
663 /* The input does not represent an Ada operator -- fall through
664 to normal quoted string handling. */
667 /* Skip past the beginning quote. */
668 ++(PARSER_STREAM (parser
));
670 /* Mark the start of the string. */
671 LS_TOKEN_STOKEN (token
).ptr
= PARSER_STREAM (parser
);
673 /* Skip to the ending quote. */
674 end
= skip_quote_char (PARSER_STREAM (parser
), quote_char
);
676 /* This helps the completer mode decide whether we have a
678 parser
->completion_quote_char
= quote_char
;
679 parser
->completion_quote_end
= end
;
681 /* Error if the input did not terminate properly, unless in
685 if (parser
->completion_tracker
== NULL
)
686 error (_("unmatched quote"));
688 /* In completion mode, we'll try to complete the incomplete
690 token
.type
= LSTOKEN_STRING
;
691 while (*PARSER_STREAM (parser
) != '\0')
692 PARSER_STREAM (parser
)++;
693 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - 1 - start
;
697 /* Skip over the ending quote and mark the length of the string. */
698 PARSER_STREAM (parser
) = (char *) ++end
;
699 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - 2 - start
;
706 /* Otherwise, only identifier characters are permitted.
707 Spaces are the exception. In general, we keep spaces,
708 but only if the next characters in the input do not resolve
709 to one of the keywords.
711 This allows users to forgo quoting CV-qualifiers, template arguments,
712 and similar common language constructs. */
716 if (isspace (*PARSER_STREAM (parser
)))
718 p
= skip_spaces (PARSER_STREAM (parser
));
719 /* When we get here we know we've found something followed by
720 a space (we skip over parens and templates below).
721 So if we find a keyword now, we know it is a keyword and not,
722 say, a function name. */
723 if (linespec_lexer_lex_keyword (p
) != NULL
)
725 LS_TOKEN_STOKEN (token
).ptr
= start
;
726 LS_TOKEN_STOKEN (token
).length
727 = PARSER_STREAM (parser
) - start
;
731 /* Advance past the whitespace. */
732 PARSER_STREAM (parser
) = p
;
735 /* If the next character is EOI or (single) ':', the
736 string is complete; return the token. */
737 if (*PARSER_STREAM (parser
) == 0)
739 LS_TOKEN_STOKEN (token
).ptr
= start
;
740 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - start
;
743 else if (PARSER_STREAM (parser
)[0] == ':')
745 /* Do not tokenize the C++ scope operator. */
746 if (PARSER_STREAM (parser
)[1] == ':')
747 ++(PARSER_STREAM (parser
));
749 /* Do not tokenize ABI tags such as "[abi:cxx11]". */
750 else if (PARSER_STREAM (parser
) - start
> 4
751 && startswith (PARSER_STREAM (parser
) - 4, "[abi"))
752 ++(PARSER_STREAM (parser
));
754 /* Do not tokenify if the input length so far is one
755 (i.e, a single-letter drive name) and the next character
756 is a directory separator. This allows Windows-style
757 paths to be recognized as filenames without quoting it. */
758 else if ((PARSER_STREAM (parser
) - start
) != 1
759 || !IS_DIR_SEPARATOR (PARSER_STREAM (parser
)[1]))
761 LS_TOKEN_STOKEN (token
).ptr
= start
;
762 LS_TOKEN_STOKEN (token
).length
763 = PARSER_STREAM (parser
) - start
;
767 /* Special case: permit quote-enclosed linespecs. */
768 else if (parser
->is_quote_enclosed
769 && strchr (linespec_quote_characters
,
770 *PARSER_STREAM (parser
))
771 && is_closing_quote_enclosed (PARSER_STREAM (parser
)))
773 LS_TOKEN_STOKEN (token
).ptr
= start
;
774 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - start
;
777 /* Because commas may terminate a linespec and appear in
778 the middle of valid string input, special cases for
779 '<' and '(' are necessary. */
780 else if (*PARSER_STREAM (parser
) == '<'
781 || *PARSER_STREAM (parser
) == '(')
783 /* Don't interpret 'operator<' / 'operator<<' as a
784 template parameter list though. */
785 if (*PARSER_STREAM (parser
) == '<'
786 && (PARSER_STATE (parser
)->language
->la_language
788 && (PARSER_STREAM (parser
) - start
) >= CP_OPERATOR_LEN
)
790 const char *p
= PARSER_STREAM (parser
);
792 while (p
> start
&& isspace (p
[-1]))
794 if (p
- start
>= CP_OPERATOR_LEN
)
796 p
-= CP_OPERATOR_LEN
;
797 if (strncmp (p
, CP_OPERATOR_STR
, CP_OPERATOR_LEN
) == 0
799 || !(isalnum (p
[-1]) || p
[-1] == '_')))
801 /* This is an operator name. Keep going. */
802 ++(PARSER_STREAM (parser
));
803 if (*PARSER_STREAM (parser
) == '<')
804 ++(PARSER_STREAM (parser
));
810 const char *p
= find_parameter_list_end (PARSER_STREAM (parser
));
811 PARSER_STREAM (parser
) = p
;
813 /* Don't loop around to the normal \0 case above because
814 we don't want to misinterpret a potential keyword at
815 the end of the token when the string isn't
816 "()<>"-balanced. This handles "b
817 function(thread<tab>" in completion mode. */
820 LS_TOKEN_STOKEN (token
).ptr
= start
;
821 LS_TOKEN_STOKEN (token
).length
822 = PARSER_STREAM (parser
) - start
;
828 /* Commas are terminators, but not if they are part of an
830 else if (*PARSER_STREAM (parser
) == ',')
832 if ((PARSER_STATE (parser
)->language
->la_language
834 && (PARSER_STREAM (parser
) - start
) > CP_OPERATOR_LEN
)
836 const char *p
= strstr (start
, CP_OPERATOR_STR
);
838 if (p
!= NULL
&& is_operator_name (p
))
840 /* This is an operator name. Keep going. */
841 ++(PARSER_STREAM (parser
));
846 /* Comma terminates the string. */
847 LS_TOKEN_STOKEN (token
).ptr
= start
;
848 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - start
;
852 /* Advance the stream. */
853 ++(PARSER_STREAM (parser
));
860 /* Lex a single linespec token from PARSER. */
862 static linespec_token
863 linespec_lexer_lex_one (linespec_parser
*parser
)
867 if (parser
->lexer
.current
.type
== LSTOKEN_CONSUMED
)
869 /* Skip any whitespace. */
870 PARSER_STREAM (parser
) = skip_spaces (PARSER_STREAM (parser
));
872 /* Check for a keyword, they end the linespec. */
873 keyword
= linespec_lexer_lex_keyword (PARSER_STREAM (parser
));
876 parser
->lexer
.current
.type
= LSTOKEN_KEYWORD
;
877 LS_TOKEN_KEYWORD (parser
->lexer
.current
) = keyword
;
878 /* We do not advance the stream here intentionally:
879 we would like lexing to stop when a keyword is seen.
881 PARSER_STREAM (parser) += strlen (keyword); */
883 return parser
->lexer
.current
;
886 /* Handle other tokens. */
887 switch (*PARSER_STREAM (parser
))
890 parser
->lexer
.current
.type
= LSTOKEN_EOI
;
894 case '0': case '1': case '2': case '3': case '4':
895 case '5': case '6': case '7': case '8': case '9':
896 if (!linespec_lexer_lex_number (parser
, &(parser
->lexer
.current
)))
897 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
901 /* If we have a scope operator, lex the input as a string.
902 Otherwise, return LSTOKEN_COLON. */
903 if (PARSER_STREAM (parser
)[1] == ':')
904 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
907 parser
->lexer
.current
.type
= LSTOKEN_COLON
;
908 ++(PARSER_STREAM (parser
));
912 case '\'': case '\"':
913 /* Special case: permit quote-enclosed linespecs. */
914 if (parser
->is_quote_enclosed
915 && is_closing_quote_enclosed (PARSER_STREAM (parser
)))
917 ++(PARSER_STREAM (parser
));
918 parser
->lexer
.current
.type
= LSTOKEN_EOI
;
921 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
925 parser
->lexer
.current
.type
= LSTOKEN_COMMA
;
926 LS_TOKEN_STOKEN (parser
->lexer
.current
).ptr
927 = PARSER_STREAM (parser
);
928 LS_TOKEN_STOKEN (parser
->lexer
.current
).length
= 1;
929 ++(PARSER_STREAM (parser
));
933 /* If the input is not a number, it must be a string.
934 [Keywords were already considered above.] */
935 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
940 return parser
->lexer
.current
;
943 /* Consume the current token and return the next token in PARSER's
944 input stream. Also advance the completion word for completion
947 static linespec_token
948 linespec_lexer_consume_token (linespec_parser
*parser
)
950 gdb_assert (parser
->lexer
.current
.type
!= LSTOKEN_EOI
);
952 bool advance_word
= (parser
->lexer
.current
.type
!= LSTOKEN_STRING
953 || *PARSER_STREAM (parser
) != '\0');
955 /* If we're moving past a string to some other token, it must be the
956 quote was terminated. */
957 if (parser
->completion_quote_char
)
959 gdb_assert (parser
->lexer
.current
.type
== LSTOKEN_STRING
);
961 /* If the string was the last (non-EOI) token, we're past the
962 quote, but remember that for later. */
963 if (*PARSER_STREAM (parser
) != '\0')
965 parser
->completion_quote_char
= '\0';
966 parser
->completion_quote_end
= NULL
;;
970 parser
->lexer
.current
.type
= LSTOKEN_CONSUMED
;
971 linespec_lexer_lex_one (parser
);
973 if (parser
->lexer
.current
.type
== LSTOKEN_STRING
)
975 /* Advance the completion word past a potential initial
977 parser
->completion_word
= LS_TOKEN_STOKEN (parser
->lexer
.current
).ptr
;
979 else if (advance_word
)
981 /* Advance the completion word past any whitespace. */
982 parser
->completion_word
= PARSER_STREAM (parser
);
985 return parser
->lexer
.current
;
988 /* Return the next token without consuming the current token. */
990 static linespec_token
991 linespec_lexer_peek_token (linespec_parser
*parser
)
994 const char *saved_stream
= PARSER_STREAM (parser
);
995 linespec_token saved_token
= parser
->lexer
.current
;
996 int saved_completion_quote_char
= parser
->completion_quote_char
;
997 const char *saved_completion_quote_end
= parser
->completion_quote_end
;
998 const char *saved_completion_word
= parser
->completion_word
;
1000 next
= linespec_lexer_consume_token (parser
);
1001 PARSER_STREAM (parser
) = saved_stream
;
1002 parser
->lexer
.current
= saved_token
;
1003 parser
->completion_quote_char
= saved_completion_quote_char
;
1004 parser
->completion_quote_end
= saved_completion_quote_end
;
1005 parser
->completion_word
= saved_completion_word
;
1009 /* Helper functions. */
1011 /* Add SAL to SALS, and also update SELF->CANONICAL_NAMES to reflect
1012 the new sal, if needed. If not NULL, SYMNAME is the name of the
1013 symbol to use when constructing the new canonical name.
1015 If LITERAL_CANONICAL is non-zero, SYMNAME will be used as the
1016 canonical name for the SAL. */
1019 add_sal_to_sals (struct linespec_state
*self
,
1020 std::vector
<symtab_and_line
> *sals
,
1021 struct symtab_and_line
*sal
,
1022 const char *symname
, int literal_canonical
)
1024 sals
->push_back (*sal
);
1026 if (self
->canonical
)
1028 struct linespec_canonical_name
*canonical
;
1030 self
->canonical_names
= XRESIZEVEC (struct linespec_canonical_name
,
1031 self
->canonical_names
,
1033 canonical
= &self
->canonical_names
[sals
->size () - 1];
1034 if (!literal_canonical
&& sal
->symtab
)
1036 symtab_to_fullname (sal
->symtab
);
1038 /* Note that the filter doesn't have to be a valid linespec
1039 input. We only apply the ":LINE" treatment to Ada for
1041 if (symname
!= NULL
&& sal
->line
!= 0
1042 && self
->language
->la_language
== language_ada
)
1043 canonical
->suffix
= xstrprintf ("%s:%d", symname
, sal
->line
);
1044 else if (symname
!= NULL
)
1045 canonical
->suffix
= xstrdup (symname
);
1047 canonical
->suffix
= xstrprintf ("%d", sal
->line
);
1048 canonical
->symtab
= sal
->symtab
;
1052 if (symname
!= NULL
)
1053 canonical
->suffix
= xstrdup (symname
);
1055 canonical
->suffix
= xstrdup ("<unknown>");
1056 canonical
->symtab
= NULL
;
1061 /* A hash function for address_entry. */
1064 hash_address_entry (const void *p
)
1066 const struct address_entry
*aep
= (const struct address_entry
*) p
;
1069 hash
= iterative_hash_object (aep
->pspace
, 0);
1070 return iterative_hash_object (aep
->addr
, hash
);
1073 /* An equality function for address_entry. */
1076 eq_address_entry (const void *a
, const void *b
)
1078 const struct address_entry
*aea
= (const struct address_entry
*) a
;
1079 const struct address_entry
*aeb
= (const struct address_entry
*) b
;
1081 return aea
->pspace
== aeb
->pspace
&& aea
->addr
== aeb
->addr
;
1084 /* Check whether the address, represented by PSPACE and ADDR, is
1085 already in the set. If so, return 0. Otherwise, add it and return
1089 maybe_add_address (htab_t set
, struct program_space
*pspace
, CORE_ADDR addr
)
1091 struct address_entry e
, *p
;
1096 slot
= htab_find_slot (set
, &e
, INSERT
);
1100 p
= XNEW (struct address_entry
);
1101 memcpy (p
, &e
, sizeof (struct address_entry
));
1107 /* A helper that walks over all matching symtabs in all objfiles and
1108 calls CALLBACK for each symbol matching NAME. If SEARCH_PSPACE is
1109 not NULL, then the search is restricted to just that program
1110 space. If INCLUDE_INLINE is true then symbols representing
1111 inlined instances of functions will be included in the result. */
1114 iterate_over_all_matching_symtabs
1115 (struct linespec_state
*state
,
1116 const lookup_name_info
&lookup_name
,
1117 const domain_enum name_domain
,
1118 enum search_domain search_domain
,
1119 struct program_space
*search_pspace
, bool include_inline
,
1120 gdb::function_view
<symbol_found_callback_ftype
> callback
)
1122 struct objfile
*objfile
;
1123 struct program_space
*pspace
;
1125 ALL_PSPACES (pspace
)
1127 if (search_pspace
!= NULL
&& search_pspace
!= pspace
)
1129 if (pspace
->executing_startup
)
1132 set_current_program_space (pspace
);
1134 ALL_OBJFILES (objfile
)
1136 struct compunit_symtab
*cu
;
1139 objfile
->sf
->qf
->expand_symtabs_matching (objfile
,
1145 ALL_OBJFILE_COMPUNITS (objfile
, cu
)
1147 struct symtab
*symtab
= COMPUNIT_FILETABS (cu
);
1149 iterate_over_file_blocks (symtab
, lookup_name
, name_domain
, callback
);
1153 struct block
*block
;
1156 for (i
= FIRST_LOCAL_BLOCK
;
1157 i
< BLOCKVECTOR_NBLOCKS (SYMTAB_BLOCKVECTOR (symtab
));
1160 block
= BLOCKVECTOR_BLOCK (SYMTAB_BLOCKVECTOR (symtab
), i
);
1161 state
->language
->la_iterate_over_symbols
1162 (block
, lookup_name
, name_domain
, [&] (symbol
*sym
)
1164 /* Restrict calls to CALLBACK to symbols
1165 representing inline symbols only. */
1166 if (SYMBOL_INLINED (sym
))
1167 return callback (sym
);
1177 /* Returns the block to be used for symbol searches from
1178 the current location. */
1180 static const struct block
*
1181 get_current_search_block (void)
1183 const struct block
*block
;
1184 enum language save_language
;
1186 /* get_selected_block can change the current language when there is
1187 no selected frame yet. */
1188 save_language
= current_language
->la_language
;
1189 block
= get_selected_block (0);
1190 set_language (save_language
);
1195 /* Iterate over static and global blocks. */
1198 iterate_over_file_blocks
1199 (struct symtab
*symtab
, const lookup_name_info
&name
,
1200 domain_enum domain
, gdb::function_view
<symbol_found_callback_ftype
> callback
)
1202 struct block
*block
;
1204 for (block
= BLOCKVECTOR_BLOCK (SYMTAB_BLOCKVECTOR (symtab
), STATIC_BLOCK
);
1206 block
= BLOCK_SUPERBLOCK (block
))
1207 LA_ITERATE_OVER_SYMBOLS (block
, name
, domain
, callback
);
1210 /* A helper for find_method. This finds all methods in type T of
1211 language T_LANG which match NAME. It adds matching symbol names to
1212 RESULT_NAMES, and adds T's direct superclasses to SUPERCLASSES. */
1215 find_methods (struct type
*t
, enum language t_lang
, const char *name
,
1216 std::vector
<const char *> *result_names
,
1217 std::vector
<struct type
*> *superclasses
)
1220 const char *class_name
= TYPE_NAME (t
);
1222 /* Ignore this class if it doesn't have a name. This is ugly, but
1223 unless we figure out how to get the physname without the name of
1224 the class, then the loop can't do any good. */
1228 lookup_name_info
lookup_name (name
, symbol_name_match_type::FULL
);
1229 symbol_name_matcher_ftype
*symbol_name_compare
1230 = get_symbol_name_matcher (language_def (t_lang
), lookup_name
);
1232 t
= check_typedef (t
);
1234 /* Loop over each method name. At this level, all overloads of a name
1235 are counted as a single name. There is an inner loop which loops over
1238 for (method_counter
= TYPE_NFN_FIELDS (t
) - 1;
1239 method_counter
>= 0;
1242 const char *method_name
= TYPE_FN_FIELDLIST_NAME (t
, method_counter
);
1243 char dem_opname
[64];
1245 if (startswith (method_name
, "__") ||
1246 startswith (method_name
, "op") ||
1247 startswith (method_name
, "type"))
1249 if (cplus_demangle_opname (method_name
, dem_opname
, DMGL_ANSI
))
1250 method_name
= dem_opname
;
1251 else if (cplus_demangle_opname (method_name
, dem_opname
, 0))
1252 method_name
= dem_opname
;
1255 if (symbol_name_compare (method_name
, lookup_name
, NULL
))
1259 for (field_counter
= (TYPE_FN_FIELDLIST_LENGTH (t
, method_counter
)
1265 const char *phys_name
;
1267 f
= TYPE_FN_FIELDLIST1 (t
, method_counter
);
1268 if (TYPE_FN_FIELD_STUB (f
, field_counter
))
1270 phys_name
= TYPE_FN_FIELD_PHYSNAME (f
, field_counter
);
1271 result_names
->push_back (phys_name
);
1277 for (ibase
= 0; ibase
< TYPE_N_BASECLASSES (t
); ibase
++)
1278 superclasses
->push_back (TYPE_BASECLASS (t
, ibase
));
1281 /* Find an instance of the character C in the string S that is outside
1282 of all parenthesis pairs, single-quoted strings, and double-quoted
1283 strings. Also, ignore the char within a template name, like a ','
1284 within foo<int, int>, while considering C++ operator</operator<<. */
1287 find_toplevel_char (const char *s
, char c
)
1289 int quoted
= 0; /* zero if we're not in quotes;
1290 '"' if we're in a double-quoted string;
1291 '\'' if we're in a single-quoted string. */
1292 int depth
= 0; /* Number of unclosed parens we've seen. */
1295 for (scan
= s
; *scan
; scan
++)
1299 if (*scan
== quoted
)
1301 else if (*scan
== '\\' && *(scan
+ 1))
1304 else if (*scan
== c
&& ! quoted
&& depth
== 0)
1306 else if (*scan
== '"' || *scan
== '\'')
1308 else if (*scan
== '(' || *scan
== '<')
1310 else if ((*scan
== ')' || *scan
== '>') && depth
> 0)
1312 else if (*scan
== 'o' && !quoted
&& depth
== 0)
1314 /* Handle C++ operator names. */
1315 if (strncmp (scan
, CP_OPERATOR_STR
, CP_OPERATOR_LEN
) == 0)
1317 scan
+= CP_OPERATOR_LEN
;
1320 while (isspace (*scan
))
1331 /* Skip over one less than the appropriate number of
1332 characters: the for loop will skip over the last
1358 /* The string equivalent of find_toplevel_char. Returns a pointer
1359 to the location of NEEDLE in HAYSTACK, ignoring any occurrences
1360 inside "()" and "<>". Returns NULL if NEEDLE was not found. */
1363 find_toplevel_string (const char *haystack
, const char *needle
)
1365 const char *s
= haystack
;
1369 s
= find_toplevel_char (s
, *needle
);
1373 /* Found first char in HAYSTACK; check rest of string. */
1374 if (startswith (s
, needle
))
1377 /* Didn't find it; loop over HAYSTACK, looking for the next
1378 instance of the first character of NEEDLE. */
1382 while (s
!= NULL
&& *s
!= '\0');
1384 /* NEEDLE was not found in HAYSTACK. */
1388 /* Convert CANONICAL to its string representation using
1389 symtab_to_fullname for SYMTAB. */
1392 canonical_to_fullform (const struct linespec_canonical_name
*canonical
)
1394 if (canonical
->symtab
== NULL
)
1395 return canonical
->suffix
;
1397 return string_printf ("%s:%s", symtab_to_fullname (canonical
->symtab
),
1401 /* Given FILTERS, a list of canonical names, filter the sals in RESULT
1402 and store the result in SELF->CANONICAL. */
1405 filter_results (struct linespec_state
*self
,
1406 std::vector
<symtab_and_line
> *result
,
1407 const std::vector
<const char *> &filters
)
1409 for (const char *name
: filters
)
1413 for (size_t j
= 0; j
< result
->size (); ++j
)
1415 const struct linespec_canonical_name
*canonical
;
1417 canonical
= &self
->canonical_names
[j
];
1418 std::string fullform
= canonical_to_fullform (canonical
);
1420 if (name
== fullform
)
1421 lsal
.sals
.push_back ((*result
)[j
]);
1424 if (!lsal
.sals
.empty ())
1426 lsal
.canonical
= xstrdup (name
);
1427 self
->canonical
->lsals
.push_back (std::move (lsal
));
1431 self
->canonical
->pre_expanded
= 0;
1434 /* Store RESULT into SELF->CANONICAL. */
1437 convert_results_to_lsals (struct linespec_state
*self
,
1438 std::vector
<symtab_and_line
> *result
)
1440 struct linespec_sals lsal
;
1442 lsal
.canonical
= NULL
;
1443 lsal
.sals
= std::move (*result
);
1444 self
->canonical
->lsals
.push_back (std::move (lsal
));
1447 /* A structure that contains two string representations of a struct
1448 linespec_canonical_name:
1449 - one where the the symtab's fullname is used;
1450 - one where the filename followed the "set filename-display"
1453 struct decode_line_2_item
1455 decode_line_2_item (std::string
&&fullform_
, std::string
&&displayform_
,
1457 : fullform (std::move (fullform_
)),
1458 displayform (std::move (displayform_
)),
1459 selected (selected_
)
1463 /* The form using symtab_to_fullname. */
1464 std::string fullform
;
1466 /* The form using symtab_to_filename_for_display. */
1467 std::string displayform
;
1469 /* Field is initialized to zero and it is set to one if the user
1470 requested breakpoint for this entry. */
1471 unsigned int selected
: 1;
1474 /* Helper for std::sort to sort decode_line_2_item entries by
1475 DISPLAYFORM and secondarily by FULLFORM. */
1478 decode_line_2_compare_items (const decode_line_2_item
&a
,
1479 const decode_line_2_item
&b
)
1481 if (a
.displayform
!= b
.displayform
)
1482 return a
.displayform
< b
.displayform
;
1483 return a
.fullform
< b
.fullform
;
1486 /* Handle multiple results in RESULT depending on SELECT_MODE. This
1487 will either return normally, throw an exception on multiple
1488 results, or present a menu to the user. On return, the SALS vector
1489 in SELF->CANONICAL is set up properly. */
1492 decode_line_2 (struct linespec_state
*self
,
1493 std::vector
<symtab_and_line
> *result
,
1494 const char *select_mode
)
1499 std::vector
<const char *> filters
;
1500 std::vector
<struct decode_line_2_item
> items
;
1502 gdb_assert (select_mode
!= multiple_symbols_all
);
1503 gdb_assert (self
->canonical
!= NULL
);
1504 gdb_assert (!result
->empty ());
1506 /* Prepare ITEMS array. */
1507 for (i
= 0; i
< result
->size (); ++i
)
1509 const struct linespec_canonical_name
*canonical
;
1510 std::string displayform
;
1512 canonical
= &self
->canonical_names
[i
];
1513 gdb_assert (canonical
->suffix
!= NULL
);
1515 std::string fullform
= canonical_to_fullform (canonical
);
1517 if (canonical
->symtab
== NULL
)
1518 displayform
= canonical
->suffix
;
1521 const char *fn_for_display
;
1523 fn_for_display
= symtab_to_filename_for_display (canonical
->symtab
);
1524 displayform
= string_printf ("%s:%s", fn_for_display
,
1528 items
.emplace_back (std::move (fullform
), std::move (displayform
),
1532 /* Sort the list of method names. */
1533 std::sort (items
.begin (), items
.end (), decode_line_2_compare_items
);
1535 /* Remove entries with the same FULLFORM. */
1536 items
.erase (std::unique (items
.begin (), items
.end (),
1537 [] (const struct decode_line_2_item
&a
,
1538 const struct decode_line_2_item
&b
)
1540 return a
.fullform
== b
.fullform
;
1544 if (select_mode
== multiple_symbols_cancel
&& items
.size () > 1)
1545 error (_("canceled because the command is ambiguous\n"
1546 "See set/show multiple-symbol."));
1548 if (select_mode
== multiple_symbols_all
|| items
.size () == 1)
1550 convert_results_to_lsals (self
, result
);
1554 printf_unfiltered (_("[0] cancel\n[1] all\n"));
1555 for (i
= 0; i
< items
.size (); i
++)
1556 printf_unfiltered ("[%d] %s\n", i
+ 2, items
[i
].displayform
.c_str ());
1558 prompt
= getenv ("PS2");
1563 args
= command_line_input (prompt
, "overload-choice");
1565 if (args
== 0 || *args
== 0)
1566 error_no_arg (_("one or more choice numbers"));
1568 number_or_range_parser
parser (args
);
1569 while (!parser
.finished ())
1571 int num
= parser
.get_number ();
1574 error (_("canceled"));
1577 /* We intentionally make this result in a single breakpoint,
1578 contrary to what older versions of gdb did. The
1579 rationale is that this lets a user get the
1580 multiple_symbols_all behavior even with the 'ask'
1581 setting; and he can get separate breakpoints by entering
1582 "2-57" at the query. */
1583 convert_results_to_lsals (self
, result
);
1588 if (num
>= items
.size ())
1589 printf_unfiltered (_("No choice number %d.\n"), num
);
1592 struct decode_line_2_item
*item
= &items
[num
];
1594 if (!item
->selected
)
1596 filters
.push_back (item
->fullform
.c_str ());
1601 printf_unfiltered (_("duplicate request for %d ignored.\n"),
1607 filter_results (self
, result
, filters
);
1612 /* The parser of linespec itself. */
1614 /* Throw an appropriate error when SYMBOL is not found (optionally in
1617 static void ATTRIBUTE_NORETURN
1618 symbol_not_found_error (const char *symbol
, const char *filename
)
1623 if (!have_full_symbols ()
1624 && !have_partial_symbols ()
1625 && !have_minimal_symbols ())
1626 throw_error (NOT_FOUND_ERROR
,
1627 _("No symbol table is loaded. Use the \"file\" command."));
1629 /* If SYMBOL starts with '$', the user attempted to either lookup
1630 a function/variable in his code starting with '$' or an internal
1631 variable of that name. Since we do not know which, be concise and
1632 explain both possibilities. */
1636 throw_error (NOT_FOUND_ERROR
,
1637 _("Undefined convenience variable or function \"%s\" "
1638 "not defined in \"%s\"."), symbol
, filename
);
1640 throw_error (NOT_FOUND_ERROR
,
1641 _("Undefined convenience variable or function \"%s\" "
1642 "not defined."), symbol
);
1647 throw_error (NOT_FOUND_ERROR
,
1648 _("Function \"%s\" not defined in \"%s\"."),
1651 throw_error (NOT_FOUND_ERROR
,
1652 _("Function \"%s\" not defined."), symbol
);
1656 /* Throw an appropriate error when an unexpected token is encountered
1659 static void ATTRIBUTE_NORETURN
1660 unexpected_linespec_error (linespec_parser
*parser
)
1662 linespec_token token
;
1663 static const char * token_type_strings
[]
1664 = {"keyword", "colon", "string", "number", "comma", "end of input"};
1666 /* Get the token that generated the error. */
1667 token
= linespec_lexer_lex_one (parser
);
1669 /* Finally, throw the error. */
1670 if (token
.type
== LSTOKEN_STRING
|| token
.type
== LSTOKEN_NUMBER
1671 || token
.type
== LSTOKEN_KEYWORD
)
1673 gdb::unique_xmalloc_ptr
<char> string
= copy_token_string (token
);
1674 throw_error (GENERIC_ERROR
,
1675 _("malformed linespec error: unexpected %s, \"%s\""),
1676 token_type_strings
[token
.type
], string
.get ());
1679 throw_error (GENERIC_ERROR
,
1680 _("malformed linespec error: unexpected %s"),
1681 token_type_strings
[token
.type
]);
1684 /* Throw an undefined label error. */
1686 static void ATTRIBUTE_NORETURN
1687 undefined_label_error (const char *function
, const char *label
)
1689 if (function
!= NULL
)
1690 throw_error (NOT_FOUND_ERROR
,
1691 _("No label \"%s\" defined in function \"%s\"."),
1694 throw_error (NOT_FOUND_ERROR
,
1695 _("No label \"%s\" defined in current function."),
1699 /* Throw a source file not found error. */
1701 static void ATTRIBUTE_NORETURN
1702 source_file_not_found_error (const char *name
)
1704 throw_error (NOT_FOUND_ERROR
, _("No source file named %s."), name
);
1707 /* Unless at EIO, save the current stream position as completion word
1708 point, and consume the next token. */
1710 static linespec_token
1711 save_stream_and_consume_token (linespec_parser
*parser
)
1713 if (linespec_lexer_peek_token (parser
).type
!= LSTOKEN_EOI
)
1714 parser
->completion_word
= PARSER_STREAM (parser
);
1715 return linespec_lexer_consume_token (parser
);
1718 /* See description in linespec.h. */
1721 linespec_parse_line_offset (const char *string
)
1723 const char *start
= string
;
1724 struct line_offset line_offset
= {0, LINE_OFFSET_NONE
};
1728 line_offset
.sign
= LINE_OFFSET_PLUS
;
1731 else if (*string
== '-')
1733 line_offset
.sign
= LINE_OFFSET_MINUS
;
1737 if (*string
!= '\0' && !isdigit (*string
))
1738 error (_("malformed line offset: \"%s\""), start
);
1740 /* Right now, we only allow base 10 for offsets. */
1741 line_offset
.offset
= atoi (string
);
1745 /* In completion mode, if the user is still typing the number, there's
1746 no possible completion to offer. But if there's already input past
1747 the number, setup to expect NEXT. */
1750 set_completion_after_number (linespec_parser
*parser
,
1751 linespec_complete_what next
)
1753 if (*PARSER_STREAM (parser
) == ' ')
1755 parser
->completion_word
= skip_spaces (PARSER_STREAM (parser
) + 1);
1756 parser
->complete_what
= next
;
1760 parser
->completion_word
= PARSER_STREAM (parser
);
1761 parser
->complete_what
= linespec_complete_what::NOTHING
;
1765 /* Parse the basic_spec in PARSER's input. */
1768 linespec_parse_basic (linespec_parser
*parser
)
1770 gdb::unique_xmalloc_ptr
<char> name
;
1771 linespec_token token
;
1772 std::vector
<symbol
*> symbols
;
1773 std::vector
<symbol
*> *labels
;
1774 std::vector
<bound_minimal_symbol
> minimal_symbols
;
1776 /* Get the next token. */
1777 token
= linespec_lexer_lex_one (parser
);
1779 /* If it is EOI or KEYWORD, issue an error. */
1780 if (token
.type
== LSTOKEN_KEYWORD
)
1782 parser
->complete_what
= linespec_complete_what::NOTHING
;
1783 unexpected_linespec_error (parser
);
1785 else if (token
.type
== LSTOKEN_EOI
)
1787 unexpected_linespec_error (parser
);
1789 /* If it is a LSTOKEN_NUMBER, we have an offset. */
1790 else if (token
.type
== LSTOKEN_NUMBER
)
1792 set_completion_after_number (parser
, linespec_complete_what::KEYWORD
);
1794 /* Record the line offset and get the next token. */
1795 name
= copy_token_string (token
);
1796 PARSER_EXPLICIT (parser
)->line_offset
1797 = linespec_parse_line_offset (name
.get ());
1799 /* Get the next token. */
1800 token
= linespec_lexer_consume_token (parser
);
1802 /* If the next token is a comma, stop parsing and return. */
1803 if (token
.type
== LSTOKEN_COMMA
)
1805 parser
->complete_what
= linespec_complete_what::NOTHING
;
1809 /* If the next token is anything but EOI or KEYWORD, issue
1811 if (token
.type
!= LSTOKEN_KEYWORD
&& token
.type
!= LSTOKEN_EOI
)
1812 unexpected_linespec_error (parser
);
1815 if (token
.type
== LSTOKEN_KEYWORD
|| token
.type
== LSTOKEN_EOI
)
1818 /* Next token must be LSTOKEN_STRING. */
1819 if (token
.type
!= LSTOKEN_STRING
)
1821 parser
->complete_what
= linespec_complete_what::NOTHING
;
1822 unexpected_linespec_error (parser
);
1825 /* The current token will contain the name of a function, method,
1827 name
= copy_token_string (token
);
1829 if (parser
->completion_tracker
!= NULL
)
1831 /* If the function name ends with a ":", then this may be an
1832 incomplete "::" scope operator instead of a label separator.
1835 which should expand to:
1838 Do a tentative completion assuming the later. If we find
1839 completions, advance the stream past the colon token and make
1840 it part of the function name/token. */
1842 if (!parser
->completion_quote_char
1843 && strcmp (PARSER_STREAM (parser
), ":") == 0)
1845 completion_tracker tmp_tracker
;
1846 const char *source_filename
1847 = PARSER_EXPLICIT (parser
)->source_filename
;
1848 symbol_name_match_type match_type
1849 = PARSER_EXPLICIT (parser
)->func_name_match_type
;
1851 linespec_complete_function (tmp_tracker
,
1852 parser
->completion_word
,
1856 if (tmp_tracker
.have_completions ())
1858 PARSER_STREAM (parser
)++;
1859 LS_TOKEN_STOKEN (token
).length
++;
1861 name
.reset (savestring (parser
->completion_word
,
1862 (PARSER_STREAM (parser
)
1863 - parser
->completion_word
)));
1867 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1871 /* Try looking it up as a function/method. */
1872 find_linespec_symbols (PARSER_STATE (parser
),
1873 PARSER_RESULT (parser
)->file_symtabs
, name
.get (),
1874 PARSER_EXPLICIT (parser
)->func_name_match_type
,
1875 &symbols
, &minimal_symbols
);
1877 if (!symbols
.empty () || !minimal_symbols
.empty ())
1879 PARSER_RESULT (parser
)->function_symbols
1880 = new std::vector
<symbol
*> (std::move (symbols
));
1881 PARSER_RESULT (parser
)->minimal_symbols
1882 = new std::vector
<bound_minimal_symbol
>
1883 (std::move (minimal_symbols
));
1884 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1888 /* NAME was not a function or a method. So it must be a label
1889 name or user specified variable like "break foo.c:$zippo". */
1890 labels
= find_label_symbols (PARSER_STATE (parser
), NULL
,
1891 &symbols
, name
.get ());
1894 PARSER_RESULT (parser
)->labels
.label_symbols
= labels
;
1895 PARSER_RESULT (parser
)->labels
.function_symbols
1896 = new std::vector
<symbol
*> (std::move (symbols
));
1897 PARSER_EXPLICIT (parser
)->label_name
= name
.release ();
1899 else if (token
.type
== LSTOKEN_STRING
1900 && *LS_TOKEN_STOKEN (token
).ptr
== '$')
1902 /* User specified a convenience variable or history value. */
1903 PARSER_EXPLICIT (parser
)->line_offset
1904 = linespec_parse_variable (PARSER_STATE (parser
), name
.get ());
1906 if (PARSER_EXPLICIT (parser
)->line_offset
.sign
== LINE_OFFSET_UNKNOWN
)
1908 /* The user-specified variable was not valid. Do not
1909 throw an error here. parse_linespec will do it for us. */
1910 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1916 /* The name is also not a label. Abort parsing. Do not throw
1917 an error here. parse_linespec will do it for us. */
1919 /* Save a copy of the name we were trying to lookup. */
1920 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1926 int previous_qc
= parser
->completion_quote_char
;
1928 /* Get the next token. */
1929 token
= linespec_lexer_consume_token (parser
);
1931 if (token
.type
== LSTOKEN_EOI
)
1933 if (previous_qc
&& !parser
->completion_quote_char
)
1934 parser
->complete_what
= linespec_complete_what::KEYWORD
;
1936 else if (token
.type
== LSTOKEN_COLON
)
1938 /* User specified a label or a lineno. */
1939 token
= linespec_lexer_consume_token (parser
);
1941 if (token
.type
== LSTOKEN_NUMBER
)
1943 /* User specified an offset. Record the line offset and
1944 get the next token. */
1945 set_completion_after_number (parser
, linespec_complete_what::KEYWORD
);
1947 name
= copy_token_string (token
);
1948 PARSER_EXPLICIT (parser
)->line_offset
1949 = linespec_parse_line_offset (name
.get ());
1951 /* Get the next token. */
1952 token
= linespec_lexer_consume_token (parser
);
1954 else if (token
.type
== LSTOKEN_EOI
&& parser
->completion_tracker
!= NULL
)
1956 parser
->complete_what
= linespec_complete_what::LABEL
;
1958 else if (token
.type
== LSTOKEN_STRING
)
1960 parser
->complete_what
= linespec_complete_what::LABEL
;
1962 /* If we have text after the label separated by whitespace
1963 (e.g., "b func():lab i<tab>"), don't consider it part of
1964 the label. In completion mode that should complete to
1965 "if", in normal mode, the 'i' should be treated as
1967 if (parser
->completion_quote_char
== '\0')
1969 const char *ptr
= LS_TOKEN_STOKEN (token
).ptr
;
1970 for (size_t i
= 0; i
< LS_TOKEN_STOKEN (token
).length
; i
++)
1974 LS_TOKEN_STOKEN (token
).length
= i
;
1975 PARSER_STREAM (parser
) = skip_spaces (ptr
+ i
+ 1);
1981 if (parser
->completion_tracker
!= NULL
)
1983 if (PARSER_STREAM (parser
)[-1] == ' ')
1985 parser
->completion_word
= PARSER_STREAM (parser
);
1986 parser
->complete_what
= linespec_complete_what::KEYWORD
;
1991 /* Grab a copy of the label's name and look it up. */
1992 name
= copy_token_string (token
);
1994 = find_label_symbols (PARSER_STATE (parser
),
1995 PARSER_RESULT (parser
)->function_symbols
,
1996 &symbols
, name
.get ());
2000 PARSER_RESULT (parser
)->labels
.label_symbols
= labels
;
2001 PARSER_RESULT (parser
)->labels
.function_symbols
2002 = new std::vector
<symbol
*> (std::move (symbols
));
2003 PARSER_EXPLICIT (parser
)->label_name
= name
.release ();
2007 /* We don't know what it was, but it isn't a label. */
2008 undefined_label_error
2009 (PARSER_EXPLICIT (parser
)->function_name
, name
.get ());
2014 /* Check for a line offset. */
2015 token
= save_stream_and_consume_token (parser
);
2016 if (token
.type
== LSTOKEN_COLON
)
2018 /* Get the next token. */
2019 token
= linespec_lexer_consume_token (parser
);
2021 /* It must be a line offset. */
2022 if (token
.type
!= LSTOKEN_NUMBER
)
2023 unexpected_linespec_error (parser
);
2025 /* Record the line offset and get the next token. */
2026 name
= copy_token_string (token
);
2028 PARSER_EXPLICIT (parser
)->line_offset
2029 = linespec_parse_line_offset (name
.get ());
2031 /* Get the next token. */
2032 token
= linespec_lexer_consume_token (parser
);
2037 /* Trailing ':' in the input. Issue an error. */
2038 unexpected_linespec_error (parser
);
2043 /* Canonicalize the linespec contained in LS. The result is saved into
2044 STATE->canonical. This function handles both linespec and explicit
2048 canonicalize_linespec (struct linespec_state
*state
, const linespec_p ls
)
2050 struct event_location
*canon
;
2051 struct explicit_location
*explicit_loc
;
2053 /* If canonicalization was not requested, no need to do anything. */
2054 if (!state
->canonical
)
2057 /* Save everything as an explicit location. */
2058 state
->canonical
->location
2059 = new_explicit_location (&ls
->explicit_loc
);
2060 canon
= state
->canonical
->location
.get ();
2061 explicit_loc
= get_explicit_location (canon
);
2063 if (explicit_loc
->label_name
!= NULL
)
2065 state
->canonical
->special_display
= 1;
2067 if (explicit_loc
->function_name
== NULL
)
2069 /* No function was specified, so add the symbol name. */
2070 gdb_assert (!ls
->labels
.function_symbols
->empty ()
2071 && (ls
->labels
.function_symbols
->size () == 1));
2072 struct symbol
*s
= ls
->labels
.function_symbols
->front ();
2073 explicit_loc
->function_name
= xstrdup (SYMBOL_NATURAL_NAME (s
));
2077 /* If this location originally came from a linespec, save a string
2078 representation of it for display and saving to file. */
2079 if (state
->is_linespec
)
2081 char *linespec
= explicit_location_to_linespec (explicit_loc
);
2083 set_event_location_string (canon
, linespec
);
2088 /* Given a line offset in LS, construct the relevant SALs. */
2090 static std::vector
<symtab_and_line
>
2091 create_sals_line_offset (struct linespec_state
*self
,
2094 int use_default
= 0;
2096 /* This is where we need to make sure we have good defaults.
2097 We must guarantee that this section of code is never executed
2098 when we are called with just a function name, since
2099 set_default_source_symtab_and_line uses
2100 select_source_symtab that calls us with such an argument. */
2102 if (ls
->file_symtabs
->size () == 1
2103 && ls
->file_symtabs
->front () == nullptr)
2105 const char *fullname
;
2107 set_current_program_space (self
->program_space
);
2109 /* Make sure we have at least a default source line. */
2110 set_default_source_symtab_and_line ();
2111 initialize_defaults (&self
->default_symtab
, &self
->default_line
);
2112 fullname
= symtab_to_fullname (self
->default_symtab
);
2113 symtab_vector_up r
=
2114 collect_symtabs_from_filename (fullname
, self
->search_pspace
);
2115 ls
->file_symtabs
= r
.release ();
2119 symtab_and_line val
;
2120 val
.line
= ls
->explicit_loc
.line_offset
.offset
;
2121 switch (ls
->explicit_loc
.line_offset
.sign
)
2123 case LINE_OFFSET_PLUS
:
2124 if (ls
->explicit_loc
.line_offset
.offset
== 0)
2127 val
.line
= self
->default_line
+ val
.line
;
2130 case LINE_OFFSET_MINUS
:
2131 if (ls
->explicit_loc
.line_offset
.offset
== 0)
2134 val
.line
= self
->default_line
- val
.line
;
2136 val
.line
= -val
.line
;
2139 case LINE_OFFSET_NONE
:
2140 break; /* No need to adjust val.line. */
2143 std::vector
<symtab_and_line
> values
;
2144 if (self
->list_mode
)
2145 values
= decode_digits_list_mode (self
, ls
, val
);
2148 struct linetable_entry
*best_entry
= NULL
;
2151 std::vector
<symtab_and_line
> intermediate_results
2152 = decode_digits_ordinary (self
, ls
, val
.line
, &best_entry
);
2153 if (intermediate_results
.empty () && best_entry
!= NULL
)
2154 intermediate_results
= decode_digits_ordinary (self
, ls
,
2158 /* For optimized code, the compiler can scatter one source line
2159 across disjoint ranges of PC values, even when no duplicate
2160 functions or inline functions are involved. For example,
2161 'for (;;)' inside a non-template, non-inline, and non-ctor-or-dtor
2162 function can result in two PC ranges. In this case, we don't
2163 want to set a breakpoint on the first PC of each range. To filter
2164 such cases, we use containing blocks -- for each PC found
2165 above, we see if there are other PCs that are in the same
2166 block. If yes, the other PCs are filtered out. */
2168 gdb::def_vector
<int> filter (intermediate_results
.size ());
2169 gdb::def_vector
<const block
*> blocks (intermediate_results
.size ());
2171 for (i
= 0; i
< intermediate_results
.size (); ++i
)
2173 set_current_program_space (intermediate_results
[i
].pspace
);
2176 blocks
[i
] = block_for_pc_sect (intermediate_results
[i
].pc
,
2177 intermediate_results
[i
].section
);
2180 for (i
= 0; i
< intermediate_results
.size (); ++i
)
2182 if (blocks
[i
] != NULL
)
2183 for (j
= i
+ 1; j
< intermediate_results
.size (); ++j
)
2185 if (blocks
[j
] == blocks
[i
])
2193 for (i
= 0; i
< intermediate_results
.size (); ++i
)
2196 struct symbol
*sym
= (blocks
[i
]
2197 ? block_containing_function (blocks
[i
])
2200 if (self
->funfirstline
)
2201 skip_prologue_sal (&intermediate_results
[i
]);
2202 intermediate_results
[i
].symbol
= sym
;
2203 add_sal_to_sals (self
, &values
, &intermediate_results
[i
],
2204 sym
? SYMBOL_NATURAL_NAME (sym
) : NULL
, 0);
2208 if (values
.empty ())
2210 if (ls
->explicit_loc
.source_filename
)
2211 throw_error (NOT_FOUND_ERROR
, _("No line %d in file \"%s\"."),
2212 val
.line
, ls
->explicit_loc
.source_filename
);
2214 throw_error (NOT_FOUND_ERROR
, _("No line %d in the current file."),
2221 /* Convert the given ADDRESS into SaLs. */
2223 static std::vector
<symtab_and_line
>
2224 convert_address_location_to_sals (struct linespec_state
*self
,
2227 symtab_and_line sal
= find_pc_line (address
, 0);
2229 sal
.section
= find_pc_overlay (address
);
2230 sal
.explicit_pc
= 1;
2231 sal
.symbol
= find_pc_sect_containing_function (sal
.pc
, sal
.section
);
2233 std::vector
<symtab_and_line
> sals
;
2234 add_sal_to_sals (self
, &sals
, &sal
, core_addr_to_string (address
), 1);
2239 /* Create and return SALs from the linespec LS. */
2241 static std::vector
<symtab_and_line
>
2242 convert_linespec_to_sals (struct linespec_state
*state
, linespec_p ls
)
2244 std::vector
<symtab_and_line
> sals
;
2246 if (ls
->labels
.label_symbols
!= NULL
)
2248 /* We have just a bunch of functions/methods or labels. */
2249 for (const auto &sym
: *ls
->labels
.label_symbols
)
2251 struct symtab_and_line sal
;
2252 struct program_space
*pspace
= SYMTAB_PSPACE (symbol_symtab (sym
));
2254 if (symbol_to_sal (&sal
, state
->funfirstline
, sym
)
2255 && maybe_add_address (state
->addr_set
, pspace
, sal
.pc
))
2256 add_sal_to_sals (state
, &sals
, &sal
,
2257 SYMBOL_NATURAL_NAME (sym
), 0);
2260 else if (ls
->function_symbols
!= NULL
|| ls
->minimal_symbols
!= NULL
)
2262 /* We have just a bunch of functions and/or methods. */
2263 if (ls
->function_symbols
!= NULL
)
2265 /* Sort symbols so that symbols with the same program space are next
2267 std::sort (ls
->function_symbols
->begin (),
2268 ls
->function_symbols
->end (),
2269 std_compare_symbols
);
2271 for (const auto &sym
: *ls
->function_symbols
)
2273 program_space
*pspace
= SYMTAB_PSPACE (symbol_symtab (sym
));
2274 set_current_program_space (pspace
);
2276 /* Don't skip to the first line of the function if we
2277 had found an ifunc minimal symbol for this function,
2278 because that means that this function is an ifunc
2279 resolver with the same name as the ifunc itself. */
2280 bool found_ifunc
= false;
2282 if (state
->funfirstline
2283 && ls
->minimal_symbols
!= NULL
2284 && SYMBOL_CLASS (sym
) == LOC_BLOCK
)
2286 const CORE_ADDR addr
2287 = BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym
));
2289 for (const auto &elem
: *ls
->minimal_symbols
)
2291 if (MSYMBOL_TYPE (elem
.minsym
) == mst_text_gnu_ifunc
2292 || MSYMBOL_TYPE (elem
.minsym
) == mst_data_gnu_ifunc
)
2294 CORE_ADDR msym_addr
= BMSYMBOL_VALUE_ADDRESS (elem
);
2295 if (MSYMBOL_TYPE (elem
.minsym
) == mst_data_gnu_ifunc
)
2297 struct gdbarch
*gdbarch
2298 = get_objfile_arch (elem
.objfile
);
2300 = (gdbarch_convert_from_func_ptr_addr
2303 current_top_target ()));
2306 if (msym_addr
== addr
)
2317 symtab_and_line sal
;
2318 if (symbol_to_sal (&sal
, state
->funfirstline
, sym
)
2319 && maybe_add_address (state
->addr_set
, pspace
, sal
.pc
))
2320 add_sal_to_sals (state
, &sals
, &sal
,
2321 SYMBOL_NATURAL_NAME (sym
), 0);
2326 if (ls
->minimal_symbols
!= NULL
)
2328 /* Sort minimal symbols by program space, too */
2329 std::sort (ls
->minimal_symbols
->begin (),
2330 ls
->minimal_symbols
->end (),
2333 for (const auto &elem
: *ls
->minimal_symbols
)
2335 program_space
*pspace
= elem
.objfile
->pspace
;
2336 set_current_program_space (pspace
);
2337 minsym_found (state
, elem
.objfile
, elem
.minsym
, &sals
);
2341 else if (ls
->explicit_loc
.line_offset
.sign
!= LINE_OFFSET_UNKNOWN
)
2343 /* Only an offset was specified. */
2344 sals
= create_sals_line_offset (state
, ls
);
2346 /* Make sure we have a filename for canonicalization. */
2347 if (ls
->explicit_loc
.source_filename
== NULL
)
2349 const char *fullname
= symtab_to_fullname (state
->default_symtab
);
2351 /* It may be more appropriate to keep DEFAULT_SYMTAB in its symtab
2352 form so that displaying SOURCE_FILENAME can follow the current
2353 FILENAME_DISPLAY_STRING setting. But as it is used only rarely
2354 it has been kept for code simplicity only in absolute form. */
2355 ls
->explicit_loc
.source_filename
= xstrdup (fullname
);
2360 /* We haven't found any results... */
2364 canonicalize_linespec (state
, ls
);
2366 if (!sals
.empty () && state
->canonical
!= NULL
)
2367 state
->canonical
->pre_expanded
= 1;
2372 /* Build RESULT from the explicit location components SOURCE_FILENAME,
2373 FUNCTION_NAME, LABEL_NAME and LINE_OFFSET. */
2376 convert_explicit_location_to_linespec (struct linespec_state
*self
,
2378 const char *source_filename
,
2379 const char *function_name
,
2380 symbol_name_match_type fname_match_type
,
2381 const char *label_name
,
2382 struct line_offset line_offset
)
2384 std::vector
<symbol
*> symbols
;
2385 std::vector
<symbol
*> *labels
;
2386 std::vector
<bound_minimal_symbol
> minimal_symbols
;
2388 result
->explicit_loc
.func_name_match_type
= fname_match_type
;
2390 if (source_filename
!= NULL
)
2394 result
->file_symtabs
2395 = symtabs_from_filename (source_filename
,
2396 self
->search_pspace
).release ();
2398 CATCH (except
, RETURN_MASK_ERROR
)
2400 source_file_not_found_error (source_filename
);
2403 result
->explicit_loc
.source_filename
= xstrdup (source_filename
);
2407 /* A NULL entry means to use the default symtab. */
2408 result
->file_symtabs
->push_back (nullptr);
2411 if (function_name
!= NULL
)
2413 find_linespec_symbols (self
, result
->file_symtabs
,
2414 function_name
, fname_match_type
,
2415 &symbols
, &minimal_symbols
);
2417 if (symbols
.empty () && minimal_symbols
.empty ())
2418 symbol_not_found_error (function_name
,
2419 result
->explicit_loc
.source_filename
);
2421 result
->explicit_loc
.function_name
= xstrdup (function_name
);
2422 result
->function_symbols
2423 = new std::vector
<symbol
*> (std::move (symbols
));
2424 result
->minimal_symbols
2425 = new std::vector
<bound_minimal_symbol
> (std::move (minimal_symbols
));
2428 if (label_name
!= NULL
)
2430 labels
= find_label_symbols (self
, result
->function_symbols
,
2431 &symbols
, label_name
);
2434 undefined_label_error (result
->explicit_loc
.function_name
,
2437 result
->explicit_loc
.label_name
= xstrdup (label_name
);
2438 result
->labels
.label_symbols
= labels
;
2439 result
->labels
.function_symbols
2440 = new std::vector
<symbol
*> (std::move (symbols
));
2443 if (line_offset
.sign
!= LINE_OFFSET_UNKNOWN
)
2444 result
->explicit_loc
.line_offset
= line_offset
;
2447 /* Convert the explicit location EXPLICIT_LOC into SaLs. */
2449 static std::vector
<symtab_and_line
>
2450 convert_explicit_location_to_sals (struct linespec_state
*self
,
2452 const struct explicit_location
*explicit_loc
)
2454 convert_explicit_location_to_linespec (self
, result
,
2455 explicit_loc
->source_filename
,
2456 explicit_loc
->function_name
,
2457 explicit_loc
->func_name_match_type
,
2458 explicit_loc
->label_name
,
2459 explicit_loc
->line_offset
);
2460 return convert_linespec_to_sals (self
, result
);
2463 /* Parse a string that specifies a linespec.
2465 The basic grammar of linespecs:
2467 linespec -> var_spec | basic_spec
2468 var_spec -> '$' (STRING | NUMBER)
2470 basic_spec -> file_offset_spec | function_spec | label_spec
2471 file_offset_spec -> opt_file_spec offset_spec
2472 function_spec -> opt_file_spec function_name_spec opt_label_spec
2473 label_spec -> label_name_spec
2475 opt_file_spec -> "" | file_name_spec ':'
2476 opt_label_spec -> "" | ':' label_name_spec
2478 file_name_spec -> STRING
2479 function_name_spec -> STRING
2480 label_name_spec -> STRING
2481 function_name_spec -> STRING
2482 offset_spec -> NUMBER
2486 This may all be followed by several keywords such as "if EXPR",
2489 A comma will terminate parsing.
2491 The function may be an undebuggable function found in minimal symbol table.
2493 If the argument FUNFIRSTLINE is nonzero, we want the first line
2494 of real code inside a function when a function is specified, and it is
2495 not OK to specify a variable or type to get its line number.
2497 DEFAULT_SYMTAB specifies the file to use if none is specified.
2498 It defaults to current_source_symtab.
2499 DEFAULT_LINE specifies the line number to use for relative
2500 line numbers (that start with signs). Defaults to current_source_line.
2501 If CANONICAL is non-NULL, store an array of strings containing the canonical
2502 line specs there if necessary. Currently overloaded member functions and
2503 line numbers or static functions without a filename yield a canonical
2504 line spec. The array and the line spec strings are allocated on the heap,
2505 it is the callers responsibility to free them.
2507 Note that it is possible to return zero for the symtab
2508 if no file is validly specified. Callers must check that.
2509 Also, the line number returned may be invalid. */
2511 /* Parse the linespec in ARG. MATCH_TYPE indicates how function names
2512 should be matched. */
2514 static std::vector
<symtab_and_line
>
2515 parse_linespec (linespec_parser
*parser
, const char *arg
,
2516 symbol_name_match_type match_type
)
2518 linespec_token token
;
2519 struct gdb_exception file_exception
= exception_none
;
2521 /* A special case to start. It has become quite popular for
2522 IDEs to work around bugs in the previous parser by quoting
2523 the entire linespec, so we attempt to deal with this nicely. */
2524 parser
->is_quote_enclosed
= 0;
2525 if (parser
->completion_tracker
== NULL
2526 && !is_ada_operator (arg
)
2527 && strchr (linespec_quote_characters
, *arg
) != NULL
)
2531 end
= skip_quote_char (arg
+ 1, *arg
);
2532 if (end
!= NULL
&& is_closing_quote_enclosed (end
))
2534 /* Here's the special case. Skip ARG past the initial
2537 parser
->is_quote_enclosed
= 1;
2541 parser
->lexer
.saved_arg
= arg
;
2542 parser
->lexer
.stream
= arg
;
2543 parser
->completion_word
= arg
;
2544 parser
->complete_what
= linespec_complete_what::FUNCTION
;
2545 PARSER_EXPLICIT (parser
)->func_name_match_type
= match_type
;
2547 /* Initialize the default symtab and line offset. */
2548 initialize_defaults (&PARSER_STATE (parser
)->default_symtab
,
2549 &PARSER_STATE (parser
)->default_line
);
2551 /* Objective-C shortcut. */
2552 if (parser
->completion_tracker
== NULL
)
2554 std::vector
<symtab_and_line
> values
2555 = decode_objc (PARSER_STATE (parser
), PARSER_RESULT (parser
), arg
);
2556 if (!values
.empty ())
2561 /* "-"/"+" is either an objc selector, or a number. There's
2562 nothing to complete the latter to, so just let the caller
2563 complete on functions, which finds objc selectors, if there's
2565 if ((arg
[0] == '-' || arg
[0] == '+') && arg
[1] == '\0')
2569 /* Start parsing. */
2571 /* Get the first token. */
2572 token
= linespec_lexer_consume_token (parser
);
2574 /* It must be either LSTOKEN_STRING or LSTOKEN_NUMBER. */
2575 if (token
.type
== LSTOKEN_STRING
&& *LS_TOKEN_STOKEN (token
).ptr
== '$')
2577 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2578 if (parser
->completion_tracker
== NULL
)
2579 PARSER_RESULT (parser
)->file_symtabs
->push_back (nullptr);
2581 /* User specified a convenience variable or history value. */
2582 gdb::unique_xmalloc_ptr
<char> var
= copy_token_string (token
);
2583 PARSER_EXPLICIT (parser
)->line_offset
2584 = linespec_parse_variable (PARSER_STATE (parser
), var
.get ());
2586 /* If a line_offset wasn't found (VAR is the name of a user
2587 variable/function), then skip to normal symbol processing. */
2588 if (PARSER_EXPLICIT (parser
)->line_offset
.sign
!= LINE_OFFSET_UNKNOWN
)
2590 /* Consume this token. */
2591 linespec_lexer_consume_token (parser
);
2593 goto convert_to_sals
;
2596 else if (token
.type
== LSTOKEN_EOI
&& parser
->completion_tracker
!= NULL
)
2598 /* Let the default linespec_complete_what::FUNCTION kick in. */
2599 unexpected_linespec_error (parser
);
2601 else if (token
.type
!= LSTOKEN_STRING
&& token
.type
!= LSTOKEN_NUMBER
)
2603 parser
->complete_what
= linespec_complete_what::NOTHING
;
2604 unexpected_linespec_error (parser
);
2607 /* Shortcut: If the next token is not LSTOKEN_COLON, we know that
2608 this token cannot represent a filename. */
2609 token
= linespec_lexer_peek_token (parser
);
2611 if (token
.type
== LSTOKEN_COLON
)
2613 /* Get the current token again and extract the filename. */
2614 token
= linespec_lexer_lex_one (parser
);
2615 gdb::unique_xmalloc_ptr
<char> user_filename
= copy_token_string (token
);
2617 /* Check if the input is a filename. */
2621 = symtabs_from_filename (user_filename
.get (),
2622 PARSER_STATE (parser
)->search_pspace
);
2623 PARSER_RESULT (parser
)->file_symtabs
= r
.release ();
2625 CATCH (ex
, RETURN_MASK_ERROR
)
2627 file_exception
= ex
;
2631 if (file_exception
.reason
>= 0)
2633 /* Symtabs were found for the file. Record the filename. */
2634 PARSER_EXPLICIT (parser
)->source_filename
= user_filename
.release ();
2636 /* Get the next token. */
2637 token
= linespec_lexer_consume_token (parser
);
2639 /* This is LSTOKEN_COLON; consume it. */
2640 linespec_lexer_consume_token (parser
);
2644 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2645 PARSER_RESULT (parser
)->file_symtabs
->push_back (nullptr);
2648 /* If the next token is not EOI, KEYWORD, or COMMA, issue an error. */
2649 else if (parser
->completion_tracker
== NULL
2650 && (token
.type
!= LSTOKEN_EOI
&& token
.type
!= LSTOKEN_KEYWORD
2651 && token
.type
!= LSTOKEN_COMMA
))
2653 /* TOKEN is the _next_ token, not the one currently in the parser.
2654 Consuming the token will give the correct error message. */
2655 linespec_lexer_consume_token (parser
);
2656 unexpected_linespec_error (parser
);
2660 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2661 PARSER_RESULT (parser
)->file_symtabs
->push_back (nullptr);
2664 /* Parse the rest of the linespec. */
2665 linespec_parse_basic (parser
);
2667 if (parser
->completion_tracker
== NULL
2668 && PARSER_RESULT (parser
)->function_symbols
== NULL
2669 && PARSER_RESULT (parser
)->labels
.label_symbols
== NULL
2670 && PARSER_EXPLICIT (parser
)->line_offset
.sign
== LINE_OFFSET_UNKNOWN
2671 && PARSER_RESULT (parser
)->minimal_symbols
== NULL
)
2673 /* The linespec didn't parse. Re-throw the file exception if
2675 if (file_exception
.reason
< 0)
2676 throw_exception (file_exception
);
2678 /* Otherwise, the symbol is not found. */
2679 symbol_not_found_error (PARSER_EXPLICIT (parser
)->function_name
,
2680 PARSER_EXPLICIT (parser
)->source_filename
);
2685 /* Get the last token and record how much of the input was parsed,
2687 token
= linespec_lexer_lex_one (parser
);
2688 if (token
.type
!= LSTOKEN_EOI
&& token
.type
!= LSTOKEN_KEYWORD
)
2689 unexpected_linespec_error (parser
);
2690 else if (token
.type
== LSTOKEN_KEYWORD
)
2692 /* Setup the completion word past the keyword. Lexing never
2693 advances past a keyword automatically, so skip it
2695 parser
->completion_word
2696 = skip_spaces (skip_to_space (PARSER_STREAM (parser
)));
2697 parser
->complete_what
= linespec_complete_what::EXPRESSION
;
2700 /* Convert the data in PARSER_RESULT to SALs. */
2701 if (parser
->completion_tracker
== NULL
)
2702 return convert_linespec_to_sals (PARSER_STATE (parser
),
2703 PARSER_RESULT (parser
));
2709 /* A constructor for linespec_state. */
2712 linespec_state_constructor (struct linespec_state
*self
,
2713 int flags
, const struct language_defn
*language
,
2714 struct program_space
*search_pspace
,
2715 struct symtab
*default_symtab
,
2717 struct linespec_result
*canonical
)
2719 memset (self
, 0, sizeof (*self
));
2720 self
->language
= language
;
2721 self
->funfirstline
= (flags
& DECODE_LINE_FUNFIRSTLINE
) ? 1 : 0;
2722 self
->list_mode
= (flags
& DECODE_LINE_LIST_MODE
) ? 1 : 0;
2723 self
->search_pspace
= search_pspace
;
2724 self
->default_symtab
= default_symtab
;
2725 self
->default_line
= default_line
;
2726 self
->canonical
= canonical
;
2727 self
->program_space
= current_program_space
;
2728 self
->addr_set
= htab_create_alloc (10, hash_address_entry
, eq_address_entry
,
2729 xfree
, xcalloc
, xfree
);
2730 self
->is_linespec
= 0;
2733 /* Initialize a new linespec parser. */
2736 linespec_parser_new (linespec_parser
*parser
,
2737 int flags
, const struct language_defn
*language
,
2738 struct program_space
*search_pspace
,
2739 struct symtab
*default_symtab
,
2741 struct linespec_result
*canonical
)
2743 memset (parser
, 0, sizeof (linespec_parser
));
2744 parser
->lexer
.current
.type
= LSTOKEN_CONSUMED
;
2745 memset (PARSER_RESULT (parser
), 0, sizeof (struct linespec
));
2746 PARSER_RESULT (parser
)->file_symtabs
= new std::vector
<symtab
*> ();
2747 PARSER_EXPLICIT (parser
)->func_name_match_type
2748 = symbol_name_match_type::WILD
;
2749 PARSER_EXPLICIT (parser
)->line_offset
.sign
= LINE_OFFSET_UNKNOWN
;
2750 linespec_state_constructor (PARSER_STATE (parser
), flags
, language
,
2752 default_symtab
, default_line
, canonical
);
2755 /* A destructor for linespec_state. */
2758 linespec_state_destructor (struct linespec_state
*self
)
2760 htab_delete (self
->addr_set
);
2763 /* Delete a linespec parser. */
2766 linespec_parser_delete (void *arg
)
2768 linespec_parser
*parser
= (linespec_parser
*) arg
;
2770 xfree (PARSER_EXPLICIT (parser
)->source_filename
);
2771 xfree (PARSER_EXPLICIT (parser
)->label_name
);
2772 xfree (PARSER_EXPLICIT (parser
)->function_name
);
2774 delete PARSER_RESULT (parser
)->file_symtabs
;
2775 delete PARSER_RESULT (parser
)->function_symbols
;
2776 delete PARSER_RESULT (parser
)->minimal_symbols
;
2777 delete PARSER_RESULT (parser
)->labels
.label_symbols
;
2778 delete PARSER_RESULT (parser
)->labels
.function_symbols
;
2780 linespec_state_destructor (PARSER_STATE (parser
));
2783 /* See description in linespec.h. */
2786 linespec_lex_to_end (const char **stringp
)
2788 linespec_parser parser
;
2789 struct cleanup
*cleanup
;
2790 linespec_token token
;
2793 if (stringp
== NULL
|| *stringp
== NULL
)
2796 linespec_parser_new (&parser
, 0, current_language
, NULL
, NULL
, 0, NULL
);
2797 cleanup
= make_cleanup (linespec_parser_delete
, &parser
);
2798 parser
.lexer
.saved_arg
= *stringp
;
2799 PARSER_STREAM (&parser
) = orig
= *stringp
;
2803 /* Stop before any comma tokens; we need it to keep it
2804 as the next token in the string. */
2805 token
= linespec_lexer_peek_token (&parser
);
2806 if (token
.type
== LSTOKEN_COMMA
)
2808 token
= linespec_lexer_consume_token (&parser
);
2810 while (token
.type
!= LSTOKEN_EOI
&& token
.type
!= LSTOKEN_KEYWORD
);
2812 *stringp
+= PARSER_STREAM (&parser
) - orig
;
2813 do_cleanups (cleanup
);
2816 /* See linespec.h. */
2819 linespec_complete_function (completion_tracker
&tracker
,
2820 const char *function
,
2821 symbol_name_match_type func_match_type
,
2822 const char *source_filename
)
2824 complete_symbol_mode mode
= complete_symbol_mode::LINESPEC
;
2826 if (source_filename
!= NULL
)
2828 collect_file_symbol_completion_matches (tracker
, mode
, func_match_type
,
2829 function
, function
, source_filename
);
2833 collect_symbol_completion_matches (tracker
, mode
, func_match_type
,
2834 function
, function
);
2839 /* Helper for complete_linespec to simplify it. SOURCE_FILENAME is
2840 only meaningful if COMPONENT is FUNCTION. */
2843 complete_linespec_component (linespec_parser
*parser
,
2844 completion_tracker
&tracker
,
2846 linespec_complete_what component
,
2847 const char *source_filename
)
2849 if (component
== linespec_complete_what::KEYWORD
)
2851 complete_on_enum (tracker
, linespec_keywords
, text
, text
);
2853 else if (component
== linespec_complete_what::EXPRESSION
)
2856 = advance_to_expression_complete_word_point (tracker
, text
);
2857 complete_expression (tracker
, text
, word
);
2859 else if (component
== linespec_complete_what::FUNCTION
)
2861 completion_list fn_list
;
2863 symbol_name_match_type match_type
2864 = PARSER_EXPLICIT (parser
)->func_name_match_type
;
2865 linespec_complete_function (tracker
, text
, match_type
, source_filename
);
2866 if (source_filename
== NULL
)
2868 /* Haven't seen a source component, like in "b
2869 file.c:function[TAB]". Maybe this wasn't a function, but
2870 a filename instead, like "b file.[TAB]". */
2871 fn_list
= complete_source_filenames (text
);
2874 /* If we only have a single filename completion, append a ':' for
2875 the user, since that's the only thing that can usefully follow
2877 if (fn_list
.size () == 1 && !tracker
.have_completions ())
2879 char *fn
= fn_list
[0].release ();
2881 /* If we also need to append a quote char, it needs to be
2882 appended before the ':'. Append it now, and make ':' the
2883 new "quote" char. */
2884 if (tracker
.quote_char ())
2886 char quote_char_str
[2] = { (char) tracker
.quote_char () };
2888 fn
= reconcat (fn
, fn
, quote_char_str
, (char *) NULL
);
2889 tracker
.set_quote_char (':');
2892 fn
= reconcat (fn
, fn
, ":", (char *) NULL
);
2893 fn_list
[0].reset (fn
);
2895 /* Tell readline to skip appending a space. */
2896 tracker
.set_suppress_append_ws (true);
2898 tracker
.add_completions (std::move (fn_list
));
2902 /* Helper for linespec_complete_label. Find labels that match
2903 LABEL_NAME in the function symbols listed in the PARSER, and add
2904 them to the tracker. */
2907 complete_label (completion_tracker
&tracker
,
2908 linespec_parser
*parser
,
2909 const char *label_name
)
2911 std::vector
<symbol
*> label_function_symbols
;
2912 std::vector
<symbol
*> *labels
2913 = find_label_symbols (PARSER_STATE (parser
),
2914 PARSER_RESULT (parser
)->function_symbols
,
2915 &label_function_symbols
,
2918 if (labels
!= nullptr)
2920 for (const auto &label
: *labels
)
2922 char *match
= xstrdup (SYMBOL_SEARCH_NAME (label
));
2923 tracker
.add_completion (gdb::unique_xmalloc_ptr
<char> (match
));
2929 /* See linespec.h. */
2932 linespec_complete_label (completion_tracker
&tracker
,
2933 const struct language_defn
*language
,
2934 const char *source_filename
,
2935 const char *function_name
,
2936 symbol_name_match_type func_name_match_type
,
2937 const char *label_name
)
2939 linespec_parser parser
;
2940 struct cleanup
*cleanup
;
2942 linespec_parser_new (&parser
, 0, language
, NULL
, NULL
, 0, NULL
);
2943 cleanup
= make_cleanup (linespec_parser_delete
, &parser
);
2945 line_offset unknown_offset
= { 0, LINE_OFFSET_UNKNOWN
};
2949 convert_explicit_location_to_linespec (PARSER_STATE (&parser
),
2950 PARSER_RESULT (&parser
),
2953 func_name_match_type
,
2954 NULL
, unknown_offset
);
2956 CATCH (ex
, RETURN_MASK_ERROR
)
2958 do_cleanups (cleanup
);
2963 complete_label (tracker
, &parser
, label_name
);
2965 do_cleanups (cleanup
);
2968 /* See description in linespec.h. */
2971 linespec_complete (completion_tracker
&tracker
, const char *text
,
2972 symbol_name_match_type match_type
)
2974 linespec_parser parser
;
2975 struct cleanup
*cleanup
;
2976 const char *orig
= text
;
2978 linespec_parser_new (&parser
, 0, current_language
, NULL
, NULL
, 0, NULL
);
2979 cleanup
= make_cleanup (linespec_parser_delete
, &parser
);
2980 parser
.lexer
.saved_arg
= text
;
2981 PARSER_EXPLICIT (&parser
)->func_name_match_type
= match_type
;
2982 PARSER_STREAM (&parser
) = text
;
2984 parser
.completion_tracker
= &tracker
;
2985 PARSER_STATE (&parser
)->is_linespec
= 1;
2987 /* Parse as much as possible. parser.completion_word will hold
2988 furthest completion point we managed to parse to. */
2991 parse_linespec (&parser
, text
, match_type
);
2993 CATCH (except
, RETURN_MASK_ERROR
)
2998 if (parser
.completion_quote_char
!= '\0'
2999 && parser
.completion_quote_end
!= NULL
3000 && parser
.completion_quote_end
[1] == '\0')
3002 /* If completing a quoted string with the cursor right at
3003 terminating quote char, complete the completion word without
3004 interpretation, so that readline advances the cursor one
3005 whitespace past the quote, even if there's no match. This
3006 makes these cases behave the same:
3008 before: "b function()"
3009 after: "b function() "
3011 before: "b 'function()'"
3012 after: "b 'function()' "
3014 and trusts the user in this case:
3016 before: "b 'not_loaded_function_yet()'"
3017 after: "b 'not_loaded_function_yet()' "
3019 parser
.complete_what
= linespec_complete_what::NOTHING
;
3020 parser
.completion_quote_char
= '\0';
3022 gdb::unique_xmalloc_ptr
<char> text_copy
3023 (xstrdup (parser
.completion_word
));
3024 tracker
.add_completion (std::move (text_copy
));
3027 tracker
.set_quote_char (parser
.completion_quote_char
);
3029 if (parser
.complete_what
== linespec_complete_what::LABEL
)
3031 parser
.complete_what
= linespec_complete_what::NOTHING
;
3033 const char *func_name
= PARSER_EXPLICIT (&parser
)->function_name
;
3035 std::vector
<symbol
*> function_symbols
;
3036 std::vector
<bound_minimal_symbol
> minimal_symbols
;
3037 find_linespec_symbols (PARSER_STATE (&parser
),
3038 PARSER_RESULT (&parser
)->file_symtabs
,
3039 func_name
, match_type
,
3040 &function_symbols
, &minimal_symbols
);
3042 PARSER_RESULT (&parser
)->function_symbols
3043 = new std::vector
<symbol
*> (std::move (function_symbols
));
3044 PARSER_RESULT (&parser
)->minimal_symbols
3045 = new std::vector
<bound_minimal_symbol
> (std::move (minimal_symbols
));
3047 complete_label (tracker
, &parser
, parser
.completion_word
);
3049 else if (parser
.complete_what
== linespec_complete_what::FUNCTION
)
3051 /* While parsing/lexing, we didn't know whether the completion
3052 word completes to a unique function/source name already or
3056 "b function() <tab>"
3057 may need to complete either to:
3058 "b function() const"
3060 "b function() if/thread/task"
3064 may need to complete either to:
3065 "b foo template_fun<T>()"
3066 with "foo" being the template function's return type, or to:
3071 may need to complete either to a source file name:
3073 or this, also a filename, but a unique completion:
3075 or to a function name:
3078 Address that by completing assuming source or function, and
3079 seeing if we find a completion that matches exactly the
3080 completion word. If so, then it must be a function (see note
3081 below) and we advance the completion word to the end of input
3082 and switch to KEYWORD completion mode.
3084 Note: if we find a unique completion for a source filename,
3085 then it won't match the completion word, because the LCD will
3086 contain a trailing ':'. And if we're completing at or after
3087 the ':', then complete_linespec_component won't try to
3088 complete on source filenames. */
3090 const char *word
= parser
.completion_word
;
3092 complete_linespec_component (&parser
, tracker
,
3093 parser
.completion_word
,
3094 linespec_complete_what::FUNCTION
,
3095 PARSER_EXPLICIT (&parser
)->source_filename
);
3097 parser
.complete_what
= linespec_complete_what::NOTHING
;
3099 if (tracker
.quote_char ())
3101 /* The function/file name was not close-quoted, so this
3102 can't be a keyword. Note: complete_linespec_component
3103 may have swapped the original quote char for ':' when we
3104 get here, but that still indicates the same. */
3106 else if (!tracker
.have_completions ())
3109 size_t wordlen
= strlen (parser
.completion_word
);
3112 = string_find_incomplete_keyword_at_end (linespec_keywords
,
3113 parser
.completion_word
,
3118 && parser
.completion_word
[wordlen
- 1] == ' '))
3120 parser
.completion_word
+= key_start
;
3121 parser
.complete_what
= linespec_complete_what::KEYWORD
;
3124 else if (tracker
.completes_to_completion_word (word
))
3126 /* Skip the function and complete on keywords. */
3127 parser
.completion_word
+= strlen (word
);
3128 parser
.complete_what
= linespec_complete_what::KEYWORD
;
3129 tracker
.discard_completions ();
3133 tracker
.advance_custom_word_point_by (parser
.completion_word
- orig
);
3135 complete_linespec_component (&parser
, tracker
,
3136 parser
.completion_word
,
3137 parser
.complete_what
,
3138 PARSER_EXPLICIT (&parser
)->source_filename
);
3140 /* If we're past the "filename:function:label:offset" linespec, and
3141 didn't find any match, then assume the user might want to create
3142 a pending breakpoint anyway and offer the keyword
3144 if (!parser
.completion_quote_char
3145 && (parser
.complete_what
== linespec_complete_what::FUNCTION
3146 || parser
.complete_what
== linespec_complete_what::LABEL
3147 || parser
.complete_what
== linespec_complete_what::NOTHING
)
3148 && !tracker
.have_completions ())
3151 = parser
.completion_word
+ strlen (parser
.completion_word
);
3153 if (end
> orig
&& end
[-1] == ' ')
3155 tracker
.advance_custom_word_point_by (end
- parser
.completion_word
);
3157 complete_linespec_component (&parser
, tracker
, end
,
3158 linespec_complete_what::KEYWORD
,
3163 do_cleanups (cleanup
);
3166 /* A helper function for decode_line_full and decode_line_1 to
3167 turn LOCATION into std::vector<symtab_and_line>. */
3169 static std::vector
<symtab_and_line
>
3170 event_location_to_sals (linespec_parser
*parser
,
3171 const struct event_location
*location
)
3173 std::vector
<symtab_and_line
> result
;
3175 switch (event_location_type (location
))
3177 case LINESPEC_LOCATION
:
3179 PARSER_STATE (parser
)->is_linespec
= 1;
3182 const linespec_location
*ls
= get_linespec_location (location
);
3183 result
= parse_linespec (parser
,
3184 ls
->spec_string
, ls
->match_type
);
3186 CATCH (except
, RETURN_MASK_ERROR
)
3188 throw_exception (except
);
3194 case ADDRESS_LOCATION
:
3196 const char *addr_string
= get_address_string_location (location
);
3197 CORE_ADDR addr
= get_address_location (location
);
3199 if (addr_string
!= NULL
)
3201 addr
= linespec_expression_to_pc (&addr_string
);
3202 if (PARSER_STATE (parser
)->canonical
!= NULL
)
3203 PARSER_STATE (parser
)->canonical
->location
3204 = copy_event_location (location
);
3207 result
= convert_address_location_to_sals (PARSER_STATE (parser
),
3212 case EXPLICIT_LOCATION
:
3214 const struct explicit_location
*explicit_loc
;
3216 explicit_loc
= get_explicit_location_const (location
);
3217 result
= convert_explicit_location_to_sals (PARSER_STATE (parser
),
3218 PARSER_RESULT (parser
),
3223 case PROBE_LOCATION
:
3224 /* Probes are handled by their own decoders. */
3225 gdb_assert_not_reached ("attempt to decode probe location");
3229 gdb_assert_not_reached ("unhandled event location type");
3235 /* See linespec.h. */
3238 decode_line_full (const struct event_location
*location
, int flags
,
3239 struct program_space
*search_pspace
,
3240 struct symtab
*default_symtab
,
3241 int default_line
, struct linespec_result
*canonical
,
3242 const char *select_mode
,
3245 struct cleanup
*cleanups
;
3246 std::vector
<const char *> filters
;
3247 linespec_parser parser
;
3248 struct linespec_state
*state
;
3250 gdb_assert (canonical
!= NULL
);
3251 /* The filter only makes sense for 'all'. */
3252 gdb_assert (filter
== NULL
|| select_mode
== multiple_symbols_all
);
3253 gdb_assert (select_mode
== NULL
3254 || select_mode
== multiple_symbols_all
3255 || select_mode
== multiple_symbols_ask
3256 || select_mode
== multiple_symbols_cancel
);
3257 gdb_assert ((flags
& DECODE_LINE_LIST_MODE
) == 0);
3259 linespec_parser_new (&parser
, flags
, current_language
,
3260 search_pspace
, default_symtab
,
3261 default_line
, canonical
);
3262 cleanups
= make_cleanup (linespec_parser_delete
, &parser
);
3264 scoped_restore_current_program_space restore_pspace
;
3266 std::vector
<symtab_and_line
> result
= event_location_to_sals (&parser
,
3268 state
= PARSER_STATE (&parser
);
3270 gdb_assert (result
.size () == 1 || canonical
->pre_expanded
);
3271 canonical
->pre_expanded
= 1;
3273 /* Arrange for allocated canonical names to be freed. */
3274 if (!result
.empty ())
3278 make_cleanup (xfree
, state
->canonical_names
);
3279 for (i
= 0; i
< result
.size (); ++i
)
3281 gdb_assert (state
->canonical_names
[i
].suffix
!= NULL
);
3282 make_cleanup (xfree
, state
->canonical_names
[i
].suffix
);
3286 if (select_mode
== NULL
)
3288 if (top_level_interpreter ()->interp_ui_out ()->is_mi_like_p ())
3289 select_mode
= multiple_symbols_all
;
3291 select_mode
= multiple_symbols_select_mode ();
3294 if (select_mode
== multiple_symbols_all
)
3298 filters
.push_back (filter
);
3299 filter_results (state
, &result
, filters
);
3302 convert_results_to_lsals (state
, &result
);
3305 decode_line_2 (state
, &result
, select_mode
);
3307 do_cleanups (cleanups
);
3310 /* See linespec.h. */
3312 std::vector
<symtab_and_line
>
3313 decode_line_1 (const struct event_location
*location
, int flags
,
3314 struct program_space
*search_pspace
,
3315 struct symtab
*default_symtab
,
3318 linespec_parser parser
;
3319 struct cleanup
*cleanups
;
3321 linespec_parser_new (&parser
, flags
, current_language
,
3322 search_pspace
, default_symtab
,
3323 default_line
, NULL
);
3324 cleanups
= make_cleanup (linespec_parser_delete
, &parser
);
3326 scoped_restore_current_program_space restore_pspace
;
3328 std::vector
<symtab_and_line
> result
= event_location_to_sals (&parser
,
3331 do_cleanups (cleanups
);
3335 /* See linespec.h. */
3337 std::vector
<symtab_and_line
>
3338 decode_line_with_current_source (const char *string
, int flags
)
3341 error (_("Empty line specification."));
3343 /* We use whatever is set as the current source line. We do not try
3344 and get a default source symtab+line or it will recursively call us! */
3345 symtab_and_line cursal
= get_current_source_symtab_and_line ();
3347 event_location_up location
= string_to_event_location (&string
,
3349 std::vector
<symtab_and_line
> sals
3350 = decode_line_1 (location
.get (), flags
, NULL
, cursal
.symtab
, cursal
.line
);
3353 error (_("Junk at end of line specification: %s"), string
);
3358 /* See linespec.h. */
3360 std::vector
<symtab_and_line
>
3361 decode_line_with_last_displayed (const char *string
, int flags
)
3364 error (_("Empty line specification."));
3366 event_location_up location
= string_to_event_location (&string
,
3368 std::vector
<symtab_and_line
> sals
3369 = (last_displayed_sal_is_valid ()
3370 ? decode_line_1 (location
.get (), flags
, NULL
,
3371 get_last_displayed_symtab (),
3372 get_last_displayed_line ())
3373 : decode_line_1 (location
.get (), flags
, NULL
,
3374 (struct symtab
*) NULL
, 0));
3377 error (_("Junk at end of line specification: %s"), string
);
3384 /* First, some functions to initialize stuff at the beggining of the
3388 initialize_defaults (struct symtab
**default_symtab
, int *default_line
)
3390 if (*default_symtab
== 0)
3392 /* Use whatever we have for the default source line. We don't use
3393 get_current_or_default_symtab_and_line as it can recurse and call
3395 struct symtab_and_line cursal
=
3396 get_current_source_symtab_and_line ();
3398 *default_symtab
= cursal
.symtab
;
3399 *default_line
= cursal
.line
;
3405 /* Evaluate the expression pointed to by EXP_PTR into a CORE_ADDR,
3406 advancing EXP_PTR past any parsed text. */
3409 linespec_expression_to_pc (const char **exp_ptr
)
3411 if (current_program_space
->executing_startup
)
3412 /* The error message doesn't really matter, because this case
3413 should only hit during breakpoint reset. */
3414 throw_error (NOT_FOUND_ERROR
, _("cannot evaluate expressions while "
3415 "program space is in startup"));
3418 return value_as_address (parse_to_comma_and_eval (exp_ptr
));
3423 /* Here's where we recognise an Objective-C Selector. An Objective C
3424 selector may be implemented by more than one class, therefore it
3425 may represent more than one method/function. This gives us a
3426 situation somewhat analogous to C++ overloading. If there's more
3427 than one method that could represent the selector, then use some of
3428 the existing C++ code to let the user choose one. */
3430 static std::vector
<symtab_and_line
>
3431 decode_objc (struct linespec_state
*self
, linespec_p ls
, const char *arg
)
3433 struct collect_info info
;
3434 std::vector
<const char *> symbol_names
;
3435 const char *new_argptr
;
3438 std::vector
<symtab
*> symtabs
;
3439 symtabs
.push_back (nullptr);
3441 info
.file_symtabs
= &symtabs
;
3443 std::vector
<symbol
*> symbols
;
3444 info
.result
.symbols
= &symbols
;
3445 std::vector
<bound_minimal_symbol
> minimal_symbols
;
3446 info
.result
.minimal_symbols
= &minimal_symbols
;
3448 new_argptr
= find_imps (arg
, &symbol_names
);
3449 if (symbol_names
.empty ())
3452 add_all_symbol_names_from_pspace (&info
, NULL
, symbol_names
,
3455 std::vector
<symtab_and_line
> values
;
3456 if (!symbols
.empty () || !minimal_symbols
.empty ())
3460 saved_arg
= (char *) alloca (new_argptr
- arg
+ 1);
3461 memcpy (saved_arg
, arg
, new_argptr
- arg
);
3462 saved_arg
[new_argptr
- arg
] = '\0';
3464 ls
->explicit_loc
.function_name
= xstrdup (saved_arg
);
3465 ls
->function_symbols
= new std::vector
<symbol
*> (std::move (symbols
));
3467 = new std::vector
<bound_minimal_symbol
> (std::move (minimal_symbols
));
3468 values
= convert_linespec_to_sals (self
, ls
);
3470 if (self
->canonical
)
3475 self
->canonical
->pre_expanded
= 1;
3477 if (ls
->explicit_loc
.source_filename
)
3479 holder
= string_printf ("%s:%s",
3480 ls
->explicit_loc
.source_filename
,
3482 str
= holder
.c_str ();
3487 self
->canonical
->location
3488 = new_linespec_location (&str
, symbol_name_match_type::FULL
);
3497 /* A function object that serves as symbol_found_callback_ftype
3498 callback for iterate_over_symbols. This is used by
3499 lookup_prefix_sym to collect type symbols. */
3500 class decode_compound_collector
3503 decode_compound_collector ()
3506 m_unique_syms
= htab_create_alloc (1, htab_hash_pointer
,
3507 htab_eq_pointer
, NULL
,
3511 ~decode_compound_collector ()
3513 if (m_unique_syms
!= NULL
)
3514 htab_delete (m_unique_syms
);
3517 /* Releases ownership of the collected symbols and returns them. */
3518 VEC (symbolp
) *release_symbols ()
3520 VEC (symbolp
) *res
= m_symbols
;
3525 /* Callable as a symbol_found_callback_ftype callback. */
3526 bool operator () (symbol
*sym
);
3529 /* A hash table of all symbols we found. We use this to avoid
3530 adding any symbol more than once. */
3531 htab_t m_unique_syms
;
3533 /* The result vector. */
3534 VEC (symbolp
) *m_symbols
;
3538 decode_compound_collector::operator () (symbol
*sym
)
3543 if (SYMBOL_CLASS (sym
) != LOC_TYPEDEF
)
3544 return true; /* Continue iterating. */
3546 t
= SYMBOL_TYPE (sym
);
3547 t
= check_typedef (t
);
3548 if (TYPE_CODE (t
) != TYPE_CODE_STRUCT
3549 && TYPE_CODE (t
) != TYPE_CODE_UNION
3550 && TYPE_CODE (t
) != TYPE_CODE_NAMESPACE
)
3551 return true; /* Continue iterating. */
3553 slot
= htab_find_slot (m_unique_syms
, sym
, INSERT
);
3557 VEC_safe_push (symbolp
, m_symbols
, sym
);
3560 return true; /* Continue iterating. */
3565 /* Return any symbols corresponding to CLASS_NAME in FILE_SYMTABS. */
3567 static VEC (symbolp
) *
3568 lookup_prefix_sym (struct linespec_state
*state
,
3569 std::vector
<symtab
*> *file_symtabs
,
3570 const char *class_name
)
3572 decode_compound_collector collector
;
3574 lookup_name_info
lookup_name (class_name
, symbol_name_match_type::FULL
);
3576 for (const auto &elt
: *file_symtabs
)
3580 iterate_over_all_matching_symtabs (state
, lookup_name
,
3581 STRUCT_DOMAIN
, ALL_DOMAIN
,
3582 NULL
, false, collector
);
3583 iterate_over_all_matching_symtabs (state
, lookup_name
,
3584 VAR_DOMAIN
, ALL_DOMAIN
,
3585 NULL
, false, collector
);
3589 /* Program spaces that are executing startup should have
3590 been filtered out earlier. */
3591 gdb_assert (!SYMTAB_PSPACE (elt
)->executing_startup
);
3592 set_current_program_space (SYMTAB_PSPACE (elt
));
3593 iterate_over_file_blocks (elt
, lookup_name
, STRUCT_DOMAIN
, collector
);
3594 iterate_over_file_blocks (elt
, lookup_name
, VAR_DOMAIN
, collector
);
3598 return collector
.release_symbols ();
3601 /* A std::sort comparison function for symbols. The resulting order does
3602 not actually matter; we just need to be able to sort them so that
3603 symbols with the same program space end up next to each other. */
3606 std_compare_symbols (const struct symbol
*a
, const struct symbol
*b
)
3610 uia
= (uintptr_t) SYMTAB_PSPACE (symbol_symtab (a
));
3611 uib
= (uintptr_t) SYMTAB_PSPACE (symbol_symtab (b
));
3618 uia
= (uintptr_t) a
;
3619 uib
= (uintptr_t) b
;
3627 /* A qsort comparison function for symbols. The resulting order does
3628 not actually matter; we just need to be able to sort them so that
3629 symbols with the same program space end up next to each other. */
3632 compare_symbols (const void *a
, const void *b
)
3634 struct symbol
* const *sa
= (struct symbol
* const*) a
;
3635 struct symbol
* const *sb
= (struct symbol
* const*) b
;
3638 uia
= (uintptr_t) SYMTAB_PSPACE (symbol_symtab (*sa
));
3639 uib
= (uintptr_t) SYMTAB_PSPACE (symbol_symtab (*sb
));
3646 uia
= (uintptr_t) *sa
;
3647 uib
= (uintptr_t) *sb
;
3657 /* Like compare_symbols but for minimal symbols. */
3660 compare_msymbols (const bound_minimal_symbol
&a
, const bound_minimal_symbol
&b
)
3664 uia
= (uintptr_t) a
.objfile
->pspace
;
3665 uib
= (uintptr_t) a
.objfile
->pspace
;
3672 uia
= (uintptr_t) a
.minsym
;
3673 uib
= (uintptr_t) b
.minsym
;
3681 /* Look for all the matching instances of each symbol in NAMES. Only
3682 instances from PSPACE are considered; other program spaces are
3683 handled by our caller. If PSPACE is NULL, then all program spaces
3684 are considered. Results are stored into INFO. */
3687 add_all_symbol_names_from_pspace (struct collect_info
*info
,
3688 struct program_space
*pspace
,
3689 const std::vector
<const char *> &names
,
3690 enum search_domain search_domain
)
3692 for (const char *iter
: names
)
3693 add_matching_symbols_to_info (iter
,
3694 symbol_name_match_type::FULL
,
3695 search_domain
, info
, pspace
);
3699 find_superclass_methods (std::vector
<struct type
*> &&superclasses
,
3700 const char *name
, enum language name_lang
,
3701 std::vector
<const char *> *result_names
)
3703 size_t old_len
= result_names
->size ();
3707 std::vector
<struct type
*> new_supers
;
3709 for (type
*t
: superclasses
)
3710 find_methods (t
, name_lang
, name
, result_names
, &new_supers
);
3712 if (result_names
->size () != old_len
|| new_supers
.empty ())
3715 superclasses
= std::move (new_supers
);
3719 /* This finds the method METHOD_NAME in the class CLASS_NAME whose type is
3720 given by one of the symbols in SYM_CLASSES. Matches are returned
3721 in SYMBOLS (for debug symbols) and MINSYMS (for minimal symbols). */
3724 find_method (struct linespec_state
*self
, std::vector
<symtab
*> *file_symtabs
,
3725 const char *class_name
, const char *method_name
,
3726 VEC (symbolp
) *sym_classes
, std::vector
<symbol
*> *symbols
,
3727 std::vector
<bound_minimal_symbol
> *minsyms
)
3731 size_t last_result_len
;
3732 std::vector
<struct type
*> superclass_vec
;
3733 std::vector
<const char *> result_names
;
3734 struct collect_info info
;
3736 /* Sort symbols so that symbols with the same program space are next
3738 qsort (VEC_address (symbolp
, sym_classes
),
3739 VEC_length (symbolp
, sym_classes
),
3744 info
.file_symtabs
= file_symtabs
;
3745 info
.result
.symbols
= symbols
;
3746 info
.result
.minimal_symbols
= minsyms
;
3748 /* Iterate over all the types, looking for the names of existing
3749 methods matching METHOD_NAME. If we cannot find a direct method in a
3750 given program space, then we consider inherited methods; this is
3751 not ideal (ideal would be to respect C++ hiding rules), but it
3752 seems good enough and is what GDB has historically done. We only
3753 need to collect the names because later we find all symbols with
3754 those names. This loop is written in a somewhat funny way
3755 because we collect data across the program space before deciding
3757 last_result_len
= 0;
3758 for (ix
= 0; VEC_iterate (symbolp
, sym_classes
, ix
, sym
); ++ix
)
3761 struct program_space
*pspace
;
3763 /* Program spaces that are executing startup should have
3764 been filtered out earlier. */
3765 pspace
= SYMTAB_PSPACE (symbol_symtab (sym
));
3766 gdb_assert (!pspace
->executing_startup
);
3767 set_current_program_space (pspace
);
3768 t
= check_typedef (SYMBOL_TYPE (sym
));
3769 find_methods (t
, SYMBOL_LANGUAGE (sym
),
3770 method_name
, &result_names
, &superclass_vec
);
3772 /* Handle all items from a single program space at once; and be
3773 sure not to miss the last batch. */
3774 if (ix
== VEC_length (symbolp
, sym_classes
) - 1
3776 != SYMTAB_PSPACE (symbol_symtab (VEC_index (symbolp
, sym_classes
,
3779 /* If we did not find a direct implementation anywhere in
3780 this program space, consider superclasses. */
3781 if (result_names
.size () == last_result_len
)
3782 find_superclass_methods (std::move (superclass_vec
), method_name
,
3783 SYMBOL_LANGUAGE (sym
), &result_names
);
3785 /* We have a list of candidate symbol names, so now we
3786 iterate over the symbol tables looking for all
3787 matches in this pspace. */
3788 add_all_symbol_names_from_pspace (&info
, pspace
, result_names
,
3791 superclass_vec
.clear ();
3792 last_result_len
= result_names
.size ();
3796 if (!symbols
->empty () || !minsyms
->empty ())
3799 /* Throw an NOT_FOUND_ERROR. This will be caught by the caller
3800 and other attempts to locate the symbol will be made. */
3801 throw_error (NOT_FOUND_ERROR
, _("see caller, this text doesn't matter"));
3808 /* This function object is a callback for iterate_over_symtabs, used
3809 when collecting all matching symtabs. */
3811 class symtab_collector
3815 : m_symtabs (new std::vector
<symtab
*> ())
3817 m_symtab_table
= htab_create (1, htab_hash_pointer
, htab_eq_pointer
,
3821 ~symtab_collector ()
3823 if (m_symtab_table
!= NULL
)
3824 htab_delete (m_symtab_table
);
3827 /* Callable as a symbol_found_callback_ftype callback. */
3828 bool operator () (symtab
*sym
);
3830 /* Releases ownership of the collected symtabs and returns them. */
3831 symtab_vector_up
release_symtabs ()
3833 return std::move (m_symtabs
);
3837 /* The result vector of symtabs. */
3838 symtab_vector_up m_symtabs
;
3840 /* This is used to ensure the symtabs are unique. */
3841 htab_t m_symtab_table
;
3845 symtab_collector::operator () (struct symtab
*symtab
)
3849 slot
= htab_find_slot (m_symtab_table
, symtab
, INSERT
);
3853 m_symtabs
->push_back (symtab
);
3861 /* Given a file name, return a list of all matching symtabs. If
3862 SEARCH_PSPACE is not NULL, the search is restricted to just that
3865 static symtab_vector_up
3866 collect_symtabs_from_filename (const char *file
,
3867 struct program_space
*search_pspace
)
3869 symtab_collector collector
;
3871 /* Find that file's data. */
3872 if (search_pspace
== NULL
)
3874 struct program_space
*pspace
;
3876 ALL_PSPACES (pspace
)
3878 if (pspace
->executing_startup
)
3881 set_current_program_space (pspace
);
3882 iterate_over_symtabs (file
, collector
);
3887 set_current_program_space (search_pspace
);
3888 iterate_over_symtabs (file
, collector
);
3891 return collector
.release_symtabs ();
3894 /* Return all the symtabs associated to the FILENAME. If SEARCH_PSPACE is
3895 not NULL, the search is restricted to just that program space. */
3897 static symtab_vector_up
3898 symtabs_from_filename (const char *filename
,
3899 struct program_space
*search_pspace
)
3901 symtab_vector_up result
3902 = collect_symtabs_from_filename (filename
, search_pspace
);
3904 if (result
->empty ())
3906 if (!have_full_symbols () && !have_partial_symbols ())
3907 throw_error (NOT_FOUND_ERROR
,
3908 _("No symbol table is loaded. "
3909 "Use the \"file\" command."));
3910 source_file_not_found_error (filename
);
3916 /* Look up a function symbol named NAME in symtabs FILE_SYMTABS. Matching
3917 debug symbols are returned in SYMBOLS. Matching minimal symbols are
3918 returned in MINSYMS. */
3921 find_function_symbols (struct linespec_state
*state
,
3922 std::vector
<symtab
*> *file_symtabs
, const char *name
,
3923 symbol_name_match_type name_match_type
,
3924 std::vector
<symbol
*> *symbols
,
3925 std::vector
<bound_minimal_symbol
> *minsyms
)
3927 struct collect_info info
;
3928 std::vector
<const char *> symbol_names
;
3931 info
.result
.symbols
= symbols
;
3932 info
.result
.minimal_symbols
= minsyms
;
3933 info
.file_symtabs
= file_symtabs
;
3935 /* Try NAME as an Objective-C selector. */
3936 find_imps (name
, &symbol_names
);
3937 if (!symbol_names
.empty ())
3938 add_all_symbol_names_from_pspace (&info
, state
->search_pspace
,
3939 symbol_names
, FUNCTIONS_DOMAIN
);
3941 add_matching_symbols_to_info (name
, name_match_type
, FUNCTIONS_DOMAIN
,
3942 &info
, state
->search_pspace
);
3945 /* Find all symbols named NAME in FILE_SYMTABS, returning debug symbols
3946 in SYMBOLS and minimal symbols in MINSYMS. */
3949 find_linespec_symbols (struct linespec_state
*state
,
3950 std::vector
<symtab
*> *file_symtabs
,
3951 const char *lookup_name
,
3952 symbol_name_match_type name_match_type
,
3953 std::vector
<symbol
*> *symbols
,
3954 std::vector
<bound_minimal_symbol
> *minsyms
)
3956 std::string canon
= cp_canonicalize_string_no_typedefs (lookup_name
);
3957 if (!canon
.empty ())
3958 lookup_name
= canon
.c_str ();
3960 /* It's important to not call expand_symtabs_matching unnecessarily
3961 as it can really slow things down (by unnecessarily expanding
3962 potentially 1000s of symtabs, which when debugging some apps can
3963 cost 100s of seconds). Avoid this to some extent by *first* calling
3964 find_function_symbols, and only if that doesn't find anything
3965 *then* call find_method. This handles two important cases:
3966 1) break (anonymous namespace)::foo
3967 2) break class::method where method is in class (and not a baseclass) */
3969 find_function_symbols (state
, file_symtabs
, lookup_name
,
3970 name_match_type
, symbols
, minsyms
);
3972 /* If we were unable to locate a symbol of the same name, try dividing
3973 the name into class and method names and searching the class and its
3975 if (symbols
->empty () && minsyms
->empty ())
3977 std::string klass
, method
;
3978 const char *last
, *p
, *scope_op
;
3979 VEC (symbolp
) *classes
;
3981 /* See if we can find a scope operator and break this symbol
3982 name into namespaces${SCOPE_OPERATOR}class_name and method_name. */
3984 p
= find_toplevel_string (lookup_name
, scope_op
);
3990 p
= find_toplevel_string (p
+ strlen (scope_op
), scope_op
);
3993 /* If no scope operator was found, there is nothing more we can do;
3994 we already attempted to lookup the entire name as a symbol
3999 /* LOOKUP_NAME points to the class name.
4000 LAST points to the method name. */
4001 klass
= std::string (lookup_name
, last
- lookup_name
);
4003 /* Skip past the scope operator. */
4004 last
+= strlen (scope_op
);
4007 /* Find a list of classes named KLASS. */
4008 classes
= lookup_prefix_sym (state
, file_symtabs
, klass
.c_str ());
4009 struct cleanup
*old_chain
4010 = make_cleanup (VEC_cleanup (symbolp
), &classes
);
4012 if (!VEC_empty (symbolp
, classes
))
4014 /* Now locate a list of suitable methods named METHOD. */
4017 find_method (state
, file_symtabs
,
4018 klass
.c_str (), method
.c_str (),
4019 classes
, symbols
, minsyms
);
4022 /* If successful, we're done. If NOT_FOUND_ERROR
4023 was not thrown, rethrow the exception that we did get. */
4024 CATCH (except
, RETURN_MASK_ERROR
)
4026 if (except
.error
!= NOT_FOUND_ERROR
)
4027 throw_exception (except
);
4032 do_cleanups (old_chain
);
4036 /* Helper for find_label_symbols. Find all labels that match name
4037 NAME in BLOCK. Return all labels that match in FUNCTION_SYMBOLS.
4038 Return the actual function symbol in which the label was found in
4039 LABEL_FUNC_RET. If COMPLETION_MODE is true, then NAME is
4040 interpreted as a label name prefix. Otherwise, only a label named
4041 exactly NAME match. */
4044 find_label_symbols_in_block (const struct block
*block
,
4045 const char *name
, struct symbol
*fn_sym
,
4046 bool completion_mode
,
4047 std::vector
<symbol
*> *result
,
4048 std::vector
<symbol
*> *label_funcs_ret
)
4050 if (completion_mode
)
4052 struct block_iterator iter
;
4054 size_t name_len
= strlen (name
);
4056 int (*cmp
) (const char *, const char *, size_t);
4057 cmp
= case_sensitivity
== case_sensitive_on
? strncmp
: strncasecmp
;
4059 ALL_BLOCK_SYMBOLS (block
, iter
, sym
)
4061 if (symbol_matches_domain (SYMBOL_LANGUAGE (sym
),
4062 SYMBOL_DOMAIN (sym
), LABEL_DOMAIN
)
4063 && cmp (SYMBOL_SEARCH_NAME (sym
), name
, name_len
) == 0)
4065 result
->push_back (sym
);
4066 label_funcs_ret
->push_back (fn_sym
);
4072 struct symbol
*sym
= lookup_symbol (name
, block
, LABEL_DOMAIN
, 0).symbol
;
4076 result
->push_back (sym
);
4077 label_funcs_ret
->push_back (fn_sym
);
4082 /* Return all labels that match name NAME in FUNCTION_SYMBOLS or NULL
4083 if no matches were found.
4085 Return the actual function symbol in which the label was found in
4086 LABEL_FUNC_RET. If COMPLETION_MODE is true, then NAME is
4087 interpreted as a label name prefix. Otherwise, only labels named
4088 exactly NAME match. */
4090 static std::vector
<symbol
*> *
4091 find_label_symbols (struct linespec_state
*self
,
4092 std::vector
<symbol
*> *function_symbols
,
4093 std::vector
<symbol
*> *label_funcs_ret
, const char *name
,
4094 bool completion_mode
)
4096 const struct block
*block
;
4097 struct symbol
*fn_sym
;
4098 std::vector
<symbol
*> result
;
4100 if (function_symbols
== NULL
)
4102 set_current_program_space (self
->program_space
);
4103 block
= get_current_search_block ();
4106 block
&& !BLOCK_FUNCTION (block
);
4107 block
= BLOCK_SUPERBLOCK (block
))
4111 fn_sym
= BLOCK_FUNCTION (block
);
4113 find_label_symbols_in_block (block
, name
, fn_sym
, completion_mode
,
4114 &result
, label_funcs_ret
);
4118 for (const auto &elt
: *function_symbols
)
4120 set_current_program_space (SYMTAB_PSPACE (symbol_symtab (elt
)));
4121 block
= SYMBOL_BLOCK_VALUE (elt
);
4123 find_label_symbols_in_block (block
, name
, elt
, completion_mode
,
4124 &result
, label_funcs_ret
);
4128 if (!result
.empty ())
4129 return new std::vector
<symbol
*> (std::move (result
));
4135 /* A helper for create_sals_line_offset that handles the 'list_mode' case. */
4137 static std::vector
<symtab_and_line
>
4138 decode_digits_list_mode (struct linespec_state
*self
,
4140 struct symtab_and_line val
)
4142 gdb_assert (self
->list_mode
);
4144 std::vector
<symtab_and_line
> values
;
4146 for (const auto &elt
: *ls
->file_symtabs
)
4148 /* The logic above should ensure this. */
4149 gdb_assert (elt
!= NULL
);
4151 set_current_program_space (SYMTAB_PSPACE (elt
));
4153 /* Simplistic search just for the list command. */
4154 val
.symtab
= find_line_symtab (elt
, val
.line
, NULL
, NULL
);
4155 if (val
.symtab
== NULL
)
4157 val
.pspace
= SYMTAB_PSPACE (elt
);
4159 val
.explicit_line
= 1;
4161 add_sal_to_sals (self
, &values
, &val
, NULL
, 0);
4167 /* A helper for create_sals_line_offset that iterates over the symtabs,
4168 adding lines to the VEC. */
4170 static std::vector
<symtab_and_line
>
4171 decode_digits_ordinary (struct linespec_state
*self
,
4174 struct linetable_entry
**best_entry
)
4176 std::vector
<symtab_and_line
> sals
;
4177 for (const auto &elt
: *ls
->file_symtabs
)
4179 std::vector
<CORE_ADDR
> pcs
;
4181 /* The logic above should ensure this. */
4182 gdb_assert (elt
!= NULL
);
4184 set_current_program_space (SYMTAB_PSPACE (elt
));
4186 pcs
= find_pcs_for_symtab_line (elt
, line
, best_entry
);
4187 for (CORE_ADDR pc
: pcs
)
4189 symtab_and_line sal
;
4190 sal
.pspace
= SYMTAB_PSPACE (elt
);
4194 sals
.push_back (std::move (sal
));
4203 /* Return the line offset represented by VARIABLE. */
4205 static struct line_offset
4206 linespec_parse_variable (struct linespec_state
*self
, const char *variable
)
4210 struct line_offset offset
= {0, LINE_OFFSET_NONE
};
4212 p
= (variable
[1] == '$') ? variable
+ 2 : variable
+ 1;
4215 while (*p
>= '0' && *p
<= '9')
4217 if (!*p
) /* Reached end of token without hitting non-digit. */
4219 /* We have a value history reference. */
4220 struct value
*val_history
;
4222 sscanf ((variable
[1] == '$') ? variable
+ 2 : variable
+ 1, "%d", &index
);
4224 = access_value_history ((variable
[1] == '$') ? -index
: index
);
4225 if (TYPE_CODE (value_type (val_history
)) != TYPE_CODE_INT
)
4226 error (_("History values used in line "
4227 "specs must have integer values."));
4228 offset
.offset
= value_as_long (val_history
);
4232 /* Not all digits -- may be user variable/function or a
4233 convenience variable. */
4235 struct internalvar
*ivar
;
4237 /* Try it as a convenience variable. If it is not a convenience
4238 variable, return and allow normal symbol lookup to occur. */
4239 ivar
= lookup_only_internalvar (variable
+ 1);
4241 /* No internal variable with that name. Mark the offset
4242 as unknown to allow the name to be looked up as a symbol. */
4243 offset
.sign
= LINE_OFFSET_UNKNOWN
;
4246 /* We found a valid variable name. If it is not an integer,
4248 if (!get_internalvar_integer (ivar
, &valx
))
4249 error (_("Convenience variables used in line "
4250 "specs must have integer values."));
4252 offset
.offset
= valx
;
4260 /* We've found a minimal symbol MSYMBOL in OBJFILE to associate with our
4261 linespec; return the SAL in RESULT. This function should return SALs
4262 matching those from find_function_start_sal, otherwise false
4263 multiple-locations breakpoints could be placed. */
4266 minsym_found (struct linespec_state
*self
, struct objfile
*objfile
,
4267 struct minimal_symbol
*msymbol
,
4268 std::vector
<symtab_and_line
> *result
)
4270 bool want_start_sal
;
4272 CORE_ADDR func_addr
;
4273 bool is_function
= msymbol_is_function (objfile
, msymbol
, &func_addr
);
4277 const char *msym_name
= MSYMBOL_LINKAGE_NAME (msymbol
);
4279 if (MSYMBOL_TYPE (msymbol
) == mst_text_gnu_ifunc
4280 || MSYMBOL_TYPE (msymbol
) == mst_data_gnu_ifunc
)
4281 want_start_sal
= gnu_ifunc_resolve_name (msym_name
, &func_addr
);
4283 want_start_sal
= true;
4286 symtab_and_line sal
;
4288 if (is_function
&& want_start_sal
)
4289 sal
= find_function_start_sal (func_addr
, NULL
, self
->funfirstline
);
4292 sal
.objfile
= objfile
;
4293 sal
.msymbol
= msymbol
;
4294 /* Store func_addr, not the minsym's address in case this was an
4295 ifunc that hasn't been resolved yet. */
4299 sal
.pc
= MSYMBOL_VALUE_ADDRESS (objfile
, msymbol
);
4300 sal
.pspace
= current_program_space
;
4303 sal
.section
= MSYMBOL_OBJ_SECTION (objfile
, msymbol
);
4305 if (maybe_add_address (self
->addr_set
, objfile
->pspace
, sal
.pc
))
4306 add_sal_to_sals (self
, result
, &sal
, MSYMBOL_NATURAL_NAME (msymbol
), 0);
4309 /* A helper function to classify a minimal_symbol_type according to
4313 classify_mtype (enum minimal_symbol_type t
)
4320 /* Intermediate priority. */
4323 case mst_solib_trampoline
:
4324 /* Lowest priority. */
4328 /* Highest priority. */
4333 /* Callback for std::sort that sorts symbols by priority. */
4336 compare_msyms (const bound_minimal_symbol
&a
, const bound_minimal_symbol
&b
)
4338 enum minimal_symbol_type ta
= MSYMBOL_TYPE (a
.minsym
);
4339 enum minimal_symbol_type tb
= MSYMBOL_TYPE (b
.minsym
);
4341 return classify_mtype (ta
) < classify_mtype (tb
);
4344 /* Helper for search_minsyms_for_name that adds the symbol to the
4348 add_minsym (struct minimal_symbol
*minsym
, struct objfile
*objfile
,
4349 struct symtab
*symtab
, int list_mode
,
4350 std::vector
<struct bound_minimal_symbol
> *msyms
)
4354 /* We're looking for a label for which we don't have debug
4356 CORE_ADDR func_addr
;
4357 if (msymbol_is_function (objfile
, minsym
, &func_addr
))
4359 symtab_and_line sal
= find_pc_sect_line (func_addr
, NULL
, 0);
4361 if (symtab
!= sal
.symtab
)
4366 /* Exclude data symbols when looking for breakpoint locations. */
4367 if (!list_mode
&& !msymbol_is_function (objfile
, minsym
))
4370 struct bound_minimal_symbol mo
= {minsym
, objfile
};
4371 msyms
->push_back (mo
);
4375 /* Search for minimal symbols called NAME. If SEARCH_PSPACE
4376 is not NULL, the search is restricted to just that program
4379 If SYMTAB is NULL, search all objfiles, otherwise
4380 restrict results to the given SYMTAB. */
4383 search_minsyms_for_name (struct collect_info
*info
,
4384 const lookup_name_info
&name
,
4385 struct program_space
*search_pspace
,
4386 struct symtab
*symtab
)
4388 std::vector
<struct bound_minimal_symbol
> minsyms
;
4392 struct program_space
*pspace
;
4394 ALL_PSPACES (pspace
)
4396 struct objfile
*objfile
;
4398 if (search_pspace
!= NULL
&& search_pspace
!= pspace
)
4400 if (pspace
->executing_startup
)
4403 set_current_program_space (pspace
);
4405 ALL_OBJFILES (objfile
)
4407 iterate_over_minimal_symbols (objfile
, name
,
4408 [&] (struct minimal_symbol
*msym
)
4410 add_minsym (msym
, objfile
, nullptr,
4411 info
->state
->list_mode
,
4420 if (search_pspace
== NULL
|| SYMTAB_PSPACE (symtab
) == search_pspace
)
4422 set_current_program_space (SYMTAB_PSPACE (symtab
));
4423 iterate_over_minimal_symbols
4424 (SYMTAB_OBJFILE (symtab
), name
,
4425 [&] (struct minimal_symbol
*msym
)
4427 add_minsym (msym
, SYMTAB_OBJFILE (symtab
), symtab
,
4428 info
->state
->list_mode
, &minsyms
);
4434 if (!minsyms
.empty ())
4438 std::sort (minsyms
.begin (), minsyms
.end (), compare_msyms
);
4440 /* Now the minsyms are in classification order. So, we walk
4441 over them and process just the minsyms with the same
4442 classification as the very first minsym in the list. */
4443 classification
= classify_mtype (MSYMBOL_TYPE (minsyms
[0].minsym
));
4445 for (const bound_minimal_symbol
&item
: minsyms
)
4447 if (classify_mtype (MSYMBOL_TYPE (item
.minsym
)) != classification
)
4450 info
->result
.minimal_symbols
->push_back (item
);
4455 /* A helper function to add all symbols matching NAME to INFO. If
4456 PSPACE is not NULL, the search is restricted to just that program
4460 add_matching_symbols_to_info (const char *name
,
4461 symbol_name_match_type name_match_type
,
4462 enum search_domain search_domain
,
4463 struct collect_info
*info
,
4464 struct program_space
*pspace
)
4466 lookup_name_info
lookup_name (name
, name_match_type
);
4468 for (const auto &elt
: *info
->file_symtabs
)
4472 iterate_over_all_matching_symtabs (info
->state
, lookup_name
,
4473 VAR_DOMAIN
, search_domain
,
4474 pspace
, true, [&] (symbol
*sym
)
4475 { return info
->add_symbol (sym
); });
4476 search_minsyms_for_name (info
, lookup_name
, pspace
, NULL
);
4478 else if (pspace
== NULL
|| pspace
== SYMTAB_PSPACE (elt
))
4480 int prev_len
= info
->result
.symbols
->size ();
4482 /* Program spaces that are executing startup should have
4483 been filtered out earlier. */
4484 gdb_assert (!SYMTAB_PSPACE (elt
)->executing_startup
);
4485 set_current_program_space (SYMTAB_PSPACE (elt
));
4486 iterate_over_file_blocks (elt
, lookup_name
, VAR_DOMAIN
,
4488 { return info
->add_symbol (sym
); });
4490 /* If no new symbols were found in this iteration and this symtab
4491 is in assembler, we might actually be looking for a label for
4492 which we don't have debug info. Check for a minimal symbol in
4494 if (prev_len
== info
->result
.symbols
->size ()
4495 && elt
->language
== language_asm
)
4496 search_minsyms_for_name (info
, lookup_name
, pspace
, elt
);
4503 /* Now come some functions that are called from multiple places within
4507 symbol_to_sal (struct symtab_and_line
*result
,
4508 int funfirstline
, struct symbol
*sym
)
4510 if (SYMBOL_CLASS (sym
) == LOC_BLOCK
)
4512 *result
= find_function_start_sal (sym
, funfirstline
);
4517 if (SYMBOL_CLASS (sym
) == LOC_LABEL
&& SYMBOL_VALUE_ADDRESS (sym
) != 0)
4520 result
->symtab
= symbol_symtab (sym
);
4521 result
->symbol
= sym
;
4522 result
->line
= SYMBOL_LINE (sym
);
4523 result
->pc
= SYMBOL_VALUE_ADDRESS (sym
);
4524 result
->pspace
= SYMTAB_PSPACE (result
->symtab
);
4525 result
->explicit_pc
= 1;
4528 else if (funfirstline
)
4532 else if (SYMBOL_LINE (sym
) != 0)
4534 /* We know its line number. */
4536 result
->symtab
= symbol_symtab (sym
);
4537 result
->symbol
= sym
;
4538 result
->line
= SYMBOL_LINE (sym
);
4539 result
->pc
= SYMBOL_VALUE_ADDRESS (sym
);
4540 result
->pspace
= SYMTAB_PSPACE (result
->symtab
);
4548 linespec_result::~linespec_result ()
4550 for (linespec_sals
&lsal
: lsals
)
4551 xfree (lsal
.canonical
);
4554 /* Return the quote characters permitted by the linespec parser. */
4557 get_gdb_linespec_parser_quote_characters (void)
4559 return linespec_quote_characters
;