Files
binutils-gdb/gdb/testsuite/gdb.dap/ada-arrays.exp
Tom Tromey 6b9efd5c1a Defer DAP launch command until after configurationDone
PR dap/32090 points out that gdb's DAP "launch" sequencing is
incorrect.  The current approach (which is itself a 2nd
implementation...) was based on a misreading of the spec.  The spec
has since been clarified here:

    https://github.com/microsoft/debug-adapter-protocol/issues/497

The clarification here is that a client is free to send the "launch"
(or "attach") request at any point after the "initialized" event has
been sent by gdb.  However, the "launch" does not cause any action to
be taken -- and does not send a response -- until after
"configurationDone" has been seen.

This patch implements this by arranging for the launch and attach
commands to return a DeferredRequest object.

All the tests needed updates.  I've also added a new test that checks
that the deferred "launch" request can be cancelled.  (Note that the
cancellation is lazy -- it also waits until configurationDone is seen.
This could be fixed, but I was not sure whether it is important to do
so.)

Finally, the "launch" command has a somewhat funny sequencing now.
Simply sending the command and waiting for a response yielded strange
results if the inferior did not stop -- in this case, the repsonse was
never sent.  So now, the command is split into two parts, with some
setup being done synchronously (for better error propagation) and the
actual "run" being done async.

Bug: https://sourceware.org/bugzilla/show_bug.cgi?id=32090
Reviewed-by: Kévin Le Gouguec <legouguec@adacore.com>
2024-12-09 13:52:54 -07:00

129 lines
4.1 KiB
Plaintext

# Copyright 2023-2024 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 <http://www.gnu.org/licenses/>.
load_lib "ada.exp"
load_lib dap-support.exp
require allow_dap_tests
require allow_ada_tests
standard_ada_testfile main
set cfile "cstuff"
set csrcfile ${srcdir}/${subdir}/${testdir}/${cfile}.c
set cobject [standard_output_file ${cfile}.o]
gdb_compile "${csrcfile}" "${cobject}" object [list debug]
if {[gdb_compile_ada "${srcfile}" "${binfile}" executable debug] != ""} {
return -1
}
if {[dap_initialize] == ""} {
return
}
set launch_id [dap_launch $testfile]
# Stop in a C frame, but examine values in an Ada frame, to make sure
# cross-language scenarios work correctly.
set line [gdb_get_line_number "STOP" $testdir/cstuff.c]
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 cstuff.c] $line]]
set line_bpno [dap_get_breakpoint_number $obj]
dap_check_request_and_response "configurationDone" configurationDone
dap_check_response "launch response" launch $launch_id
dap_wait_for_event_and_check "inferior started" thread "body reason" started
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]
# The Ada frame is frame 1.
set frame_id [dict get [lindex [dict get $bt body stackFrames] 1] 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]
gdb_assert {[llength $scopes] == 2} "two scopes"
lassign $scopes scope ignore
gdb_assert {[dict get $scope name] == "Arguments"} "scope is arguments"
gdb_assert {[dict get $scope presentationHint] == "arguments"} \
"arguments presentation hint"
gdb_assert {[dict get $scope namedVariables] == 3} "three vars in scope"
set num [dict get $scope variablesReference]
set refs [lindex [dap_check_request_and_response "fetch arguments" \
"variables" \
[format {o variablesReference [i %d]} $num]] \
0]
# Helper to check the contents of a single array-like object. VAR is
# the variable entry. NAME is the name of the variable, pulled out
# for convenience.# ARGS are the expected child values.
proc check_array_contents {var name args} {
set len [llength $args]
gdb_assert {[dict get $var indexedVariables] == $len} \
"check length of $name variable"
set num [dict get $var variablesReference]
set refs [lindex [dap_check_request_and_response \
"fetch contents of $name" \
"variables" \
[format {o variablesReference [i %d]} $num]] \
0]
foreach subvar [dict get $refs body variables] subvalue $args {
set subname [dict get $subvar name]
gdb_assert {[dict get $subvar value] == $subvalue} \
"check value of $name entry $subname"
}
}
foreach var [dict get $refs body variables] {
set name [dict get $var name]
switch $name {
"the_buffer" {
check_array_contents $var $name 1 2 3 4
}
"the_ar" {
check_array_contents $var $name 5 6 7 8 9
}
"hello" {
# Note that the expected value looks strange here -- there
# are too many backslashes. This is a TON issue, as the
# JSON looks ok: "value": "\"hello\"".
gdb_assert {[dict get $var value] == "\\\"hello\\\""} \
"value of hello variable"
}
default {
fail "unknown variable $name"
}
}
}
dap_shutdown