From patchwork Thu May 11 15:46:20 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Johnson Sun X-Patchwork-Id: 69169 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 C99623856968 for ; Thu, 11 May 2023 15:47:57 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org C99623856968 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sourceware.org; s=default; t=1683820077; bh=DQF44cgxtTbY4Zv1Dd8kohFt/w/PXLz8MgK7YSAq9ZY=; h=To:Cc:Subject:Date:In-Reply-To:References:List-Id: List-Unsubscribe:List-Archive:List-Post:List-Help:List-Subscribe: From:Reply-To:From; b=uUDKkAGeQuVpiJgXCexSL2BAyXLbABZJBeqjrN76WzEnRemP0DwoCSihaQpTeOSOY 9zTlWjkyQxLN0ug+nTnFaCL53B1s3rU9mpEjtMswlHt8nNlgo0O1fiDAiEPSuWDk74 Gijeud8+ssZkn5xgCKtbHJk8gAwu+Bp6xar5OWms= X-Original-To: gdb-patches@sourceware.org Delivered-To: gdb-patches@sourceware.org Received: from mail-pf1-x431.google.com (mail-pf1-x431.google.com [IPv6:2607:f8b0:4864:20::431]) by sourceware.org (Postfix) with ESMTPS id 78A613858C5F for ; Thu, 11 May 2023 15:47:33 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org 78A613858C5F Received: by mail-pf1-x431.google.com with SMTP id d2e1a72fcca58-6436e004954so9061469b3a.0 for ; Thu, 11 May 2023 08:47:33 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1683820052; x=1686412052; 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=DQF44cgxtTbY4Zv1Dd8kohFt/w/PXLz8MgK7YSAq9ZY=; b=U0ehu7oqzB3xpFelKITpj9vFxfvCUkQtcneabe9+gw8OExx1gfhQalylj2gjlv7Bbo RpEM9bN7Ltd7zQ/W1NmFCqCF9dsRg7SGWG4EQtIh7hh4dWhF/f/QFkhYj6tsEy7W1RH9 bnyxamIijMq9JiqDHr8z4ylWOj1ehR93Zc2LNv3gXu6Dh+oddZKs/9l2e90Tv0Ny24tE UHDjEucDNjhUiBW1ZYFwVkCIfbv8TUtA+CoE9Sn4WIdx7bRZoq649TKtamzafSlSIaXo QgENP6LqPny3a2wvVqEl+izNW9yOcjeYayB2iMOVEWQXGN16tzjQkTnyz3OAm4VgJIej zEsw== X-Gm-Message-State: AC+VfDwTn5WiQwibhSkX13jxKbQJ0WaAkQgi9aZpxagrip14Cp+4xkyD eBBT2e++xYauQPXDhMjn6Tk= X-Google-Smtp-Source: ACHHUZ4dvADyYv8941EN6YN/3zaCD/1q8I1s7Bu7eLqiRXGgcJxpXRbgMYdPc3S6yCbSAXEDhQBSLw== X-Received: by 2002:a05:6a20:144d:b0:104:3877:b5a3 with SMTP id a13-20020a056a20144d00b001043877b5a3mr917574pzi.14.1683820052477; Thu, 11 May 2023 08:47:32 -0700 (PDT) Received: from ubuntu.. (intel10.cs.nthu.edu.tw. [140.114.89.60]) by smtp.gmail.com with ESMTPSA id q12-20020a63cc4c000000b0051eff0a70d7sm5111270pgi.94.2023.05.11.08.47.31 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 11 May 2023 08:47:32 -0700 (PDT) To: SimonMarchi , Lancelot SIX , gdb-patches@sourceware.org Cc: j3.soon777@gmail.com Subject: [PATCH v6] [PR python/29603] Disable out-of-scope watchpoints Date: Thu, 11 May 2023 23:46:20 +0800 Message-Id: <20230511154619.23575-1-j3.soon777@gmail.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: References: MIME-Version: 1.0 X-Spam-Status: No, score=-11.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, 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.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 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. Calling `breakpoint_auto_delete' on all kinds of stops (in `fetch_inferior_event') seem to solve this issue, but is in fact inappropriate, since `breakpoint_auto_delete' goes over all breakpoints instead of just going through the bpstat chain (which only contains the breakpoints that were hit right now). Bug: https://sourceware.org/bugzilla/show_bug.cgi?id=29603 --- gdb/breakpoint.c | 1 + gdb/testsuite/gdb.python/py-watchpoint.c | 26 ++++++++++++ gdb/testsuite/gdb.python/py-watchpoint.exp | 46 ++++++++++++++++++++++ gdb/testsuite/gdb.python/py-watchpoint.py | 30 ++++++++++++++ 4 files changed, 103 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 1cc9e84c11f..8f35b7f7951 100644 --- a/gdb/breakpoint.c +++ b/gdb/breakpoint.c @@ -1843,6 +1843,7 @@ watchpoint_del_at_next_stop (struct watchpoint *w) w->related_breakpoint = w; } w->disposition = disp_del_at_next_stop; + disable_breakpoint (w); } /* Extract a bitfield value from value VAL using the bit parameters contained in diff --git a/gdb/testsuite/gdb.python/py-watchpoint.c b/gdb/testsuite/gdb.python/py-watchpoint.c new file mode 100644 index 00000000000..a54f379660b --- /dev/null +++ b/gdb/testsuite/gdb.python/py-watchpoint.c @@ -0,0 +1,26 @@ +/* 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) +{ + volatile int i = -1; + for (i = 0; i < 3; i++); /* main for */ + 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..fd7dbe20eb2 --- /dev/null +++ b/gdb/testsuite/gdb.python/py-watchpoint.exp @@ -0,0 +1,46 @@ +# 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 +} + +require allow_python_tests + +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" +set for_line_no [gdb_get_line_number "main for"] +gdb_test "break $for_line_no" ".*" "set breakpoint before loop" +gdb_test "continue" ".*" "run until reaching loop" +gdb_test "clear" ".*" "delete the breakpoint before loop" +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 "continue" ".*" "run until program stops" +gdb_test "python print(bpt.n)" "5" "check watchpoint hits" +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..647a653085e --- /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): + super().__init__("i", gdb.BP_WATCHPOINT) + self.n = 0 + + def stop(self): + self.n += 1 + print("Watchpoint Hit:", self.n, flush=True) + return False + + +bpt = MyBreakpoint() + +print("Python script imported")