[binutils-gdb] Error when gdb_is_target_1 is called without running gdb instance

[binutils-gdb] Error when gdb_is_target_1 is called without running gdb instance

[Keith Seitz]

https://sourceware.org/git/gitweb.cgi?p=binutils-gdb.git;h=ea764154c27a11619ba764a4c92f395ba5007234

commit ea764154c27a11619ba764a4c92f395ba5007234
Author: Keith Seitz <keiths@redhat.com>
Date:   Mon Feb 28 07:40:23 2022 -0800

    Error when gdb_is_target_1 is called without running gdb instance
    
    This is a snafu that I encountered while implementing the previous
    patch, which attempted to use gdb_is_target_native.  This proc and
    gdb_is_target_remote both rely on gdb_is_target_1, which actually
    cannot be called without gdb already running.
    
    This patch adds appropriate warning comments to these procs and
    causes gdb_is_target_1 to issue a Tcl error if it is called without a
    gdb instance already running.  This should prevent unwitting callers
    from using this at the wrong time.

Diff:
---
 gdb/testsuite/lib/gdb.exp | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/gdb/testsuite/lib/gdb.exp b/gdb/testsuite/lib/gdb.exp
index 0be5b4e6c96..2688a8e0394 100644
--- a/gdb/testsuite/lib/gdb.exp
+++ b/gdb/testsuite/lib/gdb.exp
@@ -3876,8 +3876,17 @@ proc skip_compile_feature_tests {} {
 # is a regexp that will match the output of "maint print target-stack" if
 # the target in question is currently pushed.  PROMPT_REGEXP is a regexp
 # matching the expected prompt after the command output.
+#
+# NOTE: GDB must be running BEFORE this procedure is called!
 
 proc gdb_is_target_1 { target_name target_stack_regexp prompt_regexp } {
+    global gdb_spawn_id
+
+    # Throw a Tcl error if gdb isn't already started.
+    if {![info exists gdb_spawn_id]} {
+	error "gdb_is_target_1 called with no running gdb instance"
+    }
+
     set test "probe for target ${target_name}"
     gdb_test_multiple "maint print target-stack" $test \
 	-prompt "$prompt_regexp" {
@@ -3893,6 +3902,8 @@ proc gdb_is_target_1 { target_name target_stack_regexp prompt_regexp } {
 }
 
 # Helper for gdb_is_target_remote where the expected prompt is variable.
+#
+# NOTE: GDB must be running BEFORE this procedure is called!
 
 proc gdb_is_target_remote_prompt { prompt_regexp } {
     return [gdb_is_target_1 "remote" ".*emote target using gdb-specific protocol.*" $prompt_regexp]
@@ -3900,6 +3911,8 @@ proc gdb_is_target_remote_prompt { prompt_regexp } {
 
 # Check whether we're testing with the remote or extended-remote
 # targets.
+#
+# NOTE: GDB must be running BEFORE this procedure is called!
 
 proc gdb_is_target_remote { } {
     global gdb_prompt
@@ -3908,6 +3921,8 @@ proc gdb_is_target_remote { } {
 }
 
 # Check whether we're testing with the native target.
+#
+# NOTE: GDB must be running BEFORE this procedure is called!
 
 proc gdb_is_target_native { } {
     global gdb_prompt