Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Do abortive connection shutdown in MsQuicConnection.Dispose #55493

Merged
merged 4 commits into from
Jul 15, 2021
Merged

Do abortive connection shutdown in MsQuicConnection.Dispose #55493

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6e8b357
do abortive connection shutdown in MsQuicConnection.Dispose, add test…
Jul 12, 2021
3994cfe
CloseAsync is no-op if disposed
Jul 13, 2021
81e626f
more review feedback
Jul 13, 2021
faf5e3a
Merge branch 'main' into connectiondispose
geoffkizer Jul 14, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion src/libraries/System.Net.Quic/src/System/Net/Quic/Implementations/MsQuic/MsQuicConnection.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -710,6 +710,12 @@ private void Dispose(bool disposing)

if (NetEventSource.Log.IsEnabled()) NetEventSource.Info(_state, $"{TraceId()} Stream disposing {disposing}");

// If we haven't already shutdown gracefully (via a successful CloseAsync call), then force an abortive shutdown.
MsQuicApi.Api.ConnectionShutdownDelegate(
_state.Handle,
QUIC_CONNECTION_SHUTDOWN_FLAGS.SILENT,
0);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It feels like it should be configurable from somewhere, but we might want to at least have it as a constant DEFAULT_ABORT_CODE or something like this.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This value doesn't actually matter, because of the SILENT flag -- no error is sent to the peer.

In general though, I do agree we should define DEFAULT_ABORT_CODE or something like that.


