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"
31 /* An event location used to set a stop event in the inferior.
32 This structure is an amalgam of the various ways
33 to specify where a stop event should be set. */
37 /* The type of this breakpoint specification. */
38 enum event_location_type type
;
39 #define EL_TYPE(P) (P)->type
43 /* A generic "this is a string specification" for a location.
44 This representation is used by both "normal" linespecs and
47 #define EL_LINESPEC(P) ((P)->u.addr_string)
48 #define EL_PROBE(P) ((P)->u.addr_string)
50 /* An address in the inferior. */
52 #define EL_ADDRESS(P) (P)->u.address
54 /* An explicit location. */
55 struct explicit_location explicit_loc
;
56 #define EL_EXPLICIT(P) (&((P)->u.explicit_loc))
59 /* Cached string representation of this location. This is used, e.g., to
60 save stop event locations to file. Malloc'd. */
62 #define EL_STRING(P) ((P)->as_string)
65 /* See description in location.h. */
67 enum event_location_type
68 event_location_type (const struct event_location
*location
)
70 return EL_TYPE (location
);
73 /* See description in location.h. */
76 initialize_explicit_location (struct explicit_location
*explicit_loc
)
78 memset (explicit_loc
, 0, sizeof (struct explicit_location
));
79 explicit_loc
->line_offset
.sign
= LINE_OFFSET_UNKNOWN
;
82 /* See description in location.h. */
84 struct event_location
*
85 new_linespec_location (char **linespec
)
87 struct event_location
*location
;
89 location
= XCNEW (struct event_location
);
90 EL_TYPE (location
) = LINESPEC_LOCATION
;
91 if (*linespec
!= NULL
)
94 char *orig
= *linespec
;
96 linespec_lex_to_end (linespec
);
97 p
= remove_trailing_whitespace (orig
, *linespec
);
99 EL_LINESPEC (location
) = savestring (orig
, p
- orig
);
104 /* See description in location.h. */
107 get_linespec_location (const struct event_location
*location
)
109 gdb_assert (EL_TYPE (location
) == LINESPEC_LOCATION
);
110 return EL_LINESPEC (location
);
113 /* See description in location.h. */
115 struct event_location
*
116 new_address_location (CORE_ADDR addr
, const char *addr_string
,
119 struct event_location
*location
;
121 location
= XCNEW (struct event_location
);
122 EL_TYPE (location
) = ADDRESS_LOCATION
;
123 EL_ADDRESS (location
) = addr
;
124 if (addr_string
!= NULL
)
125 EL_STRING (location
) = xstrndup (addr_string
, addr_string_len
);
129 /* See description in location.h. */
132 get_address_location (const struct event_location
*location
)
134 gdb_assert (EL_TYPE (location
) == ADDRESS_LOCATION
);
135 return EL_ADDRESS (location
);
138 /* See description in location.h. */
141 get_address_string_location (const struct event_location
*location
)
143 gdb_assert (EL_TYPE (location
) == ADDRESS_LOCATION
);
144 return EL_STRING (location
);
147 /* See description in location.h. */
149 struct event_location
*
150 new_probe_location (const char *probe
)
152 struct event_location
*location
;
154 location
= XCNEW (struct event_location
);
155 EL_TYPE (location
) = PROBE_LOCATION
;
157 EL_PROBE (location
) = xstrdup (probe
);
161 /* See description in location.h. */
164 get_probe_location (const struct event_location
*location
)
166 gdb_assert (EL_TYPE (location
) == PROBE_LOCATION
);
167 return EL_PROBE (location
);
170 /* See description in location.h. */
172 struct event_location
*
173 new_explicit_location (const struct explicit_location
*explicit_loc
)
175 struct event_location tmp
;
177 memset (&tmp
, 0, sizeof (struct event_location
));
178 EL_TYPE (&tmp
) = EXPLICIT_LOCATION
;
179 initialize_explicit_location (EL_EXPLICIT (&tmp
));
180 if (explicit_loc
!= NULL
)
182 if (explicit_loc
->source_filename
!= NULL
)
184 EL_EXPLICIT (&tmp
)->source_filename
185 = explicit_loc
->source_filename
;
188 if (explicit_loc
->function_name
!= NULL
)
189 EL_EXPLICIT (&tmp
)->function_name
190 = explicit_loc
->function_name
;
192 if (explicit_loc
->label_name
!= NULL
)
193 EL_EXPLICIT (&tmp
)->label_name
= explicit_loc
->label_name
;
195 if (explicit_loc
->line_offset
.sign
!= LINE_OFFSET_UNKNOWN
)
196 EL_EXPLICIT (&tmp
)->line_offset
= explicit_loc
->line_offset
;
199 return copy_event_location (&tmp
);
202 /* See description in location.h. */
204 struct explicit_location
*
205 get_explicit_location (struct event_location
*location
)
207 gdb_assert (EL_TYPE (location
) == EXPLICIT_LOCATION
);
208 return EL_EXPLICIT (location
);
211 /* See description in location.h. */
213 const struct explicit_location
*
214 get_explicit_location_const (const struct event_location
*location
)
216 gdb_assert (EL_TYPE (location
) == EXPLICIT_LOCATION
);
217 return EL_EXPLICIT (location
);
220 /* This convenience function returns a malloc'd string which
221 represents the location in EXPLICIT_LOC.
223 AS_LINESPEC is non-zero if this string should be a linespec.
224 Otherwise it will be output in explicit form. */
227 explicit_to_string_internal (int as_linespec
,
228 const struct explicit_location
*explicit_loc
)
231 char space
= as_linespec
? ':' : ' ';
234 if (explicit_loc
->source_filename
!= NULL
)
237 buf
.puts ("-source ");
238 buf
.puts (explicit_loc
->source_filename
);
242 if (explicit_loc
->function_name
!= NULL
)
247 buf
.puts ("-function ");
248 buf
.puts (explicit_loc
->function_name
);
252 if (explicit_loc
->label_name
!= NULL
)
257 buf
.puts ("-label ");
258 buf
.puts (explicit_loc
->label_name
);
262 if (explicit_loc
->line_offset
.sign
!= LINE_OFFSET_UNKNOWN
)
269 (explicit_loc
->line_offset
.sign
== LINE_OFFSET_NONE
? ""
270 : (explicit_loc
->line_offset
.sign
271 == LINE_OFFSET_PLUS
? "+" : "-")),
272 explicit_loc
->line_offset
.offset
);
275 return xstrdup (buf
.c_str ());
278 /* See description in location.h. */
281 explicit_location_to_string (const struct explicit_location
*explicit_loc
)
283 return explicit_to_string_internal (0, explicit_loc
);
286 /* See description in location.h. */
289 explicit_location_to_linespec (const struct explicit_location
*explicit_loc
)
291 return explicit_to_string_internal (1, explicit_loc
);
294 /* See description in location.h. */
296 struct event_location
*
297 copy_event_location (const struct event_location
*src
)
299 struct event_location
*dst
;
301 dst
= XCNEW (struct event_location
);
302 EL_TYPE (dst
) = EL_TYPE (src
);
303 if (EL_STRING (src
) != NULL
)
304 EL_STRING (dst
) = xstrdup (EL_STRING (src
));
306 switch (EL_TYPE (src
))
308 case LINESPEC_LOCATION
:
309 if (EL_LINESPEC (src
) != NULL
)
310 EL_LINESPEC (dst
) = xstrdup (EL_LINESPEC (src
));
313 case ADDRESS_LOCATION
:
314 EL_ADDRESS (dst
) = EL_ADDRESS (src
);
317 case EXPLICIT_LOCATION
:
318 if (EL_EXPLICIT (src
)->source_filename
!= NULL
)
319 EL_EXPLICIT (dst
)->source_filename
320 = xstrdup (EL_EXPLICIT (src
)->source_filename
);
322 if (EL_EXPLICIT (src
)->function_name
!= NULL
)
323 EL_EXPLICIT (dst
)->function_name
324 = xstrdup (EL_EXPLICIT (src
)->function_name
);
326 if (EL_EXPLICIT (src
)->label_name
!= NULL
)
327 EL_EXPLICIT (dst
)->label_name
= xstrdup (EL_EXPLICIT (src
)->label_name
);
329 EL_EXPLICIT (dst
)->line_offset
= EL_EXPLICIT (src
)->line_offset
;
334 if (EL_PROBE (src
) != NULL
)
335 EL_PROBE (dst
) = xstrdup (EL_PROBE (src
));
339 gdb_assert_not_reached ("unknown event location type");
345 /* A cleanup function for struct event_location. */
348 delete_event_location_cleanup (void *data
)
350 struct event_location
*location
= (struct event_location
*) data
;
352 delete_event_location (location
);
355 /* See description in location.h. */
358 make_cleanup_delete_event_location (struct event_location
*location
)
360 return make_cleanup (delete_event_location_cleanup
, location
);
363 /* See description in location.h. */
366 delete_event_location (struct event_location
*location
)
368 if (location
!= NULL
)
370 xfree (EL_STRING (location
));
372 switch (EL_TYPE (location
))
374 case LINESPEC_LOCATION
:
375 xfree (EL_LINESPEC (location
));
378 case ADDRESS_LOCATION
:
382 case EXPLICIT_LOCATION
:
383 xfree (EL_EXPLICIT (location
)->source_filename
);
384 xfree (EL_EXPLICIT (location
)->function_name
);
385 xfree (EL_EXPLICIT (location
)->label_name
);
389 xfree (EL_PROBE (location
));
393 gdb_assert_not_reached ("unknown event location type");
400 /* See description in location.h. */
403 event_location_to_string (struct event_location
*location
)
405 if (EL_STRING (location
) == NULL
)
407 switch (EL_TYPE (location
))
409 case LINESPEC_LOCATION
:
410 if (EL_LINESPEC (location
) != NULL
)
411 EL_STRING (location
) = xstrdup (EL_LINESPEC (location
));
414 case ADDRESS_LOCATION
:
417 core_addr_to_string (EL_ADDRESS (location
)));
420 case EXPLICIT_LOCATION
:
422 = explicit_location_to_string (EL_EXPLICIT (location
));
426 EL_STRING (location
) = xstrdup (EL_PROBE (location
));
430 gdb_assert_not_reached ("unknown event location type");
434 return EL_STRING (location
);
437 /* A lexer for explicit locations. This function will advance INP
438 past any strings that it lexes. Returns a malloc'd copy of the
439 lexed string or NULL if no lexing was done. */
442 explicit_location_lex_one (const char **inp
,
443 const struct language_defn
*language
)
445 const char *start
= *inp
;
450 /* If quoted, skip to the ending quote. */
451 if (strchr (get_gdb_linespec_parser_quote_characters (), *start
))
453 char quote_char
= *start
;
455 /* If the input is not an Ada operator, skip to the matching
456 closing quote and return the string. */
457 if (!(language
->la_language
== language_ada
458 && quote_char
== '\"' && is_ada_operator (start
)))
460 const char *end
= find_toplevel_char (start
+ 1, quote_char
);
463 error (_("Unmatched quote, %s."), start
);
465 return savestring (start
+ 1, *inp
- start
- 2);
469 /* If the input starts with '-' or '+', the string ends with the next
470 whitespace or comma. */
471 if (*start
== '-' || *start
== '+')
473 while (*inp
[0] != '\0' && *inp
[0] != ',' && !isspace (*inp
[0]))
478 /* Handle numbers first, stopping at the next whitespace or ','. */
479 while (isdigit (*inp
[0]))
481 if (*inp
[0] == '\0' || isspace (*inp
[0]) || *inp
[0] == ',')
482 return savestring (start
, *inp
- start
);
484 /* Otherwise stop at the next occurrence of whitespace, '\0',
489 && !(isspace ((*inp
)[0])
490 || linespec_lexer_lex_keyword (&(*inp
)[1])))
492 /* Special case: C++ operator,. */
493 if (language
->la_language
== language_cplus
494 && strncmp (*inp
, "operator", 8) == 0)
500 if (*inp
- start
> 0)
501 return savestring (start
, *inp
- start
);
506 /* See description in location.h. */
508 struct event_location
*
509 string_to_explicit_location (const char **argp
,
510 const struct language_defn
*language
,
513 struct cleanup
*cleanup
;
514 struct event_location
*location
;
516 /* It is assumed that input beginning with '-' and a non-digit
517 character is an explicit location. "-p" is reserved, though,
518 for probe locations. */
522 || !isalpha ((*argp
)[1])
523 || ((*argp
)[0] == '-' && (*argp
)[1] == 'p'))
526 location
= new_explicit_location (NULL
);
527 cleanup
= make_cleanup_delete_event_location (location
);
529 /* Process option/argument pairs. dprintf_command
530 requires that processing stop on ','. */
531 while ((*argp
)[0] != '\0' && (*argp
)[0] != ',')
536 struct cleanup
*opt_cleanup
, *oarg_cleanup
;
538 /* If *ARGP starts with a keyword, stop processing
540 if (linespec_lexer_lex_keyword (*argp
) != NULL
)
543 /* Mark the start of the string in case we need to rewind. */
546 /* Get the option string. */
547 opt
= explicit_location_lex_one (argp
, language
);
548 opt_cleanup
= make_cleanup (xfree
, opt
);
550 *argp
= skip_spaces_const (*argp
);
552 /* Get the argument string. */
553 oarg
= explicit_location_lex_one (argp
, language
);
554 oarg_cleanup
= make_cleanup (xfree
, oarg
);
555 *argp
= skip_spaces_const (*argp
);
557 /* Use the length of the option to allow abbreviations. */
560 /* All options have a required argument. Checking for this required
561 argument is deferred until later. */
562 if (strncmp (opt
, "-source", len
) == 0)
563 EL_EXPLICIT (location
)->source_filename
= oarg
;
564 else if (strncmp (opt
, "-function", len
) == 0)
565 EL_EXPLICIT (location
)->function_name
= oarg
;
566 else if (strncmp (opt
, "-line", len
) == 0)
570 EL_EXPLICIT (location
)->line_offset
571 = linespec_parse_line_offset (oarg
);
572 do_cleanups (oarg_cleanup
);
573 do_cleanups (opt_cleanup
);
577 else if (strncmp (opt
, "-label", len
) == 0)
578 EL_EXPLICIT (location
)->label_name
= oarg
;
579 /* Only emit an "invalid argument" error for options
580 that look like option strings. */
581 else if (opt
[0] == '-' && !isdigit (opt
[1]))
584 error (_("invalid explicit location argument, \"%s\""), opt
);
588 /* End of the explicit location specification.
589 Stop parsing and return whatever explicit location was
592 discard_cleanups (oarg_cleanup
);
593 do_cleanups (opt_cleanup
);
594 discard_cleanups (cleanup
);
598 /* It's a little lame to error after the fact, but in this
599 case, it provides a much better user experience to issue
600 the "invalid argument" error before any missing
602 if (oarg
== NULL
&& !dont_throw
)
603 error (_("missing argument for \"%s\""), opt
);
605 /* The option/argument pair was successfully processed;
606 oarg belongs to the explicit location, and opt should
608 discard_cleanups (oarg_cleanup
);
609 do_cleanups (opt_cleanup
);
612 /* One special error check: If a source filename was given
613 without offset, function, or label, issue an error. */
614 if (EL_EXPLICIT (location
)->source_filename
!= NULL
615 && EL_EXPLICIT (location
)->function_name
== NULL
616 && EL_EXPLICIT (location
)->label_name
== NULL
617 && (EL_EXPLICIT (location
)->line_offset
.sign
== LINE_OFFSET_UNKNOWN
)
620 error (_("Source filename requires function, label, or "
624 discard_cleanups (cleanup
);
628 /* See description in location.h. */
630 struct event_location
*
631 string_to_event_location_basic (char **stringp
,
632 const struct language_defn
*language
)
634 struct event_location
*location
;
637 /* Try the input as a probe spec. */
639 if (cs
!= NULL
&& probe_linespec_to_ops (&cs
) != NULL
)
641 location
= new_probe_location (*stringp
);
642 *stringp
+= strlen (*stringp
);
646 /* Try an address location. */
647 if (*stringp
!= NULL
&& **stringp
== '*')
649 const char *arg
, *orig
;
652 orig
= arg
= *stringp
;
653 addr
= linespec_expression_to_pc (&arg
);
654 location
= new_address_location (addr
, orig
, arg
- orig
);
655 *stringp
+= arg
- orig
;
659 /* Everything else is a linespec. */
660 location
= new_linespec_location (stringp
);
667 /* See description in location.h. */
669 struct event_location
*
670 string_to_event_location (char **stringp
,
671 const struct language_defn
*language
)
673 struct event_location
*location
;
674 const char *arg
, *orig
;
676 /* Try an explicit location. */
677 orig
= arg
= *stringp
;
678 location
= string_to_explicit_location (&arg
, language
, 0);
679 if (location
!= NULL
)
681 /* It was a valid explicit location. Advance STRINGP to
683 *stringp
+= arg
- orig
;
687 /* Everything else is a "basic" linespec, address, or probe
689 location
= string_to_event_location_basic (stringp
, language
);
695 /* See description in location.h. */
698 event_location_empty_p (const struct event_location
*location
)
700 switch (EL_TYPE (location
))
702 case LINESPEC_LOCATION
:
703 /* Linespecs are never "empty." (NULL is a valid linespec) */
706 case ADDRESS_LOCATION
:
709 case EXPLICIT_LOCATION
:
710 return (EL_EXPLICIT (location
) == NULL
711 || (EL_EXPLICIT (location
)->source_filename
== NULL
712 && EL_EXPLICIT (location
)->function_name
== NULL
713 && EL_EXPLICIT (location
)->label_name
== NULL
714 && (EL_EXPLICIT (location
)->line_offset
.sign
715 == LINE_OFFSET_UNKNOWN
)));
718 return EL_PROBE (location
) == NULL
;
721 gdb_assert_not_reached ("unknown event location type");
725 /* See description in location.h. */
728 set_event_location_string (struct event_location
*location
,
731 xfree (EL_STRING (location
));
732 EL_STRING (location
) = string
== NULL
? NULL
: xstrdup (string
);