[2/2] Fix crash in go_symbol_package_name

Message ID 20230216-submit-go-unique-ptr-v1-2-73dd8065c6a6@tromey.com
State New
Headers
Series Fix a crash in go-lang.c |

Commit Message

Tom Tromey Feb. 17, 2023, 1 a.m. UTC
  go_symbol_package_name package name asserts that it is only passed a
Go symbol, but this is not enforced by one caller.  It seems simplest
to just check and return early in this case.

Bug: https://sourceware.org/bugzilla/show_bug.cgi?id=17876
---
 gdb/go-lang.c                       |  3 ++-
 gdb/testsuite/gdb.go/no-package.exp | 31 +++++++++++++++++++++++++++++++
 2 files changed, 33 insertions(+), 1 deletion(-)
  

Comments

Andrew Burgess Feb. 17, 2023, 10:51 p.m. UTC | #1
Tom Tromey <tom@tromey.com> writes:

> go_symbol_package_name package name asserts that it is only passed a
> Go symbol, but this is not enforced by one caller.  It seems simplest
> to just check and return early in this case.
>
> Bug: https://sourceware.org/bugzilla/show_bug.cgi?id=17876
> ---
>  gdb/go-lang.c                       |  3 ++-
>  gdb/testsuite/gdb.go/no-package.exp | 31 +++++++++++++++++++++++++++++++
>  2 files changed, 33 insertions(+), 1 deletion(-)
>
> diff --git a/gdb/go-lang.c b/gdb/go-lang.c
> index f9176ace71d..bbf80af1f5c 100644
> --- a/gdb/go-lang.c
> +++ b/gdb/go-lang.c
> @@ -394,7 +394,8 @@ go_symbol_package_name (const struct symbol *sym)
>    int method_type_is_pointer;
>    gdb::unique_xmalloc_ptr<char> name_buf;
>  
> -  gdb_assert (sym->language () == language_go);
> +  if (sym->language () != language_go)
> +    return nullptr;

I think the comment for this function in go-lang.h can be updated.  The
comment claims that this function takes a Go symbol, when we now take
any symbol.

Looks fine with that updated.

Reviewed-By: Andrew Burgess <aburgess@redhat.com>

Thanks,
Andrew


>    name_buf = unpack_mangled_go_symbol (mangled_name,
>  				       &package_name, &object_name,
>  				       &method_type_package_name,
> diff --git a/gdb/testsuite/gdb.go/no-package.exp b/gdb/testsuite/gdb.go/no-package.exp
> new file mode 100644
> index 00000000000..3b39bc3220d
> --- /dev/null
> +++ b/gdb/testsuite/gdb.go/no-package.exp
> @@ -0,0 +1,31 @@
> +# This testcase is part of GDB, the GNU debugger.
> +
> +# Copyright 2023 Free Software Foundation, Inc.
> +#
> +# This program is free software; you can redistribute it and/or modify
> +# it under the terms of the GNU General Public License as published by
> +# the Free Software Foundation; either version 3 of the License, or
> +# (at your option) any later version.
> +#
> +# This program is distributed in the hope that it will be useful,
> +# but WITHOUT ANY WARRANTY; without even the implied warranty of
> +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
> +# GNU General Public License for more details.
> +#
> +# You should have received a copy of the GNU General Public License
> +# along with this program.  If not, see <http://www.gnu.org/licenses/>.
> +
> +# Regression test for a crash in go_symbol_package_name.
> +
> +load_lib "go.exp"
> +
> +require allow_go_tests support_go_compile !use_gdb_stub
> +
> +standard_testfile integers.go
> +
> +if {[prepare_for_testing "failed to prepare" ${testfile} ${srcfile} {debug go}]} {
> +    return -1
> +}
> +
> +# The bug was that stopping in _start would crash.
> +runto "*_start" message
>
> -- 
> 2.39.1
  
Tom Tromey Feb. 18, 2023, midnight UTC | #2
Andrew> I think the comment for this function in go-lang.h can be updated.  The
Andrew> comment claims that this function takes a Go symbol, when we now take
Andrew> any symbol.

Andrew> Looks fine with that updated.

I made this change, thanks.
I'm going to check these in soon.

Tom
  

Patch

diff --git a/gdb/go-lang.c b/gdb/go-lang.c
index f9176ace71d..bbf80af1f5c 100644
--- a/gdb/go-lang.c
+++ b/gdb/go-lang.c
@@ -394,7 +394,8 @@  go_symbol_package_name (const struct symbol *sym)
   int method_type_is_pointer;
   gdb::unique_xmalloc_ptr<char> name_buf;
 
-  gdb_assert (sym->language () == language_go);
+  if (sym->language () != language_go)
+    return nullptr;
   name_buf = unpack_mangled_go_symbol (mangled_name,
 				       &package_name, &object_name,
 				       &method_type_package_name,
diff --git a/gdb/testsuite/gdb.go/no-package.exp b/gdb/testsuite/gdb.go/no-package.exp
new file mode 100644
index 00000000000..3b39bc3220d
--- /dev/null
+++ b/gdb/testsuite/gdb.go/no-package.exp
@@ -0,0 +1,31 @@ 
+# This testcase is part of GDB, the GNU debugger.
+
+# Copyright 2023 Free Software Foundation, Inc.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Regression test for a crash in go_symbol_package_name.
+
+load_lib "go.exp"
+
+require allow_go_tests support_go_compile !use_gdb_stub
+
+standard_testfile integers.go
+
+if {[prepare_for_testing "failed to prepare" ${testfile} ${srcfile} {debug go}]} {
+    return -1
+}
+
+# The bug was that stopping in _start would crash.
+runto "*_start" message