From patchwork Thu Oct 20 18:11:02 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Johnson Sun X-Patchwork-Id: 59213 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 5B0A8384D175 for ; Thu, 20 Oct 2022 18:12:16 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 5B0A8384D175 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sourceware.org; s=default; t=1666289536; bh=flG0Nh1IdfPm5pBL5pYk1YIUAsVGk7WChNu+IkWscVA=; h=To:Subject:Date:In-Reply-To:References:List-Id:List-Unsubscribe: List-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To:Cc: From; b=knEQRRYXMKpq3yOAnuf68RHDQrS5CeD2c4ZeB2xCxgdSPs+6F5J9/HPQQcAGW3RqL onnxKGFV0F6EY4fi4WVF0bdc8gbpM6Km2KLBpEqZlHScJ6lz1SWWXveKLz8CCUXJWg RumA3f3YAWX/2LulVppl0+MPAD5fir9ls2te1A8k= X-Original-To: gdb-patches@sourceware.org Delivered-To: gdb-patches@sourceware.org Received: from mail-oa1-x2a.google.com (mail-oa1-x2a.google.com [IPv6:2001:4860:4864:20::2a]) by sourceware.org (Postfix) with ESMTPS id 4B369384D14D for ; Thu, 20 Oct 2022 18:11:51 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org 4B369384D14D Received: by mail-oa1-x2a.google.com with SMTP id 586e51a60fabf-1321a1e94b3so586085fac.1 for ; Thu, 20 Oct 2022 11:11:51 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; 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=flG0Nh1IdfPm5pBL5pYk1YIUAsVGk7WChNu+IkWscVA=; b=VthHKLc5mmKSjqEodYIqekXNZ6y8HAfJHZSLgxqWSv3J/YG6X3gpl2rNjg61u3uYHA Z5PHrv5CWG5dQe0uOm9Xz1RHnwlhfjg8UNZvjlBE/p/gn55i0m5uaCPkf6gQuWl3dVQg 7ZzkeByfBmrsLS+HcTkA6VL8owNo3ObNBWCx7tRJ156FGn/D+6tilesxdbavXQhZBmI4 tHWdtveLHjVV9ThX0gLaGInkF2jP/DDI7aFAWysvAmhChECsEc/gltQQGnjH9WPLG1N8 Ubo4ljd9N/L3qi1sKc7E8DVDCtThAt2x/bbWS36vbentV8iZwfbmkLHha0oMgOq6F8xS RGQQ== X-Gm-Message-State: ACrzQf0NahfCWN9orWd5TpujOoyk10bzl81ORasRcQiZyBUscDTRqFxN 4kYeWFagc7sTKzGphbL9ezNJKWoXo2d0IZnG X-Google-Smtp-Source: AMsMyM5cSczc/jrnt8G4cyNTgauQww9jM5ftaXhe15txxH9WfXGBaEKIn1h6rrtlXHJ50e81IaBHjA== X-Received: by 2002:a17:90b:4b48:b0:20a:8ea4:a18d with SMTP id mi8-20020a17090b4b4800b0020a8ea4a18dmr52952876pjb.75.1666289499968; Thu, 20 Oct 2022 11:11:39 -0700 (PDT) Received: from ubuntu-22.. (intel10.cs.nthu.edu.tw. [140.114.89.60]) by smtp.gmail.com with ESMTPSA id e13-20020a17090301cd00b00177c488fea5sm13375546plh.12.2022.10.20.11.11.38 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 20 Oct 2022 11:11:39 -0700 (PDT) To: Lancelot SIX , gdb-patches@sourceware.org Subject: [PATCH v3] [PR python/29603] Disable out-of-scope watchpoints Date: Fri, 21 Oct 2022 02:11:02 +0800 Message-Id: <20221020181101.193226-1-j3.soon777@gmail.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20221020175707.193041-1-j3.soon777@gmail.com> References: <20221020175707.193041-1-j3.soon777@gmail.com> MIME-Version: 1.0 X-Spam-Status: No, score=-10.3 required=5.0 tests=BAYES_00, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, FREEMAIL_ENVFROM_END_DIGIT, FREEMAIL_FROM, GIT_PATCH_0, KAM_SHORT, RCVD_IN_DNSWL_NONE, SPF_HELO_NONE, SPF_PASS, TXREP 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.29 Precedence: list List-Id: Gdb-patches mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-Patchwork-Original-From: Johnson Sun via Gdb-patches From: Johnson Sun Reply-To: Johnson Sun Cc: j3.soon777@gmail.com Errors-To: gdb-patches-bounces+patchwork=sourceware.org@sourceware.org Sender: "Gdb-patches" Currently, when a local software watchpoint goes out of scope, GDB sets the watchpoint's disposition to `delete at next stop' and then normal stops (i.e., stop and wait for the next GDB command). When GDB normal stops, it automatically deletes the breakpoints with their disposition set to `delete at next stop'. Suppose a Python script decides not to normal stop when a local software watchpoint goes out of scope, the watchpoint will not be automatically deleted even when its disposition is set to `delete at next stop'. Since GDB single-steps the program and tests the watched expression after each instruction, not deleting the watchpoint causes the watchpoint to be hit many more times than it should, as reported in PR python/29603. This was happening because the watchpoint is not deleted or disabled when going out of scope. This commit fixes this issue by disabling the watchpoint when going out of scope. It also adds a test to ensure this feature isn't regressed in the future. Two other solutions seem to solve this issue, but are in fact inappropriate: 1. Automatically delete breakpoints on all kinds of stops (in `fetch_inferior_event'). This solution is very slow since the deletion requires O(N) time for N breakpoints. 2. Disable the watchpoint after the watchpoint's disposition is set to `delete at next stop' (in `watchpoint_del_at_next_stop'). This solution modifies a non-extension-related code path, and isn't preferred since this issue cannot occur without extension languages. (gdb scripts always normal stop before continuing execution) Bug: https://sourceware.org/bugzilla/show_bug.cgi?id=29603 --- gdb/breakpoint.c | 2 + gdb/testsuite/gdb.python/py-watchpoint.c | 27 ++++++++++++ gdb/testsuite/gdb.python/py-watchpoint.exp | 48 ++++++++++++++++++++++ gdb/testsuite/gdb.python/py-watchpoint.py | 30 ++++++++++++++ 4 files changed, 107 insertions(+) create mode 100644 gdb/testsuite/gdb.python/py-watchpoint.c create mode 100644 gdb/testsuite/gdb.python/py-watchpoint.exp create mode 100644 gdb/testsuite/gdb.python/py-watchpoint.py diff --git a/gdb/breakpoint.c b/gdb/breakpoint.c index bff3bac7d1a..15f4ae2131c 100644 --- a/gdb/breakpoint.c +++ b/gdb/breakpoint.c @@ -5340,6 +5340,8 @@ bpstat_check_breakpoint_conditions (bpstat *bs, thread_info *thread) /* Evaluate extension language breakpoints that have a "stop" method implemented. */ bs->stop = breakpoint_ext_lang_cond_says_stop (b); + if (b->disposition == disp_del_at_next_stop) + disable_breakpoint(b); if (is_watchpoint (b)) { diff --git a/gdb/testsuite/gdb.python/py-watchpoint.c b/gdb/testsuite/gdb.python/py-watchpoint.c new file mode 100644 index 00000000000..4e1760bb05b --- /dev/null +++ b/gdb/testsuite/gdb.python/py-watchpoint.c @@ -0,0 +1,27 @@ +/* This testcase is part of GDB, the GNU debugger. + + Copyright 2022 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 + +int +main (void) +{ + int i; + for (i = 0; i < 3; i++) + printf ("%d", i); + return 0; +} diff --git a/gdb/testsuite/gdb.python/py-watchpoint.exp b/gdb/testsuite/gdb.python/py-watchpoint.exp new file mode 100644 index 00000000000..ac58d75c523 --- /dev/null +++ b/gdb/testsuite/gdb.python/py-watchpoint.exp @@ -0,0 +1,48 @@ +# Copyright (C) 2022 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 . + +# Check that Watchpoints are deleted after use. + +load_lib gdb-python.exp + +standard_testfile + +if {[prepare_for_testing "failed to prepare" $testfile $srcfile]} { + return -1 +} + +# Skip all tests if Python scripting is not enabled. +if { [skip_python_tests] } { continue } + +if ![runto_main] then { + return 0 +} + +# For remote host testing +set pyfile [gdb_remote_download host ${srcdir}/${subdir}/${testfile}.py] + +gdb_test_no_output "set can-use-hw-watchpoints 0" "Don't use hardware watchpoints" +gdb_test "python print(len(gdb.breakpoints()))" "1" "check default BP count" +gdb_test "source $pyfile" ".*Python script imported.*" \ + "import python scripts" +gdb_test "python print(len(gdb.breakpoints()))" "2" "check modified BP count" +gdb_test_sequence "continue" "run until program stops" { + "Watchpoint Hit: ." + "\[\r\n\]+Watchpoint . deleted because the program has left the block in" + "\[\r\n\]+which its expression is valid\." + "Watchpoint Hit: ." + "\[\r\n\]+012\\[Inferior 1 \\(process .*\\) exited normally\\]" +} +gdb_test "python print(len(gdb.breakpoints()))" "1" "check BP count" diff --git a/gdb/testsuite/gdb.python/py-watchpoint.py b/gdb/testsuite/gdb.python/py-watchpoint.py new file mode 100644 index 00000000000..ce5dee118ad --- /dev/null +++ b/gdb/testsuite/gdb.python/py-watchpoint.py @@ -0,0 +1,30 @@ +# Copyright (C) 2022 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 . + + +class MyBreakpoint(gdb.Breakpoint): + def __init__(self, *args, **kwargs): + gdb.Breakpoint.__init__(self, *args, **kwargs) + self.i = 0 + + def stop(self): + self.i += 1 + print("Watchpoint Hit:", self.i) + return False + + +MyBreakpoint("i", gdb.BP_WATCHPOINT) + +print("Python script imported")