bool releaseHandles = false;
lock (_state)
{
Expand Down Expand Up @@ -740,7 +746,10 @@ private void Dispose(bool disposing)
// It's unclear how to gracefully wait for a connection to be 100% done.
internal override ValueTask CloseAsync(long errorCode, CancellationToken cancellationToken = default)
{
ThrowIfDisposed();
if (_disposed == 1)
{
return default;
}

return ShutdownAsync(QUIC_CONNECTION_SHUTDOWN_FLAGS.NONE, errorCode);
}
Expand Down
108 changes: 106 additions & 2 deletions src/libraries/System.Net.Quic/tests/FunctionalTests/QuicConnectionTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ namespace System.Net.Quic.Tests
public abstract class QuicConnectionTests<T> : QuicTestBase<T>
where T : IQuicImplProviderFactory, new()
{
const int ExpectedErrorCode = 1234;

[Fact]
public async Task TestConnect()
{
Expand Down Expand Up @@ -39,8 +41,6 @@ public async Task TestConnect()
[ActiveIssue("https://github.com/dotnet/runtime/issues/55242", TestPlatforms.Linux)]
public async Task AcceptStream_ConnectionAborted_ByClient_Throws()
{
const int ExpectedErrorCode = 1234;

using var sync = new SemaphoreSlim(0);

await RunClientServer(
Expand All @@ -56,6 +56,110 @@ await RunClientServer(
Assert.Equal(ExpectedErrorCode, ex.ErrorCode);
});
}

private static async Task DoWrites(QuicStream writer, int writeCount)
{
for (int i = 0; i < writeCount; i++)
{
await writer.WriteAsync(new byte[1]);
}
}

private static async Task DoReads(QuicStream reader, int readCount)
{
for (int i = 0; i < readCount; i++)
{
int bytesRead = await reader.ReadAsync(new byte[1]);
Assert.Equal(1, bytesRead);
}
}

[Theory]
[InlineData(1)]
[InlineData(10)]
public async Task CloseAsync_WithOpenStream_LocalAndPeerStreamsFailWithQuicOperationAbortedException(int writesBeforeClose)
{
if (typeof(T) == typeof(MockProviderFactory))
{
return;
}

using var sync = new SemaphoreSlim(0);

await RunClientServer(
async clientConnection =>
{
using QuicStream clientStream = clientConnection.OpenBidirectionalStream();
await DoWrites(clientStream, writesBeforeClose);

// Wait for peer to receive data
await sync.WaitAsync();

await clientConnection.CloseAsync(ExpectedErrorCode);

await Assert.ThrowsAsync<QuicOperationAbortedException>(async () => await clientStream.ReadAsync(new byte[1]));
await Assert.ThrowsAsync<QuicOperationAbortedException>(async () => await clientStream.WriteAsync(new byte[1]));
},
async serverConnection =>
{
using QuicStream serverStream = await serverConnection.AcceptStreamAsync();
await DoReads(serverStream, writesBeforeClose);

sync.Release();

// Since the peer did the abort, we should receive the abort error code in the exception.
QuicConnectionAbortedException ex;
ex = await Assert.ThrowsAsync<QuicConnectionAbortedException>(async () => await serverStream.ReadAsync(new byte[1]));
Assert.Equal(ExpectedErrorCode, ex.ErrorCode);
ex = await Assert.ThrowsAsync<QuicConnectionAbortedException>(async () => await serverStream.WriteAsync(new byte[1]));
Assert.Equal(ExpectedErrorCode, ex.ErrorCode);
});
}

[OuterLoop("Depends on IdleTimeout")]
[Theory]
[InlineData(1)]
[InlineData(10)]
public async Task Dispose_WithOpenLocalStream_LocalStreamFailsWithQuicOperationAbortedException(int writesBeforeClose)
{
if (typeof(T) == typeof(MockProviderFactory))
{
return;
}

// Set a short idle timeout so that after we dispose the connection, the peer will discover the connection is dead before too long.
QuicListenerOptions listenerOptions = CreateQuicListenerOptions();
listenerOptions.IdleTimeout = TimeSpan.FromSeconds(1);

using var sync = new SemaphoreSlim(0);

await RunClientServer(
async clientConnection =>
{
using QuicStream clientStream = clientConnection.OpenBidirectionalStream();
await DoWrites(clientStream, writesBeforeClose);

// Wait for peer to receive data
await sync.WaitAsync();

clientConnection.Dispose();

await Assert.ThrowsAsync<QuicOperationAbortedException>(async () => await clientStream.ReadAsync(new byte[1]));
await Assert.ThrowsAsync<QuicOperationAbortedException>(async () => await clientStream.WriteAsync(new byte[1]));
},
async serverConnection =>
{
using QuicStream serverStream = await serverConnection.AcceptStreamAsync();
await DoReads(serverStream, writesBeforeClose);

sync.Release();

// The client has done an abortive shutdown of the connection, which means we are not notified that the connection has closed.
// But the connection idle timeout should kick in and eventually we will get exceptions.
await Assert.ThrowsAsync<QuicOperationAbortedException>(async () => await serverStream.ReadAsync(new byte[1]));
await Assert.ThrowsAsync<QuicOperationAbortedException>(async () => await serverStream.WriteAsync(new byte[1]));
}, listenerOptions: listenerOptions);
}
}

public sealed class QuicConnectionTests_MockProvider : QuicConnectionTests<MockProviderFactory> { }
Expand Down
29 changes: 20 additions & 9 deletions src/libraries/System.Net.Quic/tests/FunctionalTests/QuicTestBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,15 +57,21 @@ internal QuicConnection CreateQuicConnection(IPEndPoint endpoint)
return new QuicConnection(ImplementationProvider, endpoint, GetSslClientAuthenticationOptions());
}

internal QuicListener CreateQuicListener(int maxUnidirectionalStreams = 100, int maxBidirectionalStreams = 100)
internal QuicListenerOptions CreateQuicListenerOptions()
{
var options = new QuicListenerOptions()
return new QuicListenerOptions()
{
ListenEndPoint = new IPEndPoint(IPAddress.Loopback, 0),
ServerAuthenticationOptions = GetSslServerAuthenticationOptions(),
MaxUnidirectionalStreams = maxUnidirectionalStreams,
MaxBidirectionalStreams = maxBidirectionalStreams
ServerAuthenticationOptions = GetSslServerAuthenticationOptions()
};
}

internal QuicListener CreateQuicListener(int maxUnidirectionalStreams = 100, int maxBidirectionalStreams = 100)
{
var options = CreateQuicListenerOptions();
options.MaxUnidirectionalStreams = maxUnidirectionalStreams;
options.MaxBidirectionalStreams = maxBidirectionalStreams;

return CreateQuicListener(options);
}

Expand Down Expand Up @@ -111,9 +117,12 @@ internal async Task PingPong(QuicConnection client, QuicConnection server)

private QuicListener CreateQuicListener(QuicListenerOptions options) => new QuicListener(ImplementationProvider, options);

internal async Task RunClientServer(Func<QuicConnection, Task> clientFunction, Func<QuicConnection, Task> serverFunction, int iterations = 1, int millisecondsTimeout = 10_000)
internal async Task RunClientServer(Func<QuicConnection, Task> clientFunction, Func<QuicConnection, Task> serverFunction, int iterations = 1, int millisecondsTimeout = 10_000, QuicListenerOptions listenerOptions = null)
{
using QuicListener listener = CreateQuicListener();
const long ClientCloseErrorCode = 11111;
const long ServerCloseErrorCode = 22222;

using QuicListener listener = CreateQuicListener(listenerOptions ?? CreateQuicListenerOptions());

using var serverFinished = new SemaphoreSlim(0);
using var clientFinished = new SemaphoreSlim(0);
Expand All @@ -126,18 +135,20 @@ await new[]
{
using QuicConnection serverConnection = await listener.AcceptConnectionAsync();
await serverFunction(serverConnection);

serverFinished.Release();
await clientFinished.WaitAsync();
await serverConnection.CloseAsync(0);
geoffkizer marked this conversation as resolved.
Show resolved Hide resolved
await serverConnection.CloseAsync(ServerCloseErrorCode);
}),
Task.Run(async () =>
{
using QuicConnection clientConnection = CreateQuicConnection(listener.ListenEndPoint);
await clientConnection.ConnectAsync();
await clientFunction(clientConnection);

clientFinished.Release();
await serverFinished.WaitAsync();
await clientConnection.CloseAsync(0);
await clientConnection.CloseAsync(ClientCloseErrorCode);
})
}.WhenAllOrAnyFailed(millisecondsTimeout);
}
Expand Down