gdb/break-catch-throw.c

   1 /* Everything about catch/throw catchpoints, for GDB.
   2
   3    Copyright (C) 1986-2019 Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   6
   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.
  11
  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.
  16
  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/>.  */
  19
  20 #include "defs.h"
  21 #include "arch-utils.h"
  22 #include <ctype.h>
  23 #include "breakpoint.h"
  24 #include "gdbcmd.h"
  25 #include "inferior.h"
  26 #include "annotate.h"
  27 #include "valprint.h"
  28 #include "cli/cli-utils.h"
  29 #include "completer.h"
  30 #include "gdb_obstack.h"
  31 #include "mi/mi-common.h"
  32 #include "linespec.h"
  33 #include "probe.h"
  34 #include "objfiles.h"
  35 #include "cp-abi.h"
  36 #include "gdb_regex.h"
  37 #include "cp-support.h"
  38 #include "location.h"
  39
  40 /* Enums for exception-handling support.  */
  41 enum exception_event_kind
  42 {
  43   EX_EVENT_THROW,
  44   EX_EVENT_RETHROW,
  45   EX_EVENT_CATCH
  46 };
  47
  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.  */
  51
  52 struct exception_names
  53 {
  54   /* The name of the probe point to try, in the form accepted by
  55      'parse_probes'.  */
  56
  57   const char *probe;
  58
  59   /* The name of the corresponding function.  */
  60
  61   const char *function;
  62 };
  63
  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[] =
  67 {
  68   { "-probe-stap libstdcxx:throw", "__cxa_throw" },
  69   { "-probe-stap libstdcxx:rethrow", "__cxa_rethrow" },
  70   { "-probe-stap libstdcxx:catch", "__cxa_begin_catch" }
  71 };
  72
  73 static struct breakpoint_ops gnu_v3_exception_catchpoint_ops;
  74
  75 /* The type of an exception catchpoint.  */
  76
  77 struct exception_catchpoint : public breakpoint
  78 {
  79   /* The kind of exception catchpoint.  */
  80
  81   enum exception_event_kind kind;
  82
  83   /* If not empty, a string holding the source form of the regular
  84      expression to match against.  */
  85
  86   std::string exception_rx;
  87
  88   /* If non-NULL, a compiled regular expression which is used to
  89      determine which exceptions to stop on.  */
  90
  91   std::unique_ptr<compiled_regex> pattern;
  92 };
  93
  94 \f
  95
  96 /* A helper function that fetches exception probe arguments.  This
  97    fills in *ARG0 (if non-NULL) and *ARG1 (which must be non-NULL).
  98    It will throw an exception on any kind of failure.  */
  99
 100 static void
 101 fetch_probe_arguments (struct value **arg0, struct value **arg1)
 102 {
 103   struct frame_info *frame = get_selected_frame (_("No frame selected"));
 104   CORE_ADDR pc = get_frame_pc (frame);
 105   struct bound_probe pc_probe;
 106   unsigned n_args;
 107
 108   pc_probe = find_probe_by_pc (pc);
 109   if (pc_probe.prob == NULL
 110       || pc_probe.prob->get_provider () != "libstdcxx"
 111       || (pc_probe.prob->get_name () != "catch"
 112           && pc_probe.prob->get_name () != "throw"
 113           && pc_probe.prob->get_name () != "rethrow"))
 114     error (_("not stopped at a C++ exception catchpoint"));
 115
 116   n_args = pc_probe.prob->get_argument_count (frame);
 117   if (n_args < 2)
 118     error (_("C++ exception catchpoint has too few arguments"));
 119
 120   if (arg0 != NULL)
 121     *arg0 = pc_probe.prob->evaluate_argument (0, frame);
 122   *arg1 = pc_probe.prob->evaluate_argument (1, frame);
 123
 124   if ((arg0 != NULL && *arg0 == NULL) || *arg1 == NULL)
 125     error (_("error computing probe argument at c++ exception catchpoint"));
 126 }
 127
 128 \f
 129
 130 /* A helper function that returns a value indicating the kind of the
 131    exception catchpoint B.  */
 132
 133 static enum exception_event_kind
 134 classify_exception_breakpoint (struct breakpoint *b)
 135 {
 136   struct exception_catchpoint *cp = (struct exception_catchpoint *) b;
 137
 138   return cp->kind;
 139 }
 140
 141 /* Implement the 'check_status' method.  */
 142
 143 static void
 144 check_status_exception_catchpoint (struct bpstats *bs)
 145 {
 146   struct exception_catchpoint *self
 147     = (struct exception_catchpoint *) bs->breakpoint_at;
 148   std::string type_name;
 149
 150   bkpt_breakpoint_ops.check_status (bs);
 151   if (bs->stop == 0)
 152     return;
 153
 154   if (self->pattern == NULL)
 155     return;
 156
 157   TRY
 158     {
 159       struct value *typeinfo_arg;
 160       std::string canon;
 161
 162       fetch_probe_arguments (NULL, &typeinfo_arg);
 163       type_name = cplus_typename_from_type_info (typeinfo_arg);
 164
 165       canon = cp_canonicalize_string (type_name.c_str ());
 166       if (!canon.empty ())
 167         std::swap (type_name, canon);
 168     }
 169   CATCH (e, RETURN_MASK_ERROR)
 170     {
 171       exception_print (gdb_stderr, e);
 172     }
 173   END_CATCH
 174
 175   if (!type_name.empty ())
 176     {
 177       if (self->pattern->exec (type_name.c_str (), 0, NULL, 0) != 0)
 178         bs->stop = 0;
 179     }
 180 }
 181
 182 /* Implement the 're_set' method.  */
 183
 184 static void
 185 re_set_exception_catchpoint (struct breakpoint *self)
 186 {
 187   std::vector<symtab_and_line> sals;
 188   enum exception_event_kind kind = classify_exception_breakpoint (self);
 189   struct program_space *filter_pspace = current_program_space;
 190
 191   /* We first try to use the probe interface.  */
 192   TRY
 193     {
 194       event_location_up location
 195         = new_probe_location (exception_functions[kind].probe);
 196       sals = parse_probes (location.get (), filter_pspace, NULL);
 197     }
 198   CATCH (e, RETURN_MASK_ERROR)
 199     {
 200       /* Using the probe interface failed.  Let's fallback to the normal
 201          catchpoint mode.  */
 202       TRY
 203         {
 204           struct explicit_location explicit_loc;
 205
 206           initialize_explicit_location (&explicit_loc);
 207           explicit_loc.function_name
 208             = ASTRDUP (exception_functions[kind].function);
 209           event_location_up location = new_explicit_location (&explicit_loc);
 210           sals = self->ops->decode_location (self, location.get (),
 211                                              filter_pspace);
 212         }
 213       CATCH (ex, RETURN_MASK_ERROR)
 214         {
 215           /* NOT_FOUND_ERROR just means the breakpoint will be
 216              pending, so let it through.  */
 217           if (ex.error != NOT_FOUND_ERROR)
 218             throw_exception (ex);
 219         }
 220       END_CATCH
 221     }
 222   END_CATCH
 223
 224   update_breakpoint_locations (self, filter_pspace, sals, {});
 225 }
 226
 227 static enum print_stop_action
 228 print_it_exception_catchpoint (bpstat bs)
 229 {
 230   struct ui_out *uiout = current_uiout;
 231   struct breakpoint *b = bs->breakpoint_at;
 232   int bp_temp;
 233   enum exception_event_kind kind = classify_exception_breakpoint (b);
 234
 235   annotate_catchpoint (b->number);
 236   maybe_print_thread_hit_breakpoint (uiout);
 237
 238   bp_temp = b->disposition == disp_del;
 239   uiout->text (bp_temp ? "Temporary catchpoint "
 240                        : "Catchpoint ");
 241   uiout->field_int ("bkptno", b->number);
 242   uiout->text ((kind == EX_EVENT_THROW ? " (exception thrown), "
 243                 : (kind == EX_EVENT_CATCH ? " (exception caught), "
 244                    : " (exception rethrown), ")));
 245   if (uiout->is_mi_like_p ())
 246     {
 247       uiout->field_string ("reason",
 248                            async_reason_lookup (EXEC_ASYNC_BREAKPOINT_HIT));
 249       uiout->field_string ("disp", bpdisp_text (b->disposition));
 250     }
 251   return PRINT_SRC_AND_LOC;
 252 }
 253
 254 static void
 255 print_one_exception_catchpoint (struct breakpoint *b,
 256                                 struct bp_location **last_loc)
 257 {
 258   struct value_print_options opts;
 259   struct ui_out *uiout = current_uiout;
 260   enum exception_event_kind kind = classify_exception_breakpoint (b);
 261
 262   get_user_print_options (&opts);
 263   if (opts.addressprint)
 264     {
 265       annotate_field (4);
 266       if (b->loc == NULL || b->loc->shlib_disabled)
 267         uiout->field_string ("addr", "<PENDING>");
 268       else
 269         uiout->field_core_addr ("addr",
 270                                 b->loc->gdbarch, b->loc->address);
 271     }
 272   annotate_field (5);
 273   if (b->loc)
 274     *last_loc = b->loc;
 275
 276   switch (kind)
 277     {
 278     case EX_EVENT_THROW:
 279       uiout->field_string ("what", "exception throw");
 280       if (uiout->is_mi_like_p ())
 281         uiout->field_string ("catch-type", "throw");
 282       break;
 283
 284     case EX_EVENT_RETHROW:
 285       uiout->field_string ("what", "exception rethrow");
 286       if (uiout->is_mi_like_p ())
 287         uiout->field_string ("catch-type", "rethrow");
 288       break;
 289
 290     case EX_EVENT_CATCH:
 291       uiout->field_string ("what", "exception catch");
 292       if (uiout->is_mi_like_p ())
 293         uiout->field_string ("catch-type", "catch");
 294       break;
 295     }
 296 }
 297
 298 /* Implement the 'print_one_detail' method.  */
 299
 300 static void
 301 print_one_detail_exception_catchpoint (const struct breakpoint *b,
 302                                        struct ui_out *uiout)
 303 {
 304   const struct exception_catchpoint *cp
 305     = (const struct exception_catchpoint *) b;
 306
 307   if (!cp->exception_rx.empty ())
 308     {
 309       uiout->text (_("\tmatching: "));
 310       uiout->field_string ("regexp", cp->exception_rx.c_str ());
 311       uiout->text ("\n");
 312     }
 313 }
 314
 315 static void
 316 print_mention_exception_catchpoint (struct breakpoint *b)
 317 {
 318   struct ui_out *uiout = current_uiout;
 319   int bp_temp;
 320   enum exception_event_kind kind = classify_exception_breakpoint (b);
 321
 322   bp_temp = b->disposition == disp_del;
 323   uiout->text (bp_temp ? _("Temporary catchpoint ")
 324                               : _("Catchpoint "));
 325   uiout->field_int ("bkptno", b->number);
 326   uiout->text ((kind == EX_EVENT_THROW ? _(" (throw)")
 327                        : (kind == EX_EVENT_CATCH ? _(" (catch)")
 328                           : _(" (rethrow)"))));
 329 }
 330
 331 /* Implement the "print_recreate" breakpoint_ops method for throw and
 332    catch catchpoints.  */
 333
 334 static void
 335 print_recreate_exception_catchpoint (struct breakpoint *b,
 336                                      struct ui_file *fp)
 337 {
 338   int bp_temp;
 339   enum exception_event_kind kind = classify_exception_breakpoint (b);
 340
 341   bp_temp = b->disposition == disp_del;
 342   fprintf_unfiltered (fp, bp_temp ? "tcatch " : "catch ");
 343   switch (kind)
 344     {
 345     case EX_EVENT_THROW:
 346       fprintf_unfiltered (fp, "throw");
 347       break;
 348     case EX_EVENT_CATCH:
 349       fprintf_unfiltered (fp, "catch");
 350       break;
 351     case EX_EVENT_RETHROW:
 352       fprintf_unfiltered (fp, "rethrow");
 353       break;
 354     }
 355   print_recreate_thread (b, fp);
 356 }
 357
 358 static void
 359 handle_gnu_v3_exceptions (int tempflag, std::string &&except_rx,
 360                           const char *cond_string,
 361                           enum exception_event_kind ex_event, int from_tty)
 362 {
 363   std::unique_ptr<compiled_regex> pattern;
 364
 365   if (!except_rx.empty ())
 366     {
 367       pattern.reset (new compiled_regex (except_rx.c_str (), REG_NOSUB,
 368                                          _("invalid type-matching regexp")));
 369     }
 370
 371   std::unique_ptr<exception_catchpoint> cp (new exception_catchpoint ());
 372
 373   init_catchpoint (cp.get (), get_current_arch (), tempflag, cond_string,
 374                    &gnu_v3_exception_catchpoint_ops);
 375   /* We need to reset 'type' in order for code in breakpoint.c to do
 376      the right thing.  */
 377   cp->type = bp_breakpoint;
 378   cp->kind = ex_event;
 379   cp->exception_rx = std::move (except_rx);
 380   cp->pattern = std::move (pattern);
 381
 382   re_set_exception_catchpoint (cp.get ());
 383
 384   install_breakpoint (0, std::move (cp), 1);
 385 }
 386
 387 /* Look for an "if" token in *STRING.  The "if" token must be preceded
 388    by whitespace.
 389
 390    If there is any non-whitespace text between *STRING and the "if"
 391    token, then it is returned in a newly-xmalloc'd string.  Otherwise,
 392    this returns NULL.
 393
 394    STRING is updated to point to the "if" token, if it exists, or to
 395    the end of the string.  */
 396
 397 static std::string
 398 extract_exception_regexp (const char **string)
 399 {
 400   const char *start;
 401   const char *last, *last_space;
 402
 403   start = skip_spaces (*string);
 404
 405   last = start;
 406   last_space = start;
 407   while (*last != '\0')
 408     {
 409       const char *if_token = last;
 410
 411       /* Check for the "if".  */
 412       if (check_for_argument (&if_token, "if", 2))
 413         break;
 414
 415       /* No "if" token here.  Skip to the next word start.  */
 416       last_space = skip_to_space (last);
 417       last = skip_spaces (last_space);
 418     }
 419
 420   *string = last;
 421   if (last_space > start)
 422     return std::string (start, last_space - start);
 423   return std::string ();
 424 }
 425
 426 /* Deal with "catch catch", "catch throw", and "catch rethrow"
 427    commands.  */
 428
 429 static void
 430 catch_exception_command_1 (enum exception_event_kind ex_event,
 431                            const char *arg,
 432                            int tempflag, int from_tty)
 433 {
 434   const char *cond_string = NULL;
 435
 436   if (!arg)
 437     arg = "";
 438   arg = skip_spaces (arg);
 439
 440   std::string except_rx = extract_exception_regexp (&arg);
 441
 442   cond_string = ep_parse_optional_if_clause (&arg);
 443
 444   if ((*arg != '\0') && !isspace (*arg))
 445     error (_("Junk at end of arguments."));
 446
 447   if (ex_event != EX_EVENT_THROW
 448       && ex_event != EX_EVENT_CATCH
 449       && ex_event != EX_EVENT_RETHROW)
 450     error (_("Unsupported or unknown exception event; cannot catch it"));
 451
 452   handle_gnu_v3_exceptions (tempflag, std::move (except_rx), cond_string,
 453                             ex_event, from_tty);
 454 }
 455
 456 /* Implementation of "catch catch" command.  */
 457
 458 static void
 459 catch_catch_command (const char *arg, int from_tty,
 460                      struct cmd_list_element *command)
 461 {
 462   int tempflag = get_cmd_context (command) == CATCH_TEMPORARY;
 463
 464   catch_exception_command_1 (EX_EVENT_CATCH, arg, tempflag, from_tty);
 465 }
 466
 467 /* Implementation of "catch throw" command.  */
 468
 469 static void
 470 catch_throw_command (const char *arg, int from_tty,
 471                      struct cmd_list_element *command)
 472 {
 473   int tempflag = get_cmd_context (command) == CATCH_TEMPORARY;
 474
 475   catch_exception_command_1 (EX_EVENT_THROW, arg, tempflag, from_tty);
 476 }
 477
 478 /* Implementation of "catch rethrow" command.  */
 479
 480 static void
 481 catch_rethrow_command (const char *arg, int from_tty,
 482                        struct cmd_list_element *command)
 483 {
 484   int tempflag = get_cmd_context (command) == CATCH_TEMPORARY;
 485
 486   catch_exception_command_1 (EX_EVENT_RETHROW, arg, tempflag, from_tty);
 487 }
 488
 489 \f
 490
 491 /* Implement the 'make_value' method for the $_exception
 492    internalvar.  */
 493
 494 static struct value *
 495 compute_exception (struct gdbarch *argc, struct internalvar *var, void *ignore)
 496 {
 497   struct value *arg0, *arg1;
 498   struct type *obj_type;
 499
 500   fetch_probe_arguments (&arg0, &arg1);
 501
 502   /* ARG0 is a pointer to the exception object.  ARG1 is a pointer to
 503      the std::type_info for the exception.  Now we find the type from
 504      the type_info and cast the result.  */
 505   obj_type = cplus_type_from_type_info (arg1);
 506   return value_ind (value_cast (make_pointer_type (obj_type, NULL), arg0));
 507 }
 508
 509 /* Implementation of the '$_exception' variable.  */
 510
 511 static const struct internalvar_funcs exception_funcs =
 512 {
 513   compute_exception,
 514   NULL,
 515   NULL
 516 };
 517
 518 \f
 519
 520 static void
 521 initialize_throw_catchpoint_ops (void)
 522 {
 523   struct breakpoint_ops *ops;
 524
 525   initialize_breakpoint_ops ();
 526
 527   /* GNU v3 exception catchpoints.  */
 528   ops = &gnu_v3_exception_catchpoint_ops;
 529   *ops = bkpt_breakpoint_ops;
 530   ops->re_set = re_set_exception_catchpoint;
 531   ops->print_it = print_it_exception_catchpoint;
 532   ops->print_one = print_one_exception_catchpoint;
 533   ops->print_mention = print_mention_exception_catchpoint;
 534   ops->print_recreate = print_recreate_exception_catchpoint;
 535   ops->print_one_detail = print_one_detail_exception_catchpoint;
 536   ops->check_status = check_status_exception_catchpoint;
 537 }
 538
 539 void
 540 _initialize_break_catch_throw (void)
 541 {
 542   initialize_throw_catchpoint_ops ();
 543
 544   /* Add catch and tcatch sub-commands.  */
 545   add_catch_command ("catch", _("\
 546 Catch an exception, when caught."),
 547                      catch_catch_command,
 548                      NULL,
 549                      CATCH_PERMANENT,
 550                      CATCH_TEMPORARY);
 551   add_catch_command ("throw", _("\
 552 Catch an exception, when thrown."),
 553                      catch_throw_command,
 554                      NULL,
 555                      CATCH_PERMANENT,
 556                      CATCH_TEMPORARY);
 557   add_catch_command ("rethrow", _("\
 558 Catch an exception, when rethrown."),
 559                      catch_rethrow_command,
 560                      NULL,
 561                      CATCH_PERMANENT,
 562                      CATCH_TEMPORARY);
 563
 564   create_internalvar_type_lazy ("_exception", &exception_funcs, NULL);
 565 }