From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-il1-x133.google.com (mail-il1-x133.google.com [IPv6:2607:f8b0:4864:20::133]) by sourceware.org (Postfix) with ESMTPS id F01503858426 for ; Fri, 6 Oct 2023 13:44:20 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org F01503858426 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-x133.google.com with SMTP id e9e14a558f8ab-352753fb42eso9343355ab.1 for ; Fri, 06 Oct 2023 06:44:20 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=adacore.com; s=google; t=1696599860; x=1697204660; darn=sourceware.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=GtClz8g+9Em2WC9VRuIltbZegxLr2TVg13eg2Q1TWXY=; b=T5u5pGHYPLDPkLBQH+Jh0Lr5MK3Fg89aKw/ZDN2Z0qWeEBhxb17LXtOzxNnXDHB7mX NeD1wHiWUYk0iMGCAzhIKiiKzDzkD4z+TRmZcGuXxlRsuca86zsieRw9eP7w3gU/lbWg LXwpdmq7A0jBStlWxV9v/1xtdzIHj9qCsaoZJbRIZ0U7BZ/qqVVRNzK5fj04iLFjHVMW NaDQaov4UTbztqbTmpDwCdaSjxS3EIV2kycovI2YC0QQ5kdiBSxbkcLjyI4HJXBugGoy Ow9eJpgzevqTfc/Af+Gwon3wLKiq2LX8WBdTOv53c1HGP7DgyF+JZKPSOzwrj5eYXuvR YeMA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1696599860; x=1697204660; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=GtClz8g+9Em2WC9VRuIltbZegxLr2TVg13eg2Q1TWXY=; b=M6uPOKtj9N52Qq72pNhQtvLjvp//pzhDb9xeoX7WwRMX5Rpe0zzK7LLhbhSgMwk9Ge 1EvA/FNBR1HMKPsEfNp2bCIlaFrZW1fPVPUc1nuUfp9wzhqJ60uVdBu8XYIS3N5eHfhS lJwJSJqLakpT6vQ7sy0+D2u48UXxS23bQ5/ox/2Kx2UM2Q0PU+bxtJ09enZaa4S7JIR7 yyBtBwylPrC573z8x0glfzipMSxYrqouO5Jav1jw0UMcYVEm39Qi0YDYAFvyB+EPYGvy py/+1t/bcdJl3Ejs5Nn6H1Z0bqG0PTCUdkUfNAA6pD7xfVgNdCiCF5DG2vxdDkUpVstz Hrhw== X-Gm-Message-State: AOJu0YyrtbD3uaXbsxlAJn4hJeKJjz8qRPyFucDO3z02ZF/yhKdAkou7 on0PlwWcPoawl8cBCkdHlhJZc+t9zdqZgVQ5rE/13g== X-Google-Smtp-Source: AGHT+IGpej3WVD/fSNGlMlqchvxJKR96iYfK5BoRYntV8jLdoFR2yg7sWtoshjs9dzKAiy9FOZtpCQ== X-Received: by 2002:a05:6e02:930:b0:351:2288:e132 with SMTP id o16-20020a056e02093000b003512288e132mr7279772ilt.21.1696599860069; Fri, 06 Oct 2023 06:44:20 -0700 (PDT) Received: from localhost.localdomain (71-211-130-31.hlrn.qwest.net. [71.211.130.31]) by smtp.gmail.com with ESMTPSA id p2-20020a02b882000000b0043cb3818dffsm414304jam.3.2023.10.06.06.44.19 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 06 Oct 2023 06:44:19 -0700 (PDT) From: Tom Tromey To: gdb-patches@sourceware.org Cc: Tom Tromey Subject: [PATCH] Have DAP handle non-Value results from 'children' Date: Fri, 6 Oct 2023 07:44:13 -0600 Message-Id: <20231006134413.2655181-1-tromey@adacore.com> X-Mailer: git-send-email 2.40.1 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Spam-Status: No, score=-11.5 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 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 pretty-printer's 'children' method may return values other than a gdb.Value -- it may return any value that can be converted to a gdb.Value. I noticed that this case did not work for DAP. This patch fixes the problem. --- gdb/python/lib/gdb/dap/varref.py | 9 ++- gdb/testsuite/gdb.dap/children.exp | 118 +++++++++++++++++++++++++++++ gdb/testsuite/gdb.dap/children.py | 41 ++++++++++ 3 files changed, 166 insertions(+), 2 deletions(-) create mode 100644 gdb/testsuite/gdb.dap/children.exp create mode 100644 gdb/testsuite/gdb.dap/children.py diff --git a/gdb/python/lib/gdb/dap/varref.py b/gdb/python/lib/gdb/dap/varref.py index 95f00f5fe06..5dfe6e0edb9 100644 --- a/gdb/python/lib/gdb/dap/varref.py +++ b/gdb/python/lib/gdb/dap/varref.py @@ -199,9 +199,14 @@ class VariableReference(BaseReference): if isinstance(self.printer, gdb.ValuePrinter) and hasattr( self.printer, "child" ): - return self.printer.child(idx) + (name, val) = self.printer.child(idx) else: - return self.cache_children()[idx] + (name, val) = self.cache_children()[idx] + # A pretty-printer can return something other than a + # gdb.Value, but it must be convertible. + if not isinstance(val, gdb.Value): + val = gdb.Value(val) + return (name, val) @in_gdb_thread diff --git a/gdb/testsuite/gdb.dap/children.exp b/gdb/testsuite/gdb.dap/children.exp new file mode 100644 index 00000000000..1ff7cd17f26 --- /dev/null +++ b/gdb/testsuite/gdb.dap/children.exp @@ -0,0 +1,118 @@ +# 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 the handling of non-Value responses from 'children' method. + +require allow_dap_tests + +load_lib dap-support.exp + +standard_testfile lazy-string.c + +if {[build_executable ${testfile}.exp $testfile $srcfile] == -1} { + return +} + +set remote_python_file [gdb_remote_download host \ + ${srcdir}/${subdir}/${testfile}.py] + +save_vars GDBFLAGS { + append GDBFLAGS " -iex \"source $remote_python_file\"" + + if {[dap_launch $testfile] == ""} { + return + } +} + +set line [gdb_get_line_number "STOP"] +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 "stopped at line breakpoint" stopped \ + "body reason" breakpoint \ + "body hitBreakpointIds" $line_bpno + +set bt [lindex [dap_check_request_and_response "backtrace" stackTrace \ + {o threadId [i 1]}] \ + 0] +set frame_id [dict get [lindex [dict get $bt body stackFrames] 0] id] + +set scopes [dap_check_request_and_response "get scopes" scopes \ + [format {o frameId [i %d]} $frame_id]] +set scopes [dict get [lindex $scopes 0] body scopes] + +lassign $scopes scope reg_scope +gdb_assert {[dict get $scope name] == "Locals"} "scope is locals" +gdb_assert {[dict get $scope namedVariables] == 1} "one var in scope" + +set num [dict get $scope variablesReference] +set refs [lindex [dap_check_request_and_response "fetch variable" \ + "variables" \ + [format {o variablesReference [i %d] count [i 1]} \ + $num]] \ + 0] + +set vars [dict get $refs body variables] +gdb_assert {[llength $vars] == 1} "just one variable" + +set var [lindex $vars 0] +gdb_assert {[dict get $var name] == "the_string"} "variable name" +gdb_assert {[dict get $var value] == "contents"} "variable value" +gdb_assert {[dict get $var namedVariables] == 2} "variable has two children" + +set num [dict get $var variablesReference] +set refs [lindex [dap_check_request_and_response "fetch children of variable" \ + "variables" \ + [format {o variablesReference [i %d] count [i 2]} \ + $num]] \ + 0] + +set vars [dict get $refs body variables] +gdb_assert {[llength $vars] == 2} "got two children of variable" + +set saw_first 0 +set saw_second 0 +foreach var [dict get $refs body variables] { + set name [dict get $var name] + switch $name { + "first" { + gdb_assert {[dict get $var value] == 23} "value of first" + incr saw_first + } + + "second" { + # The result looks strange here, but only because TON does + # not handle the backslash-quote sequence properly when + # decoding the JSON. The actual JSON is: "value": + # "\"DEI\"". + gdb_assert {[dict get $var value] == "\\\"DEI\\\""} \ + "value of second" + incr saw_second + } + + default { + fail "unknown variable $name" + } + } +} + +gdb_assert {$saw_first == 1 && $saw_second == 1} "saw both children" + +dap_shutdown diff --git a/gdb/testsuite/gdb.dap/children.py b/gdb/testsuite/gdb.dap/children.py new file mode 100644 index 00000000000..19fa5dc7513 --- /dev/null +++ b/gdb/testsuite/gdb.dap/children.py @@ -0,0 +1,41 @@ +# Copyright (C) 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 . + + +import gdb + + +class Printer(gdb.ValuePrinter): + """Pretty print test class.""" + + def __init__(self, val): + self._val = val + + def to_string(self): + return "contents" + + def children(self): + yield "first", 23 + yield "second", "DEI" + + +def lookup_function(val): + typ = val.type + if typ.code == gdb.TYPE_CODE_PTR: + return Printer(val) + return None + + +gdb.pretty_printers.append(lookup_function) -- 2.40.1