[1/3] gdb: don't print global thread-id to CLI in describe_other_breakpoints

Message ID a3b98e8303607fdfb3bdb521736701e8f0b3dba6.1675869497.git.aburgess@redhat.com
State Committed
Commit ce068c5f45aeebc9729499253e0a8f1f29be65c2
Headers
Series Avoid printing global thread-id in CLI command output |

Commit Message

Andrew Burgess Feb. 8, 2023, 3:23 p.m. UTC
  I noticed that describe_other_breakpoints was printing the global
thread-id to the CLI.  For CLI output we should be printing the
inferior local thread-id (e.g. "2.1").  This can be seen in the
following GDB session:

  (gdb) info threads
    Id   Target Id                                Frame
    1.1  Thread 4065742.4065742 "bp-thread-speci" main () at /tmp/bp-thread-specific.c:27
  * 2.1  Thread 4065743.4065743 "bp-thread-speci" main () at /tmp/bp-thread-specific.c:27
  (gdb) break foo thread 2.1
  Breakpoint 3 at 0x40110a: foo. (2 locations)
  (gdb) break foo thread 1.1
  Note: breakpoint 3 (thread 2) also set at pc 0x40110a.
  Note: breakpoint 3 (thread 2) also set at pc 0x40110a.
  Breakpoint 4 at 0x40110a: foo. (2 locations)

Notice that GDB says:

  Note: breakpoint 3 (thread 2) also set at pc 0x40110a.

The 'thread 2' in here is using the global thread-id, we should
instead say 'thread 2.1' which corresponds to how the user specified
the breakpoint.

This commit fixes this issue and adds a test.
---
 gdb/breakpoint.c                              |  5 +-
 gdb/testsuite/gdb.multi/bp-thread-specific.c  | 28 +++++++++
 .../gdb.multi/bp-thread-specific.exp          | 61 +++++++++++++++++++
 3 files changed, 93 insertions(+), 1 deletion(-)
 create mode 100644 gdb/testsuite/gdb.multi/bp-thread-specific.c
 create mode 100644 gdb/testsuite/gdb.multi/bp-thread-specific.exp
  

Comments

Pedro Alves Feb. 8, 2023, 5:55 p.m. UTC | #1
On 2023-02-08 3:23 p.m., Andrew Burgess via Gdb-patches wrote:
> I noticed that describe_other_breakpoints was printing the global
> thread-id to the CLI.  For CLI output we should be printing the
> inferior local thread-id (e.g. "2.1").  This can be seen in the
> following GDB session:
> 
>   (gdb) info threads
>     Id   Target Id                                Frame
>     1.1  Thread 4065742.4065742 "bp-thread-speci" main () at /tmp/bp-thread-specific.c:27
>   * 2.1  Thread 4065743.4065743 "bp-thread-speci" main () at /tmp/bp-thread-specific.c:27
>   (gdb) break foo thread 2.1
>   Breakpoint 3 at 0x40110a: foo. (2 locations)
>   (gdb) break foo thread 1.1
>   Note: breakpoint 3 (thread 2) also set at pc 0x40110a.
>   Note: breakpoint 3 (thread 2) also set at pc 0x40110a.
>   Breakpoint 4 at 0x40110a: foo. (2 locations)
> 
> Notice that GDB says:
> 
>   Note: breakpoint 3 (thread 2) also set at pc 0x40110a.
> 
> The 'thread 2' in here is using the global thread-id, we should
> instead say 'thread 2.1' which corresponds to how the user specified
> the breakpoint.
> 
> This commit fixes this issue and adds a test.

Approved-By: Pedro Alves <pedro@palves.net>
  
Andrew Burgess Feb. 11, 2023, 5:41 p.m. UTC | #2
Pedro Alves <pedro@palves.net> writes:

