From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-il1-x12b.google.com (mail-il1-x12b.google.com [IPv6:2607:f8b0:4864:20::12b]) by sourceware.org (Postfix) with ESMTPS id 8FD2E3858C30 for ; Mon, 12 Jun 2023 19:36:35 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org 8FD2E3858C30 Authentication-Results: sourceware.org; dmarc=pass (p=none dis=none) header.from=adacore.com Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=adacore.com Received: by mail-il1-x12b.google.com with SMTP id e9e14a558f8ab-34057f5c089so1713175ab.2 for ; Mon, 12 Jun 2023 12:36:35 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=adacore.com; s=google; t=1686598595; x=1689190595; h=to:in-reply-to:references:message-id:content-transfer-encoding :mime-version:subject:date:from:from:to:cc:subject:date:message-id :reply-to; bh=er4s5nL9OZh5NvZCqRZbR4sFZk9rTKZ+VaFE2Gd+2Ec=; b=kYy20Bhr7ENAwli0RRJ9vrOlnuEKbqh6OVxpVvb6DCTHGwD0w6VKDxQ5Q1ybjnFqNE vDtSegQ566TDbCBEZfE8W2//DMiI8VOgIUt/pRVlSWqNwrP5UX0m6kV2Sq0RtjB/VOnl z3qx3uQRjp0oZV/+HhJ65RXuL3FyRd53mllUYlSDA3Xo+mXQcH03mqRf7v2Tg89oLIvN LORGSDasI7l59Ijj0k2lQEQT1fsQB2rH19I0sxkAoM7Y27k+hintUa7otIhmNBQOqvpp jbXgEOMTqktepr7IqkpctfOxgPbsRHXzXD7/nYOaGbu2Yy2apKNhraClO36yZHikQdeI 7ySA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1686598595; x=1689190595; h=to:in-reply-to:references:message-id:content-transfer-encoding :mime-version:subject:date:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=er4s5nL9OZh5NvZCqRZbR4sFZk9rTKZ+VaFE2Gd+2Ec=; b=ONf897E1FWXbiUEO0uKLymJyA1li0CDu6R56wJPpWCiLMdlSPrjJVIUgUsUJTTg0FZ J4PqqwCQgYPZq9RSu98U2KaKJntg/7QGHmE3hc+WNL85gHY505toVXaTJdlMHg5QtmeO XKedNRKQL7ITNAlAX395FB2BDgfVRfJbYdnXgtqT29w6zBgKUX99UkLpoo/EMqlCOj7r OI2X1DkPBeW40eOGtjN7r/V9d/z/aG6aUqkb+SHW+YoTu2KPSF9ut+7hObeb9WptY+2Y sgmoXXUwGX7l9YvonwTwQX0b+B9igbpH0NhBWKIKsok0MdTOoqTOHfJsh7QTZh6sykge y01g== X-Gm-Message-State: AC+VfDzI6PZHVbiXsu4PbXdK0OehzIUsyVo8h5J2xSDdb4MmOMs3A+0V oHcA01/gw4GgIGMhCqMe2wkxsjR0dsjKPXwIQ5RYag== X-Google-Smtp-Source: ACHHUZ6YviROZtn1fvaVZZzBXQ0SG03quOsvX9ZDM0EK4PnyrGi6hbDyYC/ZLzoDXJlr5/0xNalvLA== X-Received: by 2002:a92:d4c7:0:b0:33d:6988:bfea with SMTP id o7-20020a92d4c7000000b0033d6988bfeamr7704597ilm.21.1686598594681; Mon, 12 Jun 2023 12:36:34 -0700 (PDT) Received: from localhost.localdomain (75-166-136-83.hlrn.qwest.net. [75.166.136.83]) by smtp.gmail.com with ESMTPSA id m12-20020a056638224c00b00418a5e0e93esm2938091jas.162.2023.06.12.12.36.34 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 12 Jun 2023 12:36:34 -0700 (PDT) From: Tom Tromey Date: Mon, 12 Jun 2023 13:36:34 -0600 Subject: [PATCH 7/7] Implement DAP "hover" context MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 7bit Message-Id: <20230612-more-dap-v1-7-ad868f1a4cc0@adacore.com> References: <20230612-more-dap-v1-0-ad868f1a4cc0@adacore.com> In-Reply-To: <20230612-more-dap-v1-0-ad868f1a4cc0@adacore.com> To: gdb-patches@sourceware.org X-Mailer: b4 0.12.2 X-Spam-Status: No, score=-11.3 required=5.0 tests=BAYES_00,DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,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: A DAP client can request that an expression be evaluated in "hover" context, meaning that it should not cause side effects. In gdb, this can be implemented by temporarily setting a few "may-" parameters to "off". In order to make this work, I had to also change "may-write-registers" so that it can be changed while the program is running. I don't think there was any reason for this prohibition in the first place. Bug: https://sourceware.org/bugzilla/show_bug.cgi?id=30476 --- gdb/python/lib/gdb/dap/evaluate.py | 13 +++++++ gdb/target.c | 12 +++---- gdb/testsuite/gdb.dap/hover.c | 30 ++++++++++++++++ gdb/testsuite/gdb.dap/hover.exp | 70 ++++++++++++++++++++++++++++++++++++++ 4 files changed, 119 insertions(+), 6 deletions(-) diff --git a/gdb/python/lib/gdb/dap/evaluate.py b/gdb/python/lib/gdb/dap/evaluate.py index a0b199a1ed4..651a4046a34 100644 --- a/gdb/python/lib/gdb/dap/evaluate.py +++ b/gdb/python/lib/gdb/dap/evaluate.py @@ -43,6 +43,16 @@ def _evaluate(expr, frame_id): return ref.to_object() +# Like _evaluate but ensure that the expression cannot cause side +# effects. +@in_gdb_thread +def _eval_for_hover(expr, frame_id): + with gdb.with_parameter("may-write-registers", "off"): + with gdb.with_parameter("may-write-memory", "off"): + with gdb.with_parameter("may-call-functions", "off"): + return _evaluate(expr, frame_id) + + # Helper function to perform an assignment. @in_gdb_thread def _set_expression(expression, value, frame_id): @@ -71,6 +81,7 @@ def _repl(command, frame_id): @request("evaluate") +@capability("supportsEvaluateForHovers") def eval_request( *, expression: str, @@ -81,6 +92,8 @@ def eval_request( if context in ("watch", "variables"): # These seem to be expression-like. return send_gdb_with_response(lambda: _evaluate(expression, frameId)) + elif context == "hover": + return send_gdb_with_response(lambda: _eval_for_hover(expression, frameId)) elif context == "repl": return send_gdb_with_response(lambda: _repl(expression, frameId)) else: diff --git a/gdb/target.c b/gdb/target.c index 80d2c80d4bf..fecbc89d3ca 100644 --- a/gdb/target.c +++ b/gdb/target.c @@ -4494,7 +4494,6 @@ set_target_permissions (const char *args, int from_tty, } /* Make the real values match the user-changed values. */ - may_write_registers = may_write_registers_1; may_insert_breakpoints = may_insert_breakpoints_1; may_insert_tracepoints = may_insert_tracepoints_1; may_insert_fast_tracepoints = may_insert_fast_tracepoints_1; @@ -4502,14 +4501,15 @@ set_target_permissions (const char *args, int from_tty, update_observer_mode (); } -/* Set memory write permission independently of observer mode. */ +/* Set some permissions independently of observer mode. */ static void -set_write_memory_permission (const char *args, int from_tty, - struct cmd_list_element *c) +set_write_memory_registers_permission (const char *args, int from_tty, + struct cmd_list_element *c) { /* Make the real values match the user-changed values. */ may_write_memory = may_write_memory_1; + may_write_registers = may_write_registers_1; update_observer_mode (); } @@ -4578,7 +4578,7 @@ Set permission to write into registers."), _("\ Show permission to write into registers."), _("\ When this permission is on, GDB may write into the target's registers.\n\ Otherwise, any sort of write attempt will result in an error."), - set_target_permissions, NULL, + set_write_memory_registers_permission, NULL, &setlist, &showlist); add_setshow_boolean_cmd ("may-write-memory", class_support, @@ -4587,7 +4587,7 @@ Set permission to write into target memory."), _("\ Show permission to write into target memory."), _("\ When this permission is on, GDB may write into the target's memory.\n\ Otherwise, any sort of write attempt will result in an error."), - set_write_memory_permission, NULL, + set_write_memory_registers_permission, NULL, &setlist, &showlist); add_setshow_boolean_cmd ("may-insert-breakpoints", class_support, diff --git a/gdb/testsuite/gdb.dap/hover.c b/gdb/testsuite/gdb.dap/hover.c new file mode 100644 index 00000000000..f85339612cd --- /dev/null +++ b/gdb/testsuite/gdb.dap/hover.c @@ -0,0 +1,30 @@ +/* Copyright 2023 Free Software Foundation, Inc. + + This file is part of GDB. + + 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_variable = 23; + +int +increment () +{ + return ++global_variable; +} + +int +main () +{ + return 0; /* BREAK */ +} diff --git a/gdb/testsuite/gdb.dap/hover.exp b/gdb/testsuite/gdb.dap/hover.exp new file mode 100644 index 00000000000..4caf105b347 --- /dev/null +++ b/gdb/testsuite/gdb.dap/hover.exp @@ -0,0 +1,70 @@ +# 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 . + +# Test DAP "hover" evaluation. + +require allow_dap_tests + +load_lib dap-support.exp + +standard_testfile + +if {[build_executable ${testfile}.exp $testfile] == -1} { + return +} + +if {[dap_launch $testfile] == ""} { + return +} + +set line [gdb_get_line_number "BREAK"] +set obj [dap_check_request_and_response "set breakpoint by line number" \ + setBreakpoints \ + [format {o source [o path [%s]] breakpoints [a [o line [i %d]]]} \ + [list s $srcfile] $line]] +set line_bpno [dap_get_breakpoint_number $obj] + +dap_check_request_and_response "start inferior" configurationDone +dap_wait_for_event_and_check "inferior started" thread "body reason" started + +dap_wait_for_event_and_check "stopped at breakpoint" stopped \ + "body reason" breakpoint \ + "body hitBreakpointIds" $line_bpno + +set obj [dap_check_request_and_response "evaluate global" \ + evaluate {o expression [s global_variable]}] +dap_match_values "global value in function" [lindex $obj 0] \ + "body result" 23 + +set obj [dap_request_and_response \ + evaluate {o context [s hover] expression [s increment()]}] +gdb_assert {[dict get [lindex $obj 0] success] == "false"} \ + "increment was rejected in hover mode" + +dap_check_request_and_response "call increment" \ + evaluate {o expression [s increment()]} + +set obj [dap_request_and_response \ + evaluate {o context [s hover] \ + expression [s "global_variable = -1"]}] +gdb_assert {[dict get [lindex $obj 0] success] == "false"} \ + "assignment was rejected in hover mode" + +set obj [dap_check_request_and_response "evaluate global again" \ + evaluate {o expression [s global_variable]}] +dap_match_values "global value incremented once" [lindex $obj 0] \ + "body result" 24 + +dap_shutdown -- 2.40.1