From patchwork Tue Mar 5 15:21:37 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Andrew Burgess X-Patchwork-Id: 86805 Return-Path: X-Original-To: patchwork@sourceware.org Delivered-To: patchwork@sourceware.org Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id 2B2D838582B5 for ; Tue, 5 Mar 2024 15:23:33 +0000 (GMT) X-Original-To: gdb-patches@sourceware.org Delivered-To: gdb-patches@sourceware.org Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by sourceware.org (Postfix) with ESMTPS id B722E38582AA for ; Tue, 5 Mar 2024 15:22:02 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org B722E38582AA Authentication-Results: sourceware.org; dmarc=pass (p=none dis=none) header.from=redhat.com Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=redhat.com ARC-Filter: OpenARC Filter v1.0.0 sourceware.org B722E38582AA Authentication-Results: server2.sourceware.org; arc=none smtp.remote-ip=170.10.133.124 ARC-Seal: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1709652125; cv=none; b=g/eibr1gfXiABndLzS4HPixrIjVrF6BT3Mi9fXRsXTEOlIsHoA0/yeunwHNuB0Q3zm7gGDbqFbMfMSj7es9XgzFLUTpktHScQ5JmoJutHa+DFIxYFEigPv86EwcCbZNLo+qdSJV23u+8ko0tz/YTbaUrVoh0J4LsIBxzfkQCEDk= ARC-Message-Signature: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1709652125; c=relaxed/simple; bh=SHLEteX0aRTogpOsKuq67MhGmNEE1t+SBOIdySCF7H0=; h=DKIM-Signature:From:To:Subject:Date:Message-Id:MIME-Version; b=LKqHL9Pn8J437R3Q6Tk/5JdXktC6zoXBkONjbNL1WuDebKVom+Fv7JysEWS7+PubocBvVAbUhkXrTQZop6W8Y3FlmSyfcBh4+6B2L7w7L1znwHfFLCSTCQdpRwAOZfMsGHRQrlQjW7E0yoil+VS1l3B6Q6X3hl+xqE+XSMNlB20= ARC-Authentication-Results: i=1; server2.sourceware.org DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1709652122; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=BCh/Z6wl1CCyaD1JsXboMKfAaxjeeplEoNjNnnQAuOw=; b=Wr0W7/YUQdhMu/q0X9FOrkGvgrMCfB3fOmHjMQCVnNc0yEo9+IXTw23657A0ZnEYjPQ6i4 g1NOLEX2MbBJKnay9zB2xfWsl0PEXtc1LVaBzdXSDGjBeQKty/gqQkuHZMQdDqGLqCzfrF OxYLW7XVLgX1RekQgCW/Fe9Vj6QOilk= Received: from mail-ed1-f69.google.com (mail-ed1-f69.google.com [209.85.208.69]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-148-d1rEeRVdPrej0yrj3kEsbA-1; Tue, 05 Mar 2024 10:22:01 -0500 X-MC-Unique: d1rEeRVdPrej0yrj3kEsbA-1 Received: by mail-ed1-f69.google.com with SMTP id 4fb4d7f45d1cf-566ae32611eso5497291a12.1 for ; Tue, 05 Mar 2024 07:22:00 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1709652119; x=1710256919; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=BCh/Z6wl1CCyaD1JsXboMKfAaxjeeplEoNjNnnQAuOw=; b=aJ5E97NOnoHh0Dw9J9DYjNaXYgAoFh7dvVzQKq7E3GvmCgU6pJS9v9LSG50j7t6whS zWYNhYTfKmisSFew6PD4J9wqeK88iyDcndZ0WVpeiqLl1h0TlGZ330GV8kWgI7k3QwWg JHBeoceMxsJL1jk10awmJv+gLXBEZuMYbLA8TS0AKmGFR6vx6yjrgeRzDGBvOqOlpt5t hH2CP16Slu8gO956mbogYASFeRn6GrAv85ZrKoiDAJBtdYETwxamsTGUmqRQPwUkAve5 KS7fGeWCdpx9l3kh00ra6xAlL+vfNvZN55fe5jKBjhjTAp2nGFMMjRB2bVczfoNRNbOF uh6A== X-Gm-Message-State: AOJu0YwpDqck4I1DWwOrESlofNTjDfrmghzwtFdI7SWVZCiMTh2RIdha 2lK/aHRfzlWscSJMpwT2exhD6LclWgiFlx7NU/5+2zfUm7L2ZRLLsgYa2TMwPLQPWOMVaEeGOqX QGOUIivbdLAy5utvcPr7AqEw3vDejMp82kg8gxOL1fDUtR1DYMP31HJRsEX7gomIWT+6UgdjfKf yJ2+jLKmGUuMeY8RqeqpbmIht5Ur4HnTK8qE1WR0Se0r8= X-Received: by 2002:a50:85c3:0:b0:566:5cd2:873 with SMTP id q3-20020a5085c3000000b005665cd20873mr3192690edh.4.1709652119470; Tue, 05 Mar 2024 07:21:59 -0800 (PST) X-Google-Smtp-Source: AGHT+IG3Z2BaSze9NRYmgA4rfHGB+l6nmL9kpE0PBn2QoT2kscrk/q61N5XDTZO6gyMxVXZpnvIysA== X-Received: by 2002:a50:85c3:0:b0:566:5cd2:873 with SMTP id q3-20020a5085c3000000b005665cd20873mr3192660edh.4.1709652118863; Tue, 05 Mar 2024 07:21:58 -0800 (PST) Received: from localhost (185.223.159.143.dyn.plus.net. [143.159.223.185]) by smtp.gmail.com with ESMTPSA id em2-20020a056402364200b00567a2564ab5sm455219edb.67.2024.03.05.07.21.58 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 05 Mar 2024 07:21:58 -0800 (PST) From: Andrew Burgess To: gdb-patches@sourceware.org Cc: Andrew Burgess Subject: [PATCHv9 06/14] gdb: don't display inferior list for pending breakpoints Date: Tue, 5 Mar 2024 15:21:37 +0000 Message-Id: X-Mailer: git-send-email 2.25.4 In-Reply-To: References: MIME-Version: 1.0 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com X-Spam-Status: No, score=-12.3 required=5.0 tests=BAYES_00, DKIMWL_WL_HIGH, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, GIT_PATCH_0, KAM_SHORT, RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H4, RCVD_IN_MSPIKE_WL, SPF_HELO_NONE, SPF_NONE, TXREP, T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org X-BeenThere: gdb-patches@sourceware.org X-Mailman-Version: 2.1.30 Precedence: list List-Id: Gdb-patches mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: gdb-patches-bounces+patchwork=sourceware.org@sourceware.org I noticed that in the 'info breakpoints' output, GDB sometimes prints the inferior list for pending breakpoints, this doesn't seem right to me. A pending breakpoint has no locations (at least, as far as we display things in the 'info breakpoints' output), so including an inferior list seems odd. Here's what I see right now: (gdb) info breakpoint 5 Num Type Disp Enb Address What 5 breakpoint keep y foo inf 1 (gdb) It's the 'inf 1' at the end of the line that I'm objecting too. To trigger this behaviour we need to be in a multi-inferior debug session. The breakpoint must have been non-pending at some point in the past, and so have a location assigned to it. The breakpoint becomes pending again as a result of a shared library being unloaded. When this happens the location itself is marked pending (via bp_location::shlib_disabled). In print_one_breakpoint_location, in order to print the inferior list we check that the breakpoint has a location, and that we have multiple inferiors, but we don't check if the location itself is pending. This commit adds that check, which means the output is now: (gdb) info breakpoint 5 Num Type Disp Enb Address What 5 breakpoint keep y foo (gdb) Which I think makes more sense -- indeed, the format without the inferior list is what we display for a pending breakpoint that has never had any locations assigned, so I think this change in behaviour makes GDB more consistent. --- gdb/breakpoint.c | 2 +- gdb/testsuite/gdb.multi/pending-bp-lib.c | 22 ++++ gdb/testsuite/gdb.multi/pending-bp.c | 66 ++++++++++++ gdb/testsuite/gdb.multi/pending-bp.exp | 126 +++++++++++++++++++++++ 4 files changed, 215 insertions(+), 1 deletion(-) create mode 100644 gdb/testsuite/gdb.multi/pending-bp-lib.c create mode 100644 gdb/testsuite/gdb.multi/pending-bp.c create mode 100644 gdb/testsuite/gdb.multi/pending-bp.exp diff --git a/gdb/breakpoint.c b/gdb/breakpoint.c index c9023a13d6c..aae1b932a5d 100644 --- a/gdb/breakpoint.c +++ b/gdb/breakpoint.c @@ -6587,7 +6587,7 @@ print_one_breakpoint_location (struct breakpoint *b, } } - if (loc != NULL && !header_of_multiple) + if (loc != nullptr && !header_of_multiple && !loc->shlib_disabled) { std::vector inf_nums; int mi_only = 1; diff --git a/gdb/testsuite/gdb.multi/pending-bp-lib.c b/gdb/testsuite/gdb.multi/pending-bp-lib.c new file mode 100644 index 00000000000..15d1b9833dd --- /dev/null +++ b/gdb/testsuite/gdb.multi/pending-bp-lib.c @@ -0,0 +1,22 @@ +/* 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 . */ + +int global_var = 0; + +void +foo (int arg) +{ + global_var = arg; +} diff --git a/gdb/testsuite/gdb.multi/pending-bp.c b/gdb/testsuite/gdb.multi/pending-bp.c new file mode 100644 index 00000000000..879e0b11ac7 --- /dev/null +++ b/gdb/testsuite/gdb.multi/pending-bp.c @@ -0,0 +1,66 @@ +/* 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 . */ + +#include +#include + +void +breakpt (void) +{ + /* Nothing. */ +} + +volatile int global_counter = 0; + +volatile int call_count = 1; + +int +main (void) +{ + void *handle; + void (*func)(int); + + /* Some filler work so that we don't initially stop on the breakpt call + below. */ + ++global_counter; + + breakpt (); /* Break before open. */ + + /* Now load the shared library. */ + handle = dlopen (SHLIB_NAME, RTLD_LAZY); + if (handle == NULL) + abort (); + + breakpt (); /* Break after open. */ + + /* Find the function symbol. */ + func = (void (*)(int)) dlsym (handle, "foo"); + + for (; call_count > 0; --call_count) + { + /* Call the library function. */ + func (1); + } + + breakpt (); /* Break before close. */ + + /* Unload the shared library. */ + if (dlclose (handle) != 0) + abort (); + + breakpt (); /* Break after close. */ + + return 0; +} diff --git a/gdb/testsuite/gdb.multi/pending-bp.exp b/gdb/testsuite/gdb.multi/pending-bp.exp new file mode 100644 index 00000000000..478d8d7c037 --- /dev/null +++ b/gdb/testsuite/gdb.multi/pending-bp.exp @@ -0,0 +1,126 @@ +# 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 . + +# Tests related to pending breakpoints in a multi-inferior environment. + +require allow_shlib_tests !use_gdb_stub + +standard_testfile + +set libname $testfile-lib +set srcfile_lib $srcdir/$subdir/$libname.c +set binfile_lib [standard_output_file $libname.so] + +if { [gdb_compile_shlib $srcfile_lib $binfile_lib {}] != "" } { + untested "failed to compile shared library 1" + return -1 +} + +set binfile_lib_target [gdb_download_shlib $binfile_lib] + +if { [build_executable "failed to prepare" $testfile $srcfile \ + [list debug \ + additional_flags=-DSHLIB_NAME=\"$binfile_lib_target\" \ + shlib_load]] } { + return -1 +} + +# Start two inferiors, both running the same test binary. The arguments +# INF_1_STOP and INF_2_STOP are source code patterns that are passed to +# gdb_get_line_number to figure out where each inferior should be stopped. +# +# This proc does a clean_restart and leaves inferior 2 selected. Also the +# 'breakpoint pending' flag is enabled, so pending breakpoints can be created +# without GDB prompting the user. +proc do_test_setup { inf_1_stop inf_2_stop } { + clean_restart ${::binfile} + + gdb_locate_shlib $::binfile_lib + + if {![runto_main]} { + return false + } + + gdb_breakpoint [gdb_get_line_number ${inf_1_stop}] temporary + gdb_continue_to_breakpoint "move inferior 1 into position" + + gdb_test "add-inferior -exec ${::binfile}" \ + "Added inferior 2.*" "add inferior 2" + gdb_test "inferior 2" "Switching to inferior 2 .*" "switch to inferior 2" + + if {![runto_main]} { + return false + } + + gdb_breakpoint [gdb_get_line_number ${inf_2_stop}] temporary + gdb_continue_to_breakpoint "move inferior 2 into position" + + gdb_test_no_output "set breakpoint pending on" + + return true +} + +# Check that when a breakpoint is in the pending state, but that breakpoint +# does have some locations (those locations themselves are pending), GDB +# doesn't display the inferior list in the 'info breakpoints' output. +proc_with_prefix test_no_inf_display {} { + do_test_setup "Break before open" "Break before open" + + # Create a breakpoint on 'foo'. As the shared library (that + # contains foo) has not been loaded into any inferior yet, then + # there will be no locations and the breakpoint will be created + # pending. Pass the 'allow-pending' flag so the gdb_breakpoint + # correctly expects the new breakpoint to be pending. + gdb_breakpoint "foo" allow-pending + set bpnum [get_integer_valueof "\$bpnum" "*INVALID*" \ + "get foo breakpoint number"] + + # Check the 'info breakpoints' output; the breakpoint is pending with + # no 'inf X' appearing at the end of the line. + gdb_test "info breakpoint $bpnum" \ + "$bpnum\\s+breakpoint\\s+keep\\s+y\\s+\\s+foo" \ + "check info bp before locations have been created" + + # Now select inferior 1 and allow the inferior to run forward to the + # point where a breakpoint location for foo will have been created. + gdb_test "inferior 1" "Switching to inferior 1 .*" + gdb_breakpoint [gdb_get_line_number "Break after open"] temporary + gdb_continue_to_breakpoint \ + "move inferior 1 until a location has been added" + + # Check the 'info breakpoints' output. Notice we display the inferior + # list at the end of the breakpoint line. + gdb_test "info breakpoint $bpnum" \ + "$bpnum\\s+breakpoint\\s+keep\\s+y\\s+$::hex\\s+\]*>\\s+inf 1" \ + "check info breakpoints while breakpoint is inserted" + + # Continue inferior 1 until the shared library has been unloaded. The + # breakpoint on 'foo' will return to the pending state. We will need to + # 'continue' twice as the first time will hit the 'foo' breakpoint. + gdb_breakpoint [gdb_get_line_number "Break after close"] temporary + gdb_continue_to_breakpoint "hit the breakpoint in foo" + gdb_continue_to_breakpoint "after close library" + + # Check the 'info breakpoints' output, check there is no 'inf 1' at the + # end of the breakpoint line. + gdb_test "info breakpoint $bpnum" \ + [multi_line \ + "$bpnum\\s+breakpoint\\s+keep\\s+y\\s+\\s+foo" \ + "\\s+breakpoint already hit 1 time"] \ + "check info breakpoints while breakpoint is pending" +} + +# Run all the tests. +test_no_inf_display