1 /* Data structures and API for event locations in GDB.
2 Copyright (C) 2013-2016 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
)
233 struct cleanup
*cleanup
;
235 space
= as_linespec
? ':' : ' ';
236 buf
= mem_fileopen ();
237 cleanup
= make_cleanup_ui_file_delete (buf
);
239 if (explicit_loc
->source_filename
!= NULL
)
242 fputs_unfiltered ("-source ", buf
);
243 fputs_unfiltered (explicit_loc
->source_filename
, buf
);
247 if (explicit_loc
->function_name
!= NULL
)
250 fputc_unfiltered (space
, buf
);
252 fputs_unfiltered ("-function ", buf
);
253 fputs_unfiltered (explicit_loc
->function_name
, buf
);
257 if (explicit_loc
->label_name
!= NULL
)
260 fputc_unfiltered (space
, buf
);
262 fputs_unfiltered ("-label ", buf
);
263 fputs_unfiltered (explicit_loc
->label_name
, buf
);
267 if (explicit_loc
->line_offset
.sign
!= LINE_OFFSET_UNKNOWN
)
270 fputc_unfiltered (space
, buf
);
272 fputs_unfiltered ("-line ", buf
);
273 fprintf_filtered (buf
, "%s%d",
274 (explicit_loc
->line_offset
.sign
== LINE_OFFSET_NONE
? ""
275 : (explicit_loc
->line_offset
.sign
276 == LINE_OFFSET_PLUS
? "+" : "-")),
277 explicit_loc
->line_offset
.offset
);
280 result
= ui_file_xstrdup (buf
, NULL
);
281 do_cleanups (cleanup
);
285 /* See description in location.h. */
288 explicit_location_to_string (const struct explicit_location
*explicit_loc
)
290 return explicit_to_string_internal (0, explicit_loc
);
293 /* See description in location.h. */
296 explicit_location_to_linespec (const struct explicit_location
*explicit_loc
)
298 return explicit_to_string_internal (1, explicit_loc
);
301 /* See description in location.h. */
303 struct event_location
*
304 copy_event_location (const struct event_location
*src
)
306 struct event_location
*dst
;
308 dst
= XCNEW (struct event_location
);
309 EL_TYPE (dst
) = EL_TYPE (src
);
310 if (EL_STRING (src
) != NULL
)
311 EL_STRING (dst
) = xstrdup (EL_STRING (src
));
313 switch (EL_TYPE (src
))
315 case LINESPEC_LOCATION
:
316 if (EL_LINESPEC (src
) != NULL
)
317 EL_LINESPEC (dst
) = xstrdup (EL_LINESPEC (src
));
320 case ADDRESS_LOCATION
:
321 EL_ADDRESS (dst
) = EL_ADDRESS (src
);
324 case EXPLICIT_LOCATION
:
325 if (EL_EXPLICIT (src
)->source_filename
!= NULL
)
326 EL_EXPLICIT (dst
)->source_filename
327 = xstrdup (EL_EXPLICIT (src
)->source_filename
);
329 if (EL_EXPLICIT (src
)->function_name
!= NULL
)
330 EL_EXPLICIT (dst
)->function_name
331 = xstrdup (EL_EXPLICIT (src
)->function_name
);
333 if (EL_EXPLICIT (src
)->label_name
!= NULL
)
334 EL_EXPLICIT (dst
)->label_name
= xstrdup (EL_EXPLICIT (src
)->label_name
);
336 EL_EXPLICIT (dst
)->line_offset
= EL_EXPLICIT (src
)->line_offset
;
341 if (EL_PROBE (src
) != NULL
)
342 EL_PROBE (dst
) = xstrdup (EL_PROBE (src
));
346 gdb_assert_not_reached ("unknown event location type");
352 /* A cleanup function for struct event_location. */
355 delete_event_location_cleanup (void *data
)
357 struct event_location
*location
= (struct event_location
*) data
;
359 delete_event_location (location
);
362 /* See description in location.h. */
365 make_cleanup_delete_event_location (struct event_location
*location
)
367 return make_cleanup (delete_event_location_cleanup
, location
);
370 /* See description in location.h. */
373 delete_event_location (struct event_location
*location
)
375 if (location
!= NULL
)
377 xfree (EL_STRING (location
));
379 switch (EL_TYPE (location
))
381 case LINESPEC_LOCATION
:
382 xfree (EL_LINESPEC (location
));
385 case ADDRESS_LOCATION
:
389 case EXPLICIT_LOCATION
:
390 xfree (EL_EXPLICIT (location
)->source_filename
);
391 xfree (EL_EXPLICIT (location
)->function_name
);
392 xfree (EL_EXPLICIT (location
)->label_name
);
396 xfree (EL_PROBE (location
));
400 gdb_assert_not_reached ("unknown event location type");
407 /* See description in location.h. */
410 event_location_to_string (struct event_location
*location
)
412 if (EL_STRING (location
) == NULL
)
414 switch (EL_TYPE (location
))
416 case LINESPEC_LOCATION
:
417 if (EL_LINESPEC (location
) != NULL
)
418 EL_STRING (location
) = xstrdup (EL_LINESPEC (location
));
421 case ADDRESS_LOCATION
:
424 core_addr_to_string (EL_ADDRESS (location
)));
427 case EXPLICIT_LOCATION
:
429 = explicit_location_to_string (EL_EXPLICIT (location
));
433 EL_STRING (location
) = xstrdup (EL_PROBE (location
));
437 gdb_assert_not_reached ("unknown event location type");
441 return EL_STRING (location
);
444 /* A lexer for explicit locations. This function will advance INP
445 past any strings that it lexes. Returns a malloc'd copy of the
446 lexed string or NULL if no lexing was done. */
449 explicit_location_lex_one (const char **inp
,
450 const struct language_defn
*language
)
452 const char *start
= *inp
;
457 /* If quoted, skip to the ending quote. */
458 if (strchr (get_gdb_linespec_parser_quote_characters (), *start
))
460 char quote_char
= *start
;
462 /* If the input is not an Ada operator, skip to the matching
463 closing quote and return the string. */
464 if (!(language
->la_language
== language_ada
465 && quote_char
== '\"' && is_ada_operator (start
)))
467 const char *end
= find_toplevel_char (start
+ 1, quote_char
);
470 error (_("Unmatched quote, %s."), start
);
472 return savestring (start
+ 1, *inp
- start
- 2);
476 /* If the input starts with '-' or '+', the string ends with the next
477 whitespace or comma. */
478 if (*start
== '-' || *start
== '+')
480 while (*inp
[0] != '\0' && *inp
[0] != ',' && !isspace (*inp
[0]))
485 /* Handle numbers first, stopping at the next whitespace or ','. */
486 while (isdigit (*inp
[0]))
488 if (*inp
[0] == '\0' || isspace (*inp
[0]) || *inp
[0] == ',')
489 return savestring (start
, *inp
- start
);
491 /* Otherwise stop at the next occurrence of whitespace, '\0',
496 && !(isspace ((*inp
)[0])
497 || linespec_lexer_lex_keyword (&(*inp
)[1])))
499 /* Special case: C++ operator,. */
500 if (language
->la_language
== language_cplus
501 && strncmp (*inp
, "operator", 8)
508 if (*inp
- start
> 0)
509 return savestring (start
, *inp
- start
);
514 /* See description in location.h. */
516 struct event_location
*
517 string_to_explicit_location (const char **argp
,
518 const struct language_defn
*language
,
521 struct cleanup
*cleanup
;
522 struct event_location
*location
;
524 /* It is assumed that input beginning with '-' and a non-digit
525 character is an explicit location. "-p" is reserved, though,
526 for probe locations. */
530 || !isalpha ((*argp
)[1])
531 || ((*argp
)[0] == '-' && (*argp
)[1] == 'p'))
534 location
= new_explicit_location (NULL
);
535 cleanup
= make_cleanup_delete_event_location (location
);
537 /* Process option/argument pairs. dprintf_command
538 requires that processing stop on ','. */
539 while ((*argp
)[0] != '\0' && (*argp
)[0] != ',')
544 struct cleanup
*opt_cleanup
, *oarg_cleanup
;
546 /* If *ARGP starts with a keyword, stop processing
548 if (linespec_lexer_lex_keyword (*argp
) != NULL
)
551 /* Mark the start of the string in case we need to rewind. */
554 /* Get the option string. */
555 opt
= explicit_location_lex_one (argp
, language
);
556 opt_cleanup
= make_cleanup (xfree
, opt
);
558 *argp
= skip_spaces_const (*argp
);
560 /* Get the argument string. */
561 oarg
= explicit_location_lex_one (argp
, language
);
562 oarg_cleanup
= make_cleanup (xfree
, oarg
);
563 *argp
= skip_spaces_const (*argp
);
565 /* Use the length of the option to allow abbreviations. */
568 /* All options have a required argument. Checking for this required
569 argument is deferred until later. */
570 if (strncmp (opt
, "-source", len
) == 0)
571 EL_EXPLICIT (location
)->source_filename
= oarg
;
572 else if (strncmp (opt
, "-function", len
) == 0)
573 EL_EXPLICIT (location
)->function_name
= oarg
;
574 else if (strncmp (opt
, "-line", len
) == 0)
578 EL_EXPLICIT (location
)->line_offset
579 = linespec_parse_line_offset (oarg
);
580 do_cleanups (oarg_cleanup
);
581 do_cleanups (opt_cleanup
);
585 else if (strncmp (opt
, "-label", len
) == 0)
586 EL_EXPLICIT (location
)->label_name
= oarg
;
587 /* Only emit an "invalid argument" error for options
588 that look like option strings. */
589 else if (opt
[0] == '-' && !isdigit (opt
[1]))
592 error (_("invalid explicit location argument, \"%s\""), opt
);
596 /* End of the explicit location specification.
597 Stop parsing and return whatever explicit location was
600 discard_cleanups (oarg_cleanup
);
601 do_cleanups (opt_cleanup
);
602 discard_cleanups (cleanup
);
606 /* It's a little lame to error after the fact, but in this
607 case, it provides a much better user experience to issue
608 the "invalid argument" error before any missing
610 if (oarg
== NULL
&& !dont_throw
)
611 error (_("missing argument for \"%s\""), opt
);
613 /* The option/argument pair was successfully processed;
614 oarg belongs to the explicit location, and opt should
616 discard_cleanups (oarg_cleanup
);
617 do_cleanups (opt_cleanup
);
620 /* One special error check: If a source filename was given
621 without offset, function, or label, issue an error. */
622 if (EL_EXPLICIT (location
)->source_filename
!= NULL
623 && EL_EXPLICIT (location
)->function_name
== NULL
624 && EL_EXPLICIT (location
)->label_name
== NULL
625 && (EL_EXPLICIT (location
)->line_offset
.sign
== LINE_OFFSET_UNKNOWN
)
628 error (_("Source filename requires function, label, or "
632 discard_cleanups (cleanup
);
636 /* See description in location.h. */
638 struct event_location
*
639 string_to_event_location_basic (char **stringp
,
640 const struct language_defn
*language
)
642 struct event_location
*location
;
643 const char *arg
, *orig
, *cs
;
645 /* Try the input as a probe spec. */
647 if (cs
!= NULL
&& probe_linespec_to_ops (&cs
) != NULL
)
649 location
= new_probe_location (*stringp
);
650 *stringp
+= strlen (*stringp
);
654 /* Try an address location. */
655 if (*stringp
!= NULL
&& **stringp
== '*')
657 const char *arg
, *orig
;
660 orig
= arg
= *stringp
;
661 addr
= linespec_expression_to_pc (&arg
);
662 location
= new_address_location (addr
, orig
, arg
- orig
);
663 *stringp
+= arg
- orig
;
667 /* Everything else is a linespec. */
668 location
= new_linespec_location (stringp
);
675 /* See description in location.h. */
677 struct event_location
*
678 string_to_event_location (char **stringp
,
679 const struct language_defn
*language
)
681 struct event_location
*location
;
682 const char *arg
, *orig
;
684 /* Try an explicit location. */
685 orig
= arg
= *stringp
;
686 location
= string_to_explicit_location (&arg
, language
, 0);
687 if (location
!= NULL
)
689 /* It was a valid explicit location. Advance STRINGP to
691 *stringp
+= arg
- orig
;
695 /* Everything else is a "basic" linespec, address, or probe
697 location
= string_to_event_location_basic (stringp
, language
);
703 /* See description in location.h. */
706 event_location_empty_p (const struct event_location
*location
)
708 switch (EL_TYPE (location
))
710 case LINESPEC_LOCATION
:
711 /* Linespecs are never "empty." (NULL is a valid linespec) */
714 case ADDRESS_LOCATION
:
717 case EXPLICIT_LOCATION
:
718 return (EL_EXPLICIT (location
) == NULL
719 || (EL_EXPLICIT (location
)->source_filename
== NULL
720 && EL_EXPLICIT (location
)->function_name
== NULL
721 && EL_EXPLICIT (location
)->label_name
== NULL
722 && (EL_EXPLICIT (location
)->line_offset
.sign
723 == LINE_OFFSET_UNKNOWN
)));
726 return EL_PROBE (location
) == NULL
;
729 gdb_assert_not_reached ("unknown event location type");
733 /* See description in location.h. */
736 set_event_location_string (struct event_location
*location
,
739 xfree (EL_STRING (location
));
740 EL_STRING (location
) = string
== NULL
? NULL
: xstrdup (string
);