gdb/python/py-breakpoint.c

   1 /* Python interface to breakpoints
   2
   3    Copyright (C) 2008-2021 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 "value.h"
  22 #include "python-internal.h"
  23 #include "python.h"
  24 #include "charset.h"
  25 #include "breakpoint.h"
  26 #include "gdbcmd.h"
  27 #include "gdbthread.h"
  28 #include "observable.h"
  29 #include "cli/cli-script.h"
  30 #include "ada-lang.h"
  31 #include "arch-utils.h"
  32 #include "language.h"
  33 #include "location.h"
  34 #include "py-event.h"
  35 #include "linespec.h"
  36
  37 /* Number of live breakpoints.  */
  38 static int bppy_live;
  39
  40 /* Variables used to pass information between the Breakpoint
  41    constructor and the breakpoint-created hook function.  */
  42 gdbpy_breakpoint_object *bppy_pending_object;
  43
  44 /* Function that is called when a Python condition is evaluated.  */
  45 static const char stop_func[] = "stop";
  46
  47 /* This is used to initialize various gdb.bp_* constants.  */
  48 struct pybp_code
  49 {
  50   /* The name.  */
  51   const char *name;
  52   /* The code.  */
  53   int code;
  54 };
  55
  56 /* Entries related to the type of user set breakpoints.  */
  57 static struct pybp_code pybp_codes[] =
  58 {
  59   { "BP_NONE", bp_none},
  60   { "BP_BREAKPOINT", bp_breakpoint},
  61   { "BP_HARDWARE_BREAKPOINT", bp_hardware_breakpoint},
  62   { "BP_WATCHPOINT", bp_watchpoint},
  63   { "BP_HARDWARE_WATCHPOINT", bp_hardware_watchpoint},
  64   { "BP_READ_WATCHPOINT", bp_read_watchpoint},
  65   { "BP_ACCESS_WATCHPOINT", bp_access_watchpoint},
  66   {NULL} /* Sentinel.  */
  67 };
  68
  69 /* Entries related to the type of watchpoint.  */
  70 static struct pybp_code pybp_watch_types[] =
  71 {
  72   { "WP_READ", hw_read},
  73   { "WP_WRITE", hw_write},
  74   { "WP_ACCESS", hw_access},
  75   {NULL} /* Sentinel.  */
  76 };
  77
  78 /* Python function which checks the validity of a breakpoint object.  */
  79 static PyObject *
  80 bppy_is_valid (PyObject *self, PyObject *args)
  81 {
  82   gdbpy_breakpoint_object *self_bp = (gdbpy_breakpoint_object *) self;
  83
  84   if (self_bp->bp)
  85     Py_RETURN_TRUE;
  86   Py_RETURN_FALSE;
  87 }
  88
  89 /* Python function to test whether or not the breakpoint is enabled.  */
  90 static PyObject *
  91 bppy_get_enabled (PyObject *self, void *closure)
  92 {
  93   gdbpy_breakpoint_object *self_bp = (gdbpy_breakpoint_object *) self;
  94
  95   BPPY_REQUIRE_VALID (self_bp);
  96   if (! self_bp->bp)
  97     Py_RETURN_FALSE;
  98   if (self_bp->bp->enable_state == bp_enabled)
  99     Py_RETURN_TRUE;
 100   Py_RETURN_FALSE;
 101 }
 102
 103 /* Python function to test whether or not the breakpoint is silent.  */
 104 static PyObject *
 105 bppy_get_silent (PyObject *self, void *closure)
 106 {
 107   gdbpy_breakpoint_object *self_bp = (gdbpy_breakpoint_object *) self;
 108
 109   BPPY_REQUIRE_VALID (self_bp);
 110   if (self_bp->bp->silent)
 111     Py_RETURN_TRUE;
 112   Py_RETURN_FALSE;
 113 }
 114
 115 /* Python function to set the enabled state of a breakpoint.  */
 116 static int
 117 bppy_set_enabled (PyObject *self, PyObject *newvalue, void *closure)
 118 {
 119   gdbpy_breakpoint_object *self_bp = (gdbpy_breakpoint_object *) self;
 120   int cmp;
 121
 122   BPPY_SET_REQUIRE_VALID (self_bp);
 123
 124   if (newvalue == NULL)
 125     {
 126       PyErr_SetString (PyExc_TypeError,
 127                        _("Cannot delete `enabled' attribute."));
 128
 129       return -1;
 130     }
 131   else if (! PyBool_Check (newvalue))
 132     {
 133       PyErr_SetString (PyExc_TypeError,
 134                        _("The value of `enabled' must be a boolean."));
 135       return -1;
 136     }
 137
 138   cmp = PyObject_IsTrue (newvalue);
 139   if (cmp < 0)
 140     return -1;
 141
 142   try
 143     {
 144       if (cmp == 1)
 145         enable_breakpoint (self_bp->bp);
 146       else
 147         disable_breakpoint (self_bp->bp);
 148     }
 149   catch (const gdb_exception &except)
 150     {
 151       GDB_PY_SET_HANDLE_EXCEPTION (except);
 152     }
 153
 154   return 0;
 155 }
 156
 157 /* Python function to set the 'silent' state of a breakpoint.  */
 158 static int
 159 bppy_set_silent (PyObject *self, PyObject *newvalue, void *closure)
 160 {
 161   gdbpy_breakpoint_object *self_bp = (gdbpy_breakpoint_object *) self;
 162   int cmp;
 163
 164   BPPY_SET_REQUIRE_VALID (self_bp);
 165
 166   if (newvalue == NULL)
 167     {
 168       PyErr_SetString (PyExc_TypeError,
 169                        _("Cannot delete `silent' attribute."));
 170       return -1;
 171     }
 172   else if (! PyBool_Check (newvalue))
 173     {
 174       PyErr_SetString (PyExc_TypeError,
 175                        _("The value of `silent' must be a boolean."));
 176       return -1;
 177     }
 178
 179   cmp = PyObject_IsTrue (newvalue);
 180   if (cmp < 0)
 181     return -1;
 182   else
 183     breakpoint_set_silent (self_bp->bp, cmp);
 184
 185   return 0;
 186 }
 187
 188 /* Python function to set the thread of a breakpoint.  */
 189 static int
 190 bppy_set_thread (PyObject *self, PyObject *newvalue, void *closure)
 191 {
 192   gdbpy_breakpoint_object *self_bp = (gdbpy_breakpoint_object *) self;
 193   long id;
 194
 195   BPPY_SET_REQUIRE_VALID (self_bp);
 196
 197   if (newvalue == NULL)
 198     {
 199       PyErr_SetString (PyExc_TypeError,
 200                        _("Cannot delete `thread' attribute."));
 201       return -1;
 202     }
 203   else if (PyInt_Check (newvalue))
 204     {
 205       if (! gdb_py_int_as_long (newvalue, &id))
 206         return -1;
 207
 208       if (!valid_global_thread_id (id))
 209         {
 210           PyErr_SetString (PyExc_RuntimeError,
 211                            _("Invalid thread ID."));
 212           return -1;
 213         }
 214     }
 215   else if (newvalue == Py_None)
 216     id = -1;
 217   else
 218     {
 219       PyErr_SetString (PyExc_TypeError,
 220                        _("The value of `thread' must be an integer or None."));
 221       return -1;
 222     }
 223
 224   breakpoint_set_thread (self_bp->bp, id);
 225
 226   return 0;
 227 }
 228
 229 /* Python function to set the (Ada) task of a breakpoint.  */
 230 static int
 231 bppy_set_task (PyObject *self, PyObject *newvalue, void *closure)
 232 {
 233   gdbpy_breakpoint_object *self_bp = (gdbpy_breakpoint_object *) self;
 234   long id;
 235   int valid_id = 0;
 236
 237   BPPY_SET_REQUIRE_VALID (self_bp);
 238
 239   if (newvalue == NULL)
 240     {
 241       PyErr_SetString (PyExc_TypeError,
 242                        _("Cannot delete `task' attribute."));
 243       return -1;
 244     }
 245   else if (PyInt_Check (newvalue))
 246     {
 247       if (! gdb_py_int_as_long (newvalue, &id))
 248         return -1;
 249
 250       try
 251         {
 252           valid_id = valid_task_id (id);
 253         }
 254       catch (const gdb_exception &except)
 255         {
 256           GDB_PY_SET_HANDLE_EXCEPTION (except);
 257         }
 258
 259       if (! valid_id)
 260         {
 261           PyErr_SetString (PyExc_RuntimeError,
 262                            _("Invalid task ID."));
 263           return -1;
 264         }
 265     }
 266   else if (newvalue == Py_None)
 267     id = 0;
 268   else
 269     {
 270       PyErr_SetString (PyExc_TypeError,
 271                        _("The value of `task' must be an integer or None."));
 272       return -1;
 273     }
 274
 275   breakpoint_set_task (self_bp->bp, id);
 276
 277   return 0;
 278 }
 279
 280 /* Python function which deletes the underlying GDB breakpoint.  This
 281    triggers the breakpoint_deleted observer which will call
 282    gdbpy_breakpoint_deleted; that function cleans up the Python
 283    sections.  */
 284
 285 static PyObject *
 286 bppy_delete_breakpoint (PyObject *self, PyObject *args)
 287 {
 288   gdbpy_breakpoint_object *self_bp = (gdbpy_breakpoint_object *) self;
 289
 290   BPPY_REQUIRE_VALID (self_bp);
 291
 292   try
 293     {
 294       delete_breakpoint (self_bp->bp);
 295     }
 296   catch (const gdb_exception &except)
 297     {
 298       GDB_PY_HANDLE_EXCEPTION (except);
 299     }
 300
 301   Py_RETURN_NONE;
 302 }
 303
 304
 305 /* Python function to set the ignore count of a breakpoint.  */
 306 static int
 307 bppy_set_ignore_count (PyObject *self, PyObject *newvalue, void *closure)
 308 {
 309   gdbpy_breakpoint_object *self_bp = (gdbpy_breakpoint_object *) self;
 310   long value;
 311
 312   BPPY_SET_REQUIRE_VALID (self_bp);
 313
 314   if (newvalue == NULL)
 315     {
 316       PyErr_SetString (PyExc_TypeError,
 317                        _("Cannot delete `ignore_count' attribute."));
 318       return -1;
 319     }
 320   else if (! PyInt_Check (newvalue))
 321     {
 322       PyErr_SetString (PyExc_TypeError,
 323                        _("The value of `ignore_count' must be an integer."));
 324       return -1;
 325     }
 326
 327   if (! gdb_py_int_as_long (newvalue, &value))
 328     return -1;
 329
 330   if (value < 0)
 331     value = 0;
 332
 333   try
 334     {
 335       set_ignore_count (self_bp->number, (int) value, 0);
 336     }
 337   catch (const gdb_exception &except)
 338     {
 339       GDB_PY_SET_HANDLE_EXCEPTION (except);
 340     }
 341
 342   return 0;
 343 }
 344
 345 /* Python function to set the hit count of a breakpoint.  */
 346 static int
 347 bppy_set_hit_count (PyObject *self, PyObject *newvalue, void *closure)
 348 {
 349   gdbpy_breakpoint_object *self_bp = (gdbpy_breakpoint_object *) self;
 350
 351   BPPY_SET_REQUIRE_VALID (self_bp);
 352
 353   if (newvalue == NULL)
 354     {
 355       PyErr_SetString (PyExc_TypeError,
 356                        _("Cannot delete `hit_count' attribute."));
 357       return -1;
 358     }
 359   else
 360     {
 361       long value;
 362
 363       if (! gdb_py_int_as_long (newvalue, &value))
 364         return -1;
 365
 366       if (value != 0)
 367         {
 368           PyErr_SetString (PyExc_AttributeError,
 369                            _("The value of `hit_count' must be zero."));
 370           return -1;
 371         }
 372     }
 373
 374   self_bp->bp->hit_count = 0;
 375
 376   return 0;
 377 }
 378
 379 /* Python function to get the location of a breakpoint.  */
 380 static PyObject *
 381 bppy_get_location (PyObject *self, void *closure)
 382 {
 383   gdbpy_breakpoint_object *obj = (gdbpy_breakpoint_object *) self;
 384
 385   BPPY_REQUIRE_VALID (obj);
 386
 387   if (obj->bp->type != bp_breakpoint
 388       && obj->bp->type != bp_hardware_breakpoint)
 389     Py_RETURN_NONE;
 390
 391   const char *str = event_location_to_string (obj->bp->location.get ());
 392   if (! str)
 393     str = "";
 394   return host_string_to_python_string (str).release ();
 395 }
 396
 397 /* Python function to get the breakpoint expression.  */
 398 static PyObject *
 399 bppy_get_expression (PyObject *self, void *closure)
 400 {
 401   const char *str;
 402   gdbpy_breakpoint_object *obj = (gdbpy_breakpoint_object *) self;
 403   struct watchpoint *wp;
 404
 405   BPPY_REQUIRE_VALID (obj);
 406
 407   if (!is_watchpoint (obj->bp))
 408     Py_RETURN_NONE;
 409
 410   wp = (struct watchpoint *) obj->bp;
 411
 412   str = wp->exp_string;
 413   if (! str)
 414     str = "";
 415
 416   return host_string_to_python_string (str).release ();
 417 }
 418
 419 /* Python function to get the condition expression of a breakpoint.  */
 420 static PyObject *
 421 bppy_get_condition (PyObject *self, void *closure)
 422 {
 423   char *str;
 424   gdbpy_breakpoint_object *obj = (gdbpy_breakpoint_object *) self;
 425
 426   BPPY_REQUIRE_VALID (obj);
 427
 428   str = obj->bp->cond_string;
 429   if (! str)
 430     Py_RETURN_NONE;
 431
 432   return host_string_to_python_string (str).release ();
 433 }
 434
 435 /* Returns 0 on success.  Returns -1 on error, with a python exception set.
 436    */
 437
 438 static int
 439 bppy_set_condition (PyObject *self, PyObject *newvalue, void *closure)
 440 {
 441   gdb::unique_xmalloc_ptr<char> exp_holder;
 442   const char *exp = NULL;
 443   gdbpy_breakpoint_object *self_bp = (gdbpy_breakpoint_object *) self;
 444   struct gdb_exception except;
 445
 446   BPPY_SET_REQUIRE_VALID (self_bp);
 447
 448   if (newvalue == NULL)
 449     {
 450       PyErr_SetString (PyExc_TypeError,
 451                        _("Cannot delete `condition' attribute."));
 452       return -1;
 453     }
 454   else if (newvalue == Py_None)
 455     exp = "";
 456   else
 457     {
 458       exp_holder = python_string_to_host_string (newvalue);
 459       if (exp_holder == NULL)
 460         return -1;
 461       exp = exp_holder.get ();
 462     }
 463
 464   try
 465     {
 466       set_breakpoint_condition (self_bp->bp, exp, 0, false);
 467     }
 468   catch (gdb_exception &ex)
 469     {
 470       except = std::move (ex);
 471     }
 472
 473   GDB_PY_SET_HANDLE_EXCEPTION (except);
 474
 475   return 0;
 476 }
 477
 478 /* Python function to get the commands attached to a breakpoint.  */
 479 static PyObject *
 480 bppy_get_commands (PyObject *self, void *closure)
 481 {
 482   gdbpy_breakpoint_object *self_bp = (gdbpy_breakpoint_object *) self;
 483   struct breakpoint *bp = self_bp->bp;
 484
 485   BPPY_REQUIRE_VALID (self_bp);
 486
 487   if (! self_bp->bp->commands)
 488     Py_RETURN_NONE;
 489
 490   string_file stb;
 491
 492   current_uiout->redirect (&stb);
 493   try
 494     {
 495       print_command_lines (current_uiout, breakpoint_commands (bp), 0);
 496     }
 497   catch (const gdb_exception &except)
 498     {
 499       current_uiout->redirect (NULL);
 500       gdbpy_convert_exception (except);
 501       return NULL;
 502     }
 503
 504   current_uiout->redirect (NULL);
 505   return host_string_to_python_string (stb.c_str ()).release ();
 506 }
 507
 508 /* Set the commands attached to a breakpoint.  Returns 0 on success.
 509    Returns -1 on error, with a python exception set.  */
 510 static int
 511 bppy_set_commands (PyObject *self, PyObject *newvalue, void *closure)
 512 {
 513   gdbpy_breakpoint_object *self_bp = (gdbpy_breakpoint_object *) self;
 514   struct gdb_exception except;
 515
 516   BPPY_SET_REQUIRE_VALID (self_bp);
 517
 518   gdb::unique_xmalloc_ptr<char> commands
 519     (python_string_to_host_string (newvalue));
 520   if (commands == nullptr)
 521     return -1;
 522
 523   try
 524     {
 525       bool first = true;
 526       char *save_ptr = nullptr;
 527       auto reader
 528         = [&] ()
 529           {
 530             const char *result = strtok_r (first ? commands.get () : nullptr,
 531                                            "\n", &save_ptr);
 532             first = false;
 533             return result;
 534           };
 535
 536       counted_command_line lines = read_command_lines_1 (reader, 1, nullptr);
 537       breakpoint_set_commands (self_bp->bp, std::move (lines));
 538     }
 539   catch (gdb_exception &ex)
 540     {
 541       except = std::move (ex);
 542     }
 543
 544   GDB_PY_SET_HANDLE_EXCEPTION (except);
 545
 546   return 0;
 547 }
 548
 549 /* Python function to get the breakpoint type.  */
 550 static PyObject *
 551 bppy_get_type (PyObject *self, void *closure)
 552 {
 553   gdbpy_breakpoint_object *self_bp = (gdbpy_breakpoint_object *) self;
 554
 555   BPPY_REQUIRE_VALID (self_bp);
 556
 557   return gdb_py_object_from_longest (self_bp->bp->type).release ();
 558 }
 559
 560 /* Python function to get the visibility of the breakpoint.  */
 561
 562 static PyObject *
 563 bppy_get_visibility (PyObject *self, void *closure)
 564 {
 565   gdbpy_breakpoint_object *self_bp = (gdbpy_breakpoint_object *) self;
 566
 567   BPPY_REQUIRE_VALID (self_bp);
 568
 569   if (user_breakpoint_p (self_bp->bp))
 570     Py_RETURN_TRUE;
 571
 572   Py_RETURN_FALSE;
 573 }
 574
 575 /* Python function to determine if the breakpoint is a temporary
 576    breakpoint.  */
 577
 578 static PyObject *
 579 bppy_get_temporary (PyObject *self, void *closure)
 580 {
 581   gdbpy_breakpoint_object *self_bp = (gdbpy_breakpoint_object *) self;
 582
 583   BPPY_REQUIRE_VALID (self_bp);
 584
 585   if (self_bp->bp->disposition == disp_del
 586       || self_bp->bp->disposition == disp_del_at_next_stop)
 587     Py_RETURN_TRUE;
 588
 589   Py_RETURN_FALSE;
 590 }
 591
 592 /* Python function to determine if the breakpoint is a pending
 593    breakpoint.  */
 594
 595 static PyObject *
 596 bppy_get_pending (PyObject *self, void *closure)
 597 {
 598   gdbpy_breakpoint_object *self_bp = (gdbpy_breakpoint_object *) self;
 599
 600   BPPY_REQUIRE_VALID (self_bp);
 601
 602   if (is_watchpoint (self_bp->bp))
 603     Py_RETURN_FALSE;
 604   if (pending_breakpoint_p (self_bp->bp))
 605     Py_RETURN_TRUE;
 606
 607   Py_RETURN_FALSE;
 608 }
 609
 610 /* Python function to get the breakpoint's number.  */
 611 static PyObject *
 612 bppy_get_number (PyObject *self, void *closure)
 613 {
 614   gdbpy_breakpoint_object *self_bp = (gdbpy_breakpoint_object *) self;
 615
 616   BPPY_REQUIRE_VALID (self_bp);
 617
 618   return gdb_py_object_from_longest (self_bp->number).release ();
 619 }
 620
 621 /* Python function to get the breakpoint's thread ID.  */
 622 static PyObject *
 623 bppy_get_thread (PyObject *self, void *closure)
 624 {
 625   gdbpy_breakpoint_object *self_bp = (gdbpy_breakpoint_object *) self;
 626
 627   BPPY_REQUIRE_VALID (self_bp);
 628
 629   if (self_bp->bp->thread == -1)
 630     Py_RETURN_NONE;
 631
 632   return gdb_py_object_from_longest (self_bp->bp->thread).release ();
 633 }
 634
 635 /* Python function to get the breakpoint's task ID (in Ada).  */
 636 static PyObject *
 637 bppy_get_task (PyObject *self, void *closure)
 638 {
 639   gdbpy_breakpoint_object *self_bp = (gdbpy_breakpoint_object *) self;
 640
 641   BPPY_REQUIRE_VALID (self_bp);
 642
 643   if (self_bp->bp->task == 0)
 644     Py_RETURN_NONE;
 645
 646   return gdb_py_object_from_longest (self_bp->bp->task).release ();
 647 }
 648
 649 /* Python function to get the breakpoint's hit count.  */
 650 static PyObject *
 651 bppy_get_hit_count (PyObject *self, void *closure)
 652 {
 653   gdbpy_breakpoint_object *self_bp = (gdbpy_breakpoint_object *) self;
 654
 655   BPPY_REQUIRE_VALID (self_bp);
 656
 657   return gdb_py_object_from_longest (self_bp->bp->hit_count).release ();
 658 }
 659
 660 /* Python function to get the breakpoint's ignore count.  */
 661 static PyObject *
 662 bppy_get_ignore_count (PyObject *self, void *closure)
 663 {
 664   gdbpy_breakpoint_object *self_bp = (gdbpy_breakpoint_object *) self;
 665
 666   BPPY_REQUIRE_VALID (self_bp);
 667
 668   return gdb_py_object_from_longest (self_bp->bp->ignore_count).release ();
 669 }
 670
 671 /* Internal function to validate the Python parameters/keywords
 672    provided to bppy_init.  */
 673
 674 static int
 675 bppy_init_validate_args (const char *spec, char *source,
 676                          char *function, char *label,
 677                          char *line, enum bptype type)
 678 {
 679   /* If spec is defined, ensure that none of the explicit location
 680      keywords are also defined.  */
 681   if (spec != NULL)
 682     {
 683       if (source != NULL || function != NULL || label != NULL || line != NULL)
 684         {
 685           PyErr_SetString (PyExc_RuntimeError,
 686                            _("Breakpoints specified with spec cannot "
 687                              "have source, function, label or line defined."));
 688           return -1;
 689         }
 690     }
 691   else
 692     {
 693       /* If spec isn't defined, ensure that the user is not trying to
 694          define a watchpoint with an explicit location.  */
 695       if (type == bp_watchpoint)
 696         {
 697           PyErr_SetString (PyExc_RuntimeError,
 698                            _("Watchpoints cannot be set by explicit "
 699                              "location parameters."));
 700           return -1;
 701         }
 702       else
 703         {
 704           /* Otherwise, ensure some explicit locations are defined.  */
 705           if (source == NULL && function == NULL && label == NULL
 706               && line == NULL)
 707             {
 708               PyErr_SetString (PyExc_RuntimeError,
 709                                _("Neither spec nor explicit location set."));
 710               return -1;
 711             }
 712           /* Finally, if source is specified, ensure that line, label
 713              or function are specified too.  */
 714           if (source != NULL && function == NULL && label == NULL
 715               && line == NULL)
 716             {
 717               PyErr_SetString (PyExc_RuntimeError,
 718                                _("Specifying a source must also include a "
 719                                  "line, label or function."));
 720               return -1;
 721             }
 722         }
 723     }
 724   return 1;
 725 }
 726
 727 /* Python function to create a new breakpoint.  */
 728 static int
 729 bppy_init (PyObject *self, PyObject *args, PyObject *kwargs)
 730 {
 731   static const char *keywords[] = { "spec", "type", "wp_class", "internal",
 732                                     "temporary","source", "function",
 733                                     "label", "line", "qualified", NULL };
 734   const char *spec = NULL;
 735   enum bptype type = bp_breakpoint;
 736   int access_type = hw_write;
 737   PyObject *internal = NULL;
 738   PyObject *temporary = NULL;
 739   PyObject *lineobj = NULL;;
 740   int internal_bp = 0;
 741   int temporary_bp = 0;
 742   gdb::unique_xmalloc_ptr<char> line;
 743   char *label = NULL;
 744   char *source = NULL;
 745   char *function = NULL;
 746   PyObject * qualified = NULL;
 747
 748   if (!gdb_PyArg_ParseTupleAndKeywords (args, kwargs, "|siiOOsssOO", keywords,
 749                                         &spec, &type, &access_type,
 750                                         &internal,
 751                                         &temporary, &source,
 752                                         &function, &label, &lineobj,
 753                                         &qualified))
 754     return -1;
 755
 756
 757   if (lineobj != NULL)
 758     {
 759       if (PyInt_Check (lineobj))
 760         line.reset (xstrprintf ("%ld", PyInt_AsLong (lineobj)));
 761       else if (PyString_Check (lineobj))
 762         line = python_string_to_host_string (lineobj);
 763       else
 764         {
 765           PyErr_SetString (PyExc_RuntimeError,
 766                            _("Line keyword should be an integer or a string. "));
 767           return -1;
 768         }
 769     }
 770
 771   if (internal)
 772     {
 773       internal_bp = PyObject_IsTrue (internal);
 774       if (internal_bp == -1)
 775         return -1;
 776     }
 777
 778   if (temporary != NULL)
 779     {
 780       temporary_bp = PyObject_IsTrue (temporary);
 781       if (temporary_bp == -1)
 782         return -1;
 783     }
 784
 785   if (bppy_init_validate_args (spec, source, function, label, line.get (),
 786                                type) == -1)
 787     return -1;
 788
 789   bppy_pending_object = (gdbpy_breakpoint_object *) self;
 790   bppy_pending_object->number = -1;
 791   bppy_pending_object->bp = NULL;
 792
 793   try
 794     {
 795       switch (type)
 796         {
 797         case bp_breakpoint:
 798         case bp_hardware_breakpoint:
 799           {
 800             event_location_up location;
 801             symbol_name_match_type func_name_match_type
 802               = (qualified != NULL && PyObject_IsTrue (qualified)
 803                   ? symbol_name_match_type::FULL
 804                   : symbol_name_match_type::WILD);
 805
 806             if (spec != NULL)
 807               {
 808                 gdb::unique_xmalloc_ptr<char>
 809                   copy_holder (xstrdup (skip_spaces (spec)));
 810                 const char *copy = copy_holder.get ();
 811
 812                 location  = string_to_event_location (&copy,
 813                                                       current_language,
 814                                                       func_name_match_type);
 815               }
 816             else
 817               {
 818                 struct explicit_location explicit_loc;
 819
 820                 initialize_explicit_location (&explicit_loc);
 821                 explicit_loc.source_filename = source;
 822                 explicit_loc.function_name = function;
 823                 explicit_loc.label_name = label;
 824
 825                 if (line != NULL)
 826                   explicit_loc.line_offset =
 827                     linespec_parse_line_offset (line.get ());
 828
 829                 explicit_loc.func_name_match_type = func_name_match_type;
 830
 831                 location = new_explicit_location (&explicit_loc);
 832               }
 833
 834             const struct breakpoint_ops *ops =
 835               breakpoint_ops_for_event_location (location.get (), false);
 836
 837             create_breakpoint (python_gdbarch,
 838                                location.get (), NULL, -1, NULL, false,
 839                                0,
 840                                temporary_bp, type,
 841                                0,
 842                                AUTO_BOOLEAN_TRUE,
 843                                ops,
 844                                0, 1, internal_bp, 0);
 845             break;
 846           }
 847         case bp_watchpoint:
 848           {
 849             gdb::unique_xmalloc_ptr<char>
 850               copy_holder (xstrdup (skip_spaces (spec)));
 851             char *copy = copy_holder.get ();
 852
 853             if (access_type == hw_write)
 854               watch_command_wrapper (copy, 0, internal_bp);
 855             else if (access_type == hw_access)
 856               awatch_command_wrapper (copy, 0, internal_bp);
 857             else if (access_type == hw_read)
 858               rwatch_command_wrapper (copy, 0, internal_bp);
 859             else
 860               error(_("Cannot understand watchpoint access type."));
 861             break;
 862           }
 863         default:
 864           error(_("Do not understand breakpoint type to set."));
 865         }
 866     }
 867   catch (const gdb_exception &except)
 868     {
 869       bppy_pending_object = NULL;
 870       gdbpy_convert_exception (except);
 871       return -1;
 872     }
 873
 874   BPPY_SET_REQUIRE_VALID ((gdbpy_breakpoint_object *) self);
 875   return 0;
 876 }
 877
 878 \f
 879
 880 static bool
 881 build_bp_list (struct breakpoint *b, PyObject *list)
 882 {
 883   PyObject *bp = (PyObject *) b->py_bp_object;
 884   int iserr = 0;
 885
 886   /* Not all breakpoints will have a companion Python object.
 887      Only breakpoints that were created via bppy_new, or
 888      breakpoints that were created externally and are tracked by
 889      the Python Scripting API.  */
 890   if (bp)
 891     iserr = PyList_Append (list, bp);
 892
 893   if (iserr == -1)
 894     return true;
 895
 896   return false;
 897 }
 898
 899 /* Static function to return a tuple holding all breakpoints.  */
 900
 901 PyObject *
 902 gdbpy_breakpoints (PyObject *self, PyObject *args)
 903 {
 904   if (bppy_live == 0)
 905     return PyTuple_New (0);
 906
 907   gdbpy_ref<> list (PyList_New (0));
 908   if (list == NULL)
 909     return NULL;
 910
 911   /* If iterate_over_breakpoints returns non NULL it signals an error
 912      condition.  In that case abandon building the list and return
 913      NULL.  */
 914   auto callback = [&] (breakpoint *bp)
 915     {
 916       return build_bp_list(bp, list.get ());
 917     };
 918   if (iterate_over_breakpoints (callback) != NULL)
 919     return NULL;
 920
 921   return PyList_AsTuple (list.get ());
 922 }
 923
 924 /* Call the "stop" method (if implemented) in the breakpoint
 925    class.  If the method returns True, the inferior  will be
 926    stopped at the breakpoint.  Otherwise the inferior will be
 927    allowed to continue.  */
 928
 929 enum ext_lang_bp_stop
 930 gdbpy_breakpoint_cond_says_stop (const struct extension_language_defn *extlang,
 931                                  struct breakpoint *b)
 932 {
 933   int stop;
 934   struct gdbpy_breakpoint_object *bp_obj = b->py_bp_object;
 935   PyObject *py_bp = (PyObject *) bp_obj;
 936   struct gdbarch *garch;
 937
 938   if (bp_obj == NULL)
 939     return EXT_LANG_BP_STOP_UNSET;
 940
 941   stop = -1;
 942   garch = b->gdbarch ? b->gdbarch : get_current_arch ();
 943
 944   gdbpy_enter enter_py (garch, current_language);
 945
 946   if (bp_obj->is_finish_bp)
 947     bpfinishpy_pre_stop_hook (bp_obj);
 948
 949   if (PyObject_HasAttrString (py_bp, stop_func))
 950     {
 951       gdbpy_ref<> result (PyObject_CallMethod (py_bp, stop_func, NULL));
 952
 953       stop = 1;
 954       if (result != NULL)
 955         {
 956           int evaluate = PyObject_IsTrue (result.get ());
 957
 958           if (evaluate == -1)
 959             gdbpy_print_stack ();
 960
 961           /* If the "stop" function returns False that means
 962              the Python breakpoint wants GDB to continue.  */
 963           if (! evaluate)
 964             stop = 0;
 965         }
 966       else
 967         gdbpy_print_stack ();
 968     }
 969
 970   if (bp_obj->is_finish_bp)
 971     bpfinishpy_post_stop_hook (bp_obj);
 972
 973   if (stop < 0)
 974     return EXT_LANG_BP_STOP_UNSET;
 975   return stop ? EXT_LANG_BP_STOP_YES : EXT_LANG_BP_STOP_NO;
 976 }
 977
 978 /* Checks if the  "stop" method exists in this breakpoint.
 979    Used by condition_command to ensure mutual exclusion of breakpoint
 980    conditions.  */
 981
 982 int
 983 gdbpy_breakpoint_has_cond (const struct extension_language_defn *extlang,
 984                            struct breakpoint *b)
 985 {
 986   PyObject *py_bp;
 987   struct gdbarch *garch;
 988
 989   if (b->py_bp_object == NULL)
 990     return 0;
 991
 992   py_bp = (PyObject *) b->py_bp_object;
 993   garch = b->gdbarch ? b->gdbarch : get_current_arch ();
 994
 995   gdbpy_enter enter_py (garch, current_language);
 996   return PyObject_HasAttrString (py_bp, stop_func);
 997 }
 998
 999 \f
