[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[RFC PATCH 4/7] xeniface: Reference-count event channel contexts


  • To: win-pv-devel@xxxxxxxxxxxxxxxxxxxx
  • From: Rafał Wojdyła <omeg@xxxxxxxxxxxxxxxxxxxxxx>
  • Date: Tue, 10 Nov 2026 19:34:51 +0100
  • Authentication-results: eu.smtp.expurgate.cloud; dkim=pass header.s=fm3 header.d=invisiblethingslab.com header.i="@invisiblethingslab.com" header.h="Cc:Content-Transfer-Encoding:Content-Type:Date:From:In-Reply-To:Message-ID:MIME-Version:References:Subject:To"; dkim=pass header.s=fm3 header.d=messagingengine.com header.i="@messagingengine.com" header.h="Cc:Content-Transfer-Encoding:Content-Type:Date:Feedback-ID:From:In-Reply-To:Message-ID:MIME-Version:References:Subject:To:X-ME-Proxy:X-ME-Sender"
  • Cc: Rafał Wojdyła <omeg@xxxxxxx>, Rafał Wojdyła <omeg@xxxxxxxxxxxxxxxxxxxxxx>
  • Delivery-date: Tue, 10 Nov 2026 18:36:09 +0000
  • Dkim2-signature: i=1; m=1; t=1794335766; d=invisiblethingslab.com; mf=PG9tZWdAaW52aXNpYmxldGhpbmdzbGFiLmNvbT4=; rt=PHdpbi1wdi1kZXZlbEBsaXN0cy54ZW5wcm9qZWN0Lm9yZz4=; s=fm3:rsa-sha256:R3F/kavh7xdIfzFalPumOMLI9HU/bN0J2cJus8ICTB/dMv9 +UCoEcbrmIxRGnq6N1JKWHumnhAtL3vKsFhwlQM+6KrAQK8tl3zGyEmOoUA+Agnj 1ZkC8HfkWgjnJGb7CTtYd1PVq9JobxTsafe+x0YNUmzRqpLIxeCQ2YloOm8XNCjZ Wwjc4habTNtKmNtyMN3WzEbuqTVxQ7c8NUem8FAIK+YZYNlIkpaOtQIQXCY3cZbA yIiBItO8/NHT7v/fyfEgmowR+Cbbv8yOG0xnleKkmzPr4CjQ1Jfhb0XuPAql31+U /eR7vsZ4fRtfUhArmxiC8gkZeB3uVesZv8w8M2A==;
  • Feedback-id: i409c4082:Fastmail
  • List-id: Developer list for the Windows PV Drivers subproject <win-pv-devel.lists.xenproject.org>
  • Message-instance: m=1; h=sha256:nv+5iq8wKZfXYAr9DHPbyilGysENkZgNTDKR4ZUDIhI=:aEGE1W26l8pRlNoxUB06+4XbQaKbhmta1fGc/36eojQ=;

From: Rafał Wojdyła <omeg@xxxxxxx>

Separate removal from user lookup from destruction of an event channel.
Keep its provider channel, DPC context and referenced event alive until the
last reference is released at PASSIVE_LEVEL.

Add helpers to retain the original channel and send through that reference.
Serialize registration checks and sends with close, raising IRQL while
accessing the provider channel.

Assisted-by: LLM
Signed-off-by: Rafał Wojdyła <omeg@xxxxxxxxxxxxxxxxxxxxxx>
---
 src/xeniface/ioctl_evtchn.c | 60 +++++++++++++++++++++++++++++++++++--
 src/xeniface/ioctls.c       |  6 ++--
 src/xeniface/ioctls.h       | 22 +++++++++++++-
 3 files changed, 82 insertions(+), 6 deletions(-)

diff --git a/src/xeniface/ioctl_evtchn.c b/src/xeniface/ioctl_evtchn.c
index d5ef353..03369c0 100644
--- a/src/xeniface/ioctl_evtchn.c
+++ b/src/xeniface/ioctl_evtchn.c
@@ -94,7 +94,7 @@ EvtchnInterruptHandler(
 
 _IRQL_requires_(PASSIVE_LEVEL) // needed for KeFlushQueuedDpcs
 VOID
-EvtchnFree(
+EvtchnDereference(
     _In_ PXENIFACE_FDO                  Fdo,
     _Inout_ PXENIFACE_EVTCHN_CONTEXT    Context
     )
@@ -102,6 +102,10 @@ EvtchnFree(
     PXENBUS_EVTCHN_CHANNEL              Channel;
 
     ASSERT(KeGetCurrentIrql() == PASSIVE_LEVEL);
+    ASSERT(Context->References > 0);
+    // Destroy the channel only after all references are gone.
+    if (InterlockedDecrement(&Context->References) != 0)
+        return;
 
     Trace("Context %p, LocalPort %d, FO %p\n",
                        Context, Context->LocalPort, Context->FileObject);
@@ -186,6 +190,7 @@ IoctlEvtchnBindUnbound(
 
     Context->FileObject = FileObject;
     Context->Fdo = Fdo;
+    Context->References = 1;
 
     Trace("> RemoteDomain %d, Mask %d, FO %p\n",
                        In->RemoteDomain, In->Mask, FileObject);
@@ -281,6 +286,7 @@ IoctlEvtchnBindInterdomain(
 
     Context->FileObject = FileObject;
     Context->Fdo = Fdo;
+    Context->References = 1;
 
     Trace("> RemoteDomain %d, RemotePort %lu, Mask %d, FO %p\n",
                        In->RemoteDomain, In->RemotePort, In->Mask, FileObject);
@@ -379,7 +385,7 @@ IoctlEvtchnClose(
 
     RemoveEntryList(&Context->Entry);
     KeReleaseSpinLock(&Fdo->EvtchnLock, Irql);
-    EvtchnFree(Fdo, Context);
+    EvtchnDereference(Fdo, Context);
 
     return STATUS_SUCCESS;
 
@@ -392,6 +398,56 @@ fail1:
     return status;
 }
 
+// Retain the channel and its DPC/event independently of the owning file.
+// The caller releases its reference with EvtchnDereference at PASSIVE_LEVEL.
+_Requires_lock_not_held_(Fdo->EvtchnLock)
+_IRQL_requires_max_(DISPATCH_LEVEL)
+_Ret_maybenull_
+PXENIFACE_EVTCHN_CONTEXT
+EvtchnReference(
+    _In_ PXENIFACE_FDO       Fdo,
+    _In_ ULONG               LocalPort,
+    _In_opt_ PFILE_OBJECT    FileObject
+    )
+{
+    PXENIFACE_EVTCHN_CONTEXT Context;
+    KIRQL Irql;
+
+    KeAcquireSpinLock(&Fdo->EvtchnLock, &Irql);
+    Context = EvtchnFindChannel(Fdo, LocalPort, FileObject);
+    if (Context != NULL)
+        InterlockedIncrement(&Context->References);
+    KeReleaseSpinLock(&Fdo->EvtchnLock, Irql);
+    return Context;
+}
+
+// The caller must hold a reference.
+// ActiveOnly also requires the original context to remain registered.
+_Requires_lock_not_held_(Fdo->EvtchnLock)
+_IRQL_requires_max_(DISPATCH_LEVEL)
+NTSTATUS
+EvtchnSend(
+    _In_ PXENIFACE_FDO             Fdo,
+    _In_ PXENIFACE_EVTCHN_CONTEXT  Context,
+    _In_ BOOLEAN                   ActiveOnly
+    )
+{
+    NTSTATUS Status = STATUS_NOT_FOUND;
+    KIRQL Irql;
+
+    ASSERT(Context->References > 0);
+    ASSERT(Context->Channel != NULL);
+    // Keep the registration check and send atomic with close. The spin lock
+    // also raises IRQL to exclude suspend while Xenbus accesses the channel.
+    KeAcquireSpinLock(&Fdo->EvtchnLock, &Irql);
+    if (!ActiveOnly || EvtchnFindChannel(Fdo, Context->LocalPort, NULL) == 
Context) {
+        XENBUS_EVTCHN(Send, &Fdo->EvtchnInterface, Context->Channel);
+        Status = STATUS_SUCCESS;
+    }
+    KeReleaseSpinLock(&Fdo->EvtchnLock, Irql);
+    return Status;
+}
+
 _Requires_lock_not_held_(Fdo->EvtchnLock)
 DECLSPEC_NOINLINE
 NTSTATUS
diff --git a/src/xeniface/ioctls.c b/src/xeniface/ioctls.c
index 3d55d5a..9a054ae 100644
--- a/src/xeniface/ioctls.c
+++ b/src/xeniface/ioctls.c
@@ -151,7 +151,7 @@ fail1:
 }
 
 // Cleanup store watches and event channels, called on file object close.
-_IRQL_requires_(PASSIVE_LEVEL) // EvtchnFree calls KeFlushQueuedDpcs
+_IRQL_requires_(PASSIVE_LEVEL) // EvtchnDereference calls KeFlushQueuedDpcs
 VOID
 XenIfaceCleanup(
     _In_ PXENIFACE_FDO          Fdo,
@@ -207,7 +207,7 @@ XenIfaceCleanup(
 
         Trace("Evtchn context %p\n", EvtchnContext);
         RemoveEntryList(&EvtchnContext->Entry);
-        // EvtchnFree requires PASSIVE_LEVEL and we're inside a lock
+        // EvtchnDereference requires PASSIVE_LEVEL and we're inside a lock
         InsertTailList(&ToFree, &EvtchnContext->Entry);
     }
     KeReleaseSpinLock(&Fdo->EvtchnLock, Irql);
@@ -218,7 +218,7 @@ XenIfaceCleanup(
         Node = Node->Flink;
 
         RemoveEntryList(&EvtchnContext->Entry);
-        EvtchnFree(Fdo, EvtchnContext);
+        EvtchnDereference(Fdo, EvtchnContext);
     }
      
     // suspend events
diff --git a/src/xeniface/ioctls.h b/src/xeniface/ioctls.h
index 59e186f..a3a1339 100644
--- a/src/xeniface/ioctls.h
+++ b/src/xeniface/ioctls.h
@@ -49,6 +49,7 @@ typedef struct _XENIFACE_EVTCHN_CONTEXT {
     LIST_ENTRY             Entry;
     PXENBUS_EVTCHN_CHANNEL Channel;
     ULONG                  LocalPort;
+    LONG                   References; // channel is kept alive until this 
reaches zero
     PKEVENT                Event;
     PXENIFACE_FDO          Fdo;
     KDPC                   Dpc;
@@ -252,6 +253,25 @@ EvtchnNotify(
     _In_opt_ PFILE_OBJECT   FileObject
     );
 
+_Requires_lock_not_held_(Fdo->EvtchnLock)
+_IRQL_requires_max_(DISPATCH_LEVEL)
+_Ret_maybenull_
+PXENIFACE_EVTCHN_CONTEXT
+EvtchnReference(
+    _In_ PXENIFACE_FDO      Fdo,
+    _In_ ULONG              LocalPort,
+    _In_opt_ PFILE_OBJECT   FileObject
+    );
+
+_Requires_lock_not_held_(Fdo->EvtchnLock)
+_IRQL_requires_max_(DISPATCH_LEVEL)
+NTSTATUS
+EvtchnSend(
+    _In_ PXENIFACE_FDO             Fdo,
+    _In_ PXENIFACE_EVTCHN_CONTEXT  Context,
+    _In_ BOOLEAN                   ActiveOnly
+    );
+
 _Function_class_(KDEFERRED_ROUTINE)
 _IRQL_requires_(DISPATCH_LEVEL)
 _IRQL_requires_same_
@@ -265,7 +285,7 @@ EvtchnNotificationDpc(
 
 _IRQL_requires_(PASSIVE_LEVEL)
 VOID
-EvtchnFree(
+EvtchnDereference(
     _In_ PXENIFACE_FDO                  Fdo,
     _Inout_ PXENIFACE_EVTCHN_CONTEXT    Context
     );
-- 
2.56.0




 


Rackspace

Lists.xenproject.org is hosted with RackSpace, monitoring our
servers 24x7x365 and backed by RackSpace's Fanatical Support®.