Skip to content

Fix vsock file descriptor lifetime across async boundaries#552

Draft
DePasqualeOrg wants to merge 3 commits intoapple:mainfrom
DePasqualeOrg:fix-vsock-ebadf-crash
Draft

Fix vsock file descriptor lifetime across async boundaries#552
DePasqualeOrg wants to merge 3 commits intoapple:mainfrom
DePasqualeOrg:fix-vsock-ebadf-crash

Conversation

@DePasqualeOrg
Copy link
Contributor

@DePasqualeOrg DePasqualeOrg commented Feb 23, 2026

Note: I encountered a crash while using this package. The root cause analysis from Claude Code pointed to this potential issue, but since the specifics are beyond my understanding, I'm marking this as a draft PR. I put it through several rounds of review with Claude Code and Codex, which suggested that this fixes a legitimate issue. Also, PR #403 mentions that a fix remains to be found for EBADF panics. If this isn't helpful, please close this PR.

Problem

The gRPC client crashes with a precondition failure in NIO:

NIOPosix/System.swift:262: Precondition failed: unacceptable errno 9 Bad file descriptor
  in fcntl(descriptor:command:value:))

The crash occurs in BaseSocket.ignoreSIGPIPE() when NIO calls fcntl(fd, F_SETNOSIGPIPE, 1) on a file descriptor that has been invalidated.

Root cause

VZVirtioSocketConnection is not a raw POSIX socket — it bridges the process to the Virtualization daemon via XPC. When close() is called, the framework signals the hypervisor to tear down the host-to-guest vsock mapping, which invalidates all file descriptors pointing to the underlying kernel object — including dup'd ones.

The existing dupHandle() method calls self.close() immediately after dup(). This is safe when the fd is used synchronously, but dialAgent() passes the fd to gRPC's ClientConnection(.connectedSocket(fd)), which defers NIO channel creation until the first RPC call. By that time, the fd is invalid.

The same pattern exists in waitForAgent(), where the agent's first gRPC call (setTime via TimeSyncer) can be deferred by up to 30 seconds when Rosetta is not enabled.

Fix

Keep the VZVirtioSocketConnection alive until the gRPC client is done with the fd.

  • VsockTransport (new): A thread-safe wrapper that retains the VZVirtioSocketConnection and provides explicit close semantics. Includes a deinit safety net.
  • Vminitd: Gains an optional VsockTransport field. close() uses defer to ensure the transport is closed even if gRPC shutdown throws.
  • dupFileDescriptor() (new): Like dupHandle(), but does not close the connection. The caller is responsible for keeping the connection alive.
  • dialAgent(): Uses dupFileDescriptor() + VsockTransport instead of dupHandle().
  • waitForAgent(): Same migration — returns (FileHandle, VsockTransport) so start() can pass the transport to Vminitd.

After the fix, both the original fd (in VZVirtioSocketConnection) and the dup'd fd (used by NIO/gRPC) are open simultaneously. NIO owns and closes the dup'd fd during channel teardown. Vminitd.close() shuts down gRPC first, then closes the transport. The dup() is still necessary to avoid a double-close.

Not changed

dial() also uses dupHandle() but returns a raw FileHandle via the VirtualMachineInstance protocol. The fd is used immediately for relay I/O, so the risk is lower. Migrating it would require changing the protocol, which is a larger change better suited for a follow-up. A doc comment has been added to dupHandle() noting when it is and isn't safe.

Tests

  • Unit tests (VsockTransportTests.swift): Verify fd lifecycle invariants using Unix socket pairs — the exact fcntl(F_SETNOSIGPIPE) call that triggers the NIO crash, read/write through dup'd fds, correct teardown ordering, and peer EOF behavior.
  • Integration test (testExecDeferredConnectionStability): Runs 10 sequential exec calls with 100ms delays between creating the gRPC connection and making the first RPC, exercising the exact code path that was crashing.

@dcantah
Copy link
Member

dcantah commented Feb 24, 2026

Do you know what was occurring when you got the crash? Were you going to stop the vm/container? Was it just running and randomly crashed? It'd be useful to narrow that down. I personally haven't seen any EBADFs in quite awhile now. Our last set was solely due to interactions with our (no longer exposed) pause/resume functionality.

@DePasqualeOrg
Copy link
Contributor Author

I think I was starting or resuming a container, or trying to run a command in a container. Sorry that I can't be more specific than that.

