1 /* Everything about catch/throw catchpoints, for GDB.
3 Copyright (C) 1986-2017 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"
40 /* Enums for exception-handling support. */
41 enum exception_event_kind
48 /* Each spot where we may place an exception-related catchpoint has
49 two names: the SDT probe point and the function name. This
50 structure holds both. */
52 struct exception_names
54 /* The name of the probe point to try, in the form accepted by
59 /* The name of the corresponding function. */
64 /* Names of the probe points and functions on which to break. This is
65 indexed by exception_event_kind. */
66 static const struct exception_names exception_functions
[] =
68 { "-probe-stap libstdcxx:throw", "__cxa_throw" },
69 { "-probe-stap libstdcxx:rethrow", "__cxa_rethrow" },
70 { "-probe-stap libstdcxx:catch", "__cxa_begin_catch" }
73 static struct breakpoint_ops gnu_v3_exception_catchpoint_ops
;
75 /* The type of an exception catchpoint. */
77 struct exception_catchpoint
81 struct breakpoint base
;
83 /* The kind of exception catchpoint. */
85 enum exception_event_kind kind
;
87 /* If non-NULL, an xmalloc'd string holding the source form of the
88 regular expression to match against. */
92 /* If non-NULL, an xmalloc'd, compiled regular expression which is
93 used to determine which exceptions to stop on. */
100 /* A helper function that fetches exception probe arguments. This
101 fills in *ARG0 (if non-NULL) and *ARG1 (which must be non-NULL).
102 It will throw an exception on any kind of failure. */
105 fetch_probe_arguments (struct value
**arg0
, struct value
**arg1
)
107 struct frame_info
*frame
= get_selected_frame (_("No frame selected"));
108 CORE_ADDR pc
= get_frame_pc (frame
);
109 struct bound_probe pc_probe
;
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 std::string type_name
;
167 bkpt_breakpoint_ops
.check_status (bs
);
171 if (self
->pattern
== NULL
)
176 struct value
*typeinfo_arg
;
179 fetch_probe_arguments (NULL
, &typeinfo_arg
);
180 type_name
= cplus_typename_from_type_info (typeinfo_arg
);
182 canon
= cp_canonicalize_string (type_name
.c_str ());
184 std::swap (type_name
, canon
);
186 CATCH (e
, RETURN_MASK_ERROR
)
188 exception_print (gdb_stderr
, e
);
192 if (!type_name
.empty ())
194 if (regexec (self
->pattern
, type_name
.c_str (), 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 struct cleanup
*cleanup
;
207 enum exception_event_kind kind
= classify_exception_breakpoint (self
);
208 struct program_space
*filter_pspace
= current_program_space
;
210 /* We first try to use the probe interface. */
213 event_location_up location
214 = new_probe_location (exception_functions
[kind
].probe
);
215 sals
= parse_probes (location
.get (), filter_pspace
, NULL
);
217 CATCH (e
, RETURN_MASK_ERROR
)
219 /* Using the probe interface failed. Let's fallback to the normal
223 struct explicit_location explicit_loc
;
225 initialize_explicit_location (&explicit_loc
);
226 explicit_loc
.function_name
227 = ASTRDUP (exception_functions
[kind
].function
);
228 event_location_up location
= new_explicit_location (&explicit_loc
);
229 self
->ops
->decode_location (self
, location
.get (), filter_pspace
,
232 CATCH (ex
, RETURN_MASK_ERROR
)
234 /* NOT_FOUND_ERROR just means the breakpoint will be
235 pending, so let it through. */
236 if (ex
.error
!= NOT_FOUND_ERROR
)
237 throw_exception (ex
);
243 cleanup
= make_cleanup (xfree
, sals
.sals
);
244 update_breakpoint_locations (self
, filter_pspace
, sals
, sals_end
);
245 do_cleanups (cleanup
);
248 static enum print_stop_action
249 print_it_exception_catchpoint (bpstat bs
)
251 struct ui_out
*uiout
= current_uiout
;
252 struct breakpoint
*b
= bs
->breakpoint_at
;
254 enum exception_event_kind kind
= classify_exception_breakpoint (b
);
256 annotate_catchpoint (b
->number
);
257 maybe_print_thread_hit_breakpoint (uiout
);
259 bp_temp
= b
->disposition
== disp_del
;
260 uiout
->text (bp_temp
? "Temporary catchpoint "
262 if (!uiout
->is_mi_like_p ())
263 uiout
->field_int ("bkptno", b
->number
);
264 uiout
->text ((kind
== EX_EVENT_THROW
? " (exception thrown), "
265 : (kind
== EX_EVENT_CATCH
? " (exception caught), "
266 : " (exception rethrown), ")));
267 if (uiout
->is_mi_like_p ())
269 uiout
->field_string ("reason",
270 async_reason_lookup (EXEC_ASYNC_BREAKPOINT_HIT
));
271 uiout
->field_string ("disp", bpdisp_text (b
->disposition
));
272 uiout
->field_int ("bkptno", b
->number
);
274 return PRINT_SRC_AND_LOC
;
278 print_one_exception_catchpoint (struct breakpoint
*b
,
279 struct bp_location
**last_loc
)
281 struct value_print_options opts
;
282 struct ui_out
*uiout
= current_uiout
;
283 enum exception_event_kind kind
= classify_exception_breakpoint (b
);
285 get_user_print_options (&opts
);
286 if (opts
.addressprint
)
289 if (b
->loc
== NULL
|| b
->loc
->shlib_disabled
)
290 uiout
->field_string ("addr", "<PENDING>");
292 uiout
->field_core_addr ("addr",
293 b
->loc
->gdbarch
, b
->loc
->address
);
302 uiout
->field_string ("what", "exception throw");
303 if (uiout
->is_mi_like_p ())
304 uiout
->field_string ("catch-type", "throw");
307 case EX_EVENT_RETHROW
:
308 uiout
->field_string ("what", "exception rethrow");
309 if (uiout
->is_mi_like_p ())
310 uiout
->field_string ("catch-type", "rethrow");
314 uiout
->field_string ("what", "exception catch");
315 if (uiout
->is_mi_like_p ())
316 uiout
->field_string ("catch-type", "catch");
321 /* Implement the 'print_one_detail' method. */
324 print_one_detail_exception_catchpoint (const struct breakpoint
*b
,
325 struct ui_out
*uiout
)
327 const struct exception_catchpoint
*cp
328 = (const struct exception_catchpoint
*) b
;
330 if (cp
->exception_rx
!= NULL
)
332 uiout
->text (_("\tmatching: "));
333 uiout
->field_string ("regexp", cp
->exception_rx
);
339 print_mention_exception_catchpoint (struct breakpoint
*b
)
341 struct ui_out
*uiout
= current_uiout
;
343 enum exception_event_kind kind
= classify_exception_breakpoint (b
);
345 bp_temp
= b
->disposition
== disp_del
;
346 uiout
->text (bp_temp
? _("Temporary catchpoint ")
348 uiout
->field_int ("bkptno", b
->number
);
349 uiout
->text ((kind
== EX_EVENT_THROW
? _(" (throw)")
350 : (kind
== EX_EVENT_CATCH
? _(" (catch)")
351 : _(" (rethrow)"))));
354 /* Implement the "print_recreate" breakpoint_ops method for throw and
355 catch catchpoints. */
358 print_recreate_exception_catchpoint (struct breakpoint
*b
,
362 enum exception_event_kind kind
= classify_exception_breakpoint (b
);
364 bp_temp
= b
->disposition
== disp_del
;
365 fprintf_unfiltered (fp
, bp_temp
? "tcatch " : "catch ");
369 fprintf_unfiltered (fp
, "throw");
372 fprintf_unfiltered (fp
, "catch");
374 case EX_EVENT_RETHROW
:
375 fprintf_unfiltered (fp
, "rethrow");
378 print_recreate_thread (b
, fp
);
382 handle_gnu_v3_exceptions (int tempflag
, char *except_rx
,
383 const char *cond_string
,
384 enum exception_event_kind ex_event
, int from_tty
)
386 regex_t
*pattern
= NULL
;
388 if (except_rx
!= NULL
)
390 pattern
= XNEW (regex_t
);
391 make_cleanup (xfree
, pattern
);
393 compile_rx_or_error (pattern
, except_rx
,
394 _("invalid type-matching regexp"));
397 std::unique_ptr
<exception_catchpoint
> cp (new exception_catchpoint ());
399 init_catchpoint (&cp
->base
, get_current_arch (), tempflag
, cond_string
,
400 &gnu_v3_exception_catchpoint_ops
);
401 /* We need to reset 'type' in order for code in breakpoint.c to do
403 cp
->base
.type
= bp_breakpoint
;
405 cp
->exception_rx
= except_rx
;
406 cp
->pattern
= pattern
;
408 re_set_exception_catchpoint (&cp
->base
);
410 install_breakpoint (0, &cp
->base
, 1);
414 /* Look for an "if" token in *STRING. The "if" token must be preceded
417 If there is any non-whitespace text between *STRING and the "if"
418 token, then it is returned in a newly-xmalloc'd string. Otherwise,
421 STRING is updated to point to the "if" token, if it exists, or to
422 the end of the string. */
425 extract_exception_regexp (const char **string
)
428 const char *last
, *last_space
;
430 start
= skip_spaces_const (*string
);
434 while (*last
!= '\0')
436 const char *if_token
= last
;
438 /* Check for the "if". */
439 if (check_for_argument (&if_token
, "if", 2))
442 /* No "if" token here. Skip to the next word start. */
443 last_space
= skip_to_space (last
);
444 last
= skip_spaces_const (last_space
);
448 if (last_space
> start
)
449 return savestring (start
, last_space
- start
);
453 /* Deal with "catch catch", "catch throw", and "catch rethrow"
457 catch_exception_command_1 (enum exception_event_kind ex_event
,
459 int tempflag
, int from_tty
)
462 const char *cond_string
= NULL
;
463 struct cleanup
*cleanup
;
464 const char *arg
= arg_entry
;
468 arg
= skip_spaces_const (arg
);
470 except_rx
= extract_exception_regexp (&arg
);
471 cleanup
= make_cleanup (xfree
, except_rx
);
473 cond_string
= ep_parse_optional_if_clause (&arg
);
475 if ((*arg
!= '\0') && !isspace (*arg
))
476 error (_("Junk at end of arguments."));
478 if (ex_event
!= EX_EVENT_THROW
479 && ex_event
!= EX_EVENT_CATCH
480 && ex_event
!= EX_EVENT_RETHROW
)
481 error (_("Unsupported or unknown exception event; cannot catch it"));
483 handle_gnu_v3_exceptions (tempflag
, except_rx
, cond_string
,
486 discard_cleanups (cleanup
);
489 /* Implementation of "catch catch" command. */
492 catch_catch_command (char *arg
, int from_tty
, struct cmd_list_element
*command
)
494 int tempflag
= get_cmd_context (command
) == CATCH_TEMPORARY
;
496 catch_exception_command_1 (EX_EVENT_CATCH
, arg
, tempflag
, from_tty
);
499 /* Implementation of "catch throw" command. */
502 catch_throw_command (char *arg
, int from_tty
, struct cmd_list_element
*command
)
504 int tempflag
= get_cmd_context (command
) == CATCH_TEMPORARY
;
506 catch_exception_command_1 (EX_EVENT_THROW
, arg
, tempflag
, from_tty
);
509 /* Implementation of "catch rethrow" command. */
512 catch_rethrow_command (char *arg
, int from_tty
,
513 struct cmd_list_element
*command
)
515 int tempflag
= get_cmd_context (command
) == CATCH_TEMPORARY
;
517 catch_exception_command_1 (EX_EVENT_RETHROW
, arg
, tempflag
, from_tty
);
522 /* Implement the 'make_value' method for the $_exception
525 static struct value
*
526 compute_exception (struct gdbarch
*argc
, struct internalvar
*var
, void *ignore
)
528 struct value
*arg0
, *arg1
;
529 struct type
*obj_type
;
531 fetch_probe_arguments (&arg0
, &arg1
);
533 /* ARG0 is a pointer to the exception object. ARG1 is a pointer to
534 the std::type_info for the exception. Now we find the type from
535 the type_info and cast the result. */
536 obj_type
= cplus_type_from_type_info (arg1
);
537 return value_ind (value_cast (make_pointer_type (obj_type
, NULL
), arg0
));
540 /* Implementation of the '$_exception' variable. */
542 static const struct internalvar_funcs exception_funcs
=
552 initialize_throw_catchpoint_ops (void)
554 struct breakpoint_ops
*ops
;
556 initialize_breakpoint_ops ();
558 /* GNU v3 exception catchpoints. */
559 ops
= &gnu_v3_exception_catchpoint_ops
;
560 *ops
= bkpt_breakpoint_ops
;
561 ops
->dtor
= dtor_exception_catchpoint
;
562 ops
->re_set
= re_set_exception_catchpoint
;
563 ops
->print_it
= print_it_exception_catchpoint
;
564 ops
->print_one
= print_one_exception_catchpoint
;
565 ops
->print_mention
= print_mention_exception_catchpoint
;
566 ops
->print_recreate
= print_recreate_exception_catchpoint
;
567 ops
->print_one_detail
= print_one_detail_exception_catchpoint
;
568 ops
->check_status
= check_status_exception_catchpoint
;
571 initialize_file_ftype _initialize_break_catch_throw
;
574 _initialize_break_catch_throw (void)
576 initialize_throw_catchpoint_ops ();
578 /* Add catch and tcatch sub-commands. */
579 add_catch_command ("catch", _("\
580 Catch an exception, when caught."),
585 add_catch_command ("throw", _("\
586 Catch an exception, when thrown."),
591 add_catch_command ("rethrow", _("\
592 Catch an exception, when rethrown."),
593 catch_rethrow_command
,
598 create_internalvar_type_lazy ("_exception", &exception_funcs
, NULL
);