1000
1001 /* Event callback functions.  */
1002
1003 /* Callback that is used when a breakpoint is created.  This function
1004    will create a new Python breakpoint object.  */
1005 static void
1006 gdbpy_breakpoint_created (struct breakpoint *bp)
1007 {
1008   gdbpy_breakpoint_object *newbp;
1009
1010   if (!user_breakpoint_p (bp) && bppy_pending_object == NULL)
1011     return;
1012
1013   if (bp->type != bp_breakpoint
1014       && bp->type != bp_hardware_breakpoint
1015       && bp->type != bp_watchpoint
1016       && bp->type != bp_hardware_watchpoint
1017       && bp->type != bp_read_watchpoint
1018       && bp->type != bp_access_watchpoint)
1019     return;
1020
1021   struct gdbarch *garch = bp->gdbarch ? bp->gdbarch : get_current_arch ();
1022   gdbpy_enter enter_py (garch, current_language);
1023
1024   if (bppy_pending_object)
1025     {
1026       newbp = bppy_pending_object;
1027       Py_INCREF (newbp);
1028       bppy_pending_object = NULL;
1029     }
1030   else
1031     newbp = PyObject_New (gdbpy_breakpoint_object, &breakpoint_object_type);
1032   if (newbp)
1033     {
1034       newbp->number = bp->number;
1035       newbp->bp = bp;
1036       newbp->bp->py_bp_object = newbp;
1037       newbp->is_finish_bp = 0;
1038       ++bppy_live;
1039     }
1040   else
1041     {
1042       PyErr_SetString (PyExc_RuntimeError,
1043                        _("Error while creating breakpoint from GDB."));
1044       gdbpy_print_stack ();
1045     }
1046
1047   if (!evregpy_no_listeners_p (gdb_py_events.breakpoint_created))
1048     {
1049       if (evpy_emit_event ((PyObject *) newbp,
1050                            gdb_py_events.breakpoint_created) < 0)
1051         gdbpy_print_stack ();
1052     }
1053 }
1054
1055 /* Callback that is used when a breakpoint is deleted.  This will
1056    invalidate the corresponding Python object.  */
1057 static void
1058 gdbpy_breakpoint_deleted (struct breakpoint *b)
1059 {
1060   int num = b->number;
1061   struct breakpoint *bp = NULL;
1062
1063   bp = get_breakpoint (num);
1064   if (bp)
1065     {
1066       struct gdbarch *garch = bp->gdbarch ? bp->gdbarch : get_current_arch ();
1067       gdbpy_enter enter_py (garch, current_language);
1068
1069       gdbpy_ref<gdbpy_breakpoint_object> bp_obj (bp->py_bp_object);
1070       if (bp_obj != NULL)
1071         {
1072           if (!evregpy_no_listeners_p (gdb_py_events.breakpoint_deleted))
1073             {
1074               if (evpy_emit_event ((PyObject *) bp_obj.get (),
1075                                    gdb_py_events.breakpoint_deleted) < 0)
1076                 gdbpy_print_stack ();
1077             }
1078
1079           bp_obj->bp = NULL;
1080           --bppy_live;
1081         }
1082     }
1083 }
1084
1085 /* Callback that is used when a breakpoint is modified.  */
1086
1087 static void
1088 gdbpy_breakpoint_modified (struct breakpoint *b)
1089 {
1090   int num = b->number;
1091   struct breakpoint *bp = NULL;
1092
1093   bp = get_breakpoint (num);
1094   if (bp)
1095     {
1096       struct gdbarch *garch = bp->gdbarch ? bp->gdbarch : get_current_arch ();
1097       gdbpy_enter enter_py (garch, current_language);
1098
1099       PyObject *bp_obj = (PyObject *) bp->py_bp_object;
1100       if (bp_obj)
1101         {
1102           if (!evregpy_no_listeners_p (gdb_py_events.breakpoint_modified))
1103             {
1104               if (evpy_emit_event (bp_obj,
1105                                    gdb_py_events.breakpoint_modified) < 0)
1106                 gdbpy_print_stack ();
1107             }
1108         }
1109     }
1110 }
1111
1112 \f
1113
1114 /* Initialize the Python breakpoint code.  */
1115 int
1116 gdbpy_initialize_breakpoints (void)
1117 {
1118   int i;
1119
1120   breakpoint_object_type.tp_new = PyType_GenericNew;
1121   if (PyType_Ready (&breakpoint_object_type) < 0)
1122     return -1;
1123
1124   if (gdb_pymodule_addobject (gdb_module, "Breakpoint",
1125                               (PyObject *) &breakpoint_object_type) < 0)
1126     return -1;
1127
1128   gdb::observers::breakpoint_created.attach (gdbpy_breakpoint_created,
1129                                              "py-breakpoint");
1130   gdb::observers::breakpoint_deleted.attach (gdbpy_breakpoint_deleted,
1131                                              "py-breakpoint");
1132   gdb::observers::breakpoint_modified.attach (gdbpy_breakpoint_modified,
1133                                               "py-breakpoint");
1134
1135   /* Add breakpoint types constants.  */
1136   for (i = 0; pybp_codes[i].name; ++i)
1137     {
1138       if (PyModule_AddIntConstant (gdb_module, pybp_codes[i].name,
1139                                    pybp_codes[i].code) < 0)
1140         return -1;
1141     }
1142
1143   /* Add watchpoint types constants.  */
1144   for (i = 0; pybp_watch_types[i].name; ++i)
1145     {
1146       if (PyModule_AddIntConstant (gdb_module, pybp_watch_types[i].name,
1147                                    pybp_watch_types[i].code) < 0)
1148         return -1;
1149     }
1150
1151   return 0;
1152 }
1153
1154 \f
1155
1156 /* Helper function that overrides this Python object's
1157    PyObject_GenericSetAttr to allow extra validation of the attribute
1158    being set.  */
1159
1160 static int
1161 local_setattro (PyObject *self, PyObject *name, PyObject *v)
1162 {
1163   gdbpy_breakpoint_object *obj = (gdbpy_breakpoint_object *) self;
1164   gdb::unique_xmalloc_ptr<char> attr (python_string_to_host_string (name));
1165
1166   if (attr == NULL)
1167     return -1;
1168
1169   /* If the attribute trying to be set is the "stop" method,
1170      but we already have a condition set in the CLI or other extension
1171      language, disallow this operation.  */
1172   if (strcmp (attr.get (), stop_func) == 0)
1173     {
1174       const struct extension_language_defn *extlang = NULL;
1175
1176       if (obj->bp->cond_string != NULL)
1177         extlang = get_ext_lang_defn (EXT_LANG_GDB);
1178       if (extlang == NULL)
1179         extlang = get_breakpoint_cond_ext_lang (obj->bp, EXT_LANG_PYTHON);
1180       if (extlang != NULL)
1181         {
1182           std::string error_text
1183             = string_printf (_("Only one stop condition allowed.  There is"
1184                                " currently a %s stop condition defined for"
1185                                " this breakpoint."),
1186                              ext_lang_capitalized_name (extlang));
1187           PyErr_SetString (PyExc_RuntimeError, error_text.c_str ());
1188           return -1;
1189         }
1190     }
1191
1192   return PyObject_GenericSetAttr (self, name, v);
1193 }
1194
1195 static gdb_PyGetSetDef breakpoint_object_getset[] = {
1196   { "enabled", bppy_get_enabled, bppy_set_enabled,
1197     "Boolean telling whether the breakpoint is enabled.", NULL },
1198   { "silent", bppy_get_silent, bppy_set_silent,
1199     "Boolean telling whether the breakpoint is silent.", NULL },
1200   { "thread", bppy_get_thread, bppy_set_thread,
1201     "Thread ID for the breakpoint.\n\
1202 If the value is a thread ID (integer), then this is a thread-specific breakpoint.\n\
1203 If the value is None, then this breakpoint is not thread-specific.\n\
1204 No other type of value can be used.", NULL },
1205   { "task", bppy_get_task, bppy_set_task,
1206     "Thread ID for the breakpoint.\n\
1207 If the value is a task ID (integer), then this is an Ada task-specific breakpoint.\n\
1208 If the value is None, then this breakpoint is not task-specific.\n\
1209 No other type of value can be used.", NULL },
1210   { "ignore_count", bppy_get_ignore_count, bppy_set_ignore_count,
1211     "Number of times this breakpoint should be automatically continued.",
1212     NULL },
1213   { "number", bppy_get_number, NULL,
1214     "Breakpoint's number assigned by GDB.", NULL },
1215   { "hit_count", bppy_get_hit_count, bppy_set_hit_count,
1216     "Number of times the breakpoint has been hit.\n\
1217 Can be set to zero to clear the count. No other value is valid\n\
1218 when setting this property.", NULL },
1219   { "location", bppy_get_location, NULL,
1220     "Location of the breakpoint, as specified by the user.", NULL},
1221   { "expression", bppy_get_expression, NULL,
1222     "Expression of the breakpoint, as specified by the user.", NULL},
1223   { "condition", bppy_get_condition, bppy_set_condition,
1224     "Condition of the breakpoint, as specified by the user,\
1225 or None if no condition set."},
1226   { "commands", bppy_get_commands, bppy_set_commands,
1227     "Commands of the breakpoint, as specified by the user."},
1228   { "type", bppy_get_type, NULL,
1229     "Type of breakpoint."},
1230   { "visible", bppy_get_visibility, NULL,
1231     "Whether the breakpoint is visible to the user."},
1232   { "temporary", bppy_get_temporary, NULL,
1233     "Whether this breakpoint is a temporary breakpoint."},
1234   { "pending", bppy_get_pending, NULL,
1235     "Whether this breakpoint is a pending breakpoint."},
1236   { NULL }  /* Sentinel.  */
1237 };
1238
1239 static PyMethodDef breakpoint_object_methods[] =
1240 {
1241   { "is_valid", bppy_is_valid, METH_NOARGS,
1242     "Return true if this breakpoint is valid, false if not." },
1243   { "delete", bppy_delete_breakpoint, METH_NOARGS,
1244     "Delete the underlying GDB breakpoint." },
1245   { NULL } /* Sentinel.  */
1246 };
1247
1248 PyTypeObject breakpoint_object_type =
1249 {
1250   PyVarObject_HEAD_INIT (NULL, 0)
1251   "gdb.Breakpoint",               /*tp_name*/
1252   sizeof (gdbpy_breakpoint_object), /*tp_basicsize*/
1253   0,                              /*tp_itemsize*/
1254   0,                              /*tp_dealloc*/
1255   0,                              /*tp_print*/
1256   0,                              /*tp_getattr*/
1257   0,                              /*tp_setattr*/
1258   0,                              /*tp_compare*/
1259   0,                              /*tp_repr*/
1260   0,                              /*tp_as_number*/
1261   0,                              /*tp_as_sequence*/
1262   0,                              /*tp_as_mapping*/
1263   0,                              /*tp_hash */
1264   0,                              /*tp_call*/
1265   0,                              /*tp_str*/
1266   0,                              /*tp_getattro*/
1267   (setattrofunc)local_setattro,   /*tp_setattro */
1268   0,                              /*tp_as_buffer*/
1269   Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,  /*tp_flags*/
1270   "GDB breakpoint object",        /* tp_doc */
1271   0,                              /* tp_traverse */
1272   0,                              /* tp_clear */
1273   0,                              /* tp_richcompare */
1274   0,                              /* tp_weaklistoffset */
1275   0,                              /* tp_iter */
1276   0,                              /* tp_iternext */
1277   breakpoint_object_methods,      /* tp_methods */
1278   0,                              /* tp_members */
1279   breakpoint_object_getset,       /* tp_getset */
1280   0,                              /* tp_base */
1281   0,                              /* tp_dict */
1282   0,                              /* tp_descr_get */
1283   0,                              /* tp_descr_set */
1284   0,                              /* tp_dictoffset */
1285   bppy_init,                      /* tp_init */
1286   0,                              /* tp_alloc */
1287 };