> On 2023-02-08 3:23 p.m., Andrew Burgess via Gdb-patches wrote:
>> I noticed that describe_other_breakpoints was printing the global
>> thread-id to the CLI.  For CLI output we should be printing the
>> inferior local thread-id (e.g. "2.1").  This can be seen in the
>> following GDB session:
>> 
>>   (gdb) info threads
>>     Id   Target Id                                Frame
>>     1.1  Thread 4065742.4065742 "bp-thread-speci" main () at /tmp/bp-thread-specific.c:27
>>   * 2.1  Thread 4065743.4065743 "bp-thread-speci" main () at /tmp/bp-thread-specific.c:27
>>   (gdb) break foo thread 2.1
>>   Breakpoint 3 at 0x40110a: foo. (2 locations)
>>   (gdb) break foo thread 1.1
>>   Note: breakpoint 3 (thread 2) also set at pc 0x40110a.
>>   Note: breakpoint 3 (thread 2) also set at pc 0x40110a.
>>   Breakpoint 4 at 0x40110a: foo. (2 locations)
>> 
>> Notice that GDB says:
>> 
>>   Note: breakpoint 3 (thread 2) also set at pc 0x40110a.
>> 
>> The 'thread 2' in here is using the global thread-id, we should
>> instead say 'thread 2.1' which corresponds to how the user specified
>> the breakpoint.
>> 
>> This commit fixes this issue and adds a test.
>
> Approved-By: Pedro Alves <pedro@palves.net>

Pushed.

Thanks,
Andrew
  

Patch

diff --git a/gdb/breakpoint.c b/gdb/breakpoint.c
index adf38e7d722..701555a060e 100644
--- a/gdb/breakpoint.c
+++ b/gdb/breakpoint.c
@@ -7045,7 +7045,10 @@  describe_other_breakpoints (struct gdbarch *gdbarch,
 	    if (b->thread == -1 && thread != -1)
 	      gdb_printf (" (all threads)");
 	    else if (b->thread != -1)
-	      gdb_printf (" (thread %d)", b->thread);
+	      {
+		struct thread_info *thr = find_thread_global_id (b->thread);
+		gdb_printf (" (thread %s)", print_thread_id (thr));
+	      }
 	    gdb_printf ("%s%s ",
 			((b->enable_state == bp_disabled
 			  || b->enable_state == bp_call_disabled)
diff --git a/gdb/testsuite/gdb.multi/bp-thread-specific.c b/gdb/testsuite/gdb.multi/bp-thread-specific.c
new file mode 100644
index 00000000000..51b6492085f
--- /dev/null
+++ b/gdb/testsuite/gdb.multi/bp-thread-specific.c
@@ -0,0 +1,28 @@ 
+/* 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/>.  */
+
+int
+foo ()
+{
+  return 0;
+}
+
+int
+main ()
+{
+  return foo ();
+}
diff --git a/gdb/testsuite/gdb.multi/bp-thread-specific.exp b/gdb/testsuite/gdb.multi/bp-thread-specific.exp
new file mode 100644
index 00000000000..777fcf85ab0
--- /dev/null
+++ b/gdb/testsuite/gdb.multi/bp-thread-specific.exp
@@ -0,0 +1,61 @@ 
+# 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/>.
+
+# Check that GDB uses the correct thread-id when describing multiple
+# thread specific breakpoints at the same location.
+
+# The plain remote target can't do multiple inferiors.
+require !use_gdb_stub
+
+standard_testfile
+
+if {[prepare_for_testing "failed to prepare" $testfile $srcfile]} {
+    return -1
+}
+
+if {![runto_main]} {
+    return -1
+}
+
+gdb_test "add-inferior -exec ${binfile}" "Added inferior 2.*" "add inferior 2"
+gdb_test "inferior 2"
+
+if {![runto_main]} {
+    return -1
+}
+
+gdb_test "info threads" \
+    [multi_line \
+	 "  Id\\s+Target Id\\s+Frame\\s*" \
+	 "  1\\.1\\s+\[^\r\n\]+" \
+	 "\\* 2\\.1\\s+\[^\r\n\]+"] \
+    "check we have the expected threads"
+
+# Set the first breakpoint.  Currently this is going to insert at two
+# locations ('foo' in both inferiors) even though only one of those
+# locations will ever trigger ('foo' in inferior 2).
+gdb_test "break foo thread 2.1" \
+    "Breakpoint $decimal at $hex: foo\\. \\(2 locations\\)"
+
+set bpnum [get_integer_valueof "\$bpnum" "INVALID"]
+
+# Now set another breakpoint that will be at the same location as the
+# earlier breakpoint.  Check that the thread-id used when describing
+# the earlier breakpoints is correct.
+gdb_test "break foo thread 1.1" \
+    [multi_line \
+	 "Note: breakpoint $bpnum \\(thread 2.1\\) also set at pc $hex\\." \
+	 "Note: breakpoint $bpnum \\(thread 2.1\\) also set at pc $hex\\." \
+	 "Breakpoint $decimal at $hex: foo\\. \\(2 locations\\)"]