[binutils-gdb] [gdb] Ensure listing of unused static var in info locals

[binutils-gdb] [gdb] Ensure listing of unused static var in info locals

[Tom de Vries]

https://sourceware.org/git/gitweb.cgi?p=binutils-gdb.git;h=a88ef40d0f21342bb5ce01ce677846995ca0d133

commit a88ef40d0f21342bb5ce01ce677846995ca0d133
Author: Tom de Vries <tdevries@suse.de>
Date:   Mon Feb 24 15:32:36 2020 +0100

    [gdb] Ensure listing of unused static var in info locals
    
    Consider a test-case compiled with -g:
    ...
    int main (void) {
      static int b = 2;
      return 0;
    }
    ...
    
    When running info locals in main, we get:
    ...
    (gdb) info locals
    No locals.
    ...
    
    The info locals documentation states:
    ...
    Print the local variables of the selected frame, each on a separate line.
    These are all variables (declared either static or automatic) accessible at
    the point of execution of the selected frame.
    ...
    So, "info locals" should have printed static variable b.
    
    The variable is present in dwarf info:
    ...
     <2><14a>: Abbrev Number: 6 (DW_TAG_variable)
        <14b>   DW_AT_name        : b
        <153>   DW_AT_const_value : 2
    ...
    but instead of a location attribute, it has a const_value attribute, which
    causes the corresponding symbol to have LOC_CONST, which causes info locals to
    skip it.
    
    Fix this by handling LOC_CONST in iterate_over_block_locals.
    
    Build and reg-tested on x86_64-linux.
    
    gdb/ChangeLog:
    
    2020-02-24  Tom de Vries  <tdevries@suse.de>
    
    	PR gdb/25592
    	* stack.c (iterate_over_block_locals): Handle LOC_CONST.
    
    gdb/testsuite/ChangeLog:
    
    2020-02-24  Tom de Vries  <tdevries@suse.de>
    
    	PR gdb/25592
    	* gdb.base/info-locals-unused-static-var.c: New test.
    	* gdb.base/info-locals-unused-static-var.exp: New file.

Diff:
---
 gdb/ChangeLog                                      |  5 +++
 gdb/stack.c                                        |  1 +
 gdb/testsuite/ChangeLog                            |  6 ++++
 .../gdb.base/info-locals-unused-static-var.c       | 24 +++++++++++++
 .../gdb.base/info-locals-unused-static-var.exp     | 40 ++++++++++++++++++++++
 5 files changed, 76 insertions(+)

diff --git a/gdb/ChangeLog b/gdb/ChangeLog
index 90c895a..43ae8e8 100644
--- a/gdb/ChangeLog
+++ b/gdb/ChangeLog
@@ -1,5 +1,10 @@
 2020-02-24  Tom de Vries  <tdevries@suse.de>
 
+	PR gdb/25592
+	* stack.c (iterate_over_block_locals): Handle LOC_CONST.
+
+2020-02-24  Tom de Vries  <tdevries@suse.de>
+
 	* tui/tui-layout.c (_initialize_tui_layout): Fix help messages for
 	commands layout next/prev/regs.
 
diff --git a/gdb/stack.c b/gdb/stack.c
index af30405..266d771 100644
--- a/gdb/stack.c
+++ b/gdb/stack.c
@@ -2237,6 +2237,7 @@ iterate_over_block_locals (const struct block *b,
     {
       switch (SYMBOL_CLASS (sym))
 	{
+	case LOC_CONST:
 	case LOC_LOCAL:
 	case LOC_REGISTER:
 	case LOC_STATIC:
diff --git a/gdb/testsuite/ChangeLog b/gdb/testsuite/ChangeLog
index 6bc24e2..6e50785 100644
--- a/gdb/testsuite/ChangeLog
+++ b/gdb/testsuite/ChangeLog
@@ -1,3 +1,9 @@
+2020-02-24  Tom de Vries  <tdevries@suse.de>
+
+	PR gdb/25592
+	* gdb.base/info-locals-unused-static-var.c: New test.
+	* gdb.base/info-locals-unused-static-var.exp: New file.
+
 2020-02-22  Tom Tromey  <tom@tromey.com>
 
 	* gdb.python/tui-window.exp: New file.
diff --git a/gdb/testsuite/gdb.base/info-locals-unused-static-var.c b/gdb/testsuite/gdb.base/info-locals-unused-static-var.c
new file mode 100644
index 0000000..86d34b3
--- /dev/null
+++ b/gdb/testsuite/gdb.base/info-locals-unused-static-var.c
@@ -0,0 +1,24 @@
+/* This testcase is part of GDB, the GNU debugger.
+
+   Copyright 2020 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/>.  */
+
+int
+main (void)
+{
+  static int b = 2;
+
+  return 0;
+}
diff --git a/gdb/testsuite/gdb.base/info-locals-unused-static-var.exp b/gdb/testsuite/gdb.base/info-locals-unused-static-var.exp
new file mode 100644
index 0000000..79f02c2
--- /dev/null
+++ b/gdb/testsuite/gdb.base/info-locals-unused-static-var.exp
@@ -0,0 +1,40 @@
+# Copyright 2020 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/>.  */
+
+# Test if an unused static local var is listed with info locals.
+#
+# Note: with gcc 4.8.5, we have:
+# ...
+# (gdb) info addr b
+# Symbol "b" is static storage at address $hex
+# ...
+# but with gcc 7.5.0, we have instead:
+# ...
+# (gdb) info addr b
+# Symbol "b" is constant.
+# ...
+
+standard_testfile
+
+if {[prepare_for_testing "failed to prepare" $testfile $srcfile debug]} {
+    return -1
+}
+
+if ![runto_main] then {
+    fail "can't run to main"
+    return 0
+}
+
+gdb_test "info locals" "\r\nb = .*"