]> git.ipfire.org Git - thirdparty/binutils-gdb.git/commit
gdb/python/guile: fix segfault from nested prefix command creation
authorAndrew Burgess <aburgess@redhat.com>
Tue, 3 Jun 2025 16:23:10 +0000 (17:23 +0100)
committerAndrew Burgess <aburgess@redhat.com>
Wed, 4 Jun 2025 08:39:33 +0000 (09:39 +0100)
commitf84a4db958af0ee1521acdf69eb2be38ea2e66a3
tree4217ea7569d4b9e5be3149fa41dafee590fd29c3
parent4c1459870634074ea2266ec5755371eec3948963
gdb/python/guile: fix segfault from nested prefix command creation

A commit I recently pushed:

  commit 0b5023cc71d3af8b18e10e6599a3f9381bc15265
  Date:   Sat Apr 12 09:15:53 2025 +0100

      gdb/python/guile: user created prefix commands get help list

can trigger a segfault if a user tries to create nested prefix
commands.  For example, this will trigger a crash:

  (gdb) python gdb.ParameterPrefix("prefix-1", gdb.COMMAND_NONE)
  (gdb) python gdb.ParameterPrefix("prefix-1 prefix-2", gdb.COMMAND_NONE)

  Fatal signal: Segmentation fault
  ... etc ...

If the user adds an actual parameter under 'prefix-1' before creating
'prefix-2', then everything is fine:

  (gdb) python gdb.ParameterPrefix("prefix-1", gdb.COMMAND_NONE)
  (gdb) python gdb.Parameter('prefix-1 param-1', gdb.COMMAND_NONE, gdb.PARAM_BOOLEAN)
  (gdb) python gdb.ParameterPrefix("prefix-1 prefix-2", gdb.COMMAND_NONE)

The mistake in the above patch is in how gdbpy_parse_command_name is
used.  The BASE_LIST output argument from this function points to the
list of commands for the prefix, not to the prefix command itself.

So when gdbpy_parse_command_name is called for 'prefix-1 prefix-2',
BASE_LIST points to the list of commands associated with 'prefix-1',
not to the actual 'prefix-1' cmd_list_element.

Back in cmdpy_init, from where gdbpy_parse_command_name was called, I
was walking back from the first entry in BASE_LIST to figure out if
this was a "show" prefix command or not.  However, if BASE_LIST is
empty then there is no first item, and this would trigger the
segfault.

The solution it to extend gdbpy_parse_command_name to also return the
prefix cmd_list_element in addition to the existing values.  With this
done, and cmdpy_init updated, the segfault is now avoided.

There's a new test that would trigger the crash without the patch.

And, of course, the above commit also broke guile in the exact same
way.  And the fix is exactly the same.  And there's a guile test too.

NOTE: We should investigate possibly sharing some of this boiler plate
helper code between Python and Guile.  But not in this commit.

Approved-By: Tom Tromey <tom@tromey.com>
gdb/guile/guile-internal.h
gdb/guile/scm-cmd.c
gdb/python/py-cmd.c
gdb/python/python-internal.h
gdb/testsuite/gdb.guile/scm-parameter.exp
gdb/testsuite/gdb.python/py-parameter-prefix.exp