diff options
| author | Andrew Burgess <aburgess@redhat.com> | 2024-11-10 15:50:26 +0000 |
|---|---|---|
| committer | Andrew Burgess <aburgess@redhat.com> | 2024-11-14 19:34:44 +0000 |
| commit | ad39b4aae84a224dc5451d6a5f707b1db67a7b7e (patch) | |
| tree | ba5c21256f770093040370fd7f61285f0f45b395 | |
| parent | 5209b83f530fad1598db3eeb406762bf3fa3d5d2 (diff) | |
| download | binutils-ad39b4aae84a224dc5451d6a5f707b1db67a7b7e.zip binutils-ad39b4aae84a224dc5451d6a5f707b1db67a7b7e.tar.gz binutils-ad39b4aae84a224dc5451d6a5f707b1db67a7b7e.tar.bz2 | |
gdb/python: missing PyObject_IsTrue error check in micmdpy_set_installed
Like the previous commit, I discovered that in micmdpy_set_installed
we were calling PyObject_IsTrue, but not checking for a possible error
value being returned.
The micmdpy_set_installed function implements the
gdb.MICommand.installed attribute, and the documentation indicates that
this attribute should only be assigned a bool:
This attribute is read-write, setting this attribute to 'False'
will uninstall the command, removing it from the set of available
commands. Setting this attribute to 'True' will install the
command for use.
So I propose that instead of using PyObject_IsTrue we use
PyBool_Check, and if the new value fails this check we raise an
error. We can then compare the new value to Py_True directly instead
of calling PyObject_IsTrue.
This is a potentially breaking change to the Python API, but hopefully
this will not impact too many people, and the fix is pretty
easy (switch to using a bool). I've added a NEWS entry to draw
attention to this change.
Approved-By: Tom Tromey <tom@tromey.com>
| -rw-r--r-- | gdb/NEWS | 3 | ||||
| -rw-r--r-- | gdb/python/py-micmd.c | 11 | ||||
| -rw-r--r-- | gdb/testsuite/gdb.python/py-mi-cmd.exp | 15 |
3 files changed, 28 insertions, 1 deletions
@@ -72,6 +72,9 @@ ** The 'signed' argument to gdb.Architecture.integer_type() will no longer accept non-bool types. + ** The gdb.MICommand.installed property can only be set to True or + False. + * Debugger Adapter Protocol changes ** The "scopes" request will now return a scope holding global diff --git a/gdb/python/py-micmd.c b/gdb/python/py-micmd.c index f4abf2b..e051b90 100644 --- a/gdb/python/py-micmd.c +++ b/gdb/python/py-micmd.c @@ -509,7 +509,16 @@ micmdpy_set_installed (PyObject *self, PyObject *newvalue, void *closure) { struct micmdpy_object *micmd_obj = (struct micmdpy_object *) self; - bool installed_p = PyObject_IsTrue (newvalue); + if (!PyBool_Check (newvalue)) + { + PyErr_Format (PyExc_TypeError, + _("gdb.MICommand.installed must be set to a bool, not %s"), + newvalue == Py_None ? "None" : Py_TYPE(newvalue)->tp_name); + return -1; + } + + bool installed_p = newvalue == Py_True; + if (installed_p == (micmd_obj->mi_command != nullptr)) return 0; diff --git a/gdb/testsuite/gdb.python/py-mi-cmd.exp b/gdb/testsuite/gdb.python/py-mi-cmd.exp index 5291409..db017c6 100644 --- a/gdb/testsuite/gdb.python/py-mi-cmd.exp +++ b/gdb/testsuite/gdb.python/py-mi-cmd.exp @@ -233,6 +233,21 @@ mi_gdb_test "-abc str" \ "\\^error,msg=\"Undefined MI command: abc\",code=\"undefined-command\"" \ "-abc str, but now the command is gone" +mi_gdb_test "python cmd.installed = None" \ + ".*\r\n\\^error,msg=\"Error occurred in Python: gdb\\.MICommand\\.installed must be set to a bool, not None\"" \ + "re-install the mi command using value None" + +mi_gdb_test "python cmd.installed = 1" \ + ".*\r\n\\^error,msg=\"Error occurred in Python: gdb\\.MICommand\\.installed must be set to a bool, not int\"" \ + "re-install the mi command using an int value" + +mi_gdb_test "python print(cmd.installed)" \ + [multi_line \ + ".*" \ + "~\"False\\\\n\"" \ + "\\^done"] \ + "cmd is still not installed" + mi_gdb_test "python cmd.installed = True" \ ".*\\^done" \ "re-install the mi command" |