From patchwork Thu May 21 23:27:55 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Tom Tromey X-Patchwork-Id: 135431 Return-Path: X-Original-To: patchwork@sourceware.org Delivered-To: patchwork@sourceware.org Received: from vm01.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id E441648F60DC for ; Thu, 21 May 2026 23:29:17 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org E441648F60DC Authentication-Results: sourceware.org; dkim=fail reason="signature verification failed" (768-bit key, unprotected) header.d=tromey.com header.i=@tromey.com header.a=rsa-sha256 header.s=default header.b=WeDt5FrT X-Original-To: gdb-patches@sourceware.org Delivered-To: gdb-patches@sourceware.org Received: from omta40.uswest2.a.cloudfilter.net (omta40.uswest2.a.cloudfilter.net [35.89.44.39]) by sourceware.org (Postfix) with ESMTPS id BDD9B48F66E1 for ; Thu, 21 May 2026 23:28:00 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org BDD9B48F66E1 Authentication-Results: sourceware.org; dmarc=none (p=none dis=none) header.from=tromey.com Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=tromey.com ARC-Filter: OpenARC Filter v1.0.0 sourceware.org BDD9B48F66E1 Authentication-Results: sourceware.org; arc=none smtp.remote-ip=35.89.44.39 ARC-Seal: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1779406081; cv=none; b=HoNGA2ndFxrAQ5ZQGzAm7PMTm+TyH/6B0ijNOItMNum/jISPLq2il0Ih+RZ5QaMTL78i0co/apN9xIyUpBAHBT5ssLlZTnygKY7wogmBYv2wA31zJoGfh7Dku27fyjskgB6kCUgPbScafGfr2818f6VNkk0Xl7Ea0yLYiCXO8iM= ARC-Message-Signature: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1779406081; c=relaxed/simple; bh=RdmtT3fwFmSdvuZ1mfT7V2zbQukTCgpGkMYog2rFRBw=; h=DKIM-Signature:From:Date:Subject:MIME-Version:Message-Id:To; b=ScGFN3kzQWfCD3uh1pwu9uBZrMT8EM0GrCBXwgx3OvgfenGsLfAebeKl/ne8yOD5O887qEcgMQSLp6V19n/qfUGn1Ai+RcWhQUaAC4lHHNFToEDsWm9YI10bjGzFajnB1keS2gDVWVGIjZoLFrPsOeS4oR404ECThcPl/mEI9tQ= ARC-Authentication-Results: i=1; sourceware.org; dkim=policy (768-bit key, unprotected) header.d=tromey.com header.i=@tromey.com header.a=rsa-sha256 header.s=default header.b=WeDt5FrT reason="signing key too small" DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org BDD9B48F66E1 Received: from eig-obgw-5002b.ext.cloudfilter.net ([10.0.29.226]) by cmsmtp with ESMTPS id Q5hHwQBZEjgweQCo3whAXb; Thu, 21 May 2026 23:27:59 +0000 Received: from box5379.bluehost.com ([162.241.216.53]) by cmsmtp with ESMTPS id QCo2w9dMmmZHDQCo3wfroC; Thu, 21 May 2026 23:27:59 +0000 X-Authority-Analysis: v=2.4 cv=M6lNKzws c=1 sm=1 tr=0 ts=6a0f94ff a=ApxJNpeYhEAb1aAlGBBbmA==:117 a=ApxJNpeYhEAb1aAlGBBbmA==:17 a=IkcTkHD0fZMA:10 a=NGcC8JguVDcA:10 a=ItBw4LHWJt0A:10 a=lIVQy-06cHSF9-0ZCU0A:9 a=3ZKOabzyN94A:10 a=QEXdDO2ut3YA:10 a=DCx65vhANUyCzuf5D8fC:22 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=tromey.com; s=default; h=Cc:To:In-Reply-To:References:Message-Id: Content-Transfer-Encoding:Content-Type:MIME-Version:Subject:Date:From:Sender: Reply-To:Content-ID:Content-Description:Resent-Date:Resent-From:Resent-Sender :Resent-To:Resent-Cc:Resent-Message-ID:List-Id:List-Help:List-Unsubscribe: List-Subscribe:List-Post:List-Owner:List-Archive; bh=fPbaaefC3Ukhd8V40kflqetAqGCsk3orY6OsPy+xnUM=; b=WeDt5FrTPoM7TfypB+a+rZohOj 3wTbTyRnVMYjNnav8fP+vYOvRThdpNdthuHmtmduCjG2NbIFrD6Mg0heDTplbhMf3a/YLHVU6wECc iQAFJXNLWzWhAXtGRK8KExNEs; Received: from 75-166-225-82.hlrn.qwest.net ([75.166.225.82]:37536 helo=[192.168.0.17]) by box5379.bluehost.com with esmtpsa (TLS1.3) tls TLS_AES_256_GCM_SHA384 (Exim 4.99.2) (envelope-from ) id 1wQCo2-00000002l41-2sX3; Thu, 21 May 2026 17:27:58 -0600 From: Tom Tromey Date: Thu, 21 May 2026 17:27:55 -0600 Subject: [PATCH v3 4/4] Convert py-tui.c to the "python safety" approach MIME-Version: 1.0 Message-Id: <20260521-python-safety-initial-v3-4-d0679c36e499@tromey.com> References: <20260521-python-safety-initial-v3-0-d0679c36e499@tromey.com> In-Reply-To: <20260521-python-safety-initial-v3-0-d0679c36e499@tromey.com> To: gdb-patches@sourceware.org Cc: Tom Tromey X-Mailer: b4 0.14.3 X-AntiAbuse: This header was added to track abuse, please include it with any abuse report X-AntiAbuse: Primary Hostname - box5379.bluehost.com X-AntiAbuse: Original Domain - sourceware.org X-AntiAbuse: Originator/Caller UID/GID - [47 12] / [47 12] X-AntiAbuse: Sender Address Domain - tromey.com X-BWhitelist: no X-Source-IP: 75.166.225.82 X-Source-L: No X-Exim-ID: 1wQCo2-00000002l41-2sX3 X-Source: X-Source-Args: X-Source-Dir: X-Source-Sender: 75-166-225-82.hlrn.qwest.net ([192.168.0.17]) [75.166.225.82]:37536 X-Source-Auth: tom+tromey.com X-Email-Count: 7 X-Org: HG=bhshared;ORG=bluehost; X-Source-Cap: ZWx5bnJvYmk7ZWx5bnJvYmk7Ym94NTM3OS5ibHVlaG9zdC5jb20= X-Local-Domain: yes X-CMAE-Envelope: MS4xfHwqU8Ko9fYu0SUT+FphHYxj7G63glbGyHHjbbg/GkBc8YReE42UCvlTnT5jFQHIJobPEj8QZtQzlJxcOCysa9tLlSmccf8IFWdZWmtwOELxQgVdN/Wm teB+VJDrbiSu8pYwwzudlhCvix1Ex9Ei2Wc0xH9yqVSDebAZye2jmtd2A98uq91GHD/OzseQWm2gXEP9UHlCkghm4calqO6qcDI= X-Spam-Status: No, score=-3012.0 required=5.0 tests=BAYES_00, DKIM_SIGNED, DKIM_VALID, GIT_PATCH_0, JMQ_SPF_NEUTRAL, RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H2, SPF_HELO_NONE, TXREP, T_SPF_PERMERROR shortcircuit=no autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on sourceware.org X-BeenThere: gdb-patches@sourceware.org X-Mailman-Version: 2.1.30 Precedence: list List-Id: Gdb-patches mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: gdb-patches-bounces~patchwork=sourceware.org@sourceware.org This patch mostly converts py-tui.c to use the new Python safety code. In particular: * All methods of gdb.TuiWindow are now implemented as straightforward methods of gdbpy_tui_window. * gdbpy_register_tui_window is converted and simply returns 'void'. I converted this particular file because it was relatively straightforward, while also demonstrating most of the features of the new approach. For example, explicit result checks aren't needed, try/catch can be removed, and the methods are now written in a natural style. Note that more conversion remains to be done here: * gdbpy_tui_enabled hasn't been converted and still does explicit checks. * There's one explicit check in gdbpy_tui_window::set_title. Fully implementing the safety approach means that some low-level things should eventually be converted to throw; but some work has to be deferred until a lot of the work is complete. --- gdb/python/py-tui.c | 209 ++++++++++++++++++------------------------- gdb/python/python-internal.h | 5 +- gdb/python/python.c | 5 +- 3 files changed, 94 insertions(+), 125 deletions(-) diff --git a/gdb/python/py-tui.c b/gdb/python/py-tui.c index ca0fb89ea49..5a36814debb 100644 --- a/gdb/python/py-tui.c +++ b/gdb/python/py-tui.c @@ -44,13 +44,40 @@ class tui_py_window; /* A PyObject representing a TUI window. */ -struct gdbpy_tui_window: public PyObject +struct gdbpy_tui_window : public PyObject { /* The TUI window, or nullptr if the window has been deleted. */ tui_py_window *window; /* Return true if this object is valid. */ bool is_valid () const; + + /* Require that this object be valid. Throws exception if not. */ + void require_valid () const + { + if (!is_valid ()) + gdbpy_err_format (PyExc_RuntimeError, _("TUI window is invalid.")); + } + + /* Erase the TUI window. */ + void erase (); + + /* Python function that writes some text to a TUI window. */ + void write (gdbpy_borrowed_ref<> args, gdbpy_opt_borrowed_ref<> kw); + + /* Return the width of the TUI window. */ + int width () const; + + /* Return the height of the TUI window. */ + int height () const; + + /* Return the title of the TUI window. */ + const std::string &title () const; + + /* Set the title of the TUI window. */ + void set_title (gdbpy_opt_borrowed_ref<> new_title); + + static PyTypeObject *corresponding_object_type; }; static_assert (gdb::is_python_allocatable_v); @@ -408,173 +435,112 @@ gdbpy_tui_window_maker::operator() (const char *win_name) /* Implement "gdb.register_window_type". */ -PyObject * -gdbpy_register_tui_window (PyObject *self, PyObject *args, PyObject *kw) +void +gdbpy_register_tui_window (gdbpy_borrowed_ref<> args, + gdbpy_opt_borrowed_ref<> kw) { static const char *keywords[] = { "name", "constructor", nullptr }; - const char *name; PyObject *cons_obj; + gdbpy_arg_parse_tuple_and_keywords (args, kw, "sO", keywords, + &name, &cons_obj); - if (!gdb_PyArg_ParseTupleAndKeywords (args, kw, "sO", keywords, - &name, &cons_obj)) - return nullptr; - - try - { - gdbpy_tui_window_maker constr (gdbpy_ref<>::new_reference (cons_obj)); - tui_register_window (name, constr); - } - catch (const gdb_exception &except) - { - return gdbpy_handle_gdb_exception (nullptr, except); - } - - return py_none ().release (); + gdbpy_tui_window_maker constr (gdbpy_ref<>::new_reference (cons_obj)); + tui_register_window (name, constr); } -/* Require that "Window" be a valid window. */ - -#define REQUIRE_WINDOW(Window) \ - do { \ - if (!(Window)->is_valid ()) \ - return PyErr_Format (PyExc_RuntimeError, \ - _("TUI window is invalid.")); \ - } while (0) - -/* Require that "Window" be a valid window. */ - -#define REQUIRE_WINDOW_FOR_SETTER(Window) \ - do { \ - if (!(Window)->is_valid ()) \ - { \ - PyErr_Format (PyExc_RuntimeError, \ - _("TUI window is invalid.")); \ - return -1; \ - } \ - } while (0) - -/* Python function which checks the validity of a TUI window - object. */ -static PyObject * -gdbpy_tui_is_valid (PyObject *self, PyObject *args) -{ - gdbpy_tui_window *win = (gdbpy_tui_window *) self; - - if (win->is_valid ()) - return py_true ().release (); - return py_false ().release (); -} - /* Python function that erases the TUI window. */ -static PyObject * -gdbpy_tui_erase (PyObject *self, PyObject *args) +void +gdbpy_tui_window::erase () { - gdbpy_tui_window *win = (gdbpy_tui_window *) self; - - REQUIRE_WINDOW (win); - - win->window->erase (); - - return py_none ().release (); + require_valid (); + window->erase (); } /* Python function that writes some text to a TUI window. */ -static PyObject * -gdbpy_tui_write (PyObject *self, PyObject *args, PyObject *kw) +void +gdbpy_tui_window::write (gdbpy_borrowed_ref<> args, + gdbpy_opt_borrowed_ref<> kw) { + require_valid (); + static const char *keywords[] = { "string", "full_window", nullptr }; - gdbpy_tui_window *win = (gdbpy_tui_window *) self; const char *text; int full_window = 0; - if (!gdb_PyArg_ParseTupleAndKeywords (args, kw, "s|i", keywords, - &text, &full_window)) - return nullptr; - - REQUIRE_WINDOW (win); + gdbpy_arg_parse_tuple_and_keywords (args, kw, "s|i", keywords, + &text, &full_window); - win->window->output (text, full_window); - - return py_none ().release (); + window->output (text, full_window); } -/* Return the width of the TUI window. */ -static PyObject * -gdbpy_tui_width (PyObject *self, void *closure) +int +gdbpy_tui_window::width () const { - gdbpy_tui_window *win = (gdbpy_tui_window *) self; - REQUIRE_WINDOW (win); - gdbpy_ref<> result - = gdb_py_object_from_longest (win->window->viewport_width ()); - return result.release (); + require_valid (); + return window->viewport_width (); } -/* Return the height of the TUI window. */ -static PyObject * -gdbpy_tui_height (PyObject *self, void *closure) +int +gdbpy_tui_window::height () const { - gdbpy_tui_window *win = (gdbpy_tui_window *) self; - REQUIRE_WINDOW (win); - gdbpy_ref<> result - = gdb_py_object_from_longest (win->window->viewport_height ()); - return result.release (); + require_valid (); + return window->viewport_height (); } -/* Return the title of the TUI window. */ -static PyObject * -gdbpy_tui_title (PyObject *self, void *closure) +const std::string & +gdbpy_tui_window::title () const { - gdbpy_tui_window *win = (gdbpy_tui_window *) self; - REQUIRE_WINDOW (win); - return host_string_to_python_string (win->window->title ().c_str ()).release (); + require_valid (); + return window->title (); } /* Set the title of the TUI window. */ -static int -gdbpy_tui_set_title (PyObject *self, PyObject *newvalue, void *closure) +void +gdbpy_tui_window::set_title (gdbpy_opt_borrowed_ref<> new_title) { - gdbpy_tui_window *win = (gdbpy_tui_window *) self; + require_valid (); - REQUIRE_WINDOW_FOR_SETTER (win); - - if (newvalue == nullptr) - { - PyErr_Format (PyExc_TypeError, _("Cannot delete \"title\" attribute.")); - return -1; - } + if (new_title == nullptr) + gdbpy_err_format (PyExc_TypeError, + _("Cannot delete \"title\" attribute.")); + /* FIXME: Python safety. Ideally python_string_to_host_string would + throw on error, but this can't be done until more of the code has + been converted. */ gdb::unique_xmalloc_ptr value - = python_string_to_host_string (newvalue); + = python_string_to_host_string (new_title); if (value == nullptr) - return -1; + throw gdb_python_exception (); - win->window->set_title (value.get ()); - return 0; + window->set_title (value.get ()); } static gdb_PyGetSetDef tui_object_getset[] = { - { "width", gdbpy_tui_width, NULL, "Width of the window.", NULL }, - { "height", gdbpy_tui_height, NULL, "Height of the window.", NULL }, - { "title", gdbpy_tui_title, gdbpy_tui_set_title, "Title of the window.", - NULL }, - { NULL } /* Sentinel */ + { "width", wrap_getter, nullptr, + "Width of the window.", nullptr }, + { "height", wrap_getter, nullptr, + "Height of the window.", nullptr }, + { "title", wrap_getter, + wrap_setter, + "Title of the window.", nullptr }, + { nullptr } /* Sentinel */ }; static PyMethodDef tui_object_methods[] = { - { "is_valid", gdbpy_tui_is_valid, METH_NOARGS, + noargs_method ("is_valid", "is_valid () -> Boolean\n\ -Return true if this TUI window is valid, false if not." }, - { "erase", gdbpy_tui_erase, METH_NOARGS, - "Erase the TUI window." }, - { "write", (PyCFunction) gdbpy_tui_write, METH_VARARGS | METH_KEYWORDS, - "Append a string to the TUI window." }, - { NULL } /* Sentinel. */ +Return true if this TUI window is valid, false if not."), + noargs_method + ("erase", "Erase the TUI window."), + varargs_method ("write", + "Append a string to the TUI window."), + { nullptr } /* Sentinel. */ }; PyTypeObject gdbpy_tui_window_object_type = @@ -618,6 +584,9 @@ PyTypeObject gdbpy_tui_window_object_type = 0, /* tp_alloc */ }; +PyTypeObject *gdbpy_tui_window::corresponding_object_type + = &gdbpy_tui_window_object_type; + /* Called when TUI is enabled or disabled. */ static void diff --git a/gdb/python/python-internal.h b/gdb/python/python-internal.h index c7a496899e0..686ae63c315 100644 --- a/gdb/python/python-internal.h +++ b/gdb/python/python-internal.h @@ -498,8 +498,9 @@ gdb::unique_xmalloc_ptr gdbpy_parse_command_name (const char *name, struct cmd_list_element ***base_list, struct cmd_list_element **start_list, struct cmd_list_element **prefix_cmd = nullptr); -PyObject *gdbpy_register_tui_window (PyObject *self, PyObject *args, - PyObject *kw); + +void gdbpy_register_tui_window (gdbpy_borrowed_ref<> args, + gdbpy_opt_borrowed_ref<> kw); gdbpy_ref<> symtab_and_line_to_sal_object (struct symtab_and_line sal); gdbpy_ref<> symtab_to_symtab_object (struct symtab *symtab); diff --git a/gdb/python/python.c b/gdb/python/python.c index fd254a340d8..849154ff20c 100644 --- a/gdb/python/python.c +++ b/gdb/python/python.c @@ -3274,10 +3274,9 @@ or None if not set." }, Set the value of the convenience variable $NAME." }, #ifdef TUI - { "register_window_type", (PyCFunction) gdbpy_register_tui_window, - METH_VARARGS | METH_KEYWORDS, + varargs_function ("register_window_type", "register_window_type (NAME, CONSTRUCTOR) -> None\n\ -Register a TUI window constructor." }, +Register a TUI window constructor."), #endif /* TUI */ { "architecture_names", gdbpy_all_architecture_names, METH_NOARGS,