public inbox for gdb-patches@sourceware.org
 help / color / mirror / Atom feed
From: Tom Tromey <tromey@adacore.com>
To: gdb-patches@sourceware.org
Cc: Tom Tromey <tromey@adacore.com>
Subject: [PATCH] Fix race in DAP startup
Date: Wed, 22 Mar 2023 08:34:18 -0600	[thread overview]
Message-ID: <20230322143418.1914025-1-tromey@adacore.com> (raw)

Internal AdaCore DAP testing on Windows has had occasional failures
that show:

    assert threading.current_thread() is _dap_thread

I think this is a race in DAP startup: the _dap_thread global is only
set on return from start_thread, but it seems possible that the thread
itself could already run and encounter a @in_dap_thread decorator.

This patch fixes the problem by setting the global before running any
of the code in the new thread.  This also lets us remove a FIXME.
---
 gdb/python/lib/gdb/dap/server.py  |  4 +---
 gdb/python/lib/gdb/dap/startup.py | 12 +++++++++---
 2 files changed, 10 insertions(+), 6 deletions(-)

diff --git a/gdb/python/lib/gdb/dap/server.py b/gdb/python/lib/gdb/dap/server.py
index 92b4eee1c5e..ff88282049f 100644
--- a/gdb/python/lib/gdb/dap/server.py
+++ b/gdb/python/lib/gdb/dap/server.py
@@ -100,9 +100,7 @@ class Server:
         log("WROTE: <<<" + json.dumps(obj) + ">>>")
         self.write_queue.put(obj)
 
-    # This must be run in the DAP thread, but we can't use
-    # @in_dap_thread here because the global isn't set until after
-    # this starts running.  FIXME.
+    @in_dap_thread
     def main_loop(self):
         """The main loop of the DAP server."""
         # Before looping, start the thread that writes JSON to the
diff --git a/gdb/python/lib/gdb/dap/startup.py b/gdb/python/lib/gdb/dap/startup.py
index 22246a937ce..aa834cdb14c 100644
--- a/gdb/python/lib/gdb/dap/startup.py
+++ b/gdb/python/lib/gdb/dap/startup.py
@@ -59,14 +59,20 @@ def start_thread(name, target, args=()):
     with blocked_signals():
         result = threading.Thread(target=target, args=args, daemon=True)
         result.start()
-        return result
 
 
 def start_dap(target):
     """Start the DAP thread and invoke TARGET there."""
-    global _dap_thread
     exec_and_log("set breakpoint pending on")
-    _dap_thread = start_thread("DAP", target)
+
+    # Functions in this thread contain assertions that check for this
+    # global, so we must set it before letting these functions run.
+    def really_start_dap():
+        global _dap_thread
+        _dap_thread = threading.current_thread()
+        target()
+
+    start_thread("DAP", really_start_dap)
 
 
 def in_gdb_thread(func):
-- 
2.39.1


             reply	other threads:[~2023-03-22 14:34 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-03-22 14:34 Tom Tromey [this message]
2023-03-23 16:04 ` Tom de Vries
2023-03-24  8:05   ` Tom de Vries
2023-03-24 13:34     ` Tom Tromey

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230322143418.1914025-1-tromey@adacore.com \
    --to=tromey@adacore.com \
    --cc=gdb-patches@sourceware.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).