@DePasqualeOrg DePasqualeOrg force-pushed the fix-vsock-ebadf-crash branch from 4f81487 to 8c047dc Compare March 13, 2026 10:14
@DePasqualeOrg
Copy link
Contributor Author

I realized that I can in fact offer more details based on crash reports. I had Codex analyze three crash reports from my app that uses this package, and these were the findings. Hopefully this helps shed more light on the issue.

  • Two of the crashes fault on NIO event-loop threads in ClientBootstrap.withConnectedSocket(...), with the top of the stack going through BaseSocket.ignoreSIGPIPE() -> Posix.fcntl(...) -> preconditionIsNotUnacceptableErrno(...). Those were the EBADF cases.
  • Another crash is an EXC_GUARD (GUARD_TYPE_FD) with CLOSE on file descriptor 41, again on an NIO event-loop thread in the ClientBootstrap.withConnectedSocket(...) path, with BaseSocket.close() / channel setup cleanup in the top frames.
  • Across all three crashes, the fault point is during connection establishment / first channel setup, not an obvious stop/pause path.

These reports support the fd-lifetime issue this PR is fixing: the connection appears to already be invalid by the time NIO tries to use it or take ownership of it. The reports do not prove whether the bad descriptor came specifically from dialAgent() or waitForAgent(), but they do seem consistent with the duplicated fd remaining in user space after the underlying vsock endpoint was torn down too early.

Exercises the dialAgent() → gRPC RPC path with deliberate delays
between creating the connection and making the first RPC call. This
reproduces a crash where NIO hits a precondition failure (EBADF) in
fcntl(F_SETNOSIGPIPE) because the VZVirtioSocketConnection was closed
before the gRPC client created the NIO channel.
When dialAgent() creates a gRPC connection via vsock, it dup's the
file descriptor and immediately closes the VZVirtioSocketConnection.
The Virtualization framework tears down the vsock endpoint when the
connection is closed, which can invalidate the dup'd descriptor. Since
gRPC defers NIO channel creation until the first RPC, the fd may be
invalid by then, causing a precondition failure in NIO's
fcntl(F_SETNOSIGPIPE).

The fix introduces VsockTransport, a Sendable wrapper that retains
the VZVirtioSocketConnection until Vminitd.close() explicitly shuts
it down after the gRPC channel. A new dupFileDescriptor() method dups
without closing, and dialAgent() passes the connection as transport.
@DePasqualeOrg DePasqualeOrg force-pushed the fix-vsock-ebadf-crash branch from 8c047dc to 633b8b2 Compare March 15, 2026 20:56
@DePasqualeOrg
Copy link
Contributor Author

I'm still seeing crashes when tearing down containers. This is the latest crash analysis and summary of fixes from Codex. The changes went through several rounds of review with Codex and Claude Code:

The latest crash report still points at the same vsock fd-lifetime bug. It crashes on NIO-ELT-2-#3 with EXC_GUARD (GUARD_TYPE_FD): CLOSE on file descriptor 31, and the relevant stack is BaseSocket.close -> BaseStreamSocketChannel.close0 -> ClientBootstrap.withConnectedSocket -> DefaultChannelProvider.makeChannel -> ConnectionManager.startConnecting. That is the gRPC/vsock connection setup path.

That stack is also consistent with containerization's container stop/cleanup paths, which still go through relay shutdown plus vm.withAgent / guest cleanup work. So this still fits the same vsock/gRPC lifetime bug family.

The root cause is broader than dialAgent() alone: a VZVirtioSocketConnection could be dup'd and then closed before NIO or other async code actually used the dup'd fd. The same lifetime mistake was still present in dial(_:), VsockListener, and UnixSocketRelay.

The fixes keep the originating VZVirtioSocketConnection alive for waitForAgent() and dialAgent(), keep raw vsock dials and accepted listener connections alive across async or deferred-use boundaries via VsockConnection, make UnixSocketRelay retain the guest-side VsockConnection for the full relay lifetime, and give BidirectionalRelay its own dup of the guest fd so relay shutdown does not double-close the same descriptor.

Smaller cleanup fixes from review: StdioHandles.close() now clears readabilityHandler before close and still closes all stdio handles even if one close throws, and the old unsafe dupHandle() helper was removed.

@DePasqualeOrg DePasqualeOrg changed the title Fix EBADF crash in vsock connection handling Fix vsock file descriptor lifetime across async boundaries Mar 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants