1 /* Everything about catch/throw catchpoints, for GDB.
3 Copyright (C) 1986-2014 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/>. */
21 #include "arch-utils.h"
23 #include "breakpoint.h"
28 #include "cli/cli-utils.h"
29 #include "completer.h"
30 #include "gdb_obstack.h"
31 #include "mi/mi-common.h"
36 #include "gdb_regex.h"
37 #include "cp-support.h"
39 /* Enums for exception-handling support. */
40 enum exception_event_kind
47 /* Each spot where we may place an exception-related catchpoint has
48 two names: the SDT probe point and the function name. This
49 structure holds both. */
51 struct exception_names
53 /* The name of the probe point to try, in the form accepted by
58 /* The name of the corresponding function. */
63 /* Names of the probe points and functions on which to break. This is
64 indexed by exception_event_kind. */
65 static const struct exception_names exception_functions
[] =
67 { "-probe-stap libstdcxx:throw", "__cxa_throw" },
68 { "-probe-stap libstdcxx:rethrow", "__cxa_rethrow" },
69 { "-probe-stap libstdcxx:catch", "__cxa_begin_catch" }
72 static struct breakpoint_ops gnu_v3_exception_catchpoint_ops
;
74 /* The type of an exception catchpoint. */
76 struct exception_catchpoint
80 struct breakpoint base
;
82 /* The kind of exception catchpoint. */
84 enum exception_event_kind kind
;
86 /* If non-NULL, an xmalloc'd string holding the source form of the
87 regular expression to match against. */
91 /* If non-NULL, an xmalloc'd, compiled regular expression which is
92 used to determine which exceptions to stop on. */
99 /* A helper function that fetches exception probe arguments. This
100 fills in *ARG0 (if non-NULL) and *ARG1 (which must be non-NULL).
101 It will throw an exception on any kind of failure. */
104 fetch_probe_arguments (struct value
**arg0
, struct value
**arg1
)
106 struct frame_info
*frame
= get_selected_frame (_("No frame selected"));
107 CORE_ADDR pc
= get_frame_pc (frame
);
108 struct bound_probe pc_probe
;
109 const struct sym_probe_fns
*pc_probe_fns
;
112 pc_probe
= find_probe_by_pc (pc
);
113 if (pc_probe
.probe
== NULL
114 || strcmp (pc_probe
.probe
->provider
, "libstdcxx") != 0
115 || (strcmp (pc_probe
.probe
->name
, "catch") != 0
116 && strcmp (pc_probe
.probe
->name
, "throw") != 0
117 && strcmp (pc_probe
.probe
->name
, "rethrow") != 0))
118 error (_("not stopped at a C++ exception catchpoint"));
120 n_args
= get_probe_argument_count (pc_probe
.probe
, frame
);
122 error (_("C++ exception catchpoint has too few arguments"));
125 *arg0
= evaluate_probe_argument (pc_probe
.probe
, 0, frame
);
126 *arg1
= evaluate_probe_argument (pc_probe
.probe
, 1, frame
);
128 if ((arg0
!= NULL
&& *arg0
== NULL
) || *arg1
== NULL
)
129 error (_("error computing probe argument at c++ exception catchpoint"));
134 /* A helper function that returns a value indicating the kind of the
135 exception catchpoint B. */
137 static enum exception_event_kind
138 classify_exception_breakpoint (struct breakpoint
*b
)
140 struct exception_catchpoint
*cp
= (struct exception_catchpoint
*) b
;
145 /* Implement the 'dtor' method. */
148 dtor_exception_catchpoint (struct breakpoint
*self
)
150 struct exception_catchpoint
*cp
= (struct exception_catchpoint
*) self
;
152 xfree (cp
->exception_rx
);
153 if (cp
->pattern
!= NULL
)
154 regfree (cp
->pattern
);
155 bkpt_breakpoint_ops
.dtor (self
);
158 /* Implement the 'check_status' method. */
161 check_status_exception_catchpoint (struct bpstats
*bs
)
163 struct exception_catchpoint
*self
164 = (struct exception_catchpoint
*) bs
->breakpoint_at
;
165 char *typename
= NULL
;
166 volatile struct gdb_exception e
;
168 bkpt_breakpoint_ops
.check_status (bs
);
172 if (self
->pattern
== NULL
)
175 TRY_CATCH (e
, RETURN_MASK_ERROR
)
177 struct value
*typeinfo_arg
;
180 fetch_probe_arguments (NULL
, &typeinfo_arg
);
181 typename
= cplus_typename_from_type_info (typeinfo_arg
);
183 canon
= cp_canonicalize_string (typename
);
192 exception_print (gdb_stderr
, e
);
193 else if (regexec (self
->pattern
, typename
, 0, NULL
, 0) != 0)
199 /* Implement the 're_set' method. */
202 re_set_exception_catchpoint (struct breakpoint
*self
)
204 struct symtabs_and_lines sals
= {0};
205 struct symtabs_and_lines sals_end
= {0};
206 volatile struct gdb_exception e
;
207 struct cleanup
*cleanup
;
208 enum exception_event_kind kind
= classify_exception_breakpoint (self
);
210 /* We first try to use the probe interface. */
211 TRY_CATCH (e
, RETURN_MASK_ERROR
)
213 char *spec
= ASTRDUP (exception_functions
[kind
].probe
);
215 sals
= parse_probes (&spec
, NULL
);
220 volatile struct gdb_exception ex
;
222 /* Using the probe interface failed. Let's fallback to the normal
224 TRY_CATCH (ex
, RETURN_MASK_ERROR
)
226 char *spec
= ASTRDUP (exception_functions
[kind
].function
);
228 self
->ops
->decode_linespec (self
, &spec
, &sals
);
231 /* NOT_FOUND_ERROR just means the breakpoint will be pending, so
233 if (ex
.reason
< 0 && ex
.error
!= NOT_FOUND_ERROR
)
234 throw_exception (ex
);
237 cleanup
= make_cleanup (xfree
, sals
.sals
);
238 update_breakpoint_locations (self
, sals
, sals_end
);
239 do_cleanups (cleanup
);
242 static enum print_stop_action
243 print_it_exception_catchpoint (bpstat bs
)
245 struct ui_out
*uiout
= current_uiout
;
246 struct breakpoint
*b
= bs
->breakpoint_at
;
248 enum exception_event_kind kind
= classify_exception_breakpoint (b
);
250 annotate_catchpoint (b
->number
);
252 bp_temp
= b
->disposition
== disp_del
;
254 bp_temp
? "Temporary catchpoint "
256 if (!ui_out_is_mi_like_p (uiout
))
257 ui_out_field_int (uiout
, "bkptno", b
->number
);
259 (kind
== EX_EVENT_THROW
? " (exception thrown), "
260 : (kind
== EX_EVENT_CATCH
? " (exception caught), "
261 : " (exception rethrown), ")));
262 if (ui_out_is_mi_like_p (uiout
))
264 ui_out_field_string (uiout
, "reason",
265 async_reason_lookup (EXEC_ASYNC_BREAKPOINT_HIT
));
266 ui_out_field_string (uiout
, "disp", bpdisp_text (b
->disposition
));
267 ui_out_field_int (uiout
, "bkptno", b
->number
);
269 return PRINT_SRC_AND_LOC
;
273 print_one_exception_catchpoint (struct breakpoint
*b
,
274 struct bp_location
**last_loc
)
276 struct value_print_options opts
;
277 struct ui_out
*uiout
= current_uiout
;
278 enum exception_event_kind kind
= classify_exception_breakpoint (b
);
280 get_user_print_options (&opts
);
281 if (opts
.addressprint
)
284 if (b
->loc
== NULL
|| b
->loc
->shlib_disabled
)
285 ui_out_field_string (uiout
, "addr", "<PENDING>");
287 ui_out_field_core_addr (uiout
, "addr",
288 b
->loc
->gdbarch
, b
->loc
->address
);
297 ui_out_field_string (uiout
, "what", "exception throw");
298 if (ui_out_is_mi_like_p (uiout
))
299 ui_out_field_string (uiout
, "catch-type", "throw");
302 case EX_EVENT_RETHROW
:
303 ui_out_field_string (uiout
, "what", "exception rethrow");
304 if (ui_out_is_mi_like_p (uiout
))
305 ui_out_field_string (uiout
, "catch-type", "rethrow");
309 ui_out_field_string (uiout
, "what", "exception catch");
310 if (ui_out_is_mi_like_p (uiout
))
311 ui_out_field_string (uiout
, "catch-type", "catch");
316 /* Implement the 'print_one_detail' method. */
319 print_one_detail_exception_catchpoint (const struct breakpoint
*b
,
320 struct ui_out
*uiout
)
322 const struct exception_catchpoint
*cp
323 = (const struct exception_catchpoint
*) b
;
325 if (cp
->exception_rx
!= NULL
)
327 ui_out_text (uiout
, _("\tmatching: "));
328 ui_out_field_string (uiout
, "regexp", cp
->exception_rx
);
329 ui_out_text (uiout
, "\n");
334 print_mention_exception_catchpoint (struct breakpoint
*b
)
336 struct ui_out
*uiout
= current_uiout
;
338 enum exception_event_kind kind
= classify_exception_breakpoint (b
);
340 bp_temp
= b
->disposition
== disp_del
;
341 ui_out_text (uiout
, bp_temp
? _("Temporary catchpoint ")
343 ui_out_field_int (uiout
, "bkptno", b
->number
);
344 ui_out_text (uiout
, (kind
== EX_EVENT_THROW
? _(" (throw)")
345 : (kind
== EX_EVENT_CATCH
? _(" (catch)")
346 : _(" (rethrow)"))));
349 /* Implement the "print_recreate" breakpoint_ops method for throw and
350 catch catchpoints. */
353 print_recreate_exception_catchpoint (struct breakpoint
*b
,
357 enum exception_event_kind kind
= classify_exception_breakpoint (b
);
359 bp_temp
= b
->disposition
== disp_del
;
360 fprintf_unfiltered (fp
, bp_temp
? "tcatch " : "catch ");
364 fprintf_unfiltered (fp
, "throw");
367 fprintf_unfiltered (fp
, "catch");
369 case EX_EVENT_RETHROW
:
370 fprintf_unfiltered (fp
, "rethrow");
373 print_recreate_thread (b
, fp
);
377 handle_gnu_v3_exceptions (int tempflag
, char *except_rx
, char *cond_string
,
378 enum exception_event_kind ex_event
, int from_tty
)
380 struct exception_catchpoint
*cp
;
381 struct cleanup
*cleanup
= make_cleanup (null_cleanup
, NULL
);
382 regex_t
*pattern
= NULL
;
384 if (except_rx
!= NULL
)
386 pattern
= XNEW (regex_t
);
387 make_cleanup (xfree
, pattern
);
389 compile_rx_or_error (pattern
, except_rx
,
390 _("invalid type-matching regexp"));
393 cp
= XCNEW (struct exception_catchpoint
);
394 make_cleanup (xfree
, cp
);
396 init_catchpoint (&cp
->base
, get_current_arch (), tempflag
, cond_string
,
397 &gnu_v3_exception_catchpoint_ops
);
398 /* We need to reset 'type' in order for code in breakpoint.c to do
400 cp
->base
.type
= bp_breakpoint
;
402 cp
->exception_rx
= except_rx
;
403 cp
->pattern
= pattern
;
405 re_set_exception_catchpoint (&cp
->base
);
407 install_breakpoint (0, &cp
->base
, 1);
408 discard_cleanups (cleanup
);
411 /* Look for an "if" token in *STRING. The "if" token must be preceded
414 If there is any non-whitespace text between *STRING and the "if"
415 token, then it is returned in a newly-xmalloc'd string. Otherwise,
418 STRING is updated to point to the "if" token, if it exists, or to
419 the end of the string. */
422 extract_exception_regexp (char **string
)
425 char *last
, *last_space
;
427 start
= skip_spaces (*string
);
431 while (*last
!= '\0')
433 char *if_token
= last
;
435 /* Check for the "if". */
436 if (check_for_argument (&if_token
, "if", 2))
439 /* No "if" token here. Skip to the next word start. */
440 last_space
= skip_to_space (last
);
441 last
= skip_spaces (last_space
);
445 if (last_space
> start
)
446 return savestring (start
, last_space
- start
);
450 /* Deal with "catch catch", "catch throw", and "catch rethrow"
454 catch_exception_command_1 (enum exception_event_kind ex_event
, char *arg
,
455 int tempflag
, int from_tty
)
458 char *cond_string
= NULL
;
459 struct cleanup
*cleanup
;
463 arg
= skip_spaces (arg
);
465 except_rx
= extract_exception_regexp (&arg
);
466 cleanup
= make_cleanup (xfree
, except_rx
);
468 cond_string
= ep_parse_optional_if_clause (&arg
);
470 if ((*arg
!= '\0') && !isspace (*arg
))
471 error (_("Junk at end of arguments."));
473 if (ex_event
!= EX_EVENT_THROW
474 && ex_event
!= EX_EVENT_CATCH
475 && ex_event
!= EX_EVENT_RETHROW
)
476 error (_("Unsupported or unknown exception event; cannot catch it"));
478 handle_gnu_v3_exceptions (tempflag
, except_rx
, cond_string
,
481 discard_cleanups (cleanup
);
484 /* Implementation of "catch catch" command. */
487 catch_catch_command (char *arg
, int from_tty
, struct cmd_list_element
*command
)
489 int tempflag
= get_cmd_context (command
) == CATCH_TEMPORARY
;
491 catch_exception_command_1 (EX_EVENT_CATCH
, arg
, tempflag
, from_tty
);
494 /* Implementation of "catch throw" command. */
497 catch_throw_command (char *arg
, int from_tty
, struct cmd_list_element
*command
)
499 int tempflag
= get_cmd_context (command
) == CATCH_TEMPORARY
;
501 catch_exception_command_1 (EX_EVENT_THROW
, arg
, tempflag
, from_tty
);
504 /* Implementation of "catch rethrow" command. */
507 catch_rethrow_command (char *arg
, int from_tty
,
508 struct cmd_list_element
*command
)
510 int tempflag
= get_cmd_context (command
) == CATCH_TEMPORARY
;
512 catch_exception_command_1 (EX_EVENT_RETHROW
, arg
, tempflag
, from_tty
);
517 /* Implement the 'make_value' method for the $_exception
520 static struct value
*
521 compute_exception (struct gdbarch
*argc
, struct internalvar
*var
, void *ignore
)
523 struct value
*arg0
, *arg1
;
524 struct type
*obj_type
;
526 fetch_probe_arguments (&arg0
, &arg1
);
528 /* ARG0 is a pointer to the exception object. ARG1 is a pointer to
529 the std::type_info for the exception. Now we find the type from
530 the type_info and cast the result. */
531 obj_type
= cplus_type_from_type_info (arg1
);
532 return value_ind (value_cast (make_pointer_type (obj_type
, NULL
), arg0
));
535 /* Implementation of the '$_exception' variable. */
537 static const struct internalvar_funcs exception_funcs
=
547 initialize_throw_catchpoint_ops (void)
549 struct breakpoint_ops
*ops
;
551 initialize_breakpoint_ops ();
553 /* GNU v3 exception catchpoints. */
554 ops
= &gnu_v3_exception_catchpoint_ops
;
555 *ops
= bkpt_breakpoint_ops
;
556 ops
->dtor
= dtor_exception_catchpoint
;
557 ops
->re_set
= re_set_exception_catchpoint
;
558 ops
->print_it
= print_it_exception_catchpoint
;
559 ops
->print_one
= print_one_exception_catchpoint
;
560 ops
->print_mention
= print_mention_exception_catchpoint
;
561 ops
->print_recreate
= print_recreate_exception_catchpoint
;
562 ops
->print_one_detail
= print_one_detail_exception_catchpoint
;
563 ops
->check_status
= check_status_exception_catchpoint
;
566 initialize_file_ftype _initialize_break_catch_throw
;
569 _initialize_break_catch_throw (void)
571 initialize_throw_catchpoint_ops ();
573 /* Add catch and tcatch sub-commands. */
574 add_catch_command ("catch", _("\
575 Catch an exception, when caught."),
580 add_catch_command ("throw", _("\
581 Catch an exception, when thrown."),
586 add_catch_command ("rethrow", _("\
587 Catch an exception, when rethrown."),
588 catch_rethrow_command
,
593 create_internalvar_type_lazy ("_exception", &exception_funcs
, NULL
);