1 /* Data structures and API for event locations in GDB.
2 Copyright (C) 2013-2017 Free Software Foundation, Inc.
4 This file is part of GDB.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>. */
20 #include "gdb_assert.h"
25 #include "cli/cli-utils.h"
27 #include "cp-support.h"
32 /* An event location used to set a stop event in the inferior.
33 This structure is an amalgam of the various ways
34 to specify where a stop event should be set. */
38 /* The type of this breakpoint specification. */
39 enum event_location_type type
;
40 #define EL_TYPE(P) (P)->type
44 /* A generic "this is a string specification" for a location.
45 This representation is used by both "normal" linespecs and
48 #define EL_LINESPEC(P) ((P)->u.addr_string)
49 #define EL_PROBE(P) ((P)->u.addr_string)
51 /* An address in the inferior. */
53 #define EL_ADDRESS(P) (P)->u.address
55 /* An explicit location. */
56 struct explicit_location explicit_loc
;
57 #define EL_EXPLICIT(P) (&((P)->u.explicit_loc))
60 /* Cached string representation of this location. This is used, e.g., to
61 save stop event locations to file. Malloc'd. */
63 #define EL_STRING(P) ((P)->as_string)
66 /* See description in location.h. */
68 enum event_location_type
69 event_location_type (const struct event_location
*location
)
71 return EL_TYPE (location
);
74 /* See description in location.h. */
77 initialize_explicit_location (struct explicit_location
*explicit_loc
)
79 memset (explicit_loc
, 0, sizeof (struct explicit_location
));
80 explicit_loc
->line_offset
.sign
= LINE_OFFSET_UNKNOWN
;
83 /* See description in location.h. */
86 new_linespec_location (char **linespec
)
88 struct event_location
*location
;
90 location
= XCNEW (struct event_location
);
91 EL_TYPE (location
) = LINESPEC_LOCATION
;
92 if (*linespec
!= NULL
)
95 char *orig
= *linespec
;
97 linespec_lex_to_end (linespec
);
98 p
= remove_trailing_whitespace (orig
, *linespec
);
100 EL_LINESPEC (location
) = savestring (orig
, p
- orig
);
102 return event_location_up (location
);
105 /* See description in location.h. */
108 get_linespec_location (const struct event_location
*location
)
110 gdb_assert (EL_TYPE (location
) == LINESPEC_LOCATION
);
111 return EL_LINESPEC (location
);
114 /* See description in location.h. */
117 new_address_location (CORE_ADDR addr
, const char *addr_string
,
120 struct event_location
*location
;
122 location
= XCNEW (struct event_location
);
123 EL_TYPE (location
) = ADDRESS_LOCATION
;
124 EL_ADDRESS (location
) = addr
;
125 if (addr_string
!= NULL
)
126 EL_STRING (location
) = xstrndup (addr_string
, addr_string_len
);
127 return event_location_up (location
);
130 /* See description in location.h. */
133 get_address_location (const struct event_location
*location
)
135 gdb_assert (EL_TYPE (location
) == ADDRESS_LOCATION
);
136 return EL_ADDRESS (location
);
139 /* See description in location.h. */
142 get_address_string_location (const struct event_location
*location
)
144 gdb_assert (EL_TYPE (location
) == ADDRESS_LOCATION
);
145 return EL_STRING (location
);
148 /* See description in location.h. */
151 new_probe_location (const char *probe
)
153 struct event_location
*location
;
155 location
= XCNEW (struct event_location
);
156 EL_TYPE (location
) = PROBE_LOCATION
;
158 EL_PROBE (location
) = xstrdup (probe
);
159 return event_location_up (location
);
162 /* See description in location.h. */
165 get_probe_location (const struct event_location
*location
)
167 gdb_assert (EL_TYPE (location
) == PROBE_LOCATION
);
168 return EL_PROBE (location
);
171 /* See description in location.h. */
174 new_explicit_location (const struct explicit_location
*explicit_loc
)
176 struct event_location tmp
;
178 memset (&tmp
, 0, sizeof (struct event_location
));
179 EL_TYPE (&tmp
) = EXPLICIT_LOCATION
;
180 initialize_explicit_location (EL_EXPLICIT (&tmp
));
181 if (explicit_loc
!= NULL
)
183 if (explicit_loc
->source_filename
!= NULL
)
185 EL_EXPLICIT (&tmp
)->source_filename
186 = explicit_loc
->source_filename
;
189 if (explicit_loc
->function_name
!= NULL
)
190 EL_EXPLICIT (&tmp
)->function_name
191 = explicit_loc
->function_name
;
193 if (explicit_loc
->label_name
!= NULL
)
194 EL_EXPLICIT (&tmp
)->label_name
= explicit_loc
->label_name
;
196 if (explicit_loc
->line_offset
.sign
!= LINE_OFFSET_UNKNOWN
)
197 EL_EXPLICIT (&tmp
)->line_offset
= explicit_loc
->line_offset
;
200 return copy_event_location (&tmp
);
203 /* See description in location.h. */
205 struct explicit_location
*
206 get_explicit_location (struct event_location
*location
)
208 gdb_assert (EL_TYPE (location
) == EXPLICIT_LOCATION
);
209 return EL_EXPLICIT (location
);
212 /* See description in location.h. */
214 const struct explicit_location
*
215 get_explicit_location_const (const struct event_location
*location
)
217 gdb_assert (EL_TYPE (location
) == EXPLICIT_LOCATION
);
218 return EL_EXPLICIT (location
);
221 /* This convenience function returns a malloc'd string which
222 represents the location in EXPLICIT_LOC.
224 AS_LINESPEC is non-zero if this string should be a linespec.
225 Otherwise it will be output in explicit form. */
228 explicit_to_string_internal (int as_linespec
,
229 const struct explicit_location
*explicit_loc
)
232 char space
= as_linespec
? ':' : ' ';
235 if (explicit_loc
->source_filename
!= NULL
)
238 buf
.puts ("-source ");
239 buf
.puts (explicit_loc
->source_filename
);
243 if (explicit_loc
->function_name
!= NULL
)
248 buf
.puts ("-function ");
249 buf
.puts (explicit_loc
->function_name
);
253 if (explicit_loc
->label_name
!= NULL
)
258 buf
.puts ("-label ");
259 buf
.puts (explicit_loc
->label_name
);
263 if (explicit_loc
->line_offset
.sign
!= LINE_OFFSET_UNKNOWN
)
270 (explicit_loc
->line_offset
.sign
== LINE_OFFSET_NONE
? ""
271 : (explicit_loc
->line_offset
.sign
272 == LINE_OFFSET_PLUS
? "+" : "-")),
273 explicit_loc
->line_offset
.offset
);
276 return xstrdup (buf
.c_str ());
279 /* See description in location.h. */
282 explicit_location_to_string (const struct explicit_location
*explicit_loc
)
284 return explicit_to_string_internal (0, explicit_loc
);
287 /* See description in location.h. */
290 explicit_location_to_linespec (const struct explicit_location
*explicit_loc
)
292 return explicit_to_string_internal (1, explicit_loc
);
295 /* See description in location.h. */
298 copy_event_location (const struct event_location
*src
)
300 struct event_location
*dst
;
302 dst
= XCNEW (struct event_location
);
303 EL_TYPE (dst
) = EL_TYPE (src
);
304 if (EL_STRING (src
) != NULL
)
305 EL_STRING (dst
) = xstrdup (EL_STRING (src
));
307 switch (EL_TYPE (src
))
309 case LINESPEC_LOCATION
:
310 if (EL_LINESPEC (src
) != NULL
)
311 EL_LINESPEC (dst
) = xstrdup (EL_LINESPEC (src
));
314 case ADDRESS_LOCATION
:
315 EL_ADDRESS (dst
) = EL_ADDRESS (src
);
318 case EXPLICIT_LOCATION
:
319 if (EL_EXPLICIT (src
)->source_filename
!= NULL
)
320 EL_EXPLICIT (dst
)->source_filename
321 = xstrdup (EL_EXPLICIT (src
)->source_filename
);
323 if (EL_EXPLICIT (src
)->function_name
!= NULL
)
324 EL_EXPLICIT (dst
)->function_name
325 = xstrdup (EL_EXPLICIT (src
)->function_name
);
327 if (EL_EXPLICIT (src
)->label_name
!= NULL
)
328 EL_EXPLICIT (dst
)->label_name
= xstrdup (EL_EXPLICIT (src
)->label_name
);
330 EL_EXPLICIT (dst
)->line_offset
= EL_EXPLICIT (src
)->line_offset
;
335 if (EL_PROBE (src
) != NULL
)
336 EL_PROBE (dst
) = xstrdup (EL_PROBE (src
));
340 gdb_assert_not_reached ("unknown event location type");
343 return event_location_up (dst
);
347 event_location_deleter::operator() (event_location
*location
) const
349 if (location
!= NULL
)
351 xfree (EL_STRING (location
));
353 switch (EL_TYPE (location
))
355 case LINESPEC_LOCATION
:
356 xfree (EL_LINESPEC (location
));
359 case ADDRESS_LOCATION
:
363 case EXPLICIT_LOCATION
:
364 xfree (EL_EXPLICIT (location
)->source_filename
);
365 xfree (EL_EXPLICIT (location
)->function_name
);
366 xfree (EL_EXPLICIT (location
)->label_name
);
370 xfree (EL_PROBE (location
));
374 gdb_assert_not_reached ("unknown event location type");
381 /* See description in location.h. */
384 event_location_to_string (struct event_location
*location
)
386 if (EL_STRING (location
) == NULL
)
388 switch (EL_TYPE (location
))
390 case LINESPEC_LOCATION
:
391 if (EL_LINESPEC (location
) != NULL
)
392 EL_STRING (location
) = xstrdup (EL_LINESPEC (location
));
395 case ADDRESS_LOCATION
:
398 core_addr_to_string (EL_ADDRESS (location
)));
401 case EXPLICIT_LOCATION
:
403 = explicit_location_to_string (EL_EXPLICIT (location
));
407 EL_STRING (location
) = xstrdup (EL_PROBE (location
));
411 gdb_assert_not_reached ("unknown event location type");
415 return EL_STRING (location
);
418 /* A lexer for explicit locations. This function will advance INP
419 past any strings that it lexes. Returns a malloc'd copy of the
420 lexed string or NULL if no lexing was done. */
422 static gdb::unique_xmalloc_ptr
<char>
423 explicit_location_lex_one (const char **inp
,
424 const struct language_defn
*language
)
426 const char *start
= *inp
;
431 /* If quoted, skip to the ending quote. */
432 if (strchr (get_gdb_linespec_parser_quote_characters (), *start
))
434 char quote_char
= *start
;
436 /* If the input is not an Ada operator, skip to the matching
437 closing quote and return the string. */
438 if (!(language
->la_language
== language_ada
439 && quote_char
== '\"' && is_ada_operator (start
)))
441 const char *end
= find_toplevel_char (start
+ 1, quote_char
);
444 error (_("Unmatched quote, %s."), start
);
446 return gdb::unique_xmalloc_ptr
<char> (savestring (start
+ 1,
451 /* If the input starts with '-' or '+', the string ends with the next
452 whitespace or comma. */
453 if (*start
== '-' || *start
== '+')
455 while (*inp
[0] != '\0' && *inp
[0] != ',' && !isspace (*inp
[0]))
460 /* Handle numbers first, stopping at the next whitespace or ','. */
461 while (isdigit (*inp
[0]))
463 if (*inp
[0] == '\0' || isspace (*inp
[0]) || *inp
[0] == ',')
464 return gdb::unique_xmalloc_ptr
<char> (savestring (start
,
467 /* Otherwise stop at the next occurrence of whitespace, '\0',
472 && !(isspace ((*inp
)[0])
473 || linespec_lexer_lex_keyword (&(*inp
)[1])))
475 /* Special case: C++ operator,. */
476 if (language
->la_language
== language_cplus
477 && startswith (*inp
, CP_OPERATOR_STR
))
478 (*inp
) += CP_OPERATOR_LEN
;
483 if (*inp
- start
> 0)
484 return gdb::unique_xmalloc_ptr
<char> (savestring (start
, *inp
- start
));
489 /* See description in location.h. */
492 string_to_explicit_location (const char **argp
,
493 const struct language_defn
*language
,
496 event_location_up location
;
498 /* It is assumed that input beginning with '-' and a non-digit
499 character is an explicit location. "-p" is reserved, though,
500 for probe locations. */
504 || !isalpha ((*argp
)[1])
505 || ((*argp
)[0] == '-' && (*argp
)[1] == 'p'))
508 location
= new_explicit_location (NULL
);
510 /* Process option/argument pairs. dprintf_command
511 requires that processing stop on ','. */
512 while ((*argp
)[0] != '\0' && (*argp
)[0] != ',')
517 /* If *ARGP starts with a keyword, stop processing
519 if (linespec_lexer_lex_keyword (*argp
) != NULL
)
522 /* Mark the start of the string in case we need to rewind. */
525 /* Get the option string. */
526 gdb::unique_xmalloc_ptr
<char> opt
527 = explicit_location_lex_one (argp
, language
);
529 *argp
= skip_spaces_const (*argp
);
531 /* Get the argument string. */
532 gdb::unique_xmalloc_ptr
<char> oarg
533 = explicit_location_lex_one (argp
, language
);
534 bool have_oarg
= oarg
!= NULL
;
535 *argp
= skip_spaces_const (*argp
);
537 /* Use the length of the option to allow abbreviations. */
538 len
= strlen (opt
.get ());
540 /* All options have a required argument. Checking for this required
541 argument is deferred until later. */
542 if (strncmp (opt
.get (), "-source", len
) == 0)
543 EL_EXPLICIT (location
)->source_filename
= oarg
.release ();
544 else if (strncmp (opt
.get (), "-function", len
) == 0)
545 EL_EXPLICIT (location
)->function_name
= oarg
.release ();
546 else if (strncmp (opt
.get (), "-line", len
) == 0)
549 EL_EXPLICIT (location
)->line_offset
550 = linespec_parse_line_offset (oarg
.get ());
552 else if (strncmp (opt
.get (), "-label", len
) == 0)
553 EL_EXPLICIT (location
)->label_name
= oarg
.release ();
554 /* Only emit an "invalid argument" error for options
555 that look like option strings. */
556 else if (opt
.get ()[0] == '-' && !isdigit (opt
.get ()[1]))
559 error (_("invalid explicit location argument, \"%s\""), opt
.get ());
563 /* End of the explicit location specification.
564 Stop parsing and return whatever explicit location was
570 /* It's a little lame to error after the fact, but in this
571 case, it provides a much better user experience to issue
572 the "invalid argument" error before any missing
574 if (!have_oarg
&& !dont_throw
)
575 error (_("missing argument for \"%s\""), opt
.get ());
578 /* One special error check: If a source filename was given
579 without offset, function, or label, issue an error. */
580 if (EL_EXPLICIT (location
)->source_filename
!= NULL
581 && EL_EXPLICIT (location
)->function_name
== NULL
582 && EL_EXPLICIT (location
)->label_name
== NULL
583 && (EL_EXPLICIT (location
)->line_offset
.sign
== LINE_OFFSET_UNKNOWN
)
586 error (_("Source filename requires function, label, or "
593 /* See description in location.h. */
596 string_to_event_location_basic (char **stringp
,
597 const struct language_defn
*language
)
599 event_location_up location
;
602 /* Try the input as a probe spec. */
604 if (cs
!= NULL
&& probe_linespec_to_ops (&cs
) != NULL
)
606 location
= new_probe_location (*stringp
);
607 *stringp
+= strlen (*stringp
);
611 /* Try an address location. */
612 if (*stringp
!= NULL
&& **stringp
== '*')
614 const char *arg
, *orig
;
617 orig
= arg
= *stringp
;
618 addr
= linespec_expression_to_pc (&arg
);
619 location
= new_address_location (addr
, orig
, arg
- orig
);
620 *stringp
+= arg
- orig
;
624 /* Everything else is a linespec. */
625 location
= new_linespec_location (stringp
);
632 /* See description in location.h. */
635 string_to_event_location (char **stringp
,
636 const struct language_defn
*language
)
638 const char *arg
, *orig
;
640 /* Try an explicit location. */
641 orig
= arg
= *stringp
;
642 event_location_up location
= string_to_explicit_location (&arg
, language
, 0);
643 if (location
!= NULL
)
645 /* It was a valid explicit location. Advance STRINGP to
647 *stringp
+= arg
- orig
;
651 /* Everything else is a "basic" linespec, address, or probe
653 location
= string_to_event_location_basic (stringp
, language
);
659 /* See description in location.h. */
662 event_location_empty_p (const struct event_location
*location
)
664 switch (EL_TYPE (location
))
666 case LINESPEC_LOCATION
:
667 /* Linespecs are never "empty." (NULL is a valid linespec) */
670 case ADDRESS_LOCATION
:
673 case EXPLICIT_LOCATION
:
674 return (EL_EXPLICIT (location
) == NULL
675 || (EL_EXPLICIT (location
)->source_filename
== NULL
676 && EL_EXPLICIT (location
)->function_name
== NULL
677 && EL_EXPLICIT (location
)->label_name
== NULL
678 && (EL_EXPLICIT (location
)->line_offset
.sign
679 == LINE_OFFSET_UNKNOWN
)));
682 return EL_PROBE (location
) == NULL
;
685 gdb_assert_not_reached ("unknown event location type");
689 /* See description in location.h. */
692 set_event_location_string (struct event_location
*location
,
695 xfree (EL_STRING (location
));
696 EL_STRING (location
) = string
== NULL
? NULL
: xstrdup (string
);