gdb/python: don't allow the user to delete window title attributes

There's a bug in the python tui API.  If the user tries to delete the
window title attribute then this will trigger undefined behaviour in
GDB due to a missing nullptr check.

gdb/ChangeLog:

	* python/py-tui.c (gdbpy_tui_set_title): Check that the new value
	for the title is not nullptr.

gdb/testsuite/ChangeLog:

	* gdb.python/tui-window.exp: Add new tests.
	* gdb.python/tui-window.py (TestWindow) <__init__>: Store
	TestWindow object into global the_window.
	<remote_title>: New method.
	(delete_window_title): New function.
This commit is contained in:
Andrew Burgess
2021-02-08 11:44:51 +00:00
parent 1cf2399651
commit e0c23e11da
5 changed files with 29 additions and 2 deletions

View File

@ -1,3 +1,8 @@
2021-02-08 Andrew Burgess <andrew.burgess@embecosm.com>
* python/py-tui.c (gdbpy_tui_set_title): Check that the new value
for the title is not nullptr.
2021-02-08 Andrew Burgess <andrew.burgess@embecosm.com>
* tui-layout.c (saved_tui_windows): Delete.

View File

@ -434,7 +434,7 @@ gdbpy_tui_set_title (PyObject *self, PyObject *newvalue, void *closure)
return -1;
}
if (win->window == nullptr)
if (newvalue == nullptr)
{
PyErr_Format (PyExc_TypeError, _("Cannot delete \"title\" attribute."));
return -1;

View File

@ -1,3 +1,11 @@
2021-02-08 Andrew Burgess <andrew.burgess@embecosm.com>
* gdb.python/tui-window.exp: Add new tests.
* gdb.python/tui-window.py (TestWindow) <__init__>: Store
TestWindow object into global the_window.
<remote_title>: New method.
(delete_window_title): New function.
2021-02-08 Andrew Burgess <andrew.burgess@embecosm.com>
* gdb.tui/winheight.exp: Add more tests.

View File

@ -47,6 +47,12 @@ Term::check_contents "test title" \
"This Is The Title"
Term::check_contents "Window display" "Test: 0"
Term::command "python delete_window_title ()"
Term::check_contents "error message after trying to delete title" \
"TypeError: Cannot delete \"title\" attribute\\."
Term::check_contents "title is unchanged" \
"This Is The Title"
Term::resize 51 51
# Remember that a resize request actually does two resizes...
Term::check_contents "Window was updated" "Test: 2"

View File

@ -22,7 +22,7 @@ the_window = None
class TestWindow:
def __init__(self, win):
global the_window
the_window = win
the_window = self
self.count = 0
self.win = win
win.title = "This Is The Title"
@ -34,8 +34,16 @@ class TestWindow:
self.win.write("Test: " + str(self.count) + " " + str(w) + "x" + str(h))
self.count = self.count + 1
# Tries to delete the title attribute. GDB will throw an error.
def remove_title(self):
del self.win.title
gdb.register_window_type("test", TestWindow)
# Call REMOVE_TITLE on the global window object.
def delete_window_title ():
the_window.remove_title ()
# A TUI window "constructor" that always fails.
def failwin(win):
raise RuntimeError("Whoops")