From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-pf1-x436.google.com (mail-pf1-x436.google.com [IPv6:2607:f8b0:4864:20::436]) by sourceware.org (Postfix) with ESMTPS id 97C623858C50 for ; Sun, 23 Apr 2023 09:55:19 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org 97C623858C50 Authentication-Results: sourceware.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=gmail.com Received: by mail-pf1-x436.google.com with SMTP id d2e1a72fcca58-63b4e5fdb1eso4431839b3a.1 for ; Sun, 23 Apr 2023 02:55:19 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1682243718; x=1684835718; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=/FmBLXkKrJvmzzYoBDkBRcbf1OITxEV11BlI9V25EKY=; b=HKoKv4FZtiyzyvQSwWQhsHgws2NlbEZB4ZQ/qyfyEjU7FmZyYBEgnLfQfhW+iln+Eu 14MCX80DTKpJZqQOO+BZixmLHYLlQSLNNUnn7c9yIv/Erd1cUOJUZS4My5SiaKkhdeTW cUlt8lvamqGyhFvp5ta1T00pvuwXWMJx94cyf2FNhFpxqXKeisITBdAFAccNyUznCADD KowZcCt4xHeqUVfcfdXO5XlJ21YoWc4jWXmItjnn4420KpGJhkJq+aRb2DwfRdVlb0zW n/w1dFkdl+IiuY3g2yJqjZKYY0ANbBxZUspquQHqL0pCmcoIq9SW2CeTF2jVCPQyptyj 5vcg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1682243718; x=1684835718; 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=/FmBLXkKrJvmzzYoBDkBRcbf1OITxEV11BlI9V25EKY=; b=UA+ICuCodDy6YUoDIrVR9md3xhoeYL91pqg0C2mGWoAAnrqK5fHauQ4SFtMrNqZlfC CrSoQu9dmXEWbQRLSZFr/DIFYb+Df49HZ5BcUDlpBBG2fUuzuZ36hH4IPGDwdYjf3js1 9/i35WDdkVP6F0tHMf7lrBpJQ65BAJKXKWan9Gly59iMItPGN3FUx8I2vKYap3oz/vph ammxOFB3Wma3xAkF1X6fZ+5MOwdHrtmrFwPTf+j7hC/mWwuXd6fFNMhkOneIKgz1UoyF CjU72L7LSCZebkM1OdN6HVBZF+QK/suTFg9E7elQ9JmZn6wu9J1G2E91vV8jTNecPD7D uKTA== X-Gm-Message-State: AAQBX9eCJTgE0FJAJY/SJE3SYgZms94xmhdJeDemzx8nSDLiApdNfUWi UVtqIWi+fm85DTYG5HQMMTA1eqYINu5LGN7f X-Google-Smtp-Source: AKy350ZZ1Jxfq4moxWwe05mRHcD4AY5HeGXdo4QtKAhGwu6eqM9kaop63b6OwgmM6IzhKmKNSBwl0A== X-Received: by 2002:a05:6a21:6d84:b0:ee:84a2:4ad0 with SMTP id wl4-20020a056a216d8400b000ee84a24ad0mr14296410pzb.22.1682243718580; Sun, 23 Apr 2023 02:55:18 -0700 (PDT) Received: from ubuntu.. (intel10.cs.nthu.edu.tw. [140.114.89.60]) by smtp.gmail.com with ESMTPSA id a15-20020a65640f000000b0051afa49e07asm4868242pgv.50.2023.04.23.02.55.17 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 23 Apr 2023 02:55:18 -0700 (PDT) From: Johnson Sun To: SimonMarchi , Lancelot SIX , gdb-patches@sourceware.org Cc: j3.soon777@gmail.com Subject: [PATCH v5] [PR python/29603] Disable out-of-scope watchpoints Date: Sun, 23 Apr 2023 17:54:09 +0800 Message-Id: <20230423095408.7638-1-j3.soon777@gmail.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <1b60c407-1406-ed3c-7d64-a79c786ae9b7@gmail.com> References: <1b60c407-1406-ed3c-7d64-a79c786ae9b7@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit 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 List-Id: 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 | 27 +++++++++++++ gdb/testsuite/gdb.python/py-watchpoint.exp | 46 ++++++++++++++++++++++ gdb/testsuite/gdb.python/py-watchpoint.py | 30 ++++++++++++++ 4 files changed, 104 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 bff3bac7d1..47dcf1e127 100644 --- a/gdb/breakpoint.c +++ b/gdb/breakpoint.c @@ -1832,6 +1832,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 0000000000..2eeae55021 --- /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 = -1; + for (i = 0; i < 3; i++) /* main for */ + printf ("i = %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 0000000000..fd7dbe20eb --- /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 0000000000..647a653085 --- /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") -- 2.34.1 base-commit: c99b2113a478a075e8d8f7c3848a92f1ce73f847